hanami-helpers 1.1.2 → 1.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2240795ff1bddb8305850e8473c60580701e7175528edcc25f83bad073a49fc9
-  data.tar.gz: 704af3c5d22e74509806c87c17bb368b0935dafe6ff276d2532bbc010c59eba2
+  metadata.gz: e45f7f598ca31c583c6c23bc8c5462caba3c2ef912ec92d28902681fcade042f
+  data.tar.gz: 1471aee67afbf749bc146f0127de2c40bb08f8973bf133832251b939142a5d33
 SHA512:
-  metadata.gz: 94778d91a095e8e7e41d58c0fa9477de162960fab463f2c8eb593b03f27ba2ac3dc7041d6fdab42b7f46783838510f0532191d678c4d5cd2225b454251b0c499
-  data.tar.gz: 6a5c35fd9efdc2c5db4d763398e10bc51de1cf2b429e28bfcfc5b2694e2dc3a68d24d6b22658965e85e5b85202a3c1f206d920badc5bf6e70ae75335dd4d8410
+  metadata.gz: f894fd9f04c7e0e9ab8829f14caac0c3589345224c88bf02cda2aca4c48817c8bdf0773ab0de489a45eada4f4892eb5a494d730a1a0e616180f7f7b9347c0221
+  data.tar.gz: 8fbcfe52c12a78b6b7e26b2e8d7a35533b7558bbd2742466c5d79d87472306751db6f93b0eda4300b48cffb8bbda29f56a042bdc42426ffa3117604445bdd3a2

data/CHANGELOG.md

@@ -1,9 +1,11 @@
 # Hanami::Helpers
 View helpers for Ruby web applications
 
-## v1.1.2 - 2018-04-05
-### Fixed
-- [Luca Guidi] Ensure correct arity of `#form_for`, to be used in conjuction with `Hanami::Helpers::FormHelper::Form` (eg. `<%= form_for(form) { ... } %>`)
+## v1.2.0.beta1 - 2018-02-28
+## Added
+- [Luca Guidi] Introduced `csrf_meta_tags` helper to print meta tags for CSRF protection
+- [Luca Guidi] Added support for `form_for(..., remote: true)` which translates to `<form ... data-remote="true">`
+- [Sean Collins] Allow HTML attributes to be specified as an array of strings or symbols (eg `<%= html.span("foo", class: %w(ui form)) %>`)
 
 ## v1.1.1 - 2018-02-27
 ### Fixed

data/hanami-helpers.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.3.0'
 
-  spec.add_dependency 'hanami-utils', '~> 1.1'
+  spec.add_dependency 'hanami-utils', '1.2.0.beta1'
 
   spec.add_development_dependency 'bundler',    '~> 1.6'
   spec.add_development_dependency 'dry-struct', '~> 0.3'

data/lib/hanami/helpers/form_helper.rb

@@ -1,4 +1,5 @@
 require 'hanami/helpers/form_helper/form_builder'
+require 'hanami/helpers/html_helper'
 
 module Hanami
   module Helpers
@@ -97,6 +98,8 @@ module Hanami
       # @api private
       CSRF_TOKEN = :_csrf_token
 
+      include HtmlHelper
+
       # Form object
       #
       # @since 0.2.0
@@ -229,7 +232,7 @@ module Hanami
       #   @option options [Hash] :values An optional payload of objects to pass
       #   @param blk [Proc] A block that describes the contents of the form
       #
-      # @overload form_for(form, attributes = {}, &blk)
+      # @overload form_for(form, attributes, &blk)
       #   Use Form
       #   @param form [Hanami::Helpers::FormHelper::Form] a form object
       #   @param attributes [Hash] HTML attributes to pass to the form tag and form values
@@ -406,15 +409,18 @@ module Hanami
       #
       #     <button type="submit">Create</button>
       #   </form>
-      def form_for(name, url = nil, options = {}, &blk)
+      def form_for(name, url, options = {}, &blk)
         form = if name.is_a?(Form)
-                 options = url || {}
+                 options = url
                  name
                else
                  Form.new(name, url, options.delete(:values))
                end
 
-        attributes = { action: form.url, method: form.verb, 'accept-charset': DEFAULT_CHARSET, id: "#{form.name}-form" }.merge(options)
+        opts = options.dup
+        opts[:"data-remote"] = opts.delete(:remote) if opts.key?(:remote)
+        attributes = { action: form.url, method: form.verb, 'accept-charset': DEFAULT_CHARSET, id: "#{form.name}-form" }.merge(opts)
+
         FormBuilder.new(form, attributes, self, &blk)
       end
 
@@ -432,6 +438,36 @@ module Hanami
           locals[:session][CSRF_TOKEN]
         end
       end
+
+      # Prints CSRF meta tags for Unobtrusive JavaScript (UJS) purposes.
+      #
+      # @return [Hanami::Helpers::HtmlHelper::HtmlBuilder,NilClass] the tags if `csrf_token` is not `nil`
+      #
+      # @since 1.2.0
+      #
+      # @example
+      #   <html>
+      #     <head>
+      #       <!-- ... -->
+      #       <%= csrf_meta_tags %>
+      #     </head>
+      #     <!-- ... -->
+      #   </html>
+      #
+      #   <html>
+      #     <head>
+      #       <!-- ... -->
+      #       <meta name="csrf-param" value="_csrf_token">
+      #       <meta name="csrf-token" value="4a038be85b7603c406dcbfad4b9cdf91ec6ca138ed6441163a07bb0fdfbe25b5">
+      #     </head>
+      #     <!-- ... -->
+      #   </html>
+      def csrf_meta_tags
+        return if csrf_token.nil?
+
+        html.meta(name: "csrf-param", value: CSRF_TOKEN) +
+          html.meta(name: "csrf-token", value: csrf_token)
+      end
     end
   end
 end

data/lib/hanami/helpers/form_helper/form_builder.rb

@@ -81,11 +81,11 @@ module Hanami
 
         # Instantiate a form builder
         #
-        # @overload initialize(form, attributes, context, &blk)
+        # @overload initialize(form, attributes, params, &blk)
         #   Top level form
         #   @param form [Hanami::Helpers:FormHelper::Form] the form
         #   @param attributes [::Hash] a set of HTML attributes
-        #   @param context [Hanami::Helpers::FormHelper]
+        #   @param params [Hanami::Action::Params] request params
         #   @param blk [Proc] a block that describes the contents of the form
         #
         # @overload initialize(form, attributes, params, &blk)
@@ -1225,19 +1225,17 @@ module Hanami
         #     <option value="zw">Zimbabwe</option>
         #   </select>
         def select(name, values, attributes = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-          options     = attributes.delete(:options) { {} }
-          multiple    = attributes[:multiple]
-          attributes  = { name: _select_input_name(name, multiple), id: _input_id(name) }.merge(attributes)
-          prompt      = options.delete(:prompt)
-          selected    = options.delete(:selected)
-          input_value = _value(name)
+          options    = attributes.delete(:options) { {} }
+          attributes = { name: _select_input_name(name, attributes[:multiple]), id: _input_id(name) }.merge(attributes)
+          prompt     = options.delete(:prompt)
+          selected   = options.delete(:selected)
 
           super(attributes) do
             option(prompt) unless prompt.nil?
 
             already_selected = nil
             values.each do |content, value|
-              if (multiple || !already_selected) && (already_selected = _select_option_selected?(value, selected, input_value, multiple))
+              if (attributes[:multiple] || !already_selected) && (already_selected = _select_option_selected?(value, selected, _value(name), attributes[:multiple]))
                 option(content, { value: value, selected: SELECTED }.merge(options))
               else
                 option(content, { value: value }.merge(options))
@@ -1570,35 +1568,20 @@ module Hanami
           select_name
         end
 
+        # TODO: this has to be refactored
+        #
         # @api private
+        #
+        # rubocop:disable Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/PerceivedComplexity
         def _select_option_selected?(value, selected, input_value, multiple)
-          if input_value && selected.nil?
-            value.to_s == input_value
-          else
-            (value == selected) ||
-              _is_in_selected_values?(multiple, selected, value) ||
-              _is_current_value?(input_value, value) ||
-              _is_in_input_values?(multiple, input_value, value)
-          end
-        end
-
-        # @api private
-        def _is_current_value?(input_value, value)
-          return unless input_value
-          value.to_s == input_value.to_s
-        end
-
-        # @api private
-        def _is_in_selected_values?(multiple, selected, value)
-          return unless multiple && selected.is_a?(Array)
-          selected.include?(value)
-        end
-
-        # @api private
-        def _is_in_input_values?(multiple, input_value, value)
-          return unless multiple && input_value.is_a?(Array)
-          input_value.include?(value)
+          value == selected ||
+            (multiple && (selected.is_a?(Array) && selected.include?(value))) ||
+            (!input_value.nil? && (value.to_s == input_value.to_s)) ||
+            (multiple && (input_value.is_a?(Array) && input_value.include?(value)))
         end
+        # rubocop:enable Metrics/PerceivedComplexity
+        # rubocop:enable Metrics/CyclomaticComplexity
 
         # @api private
         def _check_box_checked?(value, input_value)

data/lib/hanami/helpers/html_helper/empty_html_node.rb

@@ -78,7 +78,7 @@ module Hanami
         # @api private
         def initialize(name, attributes)
           @name       = name
-          @attributes = attributes
+          @attributes = prepare_html_attributes(attributes)
         end
 
         # Resolve and return the output
@@ -129,6 +129,21 @@ module Hanami
         def attribute(attribute_name, value)
           %(#{ATTRIBUTES_SEPARATOR}#{attribute_name}="#{value}")
         end
+
+        # Changes any attributes values that are arrays into a string joined by
+        # a space, as HTML expects it.
+        #
+        # @param attributes [Hash] the attributes with values to be HTMLified
+        #
+        # @return [Hash] the attributes transformed into HTML friendly values, i.e space separated strings
+        #
+        # @since 1.2.0
+        def prepare_html_attributes(attributes)
+          attributes&.inject({}) do |attrs, (key, value)|
+            attrs[key] = value.is_a?(Array) ? value.join(ATTRIBUTES_SEPARATOR) : value
+            attrs
+          end
+        end
       end
     end
   end

data/lib/hanami/helpers/html_helper/html_node.rb

@@ -22,12 +22,12 @@ module Hanami
         def initialize(name, content, attributes, _options = {})
           @builder = HtmlBuilder.new
           @name    = name
-          @content = case content
-                     when Hash
+          @content = if content.is_a?(Hash)
                        @attributes = content
                        nil
                      else
-                       @attributes = attributes.to_h if attributes.respond_to?(:to_h)
+                       attributes_hash = attributes.to_h if attributes.respond_to?(:to_h)
+                       @attributes = prepare_html_attributes(attributes_hash)
                        content
                      end
         end

data/lib/hanami/helpers/version.rb

@@ -3,6 +3,6 @@ module Hanami
     # Define version
     #
     # @since 0.1.0
-    VERSION = '1.1.2'.freeze
+    VERSION = '1.2.0.beta1'.freeze
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hanami-helpers
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0.beta1
 platform: ruby
 authors:
 - Luca Guidi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-05 00:00:00.000000000 Z
+date: 2018-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.2.0.beta1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,9 +123,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.5