reform 2.3.0.rc2 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d820c5f61dcb3ef74ab8ac15bbc662bd8e9490a8
-  data.tar.gz: aa023d388b19459ebe7dd4c19862f8bc85364697
+SHA256:
+  metadata.gz: 9a0dc23a8d6a5ba78556fdd827acdfdd596e45dc8354ed5e82acfdfaf5cf5dcf
+  data.tar.gz: 21216fc1a7d500ca8ecd7b59349166629e8ef8514d34d321d23eb5a857d378dd
 SHA512:
-  metadata.gz: 48f9fcbc0917b9478d1124900146d6597e32e613a2ab4d61d504d359fb546b42d44ae958fff089df1bc315983c1fb70701b4246fb4a85b79341113f9460e5278
-  data.tar.gz: eac447cc3824c9e09926e64fb33437e8e9c0b3e86a7dfd24ec1cc71407c23550854fd6c64ea25538de01cb1350fb6302bb033e542bebb1f52a65ea1a7d8674e9
+  metadata.gz: f5a8aeaa19e8a90c4d0276fba8fe6d85fb5574607e838e9c9298d556292182231ed7d2e29b24835f3265cabb9b37db93f6602388052889e6fcd759e5478ca6ef
+  data.tar.gz: c69fadd4887bfb63538d69a501ddf0e958bd9594ceb9ff97a4181c5017d1eec0a2bbc88fc9cb9ba417257be6f01ac655301b0e822c6babf36ca45d7b7c3fd4e3

data/.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        # Due to https://github.com/actions/runner/issues/849, we have to use quotes for '3.0'
+        ruby: [2.4, 2.5, 2.6, 2.7, '3.0', head]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake

data/.gitignore

@@ -4,7 +4,6 @@
 .config
 .yardoc
 Gemfile.lock
-gemfiles/*.lock
 InstalledFiles
 _yardoc
 coverage
@@ -16,5 +15,8 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.rubocop-https*
+.rubocop*
 .byebug_history
+.idea
+*.iml
+gemfiles/*.gemfile.lock

data/CHANGES.md

@@ -1,8 +1,31 @@
-## 3.0.0
+## 2.6.0
 
+* Support ruby-3 by using `Representable::Option` to handle `keyword_arguments` forwarding :tada:
+* Upgrade `representable` and `disposable` dependencies which uses `trailblazer-option` over `declarative-option`.
+* Deprecate populator's callable signature which accepts `form` as a separate positional argument. Make all callable (proc, method, `Uber::Callable`) signatures identical.
+
+## 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`
+
+## 2.3.2
+
+* Fix Validation block option :form incorrectly memoized between tests
+
+## 2.3.1
+* With dry-validation 1.5 the form is always injected. Just add option :form to access it in the schema.
+* Removed global monkey patching of Dry::Schema::DSL
+* Tests in ruby 2.7
+
 ## 2.3.0
 
 You can upgrade from 2.2.0 without worries.

data/Gemfile

@@ -2,10 +2,4 @@ source "https://rubygems.org"
 
 gemspec
 
-# gem "disposable", path: "../disposable"
-
-# just trying to add `dry-monads` correct version in base on dry-validation
-dry_v_version = ENV.fetch('DRY_VALIDATION', '~> 0.13.0')
-dry_m_version = "~> #{dry_v_version.gsub("~>", "").to_f}.0"
-gem 'dry-monads', dry_m_version if dry_v_version.gsub("~>", "").to_f >= 1
-gem 'dry-validation', ENV.fetch('DRY_VALIDATION', '~> 0.13.0')
+gem 'dry-validation', '~> 1.5.0'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 - 2016 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

@@ -1,24 +1,11 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
-require "rubocop/rake_task"
+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
-  dry_v_version = ENV.fetch("DRY_VALIDATION", "~> 0.13.0")
-  api = dry_v_version.gsub("~>", "").to_f >= 1.0 ? "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
-
-RuboCop::RakeTask.new(:rubocop)

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/form/populator.rb

@@ -7,7 +7,7 @@
 class Reform::Form::Populator
   def initialize(user_proc)
     @user_proc = user_proc # the actual `populator: ->{}` block from the user, via ::property.
-    @value     = Declarative::Option(user_proc, instance_exec: true, callable: Object) # we can now process Callable, procs, :symbol.
+    @value     = ::Representable::Option(user_proc) # we can now process Callable, procs, :symbol.
   end
 
   def call(input, options)
@@ -30,7 +30,17 @@ class Reform::Form::Populator
 
   def call!(options)
     form = options[:represented]
-    @value.(form, options) # Declarative::Option call.
+    evaluate_option(form, options)
+  end
+
+  def evaluate_option(form, options)
+    if @user_proc.is_a?(Uber::Callable) && @user_proc.method(:call).arity == 2 # def call(form, options)
+      warn %{[Reform] Accepting `form` as a positional argument in `:populator` will be deprecated. Please use `def call(form:, **options)` signature instead.}
+
+      return @value.(form, exec_context: form, keyword_arguments: options)
+    end
+
+    @value.(exec_context: form, keyword_arguments: options.merge(form: form)) # Representable::Option call
   end
 
   def handle_fail(twin, options)
@@ -66,7 +76,7 @@ class Reform::Form::Populator
       return @user_proc.new if @user_proc.is_a?(Class) # handle populate_if_empty: Class. this excludes using Callables, though.
 
       deprecate_positional_args(form, @user_proc, options) do
-        @value.(form, options)
+        evaluate_option(form, options)
       end
     end
 

data/lib/reform/form/prepopulate.rb

@@ -13,7 +13,7 @@ module Reform::Form::Prepopulate
   def prepopulate_local!(options)
     schema.each do |dfn|
       next unless block = dfn[:prepopulator]
-      Declarative::Option(block, instance_exec: true).(self, options)
+      ::Representable::Option(block).(exec_context: self, keyword_arguments: options)
     end
   end
 

data/lib/reform/form/validate.rb

@@ -4,15 +4,15 @@ module Reform::Form::Validate
     class AllBlank
       include Uber::Callable
 
-      def call(form, options)
+      def call(input:, binding:, **)
         # TODO: Schema should provide property names as plain list.
         # ensure param keys are strings.
-        params = options[:input].each_with_object({}) { |(k, v), hash|
+        params = input.each_with_object({}) { |(k, v), hash|
           hash[k.to_s] = v
         }
 
         # return false if any property inputs are populated.
-        options[:binding][:nested].definitions.each do |definition|
+        binding[:nested].definitions.each do |definition|
           value = params[definition.name.to_s]
           return false if (!value.nil? && value != '')
         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.0.rc2".freeze
+  VERSION = "2.6.0".freeze
 end

data/reform.gemspec

@@ -17,15 +17,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency             "disposable",     ">= 0.4.2", "< 0.5.0"
-  spec.add_dependency             "representable",  ">= 2.4.0", "< 3.1.0"
+  spec.add_dependency             "disposable",     "~> 0.5.0"
+  spec.add_dependency             "representable",  ">= 3.1.1", "< 3.2.0"
   spec.add_dependency             "uber",           "< 0.2.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-line"
-  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "multi_json"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rubocop"
 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