= 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

  describe "with table options" do
    with_model :with_options do
      table :id => false do |t|
        t.string 'foo'
        t.timestamps
      end
    end

    it "should respect the additional options" do
      WithOptions.columns.map(&:name).should_not include("id")
    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