reform 2.2.4 → 2.6.2

data/test/validation/result_test.rb

@@ -0,0 +1,77 @@
+require "test_helper"
+
+class ErrorsResultTest < Minitest::Spec
+  MyResult = Struct.new(:success?, :errors) do
+    def failure?; !success? end
+  end
+
+  # TODO: errors(args) not tested.
+
+  describe "Contract::Result#success?" do
+    let(:failed) { MyResult.new(false) }
+    let(:succeeded) { MyResult.new(true) }
+
+    it { assert_equal Reform::Contract::Result.new([failed, failed]).success?, false }
+    it { assert_equal Reform::Contract::Result.new([succeeded, failed]).success?, false }
+    it { assert_equal Reform::Contract::Result.new([failed, succeeded]).success?, false }
+    it { assert Reform::Contract::Result.new([succeeded, succeeded]).success? }
+  end
+
+  describe "Contract::Result#errors" do
+    let(:results) do
+      [
+        MyResult.new(false, {length: ["no Int"]}),
+        MyResult.new(false, {title: ["must be filled"], nested: {something: []}}),
+        MyResult.new(false, {title: ["must be filled"], nested: {something: []}}),
+        MyResult.new(false, {title: ["something more"], nested: {something: []}})
+      ]
+    end
+
+    it { assert_equal Reform::Contract::Result.new(results).errors, {title: ["must be filled", "something more"], length: ["no Int"]} }
+  end
+
+  describe "Result::Pointer" do
+    let(:errors) do # dry result #errors format.
+      {
+        title: ["ignore"],
+        artist: {age: ["too old"],
+          bands: {
+            0 => {name: "too new school"},
+            1 => {name: "too boring"},
+          }
+        }
+      }
+    end
+
+    let(:top) { Reform::Contract::Result::Pointer.new(MyResult.new(false, errors), []) }
+    it { assert_equal top.success?, false }
+    it { assert_equal top.errors, errors }
+
+    let(:artist) { Reform::Contract::Result::Pointer.new(MyResult.new(false, errors), [:artist]) }
+    it { assert_equal artist.success?, false }
+    it { assert_equal artist.errors,({age: ["too old"], bands: {0 => {name: "too new school"}, 1 => {name: "too boring"}}}) }
+
+    let(:band) { Reform::Contract::Result::Pointer.new(MyResult.new(false, errors), [:artist, :bands, 1]) }
+    it { assert_equal band.success?, false }
+    it { assert_equal band.errors,({name: "too boring"}) }
+
+    describe "advance" do
+      let(:advanced) { artist.advance(:bands, 1) }
+
+      it { assert_equal advanced.success?, false }
+      it { assert_equal advanced.errors,({name: "too boring"}) }
+
+      it { assert_nil artist.advance(%i[absolute nonsense]) }
+    end
+  end
+end
+
+# validation group:
+
+# form.errors/messages/hint(*args)            ==> {:title: [..]}
+#   @call_result.errors/messages/hint(*args) }
+
+# # result = Result(original_result => [:band, :label], my_local_result => [] )
+# # result.messages(locale: :en) merges original_result and my_local_result
+
+# form.errors => Result(fetch tree of all nested forms.messages(*args))

data/test/validation_library_provided_test.rb

@@ -0,0 +1,16 @@
+require "reform"
+require "minitest/autorun"
+
+class ValidationLibraryProvidedTest < MiniTest::Spec
+  it "no validation library loaded" do
+    assert_raises Reform::Validation::NoValidationLibraryError do
+      class PersonForm < Reform::Form
+        property :name
+
+        validation do
+          required(:name).maybe(:str?)
+        end
+      end
+    end
+  end
+end

data/test/virtual_test.rb

@@ -1,16 +1,20 @@
-require 'test_helper'
+require "test_helper"
 
 class VirtualTest < MiniTest::Spec
-  class CreditCardForm < Reform::Form
+  class CreditCardForm < TestForm
     property :credit_card_number, virtual: true # no read, no write, it's virtual.
+    collection :transactions, virtual: true, populate_if_empty: OpenStruct do
+      property :id
+    end
   end
 
-  let (:form) { CreditCardForm.new(Object.new) }
+  let(:form) { CreditCardForm.new(Object.new) }
 
   it {
-    form.validate("credit_card_number" => "123")
+    form.validate(credit_card_number: "123", transactions: [id: 1])
 
-    form.credit_card_number.must_equal "123"  # this is still readable in the UI.
+    assert_equal form.credit_card_number, "123" # this is still readable in the UI.
+    assert_equal form.transactions.first.id, 1 # this is still readable in the UI.
 
     form.sync
 
@@ -19,6 +23,42 @@ class VirtualTest < MiniTest::Spec
       hash = nested
     end
 
-    hash.must_equal("credit_card_number"=> "123")
+    assert_equal hash, "credit_card_number" => "123", "transactions" => ["id" => 1]
+  }
+end
+
+class VirtualAndDefaultTest < MiniTest::Spec
+  class CreditCardForm < TestForm
+    property :credit_card_number, virtual: true, default: "123" # no read, no write, it's virtual.
+    collection :transactions, virtual: true, populate_if_empty: OpenStruct, default: [OpenStruct.new(id: 2)] do
+      property :id
+    end
+  end
+
+  def hash(form)
+    hash = {}
+    form.save do |nested|
+      hash = nested
+    end
+    hash
+  end
+
+  let(:form) { CreditCardForm.new(Object.new) }
+
+  it {
+    form = CreditCardForm.new(Object.new)
+    form.validate({})
+
+    assert_equal hash(form), "credit_card_number" => "123", "transactions" => ["id" => 2]
+
+    form = CreditCardForm.new(Object.new)
+    form.validate(credit_card_number: "123", transactions: [id: 1])
+
+    assert_equal form.credit_card_number,  "123" # this is still readable in the UI.
+    assert_equal form.transactions.first.id,  1 # this is still readable in the UI.
+
+    form.sync
+
+    assert_equal hash(form), "credit_card_number" => "123", "transactions" => ["id" => 1]
   }
-end
+end

data/test/writeable_test.rb

@@ -1,29 +1,58 @@
-require 'test_helper'
+require "test_helper"
 
 class WriteableTest < MiniTest::Spec
   Location = Struct.new(:country)
 
-  class LocationForm < Reform::Form
+  class LocationForm < TestForm
     property :country, writeable: false
   end
 
-  let (:loc) { Location.new("Australia") }
-  let (:form) { LocationForm.new(loc) }
+  let(:loc) { Location.new("Australia") }
+  let(:form) { LocationForm.new(loc) }
 
   it do
-    form.country.must_equal "Australia"
+    assert_equal form.country, "Australia"
 
     form.validate("country" => "Germany") # this usually won't change when submitting.
-    form.country.must_equal "Germany"
+    assert_equal form.country, "Germany"
 
     form.sync
-    loc.country.must_equal "Australia" # the writer wasn't called.
+    assert_equal loc.country, "Australia" # the writer wasn't called.
 
     hash = {}
     form.save do |nested|
       hash = nested
     end
 
-    hash.must_equal("country"=> "Germany")
+    assert_equal hash, "country" => "Germany"
   end
-end
+end
+
+# writable option is alias of writeable option.
+class WritableTest < MiniTest::Spec
+  Location = Struct.new(:country)
+
+  class LocationForm < TestForm
+    property :country, writable: false
+  end
+
+  let(:loc) { Location.new("Australia") }
+  let(:form) { LocationForm.new(loc) }
+
+  it do
+    assert_equal form.country, "Australia"
+
+    form.validate("country" => "Germany") # this usually won't change when submitting.
+    assert_equal form.country, "Germany"
+
+    form.sync
+    assert_equal loc.country, "Australia" # the writer wasn't called.
+
+    hash = {}
+    form.save do |nested|
+      hash = nested
+    end
+
+    assert_equal hash, "country" => "Germany"
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: reform
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.6.2
 platform: ruby
 authors:
 - Nick Sutterer
-- Garrett Heinlen
+- Fran Worley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2022-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: disposable
@@ -17,50 +17,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: representable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 3.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 3.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: uber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.2.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -88,7 +94,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-types
+  name: minitest-line
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,52 +122,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: dry-validation
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0'
 description: Form object decoupled from models.
 email:
 - apotonick@gmail.com
-- heinleng@gmail.com
+- frances@safetytoolbox.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGES.md
+- CONTRIBUTING.md
 - Gemfile
+- ISSUE_TEMPLATE.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - TODO.md
-- gemfiles/Gemfile.disposable-0.3
 - lib/reform.rb
 - lib/reform/contract.rb
-- lib/reform/contract/errors.rb
+- lib/reform/contract/custom_error.rb
 - lib/reform/contract/validate.rb
+- lib/reform/errors.rb
 - lib/reform/form.rb
 - lib/reform/form/call.rb
 - lib/reform/form/coercion.rb
 - lib/reform/form/composition.rb
 - lib/reform/form/dry.rb
+- lib/reform/form/dry/input_hash.rb
 - lib/reform/form/module.rb
-- lib/reform/form/mongoid.rb
-- lib/reform/form/orm.rb
 - lib/reform/form/populator.rb
 - lib/reform/form/prepopulate.rb
 - lib/reform/form/validate.rb
-- lib/reform/mongoid.rb
+- lib/reform/result.rb
 - lib/reform/validation.rb
 - lib/reform/validation/groups.rb
 - lib/reform/version.rb
@@ -171,10 +178,11 @@ files:
 - test/changed_test.rb
 - test/coercion_test.rb
 - test/composition_test.rb
+- test/contract/custom_error_test.rb
 - test/contract_test.rb
 - test/default_test.rb
-- test/deprecation_test.rb
 - test/deserialize_test.rb
+- test/docs/validation_test.rb
 - test/errors_test.rb
 - test/feature_test.rb
 - test/fixtures/dry_error_messages.yml
@@ -183,13 +191,13 @@ files:
 - test/from_test.rb
 - test/inherit_test.rb
 - test/module_test.rb
+- test/parse_option_test.rb
 - test/parse_pipeline_test.rb
 - test/populate_test.rb
 - test/populator_skip_test.rb
 - test/prepopulator_test.rb
 - test/read_only_test.rb
 - test/readable_test.rb
-- test/readonly_test.rb
 - test/reform_test.rb
 - test/save_test.rb
 - test/setup_test.rb
@@ -197,12 +205,12 @@ files:
 - test/skip_setter_and_getter_test.rb
 - test/test_helper.rb
 - test/validate_test.rb
-- test/validation/dry_test.rb
 - test/validation/dry_validation_test.rb
-- test/validation/errors.yml
+- test/validation/result_test.rb
+- test/validation_library_provided_test.rb
 - test/virtual_test.rb
 - test/writeable_test.rb
-homepage: https://github.com/apotonick/reform
+homepage: https://github.com/trailblazer/reform
 licenses:
 - MIT
 metadata: {}
@@ -221,8 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Form object decoupled from models with validation, population and presentation.
@@ -232,10 +239,11 @@ test_files:
 - test/changed_test.rb
 - test/coercion_test.rb
 - test/composition_test.rb
+- test/contract/custom_error_test.rb
 - test/contract_test.rb
 - test/default_test.rb
-- test/deprecation_test.rb
 - test/deserialize_test.rb
+- test/docs/validation_test.rb
 - test/errors_test.rb
 - test/feature_test.rb
 - test/fixtures/dry_error_messages.yml
@@ -244,13 +252,13 @@ test_files:
 - test/from_test.rb
 - test/inherit_test.rb
 - test/module_test.rb
+- test/parse_option_test.rb
 - test/parse_pipeline_test.rb
 - test/populate_test.rb
 - test/populator_skip_test.rb
 - test/prepopulator_test.rb
 - test/read_only_test.rb
 - test/readable_test.rb
-- test/readonly_test.rb
 - test/reform_test.rb
 - test/save_test.rb
 - test/setup_test.rb
@@ -258,8 +266,8 @@ test_files:
 - test/skip_setter_and_getter_test.rb
 - test/test_helper.rb
 - test/validate_test.rb
-- test/validation/dry_test.rb
 - test/validation/dry_validation_test.rb
-- test/validation/errors.yml
+- test/validation/result_test.rb
+- test/validation_library_provided_test.rb
 - test/virtual_test.rb
 - test/writeable_test.rb

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.3
-  - 2.0.0
-gemfile:
-  - gemfiles/Gemfile.disposable-0.3
-
-matrix:
-  fast_finish: true
-before_install:
-  - gem install bundler

data/gemfiles/Gemfile.disposable-0.3

@@ -1,6 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in reform.gemspec
-gemspec :path => '../'
-
-gem 'minitest'

data/lib/reform/contract/errors.rb

@@ -1,43 +0,0 @@
-class Reform::Contract::Errors
-  def initialize(*)
-    @errors = {}
-  end
-
-  module Merge
-    def merge!(errors, prefix)
-      errors.messages.each do |field, msgs|
-        unless field.to_sym == :base
-          field = (prefix+[field]).join(".").to_sym # TODO: why is that a symbol in Rails?
-        end
-
-        msgs.each do |msg|
-          next if messages[field] and messages[field].include?(msg)
-          add(field, msg)
-        end # Forms now contains a plain errors hash. the errors for each item are still available in item.errors.
-      end
-    end
-
-    def to_s
-      messages.inspect
-    end
-  end
-  include Merge
-
-  def add(field, message)
-    @errors[field] ||= []
-    @errors[field] << message
-  end
-
-  def messages
-    @errors
-  end
-
-  def empty?
-    @errors.empty?
-  end
-
-  # needed by Rails form builder.
-  def [](name)
-    @errors[name] || []
-  end
-end

data/lib/reform/form/mongoid.rb

@@ -1,37 +0,0 @@
-module Reform::Form::Mongoid
-  def self.included(base)
-    base.class_eval do
-      register_feature Reform::Form::Mongoid
-      include Reform::Form::ActiveModel
-      include Reform::Form::ORM
-      extend ClassMethods
-    end
-  end
-
-  module ClassMethods
-    def validates_uniqueness_of(attribute, options={})
-      options = options.merge(:attributes => [attribute])
-      validates_with(UniquenessValidator, options)
-    end
-    def i18n_scope
-      :mongoid
-    end
-  end
-
-
-  def self.mongoid_namespace
-    if mongoid_is_4_or_more?
-      'Validatable'
-    else
-      'Validations'
-    end
-  end
-
-  def self.mongoid_is_4_or_more?
-    Mongoid::VERSION.split('.').first.to_i >= 4
-  end
-
-  UniquenessValidator = Class.new("::Mongoid::#{mongoid_namespace}::UniquenessValidator".constantize) do
-    include Reform::Form::ORM::UniquenessValidator
-  end
-end

data/lib/reform/form/orm.rb

@@ -1,26 +0,0 @@
-module Reform::Form::ORM
-  def model_for_property(name)
-    return model unless is_a?(Reform::Form::Composition) # i am too lazy for proper inheritance. there should be a ActiveRecord::Composition that handles this.
-
-    model_name = options_for(name)[:on]
-    model[model_name]
-  end
-
-  module UniquenessValidator
-    # when calling validates it should create the Vali instance already and set @klass there! # TODO: fix this in AM.
-    def validate(form)
-      property = attributes.first
-
-      # here is the thing: why does AM::UniquenessValidator require a filled-out record to work properly? also, why do we need to set
-      # the class? it would be way easier to pass #validate a hash of attributes and get back an errors hash.
-      # the class for the finder could either be infered from the record or set in the validator instance itself in the call to ::validates.
-      record = form.model_for_property(property)
-      record.send("#{property}=", form.send(property))
-
-      @klass = record.class # this is usually done in the super-sucky #setup method.
-      super(record).tap do |res|
-        form.errors.add(property, record.errors.first.last) if record.errors.present?
-      end
-    end
-  end
-end

data/lib/reform/mongoid.rb

@@ -1,4 +0,0 @@
-require 'reform/form/active_model'
-require 'reform/form/orm'
-require 'reform/form/mongoid'
-require 'reform/form/active_model/model_reflections' # only load this in AR context as simple_form currently is bound to AR.

data/test/deprecation_test.rb

@@ -1,27 +0,0 @@
-require "test_helper"
-
-
-class DeprecationRemoveMePopulatorTest < MiniTest::Spec
-  Album = Struct.new(:songs)
-  Song  = Struct.new(:title)
-
-
-  class AlbumForm < Reform::Form
-    collection :songs, populator: ->(fragment, collection, index, *) { return Representable::Pipeline::Stop if fragment[:title]=="Good"
-      songs[index]
-              } do
-      property :title
-    end
-  end
-
-  it do
-    form = AlbumForm.new(Album.new([Song.new, Song.new]))
-    hash = {songs: [{title: "Good"}, {title: "Bad"}]}
-
-    form.validate(hash)
-
-    form.songs.size.must_equal 2
-    form.songs[0].title.must_equal nil
-    form.songs[1].title.must_equal "Bad"
-  end
-end

data/test/readonly_test.rb

@@ -1,14 +0,0 @@
-require "test_helper"
-
-class ReadonlyTest < MiniTest::Spec
-  class SongForm < Reform::Form
-    property :artist
-    property :title, writeable: false
-    # TODO: what to do with virtual values?
-  end
-
-  let (:form) { SongForm.new(OpenStruct.new) }
-
-  it { form.readonly?(:artist).must_equal false }
-  it { form.readonly?(:title).must_equal true }
-end