reform 2.3.0.rc1 → 2.3.0.rc2

data/test/parse_option_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require "test_helper"
 
 class ParseOptionTest < MiniTest::Spec
   Comment = Struct.new(:content, :user)
@@ -9,8 +9,8 @@ class ParseOptionTest < MiniTest::Spec
     property :user, parse: false
   end
 
-  let (:current_user) { User.new("Peter") }
-  let (:form) { CommentForm.new(Comment.new, user: current_user) }
+  let(:current_user) { User.new("Peter") }
+  let(:form) { CommentForm.new(Comment.new, user: current_user) }
 
   it do
     form.user.must_equal current_user
@@ -25,8 +25,8 @@ class ParseOptionTest < MiniTest::Spec
   describe "using ':parse' option doesn't override other ':deserialize' options" do
     class ArticleCommentForm < TestForm
       property :content
-      property :article, deserializer: { instance: "Instance" }
-      property :user, parse: false, deserializer: { instance: "Instance" }
+      property :article, deserializer: {instance: "Instance"}
+      property :user, parse: false, deserializer: {instance: "Instance"}
     end
 
     it do

data/test/parse_pipeline_test.rb

@@ -4,7 +4,7 @@ class ParsePipelineTest < MiniTest::Spec
   Album = Struct.new(:name)
 
   class AlbumForm < TestForm
-    property :name, deserializer: { parse_pipeline: ->(input, options) { Representable::Pipeline[->(ipt, opts) { opts[:represented].name = ipt.inspect }] } }
+    property :name, deserializer: {parse_pipeline: ->(input, options) { Representable::Pipeline[->(ipt, opts) { opts[:represented].name = ipt.inspect }] }}
   end
 
   it "allows passing :parse_pipeline directly" do
@@ -12,4 +12,4 @@ class ParsePipelineTest < MiniTest::Spec
     form.validate("name" => "Greatest Hits")
     form.name.must_equal "{\"name\"=>\"Greatest Hits\"}"
   end
-end
+end

data/test/populate_new_api.rb

@@ -0,0 +1,304 @@
+require "test_helper"
+
+class PopulatorTest < MiniTest::Spec
+  Song  = Struct.new(:title, :album, :composer)
+  Album = Struct.new(:name, :songs, :artist)
+  Artist = Struct.new(:name)
+
+  class AlbumForm < TestForm
+    property :name, populator: ->(options) { self.name = options[:fragment].reverse }
+    validation do
+      params { required(:name).filled }
+    end
+
+    collection :songs,
+               populator: ->(fragment:, model:, index:, **) {
+                 (item = model[index]) ? item : model.insert(index, Song.new)
+               } do
+      property :title
+      validation do
+        params { required(:title).filled }
+      end
+
+      property :composer, populator: ->(options) { options[:model] || self.composer = Artist.new } do
+        property :name
+        validation do
+          params { required(:name).filled }
+        end
+      end
+    end
+
+    # property :artist, populator: lambda { |fragment, options| (item = options.binding.get) ? item : Artist.new } do
+    # NOTE: we have to document that model here is the twin!
+    property :artist, populator: ->(options) { options[:model] || self.artist = Artist.new } do
+      property :name
+    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(:album)              { Album.new("The Dissent Of Man", [song, song_with_composer], artist) }
+
+  let(:form) { AlbumForm.new(album) }
+
+  it "runs populator on scalar" do
+    form.validate(
+      "name" => "override me!"
+    )
+
+    form.name.must_equal "!em edirrevo"
+  end
+
+  # changing existing property :artist.
+  # TODO: check with artist==nil
+  it do
+    old_id = artist.object_id
+
+    form.validate(
+      "artist" => {"name" => "Marcus Miller"}
+    )
+
+    form.artist.model.object_id.must_equal old_id
+  end
+
+  # use populator for default value on scalars?
+
+  # adding to collection via :populator.
+  # valid.
+  it "yyy" do
+    form.validate(
+      "songs"  => [{"title" => "Fallout"}, {"title" => "Roxanne"},
+        {"title" => "Rime Of The Ancient Mariner"}, # new song.
+        {"title" => "Re-Education", "composer" => {"name" => "Rise Against"}}], # new song with new composer.
+    ).must_equal true
+
+    form.errors.messages.inspect.must_equal "{}"
+
+    # form has updated.
+    form.name.must_equal "The Dissent Of Man"
+    form.songs[0].title.must_equal "Fallout"
+    form.songs[1].title.must_equal "Roxanne"
+    form.songs[1].composer.name.must_equal "Greg Graffin"
+
+    form.songs[1].composer.model.must_be_instance_of Artist
+
+    form.songs[1].title.must_equal "Roxanne"
+    form.songs[2].title.must_equal "Rime Of The Ancient Mariner" # new song added.
+    form.songs[3].title.must_equal "Re-Education"
+    form.songs[3].composer.name.must_equal "Rise Against"
+    form.songs.size.must_equal 4
+    form.artist.name.must_equal "Bad Religion"
+
+    # model has not changed, yet.
+    album.name.must_equal "The Dissent Of Man"
+    album.songs[0].title.must_equal "Broken"
+    album.songs[1].title.must_equal "Resist Stance"
+    album.songs[1].composer.name.must_equal "Greg Graffin"
+    album.songs.size.must_equal 2
+    album.artist.name.must_equal "Bad Religion"
+  end
+end
+
+class PopulateWithMethodTest < Minitest::Spec
+  Album = Struct.new(:title)
+
+  class AlbumForm < TestForm
+    property :title, populator: :title!
+
+    def title!(options)
+      self.title = options[:fragment].reverse
+    end
+  end
+
+  let(:form) { AlbumForm.new(Album.new) }
+
+  it "runs populator method" do
+    form.validate("title" => "override me!")
+
+    form.title.must_equal "!em edirrevo"
+  end
+end
+
+class PopulateWithCallableTest < Minitest::Spec
+  Album = Struct.new(:title)
+
+  class TitlePopulator
+    include Uber::Callable
+
+    def call(form, options)
+      form.title = options[:fragment].reverse
+    end
+  end
+
+  class AlbumForm < TestForm
+    property :title, populator: TitlePopulator.new
+  end
+
+  let(:form) { AlbumForm.new(Album.new) }
+
+  it "runs populator method" do
+    form.validate("title" => "override me!")
+
+    form.title.must_equal "!em edirrevo"
+  end
+end
+
+class PopulateWithProcTest < Minitest::Spec
+  Album = Struct.new(:title)
+
+  TitlePopulator = ->(options) do
+    options[:represented].title = options[:fragment].reverse
+  end
+
+  class AlbumForm < TestForm
+    property :title, populator: TitlePopulator
+  end
+
+  let(:form) { AlbumForm.new(Album.new) }
+
+  it "runs populator method" do
+    form.validate("title" => "override me!")
+
+    form.title.must_equal "!em edirrevo"
+  end
+end
+
+class PopulateIfEmptyTest < MiniTest::Spec
+  Song  = Struct.new(:title, :album, :composer)
+  Album = Struct.new(:name, :songs, :artist)
+  Artist = Struct.new(:name)
+
+  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(:album)              { Album.new("The Dissent Of Man", [song, song_with_composer], artist) }
+
+  class AlbumForm < TestForm
+    property :name
+
+    collection :songs,
+      populate_if_empty: Song do                                                # class name works.
+
+      property :title
+      validation do
+        params { required(:title).filled }
+      end
+
+      property :composer, populate_if_empty: :populate_composer! do # lambda works, too. in form context.
+        property :name
+        validation do
+          params { required(:name).filled }
+        end
+      end
+
+    private
+      def populate_composer!(options)
+        Artist.new
+      end
+    end
+
+    property :artist, populate_if_empty: ->(args) { create_artist(args[:fragment], args[:user_options]) } do # methods work, too.
+      property :name
+    end
+
+    private
+    class Sting < Artist
+      attr_accessor :args
+    end
+    def create_artist(input, user_options)
+      Sting.new.tap { |artist| artist.args = ([input, user_options].to_s) }
+    end
+  end
+
+  let(:form) { AlbumForm.new(album) }
+
+  it do
+    form.songs.size.must_equal 2
+
+    form.validate(
+      "songs" => [{"title" => "Fallout"}, {"title" => "Roxanne"},
+        {"title" => "Rime Of The Ancient Mariner"}, # new song.
+        {"title" => "Re-Education", "composer" => {"name" => "Rise Against"}}], # new song with new composer.
+    ).must_equal true
+
+    form.errors.messages.inspect.must_equal "{}"
+
+    # form has updated.
+    form.name.must_equal "The Dissent Of Man"
+    form.songs[0].title.must_equal "Fallout"
+    form.songs[1].title.must_equal "Roxanne"
+    form.songs[1].composer.name.must_equal "Greg Graffin"
+    form.songs[1].title.must_equal "Roxanne"
+    form.songs[2].title.must_equal "Rime Of The Ancient Mariner" # new song added.
+    form.songs[3].title.must_equal "Re-Education"
+    form.songs[3].composer.name.must_equal "Rise Against"
+    form.songs.size.must_equal 4
+    form.artist.name.must_equal "Bad Religion"
+
+    # model has not changed, yet.
+    album.name.must_equal "The Dissent Of Man"
+    album.songs[0].title.must_equal "Broken"
+    album.songs[1].title.must_equal "Resist Stance"
+    album.songs[1].composer.name.must_equal "Greg Graffin"
+    album.songs.size.must_equal 2
+    album.artist.name.must_equal "Bad Religion"
+  end
+
+  # trigger artist populator. lambda calling form instance method.
+  it "xxxx" do
+    form = AlbumForm.new(album = Album.new)
+    form.validate("artist" => {"name" => "From Autumn To Ashes"})
+
+    form.artist.name.must_equal "From Autumn To Ashes"
+    # test lambda was executed in form context.
+    form.artist.model.must_be_instance_of AlbumForm::Sting
+    # test lambda block arguments.
+    form.artist.model.args.to_s.must_equal "[{\"name\"=>\"From Autumn To Ashes\"}, nil]"
+
+    assert_nil album.artist
+  end
+end
+
+# delete songs while deserializing.
+class PopulateIfEmptyWithDeletionTest < MiniTest::Spec
+  Song  = Struct.new(:title, :album, :composer)
+  Album = Struct.new(:name, :songs, :artist)
+
+  let(:song)  { Song.new("Broken") }
+  let(:song2) { Song.new("Resist Stance") }
+  let(:album) { Album.new("The Dissent Of Man", [song, song2]) }
+
+  class AlbumForm < TestForm
+    property :name
+
+    collection :songs,
+      populate_if_empty: Song, skip_if: :delete_song! do
+
+      property :title
+      validation do
+        params { required(:title).filled }
+      end
+    end
+
+    def delete_song!(options)
+      songs.delete(songs[0]) and return true if options[:fragment]["title"] == "Broken, delete me!"
+      false
+    end
+  end
+
+  let(:form) { AlbumForm.new(album) }
+
+  it do
+    form.validate(
+      "songs" => [{"title" => "Broken, delete me!"}, {"title" => "Roxanne"}]
+    ).must_equal true
+
+    form.errors.messages.inspect.must_equal "{}"
+
+    form.songs.size.must_equal 1
+    form.songs[0].title.must_equal "Roxanne"
+  end
+end

data/test/{populate_test.rb → populate_old_api.rb}

@@ -12,15 +12,15 @@ class PopulatorTest < MiniTest::Spec
     end
 
     collection :songs,
-      populator: ->(fragment:, model:, index:, **) {
-        (item = model[index]) ? item : model.insert(index, Song.new) } do
-
+               populator: ->(fragment:, model:, index:, **) {
+                 (item = model[index]) ? item : model.insert(index, Song.new)
+               } do
       property :title
       validation do
         required(:title).filled
       end
 
-      property :composer, populator: ->(options) { options[:model] || self.composer= Artist.new } do
+      property :composer, populator: ->(options) { options[:model] || self.composer = Artist.new } do
         property :name
         validation do
           required(:name).filled
@@ -35,13 +35,13 @@ class PopulatorTest < 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 (:album)              { Album.new("The Dissent Of Man", [song, song_with_composer], artist) }
+  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(:album)              { Album.new("The Dissent Of Man", [song, song_with_composer], artist) }
 
-  let (:form) { AlbumForm.new(album) }
+  let(:form) { AlbumForm.new(album) }
 
   it "runs populator on scalar" do
     form.validate(
@@ -91,7 +91,6 @@ class PopulatorTest < MiniTest::Spec
     form.songs.size.must_equal 4
     form.artist.name.must_equal "Bad Religion"
 
-
     # model has not changed, yet.
     album.name.must_equal "The Dissent Of Man"
     album.songs[0].title.must_equal "Broken"
@@ -113,7 +112,7 @@ class PopulateWithMethodTest < Minitest::Spec
     end
   end
 
-  let (:form) { AlbumForm.new(Album.new) }
+  let(:form) { AlbumForm.new(Album.new) }
 
   it "runs populator method" do
     form.validate("title" => "override me!")
@@ -137,7 +136,7 @@ class PopulateWithCallableTest < Minitest::Spec
     property :title, populator: TitlePopulator.new
   end
 
-  let (:form) { AlbumForm.new(Album.new) }
+  let(:form) { AlbumForm.new(Album.new) }
 
   it "runs populator method" do
     form.validate("title" => "override me!")
@@ -157,7 +156,7 @@ class PopulateWithProcTest < Minitest::Spec
     property :title, populator: TitlePopulator
   end
 
-  let (:form) { AlbumForm.new(Album.new) }
+  let(:form) { AlbumForm.new(Album.new) }
 
   it "runs populator method" do
     form.validate("title" => "override me!")
@@ -171,13 +170,11 @@ class PopulateIfEmptyTest < MiniTest::Spec
   Album = Struct.new(:name, :songs, :artist)
   Artist = Struct.new(:name)
 
-  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 (:album)              { Album.new("The Dissent Of Man", [song, song_with_composer], artist) }
-
-
+  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(:album)              { Album.new("The Dissent Of Man", [song, song_with_composer], artist) }
 
   class AlbumForm < TestForm
     property :name
@@ -203,26 +200,26 @@ class PopulateIfEmptyTest < MiniTest::Spec
       end
     end
 
-    property :artist, populate_if_empty: lambda { |args| create_artist(args[:fragment], args[:user_options]) } do # methods work, too.
+    property :artist, populate_if_empty: ->(args) { create_artist(args[:fragment], args[:user_options]) } do # methods work, too.
       property :name
     end
 
-  private
+    private
     class Sting < Artist
       attr_accessor :args
     end
     def create_artist(input, user_options)
-      Sting.new.tap { |artist| artist.args=([input, user_options].to_s) }
+      Sting.new.tap { |artist| artist.args = ([input, user_options].to_s) }
     end
   end
 
-  let (:form) { AlbumForm.new(album) }
+  let(:form) { AlbumForm.new(album) }
 
   it do
     form.songs.size.must_equal 2
 
     form.validate(
-      "songs"  => [{"title" => "Fallout"}, {"title" => "Roxanne"},
+      "songs" => [{"title" => "Fallout"}, {"title" => "Roxanne"},
         {"title" => "Rime Of The Ancient Mariner"}, # new song.
         {"title" => "Re-Education", "composer" => {"name" => "Rise Against"}}], # new song with new composer.
     ).must_equal true
@@ -241,7 +238,6 @@ class PopulateIfEmptyTest < MiniTest::Spec
     form.songs.size.must_equal 4
     form.artist.name.must_equal "Bad Religion"
 
-
     # model has not changed, yet.
     album.name.must_equal "The Dissent Of Man"
     album.songs[0].title.must_equal "Broken"
@@ -266,16 +262,14 @@ class PopulateIfEmptyTest < MiniTest::Spec
   end
 end
 
-
 # delete songs while deserializing.
 class PopulateIfEmptyWithDeletionTest < MiniTest::Spec
   Song  = Struct.new(:title, :album, :composer)
   Album = Struct.new(:name, :songs, :artist)
 
-  let (:song)  { Song.new("Broken") }
-  let (:song2) { Song.new("Resist Stance") }
-  let (:album) { Album.new("The Dissent Of Man", [song, song2]) }
-
+  let(:song)  { Song.new("Broken") }
+  let(:song2) { Song.new("Resist Stance") }
+  let(:album) { Album.new("The Dissent Of Man", [song, song2]) }
 
   class AlbumForm < TestForm
     property :name
@@ -295,11 +289,11 @@ class PopulateIfEmptyWithDeletionTest < MiniTest::Spec
     end
   end
 
-  let (:form) { AlbumForm.new(album) }
+  let(:form) { AlbumForm.new(album) }
 
   it do
     form.validate(
-      "songs"  => [{"title" => "Broken, delete me!"}, {"title" => "Roxanne"}]
+      "songs" => [{"title" => "Broken, delete me!"}, {"title" => "Roxanne"}]
     ).must_equal true
 
     form.errors.messages.inspect.must_equal "{}"