rbx-require-relative 0.0.3 → 0.0.5

data/ChangeLog

@@ -1,3 +1,41 @@
+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?

data/NEWS

@@ -1,3 +1,19 @@
+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

data/README.textile

@@ -1,4 +1,4 @@
-h2. Ruby 1.9's relative_relative for Rubinus 1.0.1 .. 1.1
+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:
 

data/Rakefile

@@ -1,21 +1,25 @@
 #!/usr/bin/env rake
 # -*- Ruby -*-
-# Are we rubinius? We'll test by checking the specific function we need.
-raise RuntimeError, 'This package is for rubinius only!' unless
-  Object.constants.include?('Rubinius') && 
-  Rubinius.constants.include?('VM') && 
-  Rubinius::VM.respond_to?(:backtrace)
-
-begin
-  require_relative 'lib/version'
-  puts 'Looks like you already have require_relative!'
-  exit 5
-rescue NameError
-end
+# 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 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'rubygems/package_task'
+require 'rdoc/task'
 require 'rake/testtask'
 require 'fileutils'
 
@@ -26,12 +30,22 @@ def gemspec
   @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
 end
 
+def gem_file
+  if (RUBY_VERSION.start_with?('1.8') && 
+      RUBY_COPYRIGHT.end_with?('Yukihiro Matsumoto'))
+    "#{gemspec.name}-#{gemspec.version}.gem"
+  else
+    "#{gemspec.name}-#{gemspec.version}-#{gemspec.platform.to_s}.gem"
+  end
+end
+
+
 desc "Build the gem"
 task :package=>:gem
 task :gem=>:gemspec do
   sh "gem build .gemspec"
   FileUtils.mkdir_p 'pkg'
-  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+  FileUtils.mv gem_file, 'pkg'
 end
 
 task :default => [:test]
@@ -39,7 +53,7 @@ task :default => [:test]
 desc 'Install locally'
 task :install => :package do
   Dir.chdir(ROOT_DIR) do
-    sh %{gem install --local pkg/#{gemspec.name}-#{gemspec.version}}
+    sh %{gem install --local pkg/#{gem_file}}
   end
 end    
 
@@ -47,7 +61,7 @@ desc 'Test everything.'
 Rake::TestTask.new(:test) do |t|
   t.libs << './lib'
   t.pattern = 'test/test-*.rb'
-  t.verbose = true
+  t.options = '--verbose' if $VERBOSE
 end
 task :test => [:lib]
 
@@ -80,9 +94,6 @@ task :ChangeLog do
   system('git log --pretty --numstat --summary | git2cl > ChangeLog')
 end
 
-desc "Remove built files"
-task :clean => [:clobber_package, :clobber_rdoc]
-
 desc "Generate the gemspec"
 task :generate do
   puts gemspec.to_ruby
@@ -93,6 +104,20 @@ 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

data/lib/require_relative.rb

@@ -1,30 +1,77 @@
 # 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
-    Rubinius::VM.backtrace(1)[0].method.scope.data_path
+    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
-
-module Kernel
+  
+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)
-    # Rubinius::Location#file stores relative file names while
-    # Rubinius::Location#scope.data store 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.
-    dir = File.dirname(Rubinius::VM.backtrace(1)[0].
-                       method.scope.data_path)
-    require File.join(dir, 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.chdir(Dir.tmpdir) do 
+  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|

data/lib/version.rb

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

data/test/test-rr.rb

@@ -9,9 +9,18 @@ require file
 class TestRR < Test::Unit::TestCase
   require 'tmpdir'
   def test_basic
-    # The chdir is to make things harder.
+    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
-    Dir.chdir(Dir.tmpdir) do 
+    # 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), 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rbx-require-relative
 version: !ruby/object:Gem::Version 
-  hash: 25
-  prerelease: false
+  hash: 21
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - R. Bernstein
@@ -15,13 +15,20 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-27 00:00:00 -04:00
+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. 
   
-  Ruby 1.9's require_relative for Rubinius
+  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: []
@@ -47,10 +54,8 @@ licenses:
 - MIT
 post_install_message: 
 rdoc_options: 
-- --main
-- README
 - --title
-- require_relative 0.0.3 Documentation
+- require_relative 0.0.5 Documentation
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -76,9 +81,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.6.1
 signing_key: 
 specification_version: 3
-summary: Ruby 1.9's require_relative for Rubinius
+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: []