reform 2.0.5 → 2.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7b6c745acf6fc96e9d5c0291d4fa64df5be3c92
-  data.tar.gz: 0304e04e195f525af7aed8081c87a328885c2581
+  metadata.gz: 6fd73b0dc59751240c4ec4518477b225c5becf81
+  data.tar.gz: 1a6a1e8eba9f547424e533698129299afbdc8a93
 SHA512:
-  metadata.gz: 1070cf32ba255c0b08d5b0dc7bc3a666cd1a515fe627e77af2168519908fe9a0680b132cdc2e77e512cd346c1b458051bc5c1e055db31bcc101ac718dfca8bf4
-  data.tar.gz: 42777ea0870fa57d5eb6c87df3cda716bd6eff0f0c479e50610df969845b089c6dcaa366ab1e14c66484c1980fbf621dd045463cc2ae357d5e8fbbcc3f13fdf8
+  metadata.gz: 59066ba1ed67fc72da96561cb77f4dfcf3750c2840ce825b55344851476a09feba5e8222b2aa75d560014c027ce313f2896ad49b651c6de7a52ede2cee0db854
+  data.tar.gz: 57f67e136f2e7ea8c99db1baaab671a26ae6ebbfb62066564048c38ccd3bbc8b1846a54733b9f5629bb01d32085470649fa4f7c255f35042eab5f7fc9b990b69

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
-  - 2.2.0
+  - 2.2.3
   - 1.9.3
 services:
   - mongodb
@@ -15,3 +15,5 @@ matrix:
   fast_finish: true
   allow_failures:
     - rvm: 1.9.3
+before_install:
+  - gem install bundler

data/CHANGES.md

@@ -1,3 +1,15 @@
+## 2.1
+
+### Awesomeness
+
+* You can now have `:populator` for scalar properties, too. This allows "parsing code" per property which is super helpful to structure your deserialization.
+* `:populator` can be a method name, as in `populator: :populate_authors!`.
+* Populators can now skip deserialization of a nested fragment using `skip!`. [Learn more here](http://trailblazer.to/gems/reform/populator.html).
+* Added basic support for dry-validation as a future replacement for ActiveModel::Validation. Note that this is still experimental, but feel free to test.
+
+* :populator ->(options) or ->(fragment:, model:, **o)
+* `ActiveModel::Validator` prevents Rails from adding methods to it. This makes `acceptance` and `confirmation` validations work properly.
+
 ## 2.0.5
 
 * `ActiveModel::Validator` now delegates all methods properly to the form. It used to crashed with properties called `format` or other private `Object` methods.

data/Gemfile

@@ -2,6 +2,16 @@ source 'https://rubygems.org'
 
 gemspec
 
-#gem 'representable', path: "../representable"
+
+# 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 "disposable", github: "apotonick/disposable"
+
+
+# gem "declarative", path: "../declarative"
+
+gem "minitest-line"
+gem 'dry-validation'
+gem 'byebug'

data/README.md

@@ -1,5 +1,6 @@
 # Reform
 
+[![Gitter Chat](https://badges.gitter.im/trailblazer/chat.svg)](https://gitter.im/trailblazer/chat)
 [![Build
 Status](https://travis-ci.org/apotonick/reform.svg)](https://travis-ci.org/apotonick/reform)
 [![Gem Version](https://badge.fury.io/rb/reform.svg)](http://badge.fury.io/rb/reform)
@@ -12,22 +13,16 @@ Although reform can be used in any Ruby framework, it comes with [Rails support]
 
 ## 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. When in trouble, join us on the IRC (Freenode) #trailblazer channel.
+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).
 
-[Full documentation for Reform](http://trailblazerb.org/gems/reform) is available online, or support us and grab the [Trailblazer book](https://leanpub.com/trailblazer).
+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.
 
 ## Disposable
 
 Every form in Reform is a _twin_. Twins are non-persistent domain objects from the [Disposable gem](https://github.com/apotonick/disposable). All features of Disposable, like renaming fields, change tracking, etc. are available in Reform, too.
 
-<!--
-## ActiveModel
-
-**WARNING: Reform will soon drop support for ActiveModel validations.**
-
-This is mostly to save my mental integrity. The amount of problems we have in Reform with ActiveModel's poor object design, its lack of interfaces and encapsulation do outweigh the benefits. Please consider using Lotus::Validations instead, which will soon be mature enough to replace this dinosaur.
--->
-
 ## Defining Forms
 
 Forms are defined in separate classes. Often, these classes partially map to a model.
@@ -288,7 +283,7 @@ class AlbumForm < Reform::Form
   end
 ```
 
-Reform also allows to completely override population using the `:populator` options. This is [documented here](http://trailblazerb.org/gems/reform/populators.html), and also in the Trailblazer book.
+Reform also allows to completely override population using the `:populator` options. This is [documented here](http://trailblazer.to/gems/reform/populators.html), and also in the Trailblazer book.
 
 ## Installation
 
@@ -739,7 +734,7 @@ class SongForm < Reform::Form
 end
 ```
 
-Be warned that we _do not_ encourage copying validations. You should rather move validation code into forms and not work on your model directly anymore.
+Be warned that we _do not_ encourage copying validations. You should rather move validation code into forms and not work on your model directly anymore. Also, please note that the ```copy_validations_from``` line _must_ go below your property definitions for the validations to copy correctly.
 
 ## Agnosticism: Mapping Data
 
@@ -799,7 +794,7 @@ class SongForm < Reform::Form
 
 Both ActiveRecord and Mongoid modules will support "native" uniqueness support from the model class when you use `validates_uniqueness_of`. They will provide options like `:scope`, etc.
 
-You're encouraged to use Reform's non-writing `unique: true` validation, though. [Learn more](http://trailblazerb.org/gems/reform/validation.html)
+You're encouraged to use Reform's non-writing `unique: true` validation, though. [Learn more](http://trailblazer.to/gems/reform/validation.html)
 
 ## ActiveModel Compliance
 
@@ -981,7 +976,7 @@ Note that this still runs validations for the property, though.
 
 ### Prepopulating Forms
 
-Docs: http://trailblazerb.org/gems/reform/prepopulator.html
+Docs: http://trailblazer.to/gems/reform/prepopulator.html
 
 When rendering a new form for an empty object, nested forms won't show up. The [Trailblazer book, chapter 5](https://leanpub.com/trailblazer), discusses this in detail.
 

data/Rakefile

@@ -4,7 +4,7 @@ require 'rake/testtask'
 task :default => [:test]
 Rake::TestTask.new(:test) do |test|
   test.libs << 'test'
-  test.test_files = FileList['test/*_test.rb']
+  test.test_files = FileList['test/*_test.rb'] + FileList["test/validation/*_test.rb"]
 
 #   test.test_files = ["test/changed_test.rb",
 #   "test/coercion_test.rb",

data/lib/reform.rb

@@ -4,6 +4,7 @@ module Reform
   end
 end
 
+require "disposable"
 require "reform/contract"
 require "reform/form"
 require "reform/form/composition"

data/lib/reform/contract.rb

@@ -1,7 +1,4 @@
 require "uber/inheritable_attr"
-require "disposable/twin"
-require "disposable/twin/setup"
-require "disposable/twin/default"
 
 module Reform
   # Define your form structure and its validations. Instantiate it with a model,
@@ -14,10 +11,8 @@ module Reform
     feature Setup::SkipSetter
     feature Default
 
-    representer_class.instance_eval do
-      def default_inline_class
-        Contract
-      end
+    def self.default_nested_class
+      Contract
     end
 
     def self.property(name, options={}, &block)
@@ -25,10 +20,8 @@ module Reform
         options[:twin] = twin
       end
 
-      options[:pass_options] = true
-
       if validates_options = options[:validates]
-        validates name, validates_options.dup # .dup for RAils 3.x.
+        validates name, validates_options
       end
 
       super
@@ -43,13 +36,16 @@ module Reform
     require 'reform/contract/validate'
     include Reform::Contract::Validate
 
+    require "reform/validation"
+    include Reform::Validation # ::validates and #valid?
 
-    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
+
+    # 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?
@@ -63,7 +59,7 @@ module Reform
     end
 
     def self.options_for(name)
-      representer_class.representable_attrs.get(name)
+      definitions.get(name)
     end
     include Readonly
 
@@ -71,8 +67,5 @@ module Reform
     def self.clone # TODO: test. THIS IS ONLY FOR Trailblazer when contract gets cloned in suboperation.
       Class.new(self)
     end
-
-    require "reform/schema"
-    extend Reform::Schema
   end
 end

data/lib/reform/contract/validate.rb

@@ -1,8 +1,14 @@
 module Reform::Contract::Validate
+  def initialize(*)
+    super
+    @errors = build_errors
+  end
+
+  attr_reader :errors
+
   def validate
-    validate!(errs=build_errors, [])
+    validate!(errors, [])
 
-    @errors = errs
     errors.empty?
   end
 
@@ -15,17 +21,13 @@ module Reform::Contract::Validate
     errors.merge!(nested_errors, [])
   end
 
-  def errors
-    @errors ||= build_errors
-  end
-
 private
 
   # 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]) }
+      Disposable::Twin::PropertyProcessor.new(dfn, self).() { |form| form.validate!(errors, prefixes+[dfn[:name]]) }
     end
   end
 end

data/lib/reform/form.rb

@@ -1,11 +1,7 @@
-require "disposable/twin/schema"
-
 module Reform
   class Form < Contract
-    representer_class.instance_eval do
-      def default_inline_class
-        Form
-      end
+    def self.default_nested_class
+      Form
     end
 
     require "reform/form/validate"
@@ -13,45 +9,59 @@ module Reform
 
     require "reform/form/populator"
 
+    # called after populator: form.deserialize(params)
+    # as this only included in the typed pipeline, it's not applied for scalars.
+    Deserialize = ->(input, options) { input.deserialize(options[:fragment]) } # TODO: (result:, fragment:, **o) once we drop 2.0.
+
     module Property
       # Add macro logic, e.g. for :populator.
-      # TODO: This will be re-structured once Declarative allows it.
       def property(name, options={}, &block)
-        if deserializer = options[:deserializer] # this means someone is explicitly specifying :deserializer.
-          options[:deserializer] = Representable::Cloneable::Hash[deserializer]
-        end
-
         definition = super # let representable sort out inheriting of properties, and so on.
-        definition.merge!(deserializer: Representable::Cloneable::Hash.new) unless definition[:deserializer] # always keep :deserializer per property.
+        definition.merge!(deserializer: {}) unless definition[:deserializer] # always keep :deserializer per property.
 
         deserializer_options = definition[:deserializer]
 
         # Populators
-        # * they assign created data, no :setter (hence the name).
-        # * they (ab)use :instance, this is why they need to return a twin form.
-        # * they are only used in the deserializer.
-        if populator = options.delete(:populate_if_empty)
-          deserializer_options.merge!({instance: Populator::IfEmpty.new(populator)})
-          deserializer_options.merge!({setter: nil})
-        elsif populator = options.delete(:populator)
-          deserializer_options.merge!({instance: Populator.new(populator)})
-          deserializer_options.merge!({setter: nil})
+        internal_populator = Populator::Sync.new(nil)
+        if block = definition[:populate_if_empty]
+          internal_populator = Populator::IfEmpty.new(block)
+        end
+        if block = definition[:populator] # populator wins over populate_if_empty when :inherit
+          internal_populator = Populator.new(block)
+        end
+        definition.merge!(internal_populator: internal_populator) unless options[:internal_populator]
+        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.
+        if definition[:nested]
+          parse_pipeline = ->(input, options) do
+            functions = options[:binding].send(:parse_functions)
+            pipeline  = Representable::Pipeline[*functions] # Pipeline[StopOnExcluded, AssignName, ReadFragment, StopOnNotFound, OverwriteOnNil, Collect[#<Representable::Function::CreateObject:0xa6148ec>, #<Representable::Function::Decorate:0xa6148b0>, Deserialize], Set]
+
+            pipeline  = Representable::Pipeline::Insert.(pipeline, external_populator,            replace: Representable::CreateObject::Instance)
+            pipeline  = Representable::Pipeline::Insert.(pipeline, Representable::Decorate,       delete: true)
+            pipeline  = Representable::Pipeline::Insert.(pipeline, Deserialize,                   replace: Representable::Deserialize)
+            pipeline  = Representable::Pipeline::Insert.(pipeline, Representable::SetValue,       delete: true) # FIXME: only diff to options without :populator
+          end
+        else
+          parse_pipeline = ->(input, options) do
+            functions = options[:binding].send(:parse_functions)
+            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
+          end
         end
 
+        deserializer_options[:parse_pipeline] ||= parse_pipeline
 
-        # TODO: shouldn't that go into validate?
-        if proc = options.delete(:skip_if)
+        if proc = definition[:skip_if]
           proc = Reform::Form::Validate::Skip::AllBlank.new if proc == :all_blank
-
-          deserializer_options.merge!(skip_parse: proc)
+          deserializer_options.merge!(skip_parse: proc) # TODO: same with skip_parse ==> External
         end
 
-        # default:
-        # add Sync populator to nested forms.
-        # FIXME: this is, of course, ridiculous and needs a better structuring.
-        if (deserializer_options == {} || deserializer_options.keys == [:skip_parse]) && definition[:twin] && !options[:inherit] # FIXME: hmm. not a fan of this: only add when no other option given?
-          deserializer_options.merge!(instance: Populator::Sync.new(nil), setter: nil)
-        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)
@@ -76,5 +86,9 @@ module Reform
 
     require "reform/form/prepopulate"
     include Prepopulate
+
+    def skip!
+      Representable::Pipeline::Stop
+    end
   end
 end

data/lib/reform/form/active_model.rb

@@ -28,16 +28,16 @@ module Reform::Form::ActiveModel
     end
 
     # DISCUSS: can we achieve that somehow via features in build_inline?
-    def process_inline!(mod, definition)
-      _name = definition.name
-      mod.instance_eval do
-        @_name = _name.singularize.camelize
-        # this adds Form::name for AM::Validations and I18N.
-        # i have a feeling that this is also needed for Rails autoloader, which is scary.
-        # beside that, it is a nice way for debugging to find out which anonymous form class you're working on:
-        #   anonymous_nested_form.class.name
-        def name
-          @_name
+    def property(*)
+      super.tap do |dfn|
+        return dfn unless dfn[:nested]
+        _name = dfn[:name]
+        dfn[:nested].instance_eval do
+          @_name = _name.singularize.camelize
+          # this adds Form::name for AM::Validations and I18N.
+          def name
+            @_name
+          end
         end
       end
     end

data/lib/reform/form/active_model/form_builder_methods.rb

@@ -13,7 +13,7 @@ module Reform::Form::ActiveModel
       # TODO: add that shit in Form#present, not by overriding ::property.
       def property(name, options={}, &block)
         super.tap do |definition|
-          add_nested_attribute_compat(name) if definition[:twin] # TODO: fix that in Rails FB#1832 work.
+          add_nested_attribute_compat(name) if definition[:nested] # TODO: fix that in Rails FB#1832 work.
         end
       end
 
@@ -35,13 +35,14 @@ module Reform::Form::ActiveModel
 
   private
     def rename_nested_param_for!(params, dfn)
-      nested_name = "#{dfn.name}_attributes"
+      name        = dfn[:name]
+      nested_name = "#{name}_attributes"
       return unless params.has_key?(nested_name)
 
-      value = params["#{dfn.name}_attributes"]
+      value = params["#{name}_attributes"]
       value = value.values if dfn[:collection]
 
-      params[dfn.name] = value
+      params[name] = value
     end
   end
 end

data/lib/reform/form/active_model/model_reflections.rb

@@ -7,7 +7,7 @@ class Reform::Form < Reform::Contract
   module ActiveModel::ModelReflections
     def self.included(base)
       base.extend ClassMethods
-      base.register_feature self # makes it work in nested forms.
+      base.send :register_feature, self # makes it work in nested forms.
     end
 
     module ClassMethods
@@ -19,7 +19,7 @@ class Reform::Form < Reform::Contract
 
       # this is needed in simpleform to infer required fields.
       def validators_on(*args)
-        validator.validators_on(*args)
+        validation_groups.collect { |k, group| group.instance_variable_get(:@validations).validators_on(*args) }.flatten
       end
     end
 

data/lib/reform/form/active_model/model_validations.rb

@@ -63,8 +63,8 @@ module Reform::Form::ActiveModel
       def self.from_representable_attrs(attrs)
         new.tap do |mapping|
           attrs.each do |dfn|
-            from = dfn.name.to_sym
-            to = [dfn[:on], (dfn[:private_name] || dfn.name)].compact.map(&:to_sym)
+            from = dfn[:name].to_sym
+            to = [dfn[:on], (dfn[:private_name] || dfn[:name])].compact.map(&:to_sym)
             mapping.add(from, to)
           end
         end
@@ -103,7 +103,7 @@ module Reform::Form::ActiveModel
     end
 
     def copy_validations_from(models)
-      ValidationCopier.copy(self, Mapping.from_representable_attrs(representer_class.representable_attrs), models)
+      ValidationCopier.copy(self, Mapping.from_representable_attrs(definitions), models)
     end
 
   end