backports 1.8.4 → 1.9.0

data/CHANGELOG.rdoc

@@ -1,5 +1,14 @@
 = Packable --- History
 
+== Version 1.9.0 - September 4th, 2009
+
+* In Ruby 1.9, most class methods of File accept filenames as String, or convertible via #to_str or #to_path.
+File#to_path is also an alias to File#path. These have been backported.
+
+* File.binread (actually IO.binread)
+
+* BasicObject available via "require 'backports/basic_object"
+
 == Version 1.8.4 - September 3rd, 2009
 
 Added Dir.mktmpdir for older version of 1.8.6

data/README.rdoc

@@ -68,6 +68,11 @@ Additionally, the following Ruby 1.9 have been backported:
 * Enumerator
   * +new+ (with block)
 
+* File
+  * +binread+
+  * +to_path+
+  * All class methods accepting filenames will accept files or anything with a #to_path method.
+
 * Hash
   * +try_convert+
   * <tt>default_proc=</tt>
@@ -90,6 +95,10 @@ Additionally, the following Ruby 1.9 have been backported:
 
 +Enumerator+ can be accessed directly (instead of <tt>Enumerable::Enumerator</tt>)
 
+Moreover, a pretty good imitation of BasicObject is available, but it must be required explicitely:
+
+  require 'backports/basic_object'
+
 == Rails
 
 Some generic methods from Rails methods have been copied:

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
-:minor: 8
-:patch: 4
+:minor: 9
+:patch: 0

data/backports.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backports}
-  s.version = "1.8.4"
+  s.version = "1.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marc-Andr\303\251 Lafortune"]
-  s.date = %q{2009-09-03}
+  s.date = %q{2009-09-05}
   s.description = %q{      Essential backports that enable some of the really nice features of ruby 1.8.7, ruby 1.9 and rails from ruby 1.8.6 and earlier.
 }
   s.email = %q{github@marc-andre.ca}
@@ -57,11 +57,14 @@ Gem::Specification.new do |s|
      "lib/backports/1.9/array.rb",
      "lib/backports/1.9/enumerable.rb",
      "lib/backports/1.9/enumerator.rb",
+     "lib/backports/1.9/file.rb",
      "lib/backports/1.9/hash.rb",
      "lib/backports/1.9/integer.rb",
+     "lib/backports/1.9/io.rb",
      "lib/backports/1.9/kernel.rb",
      "lib/backports/1.9/string.rb",
      "lib/backports/1.9/symbol.rb",
+     "lib/backports/basic_object.rb",
      "lib/backports/rails.rb",
      "lib/backports/rails/array.rb",
      "lib/backports/rails/enumerable.rb",
@@ -71,6 +74,7 @@ Gem::Specification.new do |s|
      "lib/backports/rails/string.rb",
      "lib/backports/tools.rb",
      "test/array_test.rb",
+     "test/basic_object_test.rb",
      "test/binding_test.rb",
      "test/enumerable_test.rb",
      "test/enumerator_test.rb",
@@ -92,6 +96,7 @@ Gem::Specification.new do |s|
   s.summary = %q{Backports or ruby 1.8.7+ & rails for older ruby.}
   s.test_files = [
     "test/array_test.rb",
+     "test/basic_object_test.rb",
      "test/binding_test.rb",
      "test/enumerable_test.rb",
      "test/enumerator_test.rb",

data/lib/backports/1.8.7/string.rb

@@ -7,24 +7,26 @@ class String
     chars.first
   end unless method_defined? :chr
 
-  Backports.make_block_optional self, :each_byte, :each, :each_line, :test_on => "abc"
-  
+  Backports.make_block_optional self, :each_byte, :each_line, :test_on => "abc"
+
+  Backports.make_block_optional self, :each, :test_on => "abc" if "is there still an each?".respond_to? :each
+
   # gsub: Left alone because of $~, $1, etc... which needs to be "pushed" up one level
   # It's possible to do so, but gsub is used everywhere so i felt
   # the performance hit was too big compared to the dubious gain.
-  
+
   # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/String.html]
   unless method_defined? :each_char
     def each_char(&block)
       return to_enum(:each_char) unless block_given?
       scan(/./, &block)
-    end 
+    end
 
     alias_method :chars, :each_char unless method_defined? :chars
   end
-  
+
   alias_method :lines, :each_line unless method_defined? :lines
-  
+
   # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/String.html]
   def end_with?(*suffixes)
     suffixes.each do |suffix|
@@ -34,12 +36,12 @@ class String
     end
     false
   end unless method_defined? :end_with?
-  
+
   # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/String.html]
   unless ("check partition".partition(" ") rescue false)
     def partition_with_new_meaning(pattern = Backports::Undefined, &block)
       return partition_without_new_meaning(&block) if pattern == Backports::Undefined
-      pattern = Backports.coerce_to(pattern, String, :to_str) unless pattern.is_a? Regexp      
+      pattern = Backports.coerce_to(pattern, String, :to_str) unless pattern.is_a? Regexp
       i = index(pattern)
       return [self, "", ""] unless i
       if pattern.is_a? Regexp
@@ -58,7 +60,7 @@ class String
     pattern = Backports.coerce_to(pattern, String, :to_str) unless pattern.is_a? Regexp
     i = rindex(pattern)
     return ["", "", self] unless i
-    
+
     if pattern.is_a? Regexp
       match = Regexp.last_match
       [match.pre_match, match[0], match.post_match]
@@ -67,7 +69,7 @@ class String
       [self[0...i], self[i...last], self[last...length]]
     end
   end unless method_defined? :rpartition
- 
+
   # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/String.html]
   def start_with?(*prefixes)
     prefixes.each do |prefix|
@@ -77,7 +79,7 @@ class String
     end
     false
   end unless method_defined? :start_with?
-  
+
   # Standard in Ruby 1.8.7+. See official documentation[http://ruby-doc.org/core-1.9/classes/String.html]
   unless ("abc".upto("def", true) rescue false)
     def upto_with_exclusive(to, excl=false, &block)

data/lib/backports/1.9.rb

@@ -1,5 +1,5 @@
 require File.expand_path(File.dirname(__FILE__) + "/tools")
 Backports.require_relative "1.8.7"
-%w(array enumerable enumerator hash integer kernel string symbol).each do |lib|
+%w(array enumerable enumerator hash file integer io kernel string symbol).each do |lib|
   Backports.require_relative "1.9/#{lib}"
 end

data/lib/backports/1.9/file.rb

@@ -0,0 +1,23 @@
+class File
+  def size
+    stat.size
+  end unless method_defined? :size
+
+  alias_method :to_path, :path unless method_defined? :to_path
+
+  class << self
+    if RUBY_VERSION < '1.9' # can't see any other reasonable way to test than this
+      Backports.convert_all_arguments_to_path self, 0, :delete, :unlink, :join
+      Backports.convert_all_arguments_to_path self, 1, :chmod, :lchmod
+      Backports.convert_all_arguments_to_path self, 2, :chown, :lchown
+
+      Backports.convert_first_argument_to_path self, :atime, :basename,
+        :blockdev?, :chardev?, :ctime, :directory?, :dirname, :executable?, :executable_real?,
+        :exist?, :exists?, :expand_path, :extname, :file?, :ftype, :grpowned?,
+        :link, :lstat, :mtime, :new, :open, :owned?, :pipe?, :readable?, :readable_real?,
+        :readlink, :rename, :setgid?, :setuid?, :size, :size?, :socket?,
+        :split, :stat, :sticky?, :symlink, :symlink?, :truncate, :writable?,
+        :writable_real?, :zero?
+    end
+  end
+end

data/lib/backports/1.9/io.rb

@@ -0,0 +1,10 @@
+class IO
+  class << self
+    def binread(file, *arg)
+      raise ArgumentError, "wrong number of arguments (#{1+arg.size} for 1..3)" unless arg.size < 3
+      File.open(Backports.convert_to_path(file),"rb") do |f|
+        f.read(*arg)
+      end
+    end unless method_defined? :binread
+  end
+end

data/lib/backports/basic_object.rb

@@ -0,0 +1,52 @@
+# Note: Must be required explicitely!
+# This is a best attempt to fake BasicObject in Ruby 1.8.x
+# What you do get:
+#  * as few methods as the real BasicObject (at the moment the library is required...)
+#  * BasicObject === <anything> # ==> returns true
+# What you don't get:
+#  * BasicObject is not in the ancestor list of all classes and thus
+#  * Comparisons between classes won't work, e.g.
+#      Object < BasicObject # ==> returns true instead of false
+#  * Instance methods added to Object or Kernel after you require 'backports/basic_object'
+#    might also be available in instances of BasicObject and subclasses
+#    (they will only be undefined whenever a subclass of BasicObject is created)
+# Because of all the fineprint, BasicObject must be required explicitely
+
+require File.expand_path(File.dirname(__FILE__) + "/tools")
+Backports.require_relative '1.8.7'
+
+class BasicObject
+  KEEP = [:instance_eval, :instance_exec, :__send__,
+          "instance_eval", "instance_exec", "__send__"]
+  # undefine almost all instance methods
+  begin
+    old_verbose, $VERBOSE = $VERBOSE, nil # silence the warning for undefining __id__
+    (instance_methods - KEEP).each do |method|
+      undef_method method
+    end
+  ensure
+    $VERBOSE = old_verbose
+  end
+
+  class << self
+    def === (cmp)
+      true
+    end
+
+    # Let's try to keep things clean, in case methods have been added to Object
+    # either directly or through an included module.
+    # We'll do this whenever a class is derived from BasicObject
+    # Ideally, we'd do this by trapping Object.method_added
+    # and M.method_added for any module M included in Object or a submodule
+    # Seems really though to get right, but pull requests welcome ;-)
+    def inherited(sub)
+      BasicObject.class_eval do
+        (instance_methods - KEEP).each do |method|
+          if Object.method_defined?(method) && instance_method(method).owner == Object.instance_method(method).owner
+            undef_method method
+          end
+        end
+      end
+    end
+  end
+end unless Kernel.const_defined? :BasicObject

data/lib/backports/tools.rb

@@ -4,12 +4,12 @@ module Backports
   # Adapted from Pragmatic's "Programming Ruby" (since their version was buggy...)
   def self.require_relative(relative_feature)
     file = caller.first.split(/:\d/,2).first
-    if /\A\((.*)\)/ =~ file # eval, etc. 
-      raise LoadError, "require_relative is called in #{$1}" 
-    end 
+    if /\A\((.*)\)/ =~ file # eval, etc.
+      raise LoadError, "require_relative is called in #{$1}"
+    end
     require File.expand_path(relative_feature, File.dirname(file))
   end
-  
+
   # Metaprogramming utility to make block optional.
   # Tests first if block is already optional when given options
   def self.make_block_optional mod,*methods
@@ -23,7 +23,7 @@ module Backports
         test_on = options[:test_on] || self.new
         next if (test_on.send(selector, *options.fetch(:arg, [])) rescue false)
       end
-      
+
       arity = mod.instance_method(selector).arity
       last_arg = []
       if arity < 0
@@ -43,6 +43,55 @@ module Backports
     end
   end
 
+  # Metaprogramming utility to convert the first file argument to path
+  def self.convert_first_argument_to_path mod,*methods
+    methods.each do |selector|
+      unless mod.method_defined? selector
+        warn "#{mod}##{selector} is not defined, so argument can't converted to path"
+        next
+      end
+      arity = mod.instance_method(selector).arity
+      last_arg = []
+      if arity < 0
+        last_arg = ["*rest"]
+        arity = -1-arity
+      end
+      arg_sequence = (["file"] + (1...arity).map{|i| "arg_#{i}"} + last_arg + ["&block"]).join(", ")
+
+      alias_method_chain(mod, selector, :potential_path_argument) do |aliased_target, punctuation|
+        mod.module_eval <<-end_eval
+          def #{aliased_target}_with_potential_path_argument#{punctuation}(#{arg_sequence})
+            file = Backports.convert_to_path(file)
+            #{aliased_target}_without_potential_path_argument#{punctuation}(#{arg_sequence})
+          end
+        end_eval
+      end
+    end
+  end
+
+  # Metaprogramming utility to convert all file arguments to paths
+  def self.convert_all_arguments_to_path mod, skip, *methods
+    methods.each do |selector|
+      unless mod.method_defined? selector
+        warn "#{mod}##{selector} is not defined, so arguments can't converted to path"
+        next
+      end
+      first_args = (1..skip).map{|i| "arg_#{i}"}.join(",") + (skip > 0 ? "," : "")
+      alias_method_chain(mod, selector, :potential_path_arguments) do |aliased_target, punctuation|
+        mod.module_eval <<-end_eval
+          def #{aliased_target}_with_potential_path_arguments#{punctuation}(#{first_args}*files, &block)
+            files = files.map{|f| Backports.convert_to_path f}
+            #{aliased_target}_without_potential_path_arguments#{punctuation}(#{first_args}*files, &block)
+          end
+        end_eval
+      end
+    end
+  end
+
+  def self.convert_to_path(file_or_path)
+    coerce_to(file_or_path, String, :to_str) rescue coerce_to(file_or_path, String, :to_path) rescue file_or_path
+  end
+
   # Modified to avoid polluting Module if so desired
   # (from Rails)
   def self.alias_method_chain(mod, target, feature)
@@ -67,10 +116,10 @@ module Backports
       end
     end
   end
-  
+
   # Helper method to coerce a value into a specific class.
   # Raises a TypeError if the coercion fails or the returned value
-  # is not of the right class. 
+  # is not of the right class.
   # (from Rubinius)
   def self.coerce_to(obj, cls, meth)
     return obj if obj.kind_of?(cls)
@@ -84,7 +133,7 @@ module Backports
     raise TypeError, "Coercion error: obj.#{meth} did NOT return a #{cls} (was #{ret.class})" unless ret.kind_of? cls
     ret
   end
-  
+
   # Checks for a failed comparison (in which case it throws an ArgumentError)
   # Additionally, it maps any negative value to -1 and any positive value to +1
   # (from Rubinius)
@@ -98,7 +147,7 @@ module Backports
   # Used internally to make it easy to deal with optional arguments
   # (from Rubinius)
   Undefined = Object.new
-  
+
   # A simple class which allows the construction of Enumerator from a block
   class Yielder
     def initialize(&block)

data/test/basic_object_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+require 'backports/basic_object'
+
+class BasicObjectTest < Test::Unit::TestCase
+  context "BasicObject" do
+    should "do it's best to keep stuff undefined" do
+      # written in one big test because sequence matters
+      # and defining classes / methods can't really be undone
+
+      assert_equal 3, BasicObject.instance_methods.size
+      
+      class Subclass < BasicObject
+        def foo
+          :bar
+        end
+      end
+      
+      assert_equal 4, Subclass.instance_methods.size
+      
+      module ::Kernel
+        def bar
+          :foo
+        end
+      end
+      
+      assert Subclass.method_defined?(:bar) # for now
+      
+      class ForceCleanup < Subclass
+      end
+      
+      assert !Subclass.method_defined?(:bar) # should be cleaned up
+      
+      module SomeExtension
+        def foo
+          42
+        end
+      end
+      
+      class ::Object
+        include SomeExtension
+      end
+      
+      class ForceCleanupAgain < Subclass
+      end
+      
+      # puts BasicObject.instance_methods - BasicObject.instance_methods(false)
+      # puts BasicObject.instance_method(:foo).owner
+      # puts SomeExtension <= Object
+      assert Subclass.method_defined?(:foo) # should not be cleaned up!
+      assert !BasicObject.method_defined?(:foo) # but BasicObject should have been cleaned up!
+      
+      class BasicObject
+        def last_case
+          1.0/0
+        end
+      end
+      
+      module SomeExtension
+        def last_case
+          0
+        end
+      end
+      
+      class ForceCleanupForTheLastTime < BasicObject
+      end
+      
+      assert BasicObject.method_defined?(:last_case)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: backports
 version: !ruby/object:Gem::Version 
-  version: 1.8.4
+  version: 1.9.0
 platform: ruby
 authors: 
 - "Marc-Andr\xC3\xA9 Lafortune"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-03 00:00:00 -04:00
+date: 2009-09-05 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -62,11 +62,14 @@ files:
 - lib/backports/1.9/array.rb
 - lib/backports/1.9/enumerable.rb
 - lib/backports/1.9/enumerator.rb
+- lib/backports/1.9/file.rb
 - lib/backports/1.9/hash.rb
 - lib/backports/1.9/integer.rb
+- lib/backports/1.9/io.rb
 - lib/backports/1.9/kernel.rb
 - lib/backports/1.9/string.rb
 - lib/backports/1.9/symbol.rb
+- lib/backports/basic_object.rb
 - lib/backports/rails.rb
 - lib/backports/rails/array.rb
 - lib/backports/rails/enumerable.rb
@@ -76,6 +79,7 @@ files:
 - lib/backports/rails/string.rb
 - lib/backports/tools.rb
 - test/array_test.rb
+- test/basic_object_test.rb
 - test/binding_test.rb
 - test/enumerable_test.rb
 - test/enumerator_test.rb
@@ -124,6 +128,7 @@ specification_version: 3
 summary: Backports or ruby 1.8.7+ & rails for older ruby.
 test_files: 
 - test/array_test.rb
+- test/basic_object_test.rb
 - test/binding_test.rb
 - test/enumerable_test.rb
 - test/enumerator_test.rb