enum_table 0.1.0 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+== 0.2.0 2013-05-14
+
+ * Memoize enum_table list. Your logs are now less noisy.
+ * #enum no longer requires the table to exist when migrating or loading the
+   schema, so migrations have a chance to create the enum tables.
+
 == 0.1.0 2012-11-30
 
  * DB Nazi compliance.

data/Gemfile

@@ -1,2 +1,2 @@
-source :rubygems
+source 'https://rubygems.org'
 gemspec

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/lib/enum_table/railtie.rb

@@ -5,9 +5,19 @@ module EnumTable
         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'
+
+      %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

data/lib/enum_table/record.rb

@@ -20,7 +20,7 @@ module EnumTable
         end
         self.enums = enums.merge(name => reflection, name.to_s => reflection)
 
-        class_eval <<-EOS
+        class_eval <<-EOS, __FILE__, __LINE__ + 1
           def #{name}
             read_enum(:#{name})
           end
@@ -60,6 +60,7 @@ module EnumTable
         when String, Symbol, nil
           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 #{table_name}").each do |row|
             map[row[1]] = row[0]
           end

data/lib/enum_table/schema_statements.rb

@@ -4,6 +4,7 @@ module EnumTable
       table = NewTable.new(self, table_name, options)
       yield table if block_given?
       table._create
+      enum_tables_updated
     end
 
     def change_enum_table(table_name)
@@ -13,13 +14,17 @@ module EnumTable
     def drop_enum_table(table_name)
       drop_table table_name
       execute "DELETE FROM enum_tables WHERE table_name = '#{table_name}'"
+      enum_tables_updated
     end
 
     def enum_tables
       return [] if !table_exists?('enum_tables')
-      execute("SELECT table_name FROM enum_tables").map do |row|
-        row[0]
-      end.sort
+      @enum_tables ||= execute("SELECT table_name FROM enum_tables").
+        map { |row| row[0] }.sort
+    end
+
+    def enum_tables_updated
+      @enum_tables = nil
     end
 
     DEFAULT_VALUE_ATTRIBUTES = {type: :string, limit: 255, null: false}.freeze

data/lib/enum_table/version.rb

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

data/test/database.yml

@@ -3,17 +3,17 @@ sqlite3:
 mysql:
   username: root
   password:
-  database: db_nazi_test
+  database: enum_table_test
 mysql2:
   username: root
   password:
-  database: db_nazi_test
+  database: enum_table_test
 postgresql:
   username: postgres
   password:
-  database: db_nazi_test
+  database: enum_table_test
   min_messages: warning
 jdbcmysql:
   username: root
   password:
-  database: db_nazi_test
+  database: enum_table_test

data/test/enum_table/test_record.rb

@@ -65,6 +65,29 @@ describe EnumTable do
       enum.id_name.must_equal :gender_number
     end
 
+    describe "when missing tables are not allowed" do
+      it "raises an error if the underlying table does not exist" do
+        # must_raise does not do ancestor lookup in some versions of minitest
+        # (notably the version that ships with Ruby 1.9.3). Avoid it until we
+        # have a testrb that honors the Gemfile.
+        exception = nil
+        begin
+          User.enum(:status)
+        rescue => exception
+        end
+        exception.must_be_kind_of StandardError
+      end
+    end
+
+    describe "when missing tables are allowed" do
+      before { EnumTable.missing_tables_allowed }
+      after { EnumTable.reset }
+
+      it "does not raise an error if the underlying table does not exist" do
+        User.enum :status
+      end
+    end
+
     describe "on a subclass" do
       before do
         User.inheritance_column = :user_type

data/test/enum_table/test_schema_statements.rb

@@ -110,6 +110,21 @@ describe EnumTable::SchemaStatements do
       connection.drop_enum_table :genders
       connection.enum_tables.must_equal []
     end
+
+    it "clears memoized tables when an enum table is created" do
+      connection.create_enum_table :genders
+      connection.enum_tables.must_equal ['genders']
+      connection.create_enum_table :statuses
+      connection.enum_tables.must_equal ['genders', 'statuses']
+    end
+
+    it "clears memoized tables when an enum table is dropped" do
+      connection.create_enum_table :genders
+      connection.create_enum_table :statuses
+      connection.enum_tables.must_equal ['genders', 'statuses']
+      connection.drop_enum_table :genders
+      connection.enum_tables.must_equal ['statuses']
+    end
   end
 
   def read_table(name)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enum_table
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-30 00:00:00.000000000 Z
+date: 2013-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord