shadows 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Simon Menke
+
+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/README.rdoc

@@ -0,0 +1,47 @@
+= Shadows
+
+Shadows is an extention for Kernel#require which allows you to require shadowed files. This is very useful when extending some other gem. Just shadow the original file by creating a file with exacly the same relative path as the file you want to shadow. Then <tt>#require(:shadow)</tt> somewhere in your file.
+
+== Usage
+
+Suppose you have file called <tt>some_gem/some_file.rb</tt> which you want to shadow.
+
+Just create file with the same path in your gem/app (ie. <tt>some_gem/some_file.rb</tt>) and call <tt>require(:shadow)</tt> somwhere in that file.
+
+shadowed <tt>some_gem/some_file.rb</tt>:
+
+  class Person < Struct.new(:name)
+  end
+
+shadowing <tt>some_gem/some_file.rb</tt>:
+
+  require :shadow
+  
+  class Person
+    def whats_your_name?
+      "I'm #{self.name}. What's your name?"
+    end
+  end
+  
+  Person.new('Simon').whats_your_name? # => "I'm Simon. What's your name?"
+
+
+== Installation
+
+  gem install shadows
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+  bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Simon Menke. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "shadows"
+    gem.summary = %Q{Recursively require files.}
+    gem.description = %Q{Like #include and #extend but for ruby source files.}
+    gem.email = "simon.menke@gmail.com"
+    gem.homepage = "http://github.com/fd/shadows"
+    gem.authors = ["Simon Menke"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "shadows #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/shadows.rb

@@ -0,0 +1,62 @@
+module Shadows
+  
+  def require_with_shadow(filename, *args, &block)
+    if filename == :shadow
+      
+      # find the path of the caller
+      caller_list = caller
+      caller_path = caller_list.first.split(':', 2).first
+      relative_caller_path = nil
+      
+      # we don't support eval
+      if caller_path == '(eval)'
+        e = LoadError.new("#require(:shadow) cannot be called from an eval unless you specify what file it represents!")
+        e.set_backtrace caller_list
+        raise e
+      end
+      
+      # find a file with the same relative path a caller
+      $:.uniq.each do |load_path|
+        
+        # find load path of caller
+        if caller_path[0,load_path.size] == load_path
+          relative_caller_path = caller_path[(load_path.size + 1)..-1]
+        
+        # check for shadowed file
+        elsif relative_caller_path
+          full_path = File.join(load_path, relative_caller_path)
+          
+          # faster than require, rescue
+          if Dir.glob("#{full_path}{.rb,}").empty?
+            next
+          end
+          
+          # try loading the shadowed file
+          begin
+            return require(full_path)
+          rescue LoadError
+            next
+          end
+        end
+      end
+      
+      # raise LoadError when no shadowed file was found
+      e = LoadError.new("no such file to load - #{relative_caller_path} [:shadow]")
+      e.set_backtrace caller_list
+      raise e
+      
+    else
+      require_without_shadow(filename, *args, &block)
+    end
+  end
+  
+  def self.included(base)
+    base.class_eval do
+      alias_method :require_without_shadow, :require
+      alias_method :require, :require_with_shadow
+    end
+  end
+  
+  Kernel.send :include, self
+  
+end

data/test/fixtures/a/one.rb

@@ -0,0 +1,7 @@
+module One
+  
+  def self.name
+    "simon"
+  end
+  
+end

data/test/fixtures/b/four.rb

@@ -0,0 +1 @@
+eval %{ require :shadow }, nil, __FILE__

data/test/fixtures/b/one.rb

@@ -0,0 +1,8 @@
+module One
+  require :shadow
+  
+  def self.hello
+    puts "cool #{name}"
+  end
+  
+end

data/test/fixtures/b/three.rb

@@ -0,0 +1 @@
+eval %{ require :shadow }

data/test/fixtures/b/two.rb

@@ -0,0 +1 @@
+require :shadow

data/test/shadows_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class ShadowsTest < Test::Unit::TestCase
+  
+  should "#require :shadow if there is a file in the load path with exactly the same relative path" do
+    assert_nothing_raised do
+      assert  require('one')
+      assert !require('one')
+    end
+  end
+  
+  should "raise LoadError if no :shadow file is found" do
+    assert_raise LoadError do
+      require('two')
+    end
+  end
+  
+  should "raise LoadError if #require :shadow was executed from #eval without specifing a file" do
+    assert_raise LoadError do
+      require('three')
+    end
+  end
+  
+  should "#require :shadow from #eval if file was specified" do
+    assert_nothing_raised do
+      assert require('four')
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+$LOAD_PATH.unshift File.expand_path("../fixtures/a", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../fixtures/b", __FILE__)
+
+require 'shadows'
+
+class Test::Unit::TestCase
+  
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: shadows
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Simon Menke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-15 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: "Like #include and #extend but for ruby source files."
+email: simon.menke@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/shadows.rb
+- test/fixtures/a/four.rb
+- test/fixtures/a/one.rb
+- test/fixtures/b/four.rb
+- test/fixtures/b/one.rb
+- test/fixtures/b/three.rb
+- test/fixtures/b/two.rb
+- test/shadows_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/fd/shadows
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Recursively require files.
+test_files: 
+- test/fixtures/a/four.rb
+- test/fixtures/a/one.rb
+- test/fixtures/b/four.rb
+- test/fixtures/b/one.rb
+- test/fixtures/b/three.rb
+- test/fixtures/b/two.rb
+- test/shadows_test.rb
+- test/test_helper.rb