Skip to content

Add abbr component with specs and documentation #124

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 3 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/abbr/abbr.haml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
%abbr{@tag_attributes}
- if options[:text].blank? && block_given?
= yield
- else
= options[:text]
12 changes: 12 additions & 0 deletions app/concepts/matestack/ui/core/abbr/abbr.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
module Matestack::Ui::Core::Abbr
class Abbr < Matestack::Ui::Core::Component::Static
REQUIRED_KEYS = [:title]

def setup
@tag_attributes.merge!({
"title": options[:title]
})
end

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

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

The HTML `abbr` tag implemented in ruby.

## Parameters

This component expects 1 required param, 2 optional configuration params and either yield content or display what gets passed to the `text` configuration param.

#### # title - required
Expects a string with the meaning of the abbreviation contained within the tag.

#### # id - optional
Expects a string with all ids the `abbr` should have.

#### # class - optional
Expects a string with all classes the `abbr` should have.

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

## Example 1 - render options[:text] param

```ruby
abbr title: 'Hypertext Markup Language', text: 'HTML'
```

returns

```html
<abbr title="Hypertext Markup Language">HTML</abbr>
```


## Example 2 - yield a given block

```ruby
abbr title: 'Cascading Style Sheets' do
span text: 'CSS'
end
```

returns

```html
<abbr title="Cascading Style Sheets">CSS</abbr>
```
54 changes: 54 additions & 0 deletions spec/usage/components/abbr_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
require_relative '../../support/utils'
include Utils

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

it 'Example 1' do

class ExamplePage < Matestack::Ui::Page

def response
components {
abbr title: 'Hypertext Markup Language', text: 'HTML'
}
end

end

visit '/example'

static_output = page.html

expected_static_output = <<~HTML
<abbr title="Hypertext Markup Language">HTML</abbr>
HTML

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

it 'Example 2' do

class ExamplePage < Matestack::Ui::Page

def response
components {
abbr title: 'Cascading Style Sheets' do
span text: 'CSS'
end
}
end

end

visit '/example'

static_output = page.html

expected_static_output = <<~HTML
<abbr title="Cascading Style Sheets"><span>CSS</span></abbr>
HTML

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

end