simonmenke-need 1.1.0

data/History.txt

@@ -0,0 +1,25 @@
+=== 1.1.0 / 2008-05-24
+
+* 1 major enhancement
+  * need can now optionally take a path rather than a block
+  * thanks simonmenke
+
+=== 1.0.3 / 2008-05-23
+
+* 1 minor enhancement
+  * removed unnecessary call to binding on block
+
+=== 1.0.2 / 2008-03-18
+
+* 1 minor enhancement
+  * path creation now uses File.expand_path after joining to give the absolute path
+
+=== 1.0.1 / 2008-02-07
+
+* 1 minor enhancement
+  * path creation now uses File.join to remain platform agnostic
+
+=== 1.0.0 / 2008-02-07
+
+* 1 major enhancement
+  * need can require files relative to the file in which you are calling need.

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/need.rb
+test/test_files/file_a.rb
+test/test_files/file_b.rb
+test/test_files/file_c.rb
+test/test_files/require_file.rb
+test/test_need.rb

data/README.txt

@@ -0,0 +1,60 @@
+= need
+
+* http://need.rubyforge.org
+* source code - http://github.com/dfg59/need/tree/master
+
+== DESCRIPTION:
+
+Need makes ruby relative requires just work. Simply need a file with a relative path
+and the file will always be required correctly, regardless of what file your application is
+being launched through. Typically, ruby projects would unshift lib onto $PATH or use the
+File.dirname(__FILE__) trick. Using need means you don't have to worry about either of these.
+
+Assume you have two files, one directly in lib and the other in lib/extensions. Let's assume
+that file_a in lib requires file_b, in lib/extensions. Previously, you would doing some crazy
+load path unshifting or use the __FILE__ trick to make these requires flexible enough to work
+when your app is being accessed by rake, through a test suite, or required as a gem. Now, just
+use need.
+
+  In file_a:
+  need{"extensions/file_b"}
+  need "extensions/file_b"
+
+== FEATURES/PROBLEMS:
+
+== SYNOPSIS:
+
+  need{"relative/path/to/file"}
+  need "relative/path/to/file"
+
+== REQUIREMENTS:
+
+== INSTALL:
+
+* rubyforge - sudo gem install need
+* github - sudo gem install dfg59-need --source=http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,18 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/need.rb'
+
+Hoe.new('need', Need::VERSION) do |p|
+  p.rubyforge_name = 'need'
+  p.author = 'Drew Olson'
+  p.email = 'drew@drewolson.org'
+  p.summary = 'Need makes relative requries just work'
+  p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  p.url = "http://need.rubyforge.org"
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/lib/need.rb

@@ -0,0 +1,27 @@
+module Need
+  VERSION = '1.1.0'
+  
+  # need takes a block which should contain a string of the relative path to the file
+  # you wish to need.
+  def need(file=nil, &block)
+    if block_given?
+      require File.expand_path(File.join(File.dirname(eval("__FILE__",block)),block.call))
+    elsif file
+      require File.expand_path(File.join(File.dirname(caller_file(1)),file))
+    end
+  end
+  
+  def caller_file(level=0)
+    if caller[level]
+      File.expand_path(caller[level].split(":").first)
+    else
+      nil
+    end
+  end
+  
+  private :caller_file
+end
+
+class Object
+  include Need
+end

data/test/test_files/file_a.rb

@@ -0,0 +1 @@
+need{"require_file"}

data/test/test_files/file_b.rb

@@ -0,0 +1 @@
+need "require_file"

data/test/test_files/file_c.rb

@@ -0,0 +1 @@
+require "require_file"

data/test/test_files/require_file.rb

@@ -0,0 +1,3 @@
+def file_loaded?
+  true
+end

data/test/test_need.rb

@@ -0,0 +1,18 @@
+require "test/unit"
+require "need"
+
+class TestNeed < Test::Unit::TestCase
+  def test_need_with_block
+    need {"test_files/file_a"}
+    assert file_loaded?, "require_file was not needed correctly"
+  end
+  def test_need_with_argument
+    need  "test_files/file_b"
+    assert file_loaded?, "require_file was not needed correctly"
+  end
+  def test_require
+    assert_raise LoadError do
+      require  "test_files/file_c"
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: simonmenke-need
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Drew Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-24 00:00:00 -07: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.5.3
+    version: 
+description: "== DESCRIPTION:  Need makes ruby relative requires just work. Simply need a file with a relative path and the file will always be required correctly, regardless of what file your application is being launched through. Typically, ruby projects would unshift lib onto $PATH or use the File.dirname(__FILE__) trick. Using need means you don't have to worry about either of these.  Assume you have two files, one directly in lib and the other in lib/extensions. Let's assume that file_a in lib requires file_b, in lib/extensions. Previously, you would doing some crazy load path unshifting or use the __FILE__ trick to make these requires flexible enough to work when your app is being accessed by rake, through a test suite, or required as a gem. Now, just use need.  In file_a: need{\"extensions/file_b\"} need \"extensions/file_b\""
+email: drew@drewolson.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/need.rb
+- test/test_files/file_a.rb
+- test/test_files/file_b.rb
+- test/test_files/file_c.rb
+- test/test_files/require_file.rb
+- test/test_need.rb
+has_rdoc: true
+homepage: http://need.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: need
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Need makes relative requries just work
+test_files: 
+- test/test_need.rb