Skip to content

Add article component with docs and specs #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions app/concepts/matestack/ui/core/article/article.haml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
%article{@tag_attributes}
- if options[:text].nil? && block_given?
= yield
- else
= options[:text]
5 changes: 5 additions & 0 deletions app/concepts/matestack/ui/core/article/article.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module Matestack::Ui::Core::Article
class Article < Matestack::Ui::Core::Component::Static

end
end
46 changes: 46 additions & 0 deletions docs/components/article.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# matestack core component: Blockquote

Show [specs](../../spec/usage/components/article_spec.rb)

The HTML article tag implemented in ruby.

## Parameters

This component can take 2 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 span should have.

#### # class (optional)
Expects a string with all classes the span should have.

#### # text - optional
Expects a string which will be displayed as the content inside the `article`. If this is not passed, a block must be passed instead.

## Example 1: Yield a given block

```ruby
article do
paragraph text: "Hello world"
end
```

returns

```html
<article>
<p>Hello world</p>
</article>
```

## Example 2: Render options[:text] param

```ruby
article text: "Hello world"
```

returns

```html
<article>Hello world</article>
```
52 changes: 52 additions & 0 deletions spec/usage/components/article_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
require_relative "../../support/utils"
include Utils

describe 'Article Component', type: :feature, js: true do

it 'Example 1 - yield, no options[:text]' do

class ExamplePage < Matestack::Ui::Page

def response
components {
article do
paragraph text: "Hello world"
end
}
end

end

visit '/example'
static_output = page.html

expected_static_output = <<~HTML
<article><p>Hello world</p></article>
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 {
article text: "Hello world"
}
end

end

visit '/example'

static_output = page.html

expected_static_output = <<~HTML
<article>Hello world</article>
HTML

expect(stripped(static_output)).to include(stripped(expected_static_output))
end

end