nuatt-formtastic 0.2.2 → 0.2.3

data/lib/formtastic/inputs/string_input.rb

@@ -0,0 +1,34 @@
+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 documetation of all possible options.
+    class StringInput 
+      include Base
+      include Base::Stringish
+    end
+  end
+end

data/lib/formtastic/inputs/text_input.rb

@@ -0,0 +1,47 @@
+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 => :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 documetation of all possible options.
+    class TextInput 
+      include Base
+      
+      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_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,96 @@
+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))
+          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 = escape_html_entities(i18n_value) if i18n_value.is_a?(::String)
+          i18n_value.blank? ? nil : i18n_value
+        end
+      end
+    end
+
+    def model_name
+      @object.present? ? @object.class.name : @object_name.to_s.classify
+    end
+
+    def normalize_model_name(name)
+      if name =~ /(.+)\[(.+)\]/
+        [$1, $2]
+      else
+        [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

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Formtastic
+  # @private
+  class Railtie < Rails::Railtie
+    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

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+# Adapted from the rails3 compatibility shim in Haml 2.2
+module Formtastic
+  # @private
+  module Util
+    extend self
+    ## Rails XSS Safety
+
+    # Returns the given text, marked as being HTML-safe.
+    # With older versions of the Rails XSS-safety mechanism,
+    # this destructively modifies the HTML-safety of `text`.
+    #
+    # @param text [String]
+    # @return [String] `text`, marked as HTML-safe
+    def html_safe(text)
+      if text.respond_to?(:html_safe)
+        text.html_safe
+      else
+        text
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,95 @@
+# encoding: utf-8
+module Formtastic
+  # Generates a Formtastic form partial based on an existing model. It will not overwrite existing
+  # files without confirmation.
+  #
+  # @example
+  #   $ rails generate formtastic:form Post
+  # @example Copy the partial code to the pasteboard rather than generating a partial
+  #   $ rails generate formtastic:form Post --copy
+  # @example Return HAML output instead of ERB
+  #   $ rails generate formtastic:form Post --haml
+  # @example Generate a form for specific model attributes
+  #   $ rails generate formtastic:form Post title:string body:text
+  # @example Generate a form for a specific controller
+  #   $ rails generate formtastic:form Post --controller admin/posts
+  class FormGenerator < Rails::Generators::NamedBase
+    desc "Generates a Formtastic form partial based on an existing model."
+
+    argument :name, :type => :string, :required => true, :banner => 'MyExistingModel'
+    argument :attributes, :type => :array, :default => [], :banner => 'attribute attribute'
+
+    class_option :haml, :type => :boolean, :default => false, :group => :formtastic,
+                 :desc => "Generate HAML instead of ERB"
+
+    class_option :partial, :type => :boolean, :default => true, :group => :formtastic,
+                 :desc => 'Generate a form partial in the model views path (eg `posts/_form.html.erb`)'
+
+    class_option :copy, :type => :boolean, :default => false, :group => :formtastic,
+                 :desc => 'Copy the generated code the clipboard instead of generating a partial file."'
+
+    class_option :controller, :type => :string, :default => false, :group => :formtastic,
+                 :desc => 'Generate for custom controller/view path - in case model and controller namespace is different, i.e. "admin/posts"'
+
+    source_root File.expand_path('../../../templates', __FILE__)
+
+    def create_or_show
+      @attributes = reflected_attributes if @attributes.empty?
+      
+      if options[:copy]
+        template = File.read("#{self.class.source_root}/_form.html.#{template_type}")
+        erb = ERB.new(template, nil, '-')
+        generated_code = erb.result(binding).strip rescue nil
+        puts "The following code has been to the clipboard, just paste it in your views:" if save_to_clipboard(generated_code)
+        puts generated_code || "Error: Nothing generated. Does the model exist?"
+      else
+        empty_directory "app/views/#{controller_path}"
+        template "_form.html.#{template_type}", "app/views/#{controller_path}/_form.html.#{template_type}"
+      end
+    end
+
+    protected
+
+    def template_type
+      @template_type ||= options[:haml] ? :haml : :erb
+    end
+
+    def controller_path
+      @controller_path ||= if options[:controller]
+        options[:controller].underscore
+      else
+        name.underscore.pluralize
+      end
+    end
+
+    def reflected_attributes
+      columns = model.content_columns.map{|column| column.name}
+      columns += model.reflect_on_all_associations.map{|association| association.name.to_s}
+      columns -= %w(created_at updated_at)
+    end
+
+    def model
+      @model ||= name.camelize.constantize
+    end
+
+    def save_to_clipboard(data)
+      return unless data
+
+      begin
+        case RUBY_PLATFORM
+        when /win32/
+          require 'win32/clipboard'
+          ::Win32::Clipboard.data = data
+        when /darwin/ # mac
+          `echo "#{data}" | pbcopy`
+        else # linux/unix
+          `echo "#{data}" | xsel --clipboard` || `echo "#{data}" | xclip`
+        end
+      rescue LoadError
+        false
+      else
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Formtastic
+  # Copies formtastic.css and formtastic_changes.css to public/stylesheets/ and a config initializer
+  # to config/initializers/formtastic_config.rb.
+  #
+  # @example
+  #   $ rails generate formtastic:install
+  #
+  # @todo Revisit in Rails 3.1 where public assets are treated differently
+  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__)
+
+    def copy_files
+      template        'formtastic.rb', 'config/initializers/formtastic.rb'
+
+      template        'formtastic.css',         'public/stylesheets/formtastic.css'
+      template        'formtastic_changes.css', 'public/stylesheets/formtastic_changes.css'
+    end
+  end
+end