heartcombo--simple_form/lib/simple_form.rb

227 lines
7.3 KiB
Ruby
Raw Normal View History

2010-02-06 19:41:35 +00:00
require 'action_view'
2009-12-09 20:25:12 +00:00
require 'simple_form/action_view_extensions/form_helper'
require 'simple_form/action_view_extensions/builder'
2011-12-05 15:26:49 +00:00
require 'active_support/core_ext/hash/slice'
require 'active_support/core_ext/hash/except'
require 'active_support/core_ext/hash/reverse_merge'
2009-12-09 20:25:12 +00:00
module SimpleForm
extend ActiveSupport::Autoload
autoload :Helpers
autoload :Wrappers
eager_autoload do
autoload :Components
autoload :ErrorNotification
autoload :FormBuilder
autoload :Inputs
end
def self.eager_load!
super
SimpleForm::Inputs.eager_load!
SimpleForm::Components.eager_load!
end
2011-09-04 09:31:24 +00:00
## 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
2010-11-07 09:18:37 +00:00
@@error_notification_class = :error_notification
# Series of attemps to detect a default label method for collection.
2009-12-10 02:22:53 +00:00
mattr_accessor :collection_label_methods
2013-01-30 13:36:44 +00:00
@@collection_label_methods = [:to_label, :name, :title, :to_s]
2009-12-10 02:22:53 +00:00
# Series of attemps to detect a default value method for collection.
2009-12-10 02:22:53 +00:00
mattr_accessor :collection_value_methods
2013-01-30 13:36:44 +00:00
@@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,
2013-01-30 13:36:44 +00:00
# defaulting to span. 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
2009-12-10 22:11:15 +00:00
# How the label text should be generated altogether with the required text.
mattr_accessor :label_text
@@label_text = lambda { |label, required| "#{required} #{label}" }
2009-12-11 13:12:57 +00:00
2013-01-30 13:36:44 +00:00
# You can define the class to be used on all labels. Defaults to none.
mattr_accessor :label_class
@@label_class = nil
# Define the way to render check boxes / radio buttons with labels.
2013-01-28 21:02:59 +00:00
# inline: input + label (default)
# nested: label > input
mattr_accessor :boolean_style
@@boolean_style = :inline
2013-01-30 13:36:44 +00:00
# You can define the class to be used on all forms. Default is simple_form.
mattr_accessor :form_class
@@form_class = :simple_form
2013-01-30 13:36:44 +00:00
# You can define which elements should obtain additional classes.
2012-02-16 17:42:47 +00:00
mattr_accessor :generate_additional_classes_for
@@generate_additional_classes_for = [:wrapper, :label, :input]
2013-01-30 13:36:44 +00:00
# Whether attributes are required by default or not.
2010-07-06 09:28:23 +00:00
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
2009-12-11 13:12:57 +00:00
# Collection of methods to detect if a file type was given.
mattr_accessor :file_methods
2013-01-30 13:36:44 +00:00
@@file_methods = [:mounted_as, :file?, :public_filename]
2010-11-26 00:35:38 +00:00
# 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
# Custom wrappers for input types. This should be a hash containing an input
2012-09-07 19:14:40 +00:00
# type as key and the wrapper that will be used for all inputs with specified type.
2013-01-28 21:02:59 +00:00
# e.g { string: :string_wrapper, boolean: :boolean_wrapper }
# You can also set a wrapper mapping per form basis.
# e.g simple_form_for(@foo, wrapper_mapping: { checkbox: :bootstrap_checkbox })
mattr_accessor :wrapper_mappings
@@wrapper_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
# DEPRECATED: Maximum size allowed for inputs.
2010-02-06 21:06:25 +00:00
mattr_accessor :default_input_size
@@default_input_size = nil
2010-02-06 21:06:25 +00:00
# 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
2011-04-27 18:55:03 +00:00
# Automatically discover new inputs in Rails' autoload path.
mattr_accessor :inputs_discovery
@@inputs_discovery = true
2013-01-30 13:36:44 +00:00
# Cache SimpleForm inputs discovery.
2011-04-27 18:55:03 +00:00
mattr_accessor :cache_discovery
@@cache_discovery = defined?(Rails) && !Rails.env.development?
2011-04-27 18:55:03 +00:00
2013-01-30 13:36:44 +00:00
# Adds a class to each generated button, mostly for compatiblity.
mattr_accessor :button_class
@@button_class = 'button'
2013-04-29 15:13:33 +00:00
# Override the default ActiveModelHelper behaviour of wrapping the input.
# This gets taken care of semantically by adding an error class to the wrapper tag
# containing the input.
mattr_accessor :field_error_proc
@@field_error_proc = proc do |html_tag, instance_tag|
html_tag
end
# Adds a class to each generated inputs
mattr_accessor :input_class
@@input_class = nil
# Defines if an input wrapper class should be included or not
mattr_accessor :include_default_input_wrapper_class
@@include_default_input_wrapper_class = true
2011-09-04 09:31:24 +00:00
## WRAPPER CONFIGURATION
2012-01-24 18:54:28 +00:00
# The default wrapper to be used by the FormBuilder.
mattr_accessor :default_wrapper
@@default_wrapper = :default
2011-09-04 09:31:24 +00:00
@@wrappers = {}
2011-09-04 09:31:24 +00:00
# Retrieves a given wrapper
def self.wrapper(name)
2011-09-27 03:59:06 +00:00
@@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
2011-09-04 09:31:24 +00:00
# Define a new wrapper using SimpleForm::Wrappers::Builder
# and store it in the given name.
def self.wrappers(*args, &block)
if block_given?
2011-09-27 02:41:53 +00:00
options = args.extract_options!
name = args.first || :default
@@wrappers[name.to_sym] = build(options, &block)
2011-09-04 09:31:24 +00:00
else
@@wrappers
end
end
2011-09-02 18:33:03 +00:00
2011-09-03 08:45:10 +00:00
# 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)
2011-09-03 08:33:57 +00:00
yield builder
2011-09-03 08:45:10 +00:00
SimpleForm::Wrappers::Root.new(builder.to_a, options)
end
2013-01-28 21:02:59 +00:00
wrappers class: :input, hint_class: :field_with_hint, error_class: :field_with_errors do |b|
2011-12-04 15:15:27 +00:00
b.use :html5
2011-12-04 15:31:13 +00:00
b.use :min_max
2011-12-04 12:14:39 +00:00
b.use :maxlength
2011-09-03 08:33:57 +00:00
b.use :placeholder
b.optional :pattern
b.optional :readonly
2011-12-04 11:15:22 +00:00
2011-09-03 08:33:57 +00:00
b.use :label_input
2013-01-28 21:02:59 +00:00
b.use :hint, wrap_with: { tag: :span, class: :hint }
b.use :error, wrap_with: { tag: :span, class: :error }
2011-09-03 08:33:57 +00:00
end
2011-09-04 09:31:24 +00:00
2012-02-17 00:36:34 +00:00
def self.additional_classes_for(component)
generate_additional_classes_for.include?(component) ? yield : []
end
2012-12-27 03:40:58 +00:00
## SETUP
def self.default_input_size=(*)
ActiveSupport::Deprecation.warn "[SIMPLE_FORM] SimpleForm.default_input_size= is deprecated and has no effect", caller
end
2011-09-04 09:31:24 +00:00
# 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
end
end
require 'simple_form/railtie' if defined?(Rails)