reform 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b232b1d3bcc6dea9226b28873a60bba7a56772df
-  data.tar.gz: 4b987843362c2cc4ff3349304f0672182437a828
+  metadata.gz: 7858098ed982e9c00c56016f1678e26f4c43b9e6
+  data.tar.gz: e518cbde390737b8308ce6aa41d398b6b48b2533
 SHA512:
-  metadata.gz: 1c7eefc137c219075f02c5ff89035fadb1868b7b693ac828b100f63621f55158f0dc05b6a497efc935193f670438a42675487ebacdd5dfacf9d0c8a990a53911
-  data.tar.gz: 70f13e49731d80f0645f4467fb5521cce5b34ee9fe7490b23f0b2d6f79f66630ecec4902a2d17d2758a1b861804ad437ce205f3fcba693a084274e89f6662139
+  metadata.gz: 0d4cb6de758aeb2892ee47bb69c8f9bb061f184b8088b9eac294ed3add2e72d364b5425206b9720c671892b1926be13bff7d9a3d7a3ac818381468c9115db695
+  data.tar.gz: 868a33c66a5a2225da3a12596f7c1f703e10403a1ef7353393d237ae368b6be55148d9eb8a2fe3bdda8e1744100d3e6d668b224226001997e19d029269747d2f

data/CHANGES.md

@@ -1,4 +1,10 @@
-h3. 0.2.1
+## 0.2.2
+
+* Fix a bug where `form.save do .. end` would call `model.save` even though a block was given. This no longer happens, if there's a block to `#save`, you have to manually save data (ActiveRecord environment, only).
+* `#validate` doesn't blow up anymore when input data is missing for a nested property or collection.
+* Allow `form: SongForm` to specify an explicit form class instead of using an inline form for nested properties.
+
+## 0.2.1
 
 * `ActiveRecord::i18n_scope` now returns `activerecord`.
 * `Form#save` now calls save on the model in `ActiveRecord` context.
@@ -9,7 +15,7 @@ h3. 0.2.1
 * Move `setup` and `save` logic into respective representer classes. This might break your code in case you overwrite private reform classes.
 
 
-h3. 0.2.0
+## 0.2.0
 
 * Added nested property and collection for `has_one` and `has_many` relationships. . Note that this currently works only 1-level deep.
 * Renamed `Reform::Form::DSL` to `Reform::Form::Composition` and deprecated `DSL`.
@@ -18,21 +24,21 @@ h3. 0.2.0
 * `Form.new` now accepts one argument, only: the model/composition. If you want to create your own representer, inject it by overriding `Form#mapper`. Note that this won't create property accessors for you.
 * `Form::ActiveModel` no longer creates accessors to your represented models, e.g. having `property :title, on: :song` doesn't allow `form.song` anymore. This is because the actual model and the form's state might differ, so please use `form.title` directly.
 
-h3. 0.1.3
+## 0.1.3
 
 * Altered `reform/rails` to conditionally load `ActiveRecord` code and created `reform/active_record`.
 
-h3. 0.1.2
+## 0.1.2
 
 * `Form#to_model` is now delegated to model.
 * Coercion with virtus works.
 
-h3. 0.1.1
+## 0.1.1
 
 * Added `reform/rails` that requires everything you need (even in other frameworks :).
 * Added `Form::ActiveRecord` that gives you `validates_uniqueness_with`. Note that this is strongly coupled to your database, thou.
 * Merged a lot of cleanups from sweet @parndt <3.
 
-h3. 0.1.0
+## 0.1.0
 
 * Oh yeah.

data/README.md

@@ -402,8 +402,12 @@ Nesting forms only requires readers for the nested properties as `Album#songs`.
 
 Check out [@gogogarret](https://twitter.com/GoGoGarrett/)'s [sample Rails app](https://github.com/gogogarrett/reform_example) using Reform.
 
-Rails and Reform work out-of-the-box. If you're using Rails but for some reason wanna use the pure reform, `require reform/form`, only.
+Rails and Reform work together out-of-the-box.
 
+However, you should know about two things.
+
+1. In case you explicitely _don't_ want to have automatic support for `ActiveRecord` and form builder: `require reform/form`, only.
+2. In some setups around Rails 4 the `Form::ActiveRecord` module is not loaded properly, usually triggering a `NoMethodError` saying `undefined method 'model'`. If that happened to you, `require 'reform/rails'` manually at the bottom of your `config/application.rb`.
 
 ## ActiveRecord Compatibility
 
@@ -451,13 +455,27 @@ class SongForm < Reform::Form
 end
 ```
 
-
 ## Security
 
 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.
 
 
+## Additional Features
+
+### Nesting Without Inline Representers
+
+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.
+
+```ruby
+property :song, form: SongForm`
+```
+
+The nested `SongForm` is a stand-alone form class you have to provide.
+
+
 ## Support
 
 If you run into any trouble chat with us on irc.freenode.org#trailblazer.

data/lib/reform/form/active_model.rb

@@ -24,15 +24,22 @@ module Reform::Form::ActiveModel
       # DISCUSS: #validate should actually expect the complete params hash and then pick the right key as it knows the form name.
       # however, this would cause confusion?
       mapper.new(self).nested_forms do |attr, model| # FIXME: make this simpler.
-        if attr.options[:form_collection] # FIXME: why no array?
-          params[attr.name] = params["#{attr.name}_attributes"].values
-        else
-          params[attr.name] = params["#{attr.name}_attributes"]# DISCUSS: delete old key? override existing?
-        end
+        rename_nested_param_for!(params, attr)
       end
 
       super
     end
+
+  private
+    def rename_nested_param_for!(params, attr)
+      nested_name = "#{attr.name}_attributes"
+      return unless params.has_key?(nested_name)
+
+      value = params["#{attr.name}_attributes"]
+      value = value.values if attr.options[:form_collection]
+
+      params[attr.name] = value
+    end
   end
 
 

data/lib/reform/form/active_record.rb

@@ -36,7 +36,7 @@ class Reform::Form
 
     def save(*)
       super.tap do
-        model.save # DISCUSS: should we implement nested saving here?
+        model.save unless block_given? # DISCUSS: should we implement nested saving here?
       end
     end
 

data/lib/reform/form/multi_parameter_attributes.rb

@@ -0,0 +1,36 @@
+class Reform::Form
+  module MultiParameterAttributes
+    class DateParamsFilter
+      def call(params)
+        date_attributes = {}
+
+        params.each do |attribute, value|
+          if value.is_a?(Hash)
+            call(value) # TODO: #validate should only handle local form params.
+          elsif matches = attribute.match(/^(\w+)\(.i\)$/)
+            date_attribute = matches[1]
+            date_attributes[date_attribute] = params_to_date(
+              params.delete("#{date_attribute}(1i)"),
+              params.delete("#{date_attribute}(2i)"),
+              params.delete("#{date_attribute}(3i)")
+            )
+          end
+        end
+        params.merge!(date_attributes)
+      end
+
+    private
+      def params_to_date(year, month, day)
+        day ||= 1 # FIXME: is that really what we want? test.
+        Date.new(year.to_i, month.to_i, day.to_i) # TODO: test fails.
+      end
+    end
+
+    def validate(params)
+      # TODO: make it cleaner to hook into essential reform steps.
+      DateParamsFilter.new.call(params)
+
+      super
+    end
+  end
+end

data/lib/reform/form.rb

@@ -20,7 +20,8 @@ module Reform
         process_options(name, options, &block)
 
         definition = representer_class.property(name, options, &block)
-        setup_form_definition(definition) if block_given?
+        setup_form_definition(definition) if block_given? or options[:form]
+
         create_accessor(name)
       end
 
@@ -35,7 +36,7 @@ module Reform
       end
 
       def setup_form_definition(definition)
-        definition.options[:form] = definition.options.delete(:extend)
+        definition.options[:form] ||= definition.options.delete(:extend)
 
         definition.options[:parse_strategy] = :sync
         definition.options[:instance] = true # just to make typed? work
@@ -82,9 +83,10 @@ module Reform
         errors.merge!(form.errors, prefix)
         false
       end
-
     end
     include ValidateMethods
+    require 'reform/form/multi_parameter_attributes'
+    include MultiParameterAttributes # TODO: make features dynamic.
 
     def save
       # DISCUSS: we should never hit @mapper here (which writes to the models) when a block is passed.

data/lib/reform/version.rb

@@ -1,3 +1,3 @@
 module Reform
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/test/active_model_test.rb

@@ -45,12 +45,15 @@ class FormBuilderCompatTest < MiniTest::Spec
 
       collection :songs do
         property :title
+        property :release_date
         validates :title, :presence => true
       end
     end
   }
-  let (:form) { form_class.new(OpenStruct.new(:artist => Artist.new, :songs => [OpenStruct.new])) }
-# TODO: test when keys are missing!
+
+  let (:song) { OpenStruct.new }
+  let (:form) { form_class.new(OpenStruct.new(
+    :artist => Artist.new(:name => "Propagandhi"), :songs => [song])) }
 
   it "respects _attributes params hash" do
     form.validate("artist_attributes" => {"name" => "Blink 182"},
@@ -60,11 +63,28 @@ class FormBuilderCompatTest < MiniTest::Spec
     form.songs.first.title.must_equal "Damnit"
   end
 
+  it "allows nested collection and property to be missing" do
+    form.validate({})
+
+    form.artist.name.must_equal "Propagandhi"
+
+    form.songs.size.must_equal 1
+    form.songs[0].model.must_equal song # this is a weird test.
+  end
+
   it "defines _attributes= setter so Rails' FB works properly" do
     form.must_respond_to("artist_attributes=")
     form.must_respond_to("songs_attributes=")
   end
 
+  it "accepts deconstructed date parameters" do
+    form.validate("artist_attributes" => {"name" => "Blink 182"},
+      "songs_attributes" => {"0" => {"title" => "Damnit", "release_date(1i)" => "1997",
+        "release_date(2i)" => "9", "release_date(3i)" => "27"}})
+
+    form.songs.first.release_date.must_equal Date.new(1997, 9, 27)
+  end
+
   it "returns flat errors hash" do
     form.validate("artist_attributes" => {"name" => ""},
       "songs_attributes" => {"0" => {"title" => ""}})

data/test/active_record_test.rb

@@ -57,11 +57,18 @@ class ActiveRecordTest < MiniTest::Spec
 
   describe "#save" do
     # TODO: test 1-n?
-    it "calls AR#save" do
+    it "calls model.save" do
       Artist.delete_all
       form.validate("name" => "Bad Religion")
       form.save
       Artist.where(:name => "Bad Religion").size.must_equal 1
     end
+
+    it "doesn't call model.save when block is given" do
+      Artist.delete_all
+      form.validate("name" => "Bad Religion")
+      form.save {}
+      Artist.where(:name => "Bad Religion").size.must_equal 0
+    end
   end
 end

data/test/dummy/config/application.rb

@@ -17,4 +17,4 @@ module Dummy
   end
 end
 
-require "reform/rails"
+#require "reform/rails" # FIXME: this has to happen automatically in the rake test_rails run.

data/test/nested_form_test.rb

@@ -57,7 +57,7 @@ class NestedFormTest < MiniTest::Spec
       "hit"   =>{"title" => "Sacrifice"},
       "title" =>"Second Heat",
       "songs" => [{"title" => "Scarified"}])
-    } # TODO: test empty/non-present songs
+    }
 
     it "updates internal Fields" do
       data = {}
@@ -104,6 +104,15 @@ class NestedFormTest < MiniTest::Spec
       song.title.must_equal "Sacrifice"
       songs.first.title.must_equal "Scarified"
     end
+
+    describe "with invalid args" do
+      it "allows empty collection values" do
+        form.validate({})
+
+        form.songs.size.must_equal 1
+        form.songs[0].title.must_equal "Scarified"
+      end
+    end
   end
 
   # describe "with aliased nested form name" do
@@ -119,6 +128,37 @@ class NestedFormTest < MiniTest::Spec
   #   end
   # end
 
+  class ExplicitNestedFormTest < MiniTest::Spec
+    let (:song)  { OpenStruct.new(:title => "Downtown") }
+    let (:album) do
+      OpenStruct.new(
+        :title  => "Blackhawks Over Los Angeles",
+        :hit    => song,
+      )
+    end
+    let (:form) { AlbumForm.new(album) }
+
+    class SongForm < Reform::Form
+      property :title
+      validates_presence_of :title
+    end
+
+    class AlbumForm < Reform::Form
+      property :title
+
+      property :hit, :form => SongForm #, :parse_strategy => :sync, :instance => true
+    end
+
+
+    it "allows rendering" do
+      form.hit.title.must_equal "Downtown"
+    end
+
+    it { form.validate({"hit" => {"title" => ""}})
+      form.errors[:"hit.title"].must_equal(["can't be blank"])
+    }
+  end
+
   class UnitTest < self
     it "keeps Forms for form collection" do
       form.send(:fields).songs.must_be_kind_of Reform::Form::Forms

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reform
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Nick Sutterer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-30 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -166,6 +166,7 @@ files:
 - lib/reform/form/active_record.rb
 - lib/reform/form/coercion.rb
 - lib/reform/form/composition.rb
+- lib/reform/form/multi_parameter_attributes.rb
 - lib/reform/form/virtual_attributes.rb
 - lib/reform/rails.rb
 - lib/reform/representer.rb