reform 1.1.1 → 1.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4eac1a339ca122c10c68332cbb713fee79ef7670
-  data.tar.gz: fbea1c3d34b9af52108f4d3e508b562b32f79c27
+  metadata.gz: 463e240b0183da1d46a70a9252959ead4e45a152
+  data.tar.gz: 07842a7a220f1c72bdc412d49a187bf7ed1b76bf
 SHA512:
-  metadata.gz: 9242a0e45d2392e58af57958d695d37fb0f316f90701ebc383e256a72fa01066097e441752cd1deb112dabe628d91fca7ccfee835ee3deb2e2997fb0ca69a836
-  data.tar.gz: a95af8299b9fc16284ec5c5d583208c1efdc12ed3a6a0bfc71a6cb885409731102d20faba0009c7827523baee402165d9cf331589e41e841d0d449b0b7d2ada5
+  metadata.gz: bb02ec3ec33906652a1b72aba03481751c0e5b6a5516a1f6b11dd2cf001a681b9b21d16b764b69f4e482875213926ad4d13b4d7a7c5002417419bed3f9653008
+  data.tar.gz: 6a2c816422517921b3b3b93a400deb35b5c989ffa6ea9b21f8d3789aa3d07d52717e36a1b3f313e622344ab3c17bc469d26efe860dc6de120f15f4dad220c779

data/CHANGES.md

@@ -1,6 +1,40 @@
-## 1.1.2
+## 1.2.0
 
+### Breakage
+
+* Due to countless bugs we no longer include support for simple_form's type interrogation automatically. This allows using forms with non-AM objects. 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.
+
+### Changes
+
+* `Form#save` with `Composition` now returns true only if all composite models saved.
+* `Form::copy_validations_from` allows copying custom validators now.
 * `::validates_uniqueness_of` now accepts options like `:scope`. Thanks to @cveneziani for a failing test and insight.
+* New call style for `::properties`. Instead of an array, it's now `properties :title, :genre`.
+* All options are evaluated with `pass_options: true`.
+
+### New Stuff!!!
+
+* `:skip_if`, `:skip_if: :all_blank`.
+* You can now specify validations right in the `::property` call.
+
+    ```ruby
+    property :title, validates: {presence: true}
+    ```
+
+    Thanks to @zubin for this brillant idea!
+* Wanna parse JSON in `#validate`? Include `Reform::Form::JSON`.
+* Dirty
+* :sync
+* :save
+* `Sync::SkipUnchanged`.
+
 
 ## 1.1.1
 

data/Gemfile

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

data/README.md

@@ -29,13 +29,32 @@ class SongForm < Reform::Form
   property :title
   property :length
 
-  validates :title,  presence: true
+  validates :title, presence: true
   validates :length, numericality: true
 end
 ```
 
-To add fields to the form use the `::property` method. Also, validations no longer go into the model but sit in the form.
+Define your form's fields using `::property`. Validations no longer go into the model, but into the form.
 
+Luckily, this can be shortened as follows.
+
+```ruby
+class SongForm < Reform::Form
+  property :title, validates: {presence: true}
+  property :length, validates {numericality: true}
+end
+```
+
+Use `properties` to bulk-specify fields.
+
+```ruby
+class SongForm < Reform::Form
+  properties :title, :length, validates: {presence: true} # both required!
+  validates :length, numericality: true
+end
+```
+
+After explicitely defining your fields, you're ready to use the form.
 
 ## The API
 
@@ -163,12 +182,21 @@ You can always access the form's model. This is helpful when you were using popu
 
 ```ruby
   @form.save do |nested|
-    album = @form.album.model
+    album = @form.model
 
     album.update_attributes(nested[:album])
   end
 ```
 
+If the form wraps multiple models, via [composition](#compositions), you can access them like this:
+
+```ruby
+  @form.save do |nested|
+    song = @form.model[:song]
+    label = @form.model[:label]
+  end
+```
+
 Note that you can call `#sync` and _then_ call `#save { |hsh| }` to save models yourself.
 
 
@@ -202,7 +230,7 @@ In future versions and with the upcoming [Trailblazer framework](https://github.
 
 ### Using Contracts
 
-Applying a contract is simple, all you need is a populated object (e.g. an album after `#update_attributes`).
+Applying a contract is simple, all you need is a populated object (e.g. an album after `#assign_attributes`).
 
 ```ruby
 album.assign_attributes(..)
@@ -288,9 +316,7 @@ Or use something like `#fields_for` in a Rails environment.
 The block form of `#save` would give you the following data.
 
 ```ruby
-@form.save do |data, nested|
-  data.title #=> "Hungry Like The Wolf"
-  data.artist.name #=> "Duran Duran"
+@form.save do |nested|
 
   nested #=> {title:  "Hungry Like The Wolf",
          #    artist: {name: "Duran Duran"}}
@@ -357,9 +383,7 @@ However, `#fields_for` works just fine, again.
 The block form of `#save` will expose the data structures already discussed.
 
 ```ruby
-@form.save do |data, nested|
-  data.title #=> "Rio"
-  data.songs.first.title #=> "Hungry Like The Wolf"
+@form.save do |nested|
 
   nested #=> {title: "Rio"
          #   songs: [{title: "Hungry Like The Wolf"},
@@ -482,9 +506,7 @@ When using `#save' without a block reform will use writer methods on the differe
 Here's how the block parameters look like.
 
 ```ruby
-@form.save do |data, nested|
-  data.title #=> "Rio"
-  data.city  #=> "London"
+@form.save do |nested|
 
   nested #=> {
          #   song:  {title: "Rio"}
@@ -632,7 +654,7 @@ form.password_confirmation #=> "321"
 The nested hash in the block-`#save` provides the same value.
 
 ```ruby
-form.save do |f, nested|
+form.save do |nested|
   nested[:password_confirmation] #=> "321"
 ```
 
@@ -652,10 +674,8 @@ You want to use this to display an initial value or to further process this fiel
 It is still readable in the nested hash and through the form itself.
 
 ```ruby
-form.save do |f, nested|
+form.save do |nested|
   nested[:country] #=> "Australia"
-
-  f.country #=> "Australia"
 ```
 
 ## Validations From Models
@@ -765,6 +785,18 @@ class SongForm < Reform::Form
 end
 ```
 
+## 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.
+
+```ruby
+class SongForm < Reform::Form
+  property :image
+
+  validates :image, file_size: {less_than: 2.megabytes},
+    file_content_type: {allow: ['image/jpeg', 'image/png', 'image/gif']}
+```
+
 ## Multiparameter Dates
 
 Composed multi-parameter dates as created by the Rails date helper are processed automatically. As soon as Reform detects an incoming `release_date(i1)` or the like it is gonna be converted into a date.
@@ -777,9 +809,7 @@ Note that the date will be `nil` when one of the components (year/month/day) is
 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
+## Nesting Without Inline Representers
 
 When nesting form, you usually use a so-called inline form doing `property :song do .. end`.
 
@@ -792,7 +822,7 @@ property :song, form: SongForm
 The nested `SongForm` is a stand-alone form class you have to provide.
 
 
-### Overriding Accessors
+## Overriding Setters For Coercion
 
 When "real" coercion is too much and you simply want to convert incoming data yourself, override the setter.
 
@@ -808,6 +838,38 @@ class SongForm < Reform::Form
 This will capitalize the title _after_ calling `form.validate` but _before_ validation happens. Note that you can use `super` to call the original setter.
 
 
+## Default Values For Presentation
+
+In case you want to change a value for presentation or provide a default value, override the reader. This is only considered when the form is rendered (e.g. in `form_for`).
+
+```ruby
+class SongForm < Reform::Form
+  property :genre
+
+  def genre
+    super || 'Punkrock'
+  end
+end
+```
+
+This will now be used when rendering the view.
+
+```haml
+= f.input :genre # calls form.genre which provides default.
+```
+
+## Dirty Tracker
+
+Every form tracks changes in `#validate` and allows to check if a particular property value has changed using `#changed?`.
+
+```ruby
+form.title => "Button Up"
+
+form.validate("title" => "Just Kiddin'")
+form.changed?(:title) #=> true
+```
+
+
 ## Undocumented Features
 
 _(Please don't read this section!)_

data/TODO.md

@@ -1,3 +1,11 @@
+* fields is a Twin and sorts out all the changed? stuff.
+* virtual: don't read dont write
+* empty dont read, but write
+* read_only: read, don't write
+
+
+
+
 * `validates :title, :presence => true`
   with @model.title == "Little Green Car" and validate({}) the form is still valid (as we "have" a valid title). is that what we want?
 

data/gemfiles/Gemfile.rails-4.0

@@ -5,3 +5,4 @@ gemspec :path => '../'
 
 gem 'railties', '~> 4.0.0'
 gem 'activerecord', '~> 4.0.0'
+gem 'minitest', '~> 4.2'

data/lib/reform.rb

@@ -1,14 +1,16 @@
 module Reform
-  autoload :Contract, 'reform/contract'
-
   def self.rails3_0?
     ::ActiveModel::VERSION::MAJOR == 3 and ::ActiveModel::VERSION::MINOR == 0
   end
 end
 
+require 'reform/contract'
 require 'reform/form'
 require 'reform/form/composition'
 require 'reform/form/active_model'
+require 'reform/form/module'
+require 'reform/composition'
+
 
 if defined?(Rails) # DISCUSS: is everyone ok with this?
   require 'reform/rails'

data/lib/reform/active_record.rb

@@ -1,2 +1,3 @@
 require 'reform/form/active_model'
-require 'reform/form/active_record'
+require 'reform/form/active_record'
+require 'reform/form/model_reflections' # only load this in AR context as simple_form currently is bound to AR.

data/lib/reform/composition.rb

@@ -42,7 +42,7 @@ module Reform
     end
 
     def save
-      each { |model| model.save }
+      each.collect { |model| model.save }.all?
     end
 
     def nested_hash_for(attrs)
@@ -60,4 +60,4 @@ module Reform
       end
     end
   end
-end
+end

data/lib/reform/contract.rb

@@ -1,6 +1,7 @@
 require 'forwardable'
 require 'uber/inheritable_attr'
 require 'uber/delegates'
+require 'ostruct'
 
 require 'reform/representer'
 
@@ -29,11 +30,13 @@ module Reform
     module PropertyMethods
       def property(name, options={}, &block)
         options[:private_name] = options.delete(:as)
-
         options[:coercion_type] = options.delete(:type)
-
         options[:features] ||= []
         options[:features] += features.keys if block_given?
+        options[:pass_options] = true
+        options[:virtual] = true if options[:empty] # TODO: check TODO and fix naming!
+
+        validates(name, options.delete(:validates).dup) if options[:validates]
 
         definition = representer_class.property(name, options, &block)
         setup_form_definition(definition) if block_given? or options[:form]
@@ -42,16 +45,22 @@ module Reform
         definition
       end
 
+      def properties(*args)
+        options = args.extract_options!
+
+        if args.first.is_a? Array # TODO: REMOVE in 2.0.
+          warn "[Reform] Deprecation: Please pass a list of names instead of array to ::properties, like `properties :title, :id`."
+          args = args.first
+        end
+        args.each { |name| property(name, options.dup) }
+      end
+
       def collection(name, options={}, &block)
         options[:collection] = true
 
         property(name, options, &block)
       end
 
-      def properties(names, options={})
-        names.each { |name| property(name, options.dup) }
-      end
-
       def setup_form_definition(definition)
         options = {
           # TODO: make this a bit nicer. why do we need :form at all?
@@ -65,6 +74,7 @@ module Reform
       end
 
     private
+
       def create_accessor(name)
         handle_reserved_names(name)
 
@@ -123,6 +133,13 @@ module Reform
       end
     end
 
+    def self.clone
+      Class.new(self)
+    end
+
+    require 'reform/schema'
+    extend Schema
+
     alias_method :aliased_model, :model
 
 
@@ -137,4 +154,4 @@ module Reform
   end
 end
 
-require 'reform/contract/errors'
+require 'reform/contract/errors'

data/lib/reform/contract/setup.rb

@@ -1,4 +1,3 @@
-
 module Reform
   class Contract
     module Setup
@@ -9,8 +8,9 @@ module Reform
 
       def setup_fields
         representer = mapper.new(aliased_model).extend(Setup::Representer)
+        options     = setup_options(Reform::Representer::Options[]) # handles :empty.
 
-        create_fields(representer.fields, representer.to_hash)
+        create_fields(mapper.fields, representer.to_hash(options))
       end
 
       # DISCUSS: setting up the Validation (populating with values) will soon be handled with Disposable::Twin logic.
@@ -18,14 +18,16 @@ module Reform
         Fields.new(field_names, fields)
       end
 
+      module SetupOptions
+        def setup_options(options)
+          options
+        end
+      end
+      include SetupOptions
+
 
       # Mechanics for setting up initial Field values.
       module Representer
-        require 'reform/form/virtual_attributes' # FIXME: that shouldn't be here.
-
-        include Reform::Representer::WithOptions
-        include Reform::Form::EmptyAttributesOptions # FIXME: that shouldn't be here.
-
         def to_hash(*)
           nested_forms do |attr|
             attr.merge!(
@@ -36,9 +38,19 @@ module Reform
             )
           end
 
-          super # TODO: allow something like super(:exclude => empty_fields)
+          super
         end
       end # Representer
+
+
+      module Empty
+        def setup_options(options)
+          empty_fields = mapper.representable_attrs.find_all { |d| d[:empty] }.collect  { |d| d.name.to_sym }
+
+          options.exclude!(empty_fields)
+        end
+      end
+      include Empty
     end
-  end # Validation
+  end # Setup
 end