formtastic 1.2.5 → 2.0.0.rc1

data/lib/formtastic/inputs/time_input.rb

@@ -0,0 +1,14 @@
+module Formtastic
+  module Inputs
+    # @see Formtastic::Inputs::Timeish Timeish module for documetation of date, time and datetime input options.
+    class TimeInput 
+      include Base
+      include Base::Timeish
+      
+      # we don't want year / month / day fragments in a time select
+      def date_fragments
+        []
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/time_zone_input.rb

@@ -0,0 +1,48 @@
+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 documetation of all possible options.
+    #
+    # @todo document :priority_zones option
+    # @todo configurable default :priority_zones?
+    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] || [] # TODO config?
+      end
+    end
+  end
+end

data/lib/formtastic/inputs/url_input.rb

@@ -0,0 +1,40 @@
+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 documetation of all possible options.
+    class UrlInput 
+      include Base
+      include Base::Stringish
+      
+      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,105 @@
+module Formtastic
+  # @private
+  module LocalizedString
+
+    protected
+
+    # Internal generic method for looking up localized values within Formtastic
+    # using I18n, if no explicit value is set and I18n-lookups are enabled.
+    #
+    # Enabled/Disable this by setting:
+    #
+    #   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'
+    #
+    # NOTE: Generic, but only used for form input titles/labels/hints/actions (titles = legends, actions = buttons).
+    #
+    def localized_string(key, value, type, options = {}) #:nodoc:
+      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)
+
+        if use_i18n
+          model_name, nested_model_name  = normalize_model_name(self.model_name.underscore)
+
+          action_name = template.params[:action].to_s rescue ''
+          attribute_name = key.to_s
+
+          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.gsub!('..', '.')
+            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
+          (i18n_value.is_a?(::String) && i18n_value.present?) ? escape_html_entities(i18n_value) : nil
+        end
+      end
+    end
+
+    def model_name
+      @object.present? ? @object.class.name : @object_name.to_s.classify
+    end
+
+    def normalize_model_name(name)
+      if !name =~ /\[/ && self.respond_to?(:builder) && 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 self.respond_to?(:builder) && 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) #:nodoc:
+      if (respond_to?(:builder) && 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 = template.escape_once(string) unless string.respond_to?(:html_safe?) && string.html_safe? == true # Acceppt html_safe flag as indicator to skip escaping
+      end
+      string
+    end
+
+    def i18n_lookups_by_default
+      respond_to?(:builder) ? builder.i18n_lookups_by_default : i18n_lookups_by_default
+    end
+
+  end
+end

data/lib/formtastic/railtie.rb

@@ -1,14 +1,12 @@
 # encoding: utf-8
 
-require 'formtastic'
-require 'formtastic/layout_helper'
-require 'rails'
-
 module Formtastic
+  # @private
   class Railtie < Rails::Railtie
-    initializer 'formtastic.initialize', :after => :after_initialize do
-      ActionView::Base.send :include, Formtastic::SemanticFormHelper
-      ActionView::Base.send(:include, Formtastic::LayoutHelper)
+    initializer 'formtastic.initialize' do
+      ActiveSupport.on_load(:action_view) do
+        include Formtastic::Helpers::FormHelper
+      end
     end
   end
 end

data/lib/formtastic/semantic_form_builder.rb

@@ -0,0 +1,11 @@
+module Formtastic
+  # Quick hack/shim so that any code expecting the old SemanticFormBuilder class still works.
+  # TODO remove from 2.0 with a helpful upgrade path/warning.
+  # @private
+  class SemanticFormBuilder < Formtastic::FormBuilder
+    def initialize(*args)
+      ActiveSupport::Deprecation.warn('Formtastic::SemanticFormBuilder has been deprecated in favor of Formtastic::FormBuilder.', caller)
+      super
+    end
+  end
+end

data/lib/formtastic/util.rb

@@ -2,6 +2,7 @@
 
 # Adapted from the rails3 compatibility shim in Haml 2.2
 module Formtastic
+  # @private
   module Util
     extend self
     ## Rails XSS Safety
@@ -13,26 +14,12 @@ module Formtastic
     # @param text [String]
     # @return [String] `text`, marked as HTML-safe
     def html_safe(text)
-      return text if text.nil?
-      return text.html_safe if defined?(ActiveSupport::SafeBuffer)
-      return text.html_safe! if text.respond_to?(:html_safe!)
-      text
+      if text.respond_to?(:html_safe)
+        text.html_safe
+      else
+        text
+      end
     end
 
-    def rails_safe_buffer_class
-      # It's important that we check ActiveSupport first,
-      # because in Rails 2.3.6 ActionView::SafeBuffer exists
-      # but is a deprecated proxy object.
-      return ActiveSupport::SafeBuffer if defined?(ActiveSupport::SafeBuffer)
-      return ActionView::SafeBuffer
-    end
-
-    def rails3?
-      version=
-        if defined?(ActionPack::VERSION::MAJOR)
-          ActionPack::VERSION::MAJOR
-        end
-      !version.blank? && version >= 3
-    end
   end
 end

data/lib/formtastic/version.rb

@@ -0,0 +1,3 @@
+module Formtastic
+  VERSION = "2.0.0.rc1"
+end

data/lib/generators/formtastic/install/install_generator.rb

@@ -1,15 +1,37 @@
 # encoding: utf-8
+
 module Formtastic
+  # Copies formtastic.css to public/stylesheets/ (Rails 3.0.x only) and a config initializer
+  # to config/initializers/formtastic.rb (all Rails versions).
+  #
+  # @example
+  #   $ rails generate formtastic:install
+  #
+  # @todo Test with Rails 3.0
   class InstallGenerator < Rails::Generators::Base
-    desc "Copies formtastic.css and formtastic_changes.css to public/stylesheets/ and a config initializer to config/initializers/formtastic_config.rb"
-
     source_root File.expand_path('../../../templates', __FILE__)
+    class_option :template_engine
 
-    def copy_files
-      template        'formtastic.rb', 'config/initializers/formtastic.rb'
+    if ::Rails::VERSION::MAJOR == 3 && ::Rails::VERSION::MINOR >= 1
+      # Rails 3.1 has the asset pipeline, no need to copy CSS files any more
+      desc "Copies a config initializer to config/initializers/formtastic.rb"
+      def copy_files
+        copy_file 'formtastic.rb', 'config/initializers/formtastic.rb'
+      end
+    else
+      # Rails 3.0 doesn't have an asset pipeline, so we copy in CSS too
+      desc "Copies some CSS files to public/stylesheets/ and a config initializer to config/initializers/formtastic.rb"
+      def copy_files
+        template 'formtastic.rb', 'config/initializers/formtastic.rb'
+        template '../../../app/assets/stylesheets/formtastic.css',     'public/stylesheets/formtastic.css'
+        template '../../../app/assets/stylesheets/formtastic_ie6.css', 'public/stylesheets/formtastic_ie6.css'
+        template '../../../app/assets/stylesheets/formtastic_ie7.css', 'public/stylesheets/formtastic_ie7.css'
+      end
+    end
 
-      template        'formtastic.css',         'public/stylesheets/formtastic.css'
-      template        'formtastic_changes.css', 'public/stylesheets/formtastic_changes.css'
+    def copy_scaffold_template
+      engine = options[:template_engine]
+      copy_file "_form.html.#{engine}", "lib/templates/#{engine}/scaffold/_form.html.#{engine}"
     end
   end
 end

data/lib/generators/templates/_form.html.erb

@@ -1,5 +1,11 @@
-<%%= f.inputs do %>
-<% attributes.each do |attribute| -%>
-  <%%= f.input :<%= attribute.name %> %>
-<% end -%>
+<%%= semantic_form_for @<%= singular_name %> do |f| %>
+  <%%= f.inputs do %>
+  <%- attributes.each do |attribute| -%>
+    <%%= f.input :<%= attribute.name %> %>
+  <%- end -%>
+  <%% end %>
+
+  <%%= f.buttons do %>
+    <%%= f.commit_button %>
+  <%% end %>
 <%% end %>

data/lib/generators/templates/_form.html.haml

@@ -1,4 +1,8 @@
-= f.inputs do
-<% attributes.each do |attribute| -%>
-  = f.input :<%= attribute.name %>
-<% end -%>
+= semantic_form_for @<%= singular_name %> do |f|
+  = f.inputs do
+  <% attributes.each do |attribute| -%>
+    = f.input :<%= attribute.name %>
+  <% end -%>
+
+  = f.buttons do
+    = f.commit_button

data/lib/generators/templates/formtastic.rb

@@ -1,80 +1,73 @@
 # encoding: utf-8
 
 # --------------------------------------------------------------------------------------------------
-# Please note: If you're subclassing Formtastic::SemanticFormBuilder in a Rails 3 project, 
-# Formtastic uses class_attribute for these configuration attributes instead of the deprecated 
-# class_inheritable_attribute. The behaviour is slightly different with subclasses (especially 
-# around attributes with Hash or Array) values, so make sure you understand what's happening. 
+# Please note: If you're subclassing Formtastic::FormBuilder, Formtastic uses
+# class_attribute for these configuration attributes instead of the deprecated
+# class_inheritable_attribute. The behaviour is slightly different with subclasses (especially
+# around attributes with Hash or Array) values, so make sure you understand what's happening.
 # See the documentation for class_attribute in ActiveSupport for more information.
 # --------------------------------------------------------------------------------------------------
 
 # Set the default text field size when input is a string. Default is nil.
-# Formtastic::SemanticFormBuilder.default_text_field_size = 50
+# Formtastic::FormBuilder.default_text_field_size = 50
 
 # Set the default text area height when input is a text. Default is 20.
-# Formtastic::SemanticFormBuilder.default_text_area_height = 5
+# Formtastic::FormBuilder.default_text_area_height = 5
 
 # Set the default text area width when input is a text. Default is nil.
-# Formtastic::SemanticFormBuilder.default_text_area_width = 50
+# Formtastic::FormBuilder.default_text_area_width = 50
 
 # Should all fields be considered "required" by default?
-# Rails 2 only, ignored by Rails 3 because it will never fall back to this default.
 # Defaults to true.
-# Formtastic::SemanticFormBuilder.all_fields_required_by_default = true
+# Formtastic::FormBuilder.all_fields_required_by_default = true
 
 # Should select fields have a blank option/prompt by default?
 # Defaults to true.
-# Formtastic::SemanticFormBuilder.include_blank_for_select_by_default = true
+# Formtastic::FormBuilder.include_blank_for_select_by_default = true
 
 # 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
-# Formtastic::SemanticFormBuilder.required_string = "(required)"
+# 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)
-# Formtastic::SemanticFormBuilder.optional_string = "(optional)"
+# Formtastic::FormBuilder.optional_string = "(optional)"
 
 # Set the way inline errors will be displayed.
 # Defaults to :sentence, valid options are :sentence, :list, :first and :none
-# Formtastic::SemanticFormBuilder.inline_errors = :sentence
+# 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 formtastic_changes.css stylesheet as well
-# Formtastic::SemanticFormBuilder.default_hint_class = "inline-hints"
-# Formtastic::SemanticFormBuilder.default_inline_error_class = "inline-errors"
-# Formtastic::SemanticFormBuilder.default_error_list_class = "errors"
+# 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"
 
 # Set the method to call on label text to transform or format it for human-friendly
 # reading when formtastic is used without object. Defaults to :humanize.
-# Formtastic::SemanticFormBuilder.label_str_method = :humanize
+# Formtastic::FormBuilder.label_str_method = :humanize
 
 # Set the array of methods to try calling on parent objects in :select and :radio inputs
 # for the text inside each @<option>@ tag or alongside each radio @<input>@. The first method
 # that is found on the object will be used.
 # Defaults to ["to_label", "display_name", "full_name", "name", "title", "username", "login", "value", "to_s"]
-# Formtastic::SemanticFormBuilder.collection_label_methods = [
+# Formtastic::FormBuilder.collection_label_methods = [
 #   "to_label", "display_name", "full_name", "name", "title", "username", "login", "value", "to_s"]
 
-# Formtastic by default renders inside li tags the input, hints and then
-# errors messages. Sometimes you want the hints to be rendered first than
-# the input, in the following order: hints, input and errors. You can
-# customize it doing just as below:
-# Formtastic::SemanticFormBuilder.inline_order = [:input, :hints, :errors]
-
 # Additionally, you can customize the order for specific types of inputs.
 # This is configured on a type basis and if a type is not found it will
 # fall back to the default order as defined by #inline_order
-# Formtastic::SemanticFormBuilder.custom_inline_order[:checkbox] = [:errors, :hints, :input]
-# Formtastic::SemanticFormBuilder.custom_inline_order[:select] = [:hints, :input, :errors]
+# Formtastic::FormBuilder.custom_inline_order[:checkbox] = [:errors, :hints, :input]
+# Formtastic::FormBuilder.custom_inline_order[:select] = [:hints, :input, :errors]
 
 # Specifies if labels/hints for input fields automatically be looked up using I18n.
-# Default value: false. Overridden for specific fields by setting value to true,
+# Default value: true. Overridden for specific fields by setting value to true,
 # i.e. :label => true, or :hint => true (or opposite depending on initialized value)
-# Formtastic::SemanticFormBuilder.i18n_lookups_by_default = false
+# Formtastic::FormBuilder_lookups_by_default = false
 
-# You can add custom inputs or override parts of Formtastic by subclassing SemanticFormBuilder and
-# specifying that class here.  Defaults to SemanticFormBuilder.
-# Formtastic::SemanticFormHelper.builder = MyCustomBuilder
+# You can add custom inputs or override parts of Formtastic by subclassing Formtastic::FormBuilder and
+# specifying that class here.  Defaults to Formtastic::FormBuilder.
+# Formtastic::Helpers::FormHelper.builder = MyCustomBuilder