reform 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 201a01642c1743227a0209c716240374d884189f
-  data.tar.gz: 4327aa39fbfae302b0078c6787a0df387aa08080
+  metadata.gz: 76401e86f77b8b06874c24e8257dc97e5d0e66c0
+  data.tar.gz: 37e55343b9fc0d9b7d7764c4988f01f22db0d4fc
 SHA512:
-  metadata.gz: 42bad26c32be288977aae6cc6be0f634382b5bdc0cc733ce5b0f2084096db897df33b7126923b58f9d3eee4f50e63b1ee0095650a2c414c12a2c1e9fbc5148fd
-  data.tar.gz: 94ebe84171e96c49fff4adbdc704d5c94cebc0713a27a35b86941ffc33e23947e7371afe9b8d6fce3f7bffee1cd6ba2363418635abd87f65230bbebf7b2bf385
+  metadata.gz: 9b7b1d9f9ed49bff28ac3bd83802b8d73d20005bd9126a1d25b6a342e031a0e44a5ed675686242468c29c2ac7bf7c5b71bb7bf40c53ec5811d26ba601c02ca97
+  data.tar.gz: 557e270fa0dfbaad214790f3aaa0bf579d90feeb4b70a5193fcd2bb526b4ada902d3308081ae67b0a6fdcd13b2048afd389b9625cf7c9a8819668a3c1f247095

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.2.5
+
+* Allow proper form inheritance. When having `HitForm < SongForm < Reform::Form` the `HitForm` class will contain `SongForm`'s properties in addition to its own fields.
+* `::model` is now inherited properly.
+
 ## 0.2.4
 
 * Accessors for properties (e.g. `title` and `title=`) can now be overridden in the form *and* call `super`. This is extremely helpful if you wanna do "manual coercion" since the accessors are invoked in `#validate`. Thanks to @cj for requesting this.

data/README.md

@@ -271,12 +271,17 @@ class SongWithLabelForm < Reform::Form
   property :title, on: :song
   property :city,  on: :label
 
+  model :song # only needed in ActiveModel context.
+
   validates :title, :city, presence: true
 end
 ```
 
 Note that reform needs to know about the owner objects of properties. You can do so by using the `on:` option.
 
+Also, the form needs to have a main object configured. This is where ActiveModel-methods like `#persisted?` or '#id' are delegated to. Use `::model` to define the main object.
+
+
 ### Composition: Setup
 
 The constructor slightly differs.
@@ -415,6 +420,15 @@ Reform provides the following `ActiveRecord` specific features. They're mixed in
  * Uniqueness validations. Use `validates_uniqueness_of` in your form.
  * Calling `Form#save` will explicitely call `save` on your model (added in 0.2.1) which will usually trigger a database insertion or update.
 
+As mentioned in the [Rails Integration](https://github.com/apotonick/reform#rails-integration) section some Rails 4 setups do not properly load.
+
+You may want to include the module manually then.
+
+```ruby
+class SongForm < Reform::Form
+  include Reform::Form::ActiveRecord
+```
+
 
 ## ActiveModel Compliance
 

data/lib/reform/form.rb

@@ -4,15 +4,18 @@ require 'ostruct'
 require 'reform/composition'
 require 'reform/representer'
 
+require 'uber/inheritable_attr'
+
+
 module Reform
   class Form
     extend Forwardable
-    # reasons for delegation:
-    # presentation: this object is used in the presentation layer by #form_for.
-    # problem: #form_for uses respond_to?(:email_before_type_cast) which goes to an internal hash in the actual record.
-    # validation: this object also contains the validation rules itself, should be separated.
 
-    # Allows using property and friends in the Form itself. Forwarded to the internal representer_class.
+    extend Uber::InheritableAttr
+    inheritable_attr :representer_class
+    self.representer_class = Class.new(Reform::Representer)
+
+
     module PropertyMethods
       extend Forwardable
 
@@ -43,10 +46,6 @@ module Reform
         definition.options[:instance] = true # just to make typed? work
       end
 
-      def representer_class
-        @representer_class ||= Class.new(Reform::Representer)
-      end
-
     private
       def create_accessor(name)
         # Make a module that contains these very accessors, then include it

data/lib/reform/form/active_model.rb

@@ -55,18 +55,28 @@ module Reform::Form::ActiveModel
     end
   end
 
+
   module ClassMethods
+    # this module is only meant to extend (not include). # DISCUSS: is this a sustainable concept?
+    def self.extended(base)
+      base.class_eval do
+        extend Hooks::InheritableAttribute
+        inheritable_attr :model_options
+      end
+    end
+
+
     # Set a model name for this form if the infered is wrong.
     #
     #   class CoverSongForm < Reform::Form
     #     model :song
     def model(main_model, options={})
-      @model_options = [main_model, options]  # FIXME: make inheritable!
+      self.model_options = [main_model, options]
     end
 
     def model_name
-      if @model_options
-        form_name = @model_options.first.to_s.camelize
+      if model_options
+        form_name = model_options.first.to_s.camelize
       else
         form_name = name.sub(/Form$/, "")
       end

data/lib/reform/form/composition.rb

@@ -5,12 +5,13 @@ class Reform::Form
   module Composition
     def self.included(base)
       base.class_eval do
+        extend Reform::Form::ActiveModel::ClassMethods # ::model.
         extend ClassMethods
       end
     end
 
     module ClassMethods
-      include Reform::Form::ActiveModel::ClassMethods # ::model.
+      #include Reform::Form::ActiveModel::ClassMethods # ::model.
 
       def model_class # DISCUSS: needed?
         rpr = representer_class

data/lib/reform/representer.rb

@@ -47,6 +47,10 @@ module Reform
         each(&block)
     end
 
+    def self.clone # called in inheritable_attr :representer_class.
+      Class.new(self) # By subclassing, representable_attrs.clone is called.
+    end
+
   private
     def clone_config!
       # TODO: representable_attrs.clone! which does exactly what's done below.

data/lib/reform/version.rb

@@ -1,3 +1,3 @@
 module Reform
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/reform.gemspec

@@ -19,10 +19,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency             "representable",  ">= 1.7.5"
+  spec.add_dependency             "uber",           "~> 0.0.4"
   spec.add_dependency             "activemodel"
   spec.add_development_dependency "bundler",        "~> 1.3"
   spec.add_development_dependency "rake",           ">= 10.1.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest",       "4.2.0"
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "virtus"

data/test/active_model_test.rb

@@ -30,6 +30,15 @@ class NewActiveModelTest < MiniTest::Spec # TODO: move to test/rails/
 
     it { class_with_model.model_name.must_be_kind_of ActiveModel::Name }
     it { class_with_model.model_name.to_s.must_equal "Album" }
+    
+
+    let (:subclass_of_class_with_model) {
+      Class.new(class_with_model)
+    }
+
+    it { subclass_of_class_with_model.model_name.must_be_kind_of ActiveModel::Name }
+    it { subclass_of_class_with_model.model_name.to_s.must_equal 'Album' }
+
 
     describe "inline with model" do
       let (:form_class) {
@@ -198,6 +207,18 @@ class ActiveModelWithCompositionTest < MiniTest::Spec
         model :song
       end.new(:song => rio, :artist => duran).song.must_equal rio
     end
+
+    # it "delegates when you call ::model" do
+    #   class SongOnlyForm < Reform::Form
+    #     include Composition
+    #     include Reform::Form::ActiveModel
+
+    #     property :title,  :on => :song
+    #     model :song
+
+    #     self
+    #   end.new(:song => rio, :artist => duran).persisted?
+    # end
   end
 
 
@@ -240,4 +261,4 @@ class ActiveModelWithCompositionTest < MiniTest::Spec
 
     AnotherForm.new(:song => rio).song.must_equal rio
   end
-end
+end

data/test/reform_test.rb

@@ -112,12 +112,14 @@ class ReformTest < ReformSpec
     end
 
     it "exposes input via property accessors" do
-      comp.name.must_equal nil
-      form.name.must_equal nil
-
       form.validate("name" => "Duran Duran")
 
       form.name.must_equal "Duran Duran"
+    end
+
+    it "doesn't change model properties" do
+      form.validate("name" => "Duran Duran")
+
       comp.name.must_equal nil # don't touch model, yet.
     end
 
@@ -213,6 +215,22 @@ class ReformTest < ReformSpec
   describe "#model" do
     it { form.model.must_equal comp }
   end
+
+
+  describe "inheritance" do
+    class HitForm < SongForm
+      property :position
+      validates :position, :presence => true
+    end
+
+    let (:form) { HitForm.new(OpenStruct.new) }
+    it do
+      form.validate({"title" => "The Body"})
+      form.title.must_equal "The Body"
+      form.position.must_equal nil
+      form.errors.messages.must_equal({:name=>["can't be blank"], :position=>["can't be blank"]})
+    end
+  end
 end
 
 class EmptyAttributesTest < MiniTest::Spec

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reform
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Nick Sutterer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-22 00:00:00.000000000 Z
+date: 2014-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -25,6 +25,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.5
+- !ruby/object:Gem::Dependency
+  name: uber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -71,16 +85,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -225,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: Decouples your models from form by giving you form objects with validation,