constance 1.0.0

data/README.md

@@ -0,0 +1,65 @@
+Constance for Rails 3.x+
+=====
+
+Debug or override Rails 3.x+ constant loading.
+
+### Installation
+
+Put this in your Gemfile:
+
+    gem 'constance'
+
+Do:
+
+    bundle install
+
+### Configuration
+
+In `application.rb` just above your application and after the Bundler config, add the Constance configuration, e.g.:
+
+    ...
+    
+    # Debug class/module loading without stacks
+    Constance.configure do
+      self.debug = true
+      self.verbose = false
+    end
+    
+    module MyRailsApp
+      class Application < Rails::Application
+      ...
+
+You can configure on one line like:
+
+    Constance.debug = true
+
+    Constance.verbose = true
+    
+    Constance.proc = lambda{|from_mod, const_name| puts "my lambda was called from_mod=#{from_mod.inspect} const_name=#{const_name.inspect} caller: #{caller.inspect} and I can return any class or constant I want, or call some other class or method. But, for kicks I'll return nil"; nil}
+    
+    Constance.caller_search_mapping = {/(\/app\/|\/lib\/)/ => {'Journey' => 'Fantastic::Journey'}} # go through the caller stack to see if was called from a local or gem file that had app or lib in the path
+
+or using a block:
+
+    Constance.configure do
+      self.debug = true
+      self.verbose = true
+      self.proc = lambda{|from_mod, const_name| puts "my lambda was called from_mod=#{from_mod.inspect} const_name=#{const_name.inspect} caller: #{caller.inspect} and I can return any class or constant I want, or call some other class or method. But, for kicks I'll return nil"; nil}
+      self.caller_search_mapping = {/(\/app\/|\/lib\/)/ => {'Journey' => 'Fantastic::Journey'}} # go through the caller stack to see if was called from a local or gem file that had app or lib in the path
+    end
+
+### Example
+
+Non-verbose debug logging:
+
+    Loaded missing constant from_module: Object const_name: :Foo using ActiveSupport::Dependencies. Got: Foo
+    Loaded missing constant from_module: Object const_name: :ApplicationController using ActiveSupport::Dependencies. Got: ApplicationController
+    Loaded missing constant from_module: InheritedResources const_name: :Base using ActiveSupport::Dependencies. Got: InheritedResources::Base
+    Loaded missing constant from_module: Object const_name: :Bar using ActiveSupport::Dependencies. Got: Bar
+    Loaded missing constant from_module: Object const_name: "Foobar" using ActiveSupport::Dependencies. Got: Foobar
+
+### License
+
+Copyright (c) 2012 Gary S. Weaver, released under the [MIT license][lic].
+
+[lic]: http://github.com/garysweaver/constance/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+#http://nicksda.apotomo.de/2010/10/testing-your-rails-3-engine-sitting-in-a-gem/
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+desc "Run tests"
+task :default => :test

data/lib/constance/config.rb

@@ -0,0 +1,13 @@
+module Constance
+  OPTIONS = [
+    :caller_search_mapping,
+    :debug,
+    :verbose,
+    :proc
+  ]
+  
+  class << self
+    OPTIONS.each{|o|attr_accessor o; alias_method "#{o}?".to_sym, o}
+    def configure(&blk); class_eval(&blk); end
+  end
+end

data/lib/constance/dependencies.rb

@@ -0,0 +1,20 @@
+require 'constance/config'
+require 'pp'
+
+module ActiveSupport
+  module Dependencies
+    alias_method(:load_missing_constant_constance_renamed, :load_missing_constant)
+    undef_method(:load_missing_constant)
+    def load_missing_constant(from_mod, const_name)
+      puts "Loading missing constant from_module: #{from_mod.inspect} const_name: #{const_name.inspect}\ncaller was:\n#{caller.pretty_inspect}" if Constance.debug? && Constance.verbose?
+      result = Constance::Resolver.resolve(from_mod, const_name)
+      if result
+        puts "Loaded missing constant from_module: #{from_mod.inspect} const_name: #{const_name.inspect} using Constance::Resolver. Got: #{result.inspect}" if Constance.debug?
+      else
+        result = load_missing_constant_constance_renamed(from_mod, const_name)
+        puts "Loaded missing constant from_module: #{from_mod.inspect} const_name: #{const_name.inspect} using ActiveSupport::Dependencies. Got: #{result.inspect}}" if Constance.debug?
+      end
+      result
+    end
+  end
+end

data/lib/constance/resolver.rb

@@ -0,0 +1,35 @@
+require 'constance/config'
+
+module Constance
+  class Resolver
+    # return a constant or if returns nil, Rails will use ActiveSupport::Dependencies.load_missing_constant
+    def self.resolve(from_mod, const_name)
+      if Constance.caller_search_mapping
+        puts "#{self.class.name} checking caller stack against caller_search_mapping regular expressions #{Constance.caller_search_mapping.inspect}" if Constance.verbose?
+        klass = resolve_by_caller_search_mapping(from_mod, const_name, Constance.caller_search_mapping)
+        puts "#{self.class.name} caller_search_mapping did not resolve" if Constance.verbose? && !klass
+      end
+      if !klass && Constance.proc.is_a?(Proc)
+        puts "#{self.class.name} sending from_mod=#{from_mod} and const_name=#{const_name} into proc" if Constance.verbose?
+        klass = Constance.proc.call(from_mod, const_name)
+        puts "#{self.class.name} proc did not resolve" if Constance.verbose? && !klass
+      end
+      if klass
+        puts "#{self.class.name} setting #{const_name} => #{klass} on ActiveSupport::Dependencies::Reference @store" if Constance.verbose?
+        ActiveSupport::Dependencies::Reference.instance_variable_get(:@store)[const_name] = klass if klass
+      end
+      klass
+    end
+
+    def self.resolve_by_caller_search_mapping(from_mod, const_name, caller_search_mapping)
+      caller.each do |line|
+        caller_search_mapping.keys.each do |search|
+          if search =~ line
+            puts "#{self.class.name} matched #{search} in #{line}" if Constance.verbose?
+            return caller_search_mapping[search][const_name.to_s].try(:constantize)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/constance/version.rb

@@ -0,0 +1,3 @@
+module Constance
+  VERSION = '1.0.0'
+end

data/lib/constance.rb

@@ -0,0 +1,4 @@
+require 'constance/version'
+require 'constance/config'
+require 'constance/resolver'
+require 'constance/dependencies'

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: constance
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Gary S. Weaver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-05 00:00:00.000000000 Z
+dependencies: []
+description: Debug and override Rails 3.x constant loading.
+email:
+- garysweaver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/constance/config.rb
+- lib/constance/dependencies.rb
+- lib/constance/resolver.rb
+- lib/constance/version.rb
+- lib/constance.rb
+- Rakefile
+- README.md
+homepage: https://github.com/garysweaver/constance
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Debug and override Rails 3.x constant loading.
+test_files: []