reform 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 331784eaf17a8dc17f08c7c39cdb60af3bf502ed
-  data.tar.gz: 48cc28e685c889c3fd7ca7290215c5c4d1801ec1
+  metadata.gz: dbf6193ca27f1a4d6694b198771ab0bc3fec6459
+  data.tar.gz: 797ddc8942d2fe5c7947833b4eb52d6d5dd7fc24
 SHA512:
-  metadata.gz: 983557534185ed0d80afaccd6b433abb2ffe97fb5e44898bb915bb8d44b92f68d11447e2e30d7839be23c8f91cd374ffefe98a704eabe8f54763f13a09ade2dd
-  data.tar.gz: fbf1dc09a1197491e17fd4e36d137a98309fa05310f18e40804093ba6e1af3b08959f524293eef751fe5cbc0a21e73bd915d1a76fdddf4eb63091e203332342e
+  metadata.gz: ba03b87c0652c7daff1b3c7a5cbb3d2807f2a70f0333bda323e6da7319be22907a9d11614d3c2d6c5064f02d0c93e2957bdf194e342cb5937f1667b85093ca26
+  data.tar.gz: 259e07b615f263a630891ae34400cf9d2aacc966fa50c0f666b49b3047cd4cd82d11563f2ea8376e560ea70534d58973d21bcc61d90487bda3570e83d47e1c9b

data/CHANGES.md

@@ -1,3 +1,31 @@
+## 1.0.1
+
+* Deprecated model readers for `Composition` and `ActiveModel`. Consider the following setup.
+    ```ruby
+      class RecordingForm < Reform::Form
+        include Composition
+
+        property :title, on: :song
+      end
+    ```
+
+  Before, Reform would allow you to do `form.song` which returned the song model. You can still do this (but you shouldn't) with `form.model[:song]`.
+
+  This allows having composed models and properties with the same name. Until 1.1, you have to use `skip_accessors: true` to advise Reform _not_ to create the deprecated accessor.
+
+  Also deprecated is the alias accessor as found with `ActiveModel`.
+    ```ruby
+      class RecordingForm < Reform::Form
+        include Composition
+        include ActiveModel
+
+        model :hit, on: :song
+      end
+    ```
+  Here, an automatic reader `Form#hit` was created. This is deprecated as
+
+  This is gonna be **removed in 1.1**.
+
 ## 1.0.0
 
 * Removed `Form::DSL` in favour of `Form::Composition`.

data/README.md

@@ -42,7 +42,7 @@ To add fields to the form use the `::property` method. Also, validations no long
 Forms have a ridiculously simple API with only a handful of public methods.
 
 1. `#initialize` always requires a model that the form represents.
-2. `#validate(params)` will run all validations for the form with the input data. Its return value is the boolean result of the validations.
+2. `#validate(params)` updates the form's fields with the input data (only the form, _not_ the model) and then runs all validations. The return value is the boolean result of the validations.
 3. `#errors` returns validation messages in a classy ActiveModel style.
 4. `#sync` writes form data back to the model. This will only use setter methods on the model(s).
 5. `#save` (optional) will call `#save` on the model and nested models. Note that this implies a `#sync` call.
@@ -52,7 +52,7 @@ In addition to the main API, forms expose accessors to the defined properties. T
 
 ## Setup
 
-In your controller you'd create a form instance and pass in the models you wanna work on.
+In your controller you'd create a form instance and pass in the models you want to work on.
 
 ```ruby
 class SongsController
@@ -100,12 +100,12 @@ Your `@form` is now ready to be rendered, either do it yourself or use something
   = f.input :title
 ```
 
-Nested forms and collections can easily rendered with `fields_for`, etc. Just use Reform as if it would be an ActiveModel instance in the view layer.
+Nested forms and collections can be easily rendered with `fields_for`, etc. Just use Reform as if it would be an ActiveModel instance in the view layer.
 
 
 ## Validation
 
-After a form submission, you wanna validate the input.
+After a form submission, you want to validate the input.
 
 ```ruby
 class SongsController
@@ -117,9 +117,9 @@ class SongsController
     if @form.validate(params[:song])
 ```
 
-Reform uses the validations you provided in the form - and nothing else.
+The `#validate` method first updates the values of the form - the underlying model is still treated as immutuable and *remains unchanged*. It then runs all validations you provided in the form.
 
-Note that Reform only updates values of the internal form attributes - the underlying model is still treated as immutuable and *remains unchanged*.
+It's the only entry point for updating the form. This is per design, as separating writing and validation doesn't make sense for a form.
 
 This allows rendering the form after `validate` with the data that has been submitted. However, don't get confused, the model's values are still the old, original values and are only changed after a `#save` or `#sync` operation.
 
@@ -191,7 +191,7 @@ class AlbumContract < Reform::Contract
   end
 ```
 
-It defines the validations and the object graph to be run.
+It defines the validations and the object graph to be inspected.
 
 In future versions and with the upcoming [Trailblazer framework](https://github.com/apotonick/trailblazer), contracts can be inherited from forms, representers, and cells, and vice-versa. Actually this already works with representer inheritance - let me know if you need help.
 
@@ -412,7 +412,7 @@ class AlbumForm < Reform::Form
 
 This works for both `property` and `collection` and instantiates `Song` objects where they're missing when calling `#validate`.
 
-If you wanna create the objects yourself, because you're smarter than Reform, do it with a lambda.
+If you want to create the objects yourself, because you're smarter than Reform, do it with a lambda.
 
 ```ruby
 class AlbumForm < Reform::Form
@@ -537,7 +537,7 @@ form.save do |f, nested|
 
 ### Read-Only Fields
 
-Almost identical, the `:virtual` option makes fields read-only. Say you wanna show a value, but not process it after submission, this option is your friend.
+Almost identical, the `:virtual` option makes fields read-only. Say you want to show a value, but not process it after submission, this option is your friend.
 
 ```ruby
 class ProfileForm < Reform::Form
@@ -619,7 +619,7 @@ class CoverSongForm < Reform::Form
 end
 ```
 
-This is especially helpful when your framework tries to render `cover_song_path` although you wanna go with `song_path`.
+This is especially helpful when your framework tries to render `cover_song_path` although you want to go with `song_path`.
 
 
 ## FormBuilder Support
@@ -653,10 +653,10 @@ By explicitely defining the form layout using `::property` there is no more need
 
 When nesting form, you usually use a so-called inline form doing `property :song do .. end`.
 
-Sometimes you wanna specify an explicit form rather than using an inline form. Use the `form:` option here.
+Sometimes you want to specify an explicit form rather than using an inline form. Use the `form:` option here.
 
 ```ruby
-property :song, form: SongForm`
+property :song, form: SongForm
 ```
 
 The nested `SongForm` is a stand-alone form class you have to provide.

data/lib/reform/form/active_record.rb

@@ -38,6 +38,6 @@ module Reform::Form::ActiveRecord
     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 = mapper.representable_attrs[name][:on]
-    send(model_name)
+    model[model_name]
   end
 end

data/lib/reform/form/composition.rb

@@ -18,7 +18,7 @@ module Reform::Form::Composition
 
     def property(name, options={})
       super.tap do |definition|
-        delegate options[:on] => :@model # form.band -> composition.band
+        handle_deprecated_model_accessor(options[:on]) unless options[:skip_accessors] # TODO: remove in 1.2.
       end
     end
 
@@ -32,12 +32,25 @@ module Reform::Form::Composition
 
       composition_model = options[:on] || main_model
 
-      delegate composition_model => :model # #song => model.song
+      handle_deprecated_model_accessor(composition_model)  unless options[:skip_accessors] # TODO: remove in 1.2.
 
       # FIXME: this should just delegate to :model as in FB, and the comp would take care of it internally.
-      delegate [:persisted?, :to_key, :to_param] => composition_model  # #to_key => song.to_key
+      [:persisted?, :to_key, :to_param].each do |method|
+        define_method method do
+          model[composition_model].send(method)
+        end
+      end
+
+      alias_method main_model, composition_model # #hit => model.song. # TODO: remove in 1.2.
+    end
 
-      alias_method main_model, composition_model # #hit => model.song.
+  private
+    def handle_deprecated_model_accessor(name, aliased=name)
+      define_method name do # form.band -> composition.band
+        warn %{[Reform] Deprecation WARNING: When using Composition, you may not call Form##{name} anymore to access the contained model. Please use Form#model[:#{name}] and have a lovely day!}
+
+        @model[name]
+      end
     end
   end
 

data/lib/reform/version.rb

@@ -1,3 +1,3 @@
 module Reform
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/reform.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["apotonick@gmail.com", "heinleng@gmail.com"]
   spec.description   = %q{Freeing your AR models from form logic.}
   spec.summary       = %q{Decouples your models from form by giving you form objects with validation, presentation, workflows and security.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/apotonick/reform"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency             "representable",  "~> 1.8.1"
-  spec.add_dependency             "disposable",     "~> 0.0.3"
+  spec.add_dependency             "disposable",     "~> 0.0.4"
   spec.add_dependency             "uber",           "~> 0.0.4"
   spec.add_dependency             "activemodel"
   spec.add_development_dependency "bundler",        "~> 1.3"

data/test/active_model_test.rb

@@ -110,9 +110,9 @@ class ActiveModelWithCompositionTest < MiniTest::Spec
   let (:duran) { OpenStruct.new }
   let (:form) { HitForm.new(:song => rio, :artist => duran) }
 
-  describe "main form reader #hit" do
+  describe "main form reader #hit" do# TODO: remove in 1.2. we don't support this reader #hit anymore.
     it "delegates to :on model" do
-      form.hit.must_equal rio
+      form.hit.must_equal rio # TODO: remove in 1.2.
     end
 
     it "doesn't delegate when :on missing" do
@@ -177,6 +177,6 @@ class ActiveModelWithCompositionTest < MiniTest::Spec
     end
 
 
-    AnotherForm.new(:song => rio).song.must_equal rio
+    AnotherForm.new(:song => rio).model[:song].must_equal rio
   end
 end

data/test/composition_test.rb

@@ -16,12 +16,6 @@ class CompositionTest < ReformSpec
     end
   end
 
-  it "creates readers to models" do
-    comp.song.object_id.must_equal rio.object_id
-    comp.artist.object_id.must_equal @artist.object_id
-  end
-
-
   describe "::from" do
     it "creates the same mapping" do
       comp =

data/test/form_composition_test.rb

@@ -2,23 +2,25 @@ require 'test_helper'
 
 class FormCompositionTest < MiniTest::Spec
   Song      = Struct.new(:id, :title)
-  Requester = Struct.new(:id, :name)
+  Requester = Struct.new(:id, :name, :requester)
 
   class RequestForm < Reform::Form
     include Composition
 
-    property  :name,          :on =>  :requester
-    property  :requester_id,  :on => :requester, :as => :id
+    # TODO: remove skip_accessors in 1.1.
+    property  :name,          :on =>  :requester, :skip_accessors => true
+    property  :requester_id,  :on => :requester, :as => :id, :skip_accessors => true
     properties [:title, :id], :on => :song
     # property  :channel # FIXME: what about the "main model"?
     property :channel, :empty => true, :on => :song
+    property :requester,      :on => :requester, :skip_accessors => true
 
     validates :name, :title, :channel, :presence => true
   end
 
   let (:form)   { RequestForm.new(:song => song, :requester => requester) }
   let (:song)   { Song.new(1, "Rio") }
-  let (:requester) { Requester.new(2, "Duran Duran") }
+  let (:requester) { Requester.new(2, "Duran Duran", "MCP") }
 
 
   # delegation form -> composition works
@@ -27,10 +29,19 @@ class FormCompositionTest < MiniTest::Spec
   it { form.name.must_equal "Duran Duran" }
   it { form.requester_id.must_equal 2 }
   it { form.channel.must_equal nil }
+  it { form.requester.must_equal "MCP" } # same name as composed model.
 
+  # [DEPRECATED] # TODO: remove in 1.2.
   # delegation form -> composed models (e.g. when saving this can be handy)
-  it { form.song.must_equal   song }
-  it { form.requester.must_equal requester }
+  it { form.song.must_equal song }
+
+
+  # #model just returns <Composition>.
+  it { form.model.must_be_kind_of Reform::Composition }
+
+  # #model[] -> composed models
+  it { form.model[:requester].must_equal requester }
+  it { form.model[:song].must_equal      song }
 
 
   it "creates Composition for you" do
@@ -58,7 +69,7 @@ class FormCompositionTest < MiniTest::Spec
         hash = map
       end
 
-      hash.must_equal({:song=>{:title=>"Greyhound", :id=>1, :channel => "JJJ"}, :requester=>{:name=>"Frenzal Rhomb", :id=>2}})
+      hash.must_equal({:song=>{:title=>"Greyhound", :id=>1, :channel => "JJJ"}, :requester=>{:name=>"Frenzal Rhomb", :id=>2, :requester => "MCP"}})
     end
 
     it "pushes data to models and calls #save when no block passed" do

data/test/reform_test.rb

@@ -249,11 +249,9 @@ class EmptyAttributesTest < MiniTest::Spec
   let (:cred) { Credentials.new }
   let (:form) { PasswordForm.new(cred) }
 
-  it { form }
+  before { form.validate("password" => "123", "password_confirmation" => "321") }
 
   it {
-
-    form.validate("password" => "123", "password_confirmation" => "321")
     form.password.must_equal "123"
     form.password_confirmation.must_equal "321"
 

data/test/setup_test.rb

@@ -1,8 +1,37 @@
 require 'test_helper'
 
 class SetupTest < BaseTest
+  class AlbumForm < Reform::Form
+    property :title
+
+    property :hit do
+      property :title
+      validates :title, :presence => true
+    end
+
+    collection :songs do
+      property :title
+      validates :title, :presence => true
+
+      property :length do
+        property :minutes
+      end
+    end
+
+    property :band do # yepp, people do crazy stuff like that.
+      property :label do
+        property :name
+        validates :name, :presence => true
+      end
+      # TODO: make band a required object.
+    end
+
+    validates :title, :presence => true
+  end
+
+
   describe "populated" do
-    subject { AlbumForm.new(Album.new("Best Of", hit, [Song.new("Fallout"), Song.new("Roxanne")])) }
+    subject { AlbumForm.new(Album.new("Best Of", hit, [Song.new("Fallout", Length.new(2,3)), Song.new("Roxanne")])) }
 
     it { subject.title.must_equal "Best Of" }
 
@@ -15,6 +44,7 @@ class SetupTest < BaseTest
 
     it { subject.songs[0].must_be_kind_of Reform::Form }
     it { subject.songs[0].title.must_equal "Fallout" }
+    it { subject.songs[0].length.minutes.must_equal 2 }
 
     it { subject.songs[1].must_be_kind_of Reform::Form }
     it { subject.songs[1].title.must_equal "Roxanne" }

data/test/test_helper.rb

@@ -29,10 +29,11 @@ class BaseTest < MiniTest::Spec
     end
   end
 
-  Song  = Struct.new(:title)
-  Album = Struct.new(:title, :hit, :songs, :band)
-  Band  = Struct.new(:label)
-  Label = Struct.new(:name)
+  Song   = Struct.new(:title, :length)
+  Album  = Struct.new(:title, :hit, :songs, :band)
+  Band   = Struct.new(:label)
+  Label  = Struct.new(:name)
+  Length = Struct.new(:minutes, :seconds)
 
 
   let (:hit) { Song.new("Roxanne") }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reform
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nick Sutterer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -31,14 +31,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: uber
   requirement: !ruby/object:Gem::Requirement
@@ -248,7 +248,7 @@ files:
 - test/sync_test.rb
 - test/test_helper.rb
 - test/validate_test.rb
-homepage: ''
+homepage: https://github.com/apotonick/reform
 licenses:
 - MIT
 metadata: {}