rbx-require-relative 0.0.5-universal-ruby-1.8.7

data/ChangeLog

@@ -0,0 +1,113 @@
+2011-06-11  rocky <rockyb@rubyforge.org>
+
+	* .gemspec, Rakefile: Package name needs the kind of Ruby in it.
+	Sigh
+
+2011-06-11  rocky <rockyb@rubyforge.org>
+
+	* .gemspec, ChangeLog, NEWS, lib/require_relative.rb: Tolerance for
+	unpatched 1.9.2
+
+2011-05-26  rocky <rockyb@rubyforge.org>
+
+	* .gemspec, Rakefile, lib/version.rb: Package versioning for MRI
+	1.8.7 was wrong.
+
+2011-05-26  rocky <rockyb@rubyforge.org>
+
+	* .gemspec, README.textile, Rakefile, lib/require_relative.rb,
+	lib/version.rb, test/test-rr.rb: Handle MRI 1.8
+
+2011-04-22  rocky <rockyb@rubyforge.org>
+
+	* NEWS, lib/version.rb: Update for release.
+
+2011-04-22  rocky <rockyb@rubyforge.org>
+
+	* lib/require_relative.rb: Don't use
+	Rubinius::StaticScope#data_path, but mirror the logic for that until
+	an API is created that works like RequireRelative#abs_file. Also use
+	Rubinius::StaticScope.of_sender rather than backtrace. Thanks to
+	Evan Phoenix for advice on all of this.
+
+2011-02-14  rocky <rockyb@rubyforge.org>
+
+	* .gemspec, ChangeLog, NEWS, Rakefile, lib/require_relative.rb,
+	lib/version.rb: Allow this to be build on 1.9.2-nframe as mostly a
+	no-op.
+
+2010-09-23  rocky <rockyb@rubyforge.org>
+
+	* .gemspec: Need symbol in defined?
+
+2010-09-23  rocky <rockyb@rubyforge.org>
+
+	* .gemspec, Rakefile, lib/version.rb: Rakefile: check to see if
+	require_relative is already installed. .gemspec: cut-n-paste error
+	version.rb: bump version #
+
+2010-09-22  rocky <rockyb@rubyforge.org>
+
+	* .gemspec: Bang on gemspec Ruby version. For rubinius 1.0.1 .. 1.1
+	Gem.ruby_version is 1.8.7. I'm imagining 1.9 features will report
+	1.9 or some such thing.
+
+2010-09-22  rocky <rockyb@rubyforge.org>
+
+	* .gemspec, NEWS, lib/version.rb: Update gemspec homepage link
+
+2010-09-22  rocky <rockyb@rubyforge.org>
+
+	* README.textile: More README tweaking
+
+2010-09-22  rocky <rockyb@rubyforge.org>
+
+	* README.textile: More README tweaking
+
+2010-09-22  rocky <rockyb@rubyforge.org>
+
+	* README.textile: textile hacking.
+
+2010-09-22  rocky <rockyb@rubyforge.org>
+
+	* .gemspec, README.textile: Get version ranges in correctly.
+
+2010-09-22  rocky <rockyb@rubyforge.org>
+
+	* .gemspec, ChangeLog, Makefile, NEWS, README.textile, Rakefile,
+	lib/Makefile, test/test-rr.rb: Get ready for release.
+
+2010-09-20  rocky <rockyb@rubyforge.org>
+
+	* lib/version.rb: Set version number back to what it was
+
+2010-09-20  rocky <rockyb@rubyforge.org>
+
+	* Rakefile, lib/require_relative.rb, test/test-rr.rb: 
+	require_relative: Add RequireRelative::abs_file which is like
+	__FILE__ but gives the absolute location.  Rakefile: Had broken
+	tests because rake's default mechanism appears to be broken here and
+	I don't know why.  test-rr.rb: Reinstate more stringent testing -
+	chdir before require_relative
+
+2010-09-20  rocky <rockyb@rubyforge.org>
+
+	* .gemspec, Makefile, Rakefile, lib/.gitignore, lib/Makefile,
+	lib/version.rb: Administrivia: Add packaging, a .gemspec, make
+	comptaibility and so on.
+
+2010-09-19  rocky <rockyb@rubyforge.org>
+
+	* ChangeLog, Rakefile, lib/require_relative.rb,
+	require_relative.rb, test/test-rr.rb: Gem packaging - this time, for
+	sure!
+
+2010-09-18  rocky <rockyb@rubyforge.org>
+
+	* .gitignore, ChangeLog, README.textile, Rakefile: Bang on Rakefile
+	for testing packaging and installing.
+
+2010-09-18  rvm <rocky-rvm@static-71-183-236-17.nycmny.fios.verizon.net>
+
+	* Initial require_relative code.
+

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (C) 2010  Rocky Bernstein <rockyb@rubyforge.org>
+All rights reserved.
+ *
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+ *
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/NEWS

@@ -0,0 +1,23 @@
+0.0.5  (06-12-11) Fleetwood release
+
+Allow this to work on Ruby MRI 1.8 and 1.9. On 1.9 we don't do
+anything for require_relative, but in 1.9.2+thread_frame we add a
+relible abs_path.  This package is provided on 1.9 is there for
+compatibility and for abs_path for a threadframe-enabled 1.9.2.
+
+On MRI abs_path may be unreliable in the face of Dir.chdir.
+
+
+0.0.4  (04-22-11)
+
+- Using an undocumented API has changed in Rubinius 1.2.4dev.  Down
+  the line, we need to get an API for RequireRelative#abs_file in
+  Rubinius.  Until then, we'll have to change code.
+
+0.0.3  (09-27-10)
+
+- Small .gemspec packaging issues
+
+0.0.2  (09-22-10)
+
+- First public release.

data/README.textile

@@ -0,0 +1,13 @@
+h2. Ruby 1.9's relative_relative for Rubinus and MRI 1.8
+
+Here we add in Module RequireRelative method: *require_relative*, and *abs_file*. Example:
+
+bc. require 'rubygems'; require 'require_relative'
+require_relative './lib/foo' 
+absolute_path = RequireRelative.abs_file
+
+But why *abs_file*? Well, recall that ==__FILE__== does not give an absolute path. So if you have chdir'd before using ==__FILE__==, you might not be able to retrieve the full path.
+
+The latest version is at "http://github.com/rocky/rbx-require-relative/"://github.com/rocky/rbx-require-relative/
+
+

data/Rakefile

@@ -0,0 +1,122 @@
+#!/usr/bin/env rake
+# -*- Ruby -*-
+# Are we rubinius or MRI 1.8?
+raise RuntimeError, 'This package is for rubinius or 1.9.2-nframe only!' unless
+  (Object.constants.include?('Rubinius') && 
+   Rubinius.constants.include?('VM') && 
+   Rubinius::VM.respond_to?(:backtrace)) ||
+  (defined? RUBY_DESCRIPTION && 
+   RUBY_DESCRIPTION.start_with?('ruby 1.9.2frame')) ||
+  (RUBY_VERSION.start_with?('1.8') && 
+   RUBY_COPYRIGHT.end_with?('Yukihiro Matsumoto'))
+
+# begin
+#   require_relative 'lib/version'
+#   puts 'Looks like you already have require_relative!'
+#   exit 5
+# rescue NameError
+# end
+
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'rake/testtask'
+require 'fileutils'
+
+ROOT_DIR = File.dirname(__FILE__)
+require File.join(ROOT_DIR, '/lib/version')
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+end
+
+def gem_file
+  "#{gemspec.name}-#{gemspec.version}-#{gemspec.platform.to_s}.gem"
+end
+
+
+desc "Build the gem"
+task :package=>:gem
+task :gem=>:gemspec do
+  sh "gem build .gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv gem_file, 'pkg'
+end
+
+task :default => [:test]
+
+desc 'Install locally'
+task :install => :package do
+  Dir.chdir(ROOT_DIR) do
+    sh %{gem install --local pkg/#{gem_file}}
+  end
+end    
+
+desc 'Test everything.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << './lib'
+  t.pattern = 'test/test-*.rb'
+  t.options = '--verbose' if $VERBOSE
+end
+task :test => [:lib]
+
+require 'rbconfig'
+RUBY_PATH = File.join(RbConfig::CONFIG['bindir'],  
+                      RbConfig::CONFIG['RUBY_INSTALL_NAME'])
+
+def run_standalone_ruby_file(directory)
+  # puts ('*' * 10) + ' ' + directory + ' ' + ('*' * 10)
+  Dir.chdir(directory) do
+    Dir.glob('test-rr.rb').each do |ruby_file|
+      # puts( ('-' * 20) + ' ' + ruby_file + ' ' + ('-' * 20))
+      system(RUBY_PATH, ruby_file)
+    end
+  end
+end
+
+
+desc "Run each library Ruby file in standalone mode."
+rake_dir = File.dirname(__FILE__)
+task :check do
+  run_standalone_ruby_file(File.join(%W(#{rake_dir} test)))
+end
+task :default => [:test]
+
+# Remove the above when I figure out what's up with the commented-out code.
+
+desc 'Create a GNU-style ChangeLog via git2cl'
+task :ChangeLog do
+  system('git log --pretty --numstat --summary | git2cl > ChangeLog')
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end
+
+desc 'Remove residue from running patch'
+task :rm_patch_residue do
+  FileUtils.rm_rf FileList['**/*.{rej,orig}'].to_a, :verbose => true
+end
+
+desc 'Remove ~ backup files'
+task :rm_tilde_backups do
+  FileUtils.rm_rf Dir.glob('**/*~'), :verbose => true
+  FileUtils.rm_rf Dir.glob('**/*.rbc'), :verbose => true
+end
+
+desc "Remove built files"
+task :clean => [:clobber_package, :clobber_rdoc, :rm_patch_residue, :rm_tilde_backups]
+
+task :clobber_package do
+  FileUtils.rm_rf File.join(ROOT_DIR, 'pkg')
+end
+
+task :clobber_rdoc do
+  FileUtils.rm_rf File.join(ROOT_DIR, 'doc')
+end

data/lib/require_relative.rb

@@ -0,0 +1,83 @@
+# Ruby 1.9's require_relative.
+
+if defined?(RubyVM) && RUBY_DESCRIPTION.start_with?('ruby 1.9.2frame')
+  require 'thread_frame'
+end
+
+module RequireRelative
+  def abs_file
+    if defined?(RubyVM::ThreadFrame)
+      RubyVM::ThreadFrame.current.prev.source_container[1]
+    elsif defined?(Rubinius) && "1.8.7" == RUBY_VERSION
+      scope = Rubinius::StaticScope.of_sender
+      script = scope.current_script
+      if script
+        script.data_path
+      else
+        nil
+      end
+    else
+      file = caller.first.split(/:\d/,2).first
+      if /\A\((.*)\)/ =~ file # eval, etc.
+        nil
+      end
+      File.expand_path(file)
+    end
+  end
+  module_function :abs_file
+end
+  
+if RUBY_VERSION.start_with?('1.9')
+  # On 1.9.2 platforms we don't do anything.
+elsif defined?(Rubinius) && '1.8.7' == RUBY_VERSION
+  module Kernel
+    def require_relative(suffix)
+      # Rubinius::Location#file stores relative file names while
+      # Rubinius::Location#scope.current_script.data_path stores the
+      # absolute file name. It is possible (hopeful even) that in the
+      # future that Rubinius will change the API to be more
+      # intuitive. When that occurs, I'll change the below to that
+      # simpler thing.
+      scope = Rubinius::StaticScope.of_sender
+      script = scope.current_script
+      if script
+        require File.join(File.dirname(script.data_path), suffix)
+      else
+        raise LoadError "Something is wrong in trying to get relative path"
+      end
+    end
+  end
+elsif (RUBY_VERSION.start_with?('1.8') && 
+       RUBY_COPYRIGHT.end_with?('Yukihiro Matsumoto'))
+  def require_relative(suffix)
+    file = caller.first.split(/:\d/,2).first
+    if /\A\((.*)\)/ =~ file # eval, etc.
+      raise LoadError, "require_relative is called in #{$1}"
+    end
+    require File.join(File.dirname(file), suffix)
+  end
+end
+  
+# demo
+if __FILE__ == $0
+  file = RequireRelative.abs_file
+  puts file
+  require 'tmpdir'
+  dir = 
+    if RUBY_VERSION.start_with?('1.8') && 
+        RUBY_COPYRIGHT.end_with?('Yukihiro Matsumoto')
+      puts "Note: require_relative doesn't work with Dir.chdir as it does on Rubinius or 1.9"
+      '.'
+    else
+      Dir.tmpdir
+    end
+  Dir.chdir(dir) do 
+    rel_file = File.basename(file)
+    cur_dir  = File.basename(File.dirname(file))
+    ['./', "../#{cur_dir}/"].each do |prefix|
+      test = "#{prefix}#{rel_file}"
+      puts "#{test}: #{require_relative test}"
+      puts "#{test}: #{require_relative test} -- should be false"
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module RequireRelative
+  VERSION = '0.0.5'
+end

data/test/bar.rb

@@ -0,0 +1,3 @@
+# Just something else to try require_relative on.
+class Bar
+end

data/test/foo.rb

@@ -0,0 +1,3 @@
+# Just something to try require_relative on.
+class Foo
+end

data/test/test-rr.rb

@@ -0,0 +1,36 @@
+require 'test/unit'
+
+# require_relative the old-fashioned way...
+# Note that it's important there be no chdir before this require.
+file = File.expand_path(File.join(File.dirname(__FILE__), 
+                                  '../lib/require_relative'))
+require file
+
+class TestRR < Test::Unit::TestCase
+  require 'tmpdir'
+  def test_basic
+    dir = 
+      if RUBY_VERSION.start_with?('1.8') && 
+          RUBY_COPYRIGHT.end_with?('Yukihiro Matsumoto')
+        puts "Note: require_relative doesn't work with Dir.chdir as it does on Rubinius or 1.9"
+        '.'
+      else
+        Dir.tmpdir
+      end
+    abs_file = RequireRelative.abs_file
+    # The chdir is to make things harder for those platforms that 
+    # truly support require_relative.
+    Dir.chdir(dir) do 
+      cur_dir  = File.basename(File.expand_path(File.dirname(abs_file)))
+      ['./foo', "../#{cur_dir}/bar"].each_with_index do |suffix, i|
+        assert_equal(true, require_relative(suffix), 
+                     "check require_relative(#{suffix})")
+        # Check that the require_relative worked by checking to see of the
+        # class from each file was imported.
+        assert_equal(Class, (0 == i ? Foo : Bar).class)
+        assert_equal(false, require_relative(suffix), 
+                     "require_relative(#{suffix}) second time should be false")
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: rbx-require-relative
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: universal-ruby-1.8.7
+authors: 
+- R. Bernstein
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-11 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: |
+  Ruby 1.9's require_relative for Rubinius and MRI 1.8. 
+  
+  We also add abs_path which is like __FILE__ but __FILE__ can be fooled
+  by a sneaky "chdir" while abs_path can't. 
+  
+  If you are running on Ruby 1.9.2, require_relative is the pre-defined
+  version.  The benefit we provide in this situation by this package is
+  the ability to write the same require_relative sequence in Rubinius
+  1.8 and Ruby 1.9.
+
+email: rockyb@rubyforge.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- ChangeLog
+- NEWS
+- README.textile
+- Rakefile
+- lib/version.rb
+- lib/require_relative.rb
+- test/test-rr.rb
+- test/foo.rb
+- test/bar.rb
+has_rdoc: true
+homepage: http://github.com/rocky/rbx-require-relative
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: 
+- --title
+- require_relative 0.0.5 Documentation
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ~>
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+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.6.1
+signing_key: 
+specification_version: 3
+summary: Ruby 1.9's require_relative for Rubinius and MRI 1.8.   We also add abs_path which is like __FILE__ but __FILE__ can be fooled by a sneaky "chdir" while abs_path can't.   If you are running on Ruby 1.9.2, require_relative is the pre-defined version.  The benefit we provide in this situation by this package is the ability to write the same require_relative sequence in Rubinius 1.8 and Ruby 1.9.
+test_files: []
+