reform 2.2.4 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 851795d3f1959935496c4a582f24dffc6020b848
-  data.tar.gz: f62755eb2d9e6302a00790b703698149838474af
+SHA256:
+  metadata.gz: 0f5d5dea8c04f5d993a91776afffea2a0b48603d850c11204d04e79248be6cf8
+  data.tar.gz: e4132e9db35384198bf31797b8620219c6418df4781a8f5300bbcf38c1a1c630
 SHA512:
-  metadata.gz: 865c755aea555fedc28f61ae04a7903544ad637c621e656c68a64fc9f952b0a105906f4abc77571dce490099227224cd966c12ccc802b8ae7e830c0b27d108f3
-  data.tar.gz: a90c092125bd9f2a7db2a6092267ba3ac439c6d92bd3b2e657a50156128c4de5b8f28e3f62cc2eefc47b6a8f36b1e8d5f94e393f31ab115cf297a60210fc58c4
+  metadata.gz: '0845ada0bbafc7c3a45485d51f93c66c8616bee7b23c851712d297be20c73e82f23a8e575f803adb2972c382c4c9003951ae8d788fe12df87195950490505028'
+  data.tar.gz: bd463ddb326f4db34ef9ad6948cdb9466a56c87514f2a18fcafba6dff29b54baf5640b97b490657b92e438c336869f35adc3e407b91be80351f427fd84f28c35

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-https*
+.byebug_history
+.idea
+*.iml
+gemfiles/*.gemfile.lock

data/.travis.yml

@@ -1,11 +1,16 @@
 language: ruby
+cache: bundler
+bundler_args: --without benchmarks tools
 rvm:
-  - 2.2.3
-  - 2.0.0
+  - ruby-head
+  - 2.7
+  - 2.6
+  - 2.5
+  - 2.4
 gemfile:
-  - gemfiles/Gemfile.disposable-0.3
-
+  - gemfiles/1.5.0.gemfile
+  - gemfiles/0.13.0.gemfile
 matrix:
   fast_finish: true
-before_install:
-  - gem install bundler
+  allow_failures:
+    - rvm: ruby-head

data/Appraisals

@@ -0,0 +1,8 @@
+appraise "1.5.0" do
+  gem 'dry-monads', "1.3.5"
+  gem 'dry-validation', '~> 1.5.0'
+end
+
+appraise "0.13.0" do
+  gem 'dry-validation', '~> 0.13.0'
+end

data/CHANGES.md

@@ -1,9 +1,62 @@
+## 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.
+
+* Require Representable 3.0.0 and **removed Representable 2.4 deprecation code**.
+* Require Disposable 0.4.0 which fixes issues with `nil` field values, `sync {}` and dry-validation.
+* Fix boolean coercion.
+* Allow using `:populator` classes marked with `Uber::Callable`.
+* Introduce `parse: false` as a shortcut for `deserialzer: { writeable: false}`. Thanks to @pabloh for insisting on this handy change.
+* Memoize the deserializer instance on the class level via `::deserializer`. This saves the inferal of a deserializing representer and speeds up following calls by 130%.
+* Deprecated positional arguments for `validation :default, options: {}`. New API: `validation name: :default, **`.
+* 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)`.
+* 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
 
-* Always require `disposable` >= 0.4.1. 
-  
-  The only difference here is that `Form#sync`/`#save` with a block will include `nil` properties into the nested hash.
-* Remove `uber` dependency.
+* You can now use any object with `call` as a populator, no need to `include Uber::Callable` anymore. This is because we have only three types and don't need a `is_a?` or `respond_to?` check.
+* Use `declarative-option` and loosen `uber` dependency.
 
 ## 2.2.3
 

data/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+## How to contribute to Reform
+
+#### **Did you find a bug?**
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/trailblazer/reform/issues).
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/trailblazer/reform/issues/new). Be sure to follow the issue template.
+
+#### **Did you write a patch that fixes a bug?**
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+* All code in pull requests is assumed to be MIT licensed.  Do not submit a pull request if that isn't the case.
+
+#### **Do you intend to add a new feature or change an existing one?**
+
+* Suggest your change in the [Trailblazer Gitter Room](https://gitter.im/trailblazer/chat) and start writing code.
+
+* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
+
+#### **Do you have questions using Reform?**
+
+* Ask any questions about how to use Reform in the [Trailblazer Gitter Room](https://gitter.im/trailblazer/chat). Github issues are restricted to bug reports and fixes.
+
+* GitHub Issues should not be used as a help forum and any such issues will be closed.
+
+#### **Do you want to contribute to the Reform documentation?**
+
+* Reform documentation is provided via the [Trailblazer site](http://trailblazer.to/gems/reform/) and not the repository readme. Please add your contributions to the [Trailblazer site repository](https://github.com/trailblazer/trailblazer.github.io)

data/Gemfile

@@ -1,19 +1,5 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-
-# gem "representable", "2.4.0.rc5"
-# gem 'representable', path: "../representable"
-# # gem 'representable', github: "apotonick/representable"
-# gem "disposable", path: "../disposable"
-# gem "disposable", github: "apotonick/disposable"
-
-
-# gem "declarative", path: "../declarative"
-
-gem "minitest-line"
-gem 'byebug'
-
-# gem "uber", path: "../uber"
-gem "representable", ">= 3.0.1"
+gem "appraisal", "~> 2.2"

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,25 @@
+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](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.
+Make sure you are contributing to the correct gem!
+
+### Complete Description of Issue
+
+
+### Steps to reproduce
+
+
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### System configuration
+**Reform version**:
+
+### Full Backtrace of Exception (if any)
+

data/LICENSE.txt

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

data/README.md

@@ -3,7 +3,7 @@
 [![Gitter Chat](https://badges.gitter.im/trailblazer/chat.svg)](https://gitter.im/trailblazer/chat)
 [![TRB Newsletter](https://img.shields.io/badge/TRB-newsletter-lightgrey.svg)](http://trailblazer.to/newsletter/)
 [![Build
-Status](https://travis-ci.org/apotonick/reform.svg)](https://travis-ci.org/apotonick/reform)
+Status](https://travis-ci.org/trailblazer/reform.svg)](https://travis-ci.org/trailblazer/reform)
 [![Gem Version](https://badge.fury.io/rb/reform.svg)](http://badge.fury.io/rb/reform)
 
 _Form objects decoupled from your models._
@@ -296,7 +296,7 @@ Put this in an initializer or on top of your script.
 Reform allows to map multiple models to one form. The [complete documentation](https://github.com/apotonick/disposable#composition) is here, however, this is how it works.
 
 ```ruby
-class AlbumTwin < Reform::Form
+class AlbumForm < Reform::Form
   include Composition
 
   property :id,    on: :album
@@ -315,20 +315,18 @@ AlbumForm.new(album: album, cd: CD.find(1))
 
 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).
 
-<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!
 
-Temporary note: This is the README and API for Reform 2. On the public API, only a few tiny things have changed. Here are the [Reform 1.2 docs](https://github.com/apotonick/reform/blob/v1.2.6/README.md).
+Temporary note: This is the README and API for Reform 2. On the public API, only a few tiny things have changed. Here are the [Reform 1.2 docs](https://github.com/trailblazer/reform/blob/v1.2.6/README.md).
 
 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).
 

data/Rakefile

@@ -1,15 +1,22 @@
 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
+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_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"] + FileList["test/validation/*_test.rb"] + dry_v_test_files
   test.verbose = true
 end
+

data/gemfiles/0.13.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.2"
+gem "dry-validation", "~> 0.13.0"
+
+gemspec path: "../"

data/gemfiles/1.5.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.2"
+gem "dry-monads", "1.3.5"
+gem "dry-validation", "~> 1.5.0"
+
+gemspec path: "../"

data/lib/reform.rb

@@ -6,3 +6,4 @@ require "reform/contract"
 require "reform/form"
 require "reform/form/composition"
 require "reform/form/module"
+require "reform/errors" # TODO: remove in Reform 3.

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
@@ -27,14 +26,13 @@ module Reform
       super
     end
 
-    # FIXME: test me.
     def self.properties(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
       args.each { |name| property(name, options.dup) }
     end
 
-    require "reform/contract/errors"
-    require 'reform/contract/validate'
+    require "reform/result"
+    require "reform/contract/validate"
     include Reform::Contract::Validate
 
     require "reform/validation"
@@ -44,23 +42,16 @@ module Reform
     require "disposable/twin/sync"
     include Disposable::Twin::Sync
 
+    private
 
-
-    # module ValidatesWarning
-    #   def validates(*)
-    #     raise "[Reform] Please include either Reform::Form::ActiveModel::Validations or Reform::Form::Lotus in your form class."
-    #   end
-    # end
-    # extend ValidatesWarning
-
-  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
 
@@ -69,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

@@ -1,33 +1,63 @@
-module Reform::Contract::Validate
-  def initialize(*)
-    super
-    @errors = build_errors
-  end
+class Reform::Contract < Disposable::Twin
+  module Validate
+    def initialize(*)
+      # this will be removed in Reform 3.0. we need this for the presenting form, form builders
+      # call the Form#errors method before validation.
+      super
+      @result = Result.new([])
+    end
 
-  attr_reader :errors
+    def validate
+      validate!(nil).success?
+    end
 
-  def validate
-    validate!(errors, [])
+    # The #errors method will be removed in Reform 2.4/3.0 core.
+    def errors(*args)
+      Result::Errors.new(@result, self)
+    end
 
-    errors.empty?
-  end
+    #:private:
+    # only used in tests so far. this will be the new API in #call, where you will get @result.
+    def to_result
+      @result
+    end
+
+    def custom_errors
+      @result.to_results.select { |result| result.is_a? Reform::Contract::CustomError }
+    end
 
-  def validate!(errors, prefix)
-    validate_nested!(nested_errors = build_errors, prefix) # call valid? recursively and collect nested errors.
+    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
 
-    valid?  # calls AM/Lotus validators and invokes self.errors=.
+      # blindly add injected pointers. will be readable via #errors.
+      # also, add pointers from local errors here.
+      pointers_for_nested = pointers + local_errors_by_group.collect { |errs| Result::Pointer.new(errs, []) }.compact
 
-    errors.merge!(self.errors, prefix) # local errors.
-    errors.merge!(nested_errors, [])
-  end
+      nested_errors = validate_nested!(pointers_for_nested)
+
+      # Result: unified interface #success?, #messages, etc.
+      @result = Result.new(custom_errors + local_errors_by_group + pointers, nested_errors)
+    end
+
+    private
+
+    # Recursively call validate! on nested forms.
+    # A pointer keeps an entire result object (e.g. Dry result) and
+    # the relevant path to its fragment, e.g. <Dry::result{.....} path=songs,0>
+    def validate_nested!(pointers)
+      arr = []
+
+      schema.each(twin: true) do |dfn|
+        # on collections, this calls validate! on each item form.
+        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
 
-private
+          arr << form.validate!(dfn[:name], nested_pointers)
+        end
+      end
 
-  # runs form.validate! on all nested forms
-  def validate_nested!(errors, prefixes)
-    schema.each(twin: true) do |dfn|
-      # recursively call valid? on nested form.
-      Disposable::Twin::PropertyProcessor.new(dfn, self).() { |form| form.validate!(errors, prefixes+[dfn[:name]]) }
+      arr
     end
   end
-end
+end