reform 0.1.0 → 0.1.1

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.8.7
+  - rbx-19mode
+  - jruby-19mode

data/CHANGES.md

@@ -1,3 +1,9 @@
+h3. 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
 
 * Oh yeah.

data/README.md

@@ -100,19 +100,23 @@ To push the incoming data to the models directly, call `#save` without the block
                 #   by calling @form.song.name= and @form.artist.title=.
 ```
 
-## ActiveModel - Rails Integration
+## Rails Integration
 
-Reform offers ActiveModel support to easily make this accessible in Rails based projects.  You simply `include Reform::Form::ActiveModel` in your form object and the Rails specific code will be handled for you.
+[A sample Rails app using Reform.](https://github.com/gogogarrett/reform_example)
+
+Reform offers ActiveRecord support to easily make this accessible in Rails based projects. You simply `include Reform::Form::ActiveRecord` in your form object and the Rails specific code will be handled for you. This happens by adding behaviour to make the form ActiveModel-compliant. Note that this module will also work with other ORMs like Datamapper.
 
 ### Simple Integration
 #### Form Class
 
-You have to include a call to `model` to specifiy which is the main object of the form.
+You have to include a call to `model` to specify which is the main object of the form.
 
 ```ruby
+require 'reform/rails'
+
 class UserProfileForm < Reform::Form
   include DSL
-  include Reform::Form::ActiveModel
+  include Reform::Form::ActiveRecord
 
   property :email,        on: :user
   properties [:gender, :age],   on: :profile
@@ -121,9 +125,11 @@ class UserProfileForm < Reform::Form
 
   validates :email, :gender, presence: true
   validates :age, numericality: true
+  validates_uniqueness_of :email
 end
 ```
 
+
 #### View Form
 
 The form becomes __very__ dumb as it knows nothing about the backend assocations or data binding to the database layer.  This simply takes input and passes it along to the controller as it should.
@@ -165,6 +171,22 @@ end
 
 __Note__: this can also be used for the update action as well.
 
+## Using Your Models In Validations
+
+Sometimes you want to access your database in a validation. You can access the models using the `#model` accessor in the form.
+
+```ruby
+class ArtistForm < Reform::Form
+  property :name
+
+  validate "name_correct?"
+
+  def name_correct?
+    errors.add :name, "#{name} is stupid!" if model.artist.stupid_name?(name)
+  end
+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.

data/TODO.md

@@ -0,0 +1,2 @@
+* `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/lib/reform.rb

@@ -1,9 +1,4 @@
-require "reform/version"
-
-module Reform
-  # Your code goes here...
-end
-
+require 'reform/version'
 require 'reform/form'
 require 'reform/form/dsl'
 require 'reform/form/active_model'

data/lib/reform/form.rb

@@ -92,7 +92,7 @@ module Reform
     private
       def create_accessors(model, methods)
         accessors = methods.collect { |m| [m, "#{m}="] }.flatten
-        delegate *accessors, to: "@#{model}"
+        delegate *accessors << {:to => :"#{model}"}
       end
     end
 
@@ -129,4 +129,4 @@ module Reform
       representable_attrs.collect { |cfg| cfg.name }
     end
   end
-end
+end

data/lib/reform/form/active_model.rb

@@ -11,7 +11,7 @@ module Reform::Form::ActiveModel
       main_model      = args.last[:on]
 
       delegate main_model, :to => :model  # #song => model.song
-      delegate "persisted?", :to_key, :to_param, :to => main_model  # #to_key => song.to_key
+      delegate :persisted?, :to_key, :to_param, :to => main_model  # #to_key => song.to_key
 
       alias_method args.first, main_model # #hit => model.song.
     end
@@ -22,7 +22,7 @@ module Reform::Form::ActiveModel
     end
 
     def model_name
-      ActiveModel::Name.new(self, nil, @model_options.first.to_s.camelize)
+      ::ActiveModel::Name.new(self, nil, @model_options.first.to_s.camelize)
     end
   end
-end
+end

data/lib/reform/form/active_record.rb

@@ -0,0 +1,34 @@
+class Reform::Form
+  module ActiveRecord
+    def self.included(base)
+      base.class_eval do
+        include ActiveModel
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def validates_uniqueness_of(attribute)
+        validates_with UniquenessValidator, :attributes => [attribute]
+      end
+    end
+
+    class UniquenessValidator < ::ActiveRecord::Validations::UniquenessValidator
+      # when calling validates it should create the Vali instance already and set @klass there! # TODO: fix this in AM.
+      def validate(form)
+        property = attributes.first
+        model_name = form.send(:model).class.model_for_property(property)
+
+        # here is the thing: why does AM::UniquenessValidator require a filled-out record to work properly? also, why do we need to set
+        # the class? it would be way easier to pass #validate a hash of attributes and get back an errors hash.
+        # the class for the finder could either be infered from the record or set in the validator instance itself in the call to ::validates.
+        record = form.send(model_name)
+        record.send("#{property}=", form.send(property))
+        @klass = record.class # this is usually done in the super-sucky #setup method.
+        super(record).tap do |res|
+          form.errors.add(property, record.errors.first.last) if record.errors.present?
+        end
+      end
+    end
+  end
+end

data/lib/reform/rails.rb

@@ -0,0 +1,2 @@
+require 'reform/form/active_model'
+require 'reform/form/active_record'

data/lib/reform/version.rb

@@ -1,3 +1,3 @@
 module Reform
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/reform.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Nick Sutterer", "Garrett Heinlen"]
   spec.email         = ["apotonick@gmail.com", "heinleng@gmail.com"]
   spec.description   = %q{Freeing your AR models from form logic.}
-  spec.summary       = %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.license       = "MIT"
 
@@ -19,8 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency             "representable"
+  spec.add_dependency             "activemodel"
   spec.add_development_dependency "bundler",        "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
-  spec.add_development_dependency "activemodel"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
 end

data/test/active_model_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+
+class ActiveModelTest < MiniTest::Spec
+   class HitForm < Reform::Form
+    include DSL
+    include Reform::Form::ActiveModel
+
+    property  :title,  :on => :song
+    properties [:name, :genre],   :on => :artist
+
+    model :hit, :on => :song
+  end
+
+  let (:rio) { OpenStruct.new(:title => "Rio") }
+  let (:duran) { OpenStruct.new }
+  let (:form) { HitForm.new(:song => rio, :artist => duran) }
+
+  it "creates model readers" do
+    form.hit.must_equal rio
+  end
+
+  it "creates composition readers" do
+    form.song.must_equal rio
+    form.artist.must_equal duran
+  end
+
+  it "provides ::model_name" do
+    form.class.model_name.must_equal "Hit"
+  end
+
+  it "provides #persisted?" do
+    HitForm.new(:song => OpenStruct.new.instance_eval { def persisted?; "yo!"; end; self }, :artist => OpenStruct.new).persisted?.must_equal "yo!"
+  end
+
+  it "provides #to_key" do
+    HitForm.new(:song => OpenStruct.new.instance_eval { def to_key; "yo!"; end; self }, :artist => OpenStruct.new).to_key.must_equal "yo!"
+  end
+
+  it "provides #to_param" do
+    HitForm.new(:song => OpenStruct.new.instance_eval { def to_param; "yo!"; end; self }, :artist => OpenStruct.new).to_param.must_equal "yo!"
+  end
+
+  it "works with any order of ::model and ::property" do
+    class AnotherForm < Reform::Form
+      include DSL
+      include Reform::Form::ActiveModel
+
+      model :song, :on => :song
+      property  :title,  :on => :song
+    end
+
+
+    AnotherForm.new(:song => rio).song.must_equal rio
+  end
+end

data/test/dsl_test.rb

@@ -7,7 +7,7 @@ class DslTest < MiniTest::Spec
     property  :title,  :on => :song
     properties [:name, :genre],   :on => :artist
 
-    validates :name, :title, :genre, presence: true
+    validates :name, :title, :genre, :presence => true
   end
 
   let (:form) { SongForm.new(:song => OpenStruct.new(:title => "Rio"), :artist => OpenStruct.new()) }
@@ -16,57 +16,3 @@ class DslTest < MiniTest::Spec
     form.validate("title" => "Greyhound", "name" => "Frenzal Rhomb").must_equal false
   end
 end
-
-class ActiveModelTest < MiniTest::Spec
-   class HitForm < Reform::Form
-    include DSL
-    include Reform::Form::ActiveModel
-
-    property  :title,  :on => :song
-    properties [:name, :genre],   :on => :artist
-
-    model :hit, :on => :song
-  end
-
-  let (:rio) { OpenStruct.new(:title => "Rio") }
-  let (:duran) { OpenStruct.new }
-  let (:form) { HitForm.new(:song => rio, :artist => duran) }
-
-  it "creates model readers" do
-    form.hit.must_equal rio
-  end
-
-  it "creates composition readers" do
-    form.song.must_equal rio
-    form.artist.must_equal duran
-  end
-
-  it "provides ::model_name" do
-    form.class.model_name.must_equal "Hit"
-  end
-
-  it "provides #persisted?" do
-    HitForm.new(:song => OpenStruct.new.instance_eval { def persisted?; "yo!"; end; self }, :artist => OpenStruct.new).persisted?.must_equal "yo!"
-  end
-
-  it "provides #to_key" do
-    HitForm.new(:song => OpenStruct.new.instance_eval { def to_key; "yo!"; end; self }, :artist => OpenStruct.new).to_key.must_equal "yo!"
-  end
-
-  it "provides #to_param" do
-    HitForm.new(:song => OpenStruct.new.instance_eval { def to_param; "yo!"; end; self }, :artist => OpenStruct.new).to_param.must_equal "yo!"
-  end
-
-  it "works with any order of ::model and ::property" do
-    class AnotherForm < Reform::Form
-      include DSL
-      include Reform::Form::ActiveModel
-
-      model :song, :on => :song
-      property  :title,  :on => :song
-    end
-
-
-    AnotherForm.new(:song => rio).song.must_equal rio
-  end
-end

data/test/reform_test.rb

@@ -1,5 +1,14 @@
 require 'test_helper'
 
+require 'active_record'
+class Artist < ActiveRecord::Base
+end
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => "#{Dir.pwd}/database.sqlite3"
+)
+
+
 class RepresenterTest < MiniTest::Spec
   class SongRepresenter < Reform::Representer
     properties [:title, :year]
@@ -50,8 +59,8 @@ class ReformTest < MiniTest::Spec
   let (:form) { SongForm.new(SongAndArtistMap, comp) }
 
   class SongAndArtistMap < Reform::Representer
-    property :name, on: :artist
-    property :title, on: :song
+    property :name, :on => :artist
+    property :title, :on => :song
   end
 
   class SongForm < Reform::Form
@@ -152,12 +161,68 @@ class ReformTest < MiniTest::Spec
     end
 
     # TODO: test errors. test valid.
-    it "returns false when invalid" do
+    describe "invalid input" do
       class ValidatingForm < Reform::Form
-        validates :name, :presence => true
+        validates :name,  :presence => true
+        validates :title, :presence => true
+      end
+      let (:form) { ValidatingForm.new(SongAndArtistMap, comp) }
+
+      it "returns false when invalid" do
+        form.validate({}).must_equal false
+      end
+
+      it "populates errors" do
+        form.validate({})
+        form.errors.messages.must_equal({:name=>["can't be blank"], :title=>["can't be blank"]})
+      end
+    end
+
+    describe "method validations" do
+      it "allows accessing models" do
+        form = Class.new(Reform::Form) do
+          validate "name_correct?"
+
+          def name_correct?
+            errors.add :name, "Please give me a name" if model.artist.name.nil?
+          end
+        end.new(SongAndArtistMap, comp)
+
+        form.validate({}).must_equal false
+        form.errors.messages.must_equal({:name=>["Please give me a name"]})
+      end
+    end
+
+    describe "UniquenessValidator" do
+      # ActiveRecord::Schema.define do
+      #   create_table :artists do |table|
+      #     table.column :name, :string
+      #   end
+      # end
+      #Artist.new(:name => "Racer X").save
+      let (:comp) { SongAndArtist.new(:artist => Artist.new, :song => OpenStruct.new) }
+
+      it "allows accessing the database" do
       end
 
-      ValidatingForm.new(SongAndArtistMap, comp).validate({}).must_equal false
+      it "is valid when name is unique" do
+        ActiveRecordForm.new(SongAndArtistMap, comp).validate({"name" => "Paul Gilbert", "title" => "Godzilla"}).must_equal true
+      end
+
+      it "is invalid and shows error when taken" do
+        form = ActiveRecordForm.new(SongAndArtistMap, comp)
+        form.validate({"name" => "Racer X"}).must_equal false
+        form.errors.messages.must_equal({:name=>["has already been taken"], :title => ["can't be blank"]})
+      end
+
+      require 'reform/rails'
+      class ActiveRecordForm < Reform::Form
+        include Reform::Form::ActiveRecord
+        model :artist, :on => :artist # FIXME: i want form.artist, so move this out of ActiveModel into ModelDelegations.
+
+        validates_uniqueness_of :name
+        validates :title, :presence => true # have another property to test if we mix up.
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reform
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-09 00:00:00.000000000 Z
+date: 2013-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: representable
@@ -28,6 +28,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -77,7 +93,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -101,17 +133,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- TODO.md
+- database.sqlite3
 - lib/reform.rb
 - lib/reform/form.rb
 - lib/reform/form/active_model.rb
+- lib/reform/form/active_record.rb
 - lib/reform/form/dsl.rb
+- lib/reform/rails.rb
 - lib/reform/version.rb
 - reform.gemspec
+- test/active_model_test.rb
 - test/dsl_test.rb
 - test/reform_test.rb
 - test/test_helper.rb
@@ -139,8 +177,10 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Freeing your AR models from form logic.
+summary: Decouples your models from form by giving you form objects with validation,
+  presentation, workflows and security.
 test_files:
+- test/active_model_test.rb
 - test/dsl_test.rb
 - test/reform_test.rb
 - test/test_helper.rb