Skip to content

ISSUE #183 Adds del component #225

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 7 commits into from
Nov 19, 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/del/del.haml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
%del{@tag_attributes.merge({:cite => options[:cite], :datetime => options[:datetime]})}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd prefer the @tag_attributes.merge([...]) stuff to be within a setup method in the del.rb, but that's a personal preference. Should be fine like this for now.

- if options[:text].nil? && block_given?
= yield
- else
= options[:text]
4 changes: 4 additions & 0 deletions app/concepts/matestack/ui/core/del/del.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
module Matestack::Ui::Core::Del
class Del < Matestack::Ui::Core::Component::Static
end
end
51 changes: 51 additions & 0 deletions docs/components/del.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# matestack core component: Del

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

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

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

#### # cite (optional)
Expects a string with a URL to a document that explains the reason why the text was deleted.

#### # datetime (optional)
Expects a string which specifies the date and time of when the text was deleted.

## Example 1: Yield a given block

```ruby
del id: "foo", class: "bar" do
plain 'Hello World' # optional content
end
```

returns

```html
<del id="foo" class="bar">
Hello World
</del>
```

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

```ruby
del id: "foo", class: "bar", text: 'Hello World'
```

returns

```html
<del id="foo" class="bar">
Hello World
</del>
```
66 changes: 66 additions & 0 deletions spec/usage/components/del_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
require_relative "../../support/utils"
include Utils
RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 10_000
describe 'Del Component', type: :feature, js: true do

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

class ExamplePage < Matestack::Ui::Page

def response
components {
# simple del
del cite: 'http://citeurl.com', datetime: '2019-01-01T00:00:00Z' do
plain 'I am simple'
end

# enhanced del
del id: 'my-id', class: 'my-class', cite: 'http://citeurl.com', datetime: '2019-01-01T00:00:00Z' do
plain 'I am enhanced'
end
}
end

end

visit '/example'

static_output = page.html

expected_static_output = <<~HTML
<del cite=\"http://citeurl.com\" datetime=\"2019-01-01T00:00:00Z\">I am simple</del>
<del cite=\"http://citeurl.com\" datetime=\"2019-01-01T00:00:00Z\" id=\"my-id\" class=\"my-class\">I am enhanced</del>
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 del
del cite: 'http://citeurl.com', datetime: '2019-01-01T00:00:00Z', text: 'I am simple'

# enhanced del
del id: 'my-id', class: 'my-class', cite: 'http://citeurl.com', datetime: '2019-01-01T00:00:00Z', text: 'I am enhanced'
}
end

end

visit '/example'

static_output = page.html

expected_static_output = <<~HTML
<del cite=\"http://citeurl.com\" datetime=\"2019-01-01T00:00:00Z\">I am simple</del>
<del cite=\"http://citeurl.com\" datetime=\"2019-01-01T00:00:00Z\" id=\"my-id\" class=\"my-class\">I am enhanced</del>
HTML

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

end