relative-require 1.0

data/README.md

@@ -0,0 +1,34 @@
+relative-require.rb
+===================
+
+This module provides relative requires to the requiring file. This should solve
+most of the uglyness of pushing to $LOAD_PATH and loading #expand_path-ed files.
+
+Tested with ruby-1.8.7 and ruby-1.9.2
+
+by Jonas Pfenniger <jonas@pfenniger.name>
+
+Example project
+---------------
+
+This example shows that you don't have to mess with $LOAD_PATH anymore.
+
+$ export RUBYOPT=-relative-require
+
+lib/
+* myproject.rb
+* myproject/xyz.rb
+test/
+  test.rb
+
+in myproject.rb
+  require './myproject/xyz.rb'
+
+in test.rb
+  require '../lib/myproject.rb'
+
+Licence
+-------
+
+This project is under public licence. http://unlicence.org
+

data/lib/elative-require.rb

@@ -0,0 +1 @@
+require File.expand_path('../relative-require', __FILE__)

data/lib/relative-require.rb

@@ -0,0 +1,31 @@
+$:.reject! do |x|
+  x == '.'
+end
+
+module Kernel
+  ##
+  # The Kernel#require from before Relative was loaded.
+  alias rel_original_require require
+
+  ##
+  # When relative is required, Kernel#require is replaces with
+  # our own which is capable of loading files relatively.
+  #
+  # The meaning of ./ is replaced with "relative to the directory
+  # of the file that has called require"
+  #
+  # The +path+ argument also accepts a tuple (array of two elements)
+  # in case the path is a variable that is going to required later,
+  # in another file. In that case, the second argument to the tuple
+  # is the __FILE__ where the variable was defined.
+  def require(path) # :doc:
+    if path.kind_of? Array
+      dir = File.dirname(path[1])
+      path = File.expand_path File.join(dir, path[0])
+    elsif /^\.\.?\// =~ path
+      dir = File.dirname caller[0].sub(/:\d+:in.*/, '')
+      path = File.expand_path File.join(dir, path)
+    end
+    rel_original_require path
+  end
+end

data/test/fixtures/a.rb

@@ -0,0 +1,4 @@
+
+require './b/c'
+
+A = true

data/test/fixtures/b/c.rb

@@ -0,0 +1,4 @@
+
+C = true
+
+require '../d'

data/test/fixtures/d.rb

@@ -0,0 +1,2 @@
+
+D = true

data/test/fixtures/e.rb

@@ -0,0 +1 @@
+E = true

data/test/test.rb

@@ -0,0 +1,26 @@
+$:.reject{|x| x=='.'}
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'test/unit'
+
+class TestRelative < Test::Unit::TestCase
+  def test_that_it_works?
+    assert_raise(LoadError) do
+      require './fixtures/a'
+    end
+
+    require 'relative-require'
+
+    assert_nothing_raised() do
+      require './fixtures/a'
+    end
+
+    assert(defined? C)
+    assert(defined? D)
+    
+    assert_nothing_raised do
+      require ['./fixtures/e', __FILE__]
+    end
+    assert(defined? E)
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: relative-require
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Jonas Pfenniger
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-27 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: This module changes the meaning of relative requires from "relative to the current pwd" to "relative to the requiring file". By just changing this little thing, it lets you remove lots of uglyness regarding $LOAD_PATH
+email: jonas@pfenniger.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- lib/elative-require.rb
+- lib/relative-require.rb
+- test/fixtures/a.rb
+- test/fixtures/b/c.rb
+- test/fixtures/d.rb
+- test/fixtures/e.rb
+- test/test.rb
+has_rdoc: true
+homepage: https://github.com/zimbatm/relative-require.rb
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Bringing relative requires to Ruby
+test_files: []
+