reform 0.1.1 → 0.1.2

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 Gemfile.lock
+gemfiles/*.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -3,5 +3,6 @@ rvm:
   - 2.0.0
   - 1.9.3
   - 1.8.7
-  - rbx-19mode
-  - jruby-19mode
+gemfile:
+  - Gemfile
+  - gemfiles/Gemfile.rails-3.0

data/CHANGES.md

@@ -1,3 +1,8 @@
+h3. 0.1.2
+
+* `Form#to_model` is now delegated to model.
+* Coercion with virtus works.
+
 h3. 0.1.1
 
 * Added `reform/rails` that requires everything you need (even in other frameworks :).

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in reform.gemspec
 gemspec
+
+gem 'rake', "10.1.0.beta3"
+#gem 'representable', path: "../representable"

data/README.md

@@ -100,6 +100,26 @@ To push the incoming data to the models directly, call `#save` without the block
                 #   by calling @form.song.name= and @form.artist.title=.
 ```
 
+## Coercion
+
+Often you want incoming form data to be converted to a type, like timestamps. Reform uses [virtus](https://github.com/solnic/virtus) for coercion, the DSL is seamlessly integrated into Reform with the `:type` option.
+
+Be sure to add `virtus` to your Gemfile.
+
+```ruby
+require 'reform/form/coercion'
+
+class SongRequestForm < Reform::Form
+  include DSL
+  include Reform::Form::Coercion
+
+  property :written_at,  on: :song, type: DateTime
+end
+
+@form.save do |data, nested|
+  data.written_at #=> <DateTime XXX>
+```
+
 ## Rails Integration
 
 [A sample Rails app using Reform.](https://github.com/gogogarrett/reform_example)
@@ -121,7 +141,7 @@ class UserProfileForm < Reform::Form
   property :email,        on: :user
   properties [:gender, :age],   on: :profile
 
-  model :user, on: :user
+  model :user
 
   validates :email, :gender, presence: true
   validates :age, numericality: true
@@ -129,6 +149,12 @@ class UserProfileForm < Reform::Form
 end
 ```
 
+Basically, `model :user` tells Reform to use the `:user` object in the composition as the form main object while using `"user"` as the form name (needed for URL computation). If you want to change the form name let Reform know.
+
+```ruby
+  model :singer, :on => :user # form name is "singer" whereas main object is `:user` in composition.
+```
+
 
 #### View Form
 
@@ -190,3 +216,13 @@ end
 ## Security
 
 By explicitely defining the form layout using `::property` there is no more need for protecting from unwanted input. `strong_parameter` or `attr_accessible` become obsolete. Reform will simply ignore undefined incoming parameters.
+
+## Maintainers
+
+[Nick Sutterer](https://github.com/apotonick)
+
+[Garrett Heinlen](https://github.com/gogogarrett)
+
+### Attributions!!!
+
+Great thanks to [Blake Education](https://github.com/blake-education) for giving us the freedom and time to develop this project while working on their project.

data/TODO.md

@@ -1,2 +1,4 @@
 * `validates :title, :presence => true`
-  with @model.title == "Little Green Car" and validate({}) the form is still valid (as we "have" a valid title). is that what we want?
+  with @model.title == "Little Green Car" and validate({}) the form is still valid (as we "have" a valid title). is that what we want?
+
+* document Form#to_hash and Form#to_nested_hash (e.g. with OpenStruct composition to make it a very simple form)

data/gemfiles/Gemfile.rails-3.0

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in reform.gemspec
+gemspec :path => '../'
+
+gem 'railties', '~> 3.0.11'
+gem 'activerecord', '~> 3.0.11'

data/lib/reform/form.rb

@@ -1,4 +1,5 @@
 require 'delegate'
+require 'ostruct'
 
 module Reform
   class Form  < SimpleDelegator
@@ -8,12 +9,11 @@ module Reform
     # validation: this object also contains the validation rules itself, should be separated.
     # TODO: figure out #to_key issues.
 
-    def initialize(mapper, composition)
-      @mapper     = mapper
+    def initialize(mapper_class, composition)
+      @mapper     = mapper_class
       @model      = composition
-      representer = @mapper.new(composition)
 
-      super Fields.new(representer.fields, representer.to_hash)  # decorate composition and transform to hash.
+      super(setup_fields(mapper_class, composition))  # delegate all methods to Fields instance.
     end
 
     def validate(params)
@@ -30,13 +30,6 @@ module Reform
       @mapper.new(model).from_hash(to_hash) # DISCUSS: move to Composition?
     end
 
-  private
-    attr_accessor :mapper, :model
-
-    def update_with(params)
-      mapper.new(self).from_hash(params) # sets form properties found in params on self.
-    end
-
     # Use representer to return current key-value form hash.
     def to_hash
       mapper.new(self).to_hash
@@ -46,6 +39,24 @@ module Reform
       model.nested_hash_for(to_hash)  # use composition to compute nested hash.
     end
 
+  private
+    attr_accessor :mapper, :model
+
+    def setup_fields(mapper_class, composition)
+      # decorate composition and transform to hash.
+      representer = mapper_class.new(composition)
+
+      create_fields(representer.fields, representer.to_hash)
+    end
+
+    def create_fields(field_names, fields)
+      Fields.new(field_names, fields)
+    end
+
+    def update_with(params)
+      mapper.new(self).from_hash(params) # sets form properties found in params on self.
+    end
+
     # FIXME: make AM optional.
     require 'active_model'
     include ActiveModel::Validations

data/lib/reform/form/active_model.rb

@@ -6,14 +6,14 @@ module Reform::Form::ActiveModel
   end
 
   module ClassMethods
-    def model(*args)
-      @model_options  = args  # FIXME: make inheritable!
-      main_model      = args.last[:on]
+    def model(main_model, options={})
+      @model_options    = [main_model, options]  # FIXME: make inheritable!
+      composition_model = options[:on] || main_model
 
-      delegate main_model, :to => :model  # #song => model.song
-      delegate :persisted?, :to_key, :to_param, :to => main_model  # #to_key => song.to_key
+      delegate composition_model, :to => :model  # #song => model.song
+      delegate :persisted?, :to_key, :to_param, :to_model, :to => composition_model  # #to_key => song.to_key
 
-      alias_method args.first, main_model # #hit => model.song.
+      alias_method main_model, composition_model # #hit => model.song.
     end
 
     def property(name, options={})
@@ -22,7 +22,10 @@ module Reform::Form::ActiveModel
     end
 
     def model_name
-      ::ActiveModel::Name.new(self, nil, @model_options.first.to_s.camelize)
+      name = @model_options.first.to_s.camelize
+
+      return ::ActiveModel::Name.new(OpenStruct.new(:name => name)) if ::ActiveModel::VERSION::MAJOR == 3 and ::ActiveModel::VERSION::MINOR == 0
+      ::ActiveModel::Name.new(self, nil, name)
     end
   end
 end

data/lib/reform/form/coercion.rb

@@ -0,0 +1,18 @@
+require 'representable/decorator/coercion'
+
+class Reform::Form
+  module Coercion
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def representer_class
+        super.class_eval do
+          include Representable::Decorator::Coercion unless self < Representable::Decorator::Coercion # DISCUSS: include it once. why do we have to check this?
+          self
+        end
+      end
+    end
+  end
+end

data/lib/reform/version.rb

@@ -1,3 +1,3 @@
 module Reform
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/reform.gemspec

@@ -18,11 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency             "representable"
+  spec.add_dependency             "representable", ">= 1.5.3"
   spec.add_dependency             "activemodel"
   spec.add_development_dependency "bundler",        "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "virtus"
 end

data/test/active_model_test.rb

@@ -15,10 +15,24 @@ class ActiveModelTest < MiniTest::Spec
   let (:duran) { OpenStruct.new }
   let (:form) { HitForm.new(:song => rio, :artist => duran) }
 
-  it "creates model readers" do
-    form.hit.must_equal rio
+  describe "main form reader #hit" do
+    it "delegates to :on model" do
+      form.hit.must_equal rio
+    end
+
+    it "doesn't delegate when :on missing" do
+      class HitForm < Reform::Form
+        include DSL
+        include Reform::Form::ActiveModel
+
+        property  :title,  :on => :song
+
+        model :song
+      end.new(:song => rio, :artist => duran).song.must_equal rio
+    end
   end
 
+
   it "creates composition readers" do
     form.song.must_equal rio
     form.artist.must_equal duran
@@ -40,6 +54,10 @@ class ActiveModelTest < MiniTest::Spec
     HitForm.new(:song => OpenStruct.new.instance_eval { def to_param; "yo!"; end; self }, :artist => OpenStruct.new).to_param.must_equal "yo!"
   end
 
+  it "provides #to_model" do
+    HitForm.new(:song => OpenStruct.new.instance_eval { def to_model; "yo!"; end; self }, :artist => OpenStruct.new).to_model.must_equal "yo!"
+  end
+
   it "works with any order of ::model and ::property" do
     class AnotherForm < Reform::Form
       include DSL

data/test/dsl_test.rb

@@ -15,4 +15,29 @@ class DslTest < MiniTest::Spec
   it "works by creating Representer and Composition for you" do
     form.validate("title" => "Greyhound", "name" => "Frenzal Rhomb").must_equal false
   end
+
+  require 'reform/form/coercion'
+  it "allows coercion" do
+    form = Class.new(Reform::Form) do
+      include Reform::Form::DSL
+      include Reform::Form::Coercion
+
+      property :written_at, :type => DateTime, :on => :song
+    end.new(:song => OpenStruct.new(:written_at => "31/03/1981"))
+
+    form.written_at.must_be_kind_of DateTime
+    form.written_at.must_equal DateTime.parse("Tue, 31 Mar 1981 00:00:00 +0000")
+  end
+
+  it "allows coercion in validate" do
+    form = Class.new(Reform::Form) do
+      include Reform::Form::DSL
+      include Reform::Form::Coercion
+
+      property :id, :type => Integer, :on => :song
+    end.new(:song => OpenStruct.new())
+
+    form.validate("id" => "1")
+    form.to_hash.must_equal("id" => 1)
+  end
 end

data/test/reform_test.rb

@@ -45,6 +45,7 @@ class FieldsTest < MiniTest::Spec
     end
 
     it "processes value syms" do
+      skip "we don't need to test this as representer.to_hash always returns strings"
       fields = Reform::Fields.new(["name", "title"], :title => "The Body")
       fields.name.must_equal  nil
       fields.title.must_equal "The Body"
@@ -53,6 +54,12 @@ class FieldsTest < MiniTest::Spec
 end
 
 class ReformTest < MiniTest::Spec
+  def errors_for(form)
+    errors = form.errors
+    errors = errors.messages unless ::ActiveModel::VERSION::MAJOR == 3 and ::ActiveModel::VERSION::MINOR == 0
+    errors
+  end
+
   let (:duran)  { OpenStruct.new(:name => "Duran Duran") }
   let (:rio)    { OpenStruct.new(:title => "Rio") }
 
@@ -174,7 +181,7 @@ class ReformTest < MiniTest::Spec
 
       it "populates errors" do
         form.validate({})
-        form.errors.messages.must_equal({:name=>["can't be blank"], :title=>["can't be blank"]})
+        errors_for(form).must_equal({:name=>["can't be blank"], :title=>["can't be blank"]})
       end
     end
 
@@ -189,7 +196,7 @@ class ReformTest < MiniTest::Spec
         end.new(SongAndArtistMap, comp)
 
         form.validate({}).must_equal false
-        form.errors.messages.must_equal({:name=>["Please give me a name"]})
+        errors_for(form).must_equal({:name=>["Please give me a name"]})
       end
     end
 
@@ -212,7 +219,7 @@ class ReformTest < MiniTest::Spec
       it "is invalid and shows error when taken" do
         form = ActiveRecordForm.new(SongAndArtistMap, comp)
         form.validate({"name" => "Racer X"}).must_equal false
-        form.errors.messages.must_equal({:name=>["has already been taken"], :title => ["can't be blank"]})
+        errors_for(form).must_equal({:name=>["has already been taken"], :title => ["can't be blank"]})
       end
 
       require 'reform/rails'
@@ -264,5 +271,3 @@ class ReformTest < MiniTest::Spec
     end
   end
 end
-
-# TODO: test errors

data/test/test_helper.rb

@@ -1,4 +1,2 @@
-require 'test/unit'
-require 'minitest/spec'
-require 'ostruct'
-require 'reform'
+require 'reform'
+require 'minitest/autorun'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reform
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -19,7 +19,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -124,6 +124,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Freeing your AR models from form logic.
 email:
 - apotonick@gmail.com
@@ -141,10 +157,12 @@ files:
 - Rakefile
 - TODO.md
 - database.sqlite3
+- gemfiles/Gemfile.rails-3.0
 - lib/reform.rb
 - lib/reform/form.rb
 - lib/reform/form/active_model.rb
 - lib/reform/form/active_record.rb
+- lib/reform/form/coercion.rb
 - lib/reform/form/dsl.rb
 - lib/reform/rails.rb
 - lib/reform/version.rb