reform 2.0.0.beta1 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 719c0d3aec98a161756c38012b620944cf19fa22
-  data.tar.gz: f7adb9cb663ea890809b3606a3ab01376fe4453d
+  metadata.gz: 4b89a50eb51cda0fe932efa6b7e67eb03658fdba
+  data.tar.gz: 019bfd72b5e2c966dde1a35bc22ce4dc0c2bd934
 SHA512:
-  metadata.gz: 78d3c8711d9a337ca128e6e0cf14ebfe4df94230c4e1180110bd419ef7d4d0951be2a5f3823be807e2daf68f483a02f149e8bea212bfcac7d59613a115fbabc3
-  data.tar.gz: 9434d975625b3719bcd47a1a31da9be8feda733c3af43a78237fdbe1fa5e90805cefb88e9e707ec4c9f050a2615a1626ae345477076d1b235c9107f9c388f8cd
+  metadata.gz: adb468e4594747b200c08ac1e23dcefab0730e801698f4fd2e675a04366f75fdd156a4bc3f49fd571f0346ae7283397e5b7cf7ab536243abbd2e6e70883248a2
+  data.tar.gz: 20aab2ce543b0619ee7e064e11c993d58792cb030af05513361b358ba9b324aaf0d24bf500edadaa1dbb1f08cac18aae20d6bfe0e68b1ce86cbbe43fc1a02fb4

data/CHANGES.md

@@ -11,6 +11,7 @@ you don't need to know about forms anymore, the twin handles that using #insert.
 
 * `:as` option removed. Use `:from`.
 * With `Composition` included, `Form#model` would give you a composition object. You can grab that using `Form#mapper` now.
+* `Form#update!` is deprecated. It still works but will remind you to override `#present!` or use pre-populators as [described here](http://trailblazerb.org/gems/reform/prepopulator.html) and in the Trailblazer book, chapter "Nested Forms".
 
 ## 1.2.6
 

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 gemspec
 
 #gem 'representable', path: "../representable"
-gem "disposable", path: "../disposable"
+# gem "disposable", path: "../disposable"
 # gem "disposable", github: "apotonick/disposable"

data/README.md

@@ -859,6 +859,30 @@ form.changed?(:title) #=> true
 When including `Sync::SkipUnchanged`, the form won't assign unchanged values anymore in `#sync`.
 
 
+## Deserializing and Population
+
+A form object is just a twin. In `validate`, a representer is used to deserialize the incoming hash and populate the form twin graph. This means, you can use any representer you like and process data like JSON or XML, too.
+
+Representers can be inferred from the contract automatically using `Disposable::Schema`. You may then extend your representer with hypermedia, etc. in order to render documents. Check out the Trailblazer book (chapter Hypermedia APIs) for a full explanation.
+
+You can even write your own deserializer code in case you dislike Representable.
+
+```ruby
+class AlbumForm < Reform::Form
+  # ..
+
+  def deserialize!(document)
+    hash = YAML.parse(document)
+
+    self.title  = hash[:title]
+    self.artist = Artist.new if hash[:artist]
+  end
+end
+```
+
+The decoupling of deserializer and form object is one of the main reasons I wrote Reform 2.
+
+
 ## Undocumented Features
 
 _(Please don't read this section!)_
@@ -941,7 +965,6 @@ If you run into any trouble chat with us on irc.freenode.org#trailblazer.
 ## Maintainers
 
 [Nick Sutterer](https://github.com/apotonick)
-
 [Garrett Heinlen](https://github.com/gogogarrett)
 
 

data/Rakefile

@@ -27,7 +27,9 @@ Rake::TestTask.new(:test) do |test|
   "test/uniqueness_test.rb",
   "test/from_test.rb",
   "test/composition_test.rb",
-  "test/form_option_test.rb"
+  "test/form_option_test.rb",
+  "test/form_test.rb",
+  "test/deserialize_test.rb"
 ]
 
 

data/gemfiles/Gemfile.rails-3.0

@@ -5,4 +5,3 @@ gemspec :path => '../'
 
 gem 'railties', '~> 3.0.11'
 gem 'activerecord', '~> 3.0.11'
-gem "disposable", github: "apotonick/disposable"

data/gemfiles/Gemfile.rails-3.1

@@ -5,4 +5,3 @@ gemspec :path => '../'
 
 gem 'railties', '~> 3.1.0'
 gem 'activerecord', '~> 3.1.0'
-gem "disposable", github: "apotonick/disposable"

data/gemfiles/Gemfile.rails-3.2

@@ -5,4 +5,3 @@ gemspec :path => '../'
 
 gem 'railties', '~> 3.2.0'
 gem 'activerecord', '~> 3.2.0'
-gem "disposable", github: "apotonick/disposable"

data/gemfiles/Gemfile.rails-4.0

@@ -6,4 +6,3 @@ gemspec :path => '../'
 gem 'railties', '~> 4.0.0'
 gem 'activerecord', '~> 4.0.0'
 gem 'minitest', '~> 4.2'
-gem "disposable", github: "apotonick/disposable"

data/lib/reform/contract.rb

@@ -15,12 +15,6 @@ module Reform
 
     extend Uber::Delegates
 
-    representer_class.instance_eval do
-      def default_inline_class
-        Contract
-      end
-    end
-    # FIXME: THIS sucks because we're building two representers.
     representer_class.instance_eval do
       def default_inline_class
         Contract
@@ -28,19 +22,21 @@ module Reform
     end
 
     def self.property(name, options={}, &block)
-      options.merge!(pass_options: true)
-
       if twin = options.delete(:form)
         options[:twin] = twin
       end
 
+      if validates_options = options[:validates]
+        validates name, validates_options.dup # .dup for RAils 3.x because it's retarded.
+      end
+
       super
     end
 
     # FIXME: test me.
     def self.properties(*args)
       options = args.extract_options!
-      args.each { |name| property(name, options.dup) }
+      args.each { |name| property(name, options) }
     end
 
     # FIXME: make AM optional.
@@ -91,17 +87,12 @@ 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
 
   class Contract_ # DISCUSS: make class?
-    extend Uber::InheritableAttr
-
-    RESERVED_METHODS = [:model] # TODO: refactor that so we don't need that.
-      def handle_reserved_names(name)
-        raise "[Reform] the property name '#{name}' is reserved, please consider something else using :as." if RESERVED_METHODS.include?(name)
-      end
-
-
     # allows including representers from Representable, Roar or disposable.
     def self.inherit_module!(representer) # called from Representable::included.
       # representer_class.inherit_module!(representer)
@@ -115,9 +106,6 @@ module Reform
         property(*args) { include dfn.representer_module } # nested.
       end
     end
-
-    require 'reform/schema'
-    extend Schema
   end
 end
 

data/lib/reform/form.rb

@@ -1,3 +1,5 @@
+require "disposable/twin/schema"
+
 module Reform
   class Form < Contract
     representer_class.instance_eval do
@@ -85,4 +87,4 @@ module Reform
     require "reform/form/prepopulate"
     include Prepopulate
   end
-end
+end

data/lib/reform/form/active_model.rb

@@ -29,7 +29,7 @@ module Reform::Form::ActiveModel
         rename_nested_param_for!(params, dfn)
       end
 
-      super
+      super(params)
     end
 
   private

data/lib/reform/form/coercion.rb

@@ -1,5 +1,5 @@
-require 'representable/coercion'
+require "disposable/twin/coercion"
 
-# TODO: make optional.
-module Reform::Form::Coercion
-end
+Reform::Form.class_eval do
+  Coercion = Disposable::Twin::Coercion
+end

data/lib/reform/form/multi_parameter_attributes.rb

@@ -38,8 +38,7 @@ module Reform::Form::MultiParameterAttributes
 
   # this hooks into the format-specific #deserialize! method.
   def deserialize!(params)
-    params = DateTimeParamsFilter.new.call(params) if params.is_a?(Hash) # this currently works for hash, only.
-    super
+    super DateTimeParamsFilter.new.call(params) # if params.is_a?(Hash) # this currently works for hash, only.
   end
 
   # module BuildDefinition

data/lib/reform/form/validate.rb

@@ -20,58 +20,69 @@ module Reform::Form::Validate
   # 2. Deserialize. This is wrong and should be done in 1.
   # 3. Validate the form object graph.
   def validate(params)
-    update!(params)
+    deprecate_update!(params)
 
-    super() # run the actual validation on self.
+    # allow an external deserializer.
+    block_given? ? yield(params) : deserialize(params)
 
+    super() # run the actual validation on self.
   # rescue Representable::DeserializeError
   #   raise DeserializeError.new("[Reform] Deserialize error: You probably called #validate without setting up your nested models. Check https://github.com/apotonick/reform#populating-forms-for-validation on how to use populators.")
   end
 
+  # Meant to return params processable by the representer. This is the hook for munching date fields, etc.
+  def deserialize!(params)
+    # NOTE: it is completely up to the form user how they want to deserialize (e.g. using an external JSON-API representer).
+      # use the deserializer as an external instance to operate on the Twin API,
+      # e.g. adding new items in collections using #<< etc.
+    # DISCUSS: using self here will call the form's setters like title= which might be overridden.
+    params
+  end
+
+
+private
   # Some users use this method to pre-populate a form. Not saying this is right, but we'll keep
   # this method here.
   # DISCUSS: this is only called once, on the top-level form.
-  def update!(params)
-    deserialize!(params)
+  def deprecate_update!(params)
+    return unless self.class.instance_methods(false).include?(:update!)
+    warn "[Reform] Form#update! is deprecated and will be removed in Reform 2.1. Please use #present! or pre-populator."
+    update!(params)
   end
 
-private
-  def deserialize!(params)
-    require "disposable/twin/schema"
-    require "reform/form/coercion" # DISCUSS: make optional?
+  def deserialize(params)
+    params = deserialize!(params)
 
-    # NOTE: it is completely up to the form user how they want to deserialize (e.g. using an external JSON-API representer).
+    deserializer.new(self).from_hash(params)
+  end
 
+  # Default deserializer for hash.
+  # This is input-specific, e.g. Hash, JSON, or XML.
+  def deserializer # called on top-level, only, for now.
     deserializer = Disposable::Twin::Schema.from(self.class,
-        include:    [Representable::Hash::AllowSymbols, Representable::Hash, Representable::Coercion], # FIXME: how do we get this info?
-        superclass: Representable::Decorator,
-        representer_from: lambda { |inline| inline.representer_class },
-        options_from: :deserializer
-        )
+      include:          [Representable::Hash::AllowSymbols, Representable::Hash],
+      superclass:       Representable::Decorator,
+      representer_from: lambda { |inline| inline.representer_class },
+      options_from:     :deserializer
+    )
 
-    deserializer.representable_attrs.each do |dfn|
-      next unless dfn[:_inline] # FIXME: we have to standardize that!
+    deserializer.apply do |dfn|
+      next unless dfn[:twin]
 
-      # FIXME: collides with Schema?
+      # Representer#each and #apply have to be unified.
       dfn.merge!(
         deserialize: lambda { |decorator, params, options|
-          decorator.represented.validate(params)
+          params = decorator.represented.deserialize!(params) # let them set up params. # FIXME: we could also get a new deserializer here.
 
-          decorator.represented
+          decorator.from_hash(params) # options.binding.deserialize_method.inspect
         }
       )
     end
 
-      deserializer.new(self).
-        # extend(Representable::Debug).
-        from_hash(params)
-
-      # use the deserializer as an external instance to operate on the Twin API,
-      # e.g. adding new items in collections using #<< etc.
-
-    # DISCUSS: using self here will call the form's setters like title= which might be overridden.
+    deserializer
   end
 
+
   class DeserializeError < RuntimeError
   end
 end

data/lib/reform/schema.rb

@@ -1,27 +1,13 @@
 module Reform
   module Schema
-    # Converts the Representer->Form->Representer->Form tree into Representer->Representer.
-    # It becomes obvious that the form will be the main schema-defining instance in Trb, so this
-    # method makes sense. Consider private. This is experimental.
-    #
-    # This allows generating representers from forms. As you can see, only little code is needed thanks to representable.
-    class Converter
-      def self.from(representer_class) # TODO: can we re-use this for all the decorator logic in #validate, etc?
-        representer = Class.new(representer_class)
-        representer.representable_attrs.each do |dfn|
-          next unless form = dfn[:form]
-
-          dfn.merge!(:extend => from(form.representer_class))
-          dfn.delete!(:prepare) # not sure if this is gonna stay. also, this is representable 2.1, only.
-        end
-
-        representer
-      end
-    end
-
-    # It's your job to make sure you memoize it correctly.
-    def schema
-      Converter.from(representer_class)
+    def schema(options={})
+      require "disposable/twin/schema"
+      Disposable::Twin::Schema.from(self,
+        {
+          superclass:       Representable::Decorator,
+          representer_from: lambda { |nested| nested.representer_class }
+        }.merge(options) # TODO: options not tested.
+      )
     end
   end
 end

data/lib/reform/version.rb

@@ -1,3 +1,3 @@
 module Reform
-  VERSION = "2.0.0.beta1"
+  VERSION = "2.0.0.beta2"
 end

data/reform.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency             "representable",  ">= 2.2.2"
-  spec.add_dependency             "disposable",     "~> 0.1.2"
+  spec.add_dependency             "disposable",     "~> 0.1.4"
   spec.add_dependency             "uber",           "~> 0.0.11"
   spec.add_dependency             "activemodel"
 

data/test/coercion_test.rb

@@ -9,7 +9,7 @@ class CoercionTest < BaseTest
   end
 
   class Form < Reform::Form
-    # include Coercion
+    feature Coercion
 
     property :released_at, :type => DateTime
 

data/test/deserialize_test.rb

@@ -1,37 +1,84 @@
 require 'test_helper'
 require 'reform/form/json'
 
-class DeserializeTest < BaseTest
-  class AlbumContract < Reform::Form
-    include Reform::Form::ActiveModel::FormBuilderMethods # overrides #update!, too.
+class DeserializeTest < MiniTest::Spec
+  Song  = Struct.new(:title, :album, :composer)
+  Album = Struct.new(:title, :artist)
+  Artist = Struct.new(:name)
 
-    include Reform::Form::JSON
+  class JsonAlbumForm < Reform::Form
+    module Json
+      def deserialize(params)
+        # params = deserialize!(params) # DON'T call those hash hooks.
 
-    property :title
-    validates :title, :presence => true, :length => {:minimum => 3}
+        deserializer.new(self).
+        # extend(Representable::Debug).
+          from_json(params)
+      end
 
-    property :hit do
-      property :title
-      validates :title, :presence => true
+      def deserializer
+        deserializer = Disposable::Twin::Schema.from(self.class,
+          include:          [Representable::JSON],
+          superclass:       Representable::Decorator,
+          representer_from: lambda { |inline| inline.representer_class },
+          options_from:     :deserializer
+        )
+      end
     end
+    include Json
 
-    property :band do # yepp, people do crazy stuff like that.
-      validates :label, :presence => true
 
-      property :label do
-        property :name
-        validates :name, :presence => true
-      end
+    property :title
+    property :artist, populate_if_empty: Artist do
+      property :name
     end
   end
 
-  let (:album) { Album.new(nil, Song.new, [Song.new, Song.new], Band.new(Label.new("Fat Wreck")) ) }
-  subject { AlbumContract.new(album) }
+  let (:artist) { Artist.new("A-ha") }
+  it do
+    artist_id = artist.object_id
+
+    form = JsonAlbumForm.new(Album.new("Best Of", artist))
+    json = {title: "Apocalypse Soon", artist: {name: "Mute"}}.to_json
+
+    form.validate(json)
+
+    form.title.must_equal "Apocalypse Soon"
+    form.artist.name.must_equal "Mute"
+    form.artist.model.object_id.must_equal artist_id
+  end
+end
+
 
-  let (:json) { '{"hit":{"title":"Sacrifice"},"title":"Second Heat","songs":[{"title":"Heart Of A Lion"}],"band":{"label":{"name":"Fat Wreck"}}}' }
+class ValidateWithBlockTest < MiniTest::Spec
+  Song  = Struct.new(:title, :album, :composer)
+  Album = Struct.new(:title, :artist)
+  Artist = Struct.new(:name)
+
+  class AlbumForm < Reform::Form
+    property :title
+    property :artist, populate_if_empty: Artist do
+      property :name
+    end
+  end
 
   it do
-    subject.validate(json)
-    subject.band.label.name.must_equal "Fat Wreck"
+    album = Album.new
+    form  = AlbumForm.new(album)
+    json  = {title: "Apocalypse Soon", artist: {name: "Mute"}}.to_json
+
+    deserializer = Disposable::Twin::Schema.from(AlbumForm,
+      include:          [Representable::JSON],
+      superclass:       Representable::Decorator,
+      representer_from: lambda { |inline| inline.representer_class },
+      options_from:     :deserializer
+    )
+
+    form.validate(json) do |params|
+      deserializer.new(form).from_json(params)
+    end.must_equal true # with block must return result, too.
+
+    form.title.must_equal "Apocalypse Soon"
+    form.artist.name.must_equal "Mute"
   end
 end

data/test/form_builder_test.rb

@@ -27,6 +27,10 @@ class FormBuilderCompatTest < BaseTest
     property :band do
       property :label do
         property :name
+
+        property :location do
+          property :postcode
+        end
       end
     end
   end
@@ -36,20 +40,21 @@ class FormBuilderCompatTest < BaseTest
   let (:form) { AlbumForm.new(OpenStruct.new(
     :artist => Artist.new(:name => "Propagandhi"),
     :songs  => [song],
-    :label  => OpenStruct.new,
+    :label  => Label.new,
 
-    :band => Band.new(Label.new)
+    :band => Band.new(OpenStruct.new(location: OpenStruct.new))
     )) }
 
-  it "respects _attributes params hash" do
+  it "xxxrespects _attributes params hash" do
     form.validate(
       "artist_attributes" => {"name" => "Blink 182"},
       "songs_attributes"  => {"0" => {"title" => "Damnit"}},
-      "band_attributes"   => {"label_attributes" => {"name" => "Epitaph"}})
+      "band_attributes"   => {"label_attributes" => {"name" => "Epitaph", "location_attributes" => {"postcode" => 2481}}})
 
     form.artist.name.must_equal "Blink 182"
     form.songs.first.title.must_equal "Damnit"
     form.band.label.name.must_equal "Epitaph"
+    form.band.label.location.postcode.must_equal 2481
   end
 
   it "allows nested collection and property to be missing" do

data/test/form_test.rb

@@ -32,6 +32,7 @@ class FormTest < MiniTest::Spec
   end
 
   # ::schema
+  # TODO: refactor schema tests, this is all covered in Disposable.
   describe "::schema" do
     let (:schema) { AlbumForm.schema }
 

data/test/validate_test.rb

@@ -126,6 +126,21 @@ class ValidateWithoutConfigurationTest < MiniTest::Spec
     album.songs[1].composer.name.must_equal "Greg Graffin"
     album.artist.name.must_equal "Bad Religion"
   end
+
+  # with symbols.
+  it do
+    form.validate(
+      name:   "Best Of",
+      songs:  [{title: "The X-Creep"}, {title: "Trudging", composer: {name: "SNFU"}}],
+      artist: {name: "The Police"},
+    ).must_equal true
+
+    form.name.must_equal "Best Of"
+    form.songs[0].title.must_equal "The X-Creep"
+    form.songs[1].title.must_equal "Trudging"
+    form.songs[1].composer.name.must_equal "SNFU"
+    form.artist.name.must_equal "The Police"
+  end
 end
 
 class ValidateWithDeserializerOptionTest < MiniTest::Spec
@@ -248,7 +263,6 @@ class ValidateWithDeserializerOptionTest < MiniTest::Spec
   end
 end
 
-
 #   # not sure if we should catch that in Reform or rather do that in disposable. this is https://github.com/apotonick/reform/pull/104
 #   # describe ":populator with :empty" do
 #   #   let (:form) {
@@ -323,18 +337,7 @@ end
 #   end
 
 
-#   describe "with symbols" do
-#     let (:album) { OpenStruct.new(:band => OpenStruct.new(:label => OpenStruct.new(:name => "Epitaph"))) }
-#     subject { ErrorsTest::AlbumForm.new(album) }
-#     let (:params) { {:band => {:label => {:name => "Stiff"}}, :title => "House Of Fun"} }
 
-#     before {
-#       subject.validate(params).must_equal true
-#     }
-
-#     it { subject.band.label.name.must_equal "Stiff" }
-#     it { subject.title.must_equal "House Of Fun" }
-#   end
 
 
 #   # providing manual validator method allows accessing form's API.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reform
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta1
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Nick Sutterer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-28 00:00:00.000000000 Z
+date: 2015-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: uber
   requirement: !ruby/object:Gem::Requirement