reform 2.3.3 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f5d5dea8c04f5d993a91776afffea2a0b48603d850c11204d04e79248be6cf8
-  data.tar.gz: e4132e9db35384198bf31797b8620219c6418df4781a8f5300bbcf38c1a1c630
+  metadata.gz: e0b6b3c1dbb48304ae8b36f5fbc12d9f7149edc61b40757017472b3eb01cf04f
+  data.tar.gz: 689811ffa73a062d4e598d8a36b6258571350d1ce4c5c87c85db9707313dde04
 SHA512:
-  metadata.gz: '0845ada0bbafc7c3a45485d51f93c66c8616bee7b23c851712d297be20c73e82f23a8e575f803adb2972c382c4c9003951ae8d788fe12df87195950490505028'
-  data.tar.gz: bd463ddb326f4db34ef9ad6948cdb9466a56c87514f2a18fcafba6dff29b54baf5640b97b490657b92e438c336869f35adc3e407b91be80351f427fd84f28c35
+  metadata.gz: a797c79e164c4c1791661a97163d4e89b1b2e49ae4992e1c0a59eb427d98ddfdbdae96292f455f843acacc869b5053916afa7131018843c66f4d886e6872c372
+  data.tar.gz: 82fe647e1ab34dcc24e85250d5876b88b84ea3a991cdfb163bf0dd616be701105ab1ca87065285bc0e32abe9f67ccdb3cda103c7f70143e49d0a8c3024baa75e

data/.gitignore

@@ -15,7 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.rubocop-https*
+.rubocop*
 .byebug_history
 .idea
 *.iml

data/.travis.yml

@@ -7,9 +7,6 @@ rvm:
   - 2.6
   - 2.5
   - 2.4
-gemfile:
-  - gemfiles/1.5.0.gemfile
-  - gemfiles/0.13.0.gemfile
 matrix:
   fast_finish: true
   allow_failures:

data/CHANGES.md

@@ -1,3 +1,12 @@
+## 2.5.0
+*  fix memory leak with Dry validation (#525)
+
+## 2.4.0
+
+* [BREAKING] Dropping compatibility of dry-validation < 1.x
+[* Removed `Reform::Contract` ?]
+[* Move Form#deserializer to Form::deserializer]
+
 ## 2.3.3
 
 * Rename validation option for dry-v 1+ to `contract` instead of `schema`

data/Gemfile

@@ -2,4 +2,4 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "appraisal", "~> 2.2"
+gem 'dry-validation', '~> 1.5.0'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 - 2020 Nick Sutterer
+Copyright (c) 2013 - 2021 Nick Sutterer
 
 MIT License
 

data/README.md

@@ -10,11 +10,11 @@ _Form objects decoupled from your models._
 
 Reform gives you a form object with validations and nested setup of models. It is completely framework-agnostic and doesn't care about your database.
 
-Although reform can be used in any Ruby framework, it comes with [Rails support](#rails-integration), works with [simple_form and other form gems](#formbuilder-support), allows nesting forms to implement [has_one](#nesting-forms-1-1-relations) and [has_many](#nesting-forms-1-n-relations) relationships, can [compose a form](#compositions) from multiple objects and gives you [coercion](#coercion).
+Although reform can be used in any Ruby framework, it comes with [Rails support](#rails-integration), works with simple_form and other form gems, allows nesting forms to implement has_one and has_many relationships, can [compose a form](#compositions) from multiple objects and gives you coercion.
 
 ## Full Documentation
 
-Reform is part of the [Trailblazer](http://trailblazer.to) framework. [Full documentation](http://trailblazer.to/gems/reform) is available on the project site.
+Reform is part of the [Trailblazer](http://trailblazer.to) framework. [Full documentation](http://trailblazer.to/2.1/docs/reform.html) is available on the project site.
 
 ## Reform 2.2
 
@@ -250,7 +250,7 @@ The manual saving with block is not encouraged. You should rather check the Disp
 
 ## Populating Forms
 
-Very often, you need to give Reform some information how to create or find nested objects when `validate`ing. This directive is called _populator_ and [documented here](http://trailblazer.to/gems/reform/populator.html).
+Very often, you need to give Reform some information how to create or find nested objects when `validate`ing. This directive is called _populator_ and [documented here](http://trailblazer.to/2.1/docs/reform.html#reform-populators).
 
 ## Installation
 
@@ -313,7 +313,7 @@ AlbumForm.new(album: album, cd: CD.find(1))
 
 ## More
 
-Reform comes many more optional features, like hash fields, coercion, virtual fields, and so on. Check the [full documentation here](http://trailblazer.to/gems/reform).
+Reform comes many more optional features, like hash fields, coercion, virtual fields, and so on. Check the [full documentation here](http://trailblazer.to/2.1/docs/reform.html).
 
 [![](http://trailblazer.to/images/3dbuch-freigestellt.png)](https://leanpub.com/trailblazer)
 
@@ -330,7 +330,7 @@ Temporary note: This is the README and API for Reform 2. On the public API, only
 
 Anyway, please upgrade and _report problems_ and do not simply assume that we will magically find out what needs to get fixed. When in trouble, join us on [Gitter](https://gitter.im/trailblazer/chat).
 
-[Full documentation for Reform](http://trailblazer.to/gems/reform) is available online, or support us and grab the [Trailblazer book](https://leanpub.com/trailblazer). There is an [Upgrading Guide](http://trailblazer.to/gems/reform/upgrading-guide.html) to help you migrate from Reform 1.x.
+[Full documentation for Reform](http://trailblazer.to/2.1/docs/reform.html) is available online, or support us and grab the [Trailblazer book](https://leanpub.com/trailblazer). There is an [Upgrading Guide](http://trailblazer.to/2.1/docs/reform.html#reform-upgrading-guide) to help you migrate through versions.
 
 ### Attributions!!!
 

data/Rakefile

@@ -4,19 +4,8 @@ require "dry/types/version"
 
 task default: %i[test]
 
-TEST_WITH_OLD_AND_NEW_API = %w[
-  validation/dry_validation call composition contract errors inherit module reform
-  save skip_if populate validate form
-].freeze
-
-def dry_v_test_files
-  api = Gem::Version.new(Dry::Types::VERSION).to_s.split('.').first.to_i >= 1 ? "new" : "old"
-  TEST_WITH_OLD_AND_NEW_API.map { |file| "test/#{file}_#{api}_api.rb" }
-end
-
 Rake::TestTask.new(:test) do |test|
   test.libs << "test"
-  test.test_files = FileList["test/*_test.rb"] + FileList["test/validation/*_test.rb"] + dry_v_test_files
+  test.test_files = FileList["test/**/*_test.rb"]
   test.verbose = true
 end
-

data/lib/reform/contract/validate.rb

@@ -11,7 +11,7 @@ class Reform::Contract < Disposable::Twin
       validate!(nil).success?
     end
 
-    # The #errors method will be removed in Reform 2.4/3.0 core.
+    # The #errors method will be removed in Reform 3.0 core.
     def errors(*args)
       Result::Errors.new(@result, self)
     end

data/lib/reform/form/dry.rb

@@ -1,19 +1,57 @@
+gem 'dry-validation', '~> 1.5'
 require "dry-validation"
-require "dry/validation/version"
 require "reform/validation"
 require "reform/form/dry/input_hash"
 
+::Dry::Validation.load_extensions(:hints)
+
 module Reform::Form::Dry
+  class Contract < Dry::Validation::Contract
+  end
+
   def self.included(includer)
-    if Gem::Version.new(Dry::Validation::VERSION) > Gem::Version.new("0.13.3")
-      require "reform/form/dry/new_api"
-      validations = Reform::Form::Dry::NewApi::Validations
-    else
-      require "reform/form/dry/old_api"
-      validations = Reform::Form::Dry::OldApi::Validations
+    includer.send :include, Validations
+    includer.extend Validations::ClassMethods
+  end
+
+  module Validations
+    module ClassMethods
+      def validation_group_class
+        Group
+      end
+    end
+
+    def self.included(includer)
+      includer.extend(ClassMethods)
     end
 
-    includer.send :include, validations
-    includer.extend validations::ClassMethods
+    class Group
+      include InputHash
+
+      def initialize(**options)
+        @validator = options.fetch(:contract, Contract)
+        @schema_inject_params = options.fetch(:with, {})
+      end
+
+      attr_reader :validator, :schema_inject_params, :block
+
+      def instance_exec(&block)
+        @block = block
+      end
+
+      def call(form)
+        # when passing options[:schema] the class instance is already created so we just need to call
+        # "call"
+        return validator.call(input_hash(form)) unless validator.is_a?(Class) && @validator <= ::Dry::Validation::Contract
+
+        dynamic_options = { form: form }
+        inject_options = schema_inject_params.merge(dynamic_options)
+        contract.new(inject_options).call(input_hash(form))
+      end
+
+      def contract
+        @contract ||= Class.new(validator, &block)
+      end
+    end
   end
 end

data/lib/reform/validation/groups.rb

@@ -43,7 +43,6 @@ module Reform::Validation
 
         groups.collect do |(name, group, options)|
           next unless evaluate?(options[:if], results, form)
-
           results[name] = group.(form) # run validation for group. store and collect <Result>.
         end
       end

data/lib/reform/version.rb

@@ -1,3 +1,3 @@
 module Reform
-  VERSION = "2.3.3".freeze
+  VERSION = "2.5.0".freeze
 end

data/test/call_test.rb

@@ -0,0 +1,23 @@
+require "test_helper"
+
+class CallTest < Minitest::Spec
+  Song = Struct.new(:title)
+
+  class SongForm < TestForm
+    property :title
+
+    validation do
+      params { required(:title).filled }
+    end
+  end
+
+  let(:form) { SongForm.new(Song.new) }
+
+  it { assert form.(title: "True North").success? }
+  it { refute form.(title: "True North").failure? }
+  it { refute form.(title: "").success? }
+  it { assert form.(title: "").failure? }
+
+  it { assert_equal form.(title: "True North").errors.messages, {} }
+  it { assert_equal form.(title: "").errors.messages, title: ["must be filled"] }
+end

data/test/changed_test.rb

@@ -26,16 +26,16 @@ class ChangedTest < MiniTest::Spec
 
   # nothing changed after setup.
   it do
-    _(form.changed?(:name)).must_equal false
-    _(form.songs[0].changed?(:title)).must_equal false
-    _(form.songs[0].composer.changed?(:name)).must_equal false
+    refute form.changed?(:name)
+    refute form.songs[0].changed?(:title)
+    refute form.songs[0].composer.changed?(:name)
   end
 
   # after validate, things might have changed.
   it do
     form.validate("name" => "Out Of Bounds", "songs" => [{"composer" => {"name" => "Ingemar Jansson & Mikael Danielsson"}}])
-    _(form.changed?(:name)).must_equal true
-    _(form.songs[0].changed?(:title)).must_equal false
-    _(form.songs[0].composer.changed?(:name)).must_equal true
+    assert form.changed?(:name)
+    refute form.songs[0].changed?(:title)
+    assert form.songs[0].composer.changed?(:name)
   end
 end

data/test/coercion_test.rb

@@ -13,11 +13,11 @@ class CoercionTest < BaseTest
     feature Coercion
     include Disposable::Twin::Property::Hash
 
-    property :released_at, type: DRY_TYPES_CONSTANT::DateTime
+    property :released_at, type: Types::Params::DateTime
 
     property :hit do
-      property :length, type: DRY_TYPES_INT_CONSTANT
-      property :good,   type: DRY_TYPES_CONSTANT::Bool
+      property :length, type: Types::Params::Integer
+      property :good,   type: Types::Params::Bool
     end
 
     property :band do
@@ -28,7 +28,7 @@ class CoercionTest < BaseTest
 
     property :metadata, field: :hash do
       property :publication_settings do
-        property :featured, type: DRY_TYPES_CONSTANT::Bool
+        property :featured, type: Types::Params::Bool
       end
     end
   end
@@ -47,9 +47,9 @@ class CoercionTest < BaseTest
   end
 
   # it { subject.released_at.must_be_kind_of DateTime }
-  it { _(subject.released_at).must_equal "31/03/1981" } # NO coercion in setup.
-  it { _(subject.hit.length).must_equal "312" }
-  it { _(subject.band.label.value).must_equal "9999.99" }
+  it { assert_equal subject.released_at, "31/03/1981" } # NO coercion in setup.
+  it { assert_equal subject.hit.length, "312" }
+  it { assert_equal subject.band.label.value, "9999.99" }
 
   let(:params) do
     {
@@ -75,24 +75,24 @@ class CoercionTest < BaseTest
   describe "#validate" do
     before { subject.validate(params) }
 
-    it { _(subject.released_at).must_equal DateTime.parse("30/03/1981") }
-    it { _(subject.hit.length).must_equal 312 }
-    it { _(subject.hit.good).must_equal false }
-    it { _(subject.band.label.value).must_equal "9999.999999.99" } # coercion happened once.
-    it { _(subject.metadata.publication_settings.featured).must_equal false }
+    it { assert_equal subject.released_at, DateTime.parse("30/03/1981") }
+    it { assert_equal subject.hit.length, 312 }
+    it { assert_equal subject.hit.good, false }
+    it { assert_equal subject.band.label.value, "9999.999999.99" } # coercion happened once.
+    it { assert_equal subject.metadata.publication_settings.featured, false }
   end
 
   # sync
   describe "#sync" do
     before do
-      _(subject.validate(params)).must_equal true
+      assert subject.validate(params)
       subject.sync
     end
 
-    it { _(album.released_at).must_equal DateTime.parse("30/03/1981") }
-    it { _(album.hit.length).must_equal 312 }
-    it { _(album.hit.good).must_equal false }
+    it { assert_equal album.released_at, DateTime.parse("30/03/1981") }
+    it { assert_equal album.hit.length, 312 }
+    it { assert_equal album.hit.good, false }
     it { assert_nil album.metadata[:publication_settings] }
-    it { _(album.metadata["publication_settings"]["featured"]).must_equal false }
+    it { assert_equal album.metadata["publication_settings"]["featured"], false }
   end
 end

data/test/{composition_new_api.rb → composition_test.rb}

@@ -33,8 +33,8 @@ class FormCompositionInheritanceTest < MiniTest::Spec
   Tshirt = Struct.new(:price, :size)
   Measurement = Struct.new(:size)
 
-  it { _(form.price).must_equal 6 }
-  it { _(form.price(for_size: :s)).must_equal 2 }
+  it { assert_equal form.price, 6 }
+  it { assert_equal form.price(for_size: :s), 2 }
 end
 
 class FormCompositionTest < MiniTest::Spec
@@ -71,24 +71,24 @@ class FormCompositionTest < MiniTest::Spec
   let(:band)       { Band.new("Duran^2") }
 
   # delegation form -> composition works
-  it { _(form.id).must_equal 1 }
-  it { _(form.title).must_equal "Rio" }
-  it { _(form.name).must_equal "Duran Duran" }
-  it { _(form.requester_id).must_equal 2 }
+  it { assert_equal form.id, 1 }
+  it { assert_equal form.title, "Rio" }
+  it { assert_equal form.name, "Duran Duran" }
+  it { assert_equal form.requester_id, 2 }
   it { assert_nil form.channel }
-  it { _(form.requester).must_equal "MCP" } # same name as composed model.
+  it { assert_equal form.requester, "MCP" } # same name as composed model.
   it { assert_nil form.captcha }
 
   # #model just returns <Composition>.
-  it { _(form.mapper).must_be_kind_of Disposable::Composition }
+  it { assert form.mapper.is_a? Disposable::Composition }
 
   # #model[] -> composed models
-  it { _(form.model[:requester]).must_equal requester }
-  it { _(form.model[:song]).must_equal song }
+  it { assert_equal form.model[:requester], requester }
+  it { assert_equal form.model[:song], song }
 
   it "creates Composition for you" do
-    _(form.validate("title" => "Greyhound", "name" => "Frenzal Rhomb")).must_equal true
-    _(form.validate("title" => "", "name" => "Frenzal Rhomb")).must_equal false
+    assert_equal form.validate("title" => "Greyhound", "name" => "Frenzal Rhomb"), true
+    assert_equal form.validate("title" => "", "name" => "Frenzal Rhomb"), false
   end
 
   describe "#save" do
@@ -101,7 +101,7 @@ class FormCompositionTest < MiniTest::Spec
         hash[:title]  = form.title
       end
 
-      _(hash).must_equal({name: "Duran Duran", title: "Rio"})
+      assert_equal hash, name: "Duran Duran", title: "Rio"
     end
 
     it "provides nested symbolized hash as second block argument" do
@@ -113,11 +113,10 @@ class FormCompositionTest < MiniTest::Spec
         hash = map
       end
 
-      _(hash).must_equal({
-                        song: {"title" => "Greyhound", "id" => 1, "channel" => "JJJ", "captcha" => "wonderful", "band" => {"title" => "Duran^2"}},
-                        requester: {"name" => "Frenzal Rhomb", "id" => 2, "requester" => "MCP"}
-                      }
-      )
+      assert_equal hash, {
+        song: {"title" => "Greyhound", "id" => 1, "channel" => "JJJ", "captcha" => "wonderful", "band" => {"title" => "Duran^2"}},
+        requester: {"name" => "Frenzal Rhomb", "id" => 2, "requester" => "MCP"}
+      }
     end
 
     it "xxx pushes data to models and calls #save when no block passed" do
@@ -126,16 +125,16 @@ class FormCompositionTest < MiniTest::Spec
       band.extend(Saveable)
 
       form.validate("title" => "Greyhound", "name" => "Frenzal Rhomb", "captcha" => "1337")
-      _(form.captcha).must_equal "1337" # TODO: move to separate test.
+      assert_equal form.captcha, "1337" # TODO: move to separate test.
 
       form.save
 
-      _(requester.name).must_equal "Frenzal Rhomb"
-      _(requester.saved?).must_equal true
-      _(song.title).must_equal "Greyhound"
-      _(song.saved?).must_equal true
-      _(song.band.title).must_equal "Duran^2"
-      _(song.band.saved?).must_equal true
+      assert_equal requester.name, "Frenzal Rhomb"
+      assert_equal requester.saved?, true
+      assert_equal song.title, "Greyhound"
+      assert_equal song.saved?, true
+      assert_equal song.band.title, "Duran^2"
+      assert_equal song.band.saved?, true
     end
 
     it "returns true when models all save successfully" do
@@ -143,7 +142,7 @@ class FormCompositionTest < MiniTest::Spec
       requester.extend(Saveable)
       band.extend(Saveable)
 
-      _(form.save).must_equal true
+      assert_equal form.save, true
     end
 
     it "returns false when one or more models don't save successfully" do
@@ -157,7 +156,7 @@ class FormCompositionTest < MiniTest::Spec
       requester.extend(Saveable)
       band.extend(Saveable)
 
-      _(form.save).must_equal false
+      assert_equal form.save, false
     end
   end
 end
@@ -182,5 +181,5 @@ class FormCompositionCollectionTest < MiniTest::Spec
   let(:form)   { LibraryForm.new(library: library) }
   let(:library) { Library.new(2) }
 
-  it { form.save { |hash| _(hash).must_equal({library: {"books" => [{"id" => 1, "name" => "My book"}]}}) } }
+  it { form.save { |hash| assert_equal hash, { library: { "books" => [{ "id" => 1, "name" => "My book" }] } } } }
 end