loadable 1.2.0 → 1.2.1

data/LICENSE.txt

@@ -0,0 +1,22 @@
+BSD-2-Clause License
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -1,28 +1,32 @@
-# Loadable
+[Website](http://github.com/rubyworks/loadable) /
+[Report Issue](http://github.com/rubyworks/loadable/issues) /
+[Source Code](http://github.com/rubyworks/loadable)
+( [![Build Status](https://secure.travis-ci.org/rubyworks/loadable.png)](http://travis-ci.org/rubyworks/loadable) )
 
-## 1 Overview
+# Loadable
 
-| Project      | Loadable                                                 |
-|--------------|----------------------------------------------------------|
-| Author       | Thomas Sawyer                                            |
-| License      | BSD-2-Clause                                             |
-| Copyright    | (c) 2010 Thomas Sawyer                                   |
-| Website      | http://github.com/rubyworks/loadable                     |
-| Development  | http://github.com/rubyworks/loadable                     |
-| Mailing-List | http://groups.google.com/group/rubyworks-mailinglist     |
+*Safely Customize Ruby's Load System*
 
+<br/>
 
-## 2 Description
+## 1 Description
 
-The Loadable gem provides a more robust and convenient means of augmenting
+The Loadable gem provides a robust and convenient means of augmenting
 Ruby's load system, namely the `load` and `require` methods. Rather than
-alias and override these methods, Loadable keeps a list of *load wedges*
-that control the routing of require and load calls.
+alias and override these methods, Loadable keeps a list of load hooks
+(also called *load wedges*) that control the routing of require and load calls.
 
-In addition, the Loadable gem includes two pre-made load wedges that can be
+In addition, the Loadable gem includes two pre-made load hooks that can be
 used to prevent name clashes between Ruby's standard library and gem packages
-(see INFRACTIONS.rdoc for more on this). There is also a load wedge for
-for developers to make it trivial to make vendored sub-projects loadable.
+(see INFRACTIONS.md for more on this). There is also a load hook for
+developers to make vendored sub-projects loadable.
+
+
+## 2 Features
+
+* Safely augment Ruby's load system.
+* Prevent library name clashes.
+* Search load locations.
 
 
 ## 3 Usage
@@ -31,14 +35,17 @@ for developers to make it trivial to make vendored sub-projects loadable.
 
 Installing via RubyGems follows the usual pattern.
 
-    $ gem install loadable
+    gem install loadable
 
-To automatically load both the Gem and Ruby wedges, and the entire Loadable
+To automatically load both the Gem and Ruby hooks, and the entire Loadable
 system, add `loadable` to your RUBYOPT environment variable.
 
-    $ export RUBYOPT="-rloadable"
+    export RUBYOPT="-rloadable"
+
+Place this in your shell's configuration file, such as `~/.bashrc`. For csh 
+syntax (e.g. in `~/.cshrc`) use:
 
-Place this in your shell's configuration file, such as `~/.bashrc`.
+    setenv RUBYOPT "-rloadable"
 
 If you do not want the default setup you can `require 'loadable/system'` instead.
 This will load in Loadable system, but only add an `OriginalLoader` to the
@@ -48,12 +55,12 @@ This will load in Loadable system, but only add an `OriginalLoader` to the
 
 Loadable was written initially to provide the specific capability of loading
 Ruby standard libraries without potential interference from libraries
-installed via RubyGems (see INFRACTIONS.rdoc). The code ultimately evolved
+installed via RubyGems (see INFRACTIONS.md). The code ultimately evolved
 into a more generic tool, useful for writing any kind of plug-in load
 router. 
 
-The code for the Ruby wedge serves as a good example of writing a load wedge.
-(Note this is leaves out a few details of the real class for simplicity sake.)
+The code for the Ruby hook serves as a good example of writing a load hook.
+(Note this is leaves out a few details of the real class for simplicity's sake.)
 
     require 'rbconfig'
     require 'loadable/mixin'
@@ -89,42 +96,42 @@ domain.
 
 Under the hood, this simply appends the instance to the `$LOADERS` global variable.
 
-Loaders, also called load wedges, are easy to write as their interface is very
-simple. Any object the responds to #call, taking parameters of 
-<code>(fname, options={})</code>, can be used as a load wedge. A load wedge
+Loaders, also called load hooks or wedges, are easy to write as their interface
+is very simple. Any object that responds to #call, taking parameters of 
+<code>(fname, options={})</code>, can be used as a load hook. A load hook
 should also support `#each(options={}, &block)` which is used to iterate over
 all requirable files a loader supports.
 
 The `Loadable` mixin is just a convenience module that makes writing loaders
-a bit easier. Load wedges can be written without it, however the mixin
-provides a few methods that are often useful to any load wedge. An example is
+a bit easier. Load hooks can be written without it, however the mixin
+provides a few methods that are often useful to any load hook. An example is
 the `lookup` method used in the above example, which will search a
 load path in accordance with the Ruby's built-in require and load lookup
-procedures, i.e. automatically trying defualt extensions like `.rb`.
+procedures, i.e. automatically trying default extensions like `.rb`.
 
 You might wonder how the single method, `#call`, handles both load and require
 operations. The secret is in the `options` hash. If <code>options[:load]</code>
 resolves to true, then it is a *load* operation, otherwise it is a *require*
 operation. The `$LOADERS` global variable is iterated over in order.
-When `#load` or `#require` is called each wedge is tried in turn. The return
+When `#load` or `#require` is called each hook is tried in turn. The return
 value of `#call` controls how this loop proceeds. If the return value is `true`
 then the load was successful, and the loop can break. If it is `false` it means
 the loading has already been handled and the loop can also break. But if the
-return value is `nil`, it means the wedge does not apply and the loop should
-continue. If all wedges have been tried and all have returned `nil` then it
-falls back to the original `#load` and `#require` calls, via an instance
+return value is `nil`, it means the hook does not apply and the loop should
+continue. If all hooks have been tried and all have returned `nil` then it
+falls back to the original `#load` and `#require` calls, via an instance of
 `OriginalLoader` which should always be the last loader in the `$LOADERS` list.
 
 
 ## 4 Built-in Loaders
 
-The Loadable gem provides three special loaders out-of-the-box, the `RubyLoader`,
-the `GemLoader` and the `VendorLoader`. The first two are probably not exaclty
+The Loadable gem provides three special loaders out-of-the-box: the `RubyLoader`,
+the `GemLoader` and the `VendorLoader`. The first two are probably not exactly
 what you think they are, going just by their names, so keep reading...
 
 ### 4.1 RubyLoader
 
-The Ruby wedge makes it possible to load a Ruby standard library without
+The Ruby hook makes it possible to load a Ruby standard library without
 interference from installed gems or other package systems. It does this by 
 checking for a `:from` option passed to the require or load methods.
 
@@ -136,7 +143,7 @@ directory without understanding the potential consequences.
 
 ### 4.2 GemLoader
 
-The Gem wedge is similar to the Ruby wedge, in that it isolates the loading
+The Gem hook is similar to the Ruby hook, in that it isolates the loading
 of a gem's files from other gems.
 
     gem 'facets', '~>2.8'
@@ -151,14 +158,14 @@ raise a load error.
 
     require 'string/does_not_exit', :gem=>'facets'
 
-The Gem wedge also supports version constraints, so you do not have to use 
-`gem()` method for one off requires from a given gem.
+The Gem hook also supports version constraints, so you do not have to use 
+`gem()` method for one-off requires from a given gem.
 
     require 'string/margin', :from=>'facets', :version=>'~>2.8'
 
 ### 4.3 VendorLoader
 
-The Vendor wedge is used to add vendored projects to the load system.
+The Vendor hook is used to add vendored projects to the load system.
 This is especially useful for development. Vendored projects can be added
 in two ways, by registering an instance of VendorLoader, e.g.
 
@@ -172,11 +179,11 @@ to make this more convenient.
 
 ## 5 Development
 
-Source code for Loadbable is hosted by [GitHub](http://github.com/rubyworks/loadable).
+Source code for Loadable is hosted by [GitHub](http://github.com/rubyworks/loadable).
 
-If you has come across and issues, we encourage you to fork the repository and 
+If you come across any issues, we encourage you to fork the repository and 
 submit a pull request with the fix. When submitting a pull request, it is best
-if the changes are orgnanized into a new topic branch.
+if the changes are organized into a new topic branch.
 
 If you don't have time to code up patches yourself, please do not hesitate to
 simply report the issue on the [issue tracker](http://github.com/rubyworks/loadable/issues).
@@ -184,9 +191,10 @@ simply report the issue on the [issue tracker](http://github.com/rubyworks/loada
 
 ## 6 Copyrights
 
-Copyright (c) 2010 Thomas Sawyer, Rubyworks
+Loadable if copyrighted open source software.
 
-Load is distributed under the terms of the **FreeBSD** license.
+    Copyright (c) 2010 Rubyworks
 
-See COPYING.rdoc file for details.
+Load is distributed under the terms of the **BSD-2-Clause** license.
 
+See LICENSE.txt file for details.

data/lib/loadable/core_ext/rubygems.rb

@@ -1,12 +1,7 @@
 module Gem
 
-  # TODO: Below are two implementations of the same feature. Currently
-  # we are using `Gem.search` code which calls `Gem::Specification.current_specs`.
-  # Possibly this could be replaced by simply calling `GemPathSearcher.current_files`.
-  # Hoverver, it is unclear to me at this time which is the best course of action.
-
   # Search RubyGems for matching paths in current gem versions.
-  def self.search(fname, options={})
+  def self.search(match, options={})
     return unless defined?(::Gem)
     matches = []
     Gem::Specification.current_specs.each do |spec|
@@ -19,7 +14,7 @@ module Gem
   end
 
   class Specification
-    # Return a list of actives specs, or latest version if not active.
+    # Return a list of active specs or latest version of spec if not active.
     def self.current_specs
       named = Hash.new{|h,k| h[k] = [] }
       each{ |spec| named[spec.name] << spec }
@@ -51,6 +46,10 @@ module Gem
     end
   end
 
+end
+
+
+
 =begin
   class GemPathSearcher
     # Return a list of matching files among active or latest gems.
@@ -78,4 +77,3 @@ module Gem
   end
 =end
 
-end

data/lib/loadable/domain.rb

@@ -19,7 +19,7 @@ module Loadable
 
   # Iterate over all requirable files.
   #
-  #   LoadSystem.each{ |file| p file }
+  #   Loadable.each{ |file| p file }
   #
   # Note that esoteric load wedges may return a symbolic path rather than
   # an actual file path.
@@ -32,7 +32,7 @@ module Loadable
 
   # Search wedges for all matching paths.
   #
-  #   LoadSystem.search('detroit-*.rb')
+  #   Loadable.search('detroit-*.rb')
   #
   # Note that "esoteric" wedges might return a symbolic identifier rather
   # than an actual file path.

data/lib/loadable/loaders/gem_loader.rb

@@ -13,7 +13,7 @@ module Loadable
   #   require 'tracepoint', :from=>'tracepoint'
   #
   # The example would load the tracepoint file from the tracepoint gem.
-  # It will also fallback to the RubyWedge if 'tracepoint' is not found
+  # It will also fallback to the RubyLoader if 'tracepoint' is not found
   # among available gems. Loading can be limited to gems only by using
   # the `:gem` options instead.
   #
@@ -80,7 +80,7 @@ module Loadable
       end
     end
 
-    # Determine if this load4 wedge is applicable given the +fname+
+    # Determine if this load wedge is applicable given the +fname+
     # and +options+.
     #
     def apply?(fname, options={})

data/spec/runner.rb

@@ -0,0 +1,5 @@
+# Load all specs.
+Dir['./spec/*_spec.rb'].each do |spec|
+  require spec
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: loadable
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-17 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detroit
-  requirement: &21512620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21512620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &21517660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21517660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitap
-  requirement: &21751300 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21751300
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21755040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +69,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21755040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Loadable modifieds Ruby's load/require system to handle "load wedges",
   which work much like routes in web frameworks, but in this case determine which
   files get loaded.
@@ -63,11 +83,12 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- HISTORY.rdoc
-- COPYING.rdoc
-- INFRACTIONS.rdoc
+- LICENSE.txt
+- HISTORY.md
 - README.md
+- INFRACTIONS.md
 files:
+- .index
 - .yardopts
 - .ruby
 - lib/loadable/class_require.rb
@@ -87,16 +108,18 @@ files:
 - spec/fixture/ansi.rb
 - spec/fixture/subpro/.ruby
 - spec/fixture/subpro/lib/subpro.rb
-- spec/gem_loader_spec.rb
 - spec/helper.rb
-- spec/ruby_loader_spec.rb
-- spec/vendor_loader_spec.rb
-- HISTORY.rdoc
+- spec/runner.rb
+- spec/spec_gem_loader.rb
+- spec/spec_ruby_loader.rb
+- spec/spec_vendor_loader.rb
+- LICENSE.txt
+- HISTORY.md
 - README.md
-- COPYING.rdoc
-- INFRACTIONS.rdoc
+- INFRACTIONS.md
 homepage: http://rubyworks.github.com/loadable
-licenses: []
+licenses:
+- BSD-2-Clause
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -115,11 +138,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Safely Customize Ruby's Load System
 test_files:
-- spec/gem_loader_spec.rb
-- spec/vendor_loader_spec.rb
-- spec/ruby_loader_spec.rb
+- spec/runner.rb
+- spec/helper.rb
+- spec/spec_gem_loader.rb
+- spec/spec_vendor_loader.rb
+- spec/spec_ruby_loader.rb
+- spec/fixture/abbrev.rb
+- spec/fixture/subpro/lib/subpro.rb
+- spec/fixture/ansi.rb