reform 2.2.4 → 2.3.3

data/test/contract/custom_error_test.rb

@@ -0,0 +1,55 @@
+require "test_helper"
+
+class CustomerErrorTest < MiniTest::Spec
+  let(:key)            { :name }
+  let(:error_text)     { "text2" }
+  let(:starting_error) { [OpenStruct.new(errors: {title: ["text1"]})] }
+
+  let(:custom_error) { Reform::Contract::CustomError.new(key, error_text, @results) }
+
+  before { @results = starting_error }
+
+  it "base class structure" do
+    assert_equal custom_error.success?, false
+    assert_equal custom_error.failure?, true
+    assert_equal custom_error.errors, key => [error_text]
+    assert_equal custom_error.messages, key => [error_text]
+    assert_equal custom_error.hint, {}
+  end
+
+  describe "updates @results accordingly" do
+    it "add new key" do
+      custom_error
+
+      assert_equal @results.size, 2
+      errors = @results.map(&:errors)
+
+      assert_equal errors[0], starting_error.first.errors
+      assert_equal errors[1], custom_error.errors
+    end
+
+    describe "when key error already exists in @results" do
+      let(:key) { :title }
+
+      it "merge errors text" do
+        custom_error
+
+        assert_equal @results.size, 1
+
+        assert_equal @results.first.errors.values, [%w[text1 text2]]
+      end
+
+      describe "add error text is already" do
+        let(:error_text) { "text1" }
+
+        it 'does not create duplicates' do
+          custom_error
+
+          assert_equal @results.size, 1
+
+          assert_equal @results.first.errors.values, [%w[text1]]
+        end
+      end
+    end
+  end
+end

data/test/contract_new_api.rb

@@ -0,0 +1,77 @@
+require "test_helper"
+
+class ContractTest < MiniTest::Spec
+  Song  = Struct.new(:title, :album, :composer)
+  Album = Struct.new(:name, :duration, :songs, :artist)
+  Artist = Struct.new(:name)
+
+  class ArtistForm < TestForm
+    property :name
+  end
+
+  class AlbumForm < TestContract
+    property :name
+
+    properties :duration
+    properties :year, :style, readable: false
+
+    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, form: ArtistForm
+  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", 123, [song, song_with_composer], artist) }
+
+  let(:form) { AlbumForm.new(album) }
+
+  # accept `property form: SongForm`.
+  it do
+    _(form.artist).must_be_instance_of ArtistForm
+  end
+
+  describe ".properties" do
+    it "defines a property when called with one argument" do
+      _(form).must_respond_to :duration
+    end
+
+    it "defines several properties when called with multiple arguments" do
+      _(form).must_respond_to :year
+      _(form).must_respond_to :style
+    end
+
+    it "passes options to each property when options are provided" do
+      readable = AlbumForm.new(album).options_for(:style)[:readable]
+      _(readable).must_equal false
+    end
+
+    it "returns the list of defined properties" do
+      returned_value = AlbumForm.properties(:hello, :world, virtual: true)
+      _(returned_value).must_equal %i[hello world]
+    end
+  end
+
+  describe "#options_for" do
+    it { _(AlbumForm.options_for(:name).extend(Declarative::Inspect).inspect).must_equal "#<Disposable::Twin::Definition: @options={:private_name=>:name, :name=>\"name\"}>" }
+    it { _(AlbumForm.new(album).options_for(:name).extend(Declarative::Inspect).inspect).must_equal "#<Disposable::Twin::Definition: @options={:private_name=>:name, :name=>\"name\"}>" }
+  end
+end

data/test/contract_old_api.rb

@@ -0,0 +1,77 @@
+require "test_helper"
+
+class ContractTest < MiniTest::Spec
+  Song  = Struct.new(:title, :album, :composer)
+  Album = Struct.new(:name, :duration, :songs, :artist)
+  Artist = Struct.new(:name)
+
+  class ArtistForm < TestForm
+    property :name
+  end
+
+  class AlbumForm < TestContract
+    property :name
+
+    properties :duration
+    properties :year, :style, readable: false
+
+    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, form: ArtistForm
+  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", 123, [song, song_with_composer], artist) }
+
+  let(:form) { AlbumForm.new(album) }
+
+  # accept `property form: SongForm`.
+  it do
+    _(form.artist).must_be_instance_of ArtistForm
+  end
+
+  describe ".properties" do
+    it "defines a property when called with one argument" do
+      _(form).must_respond_to :duration
+    end
+
+    it "defines several properties when called with multiple arguments" do
+      _(form).must_respond_to :year
+      _(form).must_respond_to :style
+    end
+
+    it "passes options to each property when options are provided" do
+      readable = AlbumForm.new(album).options_for(:style)[:readable]
+      _(readable).must_equal false
+    end
+
+    it "returns the list of defined properties" do
+      returned_value = AlbumForm.properties(:hello, :world, virtual: true)
+      _(returned_value).must_equal %i[hello world]
+    end
+  end
+
+  describe "#options_for" do
+    it { _(AlbumForm.options_for(:name).extend(Declarative::Inspect).inspect).must_equal "#<Disposable::Twin::Definition: @options={:private_name=>:name, :name=>\"name\"}>" }
+    it { _(AlbumForm.new(album).options_for(:name).extend(Declarative::Inspect).inspect).must_equal "#<Disposable::Twin::Definition: @options={:private_name=>:name, :name=>\"name\"}>" }
+  end
+end

data/test/default_test.rb

@@ -5,7 +5,7 @@ class DefaultTest < Minitest::Spec
   Album = Struct.new(:name, :songs, :artist)
   Artist = Struct.new(:name)
 
-  class AlbumForm < Reform::Form
+  class AlbumForm < TestForm
     property :name, default: "Wrong"
 
     collection :songs do
@@ -16,7 +16,7 @@ class DefaultTest < Minitest::Spec
   it do
     form = AlbumForm.new(Album.new(nil, [Song.new]))
 
-    form.name.must_equal "Wrong"
-    form.songs[0].title.must_equal "It's Catching Up"
+    _(form.name).must_equal "Wrong"
+    _(form.songs[0].title).must_equal "It's Catching Up"
   end
-end
+end

data/test/deserialize_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require "test_helper"
 require "representable/json"
 
 class DeserializeTest < MiniTest::Spec
@@ -6,11 +6,11 @@ class DeserializeTest < MiniTest::Spec
   Album = Struct.new(:title, :artist)
   Artist = Struct.new(:name, :callname)
 
-  class JsonAlbumForm < Reform::Form
+  class JsonAlbumForm < TestForm
     module Json
       def deserialize(params)
         deserializer.new(self).
-        # extend(Representable::Debug).
+          # extend(Representable::Debug).
           from_json(params)
       end
 
@@ -18,7 +18,7 @@ class DeserializeTest < MiniTest::Spec
         Disposable::Rescheme.from(self.class,
           include:          [Representable::JSON],
           superclass:       Representable::Decorator,
-          definitions_from: lambda { |inline| inline.definitions },
+          definitions_from: ->(inline) { inline.definitions },
           options_from:     :deserializer,
           exclude_options:  [:populator]
         )
@@ -26,15 +26,13 @@ class DeserializeTest < MiniTest::Spec
     end
     include Json
 
-
     property :title
     property :artist, populate_if_empty: Artist do
       property :name
     end
   end
 
-
-  let (:artist) { Artist.new("A-ha") }
+  let(:artist) { Artist.new("A-ha") }
   it do
     artist_id = artist.object_id
 
@@ -43,13 +41,13 @@ class DeserializeTest < MiniTest::Spec
 
     form.validate(json)
 
-    form.title.must_equal "Apocalypse Soon"
-    form.artist.name.must_equal "Mute"
-    form.artist.model.object_id.must_equal artist_id
+    _(form.title).must_equal "Apocalypse Soon"
+    _(form.artist.name).must_equal "Mute"
+    _(form.artist.model.object_id).must_equal artist_id
   end
 
   describe "infering the deserializer from another form should NOT copy its populators" do
-    class CompilationForm < Reform::Form
+    class CompilationForm < TestForm
       property :artist, populator: ->(options) { self.artist = Artist.new(nil, options[:fragment].to_s) } do
         property :name
       end
@@ -62,20 +60,19 @@ class DeserializeTest < MiniTest::Spec
     # also tests the Form#deserializer API. # FIXME.
     it "uses deserializer inferred from JsonAlbumForm but deserializes/populates to CompilationForm" do
       form = CompilationForm.new(Album.new)
-      form.validate("artist"=> {"name" => "Horowitz"}) # the deserializer doesn't know symbols.
+      form.validate("artist" => {"name" => "Horowitz"}) # the deserializer doesn't know symbols.
       form.sync
-      form.artist.model.must_equal Artist.new("Horowitz", %{{"name"=>"Horowitz"}})
+      _(form.artist.model).must_equal Artist.new("Horowitz", %{{"name"=>"Horowitz"}})
     end
   end
 end
 
-
 class ValidateWithBlockTest < MiniTest::Spec
   Song  = Struct.new(:title, :album, :composer)
   Album = Struct.new(:title, :artist)
   Artist = Struct.new(:name)
 
-  class AlbumForm < Reform::Form
+  class AlbumForm < TestForm
     property :title
     property :artist, populate_if_empty: Artist do
       property :name
@@ -90,15 +87,15 @@ class ValidateWithBlockTest < MiniTest::Spec
     deserializer = Disposable::Rescheme.from(AlbumForm,
       include:          [Representable::JSON],
       superclass:       Representable::Decorator,
-      definitions_from: lambda { |inline| inline.definitions },
+      definitions_from: ->(inline) { inline.definitions },
       options_from:     :deserializer
     )
 
-    form.validate(json) do |params|
+    _(form.validate(json) { |params|
       deserializer.new(form).from_json(params)
-    end.must_equal true # with block must return result, too.
+    }).must_equal true # with block must return result, too.
 
-    form.title.must_equal "Apocalypse Soon"
-    form.artist.name.must_equal "Mute"
+    _(form.title).must_equal "Apocalypse Soon"
+    _(form.artist.name).must_equal "Mute"
   end
 end

data/test/errors_new_api.rb

@@ -0,0 +1,225 @@
+require "test_helper"
+
+class ErrorsTest < MiniTest::Spec
+  class AlbumForm < TestForm
+    property :title
+    validation do
+      params { required(:title).filled }
+    end
+
+    property :artists, default: []
+    property :producer do
+      property :name
+    end
+
+    property :hit do
+      property :title
+      validation do
+        params { required(:title).filled }
+      end
+    end
+
+    collection :songs do
+      property :title
+      validation do
+        params { required(:title).filled }
+      end
+    end
+
+    property :band do # yepp, people do crazy stuff like that.
+      property :name
+      property :label do
+        property :name
+        validation do
+          params { required(:name).filled }
+        end
+      end
+      # TODO: make band a required object.
+
+      validation do
+        config.messages.load_paths << "test/fixtures/dry_new_api_error_messages.yml"
+
+        params { required(:name).filled }
+
+        rule(:name) { key.failure(:good_musical_taste?) if value == "Nickelback" }
+      end
+    end
+
+    validation do
+      params do
+        required(:title).filled
+        required(:artists).each(:str?)
+        required(:producer).hash do
+          required(:name).filled
+        end
+      end
+    end
+  end
+
+  let(:album_title) { "Blackhawks Over Los Angeles" }
+  let(:album) do
+    OpenStruct.new(
+      title: album_title,
+      hit: song,
+      songs: songs, # TODO: document this requirement,
+      band: Struct.new(:name, :label).new("Epitaph", OpenStruct.new),
+      producer: Struct.new(:name).new("Sun Records")
+    )
+  end
+  let(:song)  { OpenStruct.new(title: "Downtown") }
+  let(:songs) { [song = OpenStruct.new(title: "Calling"), song] }
+  let(:form)  { AlbumForm.new(album) }
+
+  describe "#validate with invalid array property" do
+    it do
+      _(form.validate(
+        title: "Swimming Pool - EP",
+        band: {
+          name: "Marie Madeleine",
+          label: {name: "Ekler'o'shocK"}
+        },
+        artists: [42, "Good Charlotte", 43]
+      )).must_equal false
+      _(form.errors.messages).must_equal(artists: {0 => ["must be a string"], 2 => ["must be a string"]})
+      _(form.errors.size).must_equal(1)
+    end
+  end
+
+  describe "#errors without #validate" do
+    it do
+      _(form.errors.size).must_equal 0
+    end
+  end
+
+  describe "blank everywhere" do
+    before do
+      form.validate(
+        "hit" => {"title" => ""},
+        "title" => "",
+        "songs" => [{"title" => ""}, {"title" => ""}],
+        "producer" => {"name" => ""}
+      )
+    end
+
+    it do
+      _(form.errors.messages).must_equal(
+        title: ["must be filled"],
+        "hit.title": ["must be filled"],
+        "songs.title": ["must be filled"],
+        "band.label.name": ["must be filled"],
+        "producer.name": ["must be filled"]
+      )
+    end
+
+    # it do
+    #   form.errors.must_equal({:title  => ["must be filled"]})
+    #   TODO: this should only contain local errors?
+    # end
+
+    # nested forms keep their own Errors:
+    it { _(form.producer.errors.messages).must_equal(name: ["must be filled"]) }
+    it { _(form.hit.errors.messages).must_equal(title: ["must be filled"]) }
+    it { _(form.songs[0].errors.messages).must_equal(title: ["must be filled"]) }
+
+    it do
+      _(form.errors.messages).must_equal(
+        title: ["must be filled"],
+        "hit.title": ["must be filled"],
+        "songs.title": ["must be filled"],
+        "band.label.name": ["must be filled"],
+        "producer.name": ["must be filled"]
+      )
+      _(form.errors.size).must_equal(5)
+    end
+  end
+
+  describe "#validate with main form invalid" do
+    it do
+      _(form.validate("title" => "", "band" => {"label" => {name: "Fat Wreck"}}, "producer" => nil)).must_equal false
+      _(form.errors.messages).must_equal(title: ["must be filled"], producer: ["must be a hash"])
+      _(form.errors.size).must_equal(2)
+    end
+  end
+
+  describe "#validate with middle nested form invalid" do
+    before { @result = form.validate("hit" => {"title" => ""}, "band" => {"label" => {name: "Fat Wreck"}}) }
+
+    it { _(@result).must_equal false }
+    it { _(form.errors.messages).must_equal("hit.title": ["must be filled"]) }
+    it { _(form.errors.size).must_equal(1) }
+  end
+
+  describe "#validate with collection form invalid" do
+    before { @result = form.validate("songs" => [{"title" => ""}], "band" => {"label" => {name: "Fat Wreck"}}) }
+
+    it { _(@result).must_equal false }
+    it { _(form.errors.messages).must_equal("songs.title": ["must be filled"]) }
+    it { _(form.errors.size).must_equal(1) }
+  end
+
+  describe "#validate with collection and 2-level-nested invalid" do
+    before { @result = form.validate("songs" => [{"title" => ""}], "band" => {"label" => {}}) }
+
+    it { _(@result).must_equal false }
+    it { _(form.errors.messages).must_equal("songs.title": ["must be filled"], "band.label.name": ["must be filled"]) }
+    it { _(form.errors.size).must_equal(2) }
+  end
+
+  describe "#validate with nested form using :base invalid" do
+    it do
+      result = form.validate("songs" => [{"title" => "Someday"}], "band" => {"name" => "Nickelback", "label" => {"name" => "Roadrunner Records"}})
+      _(result).must_equal false
+      _(form.errors.messages).must_equal("band.name": ["you're a bad person"])
+      _(form.errors.size).must_equal(1)
+    end
+  end
+
+  describe "#add" do
+    let(:album_title) { nil }
+    it do
+      result = form.validate("songs" => [{"title" => "Someday"}], "band" => {"name" => "Nickelback", "label" => {"name" => "Roadrunner Records"}})
+      _(result).must_equal false
+      _(form.errors.messages).must_equal(title: ["must be filled"], "band.name": ["you're a bad person"])
+      # add a new custom error
+      form.errors.add(:policy, "error_text")
+      _(form.errors.messages).must_equal(title: ["must be filled"], "band.name": ["you're a bad person"], policy: ["error_text"])
+      # does not duplicate errors
+      form.errors.add(:title, "must be filled")
+      _(form.errors.messages).must_equal(title: ["must be filled"], "band.name": ["you're a bad person"], policy: ["error_text"])
+      # merge existing errors
+      form.errors.add(:policy, "another error")
+      _(form.errors.messages).must_equal(title: ["must be filled"], "band.name": ["you're a bad person"], policy: ["error_text", "another error"])
+    end
+  end
+
+  describe "correct #validate" do
+    before do
+      @result = form.validate(
+        "hit"   => {"title" => "Sacrifice"},
+        "title" => "Second Heat",
+        "songs" => [{"title" => "Heart Of A Lion"}],
+        "band"  => {"label" => {name: "Fat Wreck"}}
+      )
+    end
+
+    it { _(@result).must_equal true }
+    it { _(form.hit.title).must_equal "Sacrifice" }
+    it { _(form.title).must_equal "Second Heat" }
+    it { _(form.songs.first.title).must_equal "Heart Of A Lion" }
+    it do
+      skip "WE DON'T NEED COUNT AND EMPTY? ON THE CORE ERRORS OBJECT"
+      _(form.errors.size).must_equal(0)
+      _(form.errors.empty?).must_equal(true)
+    end
+  end
+
+  describe "Errors#to_s" do
+    before { form.validate("songs" => [{"title" => ""}], "band" => {"label" => {}}) }
+
+    # to_s is aliased to messages
+    it {
+      skip "why do we need Errors#to_s ?"
+      _(form.errors.to_s).must_equal "{:\"songs.title\"=>[\"must be filled\"], :\"band.label.name\"=>[\"must be filled\"]}"
+    }
+  end
+end