open_namespace 0.2.0 → 0.3.0

data/ChangeLog.md

@@ -1,3 +1,16 @@
+### 0.3.0 / 2010-04-28
+
+* Added {OpenNamespace.constant_path}.
+* Added {OpenNamespace::ClassMethods#require_file}.
+* Added {OpenNamespace::ClassMethods#const_search}.
+* Improved searching for constants with oddly capitalized names, such as
+  `SQL` or `RemoteTCP`.
+* Ensure that {OpenNamespace::ClassMethods#const_missing} only returns the
+  constant with the requested name.
+* Removed `OpenNamespace::ClassMethods#namespace`.
+* Removed `OpenNamespace::ClassMethods#namespace=`.
+* Removed the dependency on extlib.
+
 ### 0.2.0 / 2010-04-13
 
 * Renamed the open-namespace gem to open_namespace, for naming consistency.

data/README.md

@@ -27,38 +27,39 @@ Explicit and implicit loading of constants:
       end
     end
 
-    # explicit loading of constants
+    # explicitly load constants
     Project::Plguins.require_const :foo_bar
     # => Project::Plugins::FooBar
 
-    # explicitly loading constants via sub-paths
+    # explicitly load constants with odd capitalization
+    Project::Plugins.require_const :tcp_session
+    # => Project::Plugins::TCPSession
+
+    # explicitly load constants via sub-paths
     Project::Plguins.require_const 'templates/erb'
     # => Project::Plugins::Templates::Erb
 
-    # implicit loading of constants via const_missing
+    # implicitly load constants via const_missing
     Project::Plugins::Other
     # => Project::Plugins::Other
 
-Loading constants from alternate namespaces / directories:
+Loading constants from alternate namespace root directories:
 
     module Project
       module UI
         module CommandLine
-          include OpenNamespace
+          module Commands
+            include OpenNamespace
 
-          self.namespace = 'Project::UI::CommandLine::Commands'
-          self.namespace_root = File.join('project','ui','command_line','commands')
+            self.namespace_root = File.join('project','ui','command_line','commands')
+          end
         end
       end
     end
 
-    Project::UI::CommandLine.require_const :help
+    Project::UI::CommandLine::Commands.require_const :help
     # => Project::UI::CommandLine::Commands::Help
 
-## Requirements
-
-* [extlib](http://gemcutter.org/gems/extlib) >= 0.9.14
-
 ## Install
 
     $ sudo gem install open_namespace

data/Rakefile

@@ -13,11 +13,11 @@ begin
     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
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end

data/lib/open_namespace/class_methods.rb

@@ -1,35 +1,5 @@
-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.
     #
@@ -37,7 +7,7 @@ module OpenNamespace
     #   The file path used to load constants into the namespace.
     #
     def namespace_root
-      @namespace_root ||= self.name.to_const_path
+      @namespace_root ||= OpenNamespace.constant_path(self.name)
     end
 
     #
@@ -73,6 +43,28 @@ module OpenNamespace
     #   # => Fully::Qualified::Namespace::Network::Helper
     #
     def require_const(name)
+      require_file(name)
+
+      return const_search(name)
+    end
+
+    #
+    # Requires the file with the given name, within the namespace root
+    # directory.
+    #
+    # @param [Symbol, String] name
+    #   The name of the file to require.
+    #
+    # @return [true, nil]
+    #   Returns `true` if the file was successfully loaded, returns `nil`
+    #   on a `LoadError` exception.
+    #
+    # @raise [Gem::LoadError]
+    #   A dependency needed by the file could not be satisfied by RubyGems.
+    #
+    # @since 0.3.0
+    #
+    def require_file(name)
       name = name.to_s
       path = File.join(namespace_root,File.expand_path(File.join('',name)))
 
@@ -84,13 +76,44 @@ module OpenNamespace
         return nil
       end
 
-      const_name = (self.namespace + '::' + name.to_const_string)
+      return true
+    end
 
-      begin
-        return Object.full_const_get(const_name)
-      rescue NameError
-        return nil
+    #
+    # Finds the constant with a name similar to the given file name.
+    #
+    # @param [Symbol, String] file_name
+    #   The file name that represents the constant.
+    #
+    # @return [Object, nil]
+    #   Returns the found constants, or `nil` if a `NameError` exception
+    #   was encountered.
+    #
+    # @since 0.3.0
+    #
+    def const_search(file_name)
+      names = file_name.to_s.split(/[:\/]+/)
+      scope = self
+
+      until names.empty?
+        name = names.shift
+
+        # strip any dashes or underscores
+        name.tr!('_-','')
+
+        # perform a case insensitive search
+        const_pattern = /^#{name}$/i
+
+        # grep for the constant
+        const_name = scope.constants.find { |name| name =~ const_pattern }
+
+        # the constant search failed
+        return nil unless const_name
+
+        scope = scope.const_get(const_name)
       end
+
+      return scope
     end
 
     protected
@@ -110,7 +133,21 @@ module OpenNamespace
     # @see require_const.
     #
     def const_missing(name)
-      require_const(name.to_s.to_const_path) || super(name)
+      file_name = OpenNamespace.constant_path(name)
+
+      if require_file(file_name)
+        #
+        # If const_missing is being called, the constant is not present yet.
+        # Therefor, only check for the constant if the file was
+        # successfully loaded by require_file.
+        #
+        if self.const_defined?(name)
+          # get the exact constant name that was requested
+          return self.const_get(name)
+        end
+      end
+      
+      return super(name)
     end
   end
 end

data/lib/open_namespace/open_namespace.rb

@@ -4,4 +4,31 @@ module OpenNamespace
   def self.included(base)
     base.extend ClassMethods
   end
+
+  #
+  # Maps a constant name to a likely file path.
+  #
+  # @param [String, Symbol] name
+  #   The constant name.
+  #
+  # @return [String]
+  #   The file path that the constant is likely to be defined within.
+  #
+  # @since 0.3.0
+  #
+  def OpenNamespace.constant_path(name)
+    path = name.to_s
+
+    # back-ported from extlib's String#to_const_path
+    path.gsub!(/::/,'/')
+
+    # back-ported from extlib's String#snake_case
+    unless path.match(/\A[A-Z]+\z/)
+      path.gsub!(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      path.gsub!(/([a-z])([A-Z])/, '\1_\2')
+    end
+    path.downcase!
+
+    return path
+  end
 end

data/lib/open_namespace/version.rb

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

data/open_namespace.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{open_namespace}
-  s.version = "0.2.0"
+  s.version = "0.3.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.date = %q{2010-04-28}
   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 = [
@@ -33,12 +33,14 @@ Gem::Specification.new do |s|
      "spec/classes/custom/bad_constant.rb",
      "spec/classes/custom/constant_one.rb",
      "spec/classes/custom/constant_two.rb",
+     "spec/classes/custom/odd_constant.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/odd_constant.rb",
      "spec/classes/simple_namespace/sub/constant_four.rb",
      "spec/open_namespace_spec.rb",
      "spec/spec_helper.rb"
@@ -58,11 +60,13 @@ Gem::Specification.new do |s|
      "spec/classes/custom/constant_one.rb",
      "spec/classes/custom/bad_constant.rb",
      "spec/classes/custom/sub/constant_four.rb",
+     "spec/classes/custom/odd_constant.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"
+     "spec/classes/simple_namespace/sub/constant_four.rb",
+     "spec/classes/simple_namespace/odd_constant.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -70,16 +74,13 @@ Gem::Specification.new do |s|
     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

data/spec/classes/custom/bad_constant.rb

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

data/spec/classes/custom/constant_one.rb

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

data/spec/classes/custom/constant_two.rb

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

data/spec/classes/custom/odd_constant.rb

@@ -0,0 +1,6 @@
+module Classes
+  module CustomNamespace
+    class ODDConstant
+    end
+  end
+end

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

@@ -1,9 +1,7 @@
 module Classes
   module CustomNamespace
-    module Custom
-      module Sub
-        class ConstantFour
-        end
+    module Sub
+      class ConstantFour
       end
     end
   end

data/spec/classes/custom_namespace.rb

@@ -4,7 +4,6 @@ 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/odd_constant.rb

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

data/spec/open_namespace_spec.rb

@@ -9,15 +9,11 @@ describe OpenNamespace do
     OpenNamespace.const_defined?('VERSION').should == true
   end
 
-  describe "default namespace" do
+  context "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
@@ -35,6 +31,13 @@ describe OpenNamespace do
       const.name.should == 'Classes::SimpleNamespace::ConstantOne'
     end
 
+    it "should find constants with odd capitalization" do
+      const = @module.require_const(:odd_constant)
+
+      const.class.should == Class
+      const.name.should == 'Classes::SimpleNamespace::ODDConstant'
+    end
+
     it "should load constants via sub-paths" do
       @module.require_const File.join('sub','constant_four')
 
@@ -77,43 +80,39 @@ describe OpenNamespace do
     end
   end
 
-  describe "custom namespace" do
+  context "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')
+      @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::CustomNamespace::Custom::ConstantOne'
+      const.name.should == 'Classes::CustomNamespace::ConstantOne'
+    end
+
+    it "should find constants with odd capitalization" do
+      const = @module.require_const(:odd_constant)
+
+      const.class.should == Class
+      const.name.should == 'Classes::CustomNamespace::ODDConstant'
     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')
+      @module.should be_const_defined('Sub')
+      @sub = @module.const_get('Sub')
 
       @sub.should be_const_defined('ConstantFour')
     end
@@ -122,7 +121,7 @@ describe OpenNamespace do
       const = @module.require_const(File.join('sub','constant_four'))
 
       const.class.should == Class
-      const.name.should == 'Classes::CustomNamespace::Custom::Sub::ConstantFour'
+      const.name.should == 'Classes::CustomNamespace::Sub::ConstantFour'
     end
 
     it "should return nil on LoadError exceptions" do
@@ -141,7 +140,7 @@ describe OpenNamespace do
       const = @module::ConstantTwo
 
       const.class.should == Class
-      const.name.should == 'Classes::CustomNamespace::Custom::ConstantTwo'
+      const.name.should == 'Classes::CustomNamespace::ConstantTwo'
     end
 
     it "should raise a NameError exception const_missing fails" do

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Postmodern
@@ -14,27 +14,13 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-13 00:00:00 -07:00
+date: 2010-04-28 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 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -44,11 +30,11 @@ dependencies:
         - 9
         version: 1.2.9
   type: :development
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: yard
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
@@ -58,7 +44,7 @@ dependencies:
         - 3
         version: 0.5.3
   type: :development
-  version_requirements: *id003
+  version_requirements: *id002
 description: OpenNamespace allows namespaces to require and find classes and modules from other RubyGems.
 email: postmodern.mod3@gmail.com
 executables: []
@@ -85,12 +71,14 @@ files:
 - spec/classes/custom/bad_constant.rb
 - spec/classes/custom/constant_one.rb
 - spec/classes/custom/constant_two.rb
+- spec/classes/custom/odd_constant.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/odd_constant.rb
 - spec/classes/simple_namespace/sub/constant_four.rb
 - spec/open_namespace_spec.rb
 - spec/spec_helper.rb
@@ -132,8 +120,10 @@ test_files:
 - spec/classes/custom/constant_one.rb
 - spec/classes/custom/bad_constant.rb
 - spec/classes/custom/sub/constant_four.rb
+- spec/classes/custom/odd_constant.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
+- spec/classes/simple_namespace/odd_constant.rb