formtastic 1.2.4 → 3.1.5

data/lib/formtastic/inputs/string_input.rb

@@ -0,0 +1,36 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a `<input type="text">` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for database columns of the `:string` type,
+    # and is the default choice for all inputs when no other logical input type can be inferred.
+    # You can force any input to be a string input with `:as => :string`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :first_name, :as => :string %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="string">
+    #           <label for="user_first_name">First name</label>
+    #           <input type="text" id="user_first_name" name="user[first_name]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    class StringInput 
+      include Base
+      include Base::Stringish
+      include Base::Placeholder
+      
+    end
+  end
+end

data/lib/formtastic/inputs/text_input.rb

@@ -0,0 +1,48 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a `<textarea>` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for database columns of the `:text` type,
+    # but can forced on any text-like input with `:as => :text`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :first_name, :as => :text %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="text">
+    #           <label for="user_first_name">First name</label>
+    #           <textarea cols="30" id="user_first_name" name="user[first_name]" rows="20"></textarea>
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    class TextInput 
+      include Base
+      include Base::Placeholder
+      
+      def input_html_options
+        { 
+          :cols => builder.default_text_area_width,
+          :rows => builder.default_text_area_height
+        }.merge(super)
+      end
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.text_area(method, input_html_options)
+        end
+      end
+    
+    end
+  end
+end

data/lib/formtastic/inputs/time_picker_input.rb

@@ -0,0 +1,99 @@
+module Formtastic
+  module Inputs
+    
+    # Outputs a simple `<label>` with a HTML5 `<input type="time">` wrapped in the standard
+    # `<li>` wrapper. This is an alternative to `:time_select` for `:date`, `:time`, `:datetime` 
+    # database columns. You can use this input with `:as => :time_picker`.
+    #
+    # *Please note:* Formtastic only provides suitable markup for a date picker, but does not supply
+    # any additional CSS or Javascript to render calendar-style date pickers. Browsers that support
+    # this input type (such as Mobile Webkit and Opera on the desktop) will render a native widget.
+    # Browsers that don't will default to a plain text field`<input type="text">` and can be 
+    # poly-filled with some Javascript and a UI library of your choice.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@post) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :publish_at, :as => :time_picker %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="string">
+    #           <label for="post_publish_at">First name</label>
+    #           <input type="date" id="post_publish_at" name="post[publish_at]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @example Setting the size (defaults to 5 for HH:MM)
+    #   <%= f.input :publish_at, :as => :time_picker, :size => 20 %>
+    #   <%= f.input :publish_at, :as => :time_picker, :input_html => { :size => 20 } %>
+    #
+    # @example Setting the maxlength (defaults to 5 for HH:MM)
+    #   <%= f.input :publish_at, :as => :time_picker, :maxlength => 20 %>
+    #   <%= f.input :publish_at, :as => :time_picker, :input_html => { :maxlength => 20 } %>
+    #
+    # @example Setting the value (defaults to HH:MM for Date and Time objects, otherwise renders string)
+    #   <%= f.input :publish_at, :as => :time_picker, :input_html => { :value => "14:14" } %>
+    #
+    # @example Setting the step attribute (defaults to 60)
+    #   <%= f.input :publish_at, :as => :time_picker, :step => 120 %>
+    #   <%= f.input :publish_at, :as => :time_picker, :input_html => { :step => 120 } %>
+    #
+    # @example Setting the step attribute with a macro
+    #   <%= f.input :publish_at, :as => :time_picker, :step => :second %>
+    #   <%= f.input :publish_at, :as => :time_picker, :step => :minute %>
+    #   <%= f.input :publish_at, :as => :time_picker, :step => :quarter_hour %>
+    #   <%= f.input :publish_at, :as => :time_picker, :step => :fifteen_minutes %>
+    #   <%= f.input :publish_at, :as => :time_picker, :step => :half_hour %>
+    #   <%= f.input :publish_at, :as => :time_picker, :step => :thirty_minutes %>
+    #   <%= f.input :publish_at, :as => :time_picker, :step => :hour %>
+    #   <%= f.input :publish_at, :as => :time_picker, :step => :sixty_minutes %>
+    #
+    # @example Setting the min attribute
+    #   <%= f.input :publish_at, :as => :time_picker, :min => "09:00" %>
+    #   <%= f.input :publish_at, :as => :time_picker, :input_html => { :min => "01:00" } %>
+    #
+    # @example Setting the max attribute
+    #   <%= f.input :publish_at, :as => :time_picker, :max => "18:00" %>
+    #   <%= f.input :publish_at, :as => :time_picker, :input_html => { :max => "18:00" } %>
+    #
+    # @example Setting the placeholder attribute
+    #   <%= f.input :publish_at, :as => :time_picker, :placeholder => "HH:MM" %>
+    #   <%= f.input :publish_at, :as => :time_picker, :input_html => { :placeholder => "HH:MM" } %>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    class TimePickerInput
+      include Base
+      include Base::Stringish
+      include Base::DatetimePickerish
+      
+      def html_input_type
+        "time"
+      end
+      
+      def default_size
+        5
+      end
+      
+      def value
+        return options[:input_html][:value] if options[:input_html] && options[:input_html].key?(:value)
+        val = object.send(method)
+        return "00:00" if val.is_a?(Date)
+        return val.strftime("%H:%M") if val.is_a?(Time)
+        return val if val.nil?
+        val.to_s
+      end
+      
+      def default_step
+        60
+      end
+      
+    end
+  end
+end

data/lib/formtastic/inputs/time_select_input.rb

@@ -0,0 +1,38 @@
+module Formtastic
+  module Inputs
+    # Outputs a series of select boxes for the fragments that make up a time (hour, minute, second).
+    # Unless `:ignore_date` is true, it will render hidden inputs for the year, month and day as 
+    # well, defaulting to `Time.current` if the form object doesn't have a value, much like Rails' 
+    # own `time_select`.
+    #
+    # @see Formtastic::Inputs::Base::Timeish Timeish module for documentation of date, time and datetime input options.
+    class TimeSelectInput 
+      include Base
+      include Base::Timeish
+      
+      # we don't want year / month / day fragments if :ignore_date => true
+      def fragments
+        time_fragments
+      end
+      
+      def value_or_default_value
+        value ? value : Time.current
+      end
+      
+      def fragment_value(fragment)
+        value_or_default_value.send(fragment)
+      end
+      
+      def hidden_fragments
+        if !options[:ignore_date]
+          date_fragments.map do |fragment|
+            template.hidden_field_tag(hidden_field_name(fragment), fragment_value(fragment), :id => fragment_id(fragment), :disabled => input_html_options[:disabled] )
+          end.join.html_safe
+        else
+          super
+        end
+      end
+      
+    end
+  end
+end

data/lib/formtastic/inputs/time_zone_input.rb

@@ -0,0 +1,58 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a `<label>` with a `<select>` containing a series of time zones (using Rails' own
+    # `time_zone_select` helper), wrapped in the standard `<li>` wrapper.
+
+    # This is the default input choice for attributes matching /time_zone/, but can be applied to
+    # any text-like input with `:as => :time_zone`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :time_zone, :as => :time_zone %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="time_zone">
+    #           <label for="user_time_zone">Time zone</label>
+    #           <input type="text" id="user_time_zone" name="user[time_zone]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    #
+    # 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
+        input_wrapping do
+          label_html <<
+          builder.time_zone_select(method, priority_zones, input_options, input_html_options)
+        end
+      end
+
+      def priority_zones
+        options[:priority_zones] || Formtastic::FormBuilder.priority_time_zones
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/url_input.rb

@@ -0,0 +1,41 @@
+module Formtastic
+  module Inputs
+
+    # Outputs a simple `<label>` with a HTML5 `<input type="url">` wrapped in the standard
+    # `<li>` wrapper. This is the default input choice for all attributes matching
+    # `/^url$|^website$|_url$/`, but can be applied to any text-like input with `:as => :url`.
+    #
+    # @example Full form context and output
+    #
+    #   <%= semantic_form_for(@user) do |f| %>
+    #     <%= f.inputs do %>
+    #       <%= f.input :home_page, :as => :url %>
+    #     <% end %>
+    #   <% end %>
+    #
+    #   <form...>
+    #     <fieldset>
+    #       <ol>
+    #         <li class="url">
+    #           <label for="user_home_page">Home page</label>
+    #           <input type="number" id="user_home_page" name="user[home_page]">
+    #         </li>
+    #       </ol>
+    #     </fieldset>
+    #   </form>
+    #
+    # @see Formtastic::Helpers::InputsHelper#input InputsHelper#input for full documentation of all possible options.
+    class UrlInput 
+      include Base
+      include Base::Stringish
+      include Base::Placeholder
+      
+      def to_html
+        input_wrapping do
+          label_html <<
+          builder.url_field(method, input_html_options)
+        end
+      end
+    end
+  end
+end

data/lib/formtastic/localized_string.rb

@@ -0,0 +1,17 @@
+module Formtastic
+  module LocalizedString
+
+    def model_name
+      @object.present? ? @object.class.name : @object_name.to_s.classify
+    end
+
+    protected
+
+    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)
+    end
+
+  end
+end

data/lib/formtastic/localizer.rb

@@ -0,0 +1,152 @@
+module Formtastic
+  # 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.
+  #
+  # You can subclass this to implement your own Localizer, and configure Formtastic to use this
+  # localizer with:
+  #
+  #   Formtastic::FormBuilder.i18n_localizer
+  #
+  # Enabled/disable i18n lookups completely with:
+  #
+  #   Formtastic::FormBuilder.i18n_lookups_by_default = true/false
+  #
+  # Lookup priority:
+  #
+  #   'formtastic.%{type}.%{model}.%{action}.%{attribute}'
+  #   'formtastic.%{type}.%{model}.%{attribute}'
+  #   'formtastic.%{type}.%{attribute}'
+  #
+  # Example:
+  #
+  #   'formtastic.labels.post.edit.title'
+  #   'formtastic.labels.post.title'
+  #   'formtastic.labels.title'
+  class Localizer
+    class Cache
+      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
+    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]
+            return cache.get(cache_key) if cache.has_key?(cache_key)
+          end
+
+          defaults = Formtastic::I18n::SCOPES.reject do |i18n_scope|
+            nested_model_name.nil? && i18n_scope.match(/nested_model/)
+          end.collect do |i18n_scope|
+            i18n_path = i18n_scope.dup
+            i18n_path.gsub!('%{action}', action_name)
+            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.tr!('..', '.')
+            i18n_path.to_sym
+          end
+          defaults << ''
+
+          defaults.uniq!
+
+          default_key = defaults.shift
+          i18n_value = Formtastic::I18n.t(default_key,
+            options.merge(:default => defaults, :scope => type.to_s.pluralize.to_sym))
+          i18n_value = i18n_value.is_a?(::String) ? i18n_value : nil
+          if i18n_value.blank? && type == :label
+            # 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)
+          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
+          result
+        end
+      end
+    end
+
+    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
+        [$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
+        [builder.options[:parent_builder].object_name.to_s, name]
+      else
+        # Non-nested case
+        [name]
+      end
+    end
+
+    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
+      end
+      string
+    end
+
+    def i18n_lookups_by_default
+      builder.i18n_lookups_by_default
+    end
+
+    def i18n_cache_lookups
+      builder.i18n_cache_lookups
+    end
+
+  end
+end