with_model 0.3.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb1eb5e067e816d4644cde5fa9da460fd764ac36
-  data.tar.gz: 5de4c0d4f74cf020b4c6541b31fdcdb3ac4d053b
+  metadata.gz: b88698902a3eed64e0fc34a173d4758e4f108dc5
+  data.tar.gz: 49b3e03abeccfc847d9f5751e5107ff3c486233e
 SHA512:
-  metadata.gz: 809520bde82da03692043a5e3b23bce6ceaffcaba26db542e4dec5380658bc00551ea8c6504d04c2a702a5983397d7a047596558926d79c0616f9296332a8b8c
-  data.tar.gz: e64fcb0db081580c10cd54f0b15f4ccde04fdadc5dd92edef5cc3944d68c7a54bb965b4a811f99999042402ee0d4d6c733929b03c3a02d4152d166a5619ceeca
+  metadata.gz: e021cf0aa7032ea90c7572f28172d2158062682f382fbe8036489b88120607e986638c3b059cf3be30605f93465c90e3c417ff616f8b385a2eff0f097a4d1814
+  data.tar.gz: efd6470ae68ea7ae8861f8b0067c8fddb67062553e68eb88ec6c6afa53fc8f7160f8e05490fb1521da135e6c2fde76ec473dab85f0e48e3caa13a9781e12ca67

data/.gitignore

@@ -1,8 +1,9 @@
-.idea
 pkg/*
-*.gem
-.bundle
-.rvmrc
 doc
+coverage
 Gemfile.lock
+.rvmrc
+.idea
+.bundle
 *.rbc
+*.gem

data/.travis.yml

@@ -1,30 +1,20 @@
 language: ruby
 
-script: "bundle exec rspec spec"
-
 rvm:
-  - 1.8.7
   - 1.9.3
   - 2.0.0
-  - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
-  - ree
+  - rbx-2.2
 
 env:
-  - ACTIVE_RECORD_VERSION="~> 4.0.0.rc1"
+  - ACTIVE_RECORD_BRANCH="master"
+  - ACTIVE_RECORD_BRANCH="4-0-stable"
+  - ACTIVE_RECORD_VERSION="~> 4.0.0"
   - ACTIVE_RECORD_VERSION="~> 3.2.0"
   - ACTIVE_RECORD_VERSION="~> 3.1.0"
   - ACTIVE_RECORD_VERSION="~> 3.0.0"
 
 matrix:
   allow_failures:
-    - env: ACTIVE_RECORD_VERSION="~> 4.0.0.rc1"
-  exclude:
-    - rvm:
-      - 1.8.7
-      - jruby-18mode
-      - rbx-18mode
-      - ree
-      env: ACTIVE_RECORD_VERSION="~> 4.0.0.rc1"
+    - env: ACTIVE_RECORD_BRANCH="master"
+    - env: ACTIVE_RECORD_BRANCH="4-0-stable"

data/CHANGELOG.md

@@ -0,0 +1,70 @@
+### 1.0.0
+- Start using [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html)
+- Complete refactor of internals (Andrew Marshall)
+- Remove support for Active Record 2 (Andrew Marshall)
+- Remove dependency on RSpec (Andrew Marshall)
+- Add support for MiniTest (Andrew Marshall)
+- Add option for specifying superclass (Miks Miķelsons)
+
+### 0.3.2
+
+- Allow calling with_model without a block. (Andrew Marshall)
+- Ensure that ActiveSupport's descendants works correctly between tests. (Andrew Marshall)
+- Allow Active Record 4 in gemspec.
+
+### 0.3.1
+
+- Don't cache connection between tests. (Ryan Ong & Richard Nuno)
+
+### 0.3
+
+- Use RSpec 2.11's built-in constant stubbing.
+- Remove RSpec 1.x and Active Record 2.x support.
+- Remove Mixico support.
+
+### 0.2.6
+
+- Active Record 3.2 compatible. (Steven Harman / Brent Wheeldon)
+
+### 0.2.5
+
+- Clear Active Record 3.x associations class cache between specs to clean up test
+- pollution.
+
+### 0.2.4
+
+- Active Record 3.1 compatible.
+- Fix bug where column information was being cached incorrectly by Active
+- Record.
+
+### 0.2.3
+
+- Create a new class each run to prevent test pollution. (J. Andrew Marshall)
+- Use :UpperCase in examples.
+
+### 0.2.2
+
+- The table block is now optional.
+
+### 0.2.1
+
+- Fix a bug when the with_model name contains capital letters. Now you can
+- safely make calls like `with_model :BlogPost`
+
+### 0.2
+
+- Remove the buggy attr_accessor method for accessing with_model classes. Now
+- there is only the constant available in the example group.
+
+### 0.1.5
+
+- WithModel::Base is now marked as an abstract_class, which makes polymorphic
+- belongs_to work properly.
+
+### 0.1.4
+
+- Add ability to pass arguments to create_table.
+
+### 0.1.2
+
+- Make Mixico optional.

data/Gemfile

@@ -1,10 +1,9 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec
 
-gem "rake"
-gem "sqlite3", :platforms => :ruby
-gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
-gem "rdoc"
+gem 'activerecord', :github => 'rails', :branch => ENV['ACTIVE_RECORD_BRANCH'] if ENV['ACTIVE_RECORD_BRANCH']
+gem 'activerecord', ENV['ACTIVE_RECORD_VERSION'] if ENV['ACTIVE_RECORD_VERSION']
+gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
 gem 'coveralls', :require => false, :platform => :mri_20
-gem 'activerecord', ENV["ACTIVE_RECORD_VERSION"] if ENV["ACTIVE_RECORD_VERSION"]
+gem 'sqlite3', :platforms => :ruby

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Case Commons, LLC
+Copyright (c) 2010-2013 Case Commons, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -0,0 +1,164 @@
+# [with_model](https://github.com/Casecommons/with_model)
+
+[![Build Status](https://secure.travis-ci.org/Casecommons/with_model.png?branch=master)](https://travis-ci.org/Casecommons/with_model)
+[![Code Climate](https://codeclimate.com/github/Casecommons/with_model.png)](https://codeclimate.com/github/Casecommons/with_model)
+[![Coverage Status](https://coveralls.io/repos/Casecommons/with_model/badge.png?branch=master)](https://coveralls.io/r/Casecommons/with_model)
+[![Gem Version](https://badge.fury.io/rb/with_model.png)](https://rubygems.org/gems/with_model)
+[![Dependency Status](https://gemnasium.com/Casecommons/with_model.png)](https://gemnasium.com/Casecommons/with_model)
+
+`with_model` dynamically builds an ActiveRecord model (with table) before each test in a group and destroys it afterwards.
+
+## Installation
+
+Install as usual: `gem install with_model` or add `gem 'with_model'` to your Gemfile. See `.travis.yml` for supported (tested) Ruby versions.
+
+## RSpec
+
+Extend `WithModel` into RSpec:
+
+```ruby
+require 'with_model'
+
+RSpec.configure do |config|
+  config.extend WithModel
+end
+```
+
+## minitest/spec
+
+Extend `WithModel` into minitest/spec:
+
+```ruby
+require 'with_model'
+
+class Minitest::Spec
+  extend WithModel
+end
+```
+
+## Usage
+
+After setting up as above, call `with_model` and inside its block pass it a `table` block and a `model` block.
+
+```ruby
+require 'spec_helper'
+
+describe "A blog post" do
+  before :all do
+    module SomeModule; end
+  end
+
+  after :all do
+    Object.send :remove_const, :SomeModule
+  end
+
+  with_model :BlogPost 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
+    expect(BlogPost).to be
+  end
+
+  it "has the module" do
+    expect(BlogPost.include?(SomeModule)).to be_true
+  end
+
+  it "has the class method" do
+    expect(BlogPost.some_class_method).to eq 'chunky'
+  end
+
+  it "has the instance method" do
+    expect(BlogPost.new.some_instance_method).to eq 'bacon'
+  end
+
+  it "can do all the things a regular model can" do
+    record = BlogPost.new
+    expect(record).to_not be_valid
+    record.title = "foo"
+    expect(record).to be_valid
+    expect(record.save).to be_true
+    expect(record.reload).to eq record
+    record.comments.create!(:text => "Lorem ipsum")
+    expect(record.comments.count).to eq 1
+  end
+
+  # with_model classes can have inheritance.
+  class Car < ActiveRecord::Base
+    self.abstract_class = true
+  end
+
+  with_model :Ford, superclass: Car do
+  end
+
+  it "has a specified superclass" do
+    expect(Ford < Car).to be_true
+  end
+end
+
+describe "another example group" do
+  it "does not have the constant anymore" do
+    expect(defined?(BlogPost)).to be_false
+  end
+end
+
+describe "with table options" do
+  with_model :WithOptions do
+    table :id => false do |t|
+      t.string 'foo'
+      t.timestamps
+    end
+  end
+
+  it "respects the additional options" do
+    expect(WithOptions.columns.map(&:name)).to_not include("id")
+  end
+end
+```
+
+## Requirements
+
+- Ruby 1.9.3+
+- RSpec or minitest/spec
+- ActiveRecord 3+ (for ActiveRecord 2, use with_model 0.2.x)
+
+## Versioning
+
+As of version 1.0.0, with_model uses [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html). Previous versions used an ad-hoc versioning scheme. 
+
+## License
+
+Copyright © 2010-2014 Case Commons, LLC.
+Licensed under the MIT license, available in the “LICENSE” file.

data/Rakefile

@@ -1,21 +1,13 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-task :default => :spec
-
-def bundle_exec(command)
-  sh %Q{bundle update && bundle exec #{command}}
-end
-
-desc "Run all specs"
-task "spec" do
-  bundle_exec("rspec spec")
-end
+desc 'Run specs'
+RSpec::Core::RakeTask.new
 
 namespace "doc" do
   desc "Generate README and preview in browser"
   task "readme" do
-    sh "rdoc -c utf8 README.rdoc && open doc/README_rdoc.html"
+    sh "markdown README.md > README.html && open README.html"
   end
 end
 

data/lib/with_model.rb

@@ -1,23 +1,22 @@
+require 'with_model/model'
+require 'with_model/model/dsl'
+require 'with_model/table'
+require 'with_model/version'
+
 module WithModel
-  autoload :Base, "with_model/base"
-  autoload :Dsl, "with_model/dsl"
-  autoload :VERSION, "with_model/version"
+  def with_model(name, options = {}, &block)
+    model = Model.new name, options
+    dsl = Model::DSL.new model
+    dsl.instance_exec(&block) if block
 
-  def with_model(name, &block)
-    dsl = Dsl.new(name, self)
-    dsl.instance_eval(&block) if block
-    dsl.execute
+    before { model.create }
+    after { model.destroy }
   end
 
   def with_table(name, options = {}, &block)
-    before do
-      connection = ActiveRecord::Base.connection
-      connection.drop_table(name) if connection.table_exists?(name)
-      connection.create_table(name, options, &block)
-    end
+    table = Table.new name, options, &block
 
-    after do
-      ActiveRecord::Base.connection.drop_table(name)
-    end
+    before { table.create }
+    after { table.destroy }
   end
 end

data/lib/with_model/constant_stubber.rb

@@ -0,0 +1,24 @@
+module WithModel
+  class ConstantStubber
+    def initialize const_name
+      @const_name = const_name.to_sym
+      @original_value = nil
+    end
+
+    def stub_const value
+      if Object.const_defined?(@const_name)
+        @original_value = Object.const_get(@const_name)
+        Object.send :remove_const, @const_name
+      end
+
+      Object.const_set @const_name, value
+    end
+
+    def unstub_const
+      Object.send :remove_const, @const_name
+      Object.const_set @const_name, @original_value if @original_value
+      @original_value = nil
+    end
+  end
+  private_constant :ConstantStubber
+end

data/lib/with_model/methods.rb

@@ -0,0 +1,7 @@
+module WithModel
+  module Methods
+    def with_model?
+      true
+    end
+  end
+end

data/lib/with_model/model.rb

@@ -0,0 +1,76 @@
+require 'active_support/core_ext/string/inflections'
+require 'with_model/constant_stubber'
+require 'with_model/methods'
+require 'with_model/table'
+
+module WithModel
+  class Model
+    attr_writer :model_block, :table_block, :table_options
+
+    def initialize name, options = {}
+      @name = name.to_sym
+      @options = options
+      @model_block = proc {}
+      @table_block = proc {}
+      @table_options = {}
+    end
+
+    def create
+      table.create
+      @model = Class.new(superclass)
+
+      class << @model
+        include WithModel::Methods
+      end
+
+      stubber.stub_const @model
+      setup_model
+    end
+
+    def superclass
+      @options.fetch(:superclass) { ActiveRecord::Base }
+    end
+
+    def destroy
+      stubber.unstub_const
+      remove_from_superclass_descendants
+      reset_dependencies_cache
+      table.destroy
+      @model = nil
+    end
+
+    private
+
+    def const_name
+      @name.to_s.camelize.freeze
+    end
+
+    def setup_model
+      @model.table_name = table_name
+      @model.class_eval(&@model_block)
+      @model.reset_column_information
+    end
+
+    def remove_from_superclass_descendants
+      return unless @model.superclass.respond_to?(:direct_descendants)
+      @model.superclass.direct_descendants.delete(@model)
+    end
+
+    def reset_dependencies_cache
+      return unless defined?(ActiveSupport::Dependencies::Reference)
+      ActiveSupport::Dependencies::Reference.clear!
+    end
+
+    def stubber
+      @stubber ||= ConstantStubber.new const_name
+    end
+
+    def table
+      @table ||= Table.new table_name, @table_options, &@table_block
+    end
+
+    def table_name
+      "with_model_#{@name.to_s.tableize}_#{$$}".freeze
+    end
+  end
+end