redtape 0.0.8 → 1.0.0

data/lib/redtape.rb

@@ -1,40 +1,38 @@
 require "redtape/version"
+require "redtape/attribute_whitelist"
+require "redtape/model_factory"
+require "redtape/populator/abstract"
+require "redtape/populator/root"
+require "redtape/populator/has_many"
+require "redtape/populator/has_one"
 
 require 'active_model'
 require 'active_support/core_ext/class/attribute'
 
+require 'active_record'
+
+require 'forwardable'
+
 module Redtape
+
+  class DuelingBanjosError < StandardError; end
+  class WhitelistViolationError < StandardError; end
+
   class Form
+    extend Forwardable
     extend ActiveModel::Naming
+    include ActiveModel::Callbacks
     include ActiveModel::Conversion
     include ActiveModel::Validations
 
-    validate :models_correct
-    class_attribute :model_accessors
+    def_delegator :@factory, :model
 
-    def self.validates_and_saves(*args)
-      attr_accessor *args
-      self.model_accessors = args
-    end
-
-    def initialize(attrs = {})
-      attrs.each do |k, v|
-        send("#{k}=", v)
+    def initialize(controller, args = {})
+      if controller.respond_to?(:populate_individual_record) && args[:whitelisted_attrs]
+        fail DuelingBanjosError, "Redtape::Form does not accept both  #{controller.class}#populate_individual_record and the 'whitelisted_attrs' argument"
       end
-    end
 
-    def models_correct
-      populate
-      self.class.model_accessors.each do |accessor|
-        begin
-          model = send(accessor)
-          if model.invalid?
-            own_your_errors_in(model)
-          end
-        rescue NoMethodError => e
-          fail NoMethodError, "#{self.class} is missing 'validates_and_saves :#{accessor}': #{e}"
-        end
-      end
+      @factory = ModelFactory.new(factory_args_for(controller, args))
     end
 
     # Forms are never themselves persisted
@@ -42,34 +40,38 @@ module Redtape
       false
     end
 
+    def valid?
+      model = @factory.populate_model
+      valid = model.valid?
+
+      # @errors comes from ActiveModel::Validations. This may not
+      # be a legit hook.
+      @errors = model.errors
+
+      valid
+    end
+
     def save
       if valid?
-        persist!
+        begin
+          ActiveRecord::Base.transaction do
+            @factory.save!
+          end
+        rescue ActiveRecord::RecordInvalid
+          # This shouldn't even happen with the #valid? above.
+        end
       else
         false
       end
     end
 
-    def persist!
-      self.class.model_accessors.each do |accessor|
-        model = send(accessor)
-        unless model.save
-          return false
-        end
-      end
-      true
-    end
-
-    def populate
-      fail NotImplementedError, "Implement #populate in your subclass"
-    end
-
     private
 
-    def own_your_errors_in(model)
-      model.errors.each do |k, v|
-        errors.add(k, v)
-      end
+    def factory_args_for(controller, args)
+      args.dup.merge(
+        :attrs => controller.params,
+        :controller => controller
+      )
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redtape
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -44,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -60,7 +76,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debugger
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -115,8 +131,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/redtape.rb
-- lib/redtape/version.rb
-- spec/form_spec.rb
 homepage: http://github.com/ClearFit/redtape
 licenses: []
 post_install_message: 
@@ -131,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1709053097785266848
+      hash: -2628988932070424880
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -140,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1709053097785266848
+      hash: -2628988932070424880
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -150,5 +164,4 @@ summary: Redtape provides an alternative to [ActiveRecord::NestedAttributes#acce
   in the form of, well, a Form!  The initial implementation was heavily inspired by
   ["7 Ways to Decompose Fat Activerecord Models"](http://blog.codeclimate.com/blog/2012/10/17/7-ways-to-decompose-fat-activerecord-models/)
   by [Bryan Helmkamp](https://github.com/brynary).
-test_files:
-- spec/form_spec.rb
+test_files: []

data/lib/redtape/version.rb

@@ -1,3 +0,0 @@
-module Redtape
-  VERSION = "0.0.8"
-end

data/spec/form_spec.rb

@@ -1,134 +0,0 @@
-require 'virtus'
-
-require 'redtape'
-require 'active_model'
-
-class TestUser
-  include Virtus
-
-  extend ActiveModel::Naming
-  include ActiveModel::Validations
-  include ActiveModel::Conversion
-
-  attribute :name, String
-
-  validates_presence_of :name
-  validate :name_contains_at_least_two_parts
-
-  def name_contains_at_least_two_parts
-    unless name =~ /.+ .+/
-      errors.add(:name, "should contain at least two parts")
-    end
-  end
-
-  def persisted?
-    valid?
-  end
-
-  def save
-    valid?
-  end
-end
-
-class TestRegistrationForm < Redtape::Form
-  validates_and_saves :test_user
-
-  attr_accessor :test_user
-
-  attr_accessor :first_name, :last_name
-
-  def populate
-    self.test_user = TestUser.new(:name => "#{first_name} #{last_name}")
-  end
-end
-
-describe Redtape::Form do
-  context "given a Form where the Form fields are a proper subset of the modeled fields" do
-    context "where across all involved objects" do
-      context "all field names are unique" do
-        context "and the data is invalid" do
-          context "in a root object" do
-            it "reports an error on the model as <field_name>"
-          end
-          context "in a nested belongs_to/has_one" do
-            it "reports an error on the model as <model_name>_<field_name>"
-          end
-          context "in a nested has_many" do
-            it "reports an error on the model as <model_name>_<field_name>"
-          end
-        end
-      end
-
-      context "some field names overlap" do
-      end
-    end
-  end
-
-  context "given a Form accepting a first and last name that creates a User" do
-    context "with valid data" do
-      subject {
-        TestRegistrationForm.new(
-          :first_name => "Evan",
-          :last_name => "Light"
-        )
-      }
-
-      context "after saving the form" do
-        before do
-          subject.save
-        end
-
-        specify { subject.should be_valid }
-        specify { subject.test_user.should be_valid }
-        specify { subject.test_user.should be_persisted }
-      end
-
-      context "after validating the form" do
-        before do
-          subject.valid?
-        end
-
-        specify { subject.test_user.should be_valid }
-      end
-    end
-
-    context "with invalid data" do
-      subject {
-        TestRegistrationForm.new.tap do |f|
-          f.first_name = "Evan"
-        end
-      }
-
-      context "after saving the form" do
-        before do
-          subject.save
-        end
-
-        specify { subject.should_not be_valid }
-        specify { subject.should_not be_persisted }
-        specify { subject.errors.should have_key(:name) }
-        specify { subject.test_user.should_not be_valid }
-      end
-    end
-  end
-
-  context "given another Form subclass" do
-    before do
-      Class.new(Redtape::Form) do
-        validates_and_saves :test_object
-      end.new(:test_object => :foo)
-    end
-
-    subject {
-      TestRegistrationForm.new
-    }
-
-    context "TestRegistrationForm still saves User" do
-      before do
-        subject.save
-      end
-
-      specify { subject.should_not be_valid }
-    end
-  end
-end