Skip to content

Add address tag, specs and documentation #126

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

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

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

The HTML `<address>` 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 address should have.

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

#### # text (optional)
Expects a ruby string with the text the address tag should show.

## Example 1 - yield a given block

```ruby
address do
plain 'Codey McCodeface'
br
plain '1 Developer Avenue'
br
plain 'Techville'
end
```

returns

```html
<address>
Codey McCodeface<br>
1 Developer Avenue<br>
Techville
</address>
```

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

```ruby
address text: 'PO Box 12345'
```

returns

```html
<address>
PO Box 12345
</address>
```
58 changes: 58 additions & 0 deletions spec/usage/components/address_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
require_relative '../../support/utils'
include Utils

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

it 'Example 1 - yield a given block' do

class ExamplePage < Matestack::Ui::Page

def response
components {
address do
plain 'Codey McCodeface'
br
plain '1 Developer Avenue'
br
plain 'Techville'
end
}
end

end

visit '/example'

static_output = page.html

expected_static_output = <<~HTML
<address>Codey McCodeface<br>1 Developer Avenue<br>Techville</address>
HTML

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

it 'Example 2 - render options[:text] param' do

class ExamplePage < Matestack::Ui::Page

def response
components {
address text: 'PO Box 12345'
}
end

end

visit '/example'

static_output = page.html

expected_static_output = <<~HTML
<address>PO Box 12345</address>
HTML

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

end