reform 0.2.7 → 1.0.0

data/lib/reform/form/virtual_attributes.rb

@@ -1,10 +1,9 @@
-module Reform
-  class Form
+class Reform::Form < Reform::Contract
     # TODO: this should be in Representer namespace.
     module EmptyAttributesOptions
       def options
         empty_fields = representable_attrs.
-          find_all { |d| d.options[:empty] }.
+          find_all { |d| d[:empty] }.
           collect  { |d| d.name.to_sym }
 
         super.exclude!(empty_fields)
@@ -14,11 +13,10 @@ module Reform
     module ReadonlyAttributesOptions
       def options
         readonly_fields = representable_attrs.
-          find_all { |d| d.options[:virtual] }.
+          find_all { |d| d[:virtual] }.
           collect  { |d| d.name.to_sym }
 
         super.exclude!(readonly_fields)
       end
     end
-  end
 end

data/lib/reform/representer.rb

@@ -3,6 +3,12 @@ require 'representable/decorator'
 
 module Reform
   class Representer < Representable::Decorator
+    include Representable::Hash::AllowSymbols
+
+    extend Uber::InheritableAttr
+    inheritable_attr :options
+    # self.options = {}
+
     # Invokes #to_hash and/or #from_hash with #options. This provides a hook for other
     # modules to add options for the representational process.
     module WithOptions
@@ -42,11 +48,16 @@ module Reform
 
     def nested_forms(&block)
       clone_config!.
-        find_all { |attr| attr.options[:form] }.
-        collect  { |attr| [attr, represented.send(attr.getter)] }. # DISCUSS: can't we do this with the Binding itself?
+        find_all { |attr| attr[:form] }.
         each(&block)
     end
 
+    def self.for(options)
+      clone.tap do |representer|
+        representer.options = options
+      end
+    end
+
     def self.clone # called in inheritable_attr :representer_class.
       Class.new(self) # By subclassing, representable_attrs.clone is called.
     end
@@ -62,7 +73,10 @@ module Reform
     def self.inline_representer(base_module, name, options, &block)
       name = name.to_s.singularize.camelize
 
-      Class.new(Form) do
+      Class.new(self.options[:form_class]) do
+        # TODO: this will soon become a generic feature in representable.
+        include *options[:features].reverse if options[:features]
+
         instance_exec &block
 
         @form_name = name

data/lib/reform/version.rb

@@ -1,3 +1,3 @@
 module Reform
-  VERSION = "0.2.7"
+  VERSION = "1.0.0"
 end

data/reform.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency             "representable",  "~> 1.7.5"
+  spec.add_dependency             "representable",  "~> 1.8.1"
+  spec.add_dependency             "disposable",     "~> 0.0.3"
   spec.add_dependency             "uber",           "~> 0.0.4"
   spec.add_dependency             "activemodel"
   spec.add_development_dependency "bundler",        "~> 1.3"

data/test/active_model_test.rb

@@ -94,98 +94,6 @@ class NewActiveModelTest < MiniTest::Spec # TODO: move to test/rails/
   end
 end
 
-class FormBuilderCompatTest < MiniTest::Spec
-  let (:form_class) {
-    Class.new(Reform::Form) do
-      include Reform::Form::ActiveModel::FormBuilderMethods
-
-      property :artist do
-        property :name
-        validates :name, :presence => true
-      end
-
-      collection :songs do
-        property :title
-        property :release_date
-        validates :title, :presence => true
-      end
-
-      class LabelForm < Reform::Form
-        property :name
-      end
-
-      property :label, :form => LabelForm
-    end
-  }
-
-  let (:song) { OpenStruct.new }
-  let (:form) { form_class.new(OpenStruct.new(
-    :artist => Artist.new(:name => "Propagandhi"),
-    :songs  => [song],
-    :label  => OpenStruct.new)) }
-
-  it "respects _attributes params hash" do
-    form.validate("artist_attributes" => {"name" => "Blink 182"},
-      "songs_attributes" => {"0" => {"title" => "Damnit"}})
-
-    form.artist.name.must_equal "Blink 182"
-    form.songs.first.title.must_equal "Damnit"
-  end
-
-  it "allows nested collection and property to be missing" do
-    form.validate({})
-
-    form.artist.name.must_equal "Propagandhi"
-
-    form.songs.size.must_equal 1
-    form.songs[0].model.must_equal song # this is a weird test.
-  end
-
-  it "defines _attributes= setter so Rails' FB works properly" do
-    form.must_respond_to("artist_attributes=")
-    form.must_respond_to("songs_attributes=")
-    form.must_respond_to("label_attributes=")
-  end
-
-  describe "deconstructed date parameters" do
-    let(:form_attributes) do
-      {
-        "artist_attributes" => {"name" => "Blink 182"},
-        "songs_attributes" => {"0" => {"title" => "Damnit", "release_date(1i)" => release_year,
-          "release_date(2i)" => release_month, "release_date(3i)" => release_day}}
-      }
-    end
-    let(:release_year) { "1997" }
-    let(:release_month) { "9" }
-    let(:release_day) { "27" }
-
-    describe "with valid parameters" do
-      it "creates a date" do
-        form.validate(form_attributes)
-
-        form.songs.first.release_date.must_equal Date.new(1997, 9, 27)
-      end
-    end
-
-    %w(year month day).each do |date_attr|
-      describe "when the #{date_attr} is missing" do
-        let(:"release_#{date_attr}") { "" }
-
-        it "rejects the date" do
-          form.validate(form_attributes)
-
-          form.songs.first.release_date.must_be_nil
-        end
-      end
-    end
-  end
-
-  it "returns flat errors hash" do
-    form.validate("artist_attributes" => {"name" => ""},
-      "songs_attributes" => {"0" => {"title" => ""}})
-    form.errors.messages.must_equal(:"artist.name" => ["can't be blank"], :"songs.title" => ["can't be blank"])
-  end
-end
 
 class ActiveModelWithCompositionTest < MiniTest::Spec
    class HitForm < Reform::Form

data/test/as_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+
+class AsTest < BaseTest
+  class AlbumForm < Reform::Form
+    property :name, :as => :title
+
+    property :single, :as => :hit do
+      property :title
+    end
+
+    collection :tracks, :as => :songs do
+      property :name, :as => :title
+    end
+
+    property :band do
+      property :company, :as => :label do
+        property :business, :as => :name
+      end
+    end
+  end
+
+  let (:song2) { Song.new("Roxanne") }
+
+  let (:params) {
+      {
+        "name" => "Best Of The Police",
+        "single"   => {"title" => "So Lonely"},
+        "tracks" => [{"name" => "Message In A Bottle"}, {"name" => "Roxanne"}]
+      }
+    }
+
+  subject { AlbumForm.new(Album.new("Best Of", hit, [Song.new("Fallout"), song2])) }
+
+  it { subject.name.must_equal "Best Of" }
+  it { subject.single.title.must_equal "Roxanne" }
+  it { subject.tracks[0].name.must_equal "Fallout" }
+  it { subject.tracks[1].name.must_equal "Roxanne" }
+
+
+  describe "#validate" do
+
+
+    before { subject.validate(params) }
+
+    it { subject.name.must_equal "Best Of The Police" }
+    it { subject.single.title.must_equal "So Lonely" }
+    it { subject.tracks[0].name.must_equal "Message In A Bottle" }
+    it { subject.tracks[1].name.must_equal "Roxanne" }
+  end
+
+
+  describe "#sync" do
+    before {
+      subject.tracks[1].name = "Livin' Ain't No Crime"
+      subject.sync
+    }
+
+    it { song2.title.must_equal "Livin' Ain't No Crime" }
+  end
+
+
+  describe "#save (nested hash)" do
+    before { subject.validate(params) }
+
+    it do
+      hash = nil
+
+      subject.save do |f, nested_hash|
+        hash = nested_hash
+      end
+
+      hash.must_equal({"title"=>"Best Of The Police", "hit"=>{"title"=>"So Lonely"}, "songs"=>[{"title"=>"Message In A Bottle"}, {"title"=>"Roxanne"}]})
+    end
+  end
+end

data/test/coercion_test.rb

@@ -1,18 +1,36 @@
 require "test_helper"
 require "reform/form/coercion"
 
-class CoercionTest < MiniTest::Spec
-  it "allows coercion" do
-    form = Class.new(Reform::Form) do
+class CoercionTest < BaseTest
+  subject do
+    Class.new(Reform::Form) do
       include Reform::Form::Coercion
 
-      property :written_at, :type => DateTime
-    end.new(OpenStruct.new(:written_at => "31/03/1981"))
+      property :released_at, :type => DateTime
+
+      property :hit do
+        property :length, :type => Integer
+        property :good,   :type => Virtus::Attribute::Boolean
+      end
 
-    form.written_at.must_be_kind_of DateTime
-    form.written_at.must_equal DateTime.parse("Tue, 31 Mar 1981 00:00:00 +0000")
+      property :band do
+        property :label do
+          property :value, :type => Float
+        end
+      end
+    end.new(OpenStruct.new(
+      :released_at => "31/03/1981",
+      :hit => OpenStruct.new(:length => "312"),
+      :band => Band.new(OpenStruct.new(:value => "9999.99"))
+    ))
   end
 
+  it { subject.released_at.must_be_kind_of DateTime }
+  it { subject.released_at.must_equal DateTime.parse("Tue, 31 Mar 1981 00:00:00 +0000") }
+  it { subject.hit.length.must_equal 312 }
+  it { subject.band.label.value.must_equal 9999.99 }
+
+
   it "allows coercion in validate" do
     form = Class.new(Reform::Form) do
       include Reform::Form::Coercion
@@ -21,6 +39,6 @@ class CoercionTest < MiniTest::Spec
     end.new(OpenStruct.new())
 
     form.validate("id" => "1")
-    form.to_hash.must_equal("id" => 1)
+    form.id.must_equal 1
   end
 end

data/test/composition_test.rb

@@ -1,6 +1,6 @@
 class CompositionTest < ReformSpec
   class SongAndArtist < Reform::Composition
-    map({:artist => [:name], :song => [:title]}) #SongAndArtistMap.representable_attrs
+    map({:artist => [[:name]], :song => [[:title]]}) #SongAndArtistMap.representable_attrs
   end
 
   let (:comp) { SongAndArtist.new(:artist => @artist=OpenStruct.new, :song => rio) }
@@ -21,17 +21,16 @@ class CompositionTest < ReformSpec
     comp.artist.object_id.must_equal @artist.object_id
   end
 
-  describe "::map_from" do
+
+  describe "::from" do
     it "creates the same mapping" do
       comp =
-      Class.new(Reform::Composition) do
-        map_from(
+      Reform::Composition.from(
           Class.new(Reform::Representer) do
             property :name,  :on => :artist
             property :title, :on => :song
           end
-        )
-      end.
+        ).
       new(:artist => duran, :song => rio)
 
       comp.name.must_equal "Duran Duran"
@@ -39,6 +38,7 @@ class CompositionTest < ReformSpec
     end
   end
 
+
   describe "#nested_hash_for" do
     it "returns nested hash" do
       comp.nested_hash_for(:name => "Jimi Hendrix", :title => "Fire").must_equal({:artist=>{:name=>"Jimi Hendrix"}, :song=>{:title=>"Fire"}})
@@ -50,8 +50,8 @@ class CompositionTest < ReformSpec
 
     it "works with strings in map" do
       Class.new(Reform::Composition) do
-        map(:artist => ["name"])
-      end.new([nil]).nested_hash_for(:name => "Jimi Hendrix").must_equal({:artist=>{:name=>"Jimi Hendrix"}})
+        map(:artist => [["name"]])
+      end.new({}).nested_hash_for(:name => "Jimi Hendrix").must_equal({:artist=>{:name=>"Jimi Hendrix"}})
     end
   end
 end

data/test/contract_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class ContractTest < BaseTest
+  class AlbumContract < Reform::Contract
+    property :title
+    validates :title, :presence => true, :length => {:minimum => 3}
+
+    property :hit do
+      property :title
+      validates :title, :presence => true
+    end
+
+    collection :songs do
+      property :title
+      validates :title, :presence => true
+    end
+
+    validates :songs, :length => {:minimum => 4}
+
+    property :band do # yepp, people do crazy stuff like that.
+      validates :label, :presence => true
+
+      property :label do
+        property :name
+        validates :name, :presence => true
+      end
+      # TODO: make band a required object.
+    end
+  end
+
+  let (:album) { Album.new(nil, Song.new, [Song.new, Song.new], Band.new() ) }
+  subject { AlbumContract.new(album) }
+
+
+  describe "invalid" do
+    before {
+      res = subject.validate
+      res.must_equal false
+    }
+
+    it { subject.errors.messages.must_equal({:"hit.title"=>["can't be blank"], :"songs.title"=>["can't be blank"], :"band.label"=>["can't be blank"], :songs=>["is too short (minimum is 4 characters)"], :title=>["can't be blank", "is too short (minimum is 3 characters)"]}) }
+  end
+
+
+  describe "valid" do
+    let (:album) { Album.new(
+      "Keeper Of The Seven Keys",
+      nil,
+      [Song.new("Initiation"), Song.new("I'm Alive"), Song.new("A Little Time"), Song.new("Future World"),],
+      Band.new(Label.new("Noise"))
+    ) }
+
+    before { subject.validate.must_equal true }
+
+    it { subject.errors.messages.must_equal({}) }
+  end
+end

data/test/errors_test.rb

@@ -14,6 +14,14 @@ class ErrorsTest < MiniTest::Spec
       validates :title, :presence => true
     end
 
+    property :band do # yepp, people do crazy stuff like that.
+      property :label do
+        property :name
+        validates :name, :presence => true
+      end
+      # TODO: make band a required object.
+    end
+
     validates :title, :presence => true
   end
 
@@ -21,7 +29,9 @@ class ErrorsTest < MiniTest::Spec
     OpenStruct.new(
       :title  => "Blackhawks Over Los Angeles",
       :hit    => song,
-      :songs  => songs # TODO: document this requirement
+      :songs  => songs, # TODO: document this requirement,
+
+      :band => Struct.new(:name, :label).new("Epitaph", OpenStruct.new),
     )
   end
   let (:song)  { OpenStruct.new(:title => "Downtown") }
@@ -39,7 +49,9 @@ class ErrorsTest < MiniTest::Spec
       form.errors.messages.must_equal({
         :title  => ["can't be blank"],
         :"hit.title"=>["can't be blank"],
-        :"songs.title"=>["can't be blank"]})
+        :"songs.title"=>["can't be blank"],
+        :"band.label.name"=>["can't be blank"]
+      })
     end
 
     it do
@@ -55,36 +67,51 @@ class ErrorsTest < MiniTest::Spec
       form.errors.messages.must_equal({
         :title        => ["can't be blank"],
         :"hit.title"  => ["can't be blank"],
-        :"songs.title"=> ["can't be blank"]})
-    end # TODO: add another invalid item.
+        :"songs.title"=> ["can't be blank"],
+        :"band.label.name"=>["can't be blank"]
+      })
+    end
   end
 
+
   describe "#validate with main form invalid" do
-    before { @result = form.validate("title"=>"") }
+    before { @result = form.validate("title"=>"", "band"=>{"label"=>{:name => "Fat Wreck"}}) }
 
     it { @result.must_equal false }
     it { form.errors.messages.must_equal({:title=>["can't be blank"]}) }
   end
 
+
   describe "#validate with middle nested form invalid" do
-    before { @result = form.validate("hit"=>{"title" => ""}) }
+    before { @result = form.validate("hit"=>{"title" => ""}, "band"=>{"label"=>{:name => "Fat Wreck"}}) }
 
     it { @result.must_equal false }
     it { form.errors.messages.must_equal({:"hit.title"=>["can't be blank"]}) }
   end
 
-  describe "#validate with last nested form invalid" do
-    before { @result = form.validate("songs"=>[{"title" => ""}]) }
+
+  describe "#validate with collection form invalid" do
+    before { @result = form.validate("songs"=>[{"title" => ""}], "band"=>{"label"=>{:name => "Fat Wreck"}}) }
 
     it { @result.must_equal false }
-    it { form.errors.messages.must_equal({:"songs.title"=>["can't be blank"]}) }
+    it( "xxxx") { form.errors.messages.must_equal({:"songs.title"=>["can't be blank"]}) }
   end
 
+
+  describe "#validate with collection and 2-level-nested invalid" do
+    before { @result = form.validate("songs"=>[{"title" => ""}], "band" => {"label" => {}}) }
+
+    it { @result.must_equal false }
+    it { form.errors.messages.must_equal({:"songs.title"=>["can't be blank"], :"band.label.name"=>["can't be blank"]}) }
+  end
+
+
   describe "correct #validate" do
     before { @result = form.validate(
       "hit"   => {"title" => "Sacrifice"},
       "title" => "Second Heat",
-      "songs" => [{"title"=>"Heart Of A Lion"}]
+      "songs" => [{"title"=>"Heart Of A Lion"}],
+      "band"  => {"label"=>{:name => "Fat Wreck"}}
       ) }
 
     it { @result.must_equal true }