reform 2.2.4 → 2.3.1

data/test/{reform_test.rb → reform_old_api.rb}

@@ -1,34 +1,33 @@
-require 'test_helper'
+require "test_helper"
 
-# TODO: this test should be removed.
 class ReformTest < Minitest::Spec
-  let (:comp) { OpenStruct.new(:name => "Duran Duran", :title => "Rio") }
+  let(:comp) { OpenStruct.new(name: "Duran Duran", title: "Rio") }
 
-  let (:form) { SongForm.new(comp) }
+  let(:form) { SongForm.new(comp) }
 
-  class SongForm < Reform::Form
+  class SongForm < TestForm
     property :name
     property :title
 
     validation do
-      key(:name).required
+      required(:name).filled
     end
   end
 
   describe "(new) form with empty models" do
-    let (:comp) { OpenStruct.new }
+    let(:comp) { OpenStruct.new }
 
     it "returns empty fields" do
-      form.title.must_equal nil
-      form.name.must_equal  nil
+      assert_nil form.title
+      form.name.must_be_nil
     end
 
     describe "and submitted values" do
       it "returns filled-out fields" do
         form.validate("name" => "Duran Duran")
 
-        form.title.must_equal nil
-        form.name.must_equal  "Duran Duran"
+        assert_nil form.title
+        form.name.must_equal "Duran Duran"
       end
     end
   end
@@ -41,7 +40,7 @@ class ReformTest < Minitest::Spec
   end
 
   describe "#validate" do
-    let (:comp) { OpenStruct.new }
+    let(:comp) { OpenStruct.new }
 
     it "ignores unmapped fields in input" do
       form.validate("name" => "Duran Duran", :genre => "80s")
@@ -63,21 +62,21 @@ class ReformTest < Minitest::Spec
     it "doesn't change model properties" do
       form.validate("name" => "Duran Duran")
 
-      comp.name.must_equal nil # don't touch model, yet.
+      assert_nil comp.name # don't touch model, yet.
     end
 
     # TODO: test errors. test valid.
     describe "invalid input" do
-      class ValidatingForm < Reform::Form
+      class ValidatingForm < TestForm
         property :name
         property :title
 
         validation do
-          key(:name).required
-          key(:title).required
+          required(:name).filled
+          required(:title).filled
         end
       end
-      let (:form) { ValidatingForm.new(comp) }
+      let(:form) { ValidatingForm.new(comp) }
 
       it "returns false when invalid" do
         form.validate({}).must_equal false
@@ -85,29 +84,14 @@ class ReformTest < Minitest::Spec
 
       it "populates errors" do
         form.validate({})
-        form.errors.messages.must_equal({:name=>["is missing"], :title=>["is missing"]})
+        form.errors.messages.must_equal({name: ["must be filled"], title: ["must be filled"]})
       end
     end
   end
 
-  # FIXME: add this test to reform-rails.
-  describe "#errors" do
-    before { form.validate({})}
-
-    it { form.errors.must_be_kind_of Reform::Contract::Errors }
-
-    it { form.errors.messages.must_equal({}) }
-
-    it do
-      form.validate({"name"=>""})
-      form.errors.messages.must_equal({:name=>["must be filled"]})
-    end
-  end
-
-
   describe "#save" do
-    let (:comp) { OpenStruct.new }
-    let (:form) { SongForm.new(comp) }
+    let(:comp) { OpenStruct.new }
+    let(:form) { SongForm.new(comp) }
 
     before { form.validate("name" => "Diesel Boy") }
 
@@ -115,7 +99,7 @@ class ReformTest < Minitest::Spec
       form.save
 
       comp.name.must_equal "Diesel Boy"
-      comp.title.must_equal nil
+      assert_nil comp.title
     end
 
     describe "#save with block" do
@@ -126,42 +110,39 @@ class ReformTest < Minitest::Spec
           hash = map
         end
 
-        hash.must_equal({"name"=>"Diesel Boy"})
+        hash.must_equal({"name" => "Diesel Boy", "title" => nil})
       end
     end
   end
 
-
   describe "#model" do
     it { form.model.must_equal comp }
   end
 
-
   describe "inheritance" do
     class HitForm < SongForm
       property :position
       validation do
-        key(:position).required
+        required(:position).filled
       end
     end
 
-    let (:form) { HitForm.new(OpenStruct.new()) }
+    let(:form) { HitForm.new(OpenStruct.new()) }
     it do
       form.validate({"title" => "The Body"})
       form.title.must_equal "The Body"
-      form.position.must_equal nil
-      form.errors.messages.must_equal({:name=>["is missing"], :position=>["is missing"]})
+      assert_nil form.position
+      form.errors.messages.must_equal({name: ["must be filled"], position: ["must be filled"]})
     end
   end
 end
 
-
 class OverridingAccessorsTest < BaseTest
-  class SongForm < Reform::Form
+  class SongForm < TestForm
     property :title
 
     def title=(v) # used in #validate.
-      super v*2
+      super v * 2
     end
 
     def title # used in #sync.
@@ -169,13 +150,12 @@ class OverridingAccessorsTest < BaseTest
     end
   end
 
-  let (:song) { Song.new("Pray") }
+  let(:song) { Song.new("Pray") }
   subject { SongForm.new(song) }
 
   # override reader for presentation.
   it { subject.title.must_equal "pray" }
 
-
   describe "#save" do
     before { subject.validate("title" => "Hey Little World") }
 
@@ -198,9 +178,8 @@ class OverridingAccessorsTest < BaseTest
   end
 end
 
-
 class MethodInFormTest < MiniTest::Spec
-  class AlbumForm < Reform::Form
+  class AlbumForm < TestForm
     property :title
 
     def title
@@ -217,7 +196,7 @@ class MethodInFormTest < MiniTest::Spec
   end
 
   # methods can be used instead of created accessors.
-  subject { AlbumForm.new(OpenStruct.new(:hit => OpenStruct.new)) }
+  subject { AlbumForm.new(OpenStruct.new(hit: OpenStruct.new)) }
   it { subject.title.must_equal "The Suffer And The Witness" }
   it { subject.hit.title.must_equal "Drones" }
 end

data/test/save_new_api.rb

@@ -0,0 +1,101 @@
+require "test_helper"
+
+class SaveTest < BaseTest
+  Song  = Struct.new(:title, :album, :composer)
+  Album = Struct.new(:name, :songs, :artist)
+  Artist = Struct.new(:name)
+
+  class AlbumForm < TestForm
+    property :name
+    validation do
+      params { required(:name).filled }
+    end
+
+    collection :songs do
+      property :title
+      validation do
+        params { required(:title).filled }
+      end
+
+      property :composer do
+        property :name
+        validation do
+          params { required(:name).filled }
+        end
+      end
+    end
+
+    property :artist, save: false do
+      property :name
+    end
+  end
+
+  module Saveable
+    def save
+      @saved = true
+    end
+
+    def saved?
+      defined?(@saved) && @saved
+    end
+  end
+
+  let(:song)               { Song.new("Broken").extend(Saveable) }
+  # let(:song_with_composer) { Song.new("Resist Stance", nil, composer).extend(Saveable) }
+  let(:composer)           { Artist.new("Greg Graffin").extend(Saveable) }
+  let(:artist)             { Artist.new("Bad Religion").extend(Saveable).extend(Saveable) }
+  let(:album)              { Album.new("The Dissent Of Man", [song], artist).extend(Saveable) }
+
+  let(:form) { AlbumForm.new(album) }
+
+  it do
+    form.validate("songs" => [{"title" => "Fixed"}])
+
+    form.save
+
+    album.saved?.must_equal true
+    album.songs[0].title.must_equal "Fixed"
+    album.songs[0].saved?.must_equal true
+    assert_nil album.artist.saved?
+  end
+
+  describe "#sync with block" do
+    it do
+      form = AlbumForm.new(Album.new("Greatest Hits"))
+
+      form.validate(name: nil) # nil-out the title.
+
+      nested_hash = nil
+      form.sync do |hash|
+        nested_hash = hash
+      end
+
+      nested_hash.must_equal({"name" => nil, "artist" => nil})
+    end
+  end
+end
+
+# class SaveWithDynamicOptionsTest < MiniTest::Spec
+#   Song = Struct.new(:id, :title, :length) do
+#     include Saveable
+#   end
+
+#   class SongForm < TestForm
+#     property :title#, save: false
+#     property :length, virtual: true
+#   end
+
+#   let(:song) { Song.new }
+#   let(:form) { SongForm.new(song) }
+
+#   # we have access to original input value and outside parameters.
+#   it "xxx" do
+#     form.validate("title" => "A Poor Man's Memory", "length" => 10)
+#     length_seconds = 120
+#     form.save(length: lambda { |value, options| form.model.id = "#{value}: #{length_seconds}" })
+
+#     song.title.must_equal "A Poor Man's Memory"
+#     assert_nil song.length
+#     song.id.must_equal "10: 120"
+#   end
+# end

data/test/{save_test.rb → save_old_api.rb}

@@ -1,26 +1,26 @@
-require 'test_helper'
+require "test_helper"
 
 class SaveTest < BaseTest
   Song  = Struct.new(:title, :album, :composer)
   Album = Struct.new(:name, :songs, :artist)
   Artist = Struct.new(:name)
 
-  class AlbumForm < Reform::Form
+  class AlbumForm < TestForm
     property :name
     validation do
-      key(:name).required
+      required(:name).filled
     end
 
     collection :songs do
       property :title
       validation do
-        key(:title).required
+        required(:title).filled
       end
 
       property :composer do
         property :name
         validation do
-          key(:name).required
+          required(:name).filled
         end
       end
     end
@@ -36,19 +36,17 @@ class SaveTest < BaseTest
     end
 
     def saved?
-      @saved
+      defined?(@saved) && @saved
     end
   end
 
+  let(:song)               { Song.new("Broken").extend(Saveable) }
+  # let(:song_with_composer) { Song.new("Resist Stance", nil, composer).extend(Saveable) }
+  let(:composer)           { Artist.new("Greg Graffin").extend(Saveable) }
+  let(:artist)             { Artist.new("Bad Religion").extend(Saveable).extend(Saveable) }
+  let(:album)              { Album.new("The Dissent Of Man", [song], artist).extend(Saveable) }
 
-  let (:song)               { Song.new("Broken").extend(Saveable) }
-  # let (:song_with_composer) { Song.new("Resist Stance", nil, composer).extend(Saveable) }
-  let (:composer)           { Artist.new("Greg Graffin").extend(Saveable) }
-  let (:artist)             { Artist.new("Bad Religion").extend(Saveable).extend(Saveable) }
-  let (:album)              { Album.new("The Dissent Of Man", [song], artist).extend(Saveable) }
-
-  let (:form) { AlbumForm.new(album) }
-
+  let(:form) { AlbumForm.new(album) }
 
   it do
     form.validate("songs" => [{"title" => "Fixed"}])
@@ -58,23 +56,37 @@ class SaveTest < BaseTest
     album.saved?.must_equal true
     album.songs[0].title.must_equal "Fixed"
     album.songs[0].saved?.must_equal true
-    album.artist.saved?.must_equal nil
+    assert_nil album.artist.saved?
   end
-end
 
+  describe "#sync with block" do
+    it do
+      form = AlbumForm.new(Album.new("Greatest Hits"))
+
+      form.validate(name: nil) # nil-out the title.
+
+      nested_hash = nil
+      form.sync do |hash|
+        nested_hash = hash
+      end
+
+      nested_hash.must_equal({"name" => nil, "artist" => nil})
+    end
+  end
+end
 
 # class SaveWithDynamicOptionsTest < MiniTest::Spec
 #   Song = Struct.new(:id, :title, :length) do
 #     include Saveable
 #   end
 
-#   class SongForm < Reform::Form
+#   class SongForm < TestForm
 #     property :title#, save: false
 #     property :length, virtual: true
 #   end
 
-#   let (:song) { Song.new }
-#   let (:form) { SongForm.new(song) }
+#   let(:song) { Song.new }
+#   let(:form) { SongForm.new(song) }
 
 #   # we have access to original input value and outside parameters.
 #   it "xxx" do
@@ -83,7 +95,7 @@ end
 #     form.save(length: lambda { |value, options| form.model.id = "#{value}: #{length_seconds}" })
 
 #     song.title.must_equal "A Poor Man's Memory"
-#     song.length.must_equal nil
+#     assert_nil song.length
 #     song.id.must_equal "10: 120"
 #   end
 # end

data/test/setup_test.rb

@@ -5,7 +5,7 @@ class SetupTest < MiniTest::Spec
   Album = Struct.new(:name, :songs, :artist)
   Artist = Struct.new(:name)
 
-  class AlbumForm < Reform::Form
+  class AlbumForm < TestForm
     property :name
     collection :songs do
       property :title
@@ -20,20 +20,20 @@ class SetupTest < MiniTest::Spec
     end
   end
 
-  let (:song)               { Song.new("Broken") }
-  let (:song_with_composer) { Song.new("Resist Stance", nil, composer) }
-  let (:composer)           { Artist.new("Greg Graffin") }
-  let (:artist)             { Artist.new("Bad Religion") }
+  let(:song)               { Song.new("Broken") }
+  let(:song_with_composer) { Song.new("Resist Stance", nil, composer) }
+  let(:composer)           { Artist.new("Greg Graffin") }
+  let(:artist)             { Artist.new("Bad Religion") }
 
   describe "with nested objects" do
-    let (:album) { Album.new("The Dissent Of Man", [song, song_with_composer], artist) }
+    let(:album) { Album.new("The Dissent Of Man", [song, song_with_composer], artist) }
 
     it do
       form = AlbumForm.new(album)
 
       form.name.must_equal "The Dissent Of Man"
       form.songs[0].title.must_equal "Broken"
-      form.songs[0].composer.must_equal nil
+      assert_nil form.songs[0].composer
       form.songs[1].title.must_equal "Resist Stance"
       form.songs[1].composer.name.must_equal "Greg Graffin"
       form.artist.name.must_equal "Bad Religion"
@@ -45,4 +45,4 @@ class SetupTest < MiniTest::Spec
       form.artist.must_be_kind_of Reform::Form
     end
   end
-end
+end