formtastic 3.1.3 → 3.1.4

data/lib/formtastic/inputs/base/validations.rb

@@ -136,9 +136,10 @@ module Formtastic
           return true if options[:required] == true
           return false if not_required_through_negated_validation?
           if validations?
-            validations.select { |validator|
+            validations.any? { |validator|
               if validator.options.key?(:on)
-                return false if (validator.options[:on] != :save) && ((object.new_record? && validator.options[:on] != :create) || (!object.new_record? && validator.options[:on] != :update))
+                validator_on = Array(validator.options[:on])
+                next false if (validator_on.exclude?(:save)) && ((object.new_record? && validator_on.exclude?(:create)) || (!object.new_record? && validator_on.exclude?(:update)))
               end
               case validator.kind
               when :presence
@@ -152,7 +153,7 @@ module Formtastic
               else
                 false
               end
-            }.any?
+            }
           else
             return responds_to_global_required? && !!builder.all_fields_required_by_default
           end
@@ -192,6 +193,21 @@ module Formtastic
           validation_limit || column_limit
         end
 
+        def readonly?
+          readonly_from_options? || readonly_attribute?
+        end
+
+        def readonly_attribute?
+          object_class = self.object.class
+          object_class.respond_to?(:readonly_attributes) &&
+            self.object.persisted? &&
+            column.respond_to?(:name) &&
+            object_class.readonly_attributes.include?(column.name.to_s)
+        end
+
+        def readonly_from_options?
+          options[:input_html] && options[:input_html][:readonly]
+        end
       end
     end
   end

data/lib/formtastic/inputs/check_boxes_input.rb

@@ -69,6 +69,11 @@ module Formtastic
       include Base::Collections
       include Base::Choices
 
+      def initialize(*args)
+        super
+        raise Formtastic::UnsupportedEnumCollection if collection_from_enum?
+      end
+
       def to_html
         input_wrapping do
           choices_wrapping do
@@ -175,11 +180,14 @@ module Formtastic
       def make_selected_values
         if object.respond_to?(method)
           selected_items = object.send(method)
-
           # Construct an array from the return value, regardless of the return type
           selected_items = [*selected_items].compact.flatten
 
-          [*selected_items.map { |o| send_or_call_or_object(value_method, o) }].compact
+          selected = []
+          selected_items.map do |selected_item|
+            selected_item_id = selected_item.id if selected_item.respond_to? :id
+            item = send_or_call_or_object(value_method, selected_item) || selected_item_id
+          end.compact
         else
           []
         end

data/lib/formtastic/inputs/country_input.rb

@@ -67,8 +67,10 @@ module Formtastic
     class CountryInput 
       include Base
 
+      CountrySelectPluginMissing = Class.new(StandardError)
+
       def to_html
-        raise "To use the :country input, please install a country_select plugin, like this one: https://github.com/stefanpenner/country_select" unless builder.respond_to?(:country_select)
+        raise CountrySelectPluginMissing, "To use the :country input, please install a country_select plugin, like this one: https://github.com/stefanpenner/country_select" unless builder.respond_to?(:country_select)
         input_wrapping do
           label_html <<
           builder.country_select(method, priority_countries, input_options, input_html_options)

data/lib/formtastic/inputs/radio_input.rb

@@ -31,6 +31,10 @@ 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).
     #
+    # For radio inputs that map to ActiveRecord `enum` attributes, Formtastic will automatically
+    # load in your enum options to be used as the radio button choices. This can be overridden with
+    # the `:collection` option, or augmented with I18n translations. See examples below.
+    #
     # 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
@@ -100,6 +104,22 @@ module Formtastic
     # @example Set HTML options on a specific radio input option with a 3rd element in the array for a collection member
     #   <%= f.input :author, :as => :radio, :collection => [["Test", 'test'], ["Try", "try", {:disabled => true}]]
     #
+    # @example Using ActiveRecord enum attribute with i18n translation:
+    #   # post.rb
+    #   class Post < ActiveRecord::Base
+    #     enum :status => [ :active, :archived ]
+    #   end
+    #   # en.yml
+    #   en:
+    #     activerecord:
+    #       attributes:
+    #         post:
+    #           statuses:
+    #             active: I am active!
+    #             archived: I am archived!
+    #   # form
+    #   <%= f.input :status, :as => :radio %>
+    #
     # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
     # @see Formtastic::Inputs::RadioInput as an alternative for `belongs_to` associations
     #

data/lib/formtastic/inputs/select_input.rb

@@ -8,6 +8,7 @@ module Formtastic
     # This is the default input choice when:
     #
     # * the database column type is an `:integer` and there is an association (`belongs_to`)
+    # * the database column type is an `:integer` and there is an enum defined (`enum`)
     # * the database column type is a `:string` and the `:collection` option is used
     # * there an object with an association, but no database column on the object (`has_many`, etc)
     # * there is no object and the `:collection` option is used
@@ -38,6 +39,13 @@ module Formtastic
     # `:to_s`, which are defined in the configurations `collection_label_methods` and
     # `collection_value_methods` (see examples below).
     #
+    # For select inputs that map to ActiveRecord `enum` attributes, Formtastic will automatically
+    # load in your enum options to be used as the select's options. This can be overridden with
+    # the `:collection` option, or augmented with I18n translations. See examples below.
+    # An error is raised if you try to render a multi-select with an enum, as ActiveRecord can
+    # only store one choice in the database.
+    #
+    #
     # @example Basic `belongs_to` example with full form context
     #
     #     <%= semantic_form_for @post do |f| %>
@@ -124,6 +132,21 @@ module Formtastic
     #   <%= f.input :author, :as => :select, :prompt => true %>   =>   <option value="">Please select</option>
     #   <%= f.input :author, :as => :select, :prompt => "Please select an author" %>
     #
+    # @example Using ActiveRecord enum attribute with i18n translation:
+    #   # post.rb
+    #   class Post < ActiveRecord::Base
+    #     enum :status => [ :active, :archived ]
+    #   end
+    #   # en.yml
+    #   en:
+    #     activerecord:
+    #       attributes:
+    #         post:
+    #           statuses:
+    #             active: I am active!
+    #             archived: I am archived!
+    #   # form
+    #   <%= f.input :status, :as => :select %>
     #
     # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
     # @see Formtastic::Inputs::CheckBoxesInput CheckBoxesInput as an alternative for `has_many` and `has_and_belongs_to_many` associations
@@ -134,6 +157,11 @@ module Formtastic
       include Base
       include Base::Collections
 
+      def initialize(*args)
+        super
+        raise Formtastic::UnsupportedEnumCollection if collection_from_enum? && multiple?
+      end
+
       def to_html
         input_wrapping do
           label_html <<

data/lib/formtastic/inputs/time_zone_input.rb

@@ -28,9 +28,19 @@ module Formtastic
     #
     # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
     #
-    # @todo document :priority_zones option
-    # @todo configurable default :priority_zones?
-    class TimeZoneInput 
+    # The priority_zones option:
+    #   Since this input actually uses Rails' `time_zone_select` helper, the :priority_zones
+    #   option needs to be an array of ActiveSupport::TimeZone objects.
+    #
+    #   And you can configure default value using
+    #
+    #   ```
+    #     Formtastic::FormBuilder.priority_time_zones = [timezone1, timezone2]
+    #   ```
+    #
+    #   See http://apidock.com/rails/ActionView/Helpers/FormOptionsHelper/time_zone_select for more information.
+    #
+    class TimeZoneInput
       include Base
 
       def to_html
@@ -39,10 +49,10 @@ module Formtastic
           builder.time_zone_select(method, priority_zones, input_options, input_html_options)
         end
       end
-      
+
       def priority_zones
-        options[:priority_zones] || [] # TODO config?
+        options[:priority_zones] || Formtastic::FormBuilder.priority_time_zones
       end
     end
   end
-end
+end

data/lib/formtastic/localizer.rb

@@ -1,5 +1,5 @@
 module Formtastic
-  # Implementation for looking up localized values within Formtastic using I18n, if no 
+  # Implementation for looking up localized values within Formtastic using I18n, if no
   # explicit value (like the `:label` option) is set and I18n-lookups are enabled in the
   # configuration.
   #
@@ -28,50 +28,50 @@ module Formtastic
       def get(key)
         cache[key]
       end
-    
+
       def has_key?(key)
         cache.has_key?(key)
       end
-    
+
       def set(key, result)
         cache[key] = result
       end
-    
+
       def cache
         @cache ||= {}
       end
-    
+
       def clear!
         cache.clear
       end
     end
-        
+
     attr_accessor :builder
-    
+
     def self.cache
       @cache ||= Cache.new
     end
-    
+
     def initialize(current_builder)
-      self.builder = current_builder 
+      self.builder = current_builder
     end
 
     def localize(key, value, type, options = {}) # @private
       key = value if value.is_a?(::Symbol)
-      
+
       if value.is_a?(::String)
         escape_html_entities(value)
       else
         use_i18n = value.nil? ? i18n_lookups_by_default : (value != false)
         use_cache = i18n_cache_lookups
         cache = self.class.cache
-        
+
         if use_i18n
           model_name, nested_model_name  = normalize_model_name(builder.model_name.underscore)
 
           action_name = builder.template.params[:action].to_s rescue ''
           attribute_name = key.to_s
-          
+
           # look in the cache first
           if use_cache
             cache_key = [::I18n.locale, action_name, model_name, nested_model_name, attribute_name, key, value, type, options]
@@ -86,7 +86,7 @@ module Formtastic
             i18n_path.gsub!('%{model}', model_name)
             i18n_path.gsub!('%{nested_model}', nested_model_name) unless nested_model_name.nil?
             i18n_path.gsub!('%{attribute}', attribute_name)
-            i18n_path.gsub!('..', '.')
+            i18n_path.tr!('..', '.')
             i18n_path.to_sym
           end
           defaults << ''
@@ -103,7 +103,7 @@ module Formtastic
             options[:default] = defaults
             i18n_value = ::I18n.t(default_key, options)
           end
-          
+
           # save the result to the cache
           result = (i18n_value.is_a?(::String) && i18n_value.present?) ? escape_html_entities(i18n_value) : nil
           cache.set(cache_key, result) if use_cache
@@ -143,7 +143,7 @@ module Formtastic
     def i18n_lookups_by_default
       builder.i18n_lookups_by_default
     end
-    
+
     def i18n_cache_lookups
       builder.i18n_cache_lookups
     end

data/lib/formtastic/namespaced_class_finder.rb

@@ -29,7 +29,7 @@ module Formtastic
     end
 
     def self.use_const_defined?
-      defined?(Rails) && ::Rails.application && ::Rails.application.config.eager_load
+      defined?(Rails) && ::Rails.application && ::Rails.application.config.respond_to?(:eager_load) && ::Rails.application.config.eager_load
     end
 
     # @param namespaces [Array<Module>]

data/lib/formtastic/version.rb

@@ -1,3 +1,3 @@
 module Formtastic
-  VERSION = "3.1.3"
+  VERSION = "3.1.4"
 end

data/lib/generators/formtastic/form/form_generator.rb

@@ -75,7 +75,7 @@ module Formtastic
     # Skips Active Record Timestamps.
     def content_columns
       model.content_columns.select do |column|
-        !Formtastic::Helpers::InputsHelper::SKIPPED_COLUMNS.include? column.name.to_sym
+        !Formtastic::FormBuilder.skipped_columns.include? column.name.to_sym
       end
     end
 

data/lib/generators/formtastic/input/input_generator.rb

@@ -0,0 +1,46 @@
+module Formtastic
+
+  # Modify existing inputs, subclass them, or create your own from scratch.
+  # @example
+  # !!!shell
+  #   $ rails generate formtastic:input HatSize
+
+  # @example Define input name using underscore convention
+  # !!!shell
+  #   $ rails generate formtastic:input hat_size
+
+  # @example Override an existing input behavior
+  # !!!shell
+  #   $ rails generate formtastic:input string --extend
+
+  # @example Extend an existing input behavior
+  # !!!shell
+  #   $ rails generate formtastic:input FlexibleText --extend string
+  class InputGenerator < Rails::Generators::NamedBase
+
+    argument :name, :type => :string, :required => true, :banner => 'FILE_NAME'
+
+    source_root File.expand_path('../../../templates', __FILE__)
+
+    class_option :extend
+
+    def create
+      normalize_file_name
+      define_extension_sentence
+      template "input.rb", "app/inputs/#{name.underscore}_input.rb"
+    end
+
+    protected
+
+    def normalize_file_name
+      name.chomp!("Input")  if name.ends_with?("Input")
+      name.chomp!("_input") if name.ends_with?("_input")
+      name.chomp!("input")  if name.ends_with?("input")
+    end
+
+    def define_extension_sentence
+      @extension_sentence = "< Formtastic::Inputs::#{name.camelize}Input" if options[:extend] == "extend"
+      @extension_sentence ||= "< Formtastic::Inputs::#{options[:extend].camelize}Input" if options[:extend]
+    end
+  end
+end

data/lib/generators/templates/formtastic.rb

@@ -17,15 +17,15 @@
 # Defaults to true.
 # Formtastic::FormBuilder.include_blank_for_select_by_default = true
 
-# Set the string that will be appended to the labels/fieldsets which are required
+# Set the string that will be appended to the labels/fieldsets which are required.
 # It accepts string or procs and the default is a localized version of
 # '<abbr title="required">*</abbr>'. In other words, if you configure formtastic.required
 # in your locale, it will replace the abbr title properly. But if you don't want to use
-# abbr tag, you can simply give a string as below
+# abbr tag, you can simply give a string as below.
 # Formtastic::FormBuilder.required_string = "(required)"
 
-# Set the string that will be appended to the labels/fieldsets which are optional
-# Defaults to an empty string ("") and also accepts procs (see required_string above)
+# Set the string that will be appended to the labels/fieldsets which are optional.
+# Defaults to an empty string ("") and also accepts procs (see required_string above).
 # Formtastic::FormBuilder.optional_string = "(optional)"
 
 # Set the way inline errors will be displayed.
@@ -33,7 +33,7 @@
 # Formtastic::FormBuilder.inline_errors = :sentence
 # Formtastic uses the following classes as default for hints, inline_errors and error list
 
-# If you override the class here, please ensure to override it in your stylesheets as well
+# If you override the class here, please ensure to override it in your stylesheets as well.
 # Formtastic::FormBuilder.default_hint_class = "inline-hints"
 # Formtastic::FormBuilder.default_inline_error_class = "inline-errors"
 # Formtastic::FormBuilder.default_error_list_class = "errors"
@@ -70,7 +70,7 @@
 # can change it to any class you want.
 # Formtastic::Helpers::FormHelper.default_form_class = 'formtastic'
 
-# Formtastic will infer a class name from the model, array, string ot symbol you pass to the
+# Formtastic will infer a class name from the model, array, string or symbol you pass to the
 # form builder. You can customize the way that class is presented by overriding
 # this proc.
 # Formtastic::Helpers::FormHelper.default_form_model_class_proc = proc { |model_class_name| model_class_name }
@@ -85,7 +85,7 @@
 # Formtastic::FormBuilder.use_required_attribute = false
 
 # You can opt-in to new HTML5 browser validations (for things like email and url inputs) by setting
-# this to true. Doing so will add a `novalidate` attribute to the `<form>` tag.
+# this to true. Doing so will omit the `novalidate` attribute from the `<form>` tag.
 # See http://diveintohtml5.org/forms.html#validation for more info.
 # Formtastic::FormBuilder.perform_browser_validations = true
 
@@ -108,3 +108,6 @@ Formtastic::FormBuilder.action_class_finder = Formtastic::ActionClassFinder
 # Define custom namespaces in which to look up your Action classes. Default is
 # to look up in the global scope and in Formtastic::Actions.
 # Formtastic::FormBuilder.action_namespaces = [ ::Object, ::MyActionsModule, ::Formtastic::Actions ]
+
+# Which columns to skip when automatically rendering a form without any fields specified.
+# Formtastic::FormBuilder.skipped_columns = [:created_at, :updated_at, :created_on, :updated_on, :lock_version, :version]

data/lib/generators/templates/input.rb

@@ -0,0 +1,19 @@
+class <%= name.camelize %>Input <%= @extension_sentence %>
+  <%- if !options[:extend] -%>
+  include Formtastic::Inputs::Base
+  <%- end -%>
+
+  <%- if !options[:extend] || (options[:extend] == "extend")  -%>
+  def to_html
+    # Add your custom input definition here.
+    <%- if options[:extend] == "extend" -%>
+    super
+    <%- end -%>
+  end
+
+  <%- else -%>
+  def input_html_options
+    # Add your custom input extension here.
+  end
+  <%- end -%>
+end