rails_agnostic_models 0.0.5 → 0.0.6

data/lib/rails_agnostic_models/active_record_extensions.rb

@@ -48,8 +48,20 @@ module RailsAgnosticModels
 
       # safely refer to constants that may not be defined. Useful in a gem that might get included in places that might not define EVERY active record model, such as
       # a satelite administration application. Note that you will still need to handle nil cases
-      def safe_constant(constant_sym)
-        return Object.const_get(constant_sym) if Object.const_defined? constant_sym
+      #
+      # safe_constant(:Object) # => Object
+      # safe_constant(:ClassThatDoesNotExist) # => nil
+      # safe_constant("Object") # => Object
+      # safe_constant("MyModule::MyClass") # => MyModule::MyClass
+      def safe_constant(constant)
+        case constant
+        when Symbol then
+          return top_level_constant_lookup constant
+        when String then
+          drill_down_constant_lookup(constant)
+        else
+          return nil
+        end
       end
 
       # Defines the appropraite scope based on the version of Rails
@@ -69,6 +81,29 @@ module RailsAgnosticModels
           self.inheritance_column = column_name
         end
       end
+
+      private 
+
+      def drill_down_constant_lookup(constant)
+        constant_tokens = constant.split("::")
+        first_token = constant_tokens.first
+        return_constant = top_level_constant_lookup first_token
+        # go ahead and cut bait if the top level constant isn't there
+        return nil unless return_constant
+        constant_tokens.drop(1).each do | token |
+          if return_constant.constants.include?(token.to_sym)
+            return_constant = return_constant.const_get(token)
+          else
+            return nil
+          end
+        end
+        return return_constant
+      end
+
+      def top_level_constant_lookup(constant)
+        Object.const_get(constant) if Object.const_defined? constant
+      end
+
     end
     def self.included(klass)
       klass.extend(ClassMethods)

data/lib/rails_agnostic_models/version.rb

@@ -1,3 +1,3 @@
 module RailsAgnosticModels
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/rails_agnostic_models/safe_constant_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+class MyClass < ActiveRecord::Base
+end
+
+class OtherClass < ActiveRecord::Base
+  NUMBER = 1
+end
+
+module MyModule
+  class MyClass < ActiveRecord::Base
+  end
+end
+
+describe "#self.safe_constant" do
+  it "accepts strings" do
+    MyClass.send(:safe_constant, "OtherClass").should eq OtherClass
+  end
+  it "accepts symbols" do
+    MyClass.send(:safe_constant, :OtherClass).should eq OtherClass
+  end
+  it "does not return the constant if it's not defined" do
+    MyClass.send(:safe_constant, :SomeOtherClass).should be_nil
+  end
+  it "returns the constant if it's defined" do
+    MyClass.send(:safe_constant, :OtherClass).should eq OtherClass
+  end
+  context "namespaced constants" do
+    it "returns namedspaced constants" do
+      MyClass.send(:safe_constant, "MyModule::MyClass").should eq MyModule::MyClass
+    end 
+    it "returns nil if it doesn't exist" do
+      MyClass.send(:safe_constant, "MyModule::SOMETHING_FAKE").should be_nil
+    end 
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_agnostic_models
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -141,6 +141,7 @@ files:
 - lib/rails_agnostic_models/active_record_extensions.rb
 - lib/rails_agnostic_models/version.rb
 - rails_agnostic_models.gemspec
+- spec/rails_agnostic_models/safe_constant_spec.rb
 - spec/rails_agnostic_models/version_agnostic_inheritance_column_spec.rb
 - spec/rails_agnostic_models/version_agnostic_scope_spec.rb
 - spec/spec_helper.rb
@@ -159,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2644159498259307497
+      hash: -1154643741630881998
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -168,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2644159498259307497
+      hash: -1154643741630881998
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -177,6 +178,7 @@ specification_version: 3
 summary: Extends activerecord to provide rails-agnostic versions of common model code
   to east the pain of upgrading
 test_files:
+- spec/rails_agnostic_models/safe_constant_spec.rb
 - spec/rails_agnostic_models/version_agnostic_inheritance_column_spec.rb
 - spec/rails_agnostic_models/version_agnostic_scope_spec.rb
 - spec/spec_helper.rb