const_lookup 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1458ea9888b8c803ec0caa1f836100e7804b5b3c
+  data.tar.gz: 7ed3c09d749f078e480289026678abb74e684038
+SHA512:
+  metadata.gz: 668cb854b6887322fc9da2175f428451b4dcdb42e20b13013a813bd57bba237531e1057c41dc24c33db5f540b1eb468d3f5be097ece4d781d4c8b663b585a010
+  data.tar.gz: eacb2acf1eaf9c967cfca7c02f3e0d7da7615fe4802f324349e5bf5a85c3f755dede4d0cde85b4b5a0718d702dcdeaeef03e0d753a8e0571ff58860f62178887

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in const_lookup.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Marshall <http://johnandrewmarshall.com>
+
+MIT License
+
+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,40 @@
+# ConstLookup
+
+[![Build Status](https://secure.travis-ci.org/amarshall/const_lookup.png?branch=master)](http://travis-ci.org/amarshall/const_lookup)
+
+Makes resolving a constant in a given namespace easy.
+
+## Installation
+
+Install as usual: `gem install const_lookup` or add `gem 'const_lookup'` to your Gemfile. Note that Ruby 2.0 is required.
+
+## Usage
+
+```ruby
+module A
+  module B; end
+  module C; end
+end
+module D; end
+
+require 'const_lookup'
+
+ConstLookup.lookup('A', A::C)  #=> A
+ConstLookup.lookup('B', A::C)  #=> A::B
+ConstLookup.lookup('D', A::C)  #=> D
+ConstLookup.lookup('E', A::C)  #=> #<NameError: Failed to find `E' in A::C>
+```
+
+## Contributing
+
+Contributions are welcome. Please be sure that your pull requests are atomic so they can be considered and accepted separately.
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits & License
+
+Copyright © 2013 J. Andrew Marshall. License is available in the LICENSE file.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = '-w' unless ENV['TRAVIS']
+end
+
+task :default => :spec

data/const_lookup.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'const_lookup/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'const_lookup'
+  spec.version       = ConstLookup::VERSION
+  spec.authors       = ["Andrew Marshall"]
+  spec.email         = ["andrew@johnandrewmarshall.com"]
+  spec.description   = %q{Makes resolving a constant in a given namespace easy.}
+  spec.summary       = %q{Makes resolving a constant in a given namespace easy.}
+  spec.homepage      = 'http://johnandrewmarshall.com/projects/const_lookup'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/const_lookup.rb

@@ -0,0 +1,33 @@
+require 'const_lookup/version'
+
+class ConstLookup
+  def self.lookup name, namespace = nil
+    new(*namespace).lookup(name)
+  end
+
+  def initialize namespace = Object
+    @namespace = namespace.to_s
+  end
+
+  def lookup name
+    name = name.to_sym
+    constant = lookup_path.select do |namespace|
+      namespace.const_defined? name
+    end.map do |namespace|
+      namespace.const_get name
+    end.sort_by do |constant|
+      -constant.to_s.split('::').size
+    end.first
+    constant or raise NameError, "Failed to find `#{name}' in #@namespace"
+  end
+
+  def lookup_path
+    @namespace.split('::').reduce([]) do |lookup_path, part|
+      lookup_path << [*lookup_path.last, part]
+    end.map do |parts|
+      parts.join '::'
+    end.map do |constant_name|
+      Object.const_get constant_name
+    end.reverse
+  end
+end

data/lib/const_lookup/version.rb

@@ -0,0 +1,3 @@
+class ConstLookup
+  VERSION = '0.3.0'
+end

data/spec/const_lookup_spec.rb

@@ -0,0 +1,85 @@
+require 'const_lookup'
+
+describe ConstLookup do
+  describe ".lookup" do
+    it "creates a new finder with the given namespace and calls lookup with the name" do
+      name = double
+      namespace = double
+      finder = double
+      expect(ConstLookup).to receive(:new).with(namespace).and_return finder
+      expect(finder).to receive(:lookup).with(name)
+
+      ConstLookup.lookup name, namespace
+    end
+
+    it "creates the new finder with no args when no namespace given" do
+      name = double
+      finder = double
+      expect(ConstLookup).to receive(:new).with(no_args).and_return finder
+      expect(finder).to receive(:lookup).with(name)
+
+      ConstLookup.lookup name
+    end
+  end
+
+  describe "#lookup" do
+    it "returns the constant when it resides in the most specific namespace" do
+      stub_const('Foo::Bar::Baz', Module.new)
+      stub_const('Foo::Bar::Baz::ToFind', Module.new)
+      constant_finder = ConstLookup.new(Foo::Bar::Baz)
+      expect(constant_finder.lookup(:ToFind)).to eq Foo::Bar::Baz::ToFind
+    end
+
+    it "returns the constant when it's a sibling" do
+      stub_const('Foo::Bar::ToFind', Module.new)
+      stub_const('Foo::Bar::Baz', Module.new)
+      constant_finder = ConstLookup.new(Foo::Bar::Baz)
+      expect(constant_finder.lookup(:ToFind)).to eq Foo::Bar::ToFind
+    end
+
+    it "returns the constant when it resides in an intermediate namespace" do
+      stub_const('Foo::ToFind', Module.new)
+      stub_const('Foo::Bar::Baz', Module.new)
+      constant_finder = ConstLookup.new(Foo::Bar::Baz)
+      expect(constant_finder.lookup(:ToFind)).to eq Foo::ToFind
+    end
+
+    it "returns the constant when it resides in global namespace" do
+      stub_const('ToFind', Module.new)
+      stub_const('Foo::Bar::Baz', Module.new)
+      constant_finder = ConstLookup.new(Foo::Bar::Baz)
+      expect(constant_finder.lookup(:ToFind)).to eq ToFind
+    end
+
+    it "returns the constant in the most specific namespace when it exists in multiple parts of the lookup path" do
+      stub_const('ToFind', Module.new)
+      stub_const('Foo::ToFind', Module.new)
+      stub_const('Foo::Bar::ToFind', Module.new)
+      stub_const('Foo::Bar::Baz', Module.new)
+      constant_finder = ConstLookup.new(Foo::Bar::Baz)
+      expect(constant_finder.lookup(:ToFind)).to eq Foo::Bar::ToFind
+    end
+
+    it "raises a NameError when the constant does not exist" do
+      stub_const('Other::ToFind', Module.new)
+      stub_const('Foo::Bar::Baz', Module.new)
+      constant_finder = ConstLookup.new(Foo::Bar::Baz)
+      expect do
+        constant_finder.lookup(:ToFind)
+      end.to raise_error NameError, %q(Failed to find `ToFind' in Foo::Bar::Baz)
+    end
+  end
+
+  describe "#lookup_path" do
+    it "is just Object when no namespace is given" do
+      constant_finder = ConstLookup.new
+      expect(constant_finder.lookup_path).to eq [Object]
+    end
+
+    it "is a list of each constant in the namespace in ascending order" do
+      stub_const('Foo::Bar::Baz', Module.new)
+      constant_finder = ConstLookup.new(Foo::Bar::Baz)
+      expect(constant_finder.lookup_path).to eq [Foo::Bar::Baz, Foo::Bar, Foo]
+    end
+  end
+end

data/spec/readme_spec.rb

@@ -0,0 +1,25 @@
+require 'const_lookup'
+
+describe "README examples" do
+  describe "example 1" do
+    before do
+      module A
+        module B; end
+        module C; end
+      end
+      module D; end
+    end
+
+    after do
+      Object.send :remove_const, :A
+      Object.send :remove_const, :D
+    end
+
+    it "works" do
+      expect(ConstLookup.lookup('A', A::C)).to eq A
+      expect(ConstLookup.lookup('B', A::C)).to eq A::B
+      expect(ConstLookup.lookup('D', A::C)).to eq D
+      expect{ConstLookup.lookup('E', A::C)}.to raise_error NameError, %q(Failed to find `E' in A::C)
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: const_lookup
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Andrew Marshall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes resolving a constant in a given namespace easy.
+email:
+- andrew@johnandrewmarshall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- const_lookup.gemspec
+- lib/const_lookup.rb
+- lib/const_lookup/version.rb
+- spec/const_lookup_spec.rb
+- spec/readme_spec.rb
+homepage: http://johnandrewmarshall.com/projects/const_lookup
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.5
+signing_key: 
+specification_version: 4
+summary: Makes resolving a constant in a given namespace easy.
+test_files:
+- spec/const_lookup_spec.rb
+- spec/readme_spec.rb
+has_rdoc: