el_req 0.0.1

data/CHANGELOG

@@ -0,0 +1,4 @@
+=== 1.0.0 / 11/30/2007
+
+* 1 major enhancement
+  * bring into the world

data/MIT-LICENSE

@@ -0,0 +1,23 @@
+elreq http://elreq.rubyforge.org
+Copyright (c) 2007 Kevin R. Barnes <vinbarnes@gmail.com>
+
+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/Manifest.txt

@@ -0,0 +1,15 @@
+CHANGELOG
+Manifest.txt
+MIT-LICENSE
+Rakefile
+README.txt
+lib/file_extensions.rb
+lib/kernel_extensions.rb
+lib/relative_require.rb
+spec/file_extensions_spec.rb
+spec/kernel_extensions_spec.rb
+spec/local_extensions.rb
+spec/object_helpers_spec.rb
+spec/require_spec.rb
+spec/spec_helper.rb
+spec/lib/faux_extensions.rb

data/README.txt

@@ -0,0 +1,42 @@
+= RelATIVE reqUIRE
+
+A simple wrapper for Ruby's built-in require method. 
+
+Allows files to be required relative to the current file. Like,
+
+	require '../lib/my_file'
+	
+Which serves as a replacement for the tired idiom of,
+
+	require File.join(File.dirname(__FILE__), '..', 'lib', 'my_file')
+
+Ruby's built-in require still works the same
+
+	require 'test/unit'
+
+== Requirements
+
+* rubygems
+
+== Install
+
+Download and install relative_require with the following.
+
+   sudo gem install --remote elreq
+
+== Credits
+
+[<b>Rick Bradley</b> http://rickbradley.com] For the caller reminder.
+
+[<b>Yossef Mendelssohn</b> http://rubybyraeli.org] For all the prodding, urging and provoking.
+
+== License
+
+:include: MIT-LICENSE
+
+== Warranty
+
+This software is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantibility and fitness for a particular
+purpose.

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'hoe'
+
+$: << 'lib'
+require './lib/relative_require.rb'
+
+Hoe.new('el_req', RelativeRequire::VERSION) do |p|
+  authorship = p.paragraphs_of('MIT-LICENSE', 0).first.match(/Copyright \(c\) \d+ (.*) <(.*)>/)
+  p.author, p.email = authorship[1], authorship[2]
+  p.summary = p.paragraphs_of('README.txt', 1).first
+  p.description = p.paragraphs_of('README.txt', 2..6).join("\n\n")
+  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
+  p.rubyforge_name = p.name.gsub('_', '')
+  p.url = 'http://elreq.rubyforge.org'
+  p.test_globs = ['spec/**/*_spec.rb']
+end
+
+desc 'generate manifest file'
+task :manifest do
+  files = FileList['**/*'].exclude('doc', 'pkg').to_ary
+  files.reject! {|f| File.directory?(f)}
+  open('Manifest.txt', 'w') do |f|
+    f.puts files.join("\n")
+  end
+end
+
+desc 'run specs'
+task :spec do
+  specs = FileList['spec/**/*_spec.rb'].to_ary.join(' ')
+  puts `spec #{specs}`
+end

data/lib/file_extensions.rb

@@ -0,0 +1,6 @@
+module FileExtensions
+  def split_path(path, separator=File::Separator)
+    path.split(separator)
+  end
+end
+File.extend(FileExtensions)

data/lib/kernel_extensions.rb

@@ -0,0 +1,42 @@
+require 'file_extensions'
+
+# Removes the ubiquitous and long-winded requiring. So this,
+#
+#  <tt>require File.join(File.dirname(__FILE__), '..', 'lib', 'file_under_test')</tt>
+#
+# becomes,
+#
+#  <tt>require '../lib/file_under_test/'</tt>
+#
+# <tt>require</tt> will accept the following:
+#   * A fully qualified path -- '/Users/elvis/projects/next_best_thing/main.rb'
+#   * A relative path -- '../lib/file_under_test'
+#   * A file local to the current directory -- 'test_helper'
+#
+# Plus, we try to run File.expand_path on all paths given to <tt>require</tt>
+# so that files will not accidentally be re-required just because their
+# relative paths were slightly different.
+#
+module Kernel  
+  def require_with_lookup(path)
+    require_without_lookup(path)
+  rescue LoadError
+    relative_require(path)
+  end
+
+  unless method_defined? :require_without_lookup
+    alias_method :require_without_lookup, :require
+    alias_method :require, :require_with_lookup
+  end
+
+  def relative_require(path)
+    calling_file = caller[1].sub(/\.rb:\d+/, '.rb')
+    full_path = File.expand_path(File.join(File.dirname(calling_file), File.split_path(path)))
+    require_without_lookup(full_path)
+  end
+
+  # Wrapper function to ensure that the caller stack is correct.
+  def relative_require_wrapper(path) # :nodoc:
+    relative_require(path)
+  end
+end

data/lib/relative_require.rb

@@ -0,0 +1,5 @@
+require 'kernel_extensions'
+
+class RelativeRequire
+  VERSION = '0.0.1'
+end

data/spec/file_extensions_spec.rb

@@ -0,0 +1,22 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+require 'spec_helper'
+require 'file_extensions'
+
+describe 'File.split_path' do
+  it 'should slit a path into components' do
+    File.split_path('../lib').should == ['..', 'lib']
+  end
+
+  it 'should use File::Separator to split on by default' do
+    original_separator = File::Separator
+    File.send(:remove_const, :Separator)
+    File::Separator = '|'
+    File.split_path('..|lib').should == ['..', 'lib']
+    File.send(:remove_const, :Separator)
+    File::Separator = original_separator
+  end
+  
+  it 'should use custom separator if provided' do
+    File.split_path('..|lib', '|').should == ['..', 'lib']
+  end
+end

data/spec/kernel_extensions_spec.rb

@@ -0,0 +1,78 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+require 'spec_helper'
+require 'kernel_extensions'
+
+describe Object do
+  it 'should have method require_with_lookup' do
+    Object.new.should respond_to(:require_with_lookup)
+  end
+
+  it 'should have method require_without_lookup' do
+    Object.new.should respond_to(:require_without_lookup)
+  end
+
+  it 'should have method relative_require' do
+    Object.new.should respond_to(:relative_require)
+  end
+  
+  it 'should have method require' do
+    Object.new.should respond_to(:require)
+  end
+end
+
+describe 'relative_require' do
+  before :each do
+    remove_from_loadpath(/faux_extensions\.rb/)
+  end
+
+  it 'should require a file with a relative path' do
+    relative_require_wrapper('../spec/lib/faux_extensions').should == true
+  end
+  
+  it 'should not require a file twice with different relative paths' do
+    relative_require_wrapper('lib/faux_extensions').should == true
+    relative_require_wrapper('../spec/lib/../lib/faux_extensions').should == false
+  end
+
+  it 'should require a file with a relative path and file extension' do
+    relative_require_wrapper('../spec/lib/faux_extensions.rb').should == true
+  end
+end
+
+describe 'require' do  
+  before :each do
+    @relative_path = '../spec/lib/faux_extensions'
+    @full_path     = File.expand_path(File.join(File.dirname(__FILE__), 'lib', 'faux_extensions.rb'))
+    remove_from_loadpath(/faux_extensions\.rb/)
+  end
+  
+  it 'should call relative_require when given a relative path' do
+    self.expects(:relative_require).with(@relative_path)
+    require @relative_path
+  end
+  
+  it 'should require a file when given a relative path' do
+    require(@relative_path).should == true
+  end
+  
+  it 'should require a file in the same directory' do
+    require('local_extensions').should == true
+  end
+  
+  it 'should require a file given the complete path' do
+    require(@full_path).should == true
+  end
+  
+  it 'should not require the same file if alternate paths used' do
+    require @relative_path
+    require(@full_path).should == false
+  end
+  
+  it 'should throw a LoadError if file/path not found' do
+    lambda {require 'not_here.rb'}.should raise_error(LoadError)
+  end
+  
+  it 'should accept a relative path' do
+    lambda {require '../spec/lib/faux_extensions'}.should_not raise_error(LoadError)    
+  end
+end

data/spec/object_helpers_spec.rb

@@ -0,0 +1,60 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+require 'spec_helper'
+
+describe 'in_loadpath?' do
+  before :each do
+    $LOADED_FEATURES << 'mock_file.rb'
+  end
+  
+  after :each do
+    $LOADED_FEATURES.pop
+  end
+  
+  it 'should return true if search string is in $LOADED_FEATURES' do
+    in_loadpath?('mock_file.rb').should == true
+  end
+
+  it 'should return false if search string is not in $LOADED_FEATURES' do
+    in_loadpath?('mock_file').should == false
+  end
+
+  it 'should return true if search regexp is in $LOADED_FEATURES' do
+    in_loadpath?(/mock_file/).should == true
+  end
+
+  it 'should return false if search regexp is not in $LOADED_FEATURES' do
+    in_loadpath?(/mox_file/).should == false
+  end
+end
+
+describe 'remove_from_loadpath' do
+  before :each do
+    $LOADED_FEATURES << 'mock_file.rb'
+  end
+  
+  after :each do
+    $LOADED_FEATURES.pop
+  end
+
+  it 'should remove a file from $LOADED_FEATURES' do
+    remove_from_loadpath('mock_file.rb')
+    in_loadpath?('mock_file.rb').should == false
+  end
+
+  it 'should not remove a file not in $LOADED_FEATURES' do
+    in_loadpath?('mox_file.rb').should == false
+    remove_from_loadpath('mox_file.rb')
+    in_loadpath?('mox_file.rb').should == false
+  end
+
+  it 'should remove a regexp file from $LOADED_FEATURES' do
+    remove_from_loadpath(/mock_file/)
+    in_loadpath?('mock_file.rb').should == false
+  end
+
+  it 'should not remove a file not in $LOADED_FEATURES' do
+    in_loadpath?('mox_file.rb').should == false
+    remove_from_loadpath(/mox_file/)
+    in_loadpath?('mox_file.rb').should == false
+  end
+end

data/spec/require_spec.rb

@@ -0,0 +1,31 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+require 'spec_helper'
+
+# Make sure that ruby's built-in <tt>require</tt> works the way we expect it to
+describe 'built-in require' do
+  before :each do
+    remove_from_loadpath(/local_extensions\.rb/)
+  end
+  
+  it 'should be able to find items in the same directory' do
+    require('local_extensions').should == true
+  end
+  
+  it 'should be able to find items in the same directory with file extension' do
+    require('local_extensions.rb').should == true
+  end
+
+  it 'should be able to find items with a complete path' do
+    full_path = File.expand_path(File.join(File.dirname(__FILE__), 'local_extensions.rb'))
+    require(full_path).should == true
+  end
+
+  it 'should not reload a file' do
+    require('local_extensions').should == true
+    require('local_extensions').should == false
+  end
+
+  it 'should not be able to reliably find files using relative path' do
+    lambda { require '../../spec/local_extensions' }.should raise_error(LoadError)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mocha'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+# Helpers for testing if a file has been required or not.
+# These are mixed-in to Object so they are available to all.
+module ObjectHelpers
+  
+  # Searches $LOADED_FEATURES for the entire string or
+  # for a partial match if a Regexp is supplied and returns
+  # boolean response. If 'my_file.rb' is in $LOADED_FEATURES,
+  # 
+  #   in_loadpath?('my_file.rb') # => true
+  #   in_loadpath?(/my_file/) # => true
+  #
+  def in_loadpath?(search)
+    case search
+    when String
+      $LOADED_FEATURES.include?(search)
+    when Regexp
+      $LOADED_FEATURES.any? {|file| file =~ search}
+    end
+  end
+  
+  # Removes a file from $LOADED_FEATURES. If a string is given,
+  # an exact match is removed if found. If a Regexp is given,
+  # all files matching are removed. Note: The return value is
+  # not consistent and therefore in the realm of unsupported.
+  #
+  #   remove_from_loadpath('my_file.rb')
+  #   remove_from_loadpath(/my_file/)
+  #
+  def remove_from_loadpath(search)
+    case search
+    when String
+      $LOADED_FEATURES.delete(search)
+    when Regexp
+      $LOADED_FEATURES.reject! {|file| file =~ search}
+    end
+  end
+end
+Object.send(:include, ObjectHelpers)

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: el_req
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ""
+authors: 
+- Kevin R. Barnes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2007-12-02 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+description: Allows files to be required relative to the current file. Like,  require '../lib/my_file'  Which serves as a replacement for the tired idiom of,  require File.join(File.dirname(__FILE__), '..', 'lib', 'my_file')  Ruby's built-in require still works the same  require 'test/unit'
+email: vinbarnes@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- README.txt
+files: 
+- CHANGELOG
+- Manifest.txt
+- MIT-LICENSE
+- Rakefile
+- README.txt
+- lib/file_extensions.rb
+- lib/kernel_extensions.rb
+- lib/relative_require.rb
+- spec/file_extensions_spec.rb
+- spec/kernel_extensions_spec.rb
+- spec/local_extensions.rb
+- spec/object_helpers_spec.rb
+- spec/require_spec.rb
+- spec/spec_helper.rb
+- spec/lib/faux_extensions.rb
+has_rdoc: true
+homepage: http://elreq.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: elreq
+rubygems_version: 0.9.5
+signing_key: 
+specification_version: 2
+summary: A simple wrapper for Ruby's built-in require method.
+test_files: 
+- spec/file_extensions_spec.rb
+- spec/kernel_extensions_spec.rb
+- spec/object_helpers_spec.rb
+- spec/require_spec.rb