activemodel-form 0.0.1

data/example/config/initializers/simple_form.rb

@@ -0,0 +1,138 @@
+# 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
+
+  # The default wrapper to be used by the FormBuilder.
+  config.default_wrapper = :default
+
+  # 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/example/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/example/config/routes.rb

@@ -0,0 +1,8 @@
+Example::Application.routes.draw do
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  resource :form
+
+  root to: redirect('/form/')
+end

data/example/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Example::Application

data/example/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/example/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/example/public/500.html

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

data/example/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/example/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/lib/active_model/form/attributes.rb

@@ -0,0 +1,107 @@
+module ActiveModel
+  class Form
+    module BooleanAttribute
+      def self.parse(v)
+        if ['1', 't', 'true', 'yes'].include? v
+          true
+        elsif ['0', 'f', 'false', 'no'].include? v
+          false
+        elsif ['', nil].include? v
+          nil
+        else
+          raise "Couldn't parse boolean attribute value: '#{v}'"
+        end
+      end
+
+      def self.type
+        :boolean
+      end
+
+      def self.number?
+        false
+      end
+    end
+
+    module IntegerAttribute
+      def self.parse(v)
+        if v.present?
+          Integer(v)
+        elsif ['', nil].include? v
+          nil
+        else
+          raise "Couldn't parse integer attribute value: '#{v}'"
+        end
+      end
+
+      def self.type
+        :integer
+      end
+
+      def self.number?
+        true
+      end
+    end
+
+    module FloatAttribute
+      def self.parse(v)
+        if v.present?
+          Float(v)
+        elsif ['', nil].include? v
+          nil
+        else
+          raise "Couldn't parse float attribute value: '#{v}'"
+        end
+      end
+
+      def self.type
+        :float
+      end
+
+      def self.number?
+        true
+      end
+    end
+
+    module StringAttribute
+      def self.parse(v)
+        if v.present?
+          String.new(v)
+        elsif ['', nil].include? v
+          nil
+        else
+          raise "Couldn't parse string attribute value: '#{v}'"
+        end
+      end
+
+      def self.type
+        :string
+      end
+
+      def self.number?
+        false
+      end
+
+      def self.limit
+        nil
+      end
+    end
+
+    module DateTimeAttribute
+      def self.parse(v)
+        if v.compact.present?
+          DateTime.new(*v)
+        else
+          nil
+        end
+      end
+
+      def self.type
+        :timestamp
+      end
+
+      def self.number?
+        false
+      end
+    end
+  end
+end

data/lib/active_model/form/version.rb

@@ -0,0 +1,5 @@
+module ActiveModel
+  class Form
+    VERSION = "0.0.1"
+  end
+end

data/lib/active_model/form.rb

@@ -0,0 +1,85 @@
+require 'active_model'
+require 'active_model/form/version'
+require 'active_model/form/attributes'
+require 'active_support/inflector'
+
+module ActiveModel
+  class Form
+    include ActiveModel::Validations
+    include ActiveModel::Conversion
+    include ActiveModel
+    extend ActiveModel::Naming
+
+    def initialize(attributes=nil)
+      self.assign_attributes(attributes)
+    end
+
+    # For the Rails route helpers
+    def persisted?
+      false
+    end
+
+    # Set the model name to change the field names generated by the Rails form helpers
+    def self.model_name=(name)
+      @_model_name = ActiveModel::Name.new(self, nil, name)
+    end
+
+    def self.attribute(name, type_name)
+      # TODO: Make inheritance of ActiveModel::Forms do the right thing with attributes
+      @_attributes ||= {}
+      @_attributes[name.to_s] = self.type_from_type_name(type_name)
+      self.send(:attr_accessor, name)
+    end
+
+    def self.attributes
+      @_attributes ||= {}
+    end
+
+    # Returns the column object for the named attribute.
+    def column_for_attribute(name)
+      self.class.attributes[name.to_s]
+    end
+
+    def assign_attributes(new_attributes)
+      return if new_attributes.blank?
+      new_attributes = self.clean_attributes(new_attributes)
+      new_attributes.each do |k, v|
+        if attribute = self.class.attributes[k].presence
+          send("#{k}=", attribute.parse(v))
+        end
+      end
+    end
+
+    protected
+
+    def clean_attributes(attributes)
+      cleaned_attributes = {}
+
+      attributes.stringify_keys.each do |k, v|
+        if k.include?("(")
+          attribute_name = k.split("(").first
+          cleaned_attributes[attribute_name] ||= []
+          v = v.empty? ? nil : type_cast_attribute_value(k, v)
+          cleaned_attributes[attribute_name][find_parameter_position(k)] ||= v
+        else
+          cleaned_attributes[k] = v
+        end
+      end
+
+      cleaned_attributes
+    end
+
+    def self.type_from_type_name(type_name)
+      classified_type_name = ActiveSupport::Inflector.classify(type_name)
+      ActiveSupport::Inflector.safe_constantize("::ActiveModel::Form::#{classified_type_name}Attribute")
+    end
+
+    def type_cast_attribute_value(multiparameter_name, value)
+      multiparameter_name =~ /\([0-9]*([if])\)/ ? value.send("to_" + $1) : value
+    end
+
+    def find_parameter_position(multiparameter_name)
+      multiparameter_name.scan(/\(([0-9]*).*\)/).first.first.to_i - 1
+    end
+  end
+end

data/lib/activemodel-form.rb

@@ -0,0 +1 @@
+require 'active_model/form'

data/spec/boolean_attribute_form_spec.rb

@@ -0,0 +1,24 @@
+require_relative 'spec_helper'
+
+describe ActiveModel::Form do
+  # Boolean params generated by the Rails form helpers look like this
+  let(:params) do
+    { "form"=>
+      {"not_checked"=>"0",
+       "checked"=>"1"}
+    }
+  end
+
+  it "parses the Rails form helper boolean params" do
+    class FormWithBooleans < ActiveModel::Form
+      attribute :not_checked, :boolean
+      attribute :checked, :boolean
+      attribute :not_set, :boolean
+    end
+
+    form = FormWithBooleans.new(params['form'])
+    form.not_checked.must_equal false
+    form.checked.must_equal true
+    form.not_set.must_equal nil # TODO: Should this be nil or false?
+  end
+end

data/spec/date_time_form_spec.rb

@@ -0,0 +1,27 @@
+require_relative 'spec_helper'
+
+describe ActiveModel::Form do
+  # DateTime params generated by the Rails form helpers look like this
+  let(:params) do
+    { "form"=>
+      {"created_at(1i)"=>"2012",
+       "created_at(2i)"=>"8",
+       "created_at(3i)"=>"2",
+       "created_at(4i)"=>"17",
+       "created_at(5i)"=>"21",
+       "whatever"=>"yeah"} }
+  end
+
+  it "parses the Rails form helper datetime params" do
+    class FormWithDateTime < ActiveModel::Form
+      attribute :created_at, :date_time
+      attribute :something_else, :string
+      attribute :whatever, :string
+    end
+
+    form = FormWithDateTime.new(params['form'])
+    form.created_at.must_equal(DateTime.new(2012, 8, 2, 17, 21))
+    form.something_else.must_equal nil
+    form.whatever.must_equal "yeah"
+  end
+end

data/spec/integer_attribute_form_spec.rb

@@ -0,0 +1,24 @@
+require_relative 'spec_helper'
+
+describe ActiveModel::Form do
+  # Integr params generated by the Rails form helpers look like this
+  let(:params) do
+    { "form"=>
+      {"zero"=>"0",
+       "one"=>"1"}
+    }
+  end
+
+  it "parses the Rails form helper boolean params" do
+    class FormWithBooleans < ActiveModel::Form
+      attribute :zero, :integer
+      attribute :one, :integer
+      attribute :not_set, :integer
+    end
+
+    form = FormWithBooleans.new(params['form'])
+    form.zero.must_equal 0
+    form.one.must_equal 1
+    form.not_set.must_equal nil
+  end
+end

data/spec/model_name_spec.rb

@@ -0,0 +1,17 @@
+require_relative 'spec_helper'
+
+describe ActiveModel::Form do
+  it "can be set but doesn't influence subclasses" do
+    class Parent < ActiveModel::Form
+      self.model_name = 'the_parent'
+    end
+    class Child < ActiveModel::Form
+      self.model_name = 'the_child'
+    end
+
+    ActiveModel::Form.model_name.must_equal 'ActiveModel::Form'
+    Parent.model_name.must_equal 'the_parent'
+    Child.model_name.must_equal 'the_child'
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activemodel-form'