enum_table 0.3.0 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5ae29ffdc710d5a06627e243e256b7a8b46ae55
+  data.tar.gz: aaa6e9b0c95804dd10760b8b67289f9121d23738
+SHA512:
+  metadata.gz: 47f827c8bbd52a3102c06df809be0ef29031ec1d194ed5a186da9698127eba253a01efad0d10487949829a019a5ce896969c2e973c92f432b3a49faac1ad4e0b
+  data.tar.gz: a0ffcf59c9ae8d1c3330eb18909d04c6462b95fa8c659b3f41a1615c01f95584d323358130448f43c65f74985c9f7f284d0d40233aed07929219cdad6d261b87

data/.gitignore

@@ -1,2 +1,3 @@
 /Gemfile.lock
-/*.gem
+/.bundle
+/*.gem

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.4.0 2014-02-10
+
+ * Allow missing tables when migrating. [Kenneth Lay]
+
 == 0.3.0 2013-12-12
 
  * Fix initialize_attributes when options are passed. [Rebecca Miller-Webster]

data/Gemfile

@@ -2,4 +2,5 @@ source 'https://rubygems.org'
 gem 'sqlite3'
 gem 'mysql2'
 gem 'pg'
+gem 'minitest', '~> 4.0'
 gemspec

data/README.markdown

@@ -123,6 +123,24 @@ it less disruptive to use strings instead. Do that with the `:type` option:
 
     enum :genders, type: :string
 
+### I can't set up my Rails app!
+
+If you load any models during Rails' initialization phase (e.g. from
+`config/application.rb`, or an initializer), and these models depend on the
+existence of enum tables, you may wind up with a circular dependency: your app
+startup depends on an enum table existing, and creating the enum table requires
+loading the app (via `db:schema:load`). This might only manifest itself when you
+try to load your schema on an empty database.
+
+It is strongly recommended to avoid loading models during
+initialization. However if you cannot avoid this there is an escape hatch:
+
+    config.enum_tables.allow_missing_tables = true
+
+This will silently return an empty enum mapping while this flag is true. Of
+course, this may have knock on effects if your model expects certain values to
+be present. Consider yourself warned!
+
 ## Contributing
 
  * [Bug reports](https://github.com/howaboutwe/enum_table/issues)

data/lib/enum_table/railtie.rb

@@ -1,13 +1,27 @@
 module EnumTable
   class Railtie < Rails::Railtie
+    config.enum_table = ActiveSupport::OrderedOptions.new
+
     rake_tasks do
       namespace :enum_table do
         task :load_schema_dumper do
           require 'enum_table/schema_dumper'
         end
+
+        task :allow_missing_tables do
+          EnumTable.missing_tables_allowed
+        end
       end
 
       Rake::Task['db:schema:dump'].prerequisites << 'enum_table:load_schema_dumper'
+
+      if config.enum_table.allow_missing_tables
+        %w'db:schema:load db:migrate db:migrate:up'.each do |task|
+          task = Rake::Task[task]
+          task.prerequisites.insert 0, 'enum_table:allow_missing_tables'
+          task.enhance { EnumTable.missing_tables_disallowed }
+        end
+      end
     end
   end
 end

data/lib/enum_table/record.rb

@@ -62,6 +62,7 @@ module EnumTable
         else
           map = {}
           table_name = table || "#{self.table_name.singularize}_#{name.to_s.pluralize}"
+          return {} if EnumTable.missing_tables_allowed? && !connection.tables.include?(table_name)
           connection.execute("SELECT id, value FROM #{connection.quote_table_name table_name}").each do |row|
             map[row[1]] = row[0]
           end

data/lib/enum_table/version.rb

@@ -1,5 +1,5 @@
 module EnumTable
-  VERSION = [0, 3, 0]
+  VERSION = [0, 4, 0]
 
   class << VERSION
     include Comparable

data/lib/enum_table.rb

@@ -4,6 +4,37 @@ module EnumTable
   autoload :Reflection, 'enum_table/reflection'
   autoload :SchemaDumper, 'enum_table/schema_dumper'
   autoload :SchemaStatements, 'enum_table/schema_statements'
+
+  # Allow enum tables to be missing until missing_tables_disallowed is
+  # called. This is invoked from rake tasks that create the enum tables, such as
+  # Rails migration tasks.
+  #
+  # Missing table allowance is implemented as a thread-local stack to handle
+  # nested invocations in multi-threaded programs.
+  class << self
+    def missing_tables_allowed
+      missing_tables_allowances.push true
+    end
+
+    def missing_tables_disallowed
+      missing_tables_allowances.pop
+    end
+
+    def missing_tables_allowed?
+      !missing_tables_allowances.empty?
+    end
+
+    # Reset our state. Intended for testing Enum Table.
+    def reset
+      Thread.current[:enum_table_missing_tables_allowed] = nil
+    end
+
+    private
+
+    def missing_tables_allowances
+      Thread.current[:enum_table_missing_tables_allowed] ||= []
+    end
+  end
 end
 
 require 'enum_table/railtie' if defined?(Rails)

data/test/enum_table/test_record.rb

@@ -9,9 +9,9 @@ describe EnumTable do
       t.integer :status_id
       t.string :user_type
     end
+    Object.const_set :User, Class.new(ActiveRecord::Base)
   end
 
-  before { Object.const_set :User, Class.new(ActiveRecord::Base) }
   after { Object.send :remove_const, :User }
 
   describe '.enum' do
@@ -90,6 +90,17 @@ describe EnumTable do
       exception.must_be_kind_of StandardError
     end
 
+    describe "when missing tables are allowed" do
+      before { EnumTable.missing_tables_allowed }
+      after { EnumTable.reset }
+
+      it "does not cry when you first use the enum if the table does not exist" do
+        User.enum(:status)
+        User.enum_id(:status, 'awesome').must_equal nil
+      end
+    end
+
+
     describe "on a subclass" do
       before do
         User.inheritance_column = :user_type

data/test/test_helper.rb

@@ -1,7 +1,7 @@
 ROOT = File.expand_path('..', File.dirname(__FILE__))
 $:.unshift "#{ROOT}/lib"
 
-require 'minitest/spec'
+require 'minitest/autorun'
 require 'active_record'
 require 'enum_table'
 
@@ -47,7 +47,12 @@ MiniTest::Spec.class_eval do
   end
 
   def self.use_database
-    before { recreate_database }
-    after { drop_database }
+    mod = Module.new do
+      extend Minitest::Spec::DSL
+
+      before { recreate_database }
+      after { drop_database }
+    end
+    include mod
   end
 end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: enum_table
 version: !ruby/object:Gem::Version
-  version: 0.3.0
-  prerelease: 
+  version: 0.4.0
 platform: ruby
 authors:
 - George Ogata
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: ritual
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.1
 description: 
@@ -50,7 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -73,33 +68,26 @@ files:
 homepage: http://github.com/howaboutwe/enum_table
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 932469567180106626
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 932469567180106626
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Enumeration tables for ActiveRecord
 test_files:
 - test/database.yml