open_namespace 0.2.0

data/.gitignore

@@ -0,0 +1,7 @@
+pkg
+doc
+tmp
+.DS_Store
+.yardoc
+*.swp
+*~

data/.specopts

@@ -0,0 +1 @@
+--colour --format specdoc

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'OpenNamespace Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,10 @@
+### 0.2.0 / 2010-04-13
+
+* Renamed the open-namespace gem to open_namespace, for naming consistency.
+
+### 0.1.0 / 2010-02-11
+
+* Require extlib >= 0.9.14.
+* Provides implicit loading of constants via `const_missing`.
+* Provides explicit loading of constants via `require_const`.
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+
+Copyright (c) 2010 Hal Brodigan
+
+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.md

@@ -0,0 +1,69 @@
+# OpenNamespace
+
+* [github.com/postmodern/open_namespace](http://github.com/postmodern/open_namespace)
+* [github.com/postmodern/open_namespace/issues](http://github.com/postmodern/open_namespace/issues)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+OpenNamespace allows namespaces to require and find classes and modules from
+RubyGems. Using OpenNamespace you can make a `Plugins` module able to
+load plugin modules/classes from other gems.
+
+## Features
+
+* Provides implicit loading of constants via `const_missing`.
+* Provides explicit loading of constants via `require_const`.
+
+## Examples
+
+Explicit and implicit loading of constants:
+
+    require 'open_namespace'
+
+    module Project
+      module Plugins
+        include OpenNamespace
+      end
+    end
+
+    # explicit loading of constants
+    Project::Plguins.require_const :foo_bar
+    # => Project::Plugins::FooBar
+
+    # explicitly loading constants via sub-paths
+    Project::Plguins.require_const 'templates/erb'
+    # => Project::Plugins::Templates::Erb
+
+    # implicit loading of constants via const_missing
+    Project::Plugins::Other
+    # => Project::Plugins::Other
+
+Loading constants from alternate namespaces / directories:
+
+    module Project
+      module UI
+        module CommandLine
+          include OpenNamespace
+
+          self.namespace = 'Project::UI::CommandLine::Commands'
+          self.namespace_root = File.join('project','ui','command_line','commands')
+        end
+      end
+    end
+
+    Project::UI::CommandLine.require_const :help
+    # => Project::UI::CommandLine::Commands::Help
+
+## Requirements
+
+* [extlib](http://gemcutter.org/gems/extlib) >= 0.9.14
+
+## Install
+
+    $ sudo gem install open_namespace
+
+## License
+
+See {file:LICENSE.txt} for license information.
+

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'rake'
+require './lib/open_namespace/version.rb'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'open_namespace'
+    gem.version = OpenNamespace::VERSION
+    gem.license = 'MIT'
+    gem.summary = %Q{Allows namespaces to load constants on-demand}
+    gem.description = %Q{OpenNamespace allows namespaces to require and find classes and modules from other RubyGems.}
+    gem.email = 'postmodern.mod3@gmail.com'
+    gem.homepage = 'http://github.com/postmodern/open-namespace'
+    gem.authors = ['Postmodern']
+    gem.add_dependency 'extlib', '>= 0.9.14'
+    gem.add_development_dependency 'rspec', '>= 1.2.9'
+    gem.add_development_dependency 'yard', '>= 0.5.3'
+    gem.has_rdoc = 'yard'
+  end
+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']
+  spec.spec_opts = ['--options', '.specopts']
+end
+
+task :spec => :check_dependencies
+task :default => :spec
+
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yard, you must: gem install yard"
+  end
+end

data/lib/open_namespace.rb

@@ -0,0 +1,2 @@
+require 'open_namespace/open_namespace'
+require 'open_namespace/version'

data/lib/open_namespace/class_methods.rb

@@ -0,0 +1,116 @@
+require 'extlib'
+
+module OpenNamespace
+  module ClassMethods
+    #
+    # The namespace to search within.
+    #
+    # @return [String]
+    #   The namespace to search for constants within.
+    #
+    def namespace
+      @namespace ||= self.name
+    end
+
+    #
+    # Sets the namespace to search within.
+    #
+    # @param [Module, Class, String] new_namespace
+    #   The new namespace to search within.
+    #
+    # @return [String]
+    #   The namespace to search within.
+    #
+    def namespace=(new_namespace)
+      case new_namespace
+      when Module, Class
+        @namespace = new_namespace.name
+      else
+        @namespace = new_namespace.to_s
+      end
+    end
+
+    #
+    # The file path that represents the namespace.
+    #
+    # @return [String]
+    #   The file path used to load constants into the namespace.
+    #
+    def namespace_root
+      @namespace_root ||= self.name.to_const_path
+    end
+
+    #
+    # Sets the file path of the namespace.
+    #
+    # @param [String] new_path
+    #   The new path of the namespace.
+    #
+    # @return [String]
+    #   The file path used to load constants into the namespace.
+    #
+    def namespace_root=(new_path)
+      @namespace_root = new_path.to_s
+    end
+
+    #
+    # Requires the file and finds the newly defined constant.
+    #
+    # @param [String, Symbol] name
+    #   The name or sub-path of the file.
+    #
+    # @return [Class, Module, nil]
+    #   The constant loaded from the file. If +nil+ is returned, then either
+    #   the file could not be loaded or the required constant could not be
+    #   found.
+    #
+    # @example Loading a constant.
+    #   require_const :helper
+    #   # => Fully::Qualiffied::Namespace::Helper
+    #
+    # @example Loading a constant from a sub-path.
+    #   require_const 'network/helper'
+    #   # => Fully::Qualified::Namespace::Network::Helper
+    #
+    def require_const(name)
+      name = name.to_s
+      path = File.join(namespace_root,File.expand_path(File.join('',name)))
+
+      begin
+        require path
+      rescue Gem::LoadError
+        raise(e)
+      rescue ::LoadError
+        return nil
+      end
+
+      const_name = (self.namespace + '::' + name.to_const_string)
+
+      begin
+        return Object.full_const_get(const_name)
+      rescue NameError
+        return nil
+      end
+    end
+
+    protected
+
+    #
+    # Provides transparent access to require_const.
+    #
+    # @param [Symbol] name
+    #   The name of the constant to load.
+    #
+    # @return [Class, Module]
+    #   The loaded constant.
+    #
+    # @raise [NameError]
+    #   Could not load or find the required constant.
+    #
+    # @see require_const.
+    #
+    def const_missing(name)
+      require_const(name.to_s.to_const_path) || super(name)
+    end
+  end
+end

data/lib/open_namespace/open_namespace.rb

@@ -0,0 +1,7 @@
+require 'open_namespace/class_methods'
+
+module OpenNamespace
+  def self.included(base)
+    base.extend ClassMethods
+  end
+end

data/lib/open_namespace/version.rb

@@ -0,0 +1,4 @@
+module OpenNamespace
+  # open_namespace version
+  VERSION = '0.2.0'
+end

data/open_namespace.gemspec

@@ -0,0 +1,87 @@
+# 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{open_namespace}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Postmodern"]
+  s.date = %q{2010-04-13}
+  s.description = %q{OpenNamespace allows namespaces to require and find classes and modules from other RubyGems.}
+  s.email = %q{postmodern.mod3@gmail.com}
+  s.extra_rdoc_files = [
+    "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     ".specopts",
+     ".yardopts",
+     "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md",
+     "Rakefile",
+     "lib/open_namespace.rb",
+     "lib/open_namespace/class_methods.rb",
+     "lib/open_namespace/open_namespace.rb",
+     "lib/open_namespace/version.rb",
+     "open_namespace.gemspec",
+     "spec/classes/custom/bad_constant.rb",
+     "spec/classes/custom/constant_one.rb",
+     "spec/classes/custom/constant_two.rb",
+     "spec/classes/custom/sub/constant_four.rb",
+     "spec/classes/custom_namespace.rb",
+     "spec/classes/simple_namespace.rb",
+     "spec/classes/simple_namespace/bad_constant.rb",
+     "spec/classes/simple_namespace/constant_one.rb",
+     "spec/classes/simple_namespace/constant_two.rb",
+     "spec/classes/simple_namespace/sub/constant_four.rb",
+     "spec/open_namespace_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = %q{yard}
+  s.homepage = %q{http://github.com/postmodern/open-namespace}
+  s.licenses = ["MIT"]
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Allows namespaces to load constants on-demand}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/open_namespace_spec.rb",
+     "spec/classes/custom_namespace.rb",
+     "spec/classes/custom/constant_two.rb",
+     "spec/classes/custom/constant_one.rb",
+     "spec/classes/custom/bad_constant.rb",
+     "spec/classes/custom/sub/constant_four.rb",
+     "spec/classes/simple_namespace.rb",
+     "spec/classes/simple_namespace/constant_two.rb",
+     "spec/classes/simple_namespace/constant_one.rb",
+     "spec/classes/simple_namespace/bad_constant.rb",
+     "spec/classes/simple_namespace/sub/constant_four.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<extlib>, [">= 0.9.14"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0.5.3"])
+    else
+      s.add_dependency(%q<extlib>, [">= 0.9.14"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0.5.3"])
+    end
+  else
+    s.add_dependency(%q<extlib>, [">= 0.9.14"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0.5.3"])
+  end
+end
+

data/spec/classes/custom/bad_constant.rb

@@ -0,0 +1,8 @@
+module Classes
+  module CusstomNamespace
+    module Custom
+      class ConstantThree
+      end
+    end
+  end
+end

data/spec/classes/custom/constant_one.rb

@@ -0,0 +1,8 @@
+module Classes
+  module CustomNamespace
+    module Custom
+      class ConstantOne
+      end
+    end
+  end
+end

data/spec/classes/custom/constant_two.rb

@@ -0,0 +1,8 @@
+module Classes
+  module CustomNamespace
+    module Custom
+      class ConstantTwo
+      end
+    end
+  end
+end

data/spec/classes/custom/sub/constant_four.rb

@@ -0,0 +1,10 @@
+module Classes
+  module CustomNamespace
+    module Custom
+      module Sub
+        class ConstantFour
+        end
+      end
+    end
+  end
+end

data/spec/classes/custom_namespace.rb

@@ -0,0 +1,10 @@
+require 'open_namespace'
+
+module Classes
+  module CustomNamespace
+    include OpenNamespace
+
+    self.namespace = 'Classes::CustomNamespace::Custom'
+    self.namespace_root = File.join('classes','custom')
+  end
+end

data/spec/classes/simple_namespace.rb

@@ -0,0 +1,7 @@
+require 'open_namespace'
+
+module Classes
+  module SimpleNamespace
+    include OpenNamespace
+  end
+end

data/spec/classes/simple_namespace/bad_constant.rb

@@ -0,0 +1,6 @@
+module Classes
+  module SimpleNamespace
+    class ConstantThree
+    end
+  end
+end

data/spec/classes/simple_namespace/constant_one.rb

@@ -0,0 +1,6 @@
+module Classes
+  module SimpleNamespace
+    class ConstantOne
+    end
+  end
+end

data/spec/classes/simple_namespace/constant_two.rb

@@ -0,0 +1,6 @@
+module Classes
+  module SimpleNamespace
+    class ConstantTwo
+    end
+  end
+end

data/spec/classes/simple_namespace/sub/constant_four.rb

@@ -0,0 +1,8 @@
+module Classes
+  module SimpleNamespace
+    module Sub
+      class ConstantFour
+      end
+    end
+  end
+end

data/spec/open_namespace_spec.rb

@@ -0,0 +1,153 @@
+require 'open_namespace/version'
+
+require 'spec_helper'
+require 'classes/simple_namespace'
+require 'classes/custom_namespace'
+
+describe OpenNamespace do
+  it "should have a VERSION constant" do
+    OpenNamespace.const_defined?('VERSION').should == true
+  end
+
+  describe "default namespace" do
+    before(:all) do
+      @module = Classes::SimpleNamespace
+    end
+
+    it "should have the same namespace as the module name" do
+      @module.namespace.should == 'Classes::SimpleNamespace'
+    end
+
+    it "should have the same namespace root as the module's directory" do
+      @module.namespace_root.should == File.join('classes','simple_namespace')
+    end
+
+    it "should load constants into the namespace" do
+      @module.require_const :constant_one
+
+      @module.should be_const_defined('ConstantOne')
+    end
+
+    it "should find loaded constants in the namespace" do
+      const = @module.require_const(:constant_one)
+
+      const.class.should == Class
+      const.name.should == 'Classes::SimpleNamespace::ConstantOne'
+    end
+
+    it "should load constants via sub-paths" do
+      @module.require_const File.join('sub','constant_four')
+
+      @module.should be_const_defined('Sub')
+      @sub = @module.const_get('Sub')
+
+      @sub.should be_const_defined('ConstantFour')
+    end
+
+    it "should find constants loaded via sub-paths" do
+      const = @module.require_const(File.join('sub','constant_four'))
+
+      const.class.should == Class
+      const.name.should == 'Classes::SimpleNamespace::Sub::ConstantFour'
+    end
+
+    it "should return nil on LoadError exceptions" do
+      const = @module.require_const(:constant_not_found)
+
+      const.should be_nil
+    end
+
+    it "should return nil on NameError exceptions" do
+      const = @module.require_const(:bad_constant)
+
+      const.should be_nil
+    end
+
+    it "should load constants transparently via const_missing" do
+      const = @module::ConstantTwo
+
+      const.class.should == Class
+      const.name.should == 'Classes::SimpleNamespace::ConstantTwo'
+    end
+
+    it "should raise a NameError exception const_missing fails" do
+      lambda {
+        @module::BadConstant
+      }.should raise_error(NameError)
+    end
+  end
+
+  describe "custom namespace" do
+    before(:all) do
+      @module = Classes::CustomNamespace
+    end
+
+    it "should have the same namespace as the module name" do
+      @module.namespace.should == 'Classes::CustomNamespace::Custom'
+    end
+
+    it "should have the same namespace root as the module's directory" do
+      @module.namespace_root.should == File.join('classes','custom')
+    end
+
+    it "should load constants into the namespace" do
+      @module.require_const :constant_one
+
+      @module.should be_const_defined('Custom')
+      @custom = @module.const_get('Custom')
+
+      @custom.should be_const_defined('ConstantOne')
+    end
+
+    it "should find loaded constants in the namespace" do
+      const = @module.require_const(:constant_one)
+
+      const.class.should == Class
+      const.name.should == 'Classes::CustomNamespace::Custom::ConstantOne'
+    end
+
+    it "should load constants via sub-paths" do
+      @module.require_const File.join('sub','constant_four')
+
+      @module.should be_const_defined('Custom')
+      @custom = @module.const_get('Custom')
+
+      @custom.should be_const_defined('Sub')
+      @sub = @custom.const_get('Sub')
+
+      @sub.should be_const_defined('ConstantFour')
+    end
+
+    it "should find constants loaded via sub-paths" do
+      const = @module.require_const(File.join('sub','constant_four'))
+
+      const.class.should == Class
+      const.name.should == 'Classes::CustomNamespace::Custom::Sub::ConstantFour'
+    end
+
+    it "should return nil on LoadError exceptions" do
+      const = @module.require_const(:constant_not_found)
+
+      const.should be_nil
+    end
+
+    it "should return nil on NameError exceptions" do
+      const = @module.require_const(:bad_constant)
+
+      const.should be_nil
+    end
+
+    it "should load constants transparently via const_missing" do
+      const = @module::ConstantTwo
+
+      const.class.should == Class
+      const.name.should == 'Classes::CustomNamespace::Custom::ConstantTwo'
+    end
+
+    it "should raise a NameError exception const_missing fails" do
+      lambda {
+        @module::BadConstant
+      }.should raise_error(NameError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+gem 'rspec', '>=1.2.9'
+require 'spec'
+
+require 'open_namespace/version'
+
+include OpenNamespace

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification 
+name: open_namespace
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: extlib
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 14
+        version: 0.9.14
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :development
+  version_requirements: *id003
+description: OpenNamespace allows namespaces to require and find classes and modules from other RubyGems.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files: 
+- .gitignore
+- .specopts
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/open_namespace.rb
+- lib/open_namespace/class_methods.rb
+- lib/open_namespace/open_namespace.rb
+- lib/open_namespace/version.rb
+- open_namespace.gemspec
+- spec/classes/custom/bad_constant.rb
+- spec/classes/custom/constant_one.rb
+- spec/classes/custom/constant_two.rb
+- spec/classes/custom/sub/constant_four.rb
+- spec/classes/custom_namespace.rb
+- spec/classes/simple_namespace.rb
+- spec/classes/simple_namespace/bad_constant.rb
+- spec/classes/simple_namespace/constant_one.rb
+- spec/classes/simple_namespace/constant_two.rb
+- spec/classes/simple_namespace/sub/constant_four.rb
+- spec/open_namespace_spec.rb
+- spec/spec_helper.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/open-namespace
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Allows namespaces to load constants on-demand
+test_files: 
+- spec/spec_helper.rb
+- spec/open_namespace_spec.rb
+- spec/classes/custom_namespace.rb
+- spec/classes/custom/constant_two.rb
+- spec/classes/custom/constant_one.rb
+- spec/classes/custom/bad_constant.rb
+- spec/classes/custom/sub/constant_four.rb
+- spec/classes/simple_namespace.rb
+- spec/classes/simple_namespace/constant_two.rb
+- spec/classes/simple_namespace/constant_one.rb
+- spec/classes/simple_namespace/bad_constant.rb
+- spec/classes/simple_namespace/sub/constant_four.rb