reform 2.2.4 → 2.3.3

data/test/form_new_api.rb

@@ -0,0 +1,57 @@
+require "test_helper"
+
+class FormTest < MiniTest::Spec
+  Artist = Struct.new(:name)
+
+  class AlbumForm < TestForm
+    property :title
+
+    property :hit do
+      property :title
+    end
+
+    collection :songs do
+      property :title
+    end
+
+    property :band do # yepp, people do crazy stuff like that.
+      property :label do
+        property :name
+      end
+    end
+  end
+
+  describe "::dup" do
+    let(:cloned) { AlbumForm.clone }
+
+    # #dup is called in Op.inheritable_attr(:contract_class), it must be subclass of the original one.
+    it { _(cloned).wont_equal AlbumForm }
+    it { _(AlbumForm.definitions).wont_equal cloned.definitions }
+
+    it do
+      # currently, forms need a name for validation, even without AM.
+      cloned.singleton_class.class_eval do
+        def name
+          "Album"
+        end
+      end
+
+      cloned.validation do
+        params { required(:title).filled }
+      end
+
+      cloned.new(OpenStruct.new).validate({})
+    end
+  end
+
+  describe "#initialize" do
+    class ArtistForm < TestForm
+      property :name
+      property :current_user, virtual: true
+    end
+
+    it "allows injecting :virtual options" do
+      _(ArtistForm.new(Artist.new, current_user: Object).current_user).must_equal Object
+    end
+  end
+end

data/test/{form_test.rb → form_old_api.rb}

@@ -1,9 +1,9 @@
-require 'test_helper'
+require "test_helper"
 
 class FormTest < MiniTest::Spec
   Artist = Struct.new(:name)
 
-  class AlbumForm < Reform::Form
+  class AlbumForm < TestForm
     property :title
 
     property :hit do
@@ -22,11 +22,11 @@ class FormTest < MiniTest::Spec
   end
 
   describe "::dup" do
-    let (:cloned) { AlbumForm.clone }
+    let(:cloned) { AlbumForm.clone }
 
     # #dup is called in Op.inheritable_attr(:contract_class), it must be subclass of the original one.
-    it { cloned.wont_equal AlbumForm }
-    it { AlbumForm.definitions.wont_equal cloned.definitions }
+    it { _(cloned).wont_equal AlbumForm }
+    it { _(AlbumForm.definitions).wont_equal cloned.definitions }
 
     it do
       # currently, forms need a name for validation, even without AM.
@@ -37,7 +37,7 @@ class FormTest < MiniTest::Spec
       end
 
       cloned.validation do
-        key(:title).required
+        required(:title).filled
       end
 
       cloned.new(OpenStruct.new).validate({})
@@ -45,13 +45,13 @@ class FormTest < MiniTest::Spec
   end
 
   describe "#initialize" do
-    class ArtistForm < Reform::Form
+    class ArtistForm < TestForm
       property :name
       property :current_user, virtual: true
     end
 
     it "allows injecting :virtual options" do
-      ArtistForm.new(Artist.new, current_user: Object).current_user.must_equal Object
+      _(ArtistForm.new(Artist.new, current_user: Object).current_user).must_equal Object
     end
   end
 end

data/test/form_option_new_api.rb

@@ -0,0 +1,24 @@
+require "test_helper"
+
+class FormOptionTest < MiniTest::Spec
+  Song  = Struct.new(:title)
+  Album = Struct.new(:song)
+
+  class SongForm < TestForm
+    property :title
+    validation do
+      params { required(:title).filled }
+    end
+  end
+
+  class AlbumForm < TestForm
+    property :song, form: SongForm
+  end
+
+  it do
+    form = AlbumForm.new(Album.new(Song.new("When It Comes To You")))
+    _(form.song.title).must_equal "When It Comes To You"
+
+    form.validate(song: {title: "Run For Cover"})
+  end
+end

data/test/{form_option_test.rb → form_option_old_api.rb}

@@ -1,23 +1,23 @@
-require 'test_helper'
+require "test_helper"
 
 class FormOptionTest < MiniTest::Spec
   Song  = Struct.new(:title)
   Album = Struct.new(:song)
 
-  class SongForm < Reform::Form
+  class SongForm < TestForm
     property :title
     validation do
-      key(:title).required
+      required(:title).filled
     end
   end
 
-  class AlbumForm < Reform::Form
+  class AlbumForm < TestForm
     property :song, form: SongForm
   end
 
   it do
     form = AlbumForm.new(Album.new(Song.new("When It Comes To You")))
-    form.song.title.must_equal "When It Comes To You"
+    _(form.song.title).must_equal "When It Comes To You"
 
     form.validate(song: {title: "Run For Cover"})
   end

data/test/from_test.rb

@@ -1,7 +1,7 @@
-require 'test_helper'
+require "test_helper"
 
 class AsTest < BaseTest
-  class AlbumForm < Reform::Form
+  class AlbumForm < TestForm
     property :name, from: :title
 
     property :single, from: :hit do
@@ -19,46 +19,42 @@ class AsTest < BaseTest
     end
   end
 
-  let (:song2) { Song.new("Roxanne") }
+  let(:song2) { Song.new("Roxanne") }
 
-  let (:params) {
+  let(:params) do
       {
         "name" => "Best Of The Police",
-        "single"   => {"title" => "So Lonely"},
+        "single" => {"title" => "So Lonely"},
         "tracks" => [{"name" => "Message In A Bottle"}, {"name" => "Roxanne"}]
       }
-    }
+    end
 
   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" }
-
+  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" }
+    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 {
+    before do
       subject.tracks[1].name = "Livin' Ain't No Crime"
       subject.sync
-    }
+    end
 
-    it { song2.title.must_equal "Livin' Ain't No Crime" }
+    it { _(song2.title).must_equal "Livin' Ain't No Crime" }
   end
 
-
   describe "#save (nested hash)" do
     before { subject.validate(params) }
 
@@ -69,7 +65,7 @@ class AsTest < BaseTest
         hash = nested_hash
       end
 
-      hash.must_equal({"title"=>"Best Of The Police", "hit"=>{"title"=>"So Lonely"}, "songs"=>[{"title"=>"Message In A Bottle"}, {"title"=>"Roxanne"}]})
+      _(hash).must_equal({"title" => "Best Of The Police", "hit" => {"title" => "So Lonely"}, "songs" => [{"title" => "Message In A Bottle"}, {"title" => "Roxanne"}], "band" => nil})
     end
   end
 end

data/test/inherit_new_api.rb

@@ -0,0 +1,105 @@
+require "test_helper"
+require "representable/json"
+
+class InheritTest < BaseTest
+  Populator = Reform::Form::Populator
+
+  class SkipParse
+    include Uber::Callable
+    def call(*_args)
+      false
+    end
+  end
+
+  class AlbumForm < TestForm
+    property :title, deserializer: {instance: "Instance"}, skip_if: "skip_if in AlbumForm" # allow direct configuration of :deserializer.
+
+    property :hit, populate_if_empty: ->(*) { Song.new } do
+      property :title
+      validation do
+        params { required(:title).filled }
+      end
+    end
+
+    collection :songs, populate_if_empty: -> {}, skip_if: :all_blank do
+      property :title
+    end
+
+    property :band, populate_if_empty: -> {} do
+      def band_id
+        1
+      end
+    end
+  end
+
+  class CompilationForm < AlbumForm
+    property :title, inherit: true, skip_if: "skip_if from CompilationForm"
+    property :hit, inherit: true, populate_if_empty: ->(*) { Song.new }, skip_if: SkipParse.new do
+      property :rating
+      validation do
+        params { required(:rating).filled }
+      end
+    end
+
+    # NO collection here, this is entirely inherited.
+
+    property :band, inherit: true do # inherit everything, but explicitely.
+    end
+  end
+
+  let(:album) { Album.new(nil, Song.new, [], Band.new) }
+  subject { CompilationForm.new(album) }
+
+  it do
+    subject.validate("hit" => {"title" => "LA Drone", "rating" => 10})
+    _(subject.hit.title).must_equal "LA Drone"
+    _(subject.hit.rating).must_equal 10
+    _(subject.errors.messages).must_equal({})
+  end
+
+  it do
+    subject.validate({})
+    assert_nil subject.model.hit.title
+    assert_nil subject.model.hit.rating
+    _(subject.errors.messages).must_equal("hit.title": ["must be filled"], "hit.rating": ["must be filled"])
+  end
+
+  it "xxx" do
+    # sub hashes like :deserializer must be properly cloned when inheriting.
+    _(AlbumForm.options_for(:title)[:deserializer].object_id).wont_equal CompilationForm.options_for(:title)[:deserializer].object_id
+
+    # don't overwrite direct deserializer: {} configuration.
+    _(AlbumForm.options_for(:title)[:internal_populator]).must_be_instance_of Reform::Form::Populator::Sync
+    _(AlbumForm.options_for(:title)[:deserializer][:skip_parse]).must_equal "skip_if in AlbumForm"
+
+    # AlbumForm.options_for(:hit)[:internal_populator].inspect.must_match /Reform::Form::Populator:.+ @user_proc="Populator"/
+    # AlbumForm.options_for(:hit)[:deserializer][:instance].inspect.must_be_instance_with Reform::Form::Populator, user_proc: "Populator"
+
+    _(AlbumForm.options_for(:songs)[:internal_populator]).must_be_instance_of Reform::Form::Populator::IfEmpty
+    _(AlbumForm.options_for(:songs)[:deserializer][:skip_parse]).must_be_instance_of Reform::Form::Validate::Skip::AllBlank
+
+    _(AlbumForm.options_for(:band)[:internal_populator]).must_be_instance_of Reform::Form::Populator::IfEmpty
+
+    _(CompilationForm.options_for(:title)[:deserializer][:skip_parse]).must_equal "skip_if from CompilationForm"
+    # pp CompilationForm.options_for(:songs)
+    _(CompilationForm.options_for(:songs)[:internal_populator]).must_be_instance_of Reform::Form::Populator::IfEmpty
+
+    _(CompilationForm.options_for(:band)[:internal_populator]).must_be_instance_of Reform::Form::Populator::IfEmpty
+
+    # completely overwrite inherited.
+    _(CompilationForm.options_for(:hit)[:deserializer][:skip_parse]).must_be_instance_of SkipParse
+
+    # inherit: true with block will still inherit the original class.
+    _(AlbumForm.new(OpenStruct.new(band: OpenStruct.new)).band.band_id).must_equal 1
+    _(CompilationForm.new(OpenStruct.new(band: OpenStruct.new)).band.band_id).must_equal 1
+  end
+
+  class CDForm < AlbumForm
+    # override :band's original populate_if_empty but with :inherit.
+    property :band, inherit: true, populator: "CD Populator" do
+
+    end
+  end
+
+  it { _(CDForm.options_for(:band)[:internal_populator].instance_variable_get(:@user_proc)).must_equal "CD Populator" }
+end

data/test/inherit_old_api.rb

@@ -0,0 +1,105 @@
+require "test_helper"
+require "representable/json"
+
+class InheritTest < BaseTest
+  Populator = Reform::Form::Populator
+
+  class SkipParse
+    include Uber::Callable
+    def call(*_args)
+      false
+    end
+  end
+
+  class AlbumForm < TestForm
+    property :title, deserializer: {instance: "Instance"}, skip_if: "skip_if in AlbumForm" # allow direct configuration of :deserializer.
+
+    property :hit, populate_if_empty: ->(*) { Song.new } do
+      property :title
+      validation do
+        required(:title).filled
+      end
+    end
+
+    collection :songs, populate_if_empty: -> {}, skip_if: :all_blank do
+      property :title
+    end
+
+    property :band, populate_if_empty: -> {} do
+      def band_id
+        1
+      end
+    end
+  end
+
+  class CompilationForm < AlbumForm
+    property :title, inherit: true, skip_if: "skip_if from CompilationForm"
+    property :hit, inherit: true, populate_if_empty: ->(*) { Song.new }, skip_if: SkipParse.new do
+      property :rating
+      validation do
+        required(:rating).filled
+      end
+    end
+
+    # NO collection here, this is entirely inherited.
+
+    property :band, inherit: true do # inherit everything, but explicitely.
+    end
+  end
+
+  let(:album) { Album.new(nil, Song.new, [], Band.new) }
+  subject { CompilationForm.new(album) }
+
+  it do
+    subject.validate("hit" => {"title" => "LA Drone", "rating" => 10})
+    _(subject.hit.title).must_equal "LA Drone"
+    _(subject.hit.rating).must_equal 10
+    _(subject.errors.messages).must_equal({})
+  end
+
+  it do
+    subject.validate({})
+    assert_nil subject.model.hit.title
+    assert_nil subject.model.hit.rating
+    _(subject.errors.messages).must_equal("hit.title": ["must be filled"], "hit.rating": ["must be filled"])
+  end
+
+  it "xxx" do
+    # sub hashes like :deserializer must be properly cloned when inheriting.
+    _(AlbumForm.options_for(:title)[:deserializer].object_id).wont_equal CompilationForm.options_for(:title)[:deserializer].object_id
+
+    # don't overwrite direct deserializer: {} configuration.
+    _(AlbumForm.options_for(:title)[:internal_populator]).must_be_instance_of Reform::Form::Populator::Sync
+    _(AlbumForm.options_for(:title)[:deserializer][:skip_parse]).must_equal "skip_if in AlbumForm"
+
+    # AlbumForm.options_for(:hit)[:internal_populator].inspect.must_match /Reform::Form::Populator:.+ @user_proc="Populator"/
+    # AlbumForm.options_for(:hit)[:deserializer][:instance].inspect.must_be_instance_with Reform::Form::Populator, user_proc: "Populator"
+
+    _(AlbumForm.options_for(:songs)[:internal_populator]).must_be_instance_of Reform::Form::Populator::IfEmpty
+    _(AlbumForm.options_for(:songs)[:deserializer][:skip_parse]).must_be_instance_of Reform::Form::Validate::Skip::AllBlank
+
+    _(AlbumForm.options_for(:band)[:internal_populator]).must_be_instance_of Reform::Form::Populator::IfEmpty
+
+    _(CompilationForm.options_for(:title)[:deserializer][:skip_parse]).must_equal "skip_if from CompilationForm"
+    # pp CompilationForm.options_for(:songs)
+    _(CompilationForm.options_for(:songs)[:internal_populator]).must_be_instance_of Reform::Form::Populator::IfEmpty
+
+    _(CompilationForm.options_for(:band)[:internal_populator]).must_be_instance_of Reform::Form::Populator::IfEmpty
+
+    # completely overwrite inherited.
+    _(CompilationForm.options_for(:hit)[:deserializer][:skip_parse]).must_be_instance_of SkipParse
+
+    # inherit: true with block will still inherit the original class.
+    _(AlbumForm.new(OpenStruct.new(band: OpenStruct.new)).band.band_id).must_equal 1
+    _(CompilationForm.new(OpenStruct.new(band: OpenStruct.new)).band.band_id).must_equal 1
+  end
+
+  class CDForm < AlbumForm
+    # override :band's original populate_if_empty but with :inherit.
+    property :band, inherit: true, populator: "CD Populator" do
+
+    end
+  end
+
+  it { _(CDForm.options_for(:band)[:internal_populator].instance_variable_get(:@user_proc)).must_equal "CD Populator" }
+end