attributes_for 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a209b072da0d34c383a199a10190e3b747aa993
-  data.tar.gz: 7de6c1c29fd8eb272e51176376f894cea70dbf71
+  metadata.gz: 3341f8ea5c6de31880faa96f8566ae49c79b770d
+  data.tar.gz: 9e0d2c45a2be18135fcd985cae66f50cc4e7827f
 SHA512:
-  metadata.gz: 4cd8f89690b7249894fbffb68f7ae2e10b9b4abf305e0dfc0b0a8f25d49fdc6d9910c8f13b3bb5c82fd08f17fe81222d52a645aebeb9c05861ac494958358408
-  data.tar.gz: f94caba36425d9dc8226557a486259df7264c116f0514ca697ed2fa5d651c5627cb3f791ef60eb049779a1d9a00494c7ffab1f4d1c4291e8966f8901ca747ea8
+  metadata.gz: d84163fccde09263dad397d39c36eb7d4d9c3fb3ec2dce7771af6f8c54a81f8968cf952af767149cf2070ff4447f9fbce0924d65f265396c640b8cf719f89b54
+  data.tar.gz: 09b735c044487a75e06ab3d6b3fde5b3d436cff6672adb7d445de37d7cef7b4413db0a83d2372194d89e6eaa826762790f93042917994e415b31a0ac54dbe771

data/.travis.yml

@@ -3,4 +3,5 @@ rvm:
   - 1.9.3
   - 2.1.0
   - 2.2.2
+  - 2.2.3
 before_install: gem install bundler -v 1.10.3

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## [0.7.0] - 2015-11-09
+### Added
+- Wrap label and value in tags.
+- `:defaults` options. Apply same options to all elements.
+- `:wrapper` options (change default wrappers).
+- `:label_html` and `:value_html` to set attributes on tags.
+### Changed
+- Improved implementation slightly.
+
+## [0.6.1] - 2015-10-29
+### Changed
+- Updated dependencies.
+
+## [0.6.0] - 2015-10-21
+### Added
+- `date` and `datetime` helpers formats/converts to date and datetime.
+
 ## [0.5.1] - 2015-12-10
 ### Fixed
 - `attribute` helper explicitly casts integer to string.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attributes_for (0.6.1)
+    attributes_for (0.7.0)
       chronic_duration (~> 0.10)
       font-awesome-rails (~> 4.0)
       phony (~> 2.0)
@@ -74,11 +74,11 @@ GEM
     mime-types (2.6.2)
     mini_portile (0.6.2)
     minitest (5.8.2)
-    netrc (0.10.3)
+    netrc (0.11.0)
     nokogiri (1.6.6.2)
       mini_portile (~> 0.6.0)
     numerizer (0.1.1)
-    phony (2.15.6)
+    phony (2.15.7)
     rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)

data/README.md

@@ -56,6 +56,8 @@ Present attributes using the API in the example below. It can also generate a
 standard label value pair given an attribute name using the `attribute` method. Arbitrary
 strings can also be presented using the `string` method.
 
+Here is a complete example using all possible options.
+
 ```erb
 <ul class="list-unstyled">
   <%= attributes_for @company do |b| %>
@@ -83,6 +85,50 @@ strings can also be presented using the `string` method.
 </ul>
 ```
 
+Passing `:label_html` or `:value_html` to `#attribute` adds the given
+options to the `label` and `value` wrapper tags.
+
+```erb
+<ul class="list-unstyled">
+  <%= attributes_for @product, defaults: { label_html: { class: 'label' } } do |b|
+    <li><%= b.attribute :price, icon: 'money', value_html: { class: 'pull-right' } %></li>
+  <% end %>
+</ul>
+```
+
+Passing `:defaults` to `attributes_for` gives the option to all
+attributes. This option you can typically use when you want add styling
+to the label of each attribute.
+
+```erb
+<ul class="list-unstyled">
+  <%= attributes_for @company, defaults: { label_html: { class: 'label' } } do |b| %>
+    <li><%= b.attribute :name, icon: 'building-o' %></li>
+  <% end %>
+</ul>
+```
+
+`attributes_for` wraps labels and values in `span` tags by default. Passing
+`:wrappers` to `attributes_for` gives you the option to change the wrapper.
+
+```erb
+<ul class="list-unstyled">
+  <%= attributes_for @company, wrappers: { label: 'strong' } do |b| %>
+    <li><%= b.attribute :name, icon: 'building-o' %></li>
+  <% end %>
+</ul>
+```
+
+Passing `:empty` to `attributes_for` overrides the default empty value.
+
+```erb
+<dl>
+  <%= attributes_for @company, wrappers: { label: 'dt', value: 'dd' }, empty: '-' do |b| %>
+    <%= b.attribute :fax %>
+  <% end %>
+</dl>
+```
+
 ## Options
 
 Available options:

data/app/helpers/attributes_for/rails/attributes_for_helper.rb

@@ -3,17 +3,25 @@ module AttributesFor
     module AttributesForHelper
 
       def attributes_for(object, options = {}, &block)
-        capture AttributeBuilder.new(object, self), &block
+        capture AttributeBuilder.new(object, self, options), &block
       end
 
       class AttributeBuilder
         include ActionView::Helpers
         include FontAwesome::Rails::IconHelper
 
-        attr_accessor :object, :template
+        attr_accessor :object, :template, :default_options, :wrappers,
+          :options
 
-        def initialize(object, template)
-          @object, @template = object, template
+        def initialize(object, template, options = {})
+          @object   = object
+          @template = template
+          @default_options = options[:defaults] || {}
+
+          @wrappers = { label: 'span', value: 'span' }
+          @wrappers.merge!(options.delete(:wrappers)) if options.key?(:wrappers)
+
+          @empty    = options.delete(:empty) if options.key?(:empty)
         end
 
         def method_missing(method, *args, &block)
@@ -26,75 +34,108 @@ module AttributesFor
 
         private
 
-        def build_content(method, attribute_name, options = {}, &block)
-          content = format_attribute(method, attribute_name, options, &block)
-
-          options[:icon] ||= icon_map(method)
-
-          wrap_content(human_name(attribute_name), content, options)
+        def empty_value
+          @empty || I18n.t('attributes_for.not_set')
         end
 
-        def format_attribute(method, attribute_name, options = {}, &block)
-          value = object.public_send(attribute_name)
-
+        def build_value(method, attribute_name, options = {}, &block)
           if block_given?
             template.capture(&block)
-          elsif value.to_s.empty?
-            I18n.t "attributes_for.not_set"
           else
-            case method.to_sym
-            when :boolean
-              I18n.t("attributes_for.#{value.to_s}")
-            when :date
-              I18n.l(value.to_date, format: options[:format])
-            when :datetime
-              I18n.l(value, format: options[:format])
-            when :duration
-              ChronicDuration.output(value, :keep_zero => true)
-            when :email
-              mail_to(value, value, title: human_name(attribute_name))
-            when :phone
-              phone_number = Phony.format(Phony.normalize(value.to_s), format: :international)
-              link_to(phone_number, "tel:#{phone_number}", title: human_name(attribute_name))
-            when :url
-              link_to(value, value, title: human_name(attribute_name))
+            value = object.public_send(attribute_name)
+            if value.to_s.empty?
+              empty_value
             else
-              value.to_s
+              format_value(
+                method,
+                value,
+                options.reverse_merge(title: human_name(attribute_name))
+              )
             end
           end
         end
 
-        def wrap_content(label, content, options)
-          html_options         = options[:html] || {}
-          html_options[:id]    = options.delete(:id) if options.key?(:id)
-          html_options[:class] = options.delete(:class) if options.key?(:class)
+        def build_content(method, attribute_name, options = {}, &block)
+          value = build_value(method, attribute_name, options, &block)
+
+          options[:icon] ||= icon_map(method)
+
+          wrap_content(human_name(attribute_name), value, options)
+        end
 
-          content = "#{label}: " + content unless options[:label] === false
-          content = content_tag(:span, content.html_safe, html_options)
+        def format_value(method, value, options = {})
+          case method.to_sym
+          when :boolean
+            I18n.t("attributes_for.#{value}")
+          when :date
+            I18n.l(value.to_date, format: options[:format])
+          when :datetime
+            I18n.l(value, format: options[:format])
+          when :duration
+            ChronicDuration.output(value, keep_zero: true)
+          when :email
+            mail_to(value, value, title: options[:title])
+          when :phone
+            phone_number = Phony.format(Phony.normalize(value.to_s),
+                                        format: :international)
+            link_to(phone_number, "tel:#{phone_number}", title: options[:title])
+          when :url
+            link_to(value, value, title: options[:title])
+          else
+            value.to_s
+          end
+        end
 
-          if options[:icon]
-            content = fa_icon(options[:icon], text: content)
+        def wrap_content(label, value, options)
+          label_html_options = {}
+          label_html_options = options.delete(:label_html) if options.key?(:label_html)
+
+          value_html_options = {}
+          value_html_options = options.delete(:value_html) if options.key?(:value_html)
+
+          content = content_tag(
+            wrappers[:value],
+            value,
+            apply_default_options(:value_html, value_html_options)
+          )
+
+          unless options[:label] === false
+            content = content_tag(
+              wrappers[:label],
+              "#{label}:",
+              apply_default_options(:label_html, label_html_options)
+            ) + ' ' + content
           end
 
+          content = fa_icon(options[:icon], text: content) if options[:icon]
           content
         end
 
+        def apply_default_options(key, options)
+          if default_options.key?(key)
+            default_options[key].merge(options)
+          else
+            options
+          end
+        end
+
         def human_name(attribute)
-          object.class.human_attribute_name(attribute, default: attribute.to_s.titleize)
+          object
+            .class
+            .human_attribute_name(attribute, default: attribute.to_s.titleize)
         end
 
         def icon_map(method)
           {
             boolean:  'check',
             date:     'calendar',
-            datetime:     'calendar',
+            datetime: 'calendar',
             duration: 'clock-o',
             email:    'envelope',
             phone:    'phone',
-            url:      'globe',
+            url:      'globe'
           }[method]
         end
-
       end
     end
   end

data/lib/attributes_for/version.rb

@@ -1,3 +1,3 @@
 module AttributesFor
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attributes_for
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Ole J. Rosendahl
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2015-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails