reform 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b6f50b16163b7e3445a9efe6c8142f6dc9c87f5
-  data.tar.gz: fc8017f514448b2ea059cc39aa1dccd8a1106f94
+  metadata.gz: 6ad4504340052787a18f70b1249517dfd7ccc443
+  data.tar.gz: 7bae41c59ff9cc4b242a0eb0855f7fa382c2e4ac
 SHA512:
-  metadata.gz: 6144492691a54df88a3f72680480db06021314c8dbe26de2cde0d65ac88ce1c9527f1546dd7ed9f23bc4bb4e134df177acacdde622a740fbb483c161a1108039
-  data.tar.gz: 9a648e2fcbf4d0708a8dc5966324be103f40233b8c17470585fd44e0e119117555d213045fd71077bfae2eec3353f444bd79522cd4902195ee5cd6298ad21973
+  metadata.gz: b11cfe1184db4d697a87397acaaa2791ff8c8bdffd89682116aa17e6b91d51c0c5b3de44c4e923266fcf8db9cc994c72c49312210c092d8c54e0bf0d62301e2d
+  data.tar.gz: 42823db698bc87293a992987df02305ce8069459e707847cafb686c5477798a79a9f1b61c27825d8e5bb254bb6e58b005830b481ab64855312b5999d60e5d7c9

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 1.2.6
+
+* Added `:prepopulate` to fill out form properties for presentation. Note that you need to call `Form#prepopulate!` to trigger the prepopulation.
+* Added support for DateTime properties in forms. Until now, we were ignoring the time part. Thanks to @gdott9 for fixing this.
+
 ## 1.2.5
 
 * Added `Form#options_for` to have access to all property options.

data/README.md

@@ -8,7 +8,13 @@ Although reform can be used in any Ruby framework, it comes with [Rails support]
 ![](https://raw.githubusercontent.com/apotonick/trailblazer/master/doc/trb.jpg)
 </a>
 
-Reform is part of the [Trailblazer project](https://github.com/apotonick/trailblazer). Please [buy my book](https://leanpub.com/trailblazer) to support the development (and to learn all the cool stuff about Reform).
+Reform is part of the [Trailblazer project](https://github.com/apotonick/trailblazer). Please [buy my book](https://leanpub.com/trailblazer) to support the development and learn everything about Reform. Currently the book discusses:
+
+* Form objects, the DSL and basic API (chapter 2 and 3)
+* Basic validations and rendering forms (chapter 3)
+* Nested forms, prepopulating and validation populating and pre-selecting values (chapter 5)
+
+More chapters are coming!
 
 
 ## Installation
@@ -114,7 +120,6 @@ class SongForm < Reform::Form
 
 This will still call `song.title` but expose the attribute as `name`.
 
-
 ## Rendering Forms
 
 Your `@form` is now ready to be rendered, either do it yourself or use something like Rails' `#form_for`, `simple_form` or `formtastic`.
@@ -128,6 +133,7 @@ Your `@form` is now ready to be rendered, either do it yourself or use something
 
 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.
 
+Note that you have a mechanism to [prepopulate forms](#prepopulating-forms) for rendering.
 
 ## Validation
 
@@ -800,6 +806,17 @@ class SongForm < Reform::Form
 end
 ```
 
+### Simple Form
+
+If you want full support for `simple_form` do as follows.
+
+```ruby
+class SongForm < Reform::Form
+  include ModelReflections
+```
+
+Including this module will add `#column_for_attribute` and other methods need by form builders to automatically guess the type of a property.
+
 ## Validations For File Uploads
 
 In case you're processing uploaded files with your form using CarrierWave, Paperclip, Dragonfly or Paperdragon we recommend using the awesome [file_validators](https://github.com/musaffa/file_validators) gem for file type and size validations.
@@ -922,6 +939,29 @@ The two features are an excellent way to handle file uploads without ActiveRecor
 _(Please don't read this section!)_
 
 
+### Prepopulating Forms
+
+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.
+
+You can use the `:prepopulate` option to configure how to populate a nested form (this also works for scalar properties).
+
+```ruby
+property :song, prepopulate: ->(*) { Song.new } do
+  # ..
+end
+```
+
+This option is only executed when being instructed to do so, using the `#prepopulate!` method.
+
+```ruby
+form.prepopulate!
+```
+
+Only do this for forms that are about to get rendered, though.
+
+Collections and partial collection population is covered in chapter 5.
+
+
 ### Populator
 
 You can run your very own populator logic if you're keen (and you know what you're doing).
@@ -949,6 +989,7 @@ You can do this using `#options_for`.
 form.options_for(:title) # => {:readable=>true, :coercion_type=>String}
 ```
 
+Note that Reform renames some options (e.g. `:type` internally becomes `:coercion_type`). Those names are private API and might be changed without deprecation. You better test rendering logic in a unit test to make sure you're forward-compatible.
 
 ## Support
 

data/lib/reform/form.rb

@@ -2,14 +2,16 @@ module Reform
   class Form < Contract
     self.representer_class = Reform::Representer.for(:form_class => self)
 
-    require 'reform/form/validate'
+    require "reform/form/validate"
     include Validate # extend Contract#validate with additional behaviour.
-    require 'reform/form/sync'
+    require "reform/form/sync"
     include Sync
-    require 'reform/form/save'
+    require "reform/form/save"
     include Save
+    require "reform/form/prepopulate"
+    include Prepopulate
 
-    require 'reform/form/multi_parameter_attributes'
+    require "reform/form/multi_parameter_attributes"
     include MultiParameterAttributes # TODO: make features dynamic.
 
   private
@@ -19,12 +21,12 @@ module Reform
     end
 
 
-    require 'reform/form/scalar'
+    require "reform/form/scalar"
     extend Scalar::Property # experimental feature!
 
 
     # DISCUSS: should that be optional? hooks into #validate, too.
-    require 'reform/form/changed'
+    require "reform/form/changed"
     register_feature Changed
     include Changed
   end

data/lib/reform/form/multi_parameter_attributes.rb

@@ -1,22 +1,28 @@
 Reform::Form.class_eval do
+  # TODO: this must be implemented with a parse_filter that is only applied to type: Time or Datetime properties.
+  # we then simply add the converted attribute to params.
   module MultiParameterAttributes
+    # TODO: implement this with parse_filter, so we don't have to manually walk through the hash, etc.
     def self.included(base)
       base.send(:register_feature, self)
     end
 
-    class DateParamsFilter
+    class DateTimeParamsFilter
       def call(params)
+        params = params.dup # DISCUSS: not sure if that slows down form processing?
         date_attributes = {}
 
         params.each do |attribute, value|
           if value.is_a?(Hash)
-            call(value) # TODO: #validate should only handle local form params.
+            params[attribute] = 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)")
+              params.delete("#{date_attribute}(3i)"),
+              params.delete("#{date_attribute}(4i)"),
+              params.delete("#{date_attribute}(5i)")
             )
           end
         end
@@ -24,22 +30,22 @@ Reform::Form.class_eval do
       end
 
     private
-      def params_to_date(year, month, day)
-        return nil if blank_date_parameter?(year, month, day)
+      def params_to_date(year, month, day, hour, minute)
+        return nil if [year, month, day].any?(&:blank?)
 
-        Date.new(year.to_i, month.to_i, day.to_i) # TODO: test fails.
-      end
-
-      def blank_date_parameter?(year, month, day)
-        year.blank? || month.blank? || day.blank?
+        if hour.blank? && minute.blank?
+          Date.new(year.to_i, month.to_i, day.to_i) # TODO: test fails.
+        else
+          args = [year, month, day, hour, minute].map(&:to_i)
+          Time.zone ? Time.zone.local(*args) :
+            Time.new(*args)
+        end
       end
     end
 
     def validate(params)
       # TODO: make it cleaner to hook into essential reform steps.
-      # TODO: test with nested.
-      DateParamsFilter.new.call(params) if params.is_a?(Hash) # this currently works for hash, only.
-
+      params = DateTimeParamsFilter.new.call(params) if params.is_a?(Hash) # this currently works for hash, only.
       super
     end
 
@@ -63,4 +69,4 @@ Reform::Form.class_eval do
     #   end
     # end
   end
-end
+end

data/lib/reform/form/prepopulate.rb

@@ -0,0 +1,54 @@
+# this will soon be handled in Disposable.
+module Reform::Form::Prepopulate
+  def prepopulate!
+    # TODO: representer.new(fields).from_object(fields)
+    hash = prepopulate_representer.new(fields).to_hash(:parent_form => self)
+    prepopulate_representer.new(fields).from_hash(hash)
+
+    recursive_prepopulate_representer.new(fields).to_hash # not sure if i leave that like this, consider private.
+    self
+  end
+private
+  def prepopulate_representer
+    self.class.representer(:prepopulate, :all => true) do |dfn|
+      next unless block = dfn[:prepopulate] or dfn[:form]
+
+      if dfn[:form]
+        dfn.merge!(
+          :render_filter => lambda do |v, h, options|
+            parent_form = options.user_options[:parent_form] # TODO: merge with Validate/populate_if_empty.
+
+            # execute in form context, pass user optioins.
+            object = parent_form.instance_exec(options.user_options, &options.binding[:prepopulate])
+
+            if options.binding.array?
+              object.collect { |item| options.binding[:form].new(item) }
+            else
+              options.binding[:form].new(object)
+            end
+          end,
+          :representable  => false,
+
+          :instance => lambda { |obj, *| obj } # needed for from_hash. TODO: make that in one go.
+        )
+      else
+        dfn.merge!(:render_filter => lambda do |v, h, options|
+          parent_form = options.user_options[:parent_form] # TODO: merge with Validate/populate_if_empty.
+
+          # execute in form context, pass user optioins.
+          parent_form.instance_exec(options.user_options, &options.binding[:prepopulate])
+        end)
+      end
+    end
+  end
+
+  def recursive_prepopulate_representer
+    self.class.representer(:recursive_prepopulate_representer) do |dfn|
+      dfn.merge!(
+        :serialize => lambda { |object, *| model = object.prepopulate! } # sync! returns the synced model.
+        # representable's :setter will do collection=([..]) or property=(..) for us on the model.
+      )
+    end
+  end
+
+end

data/lib/reform/version.rb

@@ -1,3 +1,3 @@
 module Reform
-  VERSION = "1.2.5"
+  VERSION = "1.2.6"
 end

data/test/form_builder_test.rb

@@ -64,19 +64,22 @@ class FormBuilderCompatTest < BaseTest
     form.must_respond_to("label_attributes=")
   end
 
-  describe "deconstructed date parameters" do
+  describe "deconstructed datetime parameters" do
     let(:form_attributes) do
       {
         "artist_attributes" => {"name" => "Blink 182"},
         "songs_attributes" => {"0" => {"title" => "Damnit", "release_date(1i)" => release_year,
-          "release_date(2i)" => release_month, "release_date(3i)" => release_day}}
+          "release_date(2i)" => release_month, "release_date(3i)" => release_day,
+          "release_date(4i)" => release_hour, "release_date(5i)" => release_minute}}
       }
     end
     let(:release_year) { "1997" }
     let(:release_month) { "9" }
     let(:release_day) { "27" }
+    let(:release_hour) { nil }
+    let(:release_minute) { nil }
 
-    describe "with valid parameters" do
+    describe "with valid date parameters" do
       it "creates a date" do
         form.validate(form_attributes)
 
@@ -84,6 +87,17 @@ class FormBuilderCompatTest < BaseTest
       end
     end
 
+    describe "with valid datetime parameters" do
+      let(:release_hour) { "10" }
+      let(:release_minute) { "11" }
+
+      it "creates a datetime" do
+        form.validate(form_attributes)
+
+        form.songs.first.release_date.must_equal Time.new(1997, 9, 27, 10, 11)
+      end
+    end
+
     %w(year month day).each do |date_attr|
       describe "when the #{date_attr} is missing" do
         let(:"release_#{date_attr}") { "" }
@@ -95,6 +109,15 @@ class FormBuilderCompatTest < BaseTest
         end
       end
     end
+
+
+    # doesn't modify original params.
+    it do
+      original = form_attributes.inspect
+
+      form.validate(form_attributes)
+      form_attributes.inspect.must_equal original
+    end
   end
 
   it "returns flat errors hash" do
@@ -102,4 +125,4 @@ class FormBuilderCompatTest < BaseTest
       "songs_attributes" => {"0" => {"title" => ""}})
     form.errors.messages.must_equal(:"artist.name" => ["can't be blank"], :"songs.title" => ["can't be blank"])
   end
-end
+end

data/test/prepopulate_test.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+
+class PrepopulateTest < MiniTest::Spec
+  Song = Struct.new(:title, :band, :length)
+  Band = Struct.new(:name)
+
+  class AlbumForm < Reform::Form
+    property :title, prepopulate: ->(options){ "Another Day At Work" }
+    property :length
+
+    property :hit, prepopulate: ->(options){ Song.new } do
+      property :title
+
+      property :band, prepopulate: ->(options){ Band.new } do
+        property :name
+      end
+    end
+
+    collection :songs, prepopulate: ->(options){ [Song.new, Song.new] } do
+      property :title
+    end
+  end
+
+  subject { AlbumForm.new(OpenStruct.new(length: 1)).prepopulate! }
+
+  it { subject.length.must_equal 1 }
+  it { subject.title.must_equal "Another Day At Work" }
+  it { subject.hit.model.must_equal Song.new }
+  it { subject.songs.size.must_equal 2 }
+  it { subject.songs[0].model.must_equal Song.new }
+  it { subject.songs[1].model.must_equal Song.new }
+  it { subject.hit.band.model.must_equal Band.new }
+end
+
+
+class PrepopulateInFormContextTest < MiniTest::Spec
+  Song = Struct.new(:title, :band, :length)
+  Band = Struct.new(:name)
+
+  class AlbumForm < Reform::Form
+    property :title, prepopulate: ->(options){ "#{my_title} #{options.class}" }
+
+    property :hit, prepopulate: ->(options){ my_hit } do
+      property :title
+
+      property :band, prepopulate: ->(options){ my_band } do
+        property :name
+      end
+
+      def my_band
+        Band.new
+      end
+    end
+
+    def my_title
+      "Rhode Island Shred"
+    end
+
+    def my_hit
+      Song.new
+    end
+  end
+
+  subject { AlbumForm.new(OpenStruct.new).prepopulate! }
+
+  it { subject.title.must_equal "Rhode Island Shred Hash" }
+  it { subject.hit.model.must_equal Song.new }
+  it { subject.hit.band.model.must_equal Band.new }
+end
+
+class PrepopulateWithExistingCollectionTest < MiniTest::Spec
+  Song = Struct.new(:title)
+
+  class AlbumForm < Reform::Form
+    collection :songs, prepopulate: ->(*){ songs.map(&:model) + [Song.new] } do
+      property :title
+    end
+  end
+
+  subject { AlbumForm.new(OpenStruct.new(songs: [Song.new])).prepopulate! }
+
+  it { subject.songs.size.must_equal 2 }
+  it { subject.songs[0].model.must_equal Song.new }
+  it { subject.songs[1].model.must_equal Song.new }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reform
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.6
 platform: ruby
 authors:
 - Nick Sutterer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-09 00:00:00.000000000 Z
+date: 2015-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -218,6 +218,7 @@ files:
 - lib/reform/form/model_reflections.rb
 - lib/reform/form/module.rb
 - lib/reform/form/multi_parameter_attributes.rb
+- lib/reform/form/prepopulate.rb
 - lib/reform/form/save.rb
 - lib/reform/form/scalar.rb
 - lib/reform/form/sync.rb
@@ -273,6 +274,7 @@ files:
 - test/model_reflections_test.rb
 - test/model_validations_test.rb
 - test/nested_form_test.rb
+- test/prepopulate_test.rb
 - test/rails/integration_test.rb
 - test/read_only_test.rb
 - test/readable_test.rb
@@ -361,6 +363,7 @@ test_files:
 - test/model_reflections_test.rb
 - test/model_validations_test.rb
 - test/nested_form_test.rb
+- test/prepopulate_test.rb
 - test/rails/integration_test.rb
 - test/read_only_test.rb
 - test/readable_test.rb