with_model 0.1.1 → 0.1.2

data/.gitignore

@@ -3,3 +3,5 @@ pkg/*
 *.gem
 .bundle
 .rvmrc
+doc
+gemfiles/**/Gemfile.lock

data/CHANGELOG

@@ -0,0 +1,3 @@
+### 0.1.2
+
+Make Mixico optional.

data/README.rdoc

@@ -0,0 +1,128 @@
+= with_model
+
+* http://github.com/casecommons/with_model/
+
+== DESCRIPTION
+
++with_model+ dynamically builds an ActiveRecord model (with table) within an RSpec context. Outside of the context, the model is no longer present.
+
+== INSTALL
+
+ gem install with_model
+
+=== RSpec 2
+
+In spec_helper.rb:
+
+  RSpec.configure do |config|
+    config.extend WithModel
+  end
+
+=== Rspec 1
+
+In spec_helper.rb:
+
+  Spec::Runner.configure do |config|
+    config.extend WithModel
+  end
+
+== USAGE
+
+In an RSpec example group, call +with_model+ and inside its block pass it a +table+ block and a +model+ block.
+
+  require 'spec_helper'
+
+  describe "A blog post" do
+
+    with_model :blog_post do
+      # The table block works just like a migration.
+      table do |t|
+        t.string :title
+        t.timestamps
+      end
+
+      # The model block works just like the class definition.
+      model do
+        include SomeModule
+        has_many :comments
+        validates_presence_of :title
+
+        def self.some_class_method
+          'chunky'
+        end
+
+        def some_instance_method
+          'bacon'
+        end
+      end
+    end
+
+    # with_model classes can have associations.
+    with_model :comment do
+      table do |t|
+        t.string :text
+        t.belongs_to :blog_post
+        t.timestamps
+      end
+
+      model do
+        belongs_to :blog_post
+      end
+    end
+
+    it "can be accessed as a constant" do
+      BlogPost.should be
+    end
+
+    it "can be accessed as a local variable" do
+      blog_post.should be
+    end
+
+    it "can be accessed as an instance variable" do
+      @blog_post.should be
+    end
+
+    it "has the module" do
+      BlogPost.include?(SomeModule).should be_true
+    end
+
+    it "has the class method" do
+      BlogPost.some_class_method.should == 'chunky'
+    end
+
+    it "has the instance method" do
+      BlogPost.new.some_instance_method.should == 'bacon'
+    end
+
+    it "can do all the things a regular model can" do
+      record = BlogPost.new
+      record.should_not be_valid
+      record.title = "foo"
+      record.should be_valid
+      record.save.should be_true
+      record.reload.should == record
+      record.comments.create!(:text => "Lorem ipsum")
+      record.comments.count.should == 1
+    end
+  end
+
+  describe "another example group" do
+    it "should not have the constant anymore" do
+      defined?(BlogPost).should be_false
+    end
+  end
+
+=== Mixico
+
+If you have the +mixico+ gem installed, WithModel will automatically unmix any modules that were mixed into your model class. Without +mixico+, each module will hold a reference to the class for the remainder of your test suite.
+
+Usually unmixing isn't necessary, but it can be helpful if you use something like Module#included_in_classes (from Active Support 2.3) in a later test to ask a module which classes it has been mixed into.
+
+== REQUIREMENTS
+
+* RSpec
+* ActiveRecord 2 or 3
+
+== LICENSE:
+
+MIT

data/Rakefile

@@ -33,3 +33,12 @@ namespace "autotest" do
     end
   end
 end
+
+namespace "doc" do
+  desc "Generate README and preview in browser"
+  task "readme" do
+    sh "rdoc -c utf8 README.rdoc && open doc/files/README_rdoc.html"
+  end
+end
+
+task :default => :spec

data/lib/with_model/base.rb

@@ -1,4 +1,7 @@
-require 'mixico'
+begin
+  require 'mixico'
+rescue LoadError
+end
 
 module WithModel
   class Base < ActiveRecord::Base
@@ -7,20 +10,22 @@ module WithModel
         true
       end
 
-      def include(*args)
-        @modules_to_unmix ||= []
-        args.each do |mod|
-          unless @modules_to_unmix.include?(mod)
-            @modules_to_unmix << mod
+      if defined?(Mixico)
+        def include(*args)
+          @modules_to_unmix ||= []
+          args.each do |mod|
+            unless @modules_to_unmix.include?(mod)
+              @modules_to_unmix << mod
+            end
           end
+          super
         end
-        super
-      end
 
-      def _with_model_deconstructor
-        @modules_to_unmix.each do |mod|
-          disable_mixin mod
-        end if defined?(@modules_to_unmix)
+        def _with_model_deconstructor
+          @modules_to_unmix.each do |mod|
+            disable_mixin mod
+          end if defined?(@modules_to_unmix)
+        end
       end
     end
   end

data/lib/with_model/dsl.rb

@@ -32,7 +32,7 @@ module WithModel
       end
 
       example_group.after do
-        model._with_model_deconstructor
+        model._with_model_deconstructor if defined?(Mixico)
         Object.send(:remove_const, const_name)
         Object.const_set(const_name, original_const_value) if original_const_defined
       end

data/lib/with_model/version.rb

@@ -1,3 +1,3 @@
 module WithModel
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/active_record_behaviors_spec.rb

@@ -4,7 +4,14 @@ describe "ActiveRecord behaviors" do
   describe "a temporary ActiveRecord model created with with_model that has a named_scope" do
     before do
       class RegularModel < ActiveRecord::Base
-        named_scope :title_is_foo, :conditions => {:title => 'foo'}
+        scope_method =
+          if respond_to?(:scope) && !protected_methods.include?('scope')
+            :scope # ActiveRecord 3.x
+          else
+            :named_scope # ActiveRecord 2.x
+          end
+
+        send scope_method, :title_is_foo, :conditions => {:title => 'foo'}
       end
       RegularModel.connection.drop_table(RegularModel.table_name) rescue nil
       RegularModel.connection.create_table(RegularModel.table_name) do |t|
@@ -26,7 +33,14 @@ describe "ActiveRecord behaviors" do
       end
 
       model do
-        named_scope :title_is_foo, :conditions => {:title => 'foo'}
+        scope_method =
+          if respond_to?(:scope) && !protected_methods.include?('scope')
+            :scope # ActiveRecord 3.x
+          else
+            :named_scope # ActiveRecord 2.x
+          end
+
+        send scope_method, :title_is_foo, :conditions => {:title => 'foo'}
       end
     end
 

data/spec/readme_spec.rb

@@ -0,0 +1,81 @@
+  require 'spec_helper'
+
+  describe "A blog post" do
+
+    with_model :blog_post do
+      # The table block works just like a migration.
+      table do |t|
+        t.string :title
+        t.timestamps
+      end
+
+      # The model block works just like the class definition.
+      model do
+        include SomeModule
+        has_many :comments
+        validates_presence_of :title
+
+        def self.some_class_method
+          'chunky'
+        end
+
+        def some_instance_method
+          'bacon'
+        end
+      end
+    end
+
+    # with_model classes can have associations.
+    with_model :comment do
+      table do |t|
+        t.string :text
+        t.belongs_to :blog_post
+        t.timestamps
+      end
+
+      model do
+        belongs_to :blog_post
+      end
+    end
+
+    it "can be accessed as a constant" do
+      BlogPost.should be
+    end
+
+    it "can be accessed as a local variable" do
+      blog_post.should be
+    end
+
+    it "can be accessed as an instance variable" do
+      @blog_post.should be
+    end
+
+    it "has the module" do
+      BlogPost.include?(SomeModule).should be_true
+    end
+
+    it "has the class method" do
+      BlogPost.some_class_method.should == 'chunky'
+    end
+
+    it "has the instance method" do
+      BlogPost.new.some_instance_method.should == 'bacon'
+    end
+
+    it "can do all the things a regular model can" do
+      record = BlogPost.new
+      record.should_not be_valid
+      record.title = "foo"
+      record.should be_valid
+      record.save.should be_true
+      record.reload.should == record
+      record.comments.create!(:text => "Lorem ipsum")
+      record.comments.count.should == 1
+    end
+  end
+
+  describe "another example group" do
+    it "should not have the constant anymore" do
+      defined?(BlogPost).should be_false
+    end
+  end

data/spec/spec_helper.rb

@@ -16,3 +16,6 @@ end
 # WithModel requires ActiveRecord::Base.connection to be established.
 # If ActiveRecord already has a connection, as in a Rails app, this is unnecessary.
 ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ":memory:")
+
+# For readme_spec.rb
+module SomeModule; end

data/spec/with_model_spec.rb

@@ -117,10 +117,12 @@ describe "a temporary ActiveRecord model created with with_model" do
     end
   end
 
-  context "after a context that uses a mixin" do
-    it "should not have the mixin" do
-      lambda { ::ModelWithMixin.new.foo }.should raise_error(NoMethodError)
-      ::ModelWithMixin.include?(AMixin).should be_false
+  if defined?(Mixico)
+    context "after a context that uses a mixin" do
+      it "should not have the mixin" do
+        lambda { ::ModelWithMixin.new.foo }.should raise_error(NoMethodError)
+        ::ModelWithMixin.include?(AMixin).should be_false
+      end
     end
   end
 

data/with_model.gemspec

@@ -18,5 +18,4 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'activerecord', '>=2.3.5', '<4.0.0'
-  s.add_dependency 'mixico'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: with_model
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
+  hash: 31
+  prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Case Commons, LLC
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-22 00:00:00 -05:00
+date: 2011-02-03 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,20 +42,6 @@ dependencies:
         version: 4.0.0
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mixico
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
 description: Dynamically build a model within an Rspec context
 email: 
 - casecommons-dev@googlegroups.com
@@ -68,20 +54,20 @@ extra_rdoc_files: []
 files: 
 - .autotest
 - .gitignore
+- CHANGELOG
 - Gemfile
 - LICENSE
-- README
+- README.rdoc
 - Rakefile
 - gemfiles/Gemfile.common
 - gemfiles/rspec1/Gemfile
-- gemfiles/rspec1/Gemfile.lock
 - gemfiles/rspec2/Gemfile
-- gemfiles/rspec2/Gemfile.lock
 - lib/with_model.rb
 - lib/with_model/base.rb
 - lib/with_model/dsl.rb
 - lib/with_model/version.rb
 - spec/active_record_behaviors_spec.rb
+- spec/readme_spec.rb
 - spec/spec_helper.rb
 - spec/with_model_spec.rb
 - with_model.gemspec
@@ -115,11 +101,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Dynamically build a model within an Rspec context
 test_files: 
 - spec/active_record_behaviors_spec.rb
+- spec/readme_spec.rb
 - spec/spec_helper.rb
 - spec/with_model_spec.rb

data/README

@@ -1 +0,0 @@
-See spec/spec_helper.rb and spec/with_model_spec.rb for usage.

data/gemfiles/rspec1/Gemfile.lock

@@ -1,20 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activerecord (2.3.5)
-      activesupport (= 2.3.5)
-    activesupport (2.3.5)
-    autotest (4.4.2)
-    mixico (0.1.4)
-    rspec (1.3.1)
-    sqlite3-ruby (1.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 2.3.5)
-  autotest
-  mixico
-  rspec (~> 1.0)
-  sqlite3-ruby

data/gemfiles/rspec2/Gemfile.lock

@@ -1,39 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    activemodel (3.0.3)
-      activesupport (= 3.0.3)
-      builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activesupport (3.0.3)
-    arel (2.0.4)
-    autotest (4.4.4)
-    builder (2.1.2)
-    diff-lcs (1.1.2)
-    i18n (0.4.2)
-    mixico (0.1.4)
-    rspec (2.1.0)
-      rspec-core (~> 2.1.0)
-      rspec-expectations (~> 2.1.0)
-      rspec-mocks (~> 2.1.0)
-    rspec-core (2.1.0)
-    rspec-expectations (2.1.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.1.0)
-    sqlite3-ruby (1.3.2)
-    tzinfo (0.3.23)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 3.0.0)
-  autotest
-  mixico
-  rspec (~> 2.0)
-  sqlite3-ruby