formtastic 3.1.0.rc1 → 3.1.0.rc2

data/CHANGELOG

@@ -1,4 +1,8 @@
-3.1.0.rc1 (unreleased)
+3.1.0.rc2
+
+* Deprecated :member_value and :member_label options
+
+3.1.0.rc1
 
 * Deprecated support for Rails version < 4.1.0
 * Fixed synchronization issues with custom_namespace configuration

data/DEPRECATIONS

@@ -9,6 +9,8 @@ v4.0 (planned)
 v3.1 (master)
 
 * Deprecate support for Rails < 4.1
+* Deprecate :member_value option
+* Deprecate :member_label option
 
 v3.0
 

data/README.textile

@@ -191,7 +191,7 @@ If you want to customize the label text, or render some hint text below the fiel
     <%= f.inputs :name => "Advanced Options", :id => "advanced" do %>
       <%= f.input :slug, :label => "URL Title", :hint => "Created automatically if left blank", :required => false %>
       <%= f.input :section, :as => :radio %>
-      <%= f.input :user, :label => "Author", :member_label => :full_name %>
+      <%= f.input :user, :label => "Author" %>
       <%= f.input :categories, :required => false %>
       <%= f.input :created_at, :as => :string, :label => "Publication Date", :required => false %>
     <% end %>
@@ -308,6 +308,9 @@ Many inputs provide a collection of options to choose from (like @:select@, @:ra
   f.input :authors, :as => :check_boxes, :collection => [@justin, @kate]
   f.input :authors, :as => :check_boxes, :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
   f.input :author,  :as => :select,      :collection => Author.all
+  f.input :author,  :as => :select,      :collection => Author.pluck(:first_name, :id)
+  f.input :author,  :as => :select,      :collection => Author.pluck(Arel.sql("CONCAT(`first_name`, ' ', `last_name`)"), :id)
+  f.input :author,  :as => :select,      :collection => Author.your_custom_scope_or_class_method
   f.input :author,  :as => :select,      :collection => { @justin.name => @justin.id, @kate.name => @kate.id }
   f.input :author,  :as => :select,      :collection => ["Justin", "Kate", "Amelia", "Gus", "Meg"]
   f.input :author,  :as => :radio,       :collection => User.all

data/lib/formtastic/helpers/input_helper.rb

@@ -141,12 +141,6 @@ module Formtastic
       # @option options :collection [Array<ActiveModel, String, Symbol>, Hash{String => String, Boolean}, OrderedHash{String => String, Boolean}]
       #   Override collection of objects in the association (`:select`, `:radio` & `:check_boxes` inputs only)
       #
-      # @option options :member_label [Symbol, Proc, Method]
-      #   Override the method called on each object in the `:collection` for use as the `<label>` content (`:check_boxes` & `:radio` inputs) or `<option>` content (`:select` inputs)
-      #
-      # @option options :member_value [Symbol, Proc, Method]
-      #   Override the method called on each object in the `:collection` for use as the `value` attribute in the `<input>` (`:check_boxes` & `:radio` inputs) or `<option>` (`:select` inputs)
-      #
       # @option options :multiple [Boolean]
       #   Specify if the `:select` input should allow multiple selections or not (defaults to `belongs_to` associations, and `true` for `has_many` and `has_and_belongs_to_many` associations)
       #

data/lib/formtastic/inputs/base.rb

@@ -11,6 +11,11 @@ module Formtastic
         @object_name = object_name
         @method = method
         @options = options.dup
+
+        # Deprecate :member_label and :member_value, remove v4.0
+        member_deprecation_message = "passing an Array of label/value pairs like [['Justin', 2], ['Kate', 3]] into :collection directly (consider building the array in your model using Model.pluck)"
+        warn_deprecated_option!(:member_label, member_deprecation_message)
+        warn_deprecated_option!(:member_value, member_deprecation_message)
       end
 
       # Usefull for deprecating options.
@@ -24,7 +29,7 @@ module Formtastic
       # Usefull for deprecating options.
       def warn_deprecated_option!(old_option_name, instructions)
         if options.key?(old_option_name)
-          ::ActiveSupport::Deprecation.warn("The :#{old_option_name} option is deprecated in favour of `#{instructions}` and will be removed in the next version", caller(6))
+          ::ActiveSupport::Deprecation.warn("The :#{old_option_name} option is deprecated in favour of `#{instructions}`. :#{old_option_name} will be removed in the next version", caller(6))
         end
       end
 

data/lib/formtastic/inputs/check_boxes_input.rb

@@ -39,6 +39,7 @@ module Formtastic
     #   <%= f.input :categories, :as => :check_boxes, :collection => @categories %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => Category.all %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => Category.some_named_scope %>
+    #   <%= f.input :categories, :as => :check_boxes, :collection => Category.pluck(:label, :id) %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => [Category.find_by_name("Ruby"), Category.find_by_name("Rails")] %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => ["Ruby", "Rails"] %>
     #   <%= f.input :categories, :as => :check_boxes, :collection => [["Ruby", "ruby"], ["Rails", "rails"]] %>
@@ -56,24 +57,6 @@ module Formtastic
     # @example `:disabled` can be used to disable any checkboxes with a value found in the given Array
     #   <%= f.input :categories, :as => :check_boxes, :collection => ["a", "b"], :disabled => ["a"] %>
     #
-    # @example `:member_label` can be used to call a different method (or a Proc) on each object in the collection for rendering the label text (it'll try the methods like `to_s` in `collection_label_methods` config by default)
-    #   <%= f.input :categories, :as => :check_boxes, :member_label => :name %>
-    #   <%= f.input :categories, :as => :check_boxes, :member_label => :name_with_post_count
-    #   <%= f.input :categories, :as => :check_boxes, :member_label => { |c| "#{c.name} (#{pluralize("post", c.posts.count)})" }
-    #
-    # @example `:member_label` can be used with a helper method (both examples have the same result)
-    #   <%= f.input :categories, :as => :check_boxes, :member_label => method(:fancy_label)
-    #   <%= f.input :categories, :as => :check_boxes, :member_label => Proc.new { |category| fancy_label(category) }
-    #
-    # @example `:member_value` can be used to call a different method (or a Proc) on each object in the collection for rendering the value for each checkbox (it'll try the methods like `id` in `collection_value_methods` config by default)
-    #   <%= f.input :categories, :as => :check_boxes, :member_value => :code %>
-    #   <%= f.input :categories, :as => :check_boxes, :member_value => :isbn
-    #   <%= f.input :categories, :as => :check_boxes, :member_value => Proc.new { |c| c.name.downcase.underscore }
-    #
-    # @example `:member_value` can be used with a helper method (both examples have the same result)
-    #   <%= f.input :categories, :as => :check_boxes, :member_value => method(:some_helper)
-    #   <%= f.input :categories, :as => :check_boxes, :member_value => Proc.new { |category| some_helper(category) }
-    #
     # @example `:value_as_class` can be used to add a class to the `<li>` wrapped around each choice using the checkbox value for custom styling of each choice
     #   <%= f.input :categories, :as => :check_boxes, :value_as_class => true %>
     #

data/lib/formtastic/inputs/radio_input.rb

@@ -31,10 +31,9 @@ module Formtastic
     # `Section.all` for a `Post` form with an input for a `belongs_to :section` association.
     # You can override or customise this collection through the `:collection` option (see examples).
     #
-    # The way on which Formtastic renders the `value` attribute and label for each choice is
-    # customisable through the `:member_label` and `:member_value` options (see examples below).
-    # When not provided, we fall back to a list of methods to try on each object such as
-    # `:to_label`, `:name` and `:to_s`, which are defined in the configurations
+    # The way on which Formtastic renders the `value` attribute and label for each choice in the `:collection` is
+    # customisable (see examples below). When not provided, we fall back to a list of methods to try on each 
+    # object such as `:to_label`, `:name` and `:to_s`, which are defined in the configurations
     # `collection_label_methods` and `collection_value_methods`.
     #
     # @example Basic `belongs_to` example with full form context
@@ -78,6 +77,8 @@ module Formtastic
     #   <%= f.input :author, :as => :radio, :collection => @authors %>
     #   <%= f.input :author, :as => :radio, :collection => Author.all %>
     #   <%= f.input :author, :as => :radio, :collection => Author.some_named_scope %>
+    #   <%= f.input :author, :as => :radio, :collection => Author.pluck(:full_name, :id) %>
+    #   <%= f.input :author, :as => :radio, :collection => Author.pluck(Arel.sql("CONCAT(`first_name`, ' ', `last_name`)"), :id)) %>
     #   <%= f.input :author, :as => :radio, :collection => [Author.find_by_login("justin"), Category.find_by_name("kate")] %>
     #   <%= f.input :author, :as => :radio, :collection => ["Justin", "Kate"] %>
     #   <%= f.input :author, :as => :radio, :collection => [["Justin", "justin"], ["Kate", "kate"]] %>
@@ -87,23 +88,6 @@ module Formtastic
     #   <%= f.input :author, :as => :radio, :collection => [:justin, :kate] %>
     #   <%= f.input :author, :as => :radio, :collection => 1..5 %>
     #
-    # @example The `:member_label` can be used to call a different method (or a Proc) on each object in the collection for rendering the label text (it'll try the methods like `to_s` in `collection_label_methods` config by default)
-    #   <%= f.input :author, :as => :radio, :member_label => :name %>
-    #   <%= f.input :author, :as => :radio, :member_label => :name_with_post_count
-    #   <%= f.input :author, :as => :radio, :member_label => Proc.new { |a| "#{c.name} (#{pluralize("post", a.posts.count)})" }
-    #
-    # @example `:member_label` can be used with a helper method (both examples have the same result)
-    #   <%= f.input :author, :as => :radio, :member_label => method(:fancy_label)
-    #   <%= f.input :author, :as => :radio, :member_label => Proc.new { |author| fancy_label(author) }
-    #
-    # @example The `:member_value` can be used to call a different method (or a Proc) on each object in the collection for rendering the value for each checkbox (it'll try the methods like `id` in `collection_value_methods` config by default)
-    #   <%= f.input :author, :as => :radio, :member_value => :login %>
-    #   <%= f.input :author, :as => :radio, :member_value => Proc.new { |c| c.full_name.downcase.underscore }
-    #
-    # @example `:member_value` can be used with a helper method (both examples have the same result)
-    #   <%= f.input :author, :as => :radio, :member_value => method(:some_helper)
-    #   <%= f.input :author, :as => :radio, :member_value => Proc.new { |author| some_helper(author) }
-    #
     # @example Set HTML attributes on each `<input type="radio">` tag with `:input_html`
     #   <%= f.input :author, :as => :radio, :input_html => { :size => 20, :multiple => true, :class => "special" } %>
     #

data/lib/formtastic/inputs/select_input.rb

@@ -94,6 +94,8 @@ module Formtastic
     #   <%= f.input :author, :as => :select, :collection => @authors %>
     #   <%= f.input :author, :as => :select, :collection => Author.all %>
     #   <%= f.input :author, :as => :select, :collection => Author.some_named_scope %>
+    #   <%= f.input :author, :as => :select, :collection => Author.pluck(:full_name, :id) %>
+    #   <%= f.input :author, :as => :select, :collection => Author.pluck(Arel.sql("CONCAT(`first_name`, ' ', `last_name`)"), :id)) %>
     #   <%= f.input :author, :as => :select, :collection => [Author.find_by_login("justin"), Category.find_by_name("kate")] %>
     #   <%= f.input :author, :as => :select, :collection => ["Justin", "Kate"] %>
     #   <%= f.input :author, :as => :select, :collection => [["Justin", "justin"], ["Kate", "kate"]] %>
@@ -106,15 +108,6 @@ module Formtastic
     #   <%= f.input :author, :as => :select, :collection => grouped_options_for_select(...) %>
     #   <%= f.input :author, :as => :select, :collection => time_zone_options_for_select(...) %>
     #
-    # @example The `:member_label` can be used to call a different method (or a Proc) on each object in the collection for rendering the label text (it'll try the methods like `to_s` in `collection_label_methods` config by default)
-    #   <%= f.input :author, :as => :select, :member_label => :name %>
-    #   <%= f.input :author, :as => :select, :member_label => :name_with_post_count %>
-    #   <%= f.input :author, :as => :select, :member_label => Proc.new { |a| "#{c.name} (#{pluralize("post", a.posts.count)})" } %>
-    #
-    # @example The `:member_value` can be used to call a different method (or a Proc) on each object in the collection for rendering the value for each checkbox (it'll try the methods like `id` in `collection_value_methods` config by default)
-    #   <%= f.input :author, :as => :select, :member_value => :login %>
-    #   <%= f.input :author, :as => :select, :member_value => Proc.new { |c| c.full_name.downcase.underscore } %>
-    #
     # @example Set HTML attributes on the `<select>` tag with `:input_html`
     #   <%= f.input :authors, :as => :select, :input_html => { :size => 20, :multiple => true, :class => "special" } %>
     #

data/lib/formtastic/version.rb

@@ -1,3 +1,3 @@
 module Formtastic
-  VERSION = "3.1.0.rc1"
+  VERSION = "3.1.0.rc2"
 end

data/spec/inputs/check_boxes_input_spec.rb

@@ -350,9 +350,12 @@ describe 'check_boxes input' do
         item.stub(:custom_value).and_return('custom_value')
         item.should_receive(:custom_value).exactly(3).times
         @new_post.author.should_receive(:custom_value).exactly(1).times
-        concat(semantic_form_for(@new_post) do |builder|
-          concat(builder.input(:author, :as => :check_boxes, :member_value => :custom_value, :collection => [item, item, item]))
-        end)
+        
+        with_deprecation_silenced do
+          concat(semantic_form_for(@new_post) do |builder|
+            concat(builder.input(:author, :as => :check_boxes, :member_value => :custom_value, :collection => [item, item, item]))
+          end)
+        end
         output_buffer.should have_tag('input[@type=checkbox][@value="custom_value"]', :count => 3)
       end
     end

data/spec/inputs/label_spec.rb

@@ -68,16 +68,20 @@ describe 'Formtastic::FormBuilder#label' do
 
   describe 'when a collection is given' do
     it 'should use a supplied label_method for simple collections' do
-      concat(semantic_form_for(:project, :url => 'http://test.host') do |builder|
-        concat(builder.input(:author_id, :as => :check_boxes, :collection => [:a, :b, :c], :member_value => :to_s, :member_label => proc {|f| ('Label_%s' % [f])}))
-      end)
+      with_deprecation_silenced do
+        concat(semantic_form_for(:project, :url => 'http://test.host') do |builder|
+          concat(builder.input(:author_id, :as => :check_boxes, :collection => [:a, :b, :c], :member_value => :to_s, :member_label => proc {|f| ('Label_%s' % [f])}))
+        end)
+      end
       output_buffer.should have_tag('form li fieldset ol li label', /Label_[abc]/, :count => 3)
     end
 
     it 'should use a supplied value_method for simple collections' do
-      concat(semantic_form_for(:project, :url => 'http://test.host') do |builder|
-        concat(builder.input(:author_id, :as => :check_boxes, :collection => [:a, :b, :c], :member_value => proc {|f| ('Value_%s' % [f.to_s])}))
-      end)
+      with_deprecation_silenced do
+        concat(semantic_form_for(:project, :url => 'http://test.host') do |builder|
+          concat(builder.input(:author_id, :as => :check_boxes, :collection => [:a, :b, :c], :member_value => proc {|f| ('Value_%s' % [f.to_s])}))
+        end)
+      end
       output_buffer.should have_tag('form li fieldset ol li label input[value="Value_a"]')
       output_buffer.should have_tag('form li fieldset ol li label input[value="Value_b"]')
       output_buffer.should have_tag('form li fieldset ol li label input[value="Value_c"]')

data/spec/spec_helper.rb

@@ -534,7 +534,16 @@ RSpec.configure do |config|
   config.before(:each) do
     Formtastic::Localizer.cache.clear!    
   end
-  
+
+  config.before(:each) do
+    allow(Formtastic.deprecation).to receive(:deprecation_warning).and_call_original
+    # TODO: Remove this in Formtastic 4
+    [ :action_class, :standard_action_class_name, :custom_action_class_name,
+      :input_class, :standard_input_class_name, :custom_input_class_name ].each do |method|
+      allow(Formtastic.deprecation).to receive(:deprecation_warning).with(method, instance_of(String), instance_of(Array))
+    end
+  end
+
   config.before(:all) do
     DeferredGarbageCollection.start unless ENV["DEFER_GC"] == "false"
   end

data/spec/support/custom_macros.rb

@@ -428,9 +428,11 @@ module CustomMacros
 
           describe 'as a symbol' do
             before do
-              concat(semantic_form_for(@new_post) do |builder|
-                concat(builder.input(:author, :as => as, :member_label => :login))
-              end)
+              with_deprecation_silenced do
+                concat(semantic_form_for(@new_post) do |builder|
+                  concat(builder.input(:author, :as => as, :member_label => :login))
+                end)
+              end
             end
 
             it 'should have options with text content from the specified method' do
@@ -442,9 +444,11 @@ module CustomMacros
 
           describe 'as a proc' do
             before do
-              concat(semantic_form_for(@new_post) do |builder|
-                concat(builder.input(:author, :as => as, :member_label => Proc.new {|a| a.login.reverse }))
-              end)
+              with_deprecation_silenced do
+                concat(semantic_form_for(@new_post) do |builder|
+                  concat(builder.input(:author, :as => as, :member_label => Proc.new {|a| a.login.reverse }))
+                end)
+              end
             end
 
             it 'should have options with the proc applied to each' do
@@ -459,9 +463,11 @@ module CustomMacros
               def reverse_login(a)
                 a.login.reverse
               end
-              concat(semantic_form_for(@new_post) do |builder|
-                concat(builder.input(:author, :as => as, :member_label => method(:reverse_login)))
-              end)
+              with_deprecation_silenced do
+                concat(semantic_form_for(@new_post) do |builder|
+                  concat(builder.input(:author, :as => as, :member_label => method(:reverse_login)))
+                end)
+              end
             end
 
             it 'should have options with the proc applied to each' do
@@ -480,9 +486,11 @@ module CustomMacros
                 @fred.stub(:respond_to?) { |m| m.to_s == label_method || m.to_s == 'id' }
                 [@fred, @bob].each { |a| a.stub(label_method).and_return('The Label Text') }
 
-                concat(semantic_form_for(@new_post) do |builder|
-                  concat(builder.input(:author, :as => as))
-                end)
+                with_deprecation_silenced do
+                  concat(semantic_form_for(@new_post) do |builder|
+                    concat(builder.input(:author, :as => as))
+                  end)
+                end
               end
 
               it "should render the options with #{label_method} as the label" do
@@ -499,9 +507,11 @@ module CustomMacros
 
           describe 'as a symbol' do
             before do
-              concat(semantic_form_for(@new_post) do |builder|
-                concat(builder.input(:author, :as => as, :member_value => :login))
-              end)
+              with_deprecation_silenced do
+                concat(semantic_form_for(@new_post) do |builder|
+                  concat(builder.input(:author, :as => as, :member_value => :login))
+                end)
+              end
             end
 
             it 'should have options with values from specified method' do
@@ -513,9 +523,11 @@ module CustomMacros
 
           describe 'as a proc' do
             before do
-              concat(semantic_form_for(@new_post) do |builder|
-                concat(builder.input(:author, :as => as, :member_value => Proc.new {|a| a.login.reverse }))
-              end)
+              with_deprecation_silenced do
+                concat(semantic_form_for(@new_post) do |builder|
+                  concat(builder.input(:author, :as => as, :member_value => Proc.new {|a| a.login.reverse }))
+                end)
+              end
             end
 
             it 'should have options with the proc applied to each value' do
@@ -530,9 +542,11 @@ module CustomMacros
               def reverse_login(a)
                 a.login.reverse
               end
-              concat(semantic_form_for(@new_post) do |builder|
-                concat(builder.input(:author, :as => as, :member_value => method(:reverse_login)))
-              end)
+              with_deprecation_silenced do
+                concat(semantic_form_for(@new_post) do |builder|
+                  concat(builder.input(:author, :as => as, :member_value => method(:reverse_login)))
+                end)
+              end
             end
 
             it 'should have options with the proc applied to each value' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formtastic
 version: !ruby/object:Gem::Version
-  version: 3.1.0.rc1
+  version: 3.1.0.rc2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-04 00:00:00.000000000 Z
+date: 2014-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack