quality_extensions 0.1.2 → 0.1.4

data/Readme

@@ -1,7 +1,7 @@
-= QualitySmith Extensions
+= Quality Ruby Extensions
 
-[<b>Home page</b>:]        http://qualitysmithext.rubyforge.org/
-[<b>Project site</b>:]     http://rubyforge.org/projects/qualitysmithext/
+[<b>Home page</b>:]        http://quality-ext.rubyforge.org/
+[<b>Project site</b>:]     http://rubyforge.org/projects/quality-ext/
 [<b>Gem install</b>:]      <tt>gem install quality_extensions</tt>
 [<b>License</b>:]          {Ruby License}[link:files/License.html]
 
@@ -50,5 +50,3 @@ Tests are self-contained within the file for the code that is under test.
 To run the tests directly, you need to use the <tt>exrb</tt> command that is part of the {Ratchets}[http://ratchets.rubyforge.org/] project.
 
 At some point in time, we may extract them into separate files using the Exacto test extractor tool.
-
-<b>QualitySmith developers</b>: If you use <tt>vim</tt>, you can set up your editor to run the tests just by typing the <tt>:Test</tt> command. To set that up, just include <tt>~/svn/devscripts/vim/include.vim</tt> .

data/lib/quality_extensions/chainable_safe_nil.rb

@@ -0,0 +1,173 @@
+#--
+# Credits::
+# * Daniel Lucraft (http://www.daniellucraft.com/blog/2007/08/null-objects/) -- for the idea
+# * Tyler Rick -- packaged it, added some documention, and added some tests, realized it didn't work as well as one might hope...
+# Copyright:: ?
+# License::   ?
+# Submit to Facets?:: No
+# Developer notes::
+#++
+
+# The __? method just returns the object itself for all objects except for nil. For nil, __? will return a special version of nil that lets you call undefined
+# methods.
+#
+# If you call an undefined method on nil._?, you will get back an instance of ChainableSafeNil -- rather than raising an exception, which is what would 
+# happen if you called the same method on a _plain_ old nil.
+#
+# __? gives us a much conciser alternative to this common pattern:
+#   might_be_nil ? might_be_nil.some_method : nil
+# or
+#   (might_be_nil && might_be_nil.some_method)
+#
+# ... where might_be_nil is something that you hope is not nil most of the time, but which may on accosion be nil (and when it is, you don't want an exception
+# to be raised!).
+#
+# For example, accessing a key from a hash:
+#   (hash[:a] && hash[:a][:b] && hash[:a][:b].some_method)
+#
+# With __?, that simply becomes
+#   hash[:a].__?[:b].some_method)
+#
+# Unfortunately, this idea fails in two ways:
+# * nil.__?.whatever will return an instance of ChainableSafeNil, which means you may end up with ChainableSafeNil objects as values of variables and arguments
+#   in your code... which seems messy, undesirable, and undefined (Should ChainableSafeNil act like nil? Should it evaluate to false like nil does? Good luck
+#   with that...)
+# * If something evaluates to nil further on down the chain, after the __?, then all method calls to that nil will be unsafe. For example:
+#   hash = { :a => {} }
+#   hash[:a].__?[:b][:c]) => NoMethodError
+#
+# Conclusion: Chaining is impossible -- Just use _? on any object that might return nil (on which you want to call a method).
+
+
+require 'singleton'
+require 'rubygems'
+require 'facets/more/basicobject'
+
+
+class Object
+  def __?
+    self
+  end
+end
+
+class NilClass
+  def __?
+    ChainableSafeNil.instance
+  end
+end
+
+class C < BasicObject
+end
+
+class ChainableSafeNil < BasicObject
+  include Singleton
+
+  def inspect
+    "ChainableSafeNil"
+  end
+
+  def method_missing(method, *args, &block)
+    #puts "nil.respond_to?(method)=#{nil.respond_to?(method)}"
+    return ChainableSafeNil.instance  unless nil.respond_to?(method)
+    nil.send(method, *args, &block) rescue ChainableSafeNil.instance
+  end
+
+  def ==(other)
+    #other.nil?
+    raise "Why on earth is this line never getting executed?? And yet if I remove this method entirely, equality breaks"
+  end
+
+  def nil?; true; end
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+
+  def test_simple__nil
+    hash = {}
+    assert_equal ChainableSafeNil.instance, hash[:a].__?.length
+  end
+  def test_simple__normal_objects
+    hash = {:a => 'abc'}
+    assert_equal 3,        hash[:a].__?.length
+  end
+
+  def test_chaining
+    hash = {}
+
+    assert_raise(NoMethodError)           { hash[:a]    .length * 4          }
+    assert_raise(NoMethodError)           { hash[:a]    [:b][:c]             }
+    assert_raise(NoMethodError)           { hash[:a]    [:b][:c].some_method }
+
+    assert_equal ChainableSafeNil.instance, hash[:a].__?.length * 4
+    assert_equal ChainableSafeNil.instance, hash[:a].__?[:b][:c]
+    assert_equal ChainableSafeNil.instance, hash[:a].__?[:b][:c].some_method
+
+    # But it needs to be chainable even if the *receiver* of __? isn't nil but something *later* down the chain is nil...
+    # (in this example, hash[:a] isn't nil, but hash[:a][:b] is, making it unsafe to evaluate hash[:a][:b][:c])
+    hash = { :a => {} }
+    assert_raise(NoMethodError)           { hash[:a]    [:b]    [:c] }
+    # Unfortunately, I don't know any way to make that possible!!!
+    assert_raise(NoMethodError)           { hash[:a].__?[:b]    [:c] }
+    # So one is left with calling __? for *anything* that might be nil...
+    assert_equal ChainableSafeNil.instance, hash[:a].__?[:b].__?[:c]
+    # ... which is what we were trying to avoid having to do! This means __? is *not* chainable and we may as well use the plain old _? / SafeNil.
+    # We have failed as programmers and may as well go home in shame.
+  end
+
+
+  def test_inspect
+    assert_equal 'ChainableSafeNil', nil.__?.inspect
+  end
+
+  def test_nil?
+    assert ChainableSafeNil.instance.nil?
+  end
+
+  def test_equality
+    assert_equal ChainableSafeNil.instance, ChainableSafeNil.instance
+    assert       ChainableSafeNil.instance.eql?( nil.__?.length )
+    assert       ChainableSafeNil.instance == nil.__?.length
+
+    assert ChainableSafeNil.instance == nil
+    # But:
+    assert nil != ChainableSafeNil.instance
+
+    # Why isn't this true?? Which == is getting called here?
+    #assert ChainableSafeNil.instance.send(:==, ChainableSafeNil.instance)
+  end
+
+  def test_does_not_permanently_modify_nil_class
+    assert_raise(NoMethodError) { nil.foo }
+    nil.__?
+    assert_raise(NoMethodError) { nil.foo }
+  end
+end
+=end
+
+
+
+# Alternative version #1:
+# (See note in safe_nil.rb)
+=begin
+class NilClass
+  def __?
+    n = nil
+    def n.method_missing(*args)
+      __?
+    end
+    n
+  end
+end
+=end
+

data/lib/quality_extensions/hash/delete_unless.rb

@@ -0,0 +1,41 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes.
+#++
+
+require "rubygems"
+
+class Hash
+  # call-seq:
+  #   hash.delete_unless {| key, value | block }  -> hash
+  #
+  # <tt>Hash#delete_unless</tt> is the opposite of <tt>Hash#delete_if</tt>: Deletes every key-value pair from <tt>hash</tt> _except_ those for which <tt>block</tt> evaluates to <tt>true</tt>.
+  #
+  def delete_unless(&block)
+    delete_if {|k, v|
+      !yield k, v
+    }
+  end
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+  def test_1
+    hash_copy = hash = {:a => 1, :b => 2}
+    assert_equal hash.delete_if     {|k,v| k != :b},
+                 hash.delete_unless {|k,v| k == :b}
+    assert_equal({:b => 2}, hash)
+  end
+end
+=end
+

data/lib/quality_extensions/hash/hash_select.rb

@@ -0,0 +1,45 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   Ruby License
+# Submit to Facets?:: Yes.
+#++
+
+require "rubygems"
+
+class Hash
+  # call-seq:
+  #   hash.hash_select {| key, value | block }  -> hash
+  #
+  # <tt>Hash#reject</tt> returns a hash. One would intuitively expect <tt>Hash#select</tt> to also return a hash. However, it doesn't: instead, returns "a new array consisting of <tt>[key,value]</tt> pairs for which the block returns true".
+  #
+  # <tt>Hash#hash_select</tt> behaves how <tt>Hash#select</tt> (arguably) _should_ behave: Deletes every key-value pair from a copy of <tt>hash</tt> _except_ those for which <tt>block</tt> evaluates to <tt>true</tt>.
+  #
+  def hash_select(&block)
+    reject {|k, v|
+      !yield k, v
+    }
+  end
+
+  alias_method :hash_find_all, :hash_select
+  alias_method :delete_unless, :hash_select
+end
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+  def test_1
+    hash_copy = hash = {:a => 1, :b => 2}
+    assert_equal hash.reject      {|k,v| k != :b},
+                 hash.hash_select {|k,v| k == :b}
+    assert_equal(hash_copy, hash)
+  end
+end
+=end

data/lib/quality_extensions/safe_nil.rb

@@ -0,0 +1,142 @@
+#--
+# Credits::    
+# * Tom Locke (http://hobocentral.net/blog/2007/08/25/quiz/) -- original version
+# * coderrr (http://coderrr.wordpress.com/2007/09/15/the-ternary-destroyer/) -- some optimizations
+# * Tyler Rick -- packaged it, added some documention, and added some tests
+# Copyright:: ?
+# License::   ?
+# Submit to Facets?:: Yes
+# Developer notes::
+#++
+
+
+
+
+require 'singleton'
+require 'rubygems'
+require 'facets/more/basicobject'
+
+
+class Object
+  def _?
+    self
+  end
+end
+
+class NilClass
+  # The _? method just returns the object itself for all objects except for nil. For nil, _? will return a special version of nil (actually, an instance of 
+  # SafeNil) that lets you call undefined methods.
+  #
+  # If you call an undefined method on nil._?, you will get back nil -- rather than raising an exception, which is what would happen if you called the same 
+  # method on a _plain_ old nil!
+  #
+  # _? gives us a much conciser alternative to this common pattern:
+  #   might_be_nil ? might_be_nil.some_method : nil
+  # or
+  #   (might_be_nil && might_be_nil.some_method)
+  #
+  # ... where might_be_nil is something that you hope is not nil most of the time, but which may on accosion be nil (and when it is, you don't want an exception
+  # to be raised!).
+  #
+  # For example, accessing a key from a hash:
+  #   (hash[:a] && hash[:a][:b] && hash[:a][:b].some_method)
+  #
+  # With _?, that simply becomes
+  #   hash[:a]._?[:b]._?.some_method)
+  #
+  def _?
+    SafeNil.instance
+  end
+end
+
+
+# Extending BasicObject because it provides us with a clean slate. It is similar to Object except it has almost all the standard methods stripped away so that
+# we will hit method_missing for almost all method routing.
+class SafeNil < BasicObject
+  include Singleton   # I assume this is because it's faster than instantiating a new object each time.
+
+  #undef inspect   # Use nil's version of inspect... although I wonder whether it would be better to have it return "SafeNil" so you know it's different than a normal nil.
+  def inspect
+    'SafeNil'
+  end
+
+  def method_missing(method, *args, &block)
+    return nil  unless nil.respond_to?(method)      # A much faster alternative to 'rescue nil' that can be used most of the time to speed things up.
+    nil.send(method, *args, &block) rescue nil
+  end
+
+  def nil?; true; end
+end
+
+
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class TheTest < Test::Unit::TestCase
+  def test_simple__nil
+    hash = {}
+    assert_equal nil,      hash[:a]._?.length
+  end
+  def test_simple__normal_objects
+    hash = {:a => 'abc'}
+    assert_equal 3,        hash[:a]._?.length
+  end
+
+  def test_chaining
+    hash = {}
+    assert_equal nil, hash[:a]._?.foo
+    assert_equal nil, hash[:a]._?[:b]._?[:c]
+    assert_equal nil, hash[:a]._?[:b]._?[:c]._?.some_method
+  end
+
+  def test_inspect
+    assert_equal 'SafeNil', nil._?.inspect
+  end
+
+  def test_nil?
+    assert SafeNil.instance.nil?
+  end
+
+  def test_does_not_permanently_modify_nil_class
+    assert_raise(NoMethodError) { nil.foo }
+    nil._?
+    assert_raise(NoMethodError) { nil.foo }
+  end
+end
+=end
+
+
+
+# Alternative version #1:
+# This version is so nice and simple -- I wish we could use it...
+# The problem with this implementation, however, is that it causes NilClass to be permanently modified with this new method_missing behavior.
+# In other words, once you call _? once on nil, all instances of nil will forever behave the same as nil._? !  (So you may as well just modify NilClass
+# directly.)
+# This might have to do with the fact that nil itself is a “singleton object” (according to http://corelib.rubyonrails.org/classes/NilClass.html)
+# Proof:
+#    puts nil.foo rescue p $!  # => <NoMethodError: undefined method `foo' for nil:NilClass>
+#    nil._?
+#    puts nil.foo rescue p $!  # => nil
+# Too bad... it was so simple.
+#
+=begin
+class NilClass
+  def _?
+    n = nil
+    def n.method_missing(*args)
+      nil
+    end
+    n
+  end
+end
+=end
+

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: quality_extensions
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
-date: 2007-07-18 00:00:00 -07:00
+  version: 0.1.4
+date: 2007-10-12 00:00:00 -07:00
 summary: A collection of reusable Ruby methods.
 require_paths: 
 - lib
@@ -29,103 +29,106 @@ post_install_message:
 authors: 
 - Tyler Rick and others
 files: 
-- lib/quality_extensions/global_variable_set.rb
-- lib/quality_extensions/collection_extensions_for_cgi.rb
-- lib/quality_extensions/template.rb
-- lib/quality_extensions/all.rb
-- lib/quality_extensions/month.rb
+- lib/quality_extensions/symbol/match.rb
+- lib/quality_extensions/symbol/constantize.rb
+- lib/quality_extensions/colored/toggleability.rb
+- lib/quality_extensions/console/command.rb
+- lib/quality_extensions/console/command.facets.1.8.51.rb
+- lib/quality_extensions/console/command.facets.1.8.54.rb
+- lib/quality_extensions/test/assert_includes.rb
 - lib/quality_extensions/test/assert_anything.rb
-- lib/quality_extensions/test/assert_exception.rb
 - lib/quality_extensions/test/assert_user_error.rb
-- lib/quality_extensions/test/assert_changed.rb
-- lib/quality_extensions/test/difference_highlighting.rb
+- lib/quality_extensions/test/assert_exception.rb
 - lib/quality_extensions/test/all.rb
-- lib/quality_extensions/test/assert_includes.rb
-- lib/quality_extensions/exception/inspect_with_backtrace.rb
-- lib/quality_extensions/colored/toggleability.rb
-- lib/quality_extensions/file_test/binary_file.rb
-- lib/quality_extensions/kernel/autoreload.rb
-- lib/quality_extensions/kernel/require_all.rb
-- lib/quality_extensions/kernel/simulate_input.rb
+- lib/quality_extensions/test/difference_highlighting.rb
+- lib/quality_extensions/test/assert_changed.rb
+- lib/quality_extensions/dir/each_child.rb
+- lib/quality_extensions/kernel/remove_const.rb
+- lib/quality_extensions/kernel/windows_platform.rb
 - lib/quality_extensions/kernel/die.rb
-- lib/quality_extensions/kernel/require_once.rb
-- lib/quality_extensions/kernel/require_local_all.rb
-- lib/quality_extensions/kernel/example_printer.rb
-- lib/quality_extensions/kernel/all.rb
 - lib/quality_extensions/kernel/filter_output.rb
+- lib/quality_extensions/kernel/remove_module.rb
+- lib/quality_extensions/kernel/all.rb
 - lib/quality_extensions/kernel/backtrace.rb
+- lib/quality_extensions/kernel/simulate_input.rb
+- lib/quality_extensions/kernel/require_local_all.rb
+- lib/quality_extensions/kernel/require_all.rb
+- lib/quality_extensions/kernel/require_once.rb
 - lib/quality_extensions/kernel/capture_output.rb
-- lib/quality_extensions/kernel/remove_module.rb
-- lib/quality_extensions/kernel/windows_platform.rb
-- lib/quality_extensions/kernel/remove_const.rb
+- lib/quality_extensions/kernel/example_printer.rb
 - lib/quality_extensions/kernel/trap_chain.rb
-- lib/quality_extensions/dir/each_child.rb
-- lib/quality_extensions/object/singleton_send.rb
-- lib/quality_extensions/object/mcall.rb
-- lib/quality_extensions/object/ancestry_of_method.rb
+- lib/quality_extensions/object/send_if.rb
 - lib/quality_extensions/object/send_if_not_nil.rb
-- lib/quality_extensions/object/ignore_access.rb
-- lib/quality_extensions/object/methods.rb
+- lib/quality_extensions/object/ancestry_of_method.rb
 - lib/quality_extensions/object/default.rb
-- lib/quality_extensions/object/send_if.rb
+- lib/quality_extensions/object/singleton_send.rb
+- lib/quality_extensions/object/methods.rb
+- lib/quality_extensions/object/ignore_access.rb
 - lib/quality_extensions/object/if_else.rb
-- lib/quality_extensions/file/exact_match_regexp.rb
-- lib/quality_extensions/date/iso8601.rb
-- lib/quality_extensions/date/deprecated.rb
-- lib/quality_extensions/date/all.rb
-- lib/quality_extensions/date/month_ranges.rb
-- lib/quality_extensions/time/deprecated.rb
+- lib/quality_extensions/object/mcall.rb
+- lib/quality_extensions/all.rb
+- lib/quality_extensions/safe_nil.rb
 - lib/quality_extensions/time/all.rb
-- lib/quality_extensions/regexp/join.rb
+- lib/quality_extensions/time/deprecated.rb
 - lib/quality_extensions/find/select.rb
-- lib/quality_extensions/mutex/if_available.rb
-- lib/quality_extensions/console/command.rb
-- lib/quality_extensions/console/command.facets.1.8.54.rb
-- lib/quality_extensions/console/command.facets.1.8.51.rb
-- lib/quality_extensions/module/guard_method.rb
-- lib/quality_extensions/module/ancestry_of_instance_method.rb
-- lib/quality_extensions/module/split.rb
+- lib/quality_extensions/regexp/join.rb
+- lib/quality_extensions/enumerable/enum.rb
+- lib/quality_extensions/enumerable/select_while.rb
+- lib/quality_extensions/enumerable/select_until.rb
+- lib/quality_extensions/hash/hash_select.rb
+- lib/quality_extensions/hash/all.rb
+- lib/quality_extensions/hash/to_date.rb
+- lib/quality_extensions/hash/delete_unless.rb
+- lib/quality_extensions/hash/to_query_string.rb
+- lib/quality_extensions/module/malias_method_chain.rb
+- lib/quality_extensions/module/remove_const.rb
+- lib/quality_extensions/module/namespace.rb
+- lib/quality_extensions/module/attribute_accessors.rb
+- lib/quality_extensions/module/dirname.rb
 - lib/quality_extensions/module/module_methods.rb
+- lib/quality_extensions/module/alias_method_chain.rb
+- lib/quality_extensions/module/bool_attr_accessor.rb
+- lib/quality_extensions/module/class_methods.rb
+- lib/quality_extensions/module/create_setter.rb
 - lib/quality_extensions/module/alias_method.rb
-- lib/quality_extensions/module/namespace.rb
-- lib/quality_extensions/module/malias_method_chain.rb
 - lib/quality_extensions/module/includable_once.rb
 - lib/quality_extensions/module/parents.rb
-- lib/quality_extensions/module/dirname.rb
-- lib/quality_extensions/module/basename.rb
-- lib/quality_extensions/module/create_setter.rb
-- lib/quality_extensions/module/alias_method_chain.rb
-- lib/quality_extensions/module/attribute_accessors.rb
+- lib/quality_extensions/module/split.rb
 - lib/quality_extensions/module/create.rb
-- lib/quality_extensions/module/bool_attr_accessor.rb
-- lib/quality_extensions/module/remove_const.rb
+- lib/quality_extensions/module/basename.rb
+- lib/quality_extensions/module/guard_method.rb
+- lib/quality_extensions/module/ancestry_of_instance_method.rb
 - lib/quality_extensions/module/join.rb
-- lib/quality_extensions/module/class_methods.rb
-- lib/quality_extensions/symbol/constantize.rb
-- lib/quality_extensions/symbol/match.rb
-- lib/quality_extensions/enumerable/select_while.rb
-- lib/quality_extensions/enumerable/select_until.rb
-- lib/quality_extensions/enumerable/enum.rb
-- lib/quality_extensions/hash/to_query_string.rb
-- lib/quality_extensions/hash/all.rb
-- lib/quality_extensions/hash/to_date.rb
-- lib/quality_extensions/array/expand_ranges.rb
-- lib/quality_extensions/array/shell_escape.rb
-- lib/quality_extensions/array/classify.rb
-- lib/quality_extensions/array/to_query_string.rb
+- lib/quality_extensions/mutex/if_available.rb
+- lib/quality_extensions/template.rb
+- lib/quality_extensions/array/group_by.rb
+- lib/quality_extensions/array/all.rb
 - lib/quality_extensions/array/sequence.rb
 - lib/quality_extensions/array/to_a_recursive.rb
-- lib/quality_extensions/array/all.rb
+- lib/quality_extensions/array/classify.rb
+- lib/quality_extensions/array/expand_ranges.rb
+- lib/quality_extensions/array/shell_escape.rb
 - lib/quality_extensions/array/average.rb
-- lib/quality_extensions/array/group_by.rb
-- lib/quality_extensions/string/digits_only.rb
-- lib/quality_extensions/string/shell_escape.rb
-- lib/quality_extensions/string/with_knowledge_of_color.rb
+- lib/quality_extensions/array/to_query_string.rb
+- lib/quality_extensions/global_variable_set.rb
+- lib/quality_extensions/exception/inspect_with_backtrace.rb
+- lib/quality_extensions/month.rb
 - lib/quality_extensions/string/md5.rb
 - lib/quality_extensions/string/to_underscored_label.rb
-- lib/quality_extensions/string/constantize.rb
 - lib/quality_extensions/string/all.rb
+- lib/quality_extensions/string/digits_only.rb
 - lib/quality_extensions/string/each_char_with_index.rb
+- lib/quality_extensions/string/with_knowledge_of_color.rb
+- lib/quality_extensions/string/shell_escape.rb
+- lib/quality_extensions/string/constantize.rb
+- lib/quality_extensions/collection_extensions_for_cgi.rb
+- lib/quality_extensions/file/exact_match_regexp.rb
+- lib/quality_extensions/chainable_safe_nil.rb
+- lib/quality_extensions/date/all.rb
+- lib/quality_extensions/date/iso8601.rb
+- lib/quality_extensions/date/month_ranges.rb
+- lib/quality_extensions/date/deprecated.rb
+- lib/quality_extensions/file_test/binary_file.rb
 - test/all.rb
 - Readme
 test_files: 

data/lib/quality_extensions/kernel/autoreload.rb

@@ -1,128 +0,0 @@
-# CREDIT Michael Neumann
-# CREDIT George Moschovitis
-
-module Kernel
-
-  # Autoreload feature files.
-  #
-  # Automatically reload, at regular intervals, any previously loaded features,
-  # and/or other files not already loaded, if they have been modified since the last
-  # interval check. A numeric parameter sets the reload interval in seconds
-  # and the file parameter can either be a glob string or an array
-  # of file paths. If a glob string, it is expanded only once on the initial
-  # method call. Supplying a boolean parameter of 'false' will force autreload to
-  # skip previously loaded features and only reload the specified files.
-  # Also keeps a "dirty" flag.
-
-  def autoreload( *args )
-
-    check_interval=10
-    include_features = true
-    files = nil
-
-    args.each do |arg|
-      case arg
-      when Numeric
-        check_interval = arg
-      when String
-        files = Dir.glob( arg )
-      when Array
-        files = arg
-      when TrueClass, FalseClass
-        include_features = arg
-      end
-    end
-
-    file_mtime = {}
-
-    Thread.new(Time.now) do |start_time|
-      loop do
-        sleep check_interval
-
-        if include_features
-          feature_files = $LOADED_FEATURES.collect { |feature|
-            $LOAD_PATH.each { |lp| file = File.join(lp, feature) }
-          }.flatten
-          p feature_files
-
-          feature_files.each { |file|
-            if File.exists?(file) and (mtime = File.stat(file).mtime) > (file_mtime[file] || start_time)
-              $autoreload_dirty = true
-              file_mtime[file] = mtime
-              STDERR.puts "File '#{ file }' reloaded"
-              begin
-                load(file)
-              rescue Exception => e
-                STDERR.puts e.inspect
-              end
-            end
-          }
-        end
-
-        if files
-          files.each do |file|
-            if File.exists?(file) and (mtime = File.stat(file).mtime) > (file_mtime[file] || start_time)
-              $autoreload_dirty = true
-              file_mtime[file] = mtime
-              STDERR.puts "File '#{ file }' changed"
-              begin
-                load(file)
-              rescue Exception => e
-                STDERR.puts e.inspect
-              end
-            end
-          end
-        end
-
-      end
-    end
-
-  end
-
-
-  # Same as #autoreload, but does not include previously loaded features.
-  # This is equivalent to as adding a 'false' parameter to #autoreload.
-
-  def autoreload_files( *args )
-    autoreload( false, *args )
-  end
-
-  # deprecate
-  alias_method :autoreload_glob, :autoreload_files
-
-end
-
-#--
-#   # OLD VERSION
-#   def autoreload(check_interval=10)
-#     Thread.new(Time.now) { |start_time|
-#       file_mtime = {}
-#       loop {
-#         sleep check_interval
-#         $LOADED_FEATURES.each { |feature|
-#           $LOAD_PATH.each { |lp|
-#             file = File.join(lp, feature)
-#             if (File.exists?(file) and
-#               File.stat(file).mtime > (file_mtime[file] || start_time))
-#               file_mtime[file] = File.stat(file).mtime
-#               STDERR.puts "reload #{ file }"
-#               begin
-#                 load(file)
-#               rescue Exception => e
-#                 STDERR.puts e.inspect
-#               end
-#             end
-#           }
-#         }
-#       }
-#     }
-#   end
-#++
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-# TODO