foxy_factory 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kristian Mandrup
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,155 @@
+# Foxy Factory #
+
+Find Constants, including Modules and Classes registered in the Ruby kernel using convenient finder methods. 
+Create new instances factory style. This is a way more advanced utility than 'constantize' and similar more "primitive" factory methods.
+Foxy Factory caches each successful lookup for faster future retrieval, instead of having to go through the kernel.
+If a constant is not found in the cache, a kernel lookup will always be performed as a fall-back.
+
+## Install ##
+
+<code>$ gem install foxy_factory</code> 
+
+## Usage ##
+
+<code>require 'foxy_factory'</code> 
+
+## Configuration ##
+
+Imagine this namespace structure:
+
+<pre><code>    
+  class Basic
+    def initialize(number, say = "Hello", &block)
+      @number = number
+      @say = say
+      if block
+        block.arity < 1 ? obj.instance_eval(&block) : block.call(obj)
+      end        
+    end
+  end
+
+  module Howrah  
+    class MyClass < Basic
+      def initialize(number, &block)
+        super
+      end
+    end
+
+    module MyModule
+      class MyNestedClass < Basic
+        def initialize(number, &block)
+          super
+        end
+      end
+
+      module MyNestedModule
+        class MyDoubleNestedClass
+        end
+      end
+    end
+  end  
+</code></pre>
+
+Create factory with base namespace 'Howrah' that this factory will use as the root (or base) namespace
+
+<code>factory = Foxy::Factory.new :howrah</code>
+
+You can at any time change the implicit root for a given factory
+<pre><code>
+  factory = Foxy::Factory.new
+  ...
+  factory.base_namespace = :my_root
+</code></pre>
+
+## Find constant ##
+
+Find constant `Howrah::MyClass`
+<pre><code>factory.find_constant :my_class
+
+=> Howrah::MyClass
+</code></pre>
+
+Find constant `Howrah::NonExistingClass` - should raise error
+<pre><code>factory.find_constant :non_existing_class
+
+=> error: ConstantNotFoundError
+</code></pre>
+
+Find constant `Howrah::MyModule`
+<pre><code>factory.find_constant :my_module
+  
+=> Howrah::MyModule
+</code></pre>
+
+Find constant `Howrah::MyModule::MyNestedClass`
+
+<pre><code>factory.find_constant :my_module, :my_nested_class
+  
+=> Howrah::MyModule::MyNestedClass
+</code></pre>
+
+Find constant `Howrah::MyModule::MyNestedModule::MyDoubleNestedClass`
+<pre><code>factory.find_constant :my_module, :my_nested_module, :my_double_nested_class
+  
+=> Howrah::MyModule::MyNestedModule::MyDoubleNestedClass
+</code></pre>
+
+## Find module ##
+
+Find module `Howrah::MyModule`
+<pre><code>factory.find_module :my_module
+=> Howrah::MyModule  
+</code></pre>
+
+Find module `Howrah::MyModule::MyNestedModule`
+<pre><code>factory.find_module :my_module, :my_nested_module
+
+=> Howrah::MyModule::MyNestedModule
+</code></pre>
+
+Find module `Howrah::MyModule::MyNestedModule::MyNestedClass` but not class!
+<pre><code>factory.find_module! :my_module, :my_nested_class
+  
+=> error: ConstantIsNotModuleError
+</code></pre>
+
+## Find Class ##
+
+Find class `Howrah::MyModule`
+<pre><code>factory.find_class :my_module
+
+=> error: ConstantIsNotClassError
+</code></pre>
+
+Find class `Howrah::MyModule::MyNestedModule::MyDoubleNestedClass`
+<pre><code>factory.find_class :my_module, :my_nested_module, :my_nested_class
+  
+=> Howrah::MyModule::MyNestedModule::MyDoubleNestedClass
+</code></pre>
+
+## Create instance ##
+
+<pre><code>  factory.create :my_module, :my_nested_class, :args => [2, 'Hello'] do |p|
+    puts p.number * p.say
+  end 
+  
+  => Hello Hello
+
+  factory.create :my_class, :args => 2 do |p|
+    puts p.number * "Hello "
+  end 
+</code></pre>
+
+## Note on Patches/Pull Requests ##
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright ##
+
+Copyright (c) 2010 Kristian Mandrup. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,42 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "foxy_factory"
+    gem.summary = %Q{Easily find registered constants, modules and classes}
+    gem.description = %Q{Find a constant registered by Ruby kernel and cache it for next retrieval}
+    gem.email = "kmandrup@gmail.com"
+    gem.homepage = "http://github.com/kristianmandrup/factory"
+    gem.authors = ["Kristian Mandrup"]
+    # gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+# require 'spec/rake/spectask'
+# Spec::Rake::SpecTask.new(:spec) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.spec_files = FileList['spec/**/*_spec.rb']
+# end
+# 
+# Spec::Rake::SpecTask.new(:rcov) do |spec|
+#   spec.libs << 'lib' << 'spec'
+#   spec.pattern = 'spec/**/*_spec.rb'
+#   spec.rcov = true
+# end
+# 
+# task :spec => :check_dependencies
+# 
+# task :default => :spec
+# 
+# require 'rake/rdoctask'
+# Rake::RDocTask.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# 
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "factory #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/foxy_factory.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{foxy_factory}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = %q{2010-06-18}
+  s.description = %q{Find a constant registered by Ruby kernel and cache it for next retrieval}
+  s.email = %q{kmandrup@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "foxy_factory.gemspec",
+     "lib/foxy_factory.rb",
+     "spec/factory/factory_create_spec.rb",
+     "spec/factory/factory_fixture.rb",
+     "spec/factory/factory_nested_ns_spec.rb",
+     "spec/factory/factory_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kristianmandrup/factory}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Easily find registered constants, modules and classes}
+  s.test_files = [
+    "spec/factory/factory_create_spec.rb",
+     "spec/factory/factory_fixture.rb",
+     "spec/factory/factory_nested_ns_spec.rb",
+     "spec/factory/factory_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/foxy_factory.rb

@@ -0,0 +1,155 @@
+module Foxy    
+  class Factory
+    attr_reader :ns_registry, :base_namespace
+
+    class ConstantNotFoundError < StandardError
+    end
+
+    class ConstantIsNotClassError < StandardError
+    end   
+
+    class ConstantIsNotModuleError < StandardError
+    end
+
+          
+    def initialize(*namespaces)
+      # raise ArgumentError, "Factory must be initialized with an array of modules to set the base namespace" if namespaces.empty?                                                     
+      @ns_registry = namespaces.last.kind_of?(Hash) ? remove_last(namespaces) : {}
+      @base_namespace = namespace(namespaces)
+    end
+
+    def create(*args, &block)
+      if !args.last.kind_of?(Hash) || !args.last[:args] 
+        raise ArgumentError, "Last argument before block must be a hash of type :args => [...]" if block
+        raise ArgumentError, "Last argument must be a hash of type :args => [...]"
+      end
+      instance_args = args.delete(args.last)[:args]      
+      ns_list, name = parse_args(args)       
+      namespaces = get_namespaces(ns_list)      
+      obj = find_class(namespaces, name).new *instance_args 
+      if block
+        block.arity < 1 ? obj.instance_eval(&block) : block.call(obj)
+      end
+    end        
+
+    def find_class(*args)      
+      ns_list, name = parse_args(args)       
+      namespaces = get_namespaces(ns_list)
+      clazz = find_constant(*args)
+      return clazz if clazz.is_a? Class     
+      ns = full_ns_name(namespaces, name) 
+      raise Factory::ConstantIsNotClassError, "#{ns} is not a class"
+    end
+
+    def find_module(*args)                    
+      ns_list, name = parse_args(args)      
+      namespaces = get_namespaces(ns_list)
+      m_dule = find_constant(*args)   
+      return m_dule if m_dule.is_a?(Module)
+      ns = full_ns_name(namespaces, name) 
+      raise Factory::ConstantIsNotModuleError, "#{ns} is not a module"
+    end
+
+    def find_module!(*args)                    
+      ns_list, name = parse_args(args)      
+      namespaces = get_namespaces(ns_list)
+      m_dule = find_constant(*args)   
+      return m_dule if m_dule.is_a?(Module) && !m_dule.is_a?(Class)     
+      ns = full_ns_name(namespaces, name) 
+      raise Factory::ConstantIsNotModuleError, "#{ns} is not a module"
+    end
+
+    
+    def find_constant(*args) 
+      ns_list, name = parse_args(args) 
+      namespaces = get_namespaces(ns_list)      
+      ns = namespace(namespaces)     
+      
+      # put entry in cache for namespace if not present 
+      register_namespace(ns) if !registered?(ns)
+
+      # get namespace entry in cache
+      cache = ns_cache(ns)                                                      
+      begin    
+        if !cache[name]     
+          full_name = ns_name(ns, name) 
+          cache[name] = constantize(full_name)
+        end 
+        cache[name]
+      rescue
+        raise Factory::ConstantNotFoundError, "No constant found for #{camelize(name)} in namespace #{real_ns_name(ns)}"
+      end
+    end
+    
+    protected  
+      # From ActiveSupport/inflector.rb
+      def constantize(camel_cased_word)
+        Factory.get_const(camel_cased_word)
+      end 
+
+      def self.get_const(camel_cased_word)
+        names = camel_cased_word.split('::')
+        names.shift if names.empty? || names.first.empty?
+        constant = Object
+        names.each do |name|
+          constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
+        constant
+      end       
+
+      def real_ns_name(ns)
+        return camelize(base_namespace) if ns == 'RootNs'
+        ns
+      end
+
+      def parse_args(args)
+        raise ArgumentError, "Supplied options must not be empty" if !args || args.empty?
+        ns_list = [] if args.size == 1
+        ns_list = args[0..-2] if args.size > 1
+        name = args.last
+        [ns_list, name]
+      end  
+      
+      
+      def get_namespaces(ns_list)      
+        return [:root_ns] if !ns_list || ns_list.empty?
+        ns_list      
+      end
+    
+      def remove_last(namespaces)    
+        namespaces.delete(namespaces.last)
+      end    
+    
+      def register_namespace(ns)        
+        ns_registry[ns] = {}        
+      end
+
+      def registered?(ns)       
+        ns_cache(ns)
+      end
+
+      def ns_cache(ns)
+        ns_registry[ns]
+      end
+
+      def ns_name(ns, name)   
+        return "#{base_namespace}::#{camelize(name)}" if ns == 'RootNs'
+        "#{base_namespace}::#{ns}::#{camelize(name)}"
+      end
+
+      def full_ns_name(*namespaces, name)
+        ns = namespace(namespaces)
+        ns_name(ns, name)
+      end
+      
+      def namespace(namespaces)
+        raise ArgumentError, "Argument must be an array of namespaces" if !namespaces.kind_of? Array
+        namespaces.map{|n| camelize(n.to_s)}.join('::')        
+      end 
+      
+      def camelize(str)
+        str.to_s.split(/[^a-z0-9]/i).map{|w| w.capitalize}.join
+      end
+      
+  end  
+end

data/spec/factory/factory_create_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+require 'factory/factory_fixture'
+
+module Foxy  
+  describe Factory do
+    before(:each) do
+      @clean_factory = Foxy::Factory.new :howrah
+    end                   
+    
+    context "clean factory" do   
+      it "should NOT find constant 'base' in 'bad' namespace" do
+        lambda { @clean_factory.create(:bad, 'base') }.should raise_error ArgumentError
+      end          
+
+      it "should create class 'my_nested_class' in 'my_module' namespace as it's a class" do
+        @clean_factory.create(:my_class, :args => 2) do |p|
+          p.number.should == 2
+        end
+      end          
+       
+      it "should create class 'my_nested_class' in 'my_module' namespace as it's a class" do
+        @clean_factory.create(:my_module, :my_nested_class, :args => [2]) do |p|
+          p.number.should == 2
+        end
+      end          
+
+      it "should create class 'my_nested_class' in 'my_module' namespace as it's a class" do
+        @clean_factory.create(:my_module, :my_nested_class, :args => [2, 'Goodbye']) do |p|
+          p.number.should == 2
+          p.say.should == "Goodbye"
+        end
+      end          
+    end
+  end
+end

data/spec/factory/factory_fixture.rb

@@ -0,0 +1,34 @@
+puts "Fixture loaded"
+
+class Basic          
+  attr_reader :number, :say
+  
+  def initialize(number, say = "Hello", &block)
+    @number = number
+    @say = say
+    if block
+      block.arity < 1 ? obj.instance_eval(&block) : block.call(obj)
+    end        
+  end
+end
+
+module Howrah  
+  class MyClass < Basic
+    def initialize(number, say = "Hello", &block)
+      super
+    end
+  end
+
+  module MyModule
+    class MyNestedClass < Basic
+      def initialize(number, say = "Hello", &block)
+        super
+      end
+    end
+
+    module MyNestedModule
+      class MyDoubleNestedClass
+      end
+    end
+  end
+end  

data/spec/factory/factory_nested_ns_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+require 'factory/factory_fixture'
+
+module Foxy  
+  describe Factory do
+    before(:each) do
+      @clean_factory = Foxy::Factory.new :howrah
+    end                   
+    
+    context "clean factory" do   
+      it "should NOT find constant 'base' in 'bad' namespace" do
+        lambda { @clean_factory.find_constant(:bad, 'base') }.should raise_error Foxy::Factory::ConstantNotFoundError
+      end          
+       
+      it "should find class 'my_nested_class' in 'my_module' namespace as it's a class" do
+        @clean_factory.find_class(:my_module, 'my_nested_class').should_not be_nil
+      end          
+      
+      it "should NOT find class 'my_nested_module' in 'my_module' namespace as it's a module" do
+        lambda { @clean_factory.find_class(:my_module, :my_nested_module) }.should raise_error Foxy::Factory::ConstantIsNotClassError
+      end          
+      
+      it "should find constant 'my_double_nested_class' in 'my_module::mynested_module' namespace" do
+        @clean_factory.find_constant(:my_module, :my_nested_module, :my_double_nested_class).should_not be_nil 
+      end                      
+    end
+  end
+end

data/spec/factory/factory_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+require 'factory/factory_fixture'
+
+module Foxy  
+  describe Factory do
+    before(:each) do
+      @clean_factory = Foxy::Factory.new :howrah
+    end
+
+    context ":howrah factory" do    
+      it "should have an empty namespace registry" do
+        @clean_factory.ns_registry.should == {}
+      end      
+
+      describe "#find_constant" do
+        it "should raise ArgumentError if no arguments given" do
+          lambda { @clean_factory.find_constant }.should raise_error ArgumentError
+        end          
+      
+        it "should NOT find constant 'bad_class'" do
+          lambda { @clean_factory.find_constant('bad_class') }.should raise_error Foxy::Factory::ConstantNotFoundError
+        end          
+      
+        it "should find constant 'my_class' in 'howrah' namespace" do
+          @clean_factory.find_constant('my_class').should
+        end
+      
+        it "should find constant 'my_module' in 'howrah' namespace" do
+          @clean_factory.find_constant('my_module').should
+        end
+      end
+      
+      describe "#find_class" do              
+        it "should NOT find class 'my_module' in 'howrah' namespace as it's a module" do
+          lambda { @clean_factory.find_class('my_module') }.should raise_error Foxy::Factory::ConstantIsNotClassError
+        end                
+      
+        it "should find class 'my_class' in 'howrah' namespace as it's a module" do
+          @clean_factory.find_class('my_class').should
+        end          
+      end
+
+      describe "#find_module" do                            
+        it "should NOT find module 'my_class' in 'howrah' namespace as it's a module" do
+          lambda { @clean_factory.find_module('my_class') }.should raise_error Foxy::Factory::ConstantIsNotModuleError
+        end          
+
+        it "should find module 'my_module' in 'howrah' namespace as it's a module" do
+          @clean_factory.find_module('my_module').should
+        end          
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rspec'
+require 'rspec/autorun'
+require 'foxy_factory'
+
+RSpec.configure do |config|
+  # config.mock_with :mocha
+  # config.include(Matchers)  
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: foxy_factory
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Kristian Mandrup
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-18 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Find a constant registered by Ruby kernel and cache it for next retrieval
+email: kmandrup@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- foxy_factory.gemspec
+- lib/foxy_factory.rb
+- spec/factory/factory_create_spec.rb
+- spec/factory/factory_fixture.rb
+- spec/factory/factory_nested_ns_spec.rb
+- spec/factory/factory_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/kristianmandrup/factory
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easily find registered constants, modules and classes
+test_files: 
+- spec/factory/factory_create_spec.rb
+- spec/factory/factory_fixture.rb
+- spec/factory/factory_nested_ns_spec.rb
+- spec/factory/factory_spec.rb
+- spec/spec_helper.rb