objectid_columns 1.0.3 → 1.0.5

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTM2ZmNmNTFhMTVhOGU5YjM3NjJhYWMwMjQ2MTMzZWY5M2QzZjlmOA==
-  data.tar.gz: !binary |-
-    NTdmODI1NjE4NGNjOTBlZjhiYjI3OGJhOTZiNDEzZDc0M2MyYjMxMg==
+SHA1:
+  metadata.gz: 01caf94a3f04125c21d77a1956729388f6a113c8
+  data.tar.gz: 498bd6ccad78240d27f0c138de15a1213ac166c3
 SHA512:
-  metadata.gz: !binary |-
-    ODQ3M2Q4NjhhMTk4ZWQzNGM1MDhjM2U4OWQ4N2E0YmY1ZTk0Yzg5ZTFmYWE3
-    M2Q4MzkxODFlMzVlZmJjNWJkNjUzOTVkMDdmYzg3YmFjOWIzNWI0M2VlNjYx
-    NzViZmZmN2I1MGU5MGU4MGFiNmExNzA5YzZhOTcyMDA3MGE0YTA=
-  data.tar.gz: !binary |-
-    NmQ4NGM2NTM3MDg1NWM5NjJhZjk2OWQ4N2Q4ZjI0MDA4NmI5Y2Y2YmEyYzI0
-    ODMwNDI0Y2MwMTg1MDI2YjA4NGVmNjIyNzdlYjAzN2IyZjI3MGJkM2UwM2E1
-    MTZkNmQ0M2M5NzkxYTYyMzcyZTcyZWVhNTgyMjk0NTliNjFlYWM=
+  metadata.gz: 624d4c997b0a1ae924312bc6f6e810b29989f764c658cbc8b8ba10280cb0aef31f4c38c9f655106b32a87a5fb42a67ec297e4a53e6a67943e0ea72263b2d00a7
+  data.tar.gz: 72f525d605c017fac9d8475bab4e2551c0a96bea851466c08ca4a27dc9a8b061c2238d9aea6e147c6ffe2c3dd95af99e0b34d00f8b415496245175c843bc6f47

data/.travis.yml

@@ -2,8 +2,8 @@ rvm:
     - "1.8.7"
     - "1.9.3"
     - "2.0.0"
-    - "2.1.0"
-    - "jruby-1.7.9"
+    - "2.1.3"
+    - "jruby-1.7.16"
 env:
     - OBJECTID_COLUMNS_AR_TEST_VERSION=3.0.20 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
     - OBJECTID_COLUMNS_AR_TEST_VERSION=3.0.20 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
@@ -11,15 +11,15 @@ env:
     - OBJECTID_COLUMNS_AR_TEST_VERSION=3.1.12 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
     - OBJECTID_COLUMNS_AR_TEST_VERSION=3.1.12 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
     - OBJECTID_COLUMNS_AR_TEST_VERSION=3.1.12 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
-    - OBJECTID_COLUMNS_AR_TEST_VERSION=3.2.18 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
-    - OBJECTID_COLUMNS_AR_TEST_VERSION=3.2.18 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
-    - OBJECTID_COLUMNS_AR_TEST_VERSION=3.2.18 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
-    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.5 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
-    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.5 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
-    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.5 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
-    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.1 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
-    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.1 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
-    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.1 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
+    - OBJECTID_COLUMNS_AR_TEST_VERSION=3.2.19 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
+    - OBJECTID_COLUMNS_AR_TEST_VERSION=3.2.19 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
+    - OBJECTID_COLUMNS_AR_TEST_VERSION=3.2.19 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
+    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.10 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
+    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.10 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
+    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.10 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
+    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.6 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
+    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.6 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
+    - OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.6 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
 before_script:
     - mysql -e 'create database myapp_test;'
     - psql -c 'create database myapp_test;' -U postgres
@@ -27,18 +27,18 @@ matrix:
     exclude:
         # ActiveRecord 4.x doesn't support Ruby 1.8.7
         -   rvm: 1.8.7
-            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.5 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
+            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.10 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
         -   rvm: 1.8.7
-            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.5 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
+            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.10 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
         -   rvm: 1.8.7
-            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.5 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
+            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.0.10 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
         -   rvm: 1.8.7
-            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.1 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
+            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.6 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=mysql
         -   rvm: 1.8.7
-            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.1 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
+            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.6 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=postgres
         -   rvm: 1.8.7
-            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.1 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
+            env: OBJECTID_COLUMNS_AR_TEST_VERSION=4.1.6 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
     allow_failures:
         -   env: OBJECTID_COLUMNS_AR_TEST_VERSION=3.1.12 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
         -   rvm: 1.8.7
-            env: OBJECTID_COLUMNS_AR_TEST_VERSION=3.2.18 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite
+            env: OBJECTID_COLUMNS_AR_TEST_VERSION=3.2.19 OBJECTID_COLUMNS_TRAVIS_CI_DATABASE_TYPE=sqlite

data/CHANGES.md

@@ -1,5 +1,10 @@
 # Change History for ObjectidColumns
 
+### Version 1.0.5: October 10, 2014
+
+* Fixed an issue where using `objectid_columns` on a parent model class that was then inherited from (via STI) could cause an internal exception.
+* Updated Travis testing specifications to the latest versions of Ruby/JRuby and ActiveRecord.
+
 ### Version 1.0.3: June 11, 2014
 
 * Fixed an issue where, if you tried to declare `has_objectid_primary_key` on a table that didn't exist (usually meaning it just hadn't been migrated into existence yet), you'd get an error. Now, we ignore this declaration.

data/lib/objectid_columns/dynamic_methods_module.rb

@@ -44,15 +44,38 @@ module ObjectidColumns
 
       # Unfortunately, there appears to be no way to "un-include" a Module in Ruby -- so we have no way of replacing
       # an existing DynamicMethodsModule on the target class, which is what we'd really like to do in this situation.
-      if @target_class.const_defined?(@name)
-        existing = @target_class.const_get(@name)
 
-        if existing && existing != self
-          raise NameError, %{You tried to define a #{self.class.name} named #{name.inspect} on class #{target_class.name},
-but that class already has a constant named #{name.inspect}: #{existing.inspect}}
+      # Sigh. From the docs for Method#arity:
+      #
+      # "For Ruby methods that take a variable number of arguments, returns -n-1, where n is the number of required
+      # arguments. For methods written in C, returns -1 if the call takes a variable number of arguments."
+      #
+      # It turns out that .const_defined? is written in C, which means it returns -1 if it takes a variable number of
+      # arguments. So we can't check for arity.abs >= 2 here, but rather must look for <= -1...
+      if @target_class.method(:const_defined?).arity <= -1
+        if @target_class.const_defined?(@name, false)
+          existing = @target_class.const_get(@name, false)
+
+          if existing && existing != self
+            raise NameError, %{You tried to define a #{self.class.name} named #{name.inspect} on class #{target_class.name},
+  but that class already has a constant named #{name.inspect}: #{existing.inspect}}
+          end
+        end
+      else
+        # So...in Ruby 1.8.7, .const_defined? and .const_get don't accept the second parameter, which tells you whether
+        # to search superclass constants as well. But, amusingly, we're not only not stuck, this is fine: in Ruby
+        # 1.8.7, constant lookup doesn't search superclasses, either -- so we're OK.
+        if @target_class.const_defined?(@name)
+          existing = @target_class.const_get(@name)
+
+          if existing && existing != self
+            raise NameError, %{You tried to define a #{self.class.name} named #{name.inspect} on class #{target_class.name},
+  but that class already has a constant named #{name.inspect}: #{existing.inspect}}
+          end
         end
       end
 
+
       @class_methods_module = Module.new
       (class << @class_methods_module; self; end).send(:public, :private)
       @target_class.const_set("#{@name}ClassMethods", @class_methods_module)

data/lib/objectid_columns/objectid_columns_manager.rb

@@ -347,7 +347,7 @@ module ObjectidColumns
     #
     #     MyModel.where(:foo_oid => "52ec126d78161f56d8000001")
     def translate_objectid_query_pair(query_key, query_value)
-      if (type = oid_columns[query_key.to_sym])
+      if (type = net_oid_columns[query_key.to_sym])
 
         # Handle nil, false
         if (! query_value)
@@ -381,7 +381,17 @@ module ObjectidColumns
 
     # Given the name of a column, tell whether or not it is an ObjectId column.
     def is_objectid_column?(column_name)
-      oid_columns.has_key?(column_name.to_sym)
+      net_oid_columns.has_key?(column_name.to_sym)
+    end
+
+    # Returns the same thing as +oid_columns+, except merges in the ActiveRecord class's superclass's columns, if
+    # any.
+    def net_oid_columns
+      out = { }
+      if (socm = superclass_objectid_columns_manager)
+        out = socm.net_oid_columns
+      end
+      out.merge(oid_columns)
     end
 
     private
@@ -390,11 +400,18 @@ module ObjectidColumns
     # Given the name of a column -- which must be an ObjectId column -- returns its type, either +:binary+ or
     # +:string+.
     def objectid_column_type(column_name)
-      out = oid_columns[column_name.to_sym]
-      raise "Something is horribly wrong; #{column_name.inspect} is not an ObjectId column -- we have: #{oid_columns.keys.inspect}" unless out
+      out = net_oid_columns[column_name.to_sym]
+      raise "Something is horribly wrong; #{column_name.inspect} is not an ObjectId column -- we have: #{net_oid_columns.keys.inspect}" unless out
       out
     end
 
+    # If our +@active_record_class+ has a superclass that in turn is using +objectid_columns+, returns the
+    # ObjectidColumnsManager for that class, if any.
+    def superclass_objectid_columns_manager
+      ar_superclass = @active_record_class.superclass
+      ar_superclass.objectid_columns_manager if ar_superclass.respond_to?(:objectid_columns_manager)
+    end
+
     # Raises an exception -- used for +case+ statements where we switch on the type of the column. Useful so that if,
     # in the future, we support a new column type, we won't forget to add a case for it in various places.
     def unknown_type(type)

data/lib/objectid_columns/version.rb

@@ -1,4 +1,4 @@
 # What's the current version of this gem?
 module ObjectidColumns
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 end

data/spec/objectid_columns/helpers/system_helpers.rb

@@ -15,12 +15,14 @@ module ObjectidColumns
         end
       end
 
-      def define_model_class(name, table_name, &block)
-        model_class = Class.new(::ActiveRecord::Base)
+      def define_model_class(name, table_name, options = { }, &block)
+        superclass = options[:superclass] || ::ActiveRecord::Base
+        model_class = Class.new(superclass)
         ::Object.send(:remove_const, name) if ::Object.const_defined?(name)
         ::Object.const_set(name, model_class)
-        model_class.table_name = table_name
-        model_class.class_eval(&block)
+        model_class.table_name = table_name if table_name
+        model_class.class_eval(&block) if block
+        model_class
       end
 
       def ensure_database_is_set_up!

data/spec/objectid_columns/system/basic_system_spec.rb

@@ -71,6 +71,50 @@ describe "ObjectidColumns basic operations" do
         @tc.new
       end
 
+      context "with an STI table and model" do
+        before :each do
+          migrate do
+            drop_table :objectidcols_spec_table_sti rescue nil
+            create_table :objectidcols_spec_table_sti do |t|
+              t.string :type
+              t.column :some_oid, 'VARCHAR(24)'
+            end
+          end
+        end
+
+        after :each do
+          migrate do
+            drop_table :objectidcols_spec_table_sti rescue nil
+          end
+        end
+
+        let(:parent_model_class) { define_model_class(:SpectableStiParent, 'objectidcols_spec_table_sti') { has_objectid_columns } }
+        let(:child_model_class) { define_model_class(:SpectableStiChild, 'objectidcols_spec_table_sti', :superclass => parent_model_class) { } }
+
+        it "should work from both the parent and child class" do
+          id_1 = new_oid
+          id_2 = new_oid
+
+          parent_instance = parent_model_class.new(:some_oid => id_1)
+          parent_instance.save!
+
+          child_instance = child_model_class.new(:some_oid => id_2)
+          child_instance.save!
+
+          all_models = parent_model_class.all.to_a
+          expect(all_models.length).to eq(2)
+          parent_instance_again = all_models.detect { |m| m.id == parent_instance.id }
+          child_instance_again = all_models.detect { |m| m.id == child_instance.id }
+
+          expect(parent_instance_again.some_oid).to be_an_objectid_object_matching(id_1)
+          expect(child_instance_again.some_oid).to be_an_objectid_object_matching(id_2)
+
+          child_models = child_model_class.all.to_a
+          expect(child_models.length).to eq(1)
+          expect(child_models[0].some_oid).to be_an_objectid_object_matching(id_2)
+        end
+      end
+
       it "should not allow defining a column that's too short" do
         if ObjectidColumns::Helpers::SystemHelpers.supports_length_limits_on_binary_columns?
           expect { ::Spectable.class_eval { has_objectid_column :too_short_b } }.to raise_error(ArgumentError)

metadata

@@ -1,151 +1,151 @@
 --- !ruby/object:Gem::Specification
 name: objectid_columns
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - Andrew Geweke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <=
+    - - "<="
       - !ruby/object:Gem::Version
         version: 4.99.99
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <=
+    - - "<="
       - !ruby/object:Gem::Version
         version: 4.99.99
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <=
+    - - "<="
       - !ruby/object:Gem::Version
         version: 4.99.99
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
-    - - <=
+    - - "<="
       - !ruby/object:Gem::Version
         version: 4.99.99
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: moped
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bson
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: composite_primary_keys
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: 
@@ -155,8 +155,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
@@ -186,17 +186,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Transparently store MongoDB ObjectId values in ActiveRecord.