enum_table 0.2.1 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+== 0.3.0 2013-12-12
+
+ * Fix initialize_attributes when options are passed. [Rebecca Miller-Webster]
+ * Lazily load enum mappings to avoid bootstrapping errors (migrating, seeding, etc.).
+
 == 0.2.1 2013-07-16
 
  * Fix SQL escaping.

data/README.markdown

@@ -131,6 +131,11 @@ it less disruptive to use strings instead. Do that with the `:type` option:
    * Include tests where practical.
    * Leave the version alone, or bump it in a separate commit.
 
+### Running tests
+```
+testrb test
+```
+
 ## Copyright
 
 Copyright (c) HowAboutWe. See LICENSE for details.

data/enum_table.gemspec

@@ -7,6 +7,8 @@ Gem::Specification.new do |gem|
   gem.version       = EnumTable::VERSION
   gem.authors       = ['George Ogata']
   gem.email         = ['george.ogata@gmail.com']
+  gem.license       = 'MIT'
+  gem.date          = Time.now.strftime('%Y-%m-%d')
   gem.summary       = "Enumeration tables for ActiveRecord"
   gem.homepage      = 'http://github.com/howaboutwe/enum_table'
 

data/lib/enum_table.rb

@@ -4,37 +4,6 @@ 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,19 +5,9 @@ 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

@@ -15,8 +15,10 @@ module EnumTable
           value = options[key] and
             reflection.send "#{key}=", value
         end
-        enum_map(name, options).each do |value, id|
-          reflection.add_value id, value
+        reflection.to_populate do |ref|
+          enum_map(name, options).each do |value, id|
+            ref.add_value id, value
+          end
         end
         self.enums = enums.merge(name => reflection, name.to_s => reflection)
 
@@ -57,16 +59,13 @@ module EnumTable
           map = {}
           table.each_with_index { |element, i| map[element] = i + 1 }
           map
-        when String, Symbol, nil
+        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
           map
-        else
-          raise ArgumentError, "invalid table specifier: #{table.inspect}"
         end
       end
 
@@ -138,7 +137,7 @@ module EnumTable
       end
 
       # Enables state_machine to set initial values for states. Ick.
-      def initialize_attributes(attributes)  # :nodoc:
+      def initialize_attributes(attributes, *)  # :nodoc:
         attributes = super
         enums.each do |name, reflection|
           if (value = attributes.delete(reflection.name.to_s))

data/lib/enum_table/reflection.rb

@@ -10,6 +10,8 @@ module EnumTable
       @strings_to_ids = {}
       @values_to_ids = {}
       @ids_to_values = {}
+      @populate_procs = []
+      @populated = false
     end
 
     def initialize_copy(other)
@@ -20,11 +22,17 @@ module EnumTable
       @strings_to_ids = other.instance_variable_get(:@strings_to_ids).dup
       @values_to_ids = other.instance_variable_get(:@values_to_ids).dup
       @ids_to_values = other.instance_variable_get(:@ids_to_values).dup
+      @populate_procs = other.instance_variable_get(:@populate_procs).dup
+      @populated = false
     end
 
     attr_reader :name
     attr_accessor :id_name, :type
 
+    def to_populate(&block)
+      @populate_procs << block
+    end
+
     def add_value(id, value)
       @strings_to_ids[value.to_s] = id
 
@@ -34,6 +42,7 @@ module EnumTable
     end
 
     def id(value)
+      ensure_populated
       if value.is_a?(String) || type == :string
         @strings_to_ids[value.to_s.strip]
       else
@@ -42,11 +51,22 @@ module EnumTable
     end
 
     def value(id)
+      ensure_populated
       @ids_to_values[id]
     end
 
     def values
+      ensure_populated
       @values_to_ids.keys
     end
+
+    private
+
+    def ensure_populated
+      return if @populated
+      @populate_procs.each { |p| p.call(self) }
+      @populate_procs.clear
+      @populated = true
+    end
   end
 end

data/lib/enum_table/version.rb

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

data/test/database.yml

@@ -9,7 +9,7 @@ mysql2:
   password:
   database: enum_table_test
 postgresql:
-  username: g
+  username: postgres
   password:
   database: enum_table_test
   min_messages: warning

data/test/enum_table/test_record.rb

@@ -17,7 +17,8 @@ describe EnumTable do
   describe '.enum' do
     before do
       connection.create_table(:user_genders) { |t| t.string :value }
-      connection.execute "INSERT INTO user_genders(id, value) VALUES (1, 'female'), (2, 'male')"
+      connection.execute "INSERT INTO user_genders(id, value) VALUES (1, 'female')"
+      connection.execute "INSERT INTO user_genders(id, value) VALUES (2, 'male')"
     end
 
     it "defines an enum by a conventionally named table by default" do
@@ -45,14 +46,16 @@ describe EnumTable do
 
     it "accepts the :table name as a string" do
       connection.create_table(:custom_table) { |t| t.string :value }
-      connection.execute "INSERT INTO custom_table(id, value) VALUES (1, 'male'), (2, 'female')"
+      connection.execute "INSERT INTO custom_table(id, value) VALUES (1, 'male')"
+      connection.execute "INSERT INTO custom_table(id, value) VALUES (2, 'female')"
       User.enum :gender, table: 'custom_table'
       User.enums[:gender].value(1).must_equal(:male)
     end
 
     it "accepts the :table name as a symbol" do
       connection.create_table(:custom_table) { |t| t.string :value }
-      connection.execute "INSERT INTO custom_table(id, value) VALUES (1, 'male'), (2, 'female')"
+      connection.execute "INSERT INTO custom_table(id, value) VALUES (1, 'male')"
+      connection.execute "INSERT INTO custom_table(id, value) VALUES (2, 'female')"
       User.enum :gender, table: :custom_table
       User.enums[:gender].value(1).must_equal(:male)
     end
@@ -67,37 +70,24 @@ describe EnumTable do
       User.enums[:gender].value(1).must_equal :male
     end
 
-    it "raises an ArgumentError if :table is something else" do
-      ->{ User.enum :gender, table: Object.new }.must_raise ArgumentError, /invalid :table specifier/
-    end
-
     it "passes other options to the Reflection" do
       User.enum :gender, id_name: :gender_number
       enum = User.enums[:gender]
       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
+    it "does not cry immediately if the enum table does not exist" do
+      User.enum(:status)
     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
+    it "does cry when you first try to use the enum if the enum table does not exist" do
+      User.enum(:status)
+      exception = nil
+      begin
+        User.enum_id(:status, 'awesome')
+      rescue => exception
       end
+      exception.must_be_kind_of StandardError
     end
 
     describe "on a subclass" do
@@ -195,6 +185,10 @@ describe EnumTable do
       attributes['gender_id'].must_equal 1
       attributes.key?('gender').must_equal false
     end
+
+    it "should take an options hash in addition to the attributes hash and not raise an error" do
+      User.initialize_attributes({ 'gender' => 'female' }, { :some => :stuff }).wont_be_nil
+    end
   end
 
   describe "#enum_id" do

data/test/enum_table/test_schema_statements.rb

@@ -67,7 +67,8 @@ describe EnumTable::SchemaStatements do
   describe "#change_enum_table" do
     before do
       connection.execute "CREATE TABLE genders(id integer, value varchar(20))"
-      connection.execute "INSERT INTO genders (id, value) VALUES (1, 'female'), (2, 'male')"
+      connection.execute "INSERT INTO genders (id, value) VALUES (1, 'female')"
+      connection.execute "INSERT INTO genders (id, value) VALUES (2, 'male')"
     end
 
     it "inserts values added in the block" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enum_table
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -71,7 +71,8 @@ files:
 - test/enum_table/test_schema_statements.rb
 - test/test_helper.rb
 homepage: http://github.com/howaboutwe/enum_table
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -84,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -950106288231480747
+      hash: 932469567180106626
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -93,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -950106288231480747
+      hash: 932469567180106626
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25