reform 2.3.0.rc1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 833e85f6efec80dfacc227371dfb5ec4fe5d1fdd
-  data.tar.gz: e084df9fc8f080155d3af4398a80c78347db5b78
+SHA256:
+  metadata.gz: e0b6b3c1dbb48304ae8b36f5fbc12d9f7149edc61b40757017472b3eb01cf04f
+  data.tar.gz: 689811ffa73a062d4e598d8a36b6258571350d1ce4c5c87c85db9707313dde04
 SHA512:
-  metadata.gz: dba35a83313b4f5a2cecde6d85800b19c83f5b55553d2600e448ca042f1a8429a85b26ff3d522aa95b308bc1fadba731bb7a550cbe81e3ebab02d4c2052a4de8
-  data.tar.gz: cac8a4bddbbbef87379fd823bcfccce351fb9a0af36448d36d092393abaebcabc5343cc1665a68652a570bc7e765593ae0c873912033166d870e729962bddf70
+  metadata.gz: a797c79e164c4c1791661a97163d4e89b1b2e49ae4992e1c0a59eb427d98ddfdbdae96292f455f843acacc869b5053916afa7131018843c66f4d886e6872c372
+  data.tar.gz: 82fe647e1ab34dcc24e85250d5876b88b84ea3a991cdfb163bf0dd616be701105ab1ca87065285bc0e32abe9f67ccdb3cda103c7f70143e49d0a8c3024baa75e

data/.gitignore

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

data/.travis.yml

@@ -2,16 +2,12 @@ language: ruby
 cache: bundler
 bundler_args: --without benchmarks tools
 rvm:
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
-  - 2.4.0
+  - ruby-head
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4
 matrix:
   fast_finish: true
-notifications:
-  webhooks:
-    urls:
-      - https://webhooks.gitter.im/e/680e86d98056f2ae2fd7
-    on_success: change  # options: [always|never|change] default: always
-    on_failure: always  # options: [always|never|change] default: always
-    on_start: never     # options: [always|never|change] default: always
+  allow_failures:
+    - rvm: ruby-head

data/CHANGES.md

@@ -1,8 +1,25 @@
-## 3.0.0
+## 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.
@@ -17,10 +34,33 @@ You can upgrade from 2.2.0 without worries.
 * Reform now maintains a generic `Dry::Schema` class for global schema configuration. Can be overridden via `::validation`.
 * When validating with dry-validation, we now pass a symbolized hash. We also replaced `Dry::Validation::Form` with `Schema` which won't coerce values where it shouldn't.
 * [private] `Group#call` API now is: `call(form, errors)`.
-* Removed `Form#valid?`.
-
+* Modify `Form#valid?` - simply calls `validate({})`.
 * In `:if` for validation groups, you now get a hash of result objects, not just true/false.
+* Allow adding a custom error AFTER validate has been already called
+
+Compatibility with `dry-validation` with 1.x:
+* [CHANGE] seems like "custom" predicate are not supported by `dry-schema` anymore or better the same result is reached using the `rule` method:
+  Something like this:
+  ```ruby
+  validation do
+    def a_song?(value)
+       value == :really_cool_song
+    end
 
+    required(:songs).filled(:a_song?)
+  end
+  ```
+  will be something like:
+  ```ruby
+  validation do
+    required(:songs).filled
+
+    rule(:songs) do
+      key.failure(:a_song?) unless value == :really_cool_song
+    end
+  end
+  ```
+* [BREAKING] inheriting/merging/overriding schema/rules is not supported by `dry-v` so the `inherit:` option is **NOT SUPPORTED** for now. Also extend a `schema:` option using a block is **NOT SUPPORTED** for now. Possible workaround is to use reform module to compose different validations but this won't override existing validations but just merge them
 
 ## 2.2.4
 

data/Gemfile

@@ -1,8 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem "minitest-line"
-gem 'byebug'
-# gem "disposable", path: "../disposable"
-
+gem 'dry-validation', '~> 1.5.0'

data/ISSUE_TEMPLATE.md

@@ -1,6 +1,6 @@
 Note: If you have a question about Reform, would like help using
 Reform, want to request a feature, or do anything else other than
-submit a bug report, please use the Trailblazer gitter channel.
+submit a bug report, please use the [Trailblazer gitter channel](https://gitter.im/trailblazer/chat).
 
 Note: Rails/ ActiveRecord/ ActiveModel support.
 As of Reform 2.2.0 all Rails/ Active-* code was moved to the [reform-rails](https://github.com/trailblazer/reform-rails) gem.

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,18 +313,16 @@ 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).
 
-<a href="https://leanpub.com/trailblazer">
-![](http://trailblazer.to/images/3dbuch-freigestellt.png)
-</a>
+[![](http://trailblazer.to/images/3dbuch-freigestellt.png)](https://leanpub.com/trailblazer)
 
 Reform is part of the [Trailblazer project](http://trailblazer.to). Please [buy my book](https://leanpub.com/trailblazer) to support the development and learn everything about Reform - there's two chapters dedicated to Reform!
 
 
 ## Security And Strong_parameters
 
-By explicitely defining the form layout using `::property` there is no more need for protecting from unwanted input. `strong_parameter` or `attr_accessible` become obsolete. Reform will simply ignore undefined incoming parameters.
+By explicitly defining the form layout using `::property` there is no more need for protecting from unwanted input. `strong_parameter` or `attr_accessible` become obsolete. Reform will simply ignore undefined incoming parameters.
 
 ## This is not Reform 1.x!
 
@@ -332,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,15 +1,11 @@
 require "bundler/gem_tasks"
-require 'rake/testtask'
+require "rake/testtask"
+require "dry/types/version"
 
-task :default => [:test]
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'test'
-  test.test_files = FileList['test/*_test.rb'] + FileList["test/validation/*_test.rb"]
-  test.verbose = true
-end
+task default: %i[test]
 
-Rake::TestTask.new(:test_rails) do |test|
-  test.libs << 'test'
-  test.test_files = FileList['test/rails/*_test.rb']
+Rake::TestTask.new(:test) do |test|
+  test.libs << "test"
+  test.test_files = FileList["test/**/*_test.rb"]
   test.verbose = true
 end

data/lib/reform/contract.rb

@@ -1,9 +1,8 @@
-require "uber/inheritable_attr"
-
 module Reform
   # Define your form structure and its validations. Instantiate it with a model,
   # and then +validate+ this object graph.
   class Contract < Disposable::Twin
+    require "reform/contract/custom_error"
     require "disposable/twin/composition" # Expose.
     include Expose
 
@@ -15,7 +14,7 @@ module Reform
       Contract
     end
 
-    def self.property(name, options={}, &block)
+    def self.property(name, options = {}, &block)
       if twin = options.delete(:form)
         options[:twin] = twin
       end
@@ -33,7 +32,7 @@ module Reform
     end
 
     require "reform/result"
-    require 'reform/contract/validate'
+    require "reform/contract/validate"
     include Reform::Contract::Validate
 
     require "reform/validation"
@@ -43,14 +42,16 @@ module Reform
     require "disposable/twin/sync"
     include Disposable::Twin::Sync
 
-  private
+    private
+
     # DISCUSS: separate file?
     module Readonly
       def readonly?(name)
         options_for(name)[:writeable] == false
       end
+
       def options_for(name)
-       self.class.options_for(name)
+        self.class.options_for(name)
       end
     end
 
@@ -59,7 +60,6 @@ module Reform
     end
     include Readonly
 
-
     def self.clone # TODO: test. THIS IS ONLY FOR Trailblazer when contract gets cloned in suboperation.
       Class.new(self)
     end

data/lib/reform/contract/custom_error.rb

@@ -0,0 +1,41 @@
+module Reform
+  class Contract < Disposable::Twin
+    # a "fake" Dry schema object to add into the @results array
+    # super ugly hack required for 2.3.x version since we are creating
+    # a new Reform::Errors instance every time we call form.errors
+    class CustomError
+      def initialize(key, error_text, results)
+        @key        = key
+        @error_text = error_text
+        @errors     = {key => Array(error_text)}
+        @messages   = @errors
+        @hint       = {}
+        @results    = results
+
+        merge!
+      end
+
+      attr_reader :messages, :hint
+
+      def success?
+        false
+      end
+
+      def failure?
+        true
+      end
+
+      # dry 1.x errors method has 1 kwargs argument
+      def errors(**_args)
+        @errors
+      end
+
+      def merge!
+        # to_h required for dry_v 1.x since the errors are Dry object instead of an hash
+        @results.map(&:errors)
+                .detect { |hash| hash.to_h.key?(@key) }
+                .tap { |hash| hash.nil? ? @results << self : hash.to_h[@key] |= Array(@error_text) }
+      end
+    end
+  end
+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
@@ -22,7 +22,11 @@ class Reform::Contract < Disposable::Twin
       @result
     end
 
-    def validate!(name, pointers=[])
+    def custom_errors
+      @result.to_results.select { |result| result.is_a? Reform::Contract::CustomError }
+    end
+
+    def validate!(name, pointers = [])
       # run local validations. this could be nested schemas, too.
       local_errors_by_group = Reform::Validation::Groups::Validate.(self.class.validation_groups, self).compact # TODO: discss compact
 
@@ -33,10 +37,10 @@ class Reform::Contract < Disposable::Twin
       nested_errors = validate_nested!(pointers_for_nested)
 
       # Result: unified interface #success?, #messages, etc.
-      @result = Result.new(local_errors_by_group + pointers, nested_errors)
+      @result = Result.new(custom_errors + local_errors_by_group + pointers, nested_errors)
     end
 
-  private
+    private
 
     # Recursively call validate! on nested forms.
     # A pointer keeps an entire result object (e.g. Dry result) and
@@ -46,11 +50,11 @@ class Reform::Contract < Disposable::Twin
 
       schema.each(twin: true) do |dfn|
         # on collections, this calls validate! on each item form.
-        Disposable::Twin::PropertyProcessor.new(dfn, self).() { |form, i|
+        Disposable::Twin::PropertyProcessor.new(dfn, self).() do |form, i|
           nested_pointers = pointers.collect { |pointer| pointer.advance(dfn[:name].to_sym, i) }.compact # pointer contains fragment for us, so go deeper
 
           arr << form.validate!(dfn[:name], nested_pointers)
-        }
+        end
       end
 
       arr

data/lib/reform/errors.rb

@@ -12,15 +12,14 @@ class Reform::Contract::Result::Errors
   # PROTOTYPING. THIS WILL GO TO A SEPARATE GEM IN REFORM 2.4/3.0.
   DottedErrors = ->(form, prefix, hash) do
     result = form.to_result
-    result.messages.collect { |k,v| hash[ [*prefix, k].join(".").to_sym] = v }
+    result.messages.collect { |k, v| hash[[*prefix, k].join(".").to_sym] = v }
 
-    form.schema.each(twin: true) { |dfn|
+    form.schema.each(twin: true) do |dfn|
       Disposable::Twin::PropertyProcessor.new(dfn, form).() do |frm, i|
-        # DottedErrors.(form.send(dfn[:name])[i], [*prefix, dfn[:name], i], hash) and next if i
-        DottedErrors.(form.send(dfn[:name])[i], [*prefix, dfn[:name]], hash) and next if i
-        DottedErrors.(form.send(dfn[:name]), [*prefix, dfn[:name]], hash)
+        form_obj = i ? form.send(dfn[:name])[i] : form.send(dfn[:name])
+        DottedErrors.(form_obj, [*prefix, dfn[:name]], hash)
       end
-    }
+    end
   end
 
   def messages(*args)
@@ -28,22 +27,35 @@ class Reform::Contract::Result::Errors
   end
 
   def full_messages
-		@dotted_errors.collect do |path, errors|
-			human_field = path.to_s.gsub(/([\.\_])+/, " ").gsub(/(\b\w)+/) { |s| s.capitalize }
-			errors.collect { |message| "#{human_field} #{message}" }
-		end.flatten
+	  @dotted_errors.collect { |path, errors|
+		  human_field = path.to_s.gsub(/([\.\_])+/, " ").gsub(/(\b\w)+/) { |s| s.capitalize }
+			 errors.collect { |message| "#{human_field} #{message}" }
+		}.flatten
   end
 
   def [](name)
-  	@dotted_errors[name]
+  	@dotted_errors[name] || []
   end
 
   def size
     messages.size
   end
+
+  # needed for rails form helpers
+  def empty?
+    messages.empty?
+  end
+
+  # we need to delegate adding error to result because every time we call form.errors
+  # a new instance of this class is created so we need to update the @results array
+  # to be able to add custom errors here.
+  # This method will actually work only AFTER a validate call has been made
+  def add(key, error_test)
+    @result.add_error(key, error_test)
+  end
 end
 
-    # Ensure that we can return Active Record compliant full messages when using dry
-    # we only want unique messages in our array
-    #
-    # @full_errors.add()
+# Ensure that we can return Active Record compliant full messages when using dry
+# we only want unique messages in our array
+#
+# @full_errors.add()

data/lib/reform/form.rb

@@ -1,5 +1,7 @@
 module Reform
   class Form < Contract
+    class InvalidOptionsCombinationError < StandardError; end
+
     def self.default_nested_class
       Form
     end
@@ -15,23 +17,32 @@ module Reform
 
     module Property
       # Add macro logic, e.g. for :populator.
-      def property(name, options={}, &block)
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
+      def property(name, options = {}, &block)
+        if (options.keys & %i[skip_if populator]).size == 2
+          raise InvalidOptionsCombinationError.new(
+            "[Reform] #{self}:property:#{name} Do not use skip_if and populator together, use populator with skip! instead"
+          )
+        end
+
         # if composition and inherited we also need this setting
         # to correctly inherit modules
-        if options.key?(:on) && options.key?(:inherit)
-          options[:_inherited] = options[:inherit]
-        end
+        options[:_inherited] = options[:inherit] if options.key?(:on) && options.key?(:inherit)
 
         if options.key?(:parse)
           options[:deserializer] ||= {}
           options[:deserializer][:writeable] = options.delete(:parse)
         end
 
-        if options.key?(:writable)
-          options[:writeable] ||= options.delete(:writable)
+        options[:writeable] ||= options.delete(:writable) if options.key?(:writable)
+
+        # for virtual collection we need at least to have the collection equal to [] to
+        # avoid issue when the populator
+        if (options.keys & %i[collection virtual]).size == 2
+          options = { default: [] }.merge(options)
         end
 
-        definition = super # let disposable and declarative gems sort out inheriting of properties, and so on.
+        definition = super # letdisposable and declarative gems sort out inheriting of properties, and so on.
         definition.merge!(deserializer: {}) unless definition[:deserializer] # always keep :deserializer per property.
 
         deserializer_options = definition[:deserializer]
@@ -48,7 +59,7 @@ module Reform
         external_populator = Populator::External.new
 
         # always compute a parse_pipeline for each property of the deserializer and inject it via :parse_pipeline.
-        # first, let representable compute the pipeline functions by invoking #parse_functions.
+        # first, letrepresentable compute the pipeline functions by invoking #parse_functions.
         if definition[:nested]
           parse_pipeline = ->(input, opts) do
             functions = opts[:binding].send(:parse_functions)
@@ -65,7 +76,7 @@ module Reform
             pipeline  = Representable::Pipeline[*functions] # Pipeline[StopOnExcluded, AssignName, ReadFragment, StopOnNotFound, OverwriteOnNil, Collect[#<Representable::Function::CreateObject:0xa6148ec>, #<Representable::Function::Decorate:0xa6148b0>, Deserialize], Set]
 
             # FIXME: this won't work with property :name, inherit: true (where there is a populator set already).
-            pipeline  = Representable::Pipeline::Insert.(pipeline, external_populator,            replace: Representable::SetValue) if definition[:populator] # FIXME: only diff to options without :populator
+            pipeline  = Representable::Pipeline::Insert.(pipeline, external_populator, replace: Representable::SetValue) if definition[:populator] # FIXME: only diff to options without :populator
             pipeline
           end
         end
@@ -77,12 +88,12 @@ module Reform
           deserializer_options.merge!(skip_parse: proc) # TODO: same with skip_parse ==> External
         end
 
-
         # per default, everything should be writeable for the deserializer (we're only writing on the form). however, allow turning it off.
-        deserializer_options.merge!(writeable: true) unless deserializer_options.has_key?(:writeable)
+        deserializer_options.merge!(writeable: true) unless deserializer_options.key?(:writeable)
 
         definition
       end
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
     end
     extend Property