formtastic 3.0.0 → 5.0.0

data/lib/formtastic/inputs/select_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     # A select input is used to render a `<select>` tag with a series of options to choose from.
@@ -8,6 +9,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 +40,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| %>
@@ -94,6 +103,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 +117,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" } %>
     #
@@ -131,6 +133,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
@@ -141,6 +158,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 <<
@@ -175,7 +197,7 @@ module Formtastic
       def extra_input_html_options
         {
           :multiple => multiple?,
-          :name => (multiple? && Rails::VERSION::MAJOR >= 3) ? input_html_options_name_multiple : input_html_options_name
+          :name => multiple? ? input_html_options_name_multiple : input_html_options_name
         }
         
         

data/lib/formtastic/inputs/string_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 

data/lib/formtastic/inputs/text_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 

data/lib/formtastic/inputs/time_picker_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     

data/lib/formtastic/inputs/time_select_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     # Outputs a series of select boxes for the fragments that make up a time (hour, minute, second).

data/lib/formtastic/inputs/time_zone_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 
@@ -28,9 +29,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 +50,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/inputs/url_input.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
 

data/lib/formtastic/inputs.rb

@@ -1,38 +1,43 @@
+# frozen_string_literal: true
 module Formtastic
   module Inputs
     extend ActiveSupport::Autoload
 
     autoload :Base
     autoload :Basic
-    autoload :BooleanInput
-    autoload :CheckBoxesInput
-    autoload :ColorInput
-    autoload :CountryInput
-    autoload :DateInput
-    autoload :DatePickerInput
-    autoload :DatetimePickerInput
-    autoload :DateSelectInput
-    autoload :DatetimeInput
-    autoload :DatetimeSelectInput
-    autoload :EmailInput
-    autoload :FileInput
-    autoload :HiddenInput
-    autoload :NumberInput
-    autoload :NumericInput
-    autoload :PasswordInput
-    autoload :PhoneInput
-    autoload :RadioInput
-    autoload :RangeInput
-    autoload :SearchInput
-    autoload :SelectInput
-    autoload :StringInput
-    autoload :TextInput
-    autoload :TimeInput
-    autoload :TimePickerInput
-    autoload :TimeSelectInput
-    autoload :TimeZoneInput
     autoload :Timeish
-    autoload :UrlInput
+
+    eager_autoload do
+      autoload :BooleanInput
+      autoload :CheckBoxesInput
+      autoload :ColorInput
+      autoload :CountryInput
+      autoload :DatalistInput
+      autoload :DateInput
+      autoload :DatePickerInput
+      autoload :DatetimePickerInput
+      autoload :DateSelectInput
+      autoload :DatetimeInput
+      autoload :DatetimeSelectInput
+      autoload :EmailInput
+      autoload :FileInput
+      autoload :HiddenInput
+      autoload :NumberInput
+      autoload :NumericInput
+      autoload :PasswordInput
+      autoload :PhoneInput
+      autoload :RadioInput
+      autoload :RangeInput
+      autoload :SearchInput
+      autoload :SelectInput
+      autoload :StringInput
+      autoload :TextInput
+      autoload :TimeInput
+      autoload :TimePickerInput
+      autoload :TimeSelectInput
+      autoload :TimeZoneInput
+      autoload :UrlInput
+    end
   end
 end
 

data/lib/formtastic/localized_string.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
   module LocalizedString
 
@@ -7,7 +8,7 @@ module Formtastic
 
     protected
 
-    def localized_string(key, value, type, options = {}) #:nodoc:
+    def localized_string(key, value, type, options = {}) # @private
       current_builder = respond_to?(:builder) ? builder : self
       localizer = Formtastic::FormBuilder.i18n_localizer.new(current_builder)
       localizer.localize(key, value, type, options)

data/lib/formtastic/localizer.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
 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 +29,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 = {}) #:nodoc:
+    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 +87,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 << ''
@@ -101,9 +102,9 @@ module Formtastic
             # This is effectively what Rails label helper does for i18n lookup
             options[:scope] = [:helpers, type]
             options[:default] = defaults
-            i18n_value = ::I18n.t(default_key, options)
+            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
@@ -115,16 +116,14 @@ module Formtastic
     protected
 
     def normalize_model_name(name)
-      if !name =~ /\[/ && builder.respond_to?(:parent_builder) && builder.parent_builder.object_name
-        # Rails 3.1 nested builder case
-        [builder.parent_builder.object_name.to_s, name]
-      elsif name =~ /(.+)\[(.+)\]/
-        # Rails 3 (and 3.1?) nested builder case with :post rather than @post
+      if name =~ /(.+)\[(.+)\]/
+        # Nested builder case with :post rather than @post
+        # TODO: check if this is no longer required with a minimum of Rails 4.1
         [$1, $2]
       elsif builder.respond_to?(:options) && builder.options.key?(:as)
         [builder.options[:as].to_s]
       elsif builder.respond_to?(:options) && builder.options.key?(:parent_builder)
-        # Rails 3.0 nested builder work-around case, where :parent_builder is provided by f.semantic_form_for
+        # Rails 3.0+ nested builder work-around case, where :parent_builder is provided by f.semantic_form_for
         [builder.options[:parent_builder].object_name.to_s, name]
       else
         # Non-nested case
@@ -132,7 +131,7 @@ module Formtastic
       end
     end
 
-    def escape_html_entities(string) #:nodoc:
+    def escape_html_entities(string) # @private
       if (builder.escape_html_entities_in_hints_and_labels) ||
          (self.respond_to?(:escape_html_entities_in_hints_and_labels) && escape_html_entities_in_hints_and_labels)
         string = builder.template.escape_once(string) unless string.respond_to?(:html_safe?) && string.html_safe? == true # Accept html_safe flag as indicator to skip escaping
@@ -143,7 +142,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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+module Formtastic
+  # This class implements class resolution in a namespace chain. It
+  # is used both by Formtastic::Helpers::InputHelper and
+  # Formtastic::Helpers::ActionHelper to look up action and input classes.
+  #
+  # @example Implementing own class finder
+  #   # You can implement own class finder that for example prefixes the class name or uses custom module.
+  #   class MyInputClassFinder < Formtastic::NamespacedClassFinder
+  #     def initialize(namespaces)
+  #       super [MyNamespace] + namespaces # first lookup in MyNamespace then the defaults
+  #     end
+  #
+  #     private
+  #
+  #     def class_name(as)
+  #       "My#{super}Input" # for example MyStringInput
+  #     end
+  #   end
+  #
+  #   # in config/initializers/formtastic.rb
+  #   Formtastic::FormBuilder.input_class_finder = MyInputClassFinder
+  #
+
+  class NamespacedClassFinder
+    attr_reader :namespaces # @private
+
+    # @private
+    class NotFoundError < NameError
+    end
+
+    def self.use_const_defined?
+      defined?(Rails) && ::Rails.application && ::Rails.application.config.respond_to?(:eager_load) && ::Rails.application.config.eager_load
+    end
+
+    def self.finder_method
+      @finder_method ||= use_const_defined? ? :find_with_const_defined : :find_by_trying
+    end
+
+    # @param namespaces [Array<Module>]
+    def initialize(namespaces)
+      @namespaces = namespaces.flatten
+      @cache = {}
+    end
+
+    # Looks up the given reference in the configured namespaces.
+    #
+    # Two finder methods are provided, one for development tries to
+    # reference the constant directly, triggering Rails' autoloading
+    # const_missing machinery; the second one instead for production
+    # checks with .const_defined before referencing the constant.
+    #
+    def find(as)
+      @cache[as] ||= resolve(as)
+    end
+
+    def resolve(as)
+      class_name = class_name(as)
+
+      finder(class_name) or raise NotFoundError, "class #{class_name}"
+    end
+
+    # Converts symbol to class name
+    # Overridden in subclasses to create `StringInput` and `ButtonAction`
+    # @example
+    #   class_name(:string) == "String"
+
+    def class_name(as)
+      as.to_s.camelize
+    end
+
+    private
+
+    def finder(class_name) # @private
+      send(self.class.finder_method, class_name)
+    end
+
+    # Looks up the given class name in the configured namespaces in order,
+    # returning the first one that has the class name constant defined.
+    def find_with_const_defined(class_name)
+      @namespaces.find do |namespace|
+        if namespace.const_defined?(class_name)
+          break namespace.const_get(class_name)
+        end
+      end
+    end
+
+    # Use auto-loading in development environment
+    def find_by_trying(class_name)
+      @namespaces.find do |namespace|
+        begin
+          break namespace.const_get(class_name)
+        rescue NameError
+        end
+      end
+    end
+  end
+end

data/lib/formtastic/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Formtastic
-  VERSION = "3.0.0"
+  VERSION = "5.0.0"
 end

data/lib/formtastic.rb

@@ -1,39 +1,44 @@
 # encoding: utf-8
+# frozen_string_literal: true
 require 'formtastic/engine' if defined?(::Rails)
 
 module Formtastic
   extend ActiveSupport::Autoload
 
-  autoload :FormBuilder
   autoload :Helpers
   autoload :HtmlAttributes
-  autoload :I18n
-  autoload :Inputs
-  autoload :Actions
   autoload :LocalizedString
   autoload :Localizer
-  autoload :Util
-  
-  if defined?(::Rails) && Util.deprecated_version_of_rails?
-    ::ActiveSupport::Deprecation.warn(
-      "Support for Rails < 4.0.4 will be dropped from Formtastic 4.0",
-      caller)
+  autoload :NamespacedClassFinder
+  autoload :InputClassFinder
+  autoload :ActionClassFinder
+  autoload :Deprecation
+
+  eager_autoload do
+    autoload :I18n
+    autoload :FormBuilder
+    autoload :Inputs
+    autoload :Actions
   end
 
-  # @private
+  # @public
   class UnknownInputError < NameError
   end
-  
+
   # @private
   class UnknownActionError < NameError
   end
-  
+
   # @private
   class PolymorphicInputWithoutCollectionError < ArgumentError
   end
-  
+
   # @private
   class UnsupportedMethodForAction < ArgumentError
   end
 
+  # @private
+  class UnsupportedEnumCollection < NameError
+  end
+
 end

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

@@ -1,18 +1,24 @@
 # encoding: utf-8
+# frozen_string_literal: true
 module Formtastic
   # Generates a Formtastic form partial based on an existing model. It will not overwrite existing
   # files without confirmation.
   #
   # @example
+  # !!!shell
   #   $ rails generate formtastic:form Post
   # @example Copy the partial code to the pasteboard rather than generating a partial
+  # !!!shell
   #   $ rails generate formtastic:form Post --copy
   # @example Return HAML or Slim output instead of default ERB
+  # !!!shell
   #   $ rails generate formtastic:form Post --template-engine haml
   #   $ rails generate formtastic:form Post --template-engine slim
   # @example Generate a form for specific model attributes
+  # !!!shell
   #   $ rails generate formtastic:form Post title:string body:text
   # @example Generate a form for a specific controller
+  # !!!shell
   #   $ rails generate formtastic:form Post --controller admin/posts
   class FormGenerator < Rails::Generators::NamedBase
     desc "Generates a Formtastic form partial based on an existing model."
@@ -70,7 +76,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
 
@@ -103,4 +109,4 @@ module Formtastic
     end
 
   end
-end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+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/formtastic/install/install_generator.rb

@@ -1,9 +1,11 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Formtastic
   # Copies a config initializer to config/initializers/formtastic.rb
   #
   # @example
+  # !!!shell
   #   $ rails generate formtastic:install
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('../../../templates', __FILE__)