foundation_rails_helper 2.0.0 → 3.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eaf080baa48830a883681c55c892a30b366deabc
-  data.tar.gz: 84a7e2dd8b70cbbe2b622a41bc9d3500bae8f396
+  metadata.gz: f82cdd3a1e082e60417f16ac49f49bac77b92aa9
+  data.tar.gz: 12c3e4a9a151295dab07c4d66e6cc7aaf603aa87
 SHA512:
-  metadata.gz: b578327401357039bf3ec51d10c45c86f36183f86f682ea0b303c181da14278a7a3f4de4223c92c7c451d7dccba539eec8e7799c490c855bc7a9eabd7b70cfbc
-  data.tar.gz: b8d41f62ad350069855247e1bdc1672c6ae08d549424768123dd67500e79eb5e1bcea1dbe820ef4e79822ec04a251f6eddf67cdde003c40bbc28e3fb725fbdbf
+  metadata.gz: 10148a13208ea0dfb88669e319e7b0e98c6f53cc013bfc96c152a245d21b69dc9c2853ce55dad19fadf6f00aee3e66ba9273c185f051999097d9379d9b4193dc
+  data.tar.gz: 6f6ae496a923551dc81d375689f056accc381e59c4990ffefeb664df9e4112fb1965693e65129664b5628ec81a8fd0c7155cd76f4cc879a42b3c09569939adc8

data/.rubocop.yml

@@ -9,11 +9,8 @@ AllCops:
   Exclude:
     - 'vendor/**/*'
 
-# A quick fix for not having magic comments at the top of each file
-# # frozen_string_literal: true
-# https://github.com/bbatsov/rubocop/issues/3284
-FrozenStringLiteralComment:
-  Enabled: false
-
 Documentation:
   Enabled: false
+
+Style/VariableNumber:
+    EnforcedStyle: 'snake_case'

data/.rubocop_todo.yml

@@ -1,67 +1,25 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-09-14 16:08:41 -0700 using RuboCop version 0.42.0.
+# on 2017-01-13 13:27:28 -0800 using RuboCop version 0.44.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-Lint/NestedMethodDefinition:
-  Exclude:
-    - 'spec/support/mock_rails.rb'
-
-# Offense count: 3
+# Offense count: 1
 Metrics/AbcSize:
-  Max: 179
+  Max: 17
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 186
+  Max: 183
 
 # Offense count: 1
 Metrics/CyclomaticComplexity:
   Max: 7
 
-# Offense count: 157
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 163
-
-# Offense count: 5
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 55
-
 # Offense count: 1
 # Configuration parameters: CountComments.
-Metrics/ModuleLength:
-  Max: 102
-
-# Offense count: 2
-# Configuration parameters: CountKeywordArgs.
-Metrics/ParameterLists:
-  Max: 8
-
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 8
-
-# Offense count: 3
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'spec/support/mock_rails.rb'
-
-# Offense count: 1
-# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist.
-# NamePrefix: is_, has_, have_
-# NamePrefixBlacklist: is_, has_, have_
-# NameWhitelist: is_a?
-Style/PredicateName:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/foundation_rails_helper/form_builder.rb'
+Metrics/MethodLength:
+  Max: 13

data/CHANGELOG.md

@@ -1,8 +1,13 @@
+## Version 3.0.0
+* Added Foundation 6 support
+* Added auto_labels config
+
 ## Version 2.0
 This will be used for Foundation 5 support
 
 ### Breaking changes:
 * Dropped support for Ruby 1.9.3
+* display_flash_messages now requires the key_matching hash to be prefixed with the keyword argument :key_matching
 
 ### Features:
 * Add Rubocop code style linting

data/Gemfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in foundation_rails_helper.gemspec

data/README.md

@@ -9,15 +9,14 @@ So far it includes:
 
 * A custom FormBuilder that generates a form using the Foundation framework classes. It replaces the current `form_for`, so there is no need to change your Rails code. Error messages are properly displayed.
 
-* A `display_flash_messages` helper method that uses Zurb Foundation Alerts UI.
+* A `display_flash_messages` helper method that uses Zurb Foundation Callout UI.
 
 #### Compatibility
 
-* Only Rails 4.1/4.2/5 and Foundation 5 are fully supported
-* Some features may work with Foundation 4 and older, but results may vary, and markup which exists only for those versions will be gradually removed
-* Legacy branches exist for Rails 3 and 4.0 (see the rails3 and rails4.0 branches). These are not actively supported, and fixes are not retroactively applied, but pull requests are welcome.
-* We test against ruby versions 2.1 and up. This gem may still work fine on
-  1.9.3, but your mileage may vary
+* Only Rails 4.1/4.2/5, and Foundation 6 are fully supported
+* Some features may work with Foundation 5 and older, but results may vary, and markup which exists only for those versions will be gradually removed
+* Legacy branches exist for Rails 3, 4.0, and Foundation 5 (see the rails3, rails4.0, and foundation-5 branches). These are not actively supported, and fixes are not retroactively applied, but pull requests are welcome.
+* We test against ruby versions 2.1 and up. This gem may still work fine on 1.9.3, but your mileage may vary
 
 
 ## Screenshots
@@ -27,7 +26,7 @@ A classic devise sign up view will look like this:
 
 ```erb
 <%= form_for(resource, :as => resource_name, :url => registration_path(resource_name)) do |f| %>
-  <%= f.email_field :email, label: 'E-mail' %>
+  <%= f.email_field :email %>
   <%= f.password_field :password %>
   <%= f.password_field :password_confirmation %>
 
@@ -45,10 +44,10 @@ A classic devise sign up view will look like this:
   <tbody>
     <tr>
       <td valign='top'>
-        <img src="https://cloud.githubusercontent.com/assets/1400414/5994195/d9b467ce-aa1e-11e4-914c-f696724b53ed.png"/>
+        <img src="https://cloud.githubusercontent.com/assets/1400414/18522106/8b981524-7a63-11e6-8450-0605cc310205.png"/>
       </td>
       <td valign='top'>
-        <img src="https://cloud.githubusercontent.com/assets/1400414/5994196/dbf4bc0a-aa1e-11e4-8c18-b7d3b1b370dc.png"/>
+        <img src="https://cloud.githubusercontent.com/assets/1400414/18522107/8d0bfa24-7a63-11e6-8c0a-12757528b9ee.png"/>
       </td>
     </tr>
   </tbody>
@@ -56,15 +55,15 @@ A classic devise sign up view will look like this:
 
 ### Flash messages
 
-![Flash-message](https://cloud.githubusercontent.com/assets/393167/5845238/563dc094-a1b2-11e4-8548-2dd2950a60be.png "Flash-message")
+![Flash-message](https://cloud.githubusercontent.com/assets/1400414/18522256/3d13c97e-7a64-11e6-9ee2-33adc93cd573.png "Flash-message")
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'foundation-rails'
-gem 'foundation_rails_helper', '~> 1.2.0'
+gem 'foundation-rails', '~> 6.0' # required
+gem 'foundation_rails_helper', '>= 3.0.0.beta3', '< 4.0'
 ```
 
 And then execute:
@@ -124,21 +123,21 @@ Change the label text and add a class on the label:
 f.text_field :name, label: 'Nombre', label_options: { class: 'large' }
 ```
 
-If the hint option is specified
+If the help_text option is specified
 
 ```ruby
-f.text_field :name, hint: "I'm a text field"
+f.text_field :name, help_text: "I'm a text field"
 ```
 
-an additional span element will be added after the input element:
+an additional p element will be added after the input element:
 
 ```html
-<span class="hint">I'm a text field</span>
+<p class="help-text">I'm a text field</p>
 ```
 
 ### Submit Button
 
-The 'submit' helper wraps the rails helper and sets the class attribute to "small radius success button" by default.
+The 'submit' helper wraps the rails helper and sets the class attribute to "success button" by default.
 
 ```ruby
 f.submit
@@ -147,7 +146,7 @@ f.submit
 generates:
 
 ```html
-<input class="small radius success button" name="commit" type="submit" value="Create User">
+<input class="success button" name="commit" type="submit" value="Create User">
 ```
 
 Specify the class option to override the default classes.
@@ -163,9 +162,9 @@ f.email_field :email
 generates:
 
 ```html
-<label class="error" for="user_email">Email</label>
-<input class="error" id="user_email" name="user[email]" type="email" value="">
-<small class="error">can't be blank</small>
+<label class="is-invalid-label" for="user_email">Email</label>
+<input class="is-invalid-input" id="user_email" name="user[email]" type="email" value="">
+<small class="form-error is-visible">can't be blank</small>
 ```
 
 The class attribute of the 'small' element will mirror the class attribute of the 'input' element.
@@ -205,8 +204,8 @@ Currently supported options:
 ### Submit Button Class
 To use a different class for the [submit button](https://github.com/sgruhier/foundation_rails_helper#submit-button) used in `form_for`, add a config named **button_class**:
 ```ruby
-# Default: 'small radius success button'
-config.button_class = 'large secondary button'
+# Default: 'success button'
+config.button_class = 'large hollow secondary button'
 ```
 
 Please note, the button class can still be overridden by an options hash.
@@ -227,6 +226,4 @@ See the [CONTRIBUTING](CONTRIBUTING.md) file.
 
 ## Copyright
 
-Sébastien Gruhier (http://xilinus.com, http://v2.maptimize.com) - MIT LICENSE - 2015
-
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/sgruhier/foundation_rails_helper/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+Sébastien Gruhier (http://xilinus.com, http://v2.maptimize.com) - MIT LICENSE

data/Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

data/foundation_rails_helper.gemspec

@@ -1,39 +1,43 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
 require File.expand_path('../lib/foundation_rails_helper/version', __FILE__)
 
-Gem::Specification.new do |gem|
-  gem.authors       = ['Sebastien Gruhier']
-  gem.email         = ['sebastien.gruhier@xilinus.com']
-  gem.description   = 'Rails for zurb foundation CSS framework. Form builder, flash message, ...'
-  gem.summary       = 'Rails helpers for zurb foundation CSS framework'
-  gem.homepage      = 'http://github.com/sgruhier/foundation_rails_helper'
-
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.name          = 'foundation_rails_helper'
-  gem.require_paths = ['lib']
-  gem.version       = FoundationRailsHelper::VERSION
-  gem.license       = 'MIT'
+class Gem::Specification # rubocop:disable ClassAndModuleChildren
+  def self.rails_gem_version
+    # Allow different versions of the rails gems to be specified, for testing
+    @rails_gem_version ||=
+      if ENV['RAILS_VERSION']
+        "~> #{ENV['RAILS_VERSION']}"
+      else
+        ['~> 5.0', '>= 5.0.0']
+      end
+  end
+end
 
-  # Allow different versions of the rails gems to be specified, for testing:
-  rails_version = ENV['RAILS_VERSION'] || 'default'
+Gem::Specification.new do |gem|
+  gem.authors = ['Sebastien Gruhier']
+  gem.email = ['sebastien.gruhier@xilinus.com']
+  gem.description =
+    'Rails for zurb foundation CSS framework. Form builder, flash message, ...'
+  gem.summary = 'Rails helpers for zurb foundation CSS framework'
+  gem.homepage = 'http://github.com/sgruhier/foundation_rails_helper'
 
-  rails = case rails_version
-          when 'default'
-            '>= 4.1'
-          else
-            "~> #{rails_version}"
-          end
+  gem.executables =
+    `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name = 'foundation_rails_helper'
+  gem.require_paths = %w(lib)
+  gem.version = FoundationRailsHelper::VERSION
+  gem.license = 'MIT'
 
-  gem.add_dependency 'railties',      rails
-  gem.add_dependency 'actionpack',    rails
-  gem.add_dependency 'activemodel',   rails
-  gem.add_dependency 'activesupport', rails
-  gem.add_dependency 'tzinfo',        '~> 1.2', '>= 1.2.2'
+  gem.add_dependency 'railties', Gem::Specification.rails_gem_version
+  gem.add_dependency 'actionpack', Gem::Specification.rails_gem_version
+  gem.add_dependency 'activemodel', Gem::Specification.rails_gem_version
+  gem.add_dependency 'activesupport', Gem::Specification.rails_gem_version
+  gem.add_dependency 'tzinfo', '~> 1.2', '>= 1.2.2'
 
-  gem.add_development_dependency 'rspec-rails', '>= 3.1'
-  gem.add_development_dependency 'mime-types',  '~> 2'
-  gem.add_development_dependency 'capybara',    '~> 2.7'
-  gem.add_development_dependency 'rubocop',     '> 0.41'
+  gem.add_development_dependency 'rspec-rails', '~> 3.1'
+  gem.add_development_dependency 'mime-types', '~> 2'
+  gem.add_development_dependency 'capybara', '~> 2.7'
+  gem.add_development_dependency 'rubocop', '~> 0.44.1'
 end

data/lib/foundation_rails_helper.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
 require 'foundation_rails_helper/version'
 require 'foundation_rails_helper/configuration'
 require 'foundation_rails_helper/form_builder'
+require 'foundation_rails_helper/size_class_calculator'
 require 'foundation_rails_helper/flash_helper'
 require 'foundation_rails_helper/action_view_extension'
 ActiveSupport.on_load(:action_view) do

data/lib/foundation_rails_helper/action_view_extension.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ActionView::Base.default_form_builder = FoundationRailsHelper::FormBuilder
 ActionView::Base.field_error_proc = proc do |html_tag, _instance_tag|
   html_tag

data/lib/foundation_rails_helper/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module FoundationRailsHelper
   class << self
     attr_writer :configuration
@@ -18,10 +19,12 @@ module FoundationRailsHelper
   class Configuration
     attr_accessor :button_class
     attr_accessor :ignored_flash_keys
+    attr_accessor :auto_labels
 
     def initialize
-      @button_class = 'small radius success button'
+      @button_class = 'success button'
       @ignored_flash_keys = []
+      @auto_labels = true
     end
   end
 end

data/lib/foundation_rails_helper/flash_helper.rb

@@ -1,44 +1,71 @@
+# frozen_string_literal: true
 require 'action_view/helpers'
 
 module FoundationRailsHelper
   module FlashHelper
-    # <div class="alert-box [success alert secondary]">
+    # <div class="callout [success alert secondary]" data-closable>
     #   This is an alert box.
-    #   <a href="" class="close">&times;</a>
+    #   <button name="button" type="submit" class="close-button" data-close="">
+    #     <span>&times;</span>
+    #   </button>
     # </div>
     DEFAULT_KEY_MATCHING = {
-      alert: :alert,
-      notice: :success,
-      info: :info,
+      alert:     :alert,
+      notice:    :success,
+      info:      :info,
       secondary: :secondary,
-      success: :success,
-      error: :alert,
-      warning: :warning
+      success:   :success,
+      error:     :alert,
+      warning:   :warning,
+      primary:   :primary
     }.freeze
-    def display_flash_messages(key_matching = {})
+
+    # Displays the flash messages found in ActionDispatch's +flash+ hash using
+    # Foundation's +callout+ component.
+    #
+    # Parameters:
+    # * +closable+ - A boolean to determine whether the displayed flash messages
+    # should be closable by the user. Defaults to true.
+    # * +key_matching+ - A Hash of key/value pairs mapping flash keys to the
+    # corresponding class to use for the callout box.
+    def display_flash_messages(closable: true, key_matching: {})
       key_matching = DEFAULT_KEY_MATCHING.merge(key_matching)
-      key_matching.default = :standard
+      key_matching.default = :primary
 
       capture do
         flash.each do |key, value|
-          next if FoundationRailsHelper.configuration.ignored_flash_keys.include? key.to_sym
+          next if ignored_key?(key.to_sym)
+
           alert_class = key_matching[key.to_sym]
-          concat alert_box(value, alert_class)
+          concat alert_box(value, alert_class, closable)
         end
       end
     end
 
     private
 
-    def alert_box(value, alert_class)
-      content_tag :div, data: { alert: '' }, class: "alert-box #{alert_class}" do
+    def alert_box(value, alert_class, closable)
+      options = { class: "flash callout #{alert_class}" }
+      options[:data] = { closable: '' } if closable
+      content_tag(:div, options) do
         concat value
-        concat close_link
+        concat close_link if closable
       end
     end
 
     def close_link
-      link_to('&times;'.html_safe, '#', class: :close)
+      button_tag(
+        class: 'close-button',
+        type: 'button',
+        data: { close: '' },
+        aria: { label: 'Dismiss alert' }
+      ) do
+        content_tag(:span, '&times;'.html_safe, aria: { hidden: true })
+      end
+    end
+
+    def ignored_key?(key)
+      FoundationRailsHelper.configuration.ignored_flash_keys.include?(key)
     end
   end
 end