modelizer 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+=== 1.0.0 (2009-02-24)
+
+* Birthday!

data/Manifest.txt

@@ -0,0 +1,8 @@
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/modelizer.rb
+rails/init.rb
+test/helper.rb
+test/modelizer_test.rb

data/README.rdoc

@@ -0,0 +1,84 @@
+= Modelizer
+
+Need a simple, consistent way to create model instances in your Rails
+tests? Use the Modelizer.
+
+== Examples
+
+First, define a model template. I generally do this in the unit test
+for the model until I need to use the template somewhere else. As soon
+as it's used in multiple places, I move it to a reopened
+<tt>Test::Unit::TestCase</tt> in <tt>test/test_helper.rb</tt>.
+
+    class UserTest < ActiveSupport::TestCase
+
+      # a simple list of attributes
+      model_template_for User, :name => "Bob"
+
+      # or a block for lazy evaluation
+      model_template_for User do
+        { :name => "Bob", :address => addresses(:default) }
+      end
+
+    end
+
+This declaration generates a bunch of instance methods for you:
+
+* def valid_user_attributes(extras = {})
+* def valid_user_attributes_without(*excluded)
+* def new_user(extras = {})
+* def new_user_without(*excluded)
+* def create_user(extras = {})
+* def create_user!(extras = {})
+* def create_user_without(*excluded)
+* def create_user_without!(*excluded)
+
+It also generates a test to make sure your model template is valid.
+
+=== Using in Tests
+
+These methods are just simple helpers for model creation:
+
+    class UserTest < ActiveSupport::TestCase
+      model_template_for User, :name => "Bob"
+
+      def test_pointless_stuff
+        assert new_user.valid?
+        assert !new_user_without(:name).valid?
+
+        assert !create_user.new_record?
+
+        assert_raise do
+          create_user_without! :name
+        end
+
+        assert_equal "Fred", new_user(:name => "Fred").name
+      end
+    end
+
+== Installation
+
+    $ sudo gem install modelizer
+
+== License
+
+Copyright 2009 John Barnette (jbarnette@rubyforge.org)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,14 @@
+require "rubygems"
+require "hoe"
+
+Hoe.new "modelizer", "1.0.0" do |p|
+  p.developer "John Barnette", "jbarnette@rubyforge.org"
+
+  p.url              = "http://github.com/jbarnette/modelizer"
+  p.history_file     = "CHANGELOG.rdoc"
+  p.readme_file      = "README.rdoc"
+  p.extra_rdoc_files = [p.readme_file]
+  p.need_tar         = false
+  p.test_globs       = %w(test/**/*_test.rb)
+  p.testlib          = :minitest
+end

data/lib/modelizer.rb

@@ -0,0 +1,100 @@
+module Modelizer
+  @@cache = {}
+  def self.cache; @@cache end
+
+  def self.included target
+    target.extend ClassMethods
+  end
+
+  def assign_model_template_attributes model, attributes
+    model.send :attributes=, attributes, false
+    model
+  end
+
+  def valid_model_template_attributes klass, extras = {}
+    defaults, block = ::Modelizer.cache[klass]
+    lazy = block && instance_eval(&block)
+    [defaults, lazy, extras].compact.inject { |t, s| t.merge s }
+  end
+
+  def valid_model_template_attributes_without klass, excluded
+    valid_model_template_attributes(klass).delete_if do |k, v|
+      excluded.include? k
+    end
+  end
+
+  module ClassMethods
+    def model_template_for klass, defaults = {}, &block
+      if defaults.empty? && !block
+        raise "default attributes or lazy block required"
+      end
+
+      ::Modelizer.cache[klass] = [defaults, block]
+
+      klass = klass.name
+      model = klass.underscore.tr "/", "_"
+
+      module_eval <<-END, __FILE__, __LINE__ + 1
+        def valid_#{model}_attributes extras = {}
+          valid_model_template_attributes #{klass}, extras
+        end
+
+        def valid_#{model}_attributes_without *excluded
+          valid_model_template_attributes_without #{klass}, excluded
+        end
+
+        def new_#{model} extras = {}
+          assign_model_template_attributes #{klass}.new,
+            valid_model_template_attributes(#{klass}, extras)
+        end
+
+        def new_#{model}_without *excluded
+          assign_model_template_attributes #{klass}.new,
+            valid_model_template_attributes_without(#{klass}, excluded)
+        end
+
+        def create_#{model} extras = {}
+          (m = new_#{model}(extras)).save; m
+        end
+
+        def create_#{model}! extras = {}
+          (m = new_#{model}(extras)).save!; m
+        end
+
+        def create_#{model}_without *excluded
+          (m = new_#{model}_without(*excluded)).save; m
+        end
+
+        def create_#{model}_without! *excluded
+          (m = new_#{model}_without(*excluded)).save!; m
+        end
+      END
+
+      # Install a test that ensures the model template is valid. If
+      # the template is defined in one of the abstract test
+      # superclasses, generate a whole new testcase. If it's in a
+      # concrete test, just generate a method.
+
+      file, line = caller.first.split ":"
+      line = line.to_i
+
+      test =<<-END
+        def test_model_template_for_#{model}
+          assert (m = new_#{model}).valid?,
+            "#{klass} template is invalid: " +
+              m.errors.full_messages.to_sentence
+        end
+      END
+
+      if self == Test::Unit::TestCase
+        eval <<-END, nil, file, line - 2
+          class ::ModelTemplateFor#{klass}Test < ActiveSupport::TestCase
+            #{test}
+          end
+        END
+      else
+        module_eval test, file, line - 1
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+class ::Test::Unit::TestCase
+  include Modelizer
+end

data/test/helper.rb

@@ -0,0 +1,2 @@
+require "minitest/autorun"
+require "modelizer"

data/test/modelizer_test.rb

@@ -0,0 +1,15 @@
+require "minitest/unit"
+require "activesupport"
+require "modelizer"
+
+class TestModelizer < MiniTest::Unit::TestCase
+  def setup
+    @klass = Class.new
+    @klass.send :include, Modelizer
+  end
+
+  def test_adds_model_template_for_class_method
+    assert_includes @klass.singleton_methods.collect { |m| m.to_s },
+      "model_template_for"
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: modelizer
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- John Barnette
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-26 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.9.0
+    version: 
+description: ""
+email: 
+- jbarnette@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/modelizer.rb
+- rails/init.rb
+- test/helper.rb
+- test/modelizer_test.rb
+has_rdoc: true
+homepage: http://github.com/jbarnette/modelizer
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: modelizer
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: ""
+test_files: 
+- test/modelizer_test.rb