reform 2.2.4 → 2.3.3

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_old_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
+      required(:name).filled
+    end
+
+    collection :songs do
+      property :title
+      validation do
+        required(:title).filled
+      end
+
+      property :composer do
+        property :name
+        validation do
+          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/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,29 +20,29 @@ 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
-      form.songs[1].title.must_equal "Resist Stance"
-      form.songs[1].composer.name.must_equal "Greg Graffin"
-      form.artist.name.must_equal "Bad Religion"
+      _(form.name).must_equal "The Dissent Of Man"
+      _(form.songs[0].title).must_equal "Broken"
+      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"
 
       # make sure all is wrapped in forms.
-      form.songs[0].must_be_kind_of Reform::Form
-      form.songs[1].must_be_kind_of Reform::Form
-      form.songs[1].composer.must_be_kind_of Reform::Form
-      form.artist.must_be_kind_of Reform::Form
+      _(form.songs[0]).must_be_kind_of Reform::Form
+      _(form.songs[1]).must_be_kind_of Reform::Form
+      _(form.songs[1].composer).must_be_kind_of Reform::Form
+      _(form.artist).must_be_kind_of Reform::Form
     end
   end
-end
+end

data/test/skip_if_new_api.rb

@@ -0,0 +1,85 @@
+require "test_helper"
+
+class SkipIfTest < BaseTest
+  let(:hit) { Song.new }
+  let(:album) { Album.new(nil, hit, [], nil) }
+
+  class AlbumForm < TestForm
+    property :title
+
+    property :hit, skip_if: ->(options) { options[:fragment]["title"] == "" } do
+      property :title
+      validation do
+        params { required(:title).filled }
+      end
+    end
+
+    collection :songs, skip_if: :skip_song?, populate_if_empty: BaseTest::Song do
+      property :title
+    end
+
+    def skip_song?(options)
+      options[:fragment]["title"].nil?
+    end
+  end
+
+  # deserializes when present.
+  it do
+    form = AlbumForm.new(album)
+    _(form.validate("hit" => {"title" => "Altar Of Sacrifice"})).must_equal true
+    _(form.hit.title).must_equal "Altar Of Sacrifice"
+  end
+
+  # skips deserialization when not present.
+  it do
+    form = AlbumForm.new(Album.new)
+    _(form.validate("hit" => {"title" => ""})).must_equal true
+    assert_nil form.hit # hit hasn't been deserialised.
+  end
+
+  # skips deserialization when not present.
+  it do
+    form = AlbumForm.new(Album.new(nil, nil, []))
+    _(form.validate("songs" => [{"title" => "Waste Of Breath"}, {"title" => nil}])).must_equal true
+    _(form.songs.size).must_equal 1
+    _(form.songs[0].title).must_equal "Waste Of Breath"
+  end
+end
+
+class SkipIfAllBlankTest < BaseTest
+  # skip_if: :all_blank"
+  class AlbumForm < TestForm
+    collection :songs, skip_if: :all_blank, populate_if_empty: BaseTest::Song do
+      property :title
+      property :length
+    end
+  end
+
+  # create only one object.
+  it do
+    form = AlbumForm.new(OpenStruct.new(songs: []))
+    _(form.validate("songs" => [{"title" => "Apathy"}, {"title" => "", "length" => ""}])).must_equal true
+    _(form.songs.size).must_equal 1
+    _(form.songs[0].title).must_equal "Apathy"
+  end
+
+  it do
+    form = AlbumForm.new(OpenStruct.new(songs: []))
+    _(form.validate("songs" => [{"title" => "", "length" => ""}, {"title" => "Apathy"}])).must_equal true
+    _(form.songs.size).must_equal 1
+    _(form.songs[0].title).must_equal "Apathy"
+  end
+end
+
+class InvalidOptionsCombinationTest < BaseTest
+  it do
+    assert_raises(Reform::Form::InvalidOptionsCombinationError) do
+      class AlbumForm < TestForm
+        collection :songs, skip_if: :all_blank, populator: -> {} do
+          property :title
+          property :length
+        end
+      end
+    end
+  end
+end

data/test/skip_if_old_api.rb

@@ -0,0 +1,92 @@
+require "test_helper"
+
+class SkipIfTest < BaseTest
+  let(:hit) { Song.new }
+  let(:album) { Album.new(nil, hit, [], nil) }
+
+  class AlbumForm < TestForm
+    property :title
+
+    property :hit, skip_if: ->(options) { options[:fragment]["title"] == "" } do
+      property :title
+      validation do
+        required(:title).filled
+      end
+    end
+
+    collection :songs, skip_if: :skip_song?, populate_if_empty: BaseTest::Song do
+      property :title
+    end
+
+    def skip_song?(options)
+      options[:fragment]["title"].nil?
+    end
+  end
+
+  # deserializes when present.
+  it do
+    form = AlbumForm.new(album)
+    _(form.validate("hit" => {"title" => "Altar Of Sacrifice"})).must_equal true
+    _(form.hit.title).must_equal "Altar Of Sacrifice"
+  end
+
+  # skips deserialization when not present.
+  it do
+    form = AlbumForm.new(Album.new)
+    _(form.validate("hit" => {"title" => ""})).must_equal true
+    assert_nil form.hit # hit hasn't been deserialised.
+  end
+
+  # skips deserialization when not present.
+  it do
+    form = AlbumForm.new(Album.new(nil, nil, []))
+    _(form.validate("songs" => [{"title" => "Waste Of Breath"}, {"title" => nil}])).must_equal true
+    _(form.songs.size).must_equal 1
+    _(form.songs[0].title).must_equal "Waste Of Breath"
+  end
+end
+
+class SkipIfAllBlankTest < BaseTest
+  # skip_if: :all_blank"
+  class AlbumForm < TestForm
+    collection :songs, skip_if: :all_blank, populate_if_empty: BaseTest::Song do
+      property :title
+      property :length
+    end
+  end
+
+  # create only one object.
+  it do
+    form = AlbumForm.new(OpenStruct.new(songs: []))
+    _(form.validate("songs" => [{"title" => "Apathy"}, {"title" => "", "length" => ""}])).must_equal true
+    _(form.songs.size).must_equal 1
+    _(form.songs[0].title).must_equal "Apathy"
+  end
+
+  it do
+    form = AlbumForm.new(OpenStruct.new(songs: []))
+    _(form.validate("songs" => [{"title" => "", "length" => ""}, {"title" => "Apathy"}])).must_equal true
+    _(form.songs.size).must_equal 1
+    _(form.songs[0].title).must_equal "Apathy"
+  end
+
+  it do
+    form = AlbumForm.new(OpenStruct.new(songs: []))
+    _(form.validate(:songs => [{:title=>"", :length => ""}, {:title=>"Apathy"}])).must_equal true
+    _(form.songs.size).must_equal 1
+    _(form.songs[0].title).must_equal "Apathy"
+  end
+end
+
+class InvalidOptionsCombinationTest < BaseTest
+  it do
+    assert_raises(Reform::Form::InvalidOptionsCombinationError) do
+      class AlbumForm < TestForm
+        collection :songs, skip_if: :all_blank, populator: -> {} do
+          property :title
+          property :length
+        end
+      end
+    end
+  end
+end

data/test/skip_setter_and_getter_test.rb

@@ -7,7 +7,7 @@ class SetupSkipSetterAndGetterTest < MiniTest::Spec
   Album = Struct.new(:title, :artist)
   Artist = Struct.new(:name)
 
-  class AlbumForm < Reform::Form
+  class AlbumForm < TestForm
     property :title
 
     def title
@@ -31,24 +31,23 @@ class SetupSkipSetterAndGetterTest < MiniTest::Spec
     end
   end
 
-  let (:artist) { Artist.new("Bad Religion") }
-
+  let(:artist) { Artist.new("Bad Religion") }
 
   it do
     album = Album.new("Greatest Hits", artist)
     form  = AlbumForm.new(album)
 
-    form.title.must_equal "GREATEST HITS"
-    form.artist.name.must_equal "bad religion"
+    _(form.title).must_equal "GREATEST HITS"
+    _(form.artist.name).must_equal "bad religion"
 
     form.validate("title" => "Resiststance", "artist" => {"name" => "Greg Graffin"})
 
-    form.title.must_equal "ECNATSTSISER" # first, setter called, then getter.
-    form.artist.name.must_equal "greg graffi"
+    _(form.title).must_equal "ECNATSTSISER" # first, setter called, then getter.
+    _(form.artist.name).must_equal "greg graffi"
 
     form.sync
 
-    album.title.must_equal "ecnatstsiseR" # setter called, but not getter.
-    album.artist.name.must_equal "Greg Graffi"
+    _(album.title).must_equal "ecnatstsiseR" # setter called, but not getter.
+    _(album.artist.name).must_equal "Greg Graffi"
   end
-end
+end