reform 2.3.0.rc1 → 2.3.0.rc2

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,4 +1,4 @@
-require 'test_helper'
+require "test_helper"
 
 class FormOptionTest < MiniTest::Spec
   Song  = Struct.new(:title)

data/test/from_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require "test_helper"
 
 class AsTest < BaseTest
   class AlbumForm < TestForm
@@ -19,15 +19,15 @@ 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])) }
 
@@ -36,10 +36,8 @@ class AsTest < BaseTest
   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" }
@@ -48,17 +46,15 @@ class AsTest < BaseTest
     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" }
   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"}], "band"=> nil})
+      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_test.rb → inherit_old_api.rb}

@@ -1,12 +1,12 @@
-require 'test_helper'
-require 'representable/json'
+require "test_helper"
+require "representable/json"
 
 class InheritTest < BaseTest
   Populator = Reform::Form::Populator
 
   class SkipParse
     include Uber::Callable
-    def call(*args)
+    def call(*_args)
       false
     end
   end
@@ -14,19 +14,18 @@ class InheritTest < BaseTest
   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 :hit, populate_if_empty: ->(*) { Song.new } do
       property :title
       validation do
         required(:title).filled
       end
     end
 
-    collection :songs, populate_if_empty: lambda {}, skip_if: :all_blank do
+    collection :songs, populate_if_empty: -> {}, skip_if: :all_blank do
       property :title
     end
 
-    property :band, populate_if_empty: lambda {} do
-
+    property :band, populate_if_empty: -> {} do
       def band_id
         1
       end
@@ -35,7 +34,7 @@ class InheritTest < BaseTest
 
   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 :hit, inherit: true, populate_if_empty: ->(*) { Song.new }, skip_if: SkipParse.new do
       property :rating
       validation do
         required(:rating).filled
@@ -48,11 +47,11 @@ class InheritTest < BaseTest
     end
   end
 
-  let (:album) { Album.new(nil, Song.new, [], Band.new) }
+  let(:album) { Album.new(nil, Song.new, [], Band.new) }
   subject { CompilationForm.new(album) }
 
   it do
-    subject.validate({"hit" => {"title" => "LA Drone", "rating" => 10}})
+    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({})
@@ -62,7 +61,7 @@ class InheritTest < BaseTest
     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"]})
+    subject.errors.messages.must_equal("hit.title": ["must be filled"], "hit.rating": ["must be filled"])
   end
 
   it "xxx" do
@@ -76,31 +75,25 @@ class InheritTest < BaseTest
     # 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

data/test/module_new_api.rb

@@ -0,0 +1,137 @@
+require "test_helper"
+require "reform/form/coercion"
+
+class ModuleInclusionTest < MiniTest::Spec
+  module BandPropertyForm
+    include Reform::Form::Module
+
+    property :band do
+      property :title
+
+      validation do
+        params { required(:title).filled }
+      end
+
+      def id # gets mixed into Form, too.
+        2
+      end
+    end
+
+    def id # gets mixed into Form, too.
+      1
+    end
+
+    validation do
+      params { required(:band).filled }
+    end
+
+    include Dry::Types.module # allows using Types::* in module.
+    property :cool, type: DRY_TYPES_CONSTANT::Bool # test coercion.
+  end
+
+  # TODO: test if works, move stuff into inherit_schema!
+  module AirplaysPropertyForm
+    include Reform::Form::Module
+
+    collection :airplays do
+      property :station
+      validation do
+        params { required(:station).filled }
+      end
+    end
+    validation do
+      params { required(:airplays).filled }
+    end
+  end
+
+  # test:
+  # by including BandPropertyForm into multiple classes we assure that options hashes don't get messed up by AM:V.
+  class HitForm < TestForm
+    include BandPropertyForm
+  end
+
+  class SongForm < TestForm
+    include Coercion
+    property :title
+
+    include BandPropertyForm
+  end
+
+  let(:song) { OpenStruct.new(band: OpenStruct.new(title: "Time Again")) }
+
+  # nested form from module is present and creates accessor.
+  it { SongForm.new(song).band.title.must_equal "Time Again" }
+
+  # methods from module get included.
+  it { SongForm.new(song).id.must_equal 1 }
+  it { SongForm.new(song).band.id.must_equal 2 }
+
+  # validators get inherited.
+  it do
+    form = SongForm.new(OpenStruct.new)
+    form.validate({})
+    form.errors.messages.must_equal(band: ["must be filled"])
+  end
+
+  # coercion works
+  it do
+    form = SongForm.new(OpenStruct.new)
+    form.validate(cool: "1")
+    form.cool.must_equal true
+  end
+
+  # include a module into a module into a class :)
+  module AlbumFormModule
+    include Reform::Form::Module
+    include BandPropertyForm
+
+    property :name
+    validation do
+      params { required(:name).filled }
+    end
+  end
+
+  class AlbumForm < TestForm
+    include AlbumFormModule
+
+    # pp heritage
+    property :band, inherit: true do
+      property :label
+      validation do
+        params { required(:label).filled }
+      end
+    end
+  end
+
+  it do
+    form = AlbumForm.new(OpenStruct.new(band: OpenStruct.new))
+    form.validate("band" => {})
+    form.errors.messages.must_equal("band.title": ["must be filled"], "band.label": ["must be filled"], name: ["must be filled"])
+  end
+
+  describe "module with custom accessors" do
+    module SongModule
+      include Reform::Form::Module
+
+      property :id    # no custom accessor for id.
+      property :title # has custom accessor.
+
+      module InstanceMethods
+        def title
+          super.upcase
+        end
+      end
+    end
+
+    class IncludingSongForm < TestForm
+      include SongModule
+    end
+
+    let(:song) { OpenStruct.new(id: 1, title: "Instant Mash") }
+
+    it do
+      IncludingSongForm.new(song).id.must_equal 1
+      IncludingSongForm.new(song).title.must_equal "INSTANT MASH"
+    end
+  end
+end

data/test/{module_test.rb → module_old_api.rb}

@@ -1,10 +1,11 @@
 require "test_helper"
-require 'reform/form/coercion'
+require "reform/form/coercion"
 
 class ModuleInclusionTest < MiniTest::Spec
   module BandPropertyForm
     include Reform::Form::Module
 
+    property :artist
     property :band do
       property :title
 
@@ -26,7 +27,14 @@ class ModuleInclusionTest < MiniTest::Spec
     end
 
     include Dry::Types.module # allows using Types::* in module.
-    property :cool, type: Form::Bool # test coercion.
+    property :cool, type: DRY_TYPES_CONSTANT::Bool # test coercion.
+
+    module InstanceMethods
+      def artist=(new_value)
+        errors.add(:artist, "this needs to be filled") if new_value.nil?
+        super(new_value)
+      end
+    end
   end
 
   # TODO: test if works, move stuff into inherit_schema!
@@ -44,7 +52,6 @@ class ModuleInclusionTest < MiniTest::Spec
     end
   end
 
-
   # test:
   # by including BandPropertyForm into multiple classes we assure that options hashes don't get messed up by AM:V.
   class HitForm < TestForm
@@ -58,11 +65,11 @@ class ModuleInclusionTest < MiniTest::Spec
     include BandPropertyForm
   end
 
-
-  let (:song) { OpenStruct.new(:band => OpenStruct.new(:title => "Time Again")) }
+  let(:song) { OpenStruct.new(band: OpenStruct.new(title: "Time Again"), artist: "Ketama") }
 
   # nested form from module is present and creates accessor.
   it { SongForm.new(song).band.title.must_equal "Time Again" }
+  it { SongForm.new(song).artist.must_equal "Ketama" }
 
   # methods from module get included.
   it { SongForm.new(song).id.must_equal 1 }
@@ -71,8 +78,8 @@ class ModuleInclusionTest < MiniTest::Spec
   # validators get inherited.
   it do
     form = SongForm.new(OpenStruct.new)
-    form.validate({})
-    form.errors.messages.must_equal({:band=>["must be filled"]})
+    form.validate(artist: nil)
+    form.errors.messages.must_equal(artist: ["this needs to be filled"], band: ["must be filled"])
   end
 
   # coercion works
@@ -82,7 +89,6 @@ class ModuleInclusionTest < MiniTest::Spec
     form.cool.must_equal true
   end
 
-
   # include a module into a module into a class :)
   module AlbumFormModule
     include Reform::Form::Module
@@ -98,7 +104,7 @@ class ModuleInclusionTest < MiniTest::Spec
     include AlbumFormModule
 
     # pp heritage
-    property :band, :inherit => true do
+    property :band, inherit: true do
       property :label
       validation do
         required(:label).filled
@@ -107,12 +113,11 @@ class ModuleInclusionTest < MiniTest::Spec
   end
 
   it do
-    form = AlbumForm.new(OpenStruct.new(:band => OpenStruct.new))
-    form.validate({"band" => {}})
-    form.errors.messages.must_equal({:"band.title"=>["must be filled"], :"band.label"=>["must be filled"], :name=>["must be filled"]})
+    form = AlbumForm.new(OpenStruct.new(band: OpenStruct.new))
+    form.validate("band" => {})
+    form.errors.messages.must_equal("band.title": ["must be filled"], "band.label": ["must be filled"], name: ["must be filled"])
   end
 
-
   describe "module with custom accessors" do
     module SongModule
       include Reform::Form::Module
@@ -131,7 +136,7 @@ class ModuleInclusionTest < MiniTest::Spec
       include SongModule
     end
 
-    let (:song) { OpenStruct.new(id: 1, title: "Instant Mash") }
+    let(:song) { OpenStruct.new(id: 1, title: "Instant Mash") }
 
     it do
       IncludingSongForm.new(song).id.must_equal 1
@@ -139,4 +144,3 @@ class ModuleInclusionTest < MiniTest::Spec
     end
   end
 end
-