with_model 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: acf677d36c3ecf81055a163f81197487363d9e30
-  data.tar.gz: 4a2592965f7f7daad7bd87f3ebeb1d4a966042ad
+SHA256:
+  metadata.gz: 22f429a5cb8e986623de65004594810d642f7ca21b0bf24a0a1257defa40add9
+  data.tar.gz: a7a0cbbe47ba722b1359a438c18692a7927ff957c88cd0e0919ac3ab4ac65e92
 SHA512:
-  metadata.gz: 2740903c7eb9e1694e73a1e2dea1a8f50dedee100c182e1d499fce75bb6a12d42a6448c65cf3e674bb8c5dfd68829514acecdc52acab9c4463dd2da62e03e538
-  data.tar.gz: 2770e5fb17c776135c589606e89e85c5c45df341aecca576bc8304a233dc82ebe0ad614b2fcaed4af98c306068a66f23c9714f317596e6839f234f831cb02e22
+  metadata.gz: 63d816a1fe0782ee315073325b6eb59b468bc87c7899f3a124c181cc6542ee9c31d55768a3e2af8234ec6ffad9bb92037b012da5328128e835fce4a74d7a6b15
+  data.tar.gz: 6da66d3cbf860d19d5a2c661e01e75ff7aef341d78d64d12055d5c28ebc5e7401ea5c095b6b006da1c01bcb4b2100bf524681a63292ccf791cff7def6a987115

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  lint-config-ruby:
+    - default.yml
+
+AllCops:
+  TargetRubyVersion: 2.3

data/.travis.yml

@@ -2,36 +2,42 @@ language: ruby
 sudo: false
 
 rvm:
-  - "2.3.3"
-  - "2.2.6"
-  - "2.1.10"
-  - jruby-9.1.6.0
+  - "2.5.1"
+  - "2.4.4"
+  - "2.3.7"
+  - jruby-9.2.0.0
 
 install:
   - bundle install --retry=3
 
 env:
   - ACTIVE_RECORD_BRANCH="master"
+  - ACTIVE_RECORD_BRANCH="5-2-stable"
+  - ACTIVE_RECORD_BRANCH="5-1-stable"
   - ACTIVE_RECORD_BRANCH="5-0-stable"
-  - ACTIVE_RECORD_BRANCH="4-2-stable"
+  - ACTIVE_RECORD_VERSION="~> 5.2.0"
+  - ACTIVE_RECORD_VERSION="~> 5.1.0"
   - ACTIVE_RECORD_VERSION="~> 5.0.0"
   - ACTIVE_RECORD_VERSION="~> 4.2.0"
 
 matrix:
   allow_failures:
     - env: ACTIVE_RECORD_BRANCH="master"
+    - env: ACTIVE_RECORD_BRANCH="5-2-stable"
+    - env: ACTIVE_RECORD_BRANCH="5-1-stable"
     - env: ACTIVE_RECORD_BRANCH="5-0-stable"
-    - env: ACTIVE_RECORD_BRANCH="4-2-stable"
   exclude:
-    - rvm: "2.1.10"
+    - rvm: 2.3.7
       env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: "2.1.10"
-      env: ACTIVE_RECORD_BRANCH="5-0-stable"
-    - rvm: "2.1.10"
-      env: ACTIVE_RECORD_VERSION="~> 5.0.0"
-    - rvm: jruby-9.1.6.0
+    - rvm: jruby-9.2.0.0
       env: ACTIVE_RECORD_BRANCH="master"
-    - rvm: jruby-9.1.6.0
-      env: ACTIVE_RECORD_BRANCH="5-0-stable"
-    - rvm: jruby-9.1.6.0
-      env: ACTIVE_RECORD_VERSION="~> 5.0.0"
+    - rvm: jruby-9.2.0.0
+      env: ACTIVE_RECORD_BRANCH="5-2-stable"
+    - rvm: jruby-9.2.0.0
+      env: ACTIVE_RECORD_VERSION="~> 5.2.0"
+    - rvm: jruby-9.2.0.0
+      env: ACTIVE_RECORD_VERSION="~> 4.2.0"
+
+addons:
+  code_climate:
+    repo_token: fe5c8a8b1b951a54707c08b6fb2a9a5edf9e0522d28bccc648454f774c9ccab1

data/Gemfile

@@ -1,12 +1,17 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
 
-if ar_branch = ENV['ACTIVE_RECORD_BRANCH']
-  gem 'activerecord', :git => 'https://github.com/rails/rails.git', :branch => ENV['ACTIVE_RECORD_BRANCH']
-  gem 'arel', :git => 'https://github.com/rails/arel.git' if ar_branch == 'master'
-end
+gem 'lint-config-ruby', git: 'https://github.com/Casecommons/lint-config-ruby.git', tag: 'v1.0.0'
+
+ar_branch = ENV['ACTIVE_RECORD_BRANCH']
+ar_version = ENV['ACTIVE_RECORD_VERSION']
 
-if ENV['ACTIVE_RECORD_VERSION']
-  gem 'activerecord', ENV['ACTIVE_RECORD_VERSION']
+if ar_branch
+  gem 'activerecord', git: 'https://github.com/rails/rails.git', branch: ar_branch
+  gem 'arel', git: 'https://github.com/rails/arel.git' if ar_branch == 'master'
+elsif ar_version
+  gem 'activerecord', ar_version # rubocop:disable Bundler/DuplicatedGem
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2016 Case Commons, Inc. <http://casecommons.org>
+Copyright (c) 2010-2018 Case Commons, Inc. <http://casecommons.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

data/README.md

@@ -2,11 +2,13 @@
 
 [![Gem Version](https://img.shields.io/gem/v/with_model.svg?style=flat)](https://rubygems.org/gems/with_model)
 [![Build Status](https://secure.travis-ci.org/Casecommons/with_model.svg?branch=master)](https://travis-ci.org/Casecommons/with_model)
-[![Code Climate](https://img.shields.io/codeclimate/github/Casecommons/with_model.svg?style=flat)](https://codeclimate.com/github/Casecommons/with_model)
-[![Coverage Status](https://img.shields.io/coveralls/Casecommons/with_model/master.svg?style=flat)](https://coveralls.io/r/Casecommons/with_model)
 
 `with_model` dynamically builds an ActiveRecord model (with table) before each test in a group and destroys it afterwards.
 
+## Development status
+
+`with_model` is actively maintained. It is quite stable, so while updates may appear infrequent, it is only because none are needed.
+
 ## Installation
 
 Install as usual: `gem install with_model` or add `gem 'with_model'` to your Gemfile. See `.travis.yml` for supported (tested) Ruby versions.
@@ -43,24 +45,18 @@ After setting up as above, call `with_model` and inside its block pass it a `tab
 require 'spec_helper'
 
 describe "A blog post" do
-  before :all do
-    module SomeModule; end
-  end
-
-  after :all do
-    Object.send :remove_const, :SomeModule
-  end
+  module MyModule; end
 
   with_model :BlogPost do
-    # The table block works just like a migration.
+    # The table block (and an options hash) is passed to ActiveRecord migration’s `create_table`.
     table do |t|
       t.string :title
       t.timestamps null: false
     end
 
-    # The model block works just like the class definition.
+    # The model block is the ActiveRecord model’s class body.
     model do
-      include SomeModule
+      include MyModule
       has_many :comments
       validates_presence_of :title
 
@@ -92,7 +88,7 @@ describe "A blog post" do
   end
 
   it "has the module" do
-    expect(BlogPost.include?(SomeModule)).to eq true
+    expect(BlogPost.include?(MyModule)).to eq true
   end
 
   it "has the class method" do
@@ -171,9 +167,9 @@ end
 
 ## 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. 
+`with_model` uses [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html).
 
 ## License
 
-Copyright © 2010–2016 [Case Commons, Inc](http://casecommons.org).
+Copyright © 2010–2018 [Case Commons, Inc](http://casecommons.org).
 Licensed under the MIT license, see [LICENSE](/LICENSE) file.

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new
+
+desc 'Run lint'
+RuboCop::RakeTask.new
+
+namespace 'doc' do
+  desc 'Generate README and preview in browser'
+  task 'readme' do
+    sh 'markdown README.md > README.html && open README.html'
+  end
+end
+
+task default: %i[spec rubocop]

data/bin/rake

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/lib/with_model.rb

@@ -1,13 +1,12 @@
+# frozen_string_literal: true
+
 require 'with_model/model'
 require 'with_model/model/dsl'
 require 'with_model/table'
 require 'with_model/version'
 
 module WithModel
-  def with_model(name, options = {}, &block)
-    options = options.dup
-    scope = options.delete(:scope)
-
+  def with_model(name, scope: nil, **options, &block)
     model = Model.new name, options
     dsl = Model::DSL.new model
     dsl.instance_exec(&block) if block
@@ -21,10 +20,7 @@ module WithModel
     end
   end
 
-  def with_table(name, options = {}, &block)
-    options = options.dup
-    scope = options.delete(:scope)
-
+  def with_table(name, scope: nil, **options, &block)
     table = Table.new name, options, &block
 
     before(*scope) do

data/lib/with_model/constant_stubber.rb

@@ -1,24 +1,46 @@
+# frozen_string_literal: true
+
 module WithModel
   class ConstantStubber
-    def initialize const_name
+    def initialize(const_name)
       @const_name = const_name.to_sym
+      @namespace = nil
       @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
+    def stub_const(value)
+      @namespace = namespace
+      if @namespace.const_defined?(basename)
+        @original_value = @namespace.const_get(basename)
+        @namespace.__send__ :remove_const, basename
       end
 
-      Object.const_set @const_name, value
+      @namespace.const_set basename, value
     end
 
     def unstub_const
-      Object.send :remove_const, @const_name
-      Object.const_set @const_name, @original_value if @original_value
+      @namespace.__send__ :remove_const, basename
+      @namespace.const_set basename, @original_value if @original_value
+      @namespace = nil
       @original_value = nil
     end
+
+    private
+
+    def namespace
+      *namespace_parts, _ = lookup_list
+      namespace_parts.reduce(Object) do |ns, ns_part|
+        ns.const_get(ns_part.to_sym)
+      end
+    end
+
+    def lookup_list
+      @const_name.to_s.split('::')
+    end
+
+    def basename
+      @basename ||= lookup_list.last
+    end
   end
   private_constant :ConstantStubber
 end

data/lib/with_model/methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WithModel
   module Methods
     def with_model?

data/lib/with_model/model.rb

@@ -1,23 +1,22 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require 'active_support/core_ext/string/inflections'
+require 'English'
 require 'with_model/constant_stubber'
 require 'with_model/methods'
 require 'with_model/table'
 
 module WithModel
   class Model
-    OPTIONS = [:superclass].freeze
-    private_constant :OPTIONS
-
     attr_writer :model_block, :table_block, :table_options
 
-    def initialize name, options = {}
-      validate_options!(options)
+    def initialize(name, superclass: ActiveRecord::Base)
       @name = name.to_sym
       @model_block = nil
       @table_block = nil
       @table_options = {}
-      @superclass = options.fetch(:superclass, ActiveRecord::Base)
+      @superclass = superclass
     end
 
     def create
@@ -68,15 +67,8 @@ module WithModel
     end
 
     def table_name
-      uid = "#$$_#{Thread.current.object_id}"
-      "with_model_#{@name.to_s.tableize}_#{uid}".freeze
-    end
-
-    def validate_options!(options)
-      unknown_options = options.keys - OPTIONS
-      unless unknown_options.empty?
-        raise ArgumentError, "unknown options: #{unknown_options.inspect}"
-      end
+      uid = "#{$PID}_#{Thread.current.object_id}"
+      "with_model_#{@name.to_s.tableize}_#{uid}"
     end
   end
 end

data/lib/with_model/model/dsl.rb

@@ -1,16 +1,23 @@
+# frozen_string_literal: true
+
 module WithModel
   class Model
     class DSL
-      def initialize model
+      def initialize(model)
         @model = model
       end
 
-      def table options = {}, &block
+      # Provide a schema definition for the table, passed to ActiveRecord’s `create_table`.
+      # The table name will be auto-generated.
+      #
+      # @see https://api.rubyonrails.org/classes/ActiveRecord/ConnectionAdapters/SchemaStatements.html#method-i-create_table
+      def table(options = {}, &block)
         @model.table_options = options
         @model.table_block = block
       end
 
-      def model &block
+      # Provide a class body for the ActiveRecord model.
+      def model(&block)
         @model.model_block = block
       end
     end

data/lib/with_model/table.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
 module WithModel
   class Table
-    def initialize name, options = {}, &block
+    def initialize(name, options = {}, &block)
       @name = name.freeze
       @options = options.freeze
       @block = block

data/lib/with_model/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module WithModel
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0'
 end

data/spec/active_record_behaviors_spec.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
-describe "ActiveRecord behaviors" do
-  describe "a temporary ActiveRecord model created with with_model" do
-    context "that has a named scope" do
+describe 'ActiveRecord behaviors' do
+  describe 'a temporary ActiveRecord model created with with_model' do
+    context 'that has a named scope' do
       before do
         @regular_model = Class.new ActiveRecord::Base do
-          scope :title_is_foo, lambda { where(:title => 'foo') }
+          scope :title_is_foo, -> { where(title: 'foo') }
         end
 
         @regular_model.connection.create_table(@regular_model.table_name, force: true) do |t|
@@ -27,39 +29,39 @@ describe "ActiveRecord behaviors" do
         end
 
         model do
-          scope :title_is_foo, lambda { where(:title => 'foo') }
+          scope :title_is_foo, -> { where(title: 'foo') }
         end
       end
 
-      describe "the named scope" do
-        it "works like a regular named scope" do
-          included = @regular_model.create!(:title => 'foo', :content => 'Include me!')
-          excluded = @regular_model.create!(:title => 'bar', :content => 'Include me!')
+      describe 'the named scope' do
+        it 'works like a regular named scope' do
+          included = @regular_model.create!(title: 'foo', content: 'Include me!')
+          @regular_model.create!(title: 'bar', content: 'Include me!')
 
           expect(@regular_model.title_is_foo).to eq [included]
 
-          included = BlogPost.create!(:title => 'foo', :content => 'Include me!')
-          excluded = BlogPost.create!(:title => 'bar', :content => 'Include me!')
+          included = BlogPost.create!(title: 'foo', content: 'Include me!')
+          BlogPost.create!(title: 'bar', content: 'Include me!')
 
           expect(BlogPost.title_is_foo).to eq [included]
         end
       end
     end
 
-    context "that has a polymorphic belongs_to" do
+    context 'that has a polymorphic belongs_to' do
       before do
         animal = Class.new ActiveRecord::Base do
-          has_many :tea_cups, :as => :pet
+          has_many :tea_cups, as: :pet
         end
         stub_const 'Animal', animal
       end
 
       with_model :TeaCup do
         table do |t|
-          t.belongs_to :pet, :polymorphic => true, :index => false
+          t.belongs_to :pet, polymorphic: true, index: false
         end
         model do
-          belongs_to :pet, :polymorphic => true
+          belongs_to :pet, polymorphic: true
         end
       end
 
@@ -67,20 +69,20 @@ describe "ActiveRecord behaviors" do
 
       with_model :StuffedAnimal do
         model do
-          has_many :tea_cups, :as => :pet
+          has_many :tea_cups, as: :pet
         end
       end
 
-      describe "the polymorphic belongs_to" do
-        it "works like a regular polymorphic belongs_to" do
+      describe 'the polymorphic belongs_to' do
+        it 'works like a regular polymorphic belongs_to' do
           animal = Animal.create!
           stuffed_animal = StuffedAnimal.create!
 
-          tea_cup_for_animal = TeaCup.create!(:pet => animal)
+          tea_cup_for_animal = TeaCup.create!(pet: animal)
           expect(tea_cup_for_animal.pet_type).to eq 'Animal'
           expect(animal.tea_cups).to include(tea_cup_for_animal)
 
-          tea_cup_for_stuffed_animal = TeaCup.create!(:pet => stuffed_animal)
+          tea_cup_for_stuffed_animal = TeaCup.create!(pet: stuffed_animal)
           expect(tea_cup_for_stuffed_animal.pet_type).to eq 'StuffedAnimal'
           expect(stuffed_animal.tea_cups).to include(tea_cup_for_stuffed_animal)
         end
@@ -88,7 +90,7 @@ describe "ActiveRecord behaviors" do
     end
   end
 
-  context "with an association" do
+  context 'with an association' do
     with_model :Province do
       table do |t|
         t.belongs_to :country
@@ -100,13 +102,13 @@ describe "ActiveRecord behaviors" do
 
     with_model :Country
 
-    context "in earlier examples" do
-      it "works as normal" do
-        Province.create!(:country => Country.create!)
+    context 'in earlier examples' do
+      it 'works as normal' do
+        Province.create!(country: Country.create!)
       end
     end
 
-    context "in later examples" do
+    context 'in later examples' do
       it "does not hold a reference to earlier example groups' classes" do
         expect(Province.reflect_on_association(:country).klass).to eq Country
       end