ehoch_simple_form 2.0.2.dev

data/lib/generators/simple_form/USAGE

@@ -0,0 +1,3 @@
+To copy a SimpleForm initializer to your Rails App, with some configuration values, just do:
+
+    rails generate simple_form:install

data/lib/generators/simple_form/install_generator.rb

@@ -0,0 +1,32 @@
+module SimpleForm
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy SimpleForm default files"
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :template_engine, :desc => 'Template engine to be invoked (erb, haml or slim).'
+      class_option :bootstrap, :type => :boolean, :desc => 'Add the Twitter Bootstrap wrappers to the SimpleForm initializer.'
+
+      def info_bootstrap
+        return if options.bootstrap?
+        puts "SimpleForm 2 supports Twitter bootstrap. In case you want to " \
+          "generate bootstrap configuration, please re-run this " \
+          "generator passing --bootstrap as option."
+      end
+
+      def copy_config
+        directory 'config'
+      end
+
+      def copy_scaffold_template
+        engine = options[:template_engine]
+        copy_file "_form.html.#{engine}", "lib/templates/#{engine}/scaffold/_form.html.#{engine}"
+      end
+
+      def show_readme
+        if behavior == :invoke && options.bootstrap?
+          readme "README"
+        end
+      end
+    end
+  end
+end

data/lib/generators/simple_form/templates/README

@@ -0,0 +1,12 @@
+===============================================================================
+
+  Be sure to have a copy of the Bootstrap stylesheet available on your
+  application, you can get it on http://twitter.github.com/bootstrap.
+
+  Inside your views, use the 'simple_form_for' with one of the Bootstrap form
+  classes, '.form-horizontal', '.form-inline', '.form-search' or
+  '.form-vertical', as the following:
+
+    = simple_form_for(@user, :html => {:class => 'form-horizontal' }) do |form|
+
+===============================================================================

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

@@ -0,0 +1,13 @@
+<%%= simple_form_for(@<%= singular_table_name %>) do |f| %>
+  <%%= f.error_notification %>
+
+  <div class="form-inputs">
+  <%- attributes.each do |attribute| -%>
+    <%%= f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %> %>
+  <%- end -%>
+  </div>
+
+  <div class="form-actions">
+    <%%= f.button :submit %>
+  </div>
+<%% end %>

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

@@ -0,0 +1,10 @@
+= simple_form_for(@<%= singular_table_name %>) do |f|
+  = f.error_notification
+
+  .form-inputs
+  <%- attributes.each do |attribute| -%>
+    = f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %>
+  <%- end -%>
+
+  .form-actions
+    = f.button :submit

data/lib/generators/simple_form/templates/_form.html.slim

@@ -0,0 +1,10 @@
+= simple_form_for(@<%= singular_table_name %>) do |f|
+  = f.error_notification
+
+  .form-inputs
+<%- attributes.each do |attribute| -%>
+    = f.<%= attribute.reference? ? :association : :input %> :<%= attribute.name %>
+<%- end -%>
+
+  .form-actions
+    = f.button :submit

data/lib/generators/simple_form/templates/config/initializers/simple_form.rb.tt

@@ -0,0 +1,181 @@
+# Use this setup block to configure all options available in SimpleForm.
+SimpleForm.setup do |config|
+  # Wrappers are used by the form builder to generate a
+  # complete input. You can remove any component from the
+  # wrapper, change the order or even add your own to the
+  # stack. The options given below are used to wrap the
+  # whole input.
+  config.wrappers :default, :class => :input,
+    :hint_class => :field_with_hint, :error_class => :field_with_errors do |b|
+    ## Extensions enabled by default
+    # Any of these extensions can be disabled for a
+    # given input by passing: `f.input EXTENSION_NAME => false`.
+    # You can make any of these extensions optional by
+    # renaming `b.use` to `b.optional`.
+
+    # Determines whether to use HTML5 (:email, :url, ...)
+    # and required attributes
+    b.use :html5
+
+    # Calculates placeholders automatically from I18n
+    # You can also pass a string as f.input :placeholder => "Placeholder"
+    b.use :placeholder
+
+    ## Optional extensions
+    # They are disabled unless you pass `f.input EXTENSION_NAME => :lookup`
+    # to the input. If so, they will retrieve the values from the model
+    # if any exists. If you want to enable the lookup for any of those
+    # extensions by default, you can change `b.optional` to `b.use`.
+
+    # Calculates maxlength from length validations for string inputs
+    b.optional :maxlength
+
+    # Calculates pattern from format validations for string inputs
+    b.optional :pattern
+
+    # Calculates min and max from length validations for numeric inputs
+    b.optional :min_max
+
+    # Calculates readonly automatically from readonly attributes
+    b.optional :readonly
+
+    ## Inputs
+    b.use :label_input
+    b.use :hint,  :wrap_with => { :tag => :span, :class => :hint }
+    b.use :error, :wrap_with => { :tag => :span, :class => :error }
+  end
+<% if options.bootstrap? %>
+  config.wrappers :bootstrap, :tag => 'div', :class => 'control-group', :error_class => 'error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.use :label
+    b.wrapper :tag => 'div', :class => 'controls' do |ba|
+      ba.use :input
+      ba.use :error, :wrap_with => { :tag => 'span', :class => 'help-inline' }
+      ba.use :hint,  :wrap_with => { :tag => 'p', :class => 'help-block' }
+    end
+  end
+
+  config.wrappers :prepend, :tag => 'div', :class => "control-group", :error_class => 'error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.use :label
+    b.wrapper :tag => 'div', :class => 'controls' do |input|
+      input.wrapper :tag => 'div', :class => 'input-prepend' do |prepend|
+        prepend.use :input
+      end
+      input.use :hint,  :wrap_with => { :tag => 'span', :class => 'help-block' }
+      input.use :error, :wrap_with => { :tag => 'span', :class => 'help-inline' }
+    end
+  end
+
+  config.wrappers :append, :tag => 'div', :class => "control-group", :error_class => 'error' do |b|
+    b.use :html5
+    b.use :placeholder
+    b.use :label
+    b.wrapper :tag => 'div', :class => 'controls' do |input|
+      input.wrapper :tag => 'div', :class => 'input-append' do |append|
+        append.use :input
+      end
+      input.use :hint,  :wrap_with => { :tag => 'span', :class => 'help-block' }
+      input.use :error, :wrap_with => { :tag => 'span', :class => 'help-inline' }
+    end
+  end
+
+  # Wrappers for forms and inputs using the Twitter Bootstrap toolkit.
+  # Check the Bootstrap docs (http://twitter.github.com/bootstrap)
+  # to learn about the different styles for forms and inputs,
+  # buttons and other elements.
+  config.default_wrapper = :bootstrap
+<% else %>
+  # The default wrapper to be used by the FormBuilder.
+  config.default_wrapper = :default
+<% end %>
+  # Define the way to render check boxes / radio buttons with labels.
+  # Defaults to :nested for bootstrap config.
+  #   :inline => input + label
+  #   :nested => label > input
+  config.boolean_style = :nested
+
+  # Default class for buttons
+  config.button_class = 'btn'
+
+  # Method used to tidy up errors. Specify any Rails Array method.
+  # :first lists the first message for each field.
+  # Use :to_sentence to list all errors for each field.
+  # config.error_method = :first
+
+  # Default tag used for error notification helper.
+  config.error_notification_tag = :div
+
+  # CSS class to add for error notification helper.
+  config.error_notification_class = 'alert alert-error'
+
+  # ID to add for error notification helper.
+  # config.error_notification_id = nil
+
+  # Series of attempts to detect a default label method for collection.
+  # config.collection_label_methods = [ :to_label, :name, :title, :to_s ]
+
+  # Series of attempts to detect a default value method for collection.
+  # config.collection_value_methods = [ :id, :to_s ]
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  # config.collection_wrapper_tag = nil
+
+  # You can define the class to use on all collection wrappers. Defaulting to none.
+  # config.collection_wrapper_class = nil
+
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to :span. Please note that when using :boolean_style = :nested,
+  # SimpleForm will force this option to be a label.
+  # config.item_wrapper_tag = :span
+
+  # You can define a class to use in all item wrappers. Defaulting to none.
+  # config.item_wrapper_class = nil
+
+  # How the label text should be generated altogether with the required text.
+  # config.label_text = lambda { |label, required| "#{required} #{label}" }
+
+  # You can define the class to use on all labels. Default is nil.
+  config.label_class = 'control-label'
+
+  # You can define the class to use on all forms. Default is simple_form.
+  # config.form_class = :simple_form
+
+  # You can define which elements should obtain additional classes
+  # config.generate_additional_classes_for = [:wrapper, :label, :input]
+
+  # Whether attributes are required by default (or not). Default is true.
+  # config.required_by_default = true
+
+  # Tell browsers whether to use default HTML5 validations (novalidate option).
+  # Default is enabled.
+  config.browser_validations = false
+
+  # Collection of methods to detect if a file type was given.
+  # config.file_methods = [ :mounted_as, :file?, :public_filename ]
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value.
+  # config.input_mappings = { /count/ => :integer }
+
+  # Default priority for time_zone inputs.
+  # config.time_zone_priority = nil
+
+  # Default priority for country inputs.
+  # config.country_priority = nil
+
+  # Default size for text inputs.
+  # config.default_input_size = 50
+
+  # When false, do not use translations for labels.
+  # config.translate_labels = true
+
+  # Automatically discover new inputs in Rails' autoload path.
+  # config.inputs_discovery = true
+
+  # Cache SimpleForm inputs discovery
+  # config.cache_discovery = !Rails.env.development?
+end

data/lib/generators/simple_form/templates/config/locales/simple_form.en.yml

@@ -0,0 +1,26 @@
+en:
+  simple_form:
+    "yes": 'Yes'
+    "no": 'No'
+    required:
+      text: 'required'
+      mark: '*'
+      # You can uncomment the line below if you need to overwrite the whole required html.
+      # When using html, text and mark won't be used.
+      # html: '<abbr title="required">*</abbr>'
+    error_notification:
+      default_message: "Some errors were found, please take a look:"
+    # Labels and hints examples
+    # labels:
+    #   defaults:
+    #     password: 'Password'
+    #   user:
+    #     new:
+    #       email: 'E-mail to sign in.'
+    #     edit:
+    #       email: 'E-mail.'
+    # hints:
+    #   defaults:
+    #     username: 'User name to sign in.'
+    #     password: 'No special characters, please.'
+

data/lib/simple_form.rb

@@ -0,0 +1,215 @@
+require 'action_view'
+require 'simple_form/action_view_extensions/form_helper'
+require 'simple_form/action_view_extensions/builder'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/hash/reverse_merge'
+
+module SimpleForm
+  autoload :Components,        'simple_form/components'
+  autoload :ErrorNotification, 'simple_form/error_notification'
+  autoload :FormBuilder,       'simple_form/form_builder'
+  autoload :Helpers,           'simple_form/helpers'
+  autoload :I18nCache,         'simple_form/i18n_cache'
+  autoload :Inputs,            'simple_form/inputs'
+  autoload :MapType,           'simple_form/map_type'
+  autoload :Wrappers,          'simple_form/wrappers'
+
+  ## CONFIGURATION OPTIONS
+
+  # Method used to tidy up errors.
+  mattr_accessor :error_method
+  @@error_method = :first
+
+  # Default tag used for error notification helper.
+  mattr_accessor :error_notification_tag
+  @@error_notification_tag = :p
+
+  # CSS class to add for error notification helper.
+  mattr_accessor :error_notification_class
+  @@error_notification_class = :error_notification
+
+  # Series of attemps to detect a default label method for collection.
+  mattr_accessor :collection_label_methods
+  @@collection_label_methods = [ :to_label, :name, :title, :to_s ]
+
+  # Series of attemps to detect a default value method for collection.
+  mattr_accessor :collection_value_methods
+  @@collection_value_methods = [ :id, :to_s ]
+
+  # You can wrap a collection of radio/check boxes in a pre-defined tag, defaulting to none.
+  mattr_accessor :collection_wrapper_tag
+  @@collection_wrapper_tag = nil
+
+  # You can define the class to use on all collection wrappers, defaulting to none.
+  mattr_accessor :collection_wrapper_class
+  @@collection_wrapper_class = nil
+
+  # You can wrap each item in a collection of radio/check boxes with a tag,
+  # defaulting to none. Please note that when using :boolean_style = :nested,
+  # SimpleForm will force this option to be a :label.
+  mattr_accessor :item_wrapper_tag
+  @@item_wrapper_tag = :span
+
+  # You can define the class to use on all item wrappers, defaulting to none.
+  mattr_accessor :item_wrapper_class
+  @@item_wrapper_class = nil
+
+  # How the label text should be generated altogether with the required text.
+  mattr_accessor :label_text
+  @@label_text = lambda { |label, required| "#{required} #{label}" }
+
+  # You can define the class to use on all labels. Default is nil.
+  mattr_accessor :label_class
+  @@label_class = nil
+
+  # Define the way to render check boxes / radio buttons with labels.
+  #   :inline => input + label (default)
+  #   :nested => label > input
+  mattr_accessor :boolean_style
+  @@boolean_style = :inline
+
+  # You can define the class to use on all forms. Default is simple_form.
+  mattr_accessor :form_class
+  @@form_class = :simple_form
+
+  # You can define which elements should obtain additional classes
+  mattr_accessor :generate_additional_classes_for
+  @@generate_additional_classes_for = [:wrapper, :label, :input]
+
+  # Whether attributes are required by default (or not).
+  mattr_accessor :required_by_default
+  @@required_by_default = true
+
+  # Tell browsers whether to use default HTML5 validations (novalidate option).
+  mattr_accessor :browser_validations
+  @@browser_validations = true
+
+  # Collection of methods to detect if a file type was given.
+  mattr_accessor :file_methods
+  @@file_methods = [ :mounted_as, :file?, :public_filename ]
+
+  # Custom mappings for input types. This should be a hash containing a regexp
+  # to match as key, and the input type that will be used when the field name
+  # matches the regexp as value, such as { /count/ => :integer }.
+  mattr_accessor :input_mappings
+  @@input_mappings = nil
+
+  # Default priority for time_zone inputs.
+  mattr_accessor :time_zone_priority
+  @@time_zone_priority = nil
+
+  # Default priority for country inputs.
+  mattr_accessor :country_priority
+  @@country_priority = nil
+
+  # Maximum size allowed for inputs.
+  mattr_accessor :default_input_size
+  @@default_input_size = 50
+
+  # When off, do not use translations in labels. Disabling translation in
+  # hints and placeholders can be done manually in the wrapper API.
+  mattr_accessor :translate_labels
+  @@translate_labels = true
+
+  # Automatically discover new inputs in Rails' autoload path.
+  mattr_accessor :inputs_discovery
+  @@inputs_discovery = true
+
+  # Cache SimpleForm inputs discovery
+  mattr_accessor :cache_discovery
+  @@cache_discovery = defined?(Rails) && !Rails.env.development?
+
+  # Adds a class to each generated button, mostly for compatiblity
+  mattr_accessor :button_class
+  @@button_class = 'button'
+
+  ## WRAPPER CONFIGURATION
+  # The default wrapper to be used by the FormBuilder.
+  mattr_accessor :default_wrapper
+  @@default_wrapper = :default
+  @@wrappers = {}
+
+  # Retrieves a given wrapper
+  def self.wrapper(name)
+    @@wrappers[name.to_sym] or raise WrapperNotFound, "Couldn't find wrapper with name #{name}"
+  end
+
+  # Raised when fails to find a given wrapper name
+  class WrapperNotFound < StandardError
+  end
+
+  # Define a new wrapper using SimpleForm::Wrappers::Builder
+  # and store it in the given name.
+  def self.wrappers(*args, &block)
+    if block_given?
+      options                 = args.extract_options!
+      name                    = args.first || :default
+      @@wrappers[name.to_sym] = build(options, &block)
+    else
+      @@wrappers
+    end
+  end
+
+  # Builds a new wrapper using SimpleForm::Wrappers::Builder.
+  def self.build(options={})
+    options[:tag] = :div if options[:tag].nil?
+    builder = SimpleForm::Wrappers::Builder.new(options)
+    yield builder
+    SimpleForm::Wrappers::Root.new(builder.to_a, options)
+  end
+
+  wrappers :class => :input, :hint_class => :field_with_hint, :error_class => :field_with_errors do |b|
+    b.use :html5
+
+    b.use :min_max
+    b.use :maxlength
+    b.use :placeholder
+    b.optional :pattern
+    b.optional :readonly
+
+    b.use :label_input
+    b.use :hint,  :wrap_with => { :tag => :span, :class => :hint }
+    b.use :error, :wrap_with => { :tag => :span, :class => :error }
+  end
+
+  ## SETUP
+
+  DEPRECATED = %w(hint_tag hint_class error_tag error_class error_notification_id wrapper_tag wrapper_class wrapper_error_class components html5)
+  @@deprecated = []
+
+  DEPRECATED.each do |method|
+    class_eval "def self.#{method}=(*); @@deprecated << :#{method}=; end"
+    class_eval "def self.#{method}; deprecation_warn 'SimpleForm.#{method} is deprecated and has no effect'; end"
+  end
+
+  def self.translate=(value)
+    deprecation_warn "SimpleForm.translate= is disabled in favor of translate_labels="
+    self.translate_labels = value
+  end
+
+  def self.translate
+    deprecation_warn "SimpleForm.translate is disabled in favor of translate_labels"
+    self.translate_labels
+  end
+
+  def self.deprecation_warn(message)
+    ActiveSupport::Deprecation.warn "[SIMPLE_FORM] #{message}", caller
+  end
+
+  def self.additional_classes_for(component)
+    generate_additional_classes_for.include?(component) ? yield : []
+  end
+
+  # Default way to setup SimpleForm. Run rails generate simple_form:install
+  # to create a fresh initializer with all configuration values.
+  def self.setup
+    yield self
+
+    unless @@deprecated.empty?
+      raise "[SIMPLE FORM] Your SimpleForm initializer file is using the following methods: #{@@deprecated.to_sentence}. " <<
+        "Those methods are part of the outdated configuration API. Updating to the new API is easy and fast. " <<
+        "Check for more info here: https://github.com/plataformatec/simple_form/wiki/Upgrading-to-Simple-Form-2.0"
+    end
+  end
+end