Merge pull request #230 from mayanktap/add-dl-tag

Add dl component

Author: pascalwengerter

app/concepts/matestack/ui/core/dl/dl.haml

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

app/concepts/matestack/ui/core/dl/dl.rb

@@ -0,0 +1,5 @@
+module Matestack::Ui::Core::Dl
+  class Dl < Matestack::Ui::Core::Component::Static
+
+  end
+end

docs/components/dl.md

@@ -0,0 +1,47 @@
+# matestack core component: Dl
+
+Show [specs](/spec/usage/components/dl_spec.rb)
+
+The HTML dl tag implemented in ruby.
+
+## Parameters
+
+This component can take 3 optional configuration params and either yield content or display what gets passed to the `text` configuration param.
+
+#### # id (optional)
+Expects a string with all ids the `dl` should have.
+
+#### # class (optional)
+Expects a string with all classes the `dl` should have.
+
+## Example 1: Yield a given block
+
+```ruby
+dl id: "foo", class: "bar" do
+  dt text: "dt component"
+  dd text: "dd component"
+end
+```
+
+returns
+
+```html
+<dl id="foo" class="bar">
+  <dt>dt component</dt>
+  <dd>dd component</dd>
+</dl>
+```
+
+## Example 2: Render options[:text] param
+
+```ruby
+dl id: "foo", class: "bar", text: 'Hello World'
+```
+
+returns
+
+```html
+<dl id="foo" class="bar">
+  Hello World
+</dl>
+```

spec/usage/components/dl_spec.rb

@@ -0,0 +1,58 @@
+require_relative "../../support/utils"
+include Utils
+
+describe 'Dl Component', type: :feature, js: true do
+
+  it 'Example 1 - yield, no options[:text]' do
+
+    class ExamplePage < Matestack::Ui::Page
+
+      def response
+        components {
+          dl id: 'my-id', class: 'my-class' do
+            dt text: "dt component"
+            dd text: "dd component"
+          end
+        }
+      end
+
+    end
+
+    visit '/example'
+    static_output = page.html
+
+    expected_static_output = <<~HTML
+    <dl id="my-id" class="my-class"><dt>dt component</dt><dd>dd component</dd></dl>
+    HTML
+    expect(stripped(static_output)).to include(stripped(expected_static_output))
+  end
+
+  it 'Example 2 - render options[:text]' do
+
+    class ExamplePage < Matestack::Ui::Page
+
+      def response
+        components {
+          # simple dl tag
+          dl text: 'This is simple dl text'
+
+          # enhanced dl tag
+          dl id: 'my-id', class: 'my-class', text: 'This is a enhanced dl with text'
+        }
+      end
+
+    end
+
+    visit '/example'
+
+    static_output = page.html
+
+    expected_static_output = <<~HTML
+    <dl>This is simple dl text</dl>
+    <dl id="my-id" class="my-class">This is a enhanced dl with text</dl>
+    HTML
+
+    expect(stripped(static_output)).to include(stripped(expected_static_output))
+  end
+
+end