reform 1.2.0.beta2 → 1.2.1

data/test/benchmarking.rb

@@ -0,0 +1,26 @@
+require 'reform'
+require 'ostruct'
+require 'benchmark'
+
+class BandForm < Reform::Form
+  property :name, validates: {presence: true}
+
+  collection :songs do
+    property :title, validates: {presence: true}
+  end
+end
+
+songs = 50.times.collect { OpenStruct.new(title: "Be Stag") }
+band = OpenStruct.new(name: "Teenage Bottlerock", songs: songs)
+
+songs_params = 50.times.collect { {title: "Commando"} }
+
+time = Benchmark.measure do
+  100.times.each do
+    form = BandForm.new(band)
+    form.validate("name" => "Ramones", "songs" => songs_params)
+    form.save
+  end
+end
+
+puts time

data/test/contract_test.rb

@@ -54,4 +54,44 @@ class ContractTest < BaseTest
 
     it { subject.errors.messages.must_equal({}) }
   end
+
+
+  describe "::representer" do
+    # without name will always iterate.
+    it do
+      names = []
+      AlbumContract.representer { |dfn| names << dfn.name }
+      names.must_equal ["hit", "songs", "band"]
+
+      # this doesn't cache.
+      names = []
+      AlbumContract.representer { |dfn| names << dfn.name }
+      names.must_equal ["hit", "songs", "band"]
+    end
+
+    # with name caches representer per class and runs once.
+    it do
+      names = []
+      AlbumContract.representer(:sync) { |dfn| names << dfn.name }
+      names.must_equal ["hit", "songs", "band"]
+
+      # this does cache.
+      names = []
+      AlbumContract.representer(:sync) { |dfn| names << dfn.name }
+      names.must_equal []
+    end
+
+    # it allows iterating all properties, not only nested.
+    it do
+      names = []
+      AlbumContract.representer(:save, all: true) { |dfn| names << dfn.name }
+      names.must_equal ["title", "hit", "songs", "band"]
+
+      names = []
+      AlbumContract.representer(:save, all: true) { |dfn| names << dfn.name }
+      names.must_equal []
+    end
+
+    # test :superclass?
+  end
 end

data/test/custom_validation_test.rb

@@ -23,7 +23,7 @@ unless ActiveModel::VERSION::MAJOR == 3 and ActiveModel::VERSION::MINOR == 0
       extend ActiveModel::ModelValidations
 
       property :title
-      property :artist_name, as: :artist
+      property :artist_name, from: :artist
       copy_validations_from Album
     end
 

data/test/empty_test.rb

@@ -1,11 +1,39 @@
 require 'test_helper'
 
-class EmptyAttributesTest < MiniTest::Spec
+
+class DeprecatedVirtualTest < MiniTest::Spec # TODO: remove me in 2.0.
+  Location = Struct.new(:country)
+
+  class LocationForm < Reform::Form
+    property :country, virtual: true # this becomes readonly: true
+  end
+
+  let (:loc) { Location.new("Australia") }
+  let (:form) { LocationForm.new(loc) }
+
+  it { form.country.must_equal "Australia" }
+  it do
+    form.validate("country" => "Germany") # this usually won't change when submitting.
+    form.country.must_equal "Germany"
+
+    form.sync
+    loc.country.must_equal "Australia" # the writer wasn't called.
+
+    hash = {}
+    form.save do |nested|
+      hash = nested
+    end
+
+    hash.must_equal("country"=> "Germany")
+  end
+end
+
+class DeprecatedEmptyTest < MiniTest::Spec # don't read, don't write
   Credentials = Struct.new(:password)
 
   class PasswordForm < Reform::Form
     property :password
-    property :password_confirmation, :empty => true
+    property :password_confirmation, empty: true
   end
 
   let (:cred) { Credentials.new }
@@ -15,7 +43,7 @@ class EmptyAttributesTest < MiniTest::Spec
     form.validate("password" => "123", "password_confirmation" => "321")
 
     form.password.must_equal "123"
-    form.password_confirmation.must_equal "321"
+    form.password_confirmation.must_equal "321" # this is still readable in the UI.
 
     form.sync
     cred.password.must_equal "123"

data/test/form_composition_test.rb

@@ -9,7 +9,7 @@ class FormCompositionTest < MiniTest::Spec
     include Composition
 
     property  :name,          :on =>  :requester
-    property  :requester_id,  :on => :requester, :as => :id
+    property  :requester_id,  :on => :requester, :from => :id
     properties :title, :id, :on => :song
     # property  :channel # FIXME: what about the "main model"?
     property :channel, :empty => true, :on => :song

data/test/from_test.rb

@@ -0,0 +1,150 @@
+require 'test_helper'
+
+class AsTest < BaseTest
+  class AlbumForm < Reform::Form
+    property :name, from: :title
+
+    property :single, from: :hit do
+      property :title
+    end
+
+    collection :tracks, from: :songs do
+      property :name, from: :title
+    end
+
+    property :band do
+      property :company, from: :label do
+        property :business, from: :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 |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
+
+
+class AsREMOVEMEin20Test < BaseTest # TODO: remove me in 2.0.
+  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 |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/model_validations_test.rb

@@ -23,7 +23,7 @@ class ModelValidationsTest < MiniTest::Spec
     extend ActiveModel::ModelValidations
 
     property :title
-    property :artist_name, as: :artist
+    property :artist_name, from: :artist
     copy_validations_from Album
   end
 
@@ -34,7 +34,7 @@ class ModelValidationsTest < MiniTest::Spec
     model :album
 
     property :title, on: :album
-    property :artist_name, as: :artist, on: :album
+    property :artist_name, from: :artist, on: :album
     property :rating, on: :album_rating
 
     copy_validations_from album: Album, album_rating: AlbumRating

data/test/nested_form_test.rb

@@ -94,10 +94,10 @@ class NestedFormTest < MiniTest::Spec
     it "updates internal Fields" do
       data = {}
 
-      form.save do |f, nested_hash|
-        data[:title]        = f.title
-        data[:hit_title]    = f.hit.title
-        data[:first_title]  = f.songs.first.title
+      form.save do |nested_hash|
+        data[:title]        = form.title
+        data[:hit_title]    = form.hit.title
+        data[:first_title]  = form.songs.first.title
       end
 
       data.must_equal(:title=>"Second Heat", :hit_title => "Sacrifice", :first_title => "Scarified")

data/test/read_only_test.rb

@@ -1,28 +1,3 @@
 require 'test_helper'
 
-class ReadonlyAttributesTest < MiniTest::Spec
-  Location = Struct.new(:country)
 
-  class LocationForm < Reform::Form
-    property :country, virtual: true # read_only: true
-  end
-
-  let (:loc) { Location.new("Australia") }
-  let (:form) { LocationForm.new(loc) }
-
-  it { form.country.must_equal "Australia" }
-  it do
-    form.validate("country" => "Germany") # this usually won't change when submitting.
-    form.country.must_equal "Germany"
-
-    form.sync
-    loc.country.must_equal "Australia" # the writer wasn't called.
-
-    hash = {}
-    form.save do |nested|
-      hash = nested
-    end
-
-    hash.must_equal("country"=> "Germany")
-  end
-end

data/test/readable_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+class ReadableTest < MiniTest::Spec
+  Credentials = Struct.new(:password)
+
+  class PasswordForm < Reform::Form
+    reform_2_0!
+
+    property :password, readable: false
+  end
+
+  let (:cred) { Credentials.new }
+  let (:form) { PasswordForm.new(cred) }
+
+  it {
+    form.password.must_equal nil
+
+    form.validate("password" => "123")
+
+    form.password.must_equal "123"
+
+    form.sync
+    cred.password.must_equal "123"
+
+    hash = {}
+    form.save do |nested|
+      hash = nested
+    end
+
+    hash.must_equal("password"=> "123")
+  }
+end

data/test/reform_test.rb

@@ -143,27 +143,6 @@ class ReformTest < ReformSpec
     end
 
     describe "#save with block" do
-      it "Deprecated: provides data block argument" do # TODO: remove in 1.1.
-        hash = {}
-
-        form.save do |data, map|
-          hash[:name]   = data.name
-          hash[:title]  = data.title
-        end
-
-        hash.must_equal({:name=>"Diesel Boy", :title=>nil})
-      end
-
-      it "Deprecated: provides nested symbolized hash as second block argument" do # TODO: remove in 1.1.
-        hash = {}
-
-        form.save do |data, map|
-          hash = map
-        end
-
-        hash.must_equal({"name"=>"Diesel Boy"})
-      end
-
       it do
         hash = {}
 

data/test/virtual_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class VirtualTest < MiniTest::Spec
+  class CreditCardForm < Reform::Form
+    reform_2_0!
+
+    property :credit_card_number, virtual: true # no read, no write, it's virtual.
+  end
+
+  let (:form) { CreditCardForm.new(Object.new) }
+
+  it {
+    form.validate("credit_card_number" => "123")
+
+    form.credit_card_number.must_equal "123"
+
+    form.sync
+
+    hash = {}
+    form.save do |nested|
+      hash = nested
+    end
+
+    hash.must_equal("credit_card_number"=> "123")
+  }
+end