reverse-require 0.2.0 → 0.3.0

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.3.0 / 2009-01-08
+
+* Added Kernel#require_for.
+* Changed how Kernel#reverse_require behaves.
+* Changed how Kernel#require_all behaves.
+* Added extensions to the Gem module:
+  * Gem.find_resources
+  * Gem.find_resources_for
+
 === 0.2.0 / 2008-11-23
 
 * Use the new Gem.find_files method provided by RubyGems >= 1.3.0. Using

data/Manifest.txt

@@ -5,7 +5,7 @@ TODO.txt
 Rakefile
 lib/reverse_require.rb
 lib/reverse_require/version.rb
-lib/reverse_require/exceptions.rb
-lib/reverse_require/exceptions/rubygems_version_exception.rb
 lib/reverse_require/extensions.rb
+lib/reverse_require/extensions/rubygems.rb
 lib/reverse_require/extensions/kernel.rb
+lib/reverse_require/reverse_require.rb

data/README.txt

@@ -1,30 +1,41 @@
 = ReverseRequire
 
 * http://reverserequire.rubyforge.org/
+* http://github.com/postmodern/reverse-require
 * Postmodern (postmodern.mod3 at gmail.com)
 
 == DESCRIPTION:
 
-reverse_require will require all files ending with a specified path from
-within previously installed RubyGems. By using reverse_require in your
-code-base, it allows developers to extend the functionality of your
-code-base, by merely adding specially named files to their own RubyGems.
-Simply use reverse_require in the code-base that you'd like to be extendable:
+reverse-require allows one to require files that ends with a specified path
+from other RubyGems.
 
-  reverse_require 'some/path'
+For instance, if one wanted to require the file 'mylibrary/extensions.rb'
+from all RubyGems:
 
-The <tt>some/path.rb</tt> files within the <tt>lib/</tt> directories of
-other RubyGems will then be loaded. This functionality makes designing
-plug-in systems ontop of RubyGems trivial.
+  require 'reverse_require'
+
+  require_all 'mylibrary/extensions'
+  # => true
+
+One can also require 'mylibrary/extensions.rb' only from RubyGems that
+depend on the currently loaded version of the mylibrary Gem:
+
+  require_for 'mylibrary', 'mylibrary/extensions'
+  # => true
 
 == FEATURES/PROBLEMS:
 
-* Require files ending with a specified path from previously installed
-  RubyGems.
+* Require files ending with a specified path from all RubyGems.
+* Require files ending with a specified path from RubyGems that depends on
+  another specified RubyGem.
+* Provides extensions to RubyGems for finding static resources in other
+  RubyGems:
+  * Gem.find_resources
+  * Gem.find_resources_for
 
 == REQUIREMENTS:
 
-* RubyGems >= 1.3.0
+* rubygems >= 1.3.0
 
 == INSTALL:
 
@@ -34,7 +45,7 @@ plug-in systems ontop of RubyGems trivial.
 
 The MIT License
 
-Copyright (c) 2008 Hal Brodigan
+Copyright (c) 2008-2009 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/reverse_require.rb

@@ -1,2 +1,6 @@
-require 'reverse_require/extensions'
+require 'reverse_require/reverse_require'
 require 'reverse_require/version'
+
+ReverseRequire.rubygems_version_check do
+  require 'reverse_require/extensions'
+end

data/lib/reverse_require/extensions.rb

@@ -1 +1,2 @@
+require 'reverse_require/extensions/rubygems'
 require 'reverse_require/extensions/kernel'

data/lib/reverse_require/extensions/kernel.rb

@@ -1,24 +1,14 @@
-require 'reverse_require/exceptions/rubygems_version_exception'
+require 'reverse_require/extensions/rubygems'
 
 module Kernel
   #
-  # Requires all files from previously installed RubyGems that
-  # end with the specified _path_. If no RubyGems contain the
-  # specified _path_, +false+ will be returned.
+  # Require the given _paths_ in reverse. Returns +false+ if all of the
+  # paths are already loaded, returns +true+ otherwise.
   #
-  #   reverse_require 'ronin/models'
-  #   # => true
-  #
-  def reverse_require(path)
-    major, minor, rev = Gem::RubyGemsVersion.split('.').map { |i| i.to_i }
-
-    if (major == 1 && minor == 2)
-      raise(ReverseRequire::RubyGemsVersionException,"RubyGems >= 1.3.0 is required for reverse_require",caller)
-    end
-
+  def reverse_require(*paths)
     was_loaded = false
 
-    Gem.find_files(path).reverse_each do |path|
+    paths.reverse_each do |path|
       begin
         if File.file?(path)
           was_loaded ||= require path
@@ -31,5 +21,27 @@ module Kernel
     return was_loaded
   end
 
-  alias require_all reverse_require
+  #
+  # Requires files from previously installed RubyGems that also end with
+  # the specified _path_. Returns +false+ if no RubyGem contains the
+  # specified _path_, returns +true+ otherwise.
+  #
+  #   require_all 'ronin/models'
+  #   # => true
+  #
+  def require_all(path)
+    reverse_require(*Gem.find_files(path))
+  end
+
+  #
+  # Requires files that end with the specified _path_, from previously
+  # installed RubyGems which depend on the specified _gem_. Returns +false+
+  # if no RubyGem contains the specified _path_, returns +true+ otherwise.
+  #
+  #   require_for 'ronin', 'ronin/models'
+  #   # => true
+  #
+  def require_for(gem,path)
+    reverse_require(*Gem.find_files_for(gem,path))
+  end
 end

data/lib/reverse_require/extensions/rubygems.rb

@@ -0,0 +1,46 @@
+require 'rubygems'
+
+module Gem
+  #
+  # Find all files that end with the specified _path_, from within RubyGems
+  # that depend on the specified _gem_.
+  #
+  def self.find_files_for(gem,path)
+    if (spec = Gem.loaded_specs[gem])
+      version = spec.version
+    else
+      version = nil
+    end
+
+    dep = Gem.source_index.find_name(gem,version).first
+
+    dep.dependent_gems.map { |deps|
+      Gem.searcher.matching_files deps.first, path
+    }.flatten
+  end
+
+  #
+  # Find resources that end with the specified _path_ from all RubyGems.
+  #
+  #   Gem.find_resources 'static/template.erb'
+  #   # => [...]
+  #
+  def self.find_resources(path)
+    find_files(File.join('..',path)).map do |gem_path|
+      File.expand_path(gem_path)
+    end
+  end
+
+  #
+  # Find resources that end with the specified _path_, from within RubyGems
+  # that depend on the specified _gem_.
+  #
+  #   Gem.find_resources_for 'statix', 'static/xsl/page.xsl'
+  #   # => [...]
+  #
+  def self.find_resources_for(gem,path)
+    find_files_for(gem,File.join('..',path)).map do |gem_path|
+      File.expand_path(gem_path)
+    end
+  end
+end

data/lib/reverse_require/reverse_require.rb

@@ -0,0 +1,15 @@
+module ReverseRequire
+  #
+  # Preforms a version check on rubygems before calling the given _block_.
+  # If rubygems >= 1.3.0 is not found, then an exception will be raised.
+  #
+  def self.rubygems_version_check(&block)
+    major, minor, rev = Gem::RubyGemsVersion.split('.').map { |i| i.to_i }
+
+    if (major <= 1 && minor <= 2)
+      raise("rubygems >= 1.3.0 is required, please run 'gem update --system'")
+    end
+
+    block.call if block
+  end
+end

data/lib/reverse_require/version.rb

@@ -1,3 +1,3 @@
 module ReverseRequire
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: reverse-require
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Postmodern
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-23 00:00:00 -08:00
+date: 2009-01-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,7 +22,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.2
     version: 
-description: "reverse_require will require all files ending with a specified path from within previously installed RubyGems. By using reverse_require in your code-base, it allows developers to extend the functionality of your code-base, by merely adding specially named files to their own RubyGems. Simply use reverse_require in the code-base that you'd like to be extendable:  reverse_require 'some/path'  The <tt>some/path.rb</tt> files within the <tt>lib/</tt> directories of other RubyGems will then be loaded. This functionality makes designing plug-in systems ontop of RubyGems trivial."
+description: "reverse-require allows one to require files that ends with a specified path from other RubyGems.  For instance, if one wanted to require the file 'mylibrary/extensions.rb' from all RubyGems:  require 'reverse_require'  require_all 'mylibrary/extensions' # => true  One can also require 'mylibrary/extensions.rb' only from RubyGems that depend on the currently loaded version of the mylibrary Gem:  require_for 'mylibrary', 'mylibrary/extensions' # => true"
 email: 
 - postmodern.mod3@gmail.com
 executables: []
@@ -42,10 +42,10 @@ files:
 - Rakefile
 - lib/reverse_require.rb
 - lib/reverse_require/version.rb
-- lib/reverse_require/exceptions.rb
-- lib/reverse_require/exceptions/rubygems_version_exception.rb
 - lib/reverse_require/extensions.rb
+- lib/reverse_require/extensions/rubygems.rb
 - lib/reverse_require/extensions/kernel.rb
+- lib/reverse_require/reverse_require.rb
 has_rdoc: true
 homepage: http://reverserequire.rubyforge.org/
 post_install_message: 
@@ -72,6 +72,6 @@ rubyforge_project: reverserequire
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: reverse_require will require all files ending with a specified path from within previously installed RubyGems
+summary: reverse-require allows one to require files that ends with a specified path from other RubyGems
 test_files: []
 

data/lib/reverse_require/exceptions.rb

@@ -1 +0,0 @@
-require 'reverse_require/exceptions/rubygems_version_exception'

data/lib/reverse_require/exceptions/rubygems_version_exception.rb

@@ -1,4 +0,0 @@
-module ReverseRequire
-  class RubyGemsVersionException < RuntimeError
-  end
-end