Merge pull request #48 from basemate/change_paragraph_component

rename pg component to paragraph component

Author: jonasjabari

app/concepts/paragraph/cell/paragraph.rb

@@ -0,0 +1,5 @@
+module Paragraph::Cell
+  class Paragraph < Component::Cell::Static
+
+  end
+end

app/concepts/paragraph/view/paragraph.haml

@@ -0,0 +1,8 @@
+- if options[:text].nil?
+  %p{@tag_attributes}
+    - if block_given?
+      = yield
+
+- else
+  %p{@tag_attributes}
+    = options[:text]

docs/components/paragraph.md

@@ -0,0 +1,73 @@
+# matestack core component: Paragraph
+
+Show [specs](../../spec/usage/components/paragraph_spec.rb)
+
+The HTML `<p>` tag implemented in ruby. This is a workaround because the single `p` is the short version of `puts` in ruby.
+
+## Parameters
+
+This component can take 3 optional configuration params and optional content.
+
+#### # id (optional)
+Expects a string with all ids the p should have.
+
+#### # class (optional)
+Expects a string with all classes the p should have.
+
+#### # text (optional)
+Expects a string with the text that should go into the `<p>` tag.
+
+## Example 1
+Specifying the text directly
+
+```ruby
+div id: "foo", class: "bar" do
+  paragraph text: "Hello World"
+end
+```
+
+returns
+
+```html
+<div id="foo" class="bar">
+  <p>Hello World</p>
+</div>
+```
+
+## Example 2
+Rendering a content block between the `<p>` tags
+
+```ruby
+div id: "foo", class: "bar" do
+  paragraph do
+    plain "Hello World"
+  end
+end
+```
+
+returns
+
+```html
+<div id="foo" class="bar">
+  <p>Hello World</p>
+</div>
+```
+
+## Example 3
+Rendering a `<span>` tag into `<p>` tags
+
+```ruby
+paragraph id: "foo", class: "bar" do
+  span do
+    plain "Hello World"
+  end
+end
+```
+
+returns
+
+```html
+<p id="foo" class="bar">
+  <span>Hello World</span>
+</p>
+```

docs/components/pg.md

@@ -1,73 +1,5 @@
-# matestack core component: Pg
+# matestack core component: PG
 
 Show [specs](../../spec/usage/components/pg_spec.rb)
 
-The HTML `<p>` tag implemented in ruby. This is a workaround because the single `p` is the short version of `puts` in ruby.
-
-## Parameters
-
-This component can take 3 optional configuration params and optional content.
-
-#### # id (optional)
-Expects a string with all ids the p should have.
-
-#### # class (optional)
-Expects a string with all classes the p should have.
-
-#### # text (optional)
-Expects a string with the text that should go into the `<p>` tag.
-
-## Example 1
-Specifying the text directly
-
-```ruby
-div id: "foo", class: "bar" do
-  pg text: "Hello World"
-end
-```
-
-returns
-
-```html
-<div id="foo" class="bar">
-  <p>Hello World</p>
-</div>
-```
-
-## Example 2
-Rendering a content block between the `<p>` tags
-
-```ruby
-div id: "foo", class: "bar" do
-  pg do
-    plain "Hello World"
-  end
-end
-```
-
-returns
-
-```html
-<div id="foo" class="bar">
-  <p>Hello World</p>
-</div>
-```
-
-## Example 3
-Rendering a `<span>` tag into `<p>` tags
-
-```ruby
-pg id: "foo", class: "bar" do
-  span do
-    plain "Hello World"
-  end
-end
-```
-
-returns
-
-```html
-<p id="foo" class="bar">
-  <span>Hello World</span>
-</p>
-```
+The HTML `<p>` tag implemented in ruby. Please refer to the [paragraph core component](./paragraph.md) since the PG component is deprecated and will be removed sometime in the future.

spec/usage/components/action_spec.rb

@@ -534,7 +534,7 @@ class Pages::ExampleApp::SecondExamplePage < Page::Cell::Page
       def response
         components {
           heading size: 2, text: "This is Page 2"
-          pg text: 'You made it!'
+          paragraph text: 'You made it!'
         }
       end
 

spec/usage/components/footer_spec.rb

@@ -16,7 +16,7 @@ def response
 
           # advanced footer tag
           footer id: 'my-unique-footer', class: 'awesome-footer' do
-            pg class: 'footer-text', text: 'hello world!'
+            paragraph class: 'footer-text', text: 'hello world!'
           end
         }
       end

spec/usage/components/paragraph_spec.rb

@@ -0,0 +1,36 @@
+require_relative '../../support/utils'
+include Utils
+
+describe 'Paragraph Component', type: :feature, js: true do
+
+  it 'Example 1' do
+
+    class ExamplePage < Page::Cell::Page
+
+      def response
+        components {
+          # simple paragraph
+          paragraph text: 'I am simple'
+
+          # enhanced paragraph
+          paragraph id: 'my-id', class: 'my-class' do
+            plain 'I am enhanced'
+          end
+        }
+      end
+
+    end
+
+    visit '/example'
+
+    static_output = page.html
+
+    expected_static_output = <<~HTML
+    <p>I am simple</p>
+    <p id="my-id" class="my-class">I am enhanced</p>
+    HTML
+
+    expect(stripped(static_output)).to include(stripped(expected_static_output))
+  end
+
+end

spec/usage/components/time_spec.rb

@@ -10,15 +10,15 @@ class ExamplePage < Page::Cell::Page
       def response
         components {
           # simple time tag
-          pg do
+          paragraph do
             plain 'This should show '
             time class: 'my-simple-time' do
               plain '12:00'
             end
           end
 
           # time tag with timestamp
-          pg id: 'my-parent-paragraph' do
+          paragraph id: 'my-parent-paragraph' do
             plain 'Today is '
             time id: 'example-timestamp', datetime: DateTime.new(2019,2,12,10,38,39,'+02:00') do
               plain 'July 7'