quality_extensions 1.1.6 → 1.3.0

data/lib/quality_extensions/kernel/filter_output.rb

@@ -4,6 +4,7 @@
 # License::   Ruby License
 # Submit to Facets?:: Yes.
 # Developer notes:
+# To do: write an add_prefix_to_output method based on this that prefixes all lines output with some string, to help group them together when looking through a long log file
 #++
 
 require 'stringio'

data/lib/quality_extensions/kernel/require_all.rb

@@ -9,8 +9,8 @@ $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
 require 'rubygems'
 require 'facets/filelist'
 
-require 'facets/kernel/require_local'
-require_local '../file/exact_match_regexp'
+require 'facets/kernel/require_relative'
+require_relative '../file/exact_match_regexp'
 
 module Kernel
 
@@ -60,7 +60,7 @@ module Kernel
   #
   # All of the +options+ available for +require_all+ are still available here.
   #
-  def require_local_all(dir = './', options = {})
+  def require_relative_all(dir = './', options = {})
     raise ArgumentError.new("dir must be a String") unless dir.is_a?(String)
     local_dir = File.dirname( caller[0] )
     require_all(
@@ -86,7 +86,7 @@ require 'English'
 class TheTest < Test::Unit::TestCase
   def setup
     @base_dir = "#{Dir.tmpdir}/require_all_test"
-    @base_local_dir = File.dirname(__FILE__) # To allow testing of require_local_all. But tests should put everything in "#{@base_local_dir}/require_all_test" to avoid clutter or name conflicts with other files!
+    @base_local_dir = File.dirname(__FILE__) # To allow testing of require_relative_all. But tests should put everything in "#{@base_local_dir}/require_all_test" to avoid clutter or name conflicts with other files!
     FileUtils.mkdir              @base_dir
     @deep_dir = "really/really/deep/subdir"
     $loaded = []
@@ -137,11 +137,11 @@ class TheTest < Test::Unit::TestCase
     assert_equal ['require_me.rb'], $loaded
   end
 
-  def test_require_local_all
+  def test_require_relative_all
     create_ruby_file 'require_all_test/lib/require_me.rb', @base_local_dir
     create_ruby_file 'require_all_test/lib/please_ignore_me.rb', @base_local_dir
 
-    require_local_all 'require_all_test/lib', :exclude => [/ignore/]
+    require_relative_all 'require_all_test/lib', :exclude => [/ignore/]
     assert_equal ['require_all_test/lib/require_me.rb'], $loaded
   end
 
@@ -172,7 +172,7 @@ class TheTest < Test::Unit::TestCase
     #require_all File.dirname(@base_dir), :exclude => [/^all\.rb$/]
     # This works, but it's too much to expect users to type out!:
     #require_all File.dirname(@base_dir), :exclude => [/(\/|^)all\.rb$/]
-    
+
     # So...... I added an :exclude_files option so that people wouldn't have to!
     require_all File.dirname(@base_dir), :exclude_files => ['all.rb']
 

data/lib/quality_extensions/module/guard_method.rb

@@ -14,8 +14,8 @@
 $LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
 require 'rubygems'
 require 'quality_extensions/module/attribute_accessors'
-require 'facets/kernel/require_local'
-require_local 'bool_attr_accessor'
+require 'facets/kernel/require_relative'
+require_relative 'bool_attr_accessor'
 #require 'quality_extensions/module/bool_attr_accessor'
 require 'quality_extensions/symbol/match'
 
@@ -33,7 +33,7 @@ class Module
   #     # Section of code during which you don't want any stupid stuff to happen
   #   end                          # Causes @stupid_stuff_disabled to be set back to false
   #   # Okay, a, you can resume doing stupid stuff again...
-  #   
+  #
   # If you want your guard method to *disable* the flag rather than *enable* it, simply pass false to the guard method.
   #
   # These calls can be nested however you wish:

data/lib/quality_extensions/object/non.rb

@@ -1,12 +1,18 @@
+
 class Object
-  def nonblank?
-    !blank?
+  def nonnil?
+    !nil?
   end
 end
 
 class Object
-  def nonnil?
-    !nil?
+  def nonempty?
+    !empty?
   end
 end
 
+class Object
+  def nonblank?
+    !blank?
+  end
+end

data/lib/quality_extensions/pathname.rb

@@ -4,7 +4,7 @@
 # Copyright:: Copyright (c) 2009, Tyler Rick
 # License::   Ruby License
 # Submit to Facets?::
-# Developer notes:: 
+# Developer notes::
 # * Make a patch to actual pathname source.
 # * document all Pathname methods better, copying from docs for delegated class if necessary, but NOT just saying 'See FileTest.file?.' How useless that is to have to keep flipping back and forth referring to like 4 different classes!
 # History::
@@ -18,6 +18,54 @@
 #++
 
 
+
+# TODO: How much of this stuff already exists as private methods??
+#
+#  # chop_basename(path) -> [pre-basename, basename] or nil
+#  def chop_basename(path)
+#    base = File.basename(path)
+#    if /\A#{SEPARATOR_PAT}?\z/ =~ base
+#      return nil
+#    else
+#      return path[0, path.rindex(base)], base
+#    end
+#  end
+#  private :chop_basename
+#
+#  # split_names(path) -> prefix, [name, ...]
+#  def split_names(path)
+#    names = []
+#    while r = chop_basename(path)
+#      path, basename = r
+#      names.unshift basename
+#    end
+#    return path, names
+#  end
+#  private :split_names
+#
+#  def prepend_prefix(prefix, relpath)
+#    if relpath.empty?
+#      File.dirname(prefix)
+#    elsif /#{SEPARATOR_PAT}/ =~ prefix
+#      prefix = File.dirname(prefix)
+#      prefix = File.join(prefix, "") if File.basename(prefix + 'a') != 'a'
+#      prefix + relpath
+#    else
+#      prefix + relpath
+#    end
+#  end
+#  private :prepend_prefix
+#
+
+
+
+
+
+
+
+
+
+
 require 'pathname'
 require 'tempfile'
 
@@ -71,7 +119,7 @@ class Pathname
     Pathname.new(new_path)
   end
   alias_method :move, :mv
-  
+
   # Copies self to +dest+ using FileUtils.cp.
   #
   # See documentation for FileUtils.cp for a list of valid +options+.
@@ -84,7 +132,7 @@ class Pathname
   end
   alias_method :copy, :cp
 
-  # Copies self to +dest+ using FileUtils.cp_r. If self is a directory, this method copies all its contents recursively. If +dest+ is a directory, copies self to +dest/src+. 
+  # Copies self to +dest+ using FileUtils.cp_r. If self is a directory, this method copies all its contents recursively. If +dest+ is a directory, copies self to +dest/src+.
   #
   # See documentation for FileUtils.cp_r for a list of valid +options+.
   #

data/lib/quality_extensions/regexp/named_captures.rb

@@ -1,6 +1,7 @@
 # http://tfletcher.com/lib/named_captures.rb
 require 'strscan'
 
+# TODO: require the file that defines this instead
 class Module
   # c.f. ActiveSupport
   def alias_method_chain(target, feature)
@@ -13,7 +14,7 @@ end
 
 class MatchData
   attr_accessor :capture_names
-  
+
   def method_missing(capture_name, *args, &block)
     if index = capture_names.index(capture_name)
       return self[index + 1]
@@ -37,10 +38,10 @@ class Regexp
   end
 
   private
-  
+
   def extract_capture_names_from(pattern)
     names, scanner, last_close = [], StringScanner.new(pattern), nil
-    
+
     while scanner.skip_until(/\(/)
       next if scanner.pre_match =~ /\\$/
 
@@ -51,7 +52,7 @@ class Regexp
       else
         names << :capture
       end
-      
+
       while scanner.skip_until(/[()]/)
         if scanner.matched =~ /\)$/
           (names.size - 1).downto(0) do |i|
@@ -66,14 +67,14 @@ class Regexp
         end
       end
     end
-    
+
     return names
   end
 end
 
 if __FILE__ == $0 then
   require 'test/unit'
-  
+
   class NamedCapturesTest < Test::Unit::TestCase
     def test_escaped_brackets_are_ignored
       assert /\(\)\(\)/.capture_names.empty?

data/lib/quality_extensions/regexp/to_plain_s.rb

@@ -0,0 +1,116 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2009 Tyler Rick
+# License::   Ruby License
+# Submit to Facets?:: Yes.
+# Developer notes::
+#++
+
+
+class Regexp
+  def self.to_plain_s(input, also_unescape = nil)
+    input.
+    gsub(/((?<!\\)(\\\\)*)\(((?=\?[^):]*:)\?[^):]*:)?/, '\1').   # remove all unescaped '('s and any '?-mix:b-style prefix that their contents begin with
+    gsub(/((?<!\\)(\\\\)*)[)?*+\[\]]/, '\1').                    # remove all unescaped ')', '?', '*', etc.es
+    gsub(/((?<!\\)(\\\\)*)\{.*\}/, '\1').                        # remove all unescaped /{.*}/
+    gsub(/((?<!\\)(\\\\)*)\\([().\/#{also_unescape}])/, '\1\3').                    # unescape any remaining (escaped) '\(', '\)', '\.', etc.es
+    gsub(/\\\\/, '\\')
+  end
+
+  # Sometimes you don't want to see a [serialized] version of the regular expression:
+  #   /a/.to_s       => '(?-mix:a)'
+  # and you simply want a simple, human-readable version:
+  #   /a/.to_plain_s => 'a'
+  #
+  # Since the Regexp object doesn't know what it was delimited with, to_plain_s can't know which
+  # delimiter character, if any, it should try to unescape.
+  #
+  # %r#a\#b#.to_plain_s('#') # => "a#b"
+  # %r#a\#b#.to_plain_s      # => "a\\#b"
+  #
+  # An escaped '/' will always be unescaped, since Ruby escapes for you even when you don't:
+  #   /a\/b/.to_plain_s      # => 'a/b'
+  # %r#a\/b#.to_plain_s      # => 'a/b'
+  # %r#a/b#. to_plain_s      # => "a/b"
+  #
+  def to_plain_s(also_unescape = nil)
+    Regexp.to_plain_s(self.to_s, also_unescape)
+  end
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'spec/autorun'
+
+describe 'Regexp#to_plain_s' do
+  it "removes '?-mix:' prefix" do
+    /a/.to_plain_s.should == 'a'
+  end
+
+  it "removes unescaped ()" do
+    /(a)bc/.to_plain_s.should == 'abc'
+  end
+
+  it "removes unescaped ?, *, +" do
+    /a?b*c+/.to_plain_s.should == 'abc'
+  end
+
+  it "removes unescaped /{3}/" do
+    /a{3}bc/.to_plain_s.should == 'abc'
+    /a{1,3}bc/.to_plain_s.should == 'abc'
+  end
+
+  it "unescapes escaped ()'s correctly" do
+    #                        1       1 2   1 2
+    Regexp.to_plain_s( "(a) \\(b\\) \\\\(c\\\\)" ).should ==
+    "a (b) \\c\\"
+
+    #    1  1  12  12
+    /(a) \(b\) \\(c\\)/.to_plain_s.should ==
+    "a (b) \\c\\"
+
+    #                        1   1   1 2   1 2   1 2 3   1 2 3   1 2 3 4   1 2 3 4   1 2 3 4 5   1 2 3 4 5
+    Regexp.to_plain_s( "(a) \\(b\\) \\\\(c\\\\) \\\\\\(d\\\\\\) \\\\\\\\(e\\\\\\\\) \\\\\\\\\\(f\\\\\\\\\\)" ).should ==
+    #       1  1  1   1   1 2  1 2  1 2   1 2
+    "a (b) \\c\\ \\(d\\) \\\\e\\\\ \\\\(f\\\\)"
+
+    #    1  1  12  12  123  123  1234  1234  12345  12345
+    /(a) \(b\) \\(c\\) \\\(d\\\) \\\\(e\\\\) \\\\\(f\\\\\)/.to_plain_s.should ==
+    #       1  1  1   1   1 2  1 2  1 2   1 2
+    "a (b) \\c\\ \\(d\\) \\\\e\\\\ \\\\(f\\\\)"
+  end
+
+  it "unescapes escaped /'s, iff they tell us that they need to be unescaped" do
+      /a\/b/.to_plain_s.     should == 'a/b'
+    %r#a\#b#.to_plain_s.     should == "a\\#b"
+    %r#a\#b#.to_plain_s('#').should == "a#b"
+    %r#a\/b#.to_plain_s.     should == 'a/b'
+    %r#a/b#. to_plain_s.     should == "a/b"
+  end
+
+  it "unescapes escaped .'s" do
+    /a\.b/.to_plain_s.should == 'a.b'
+  end
+
+  it 'matches the original regexp' do
+    (r=/a/).to_plain_s.should match(r)
+    (r=/(a)bc/).to_plain_s.should match(r)
+    (r=/a?b*c+/).to_plain_s.should match(r)
+    (r=/a{1}bc/).to_plain_s.should match(r)
+    (r=/(a) \(b\) \\(c\\)/).to_plain_s.should match(r)
+    (r=/(a) \(b\) \\(c\\) \\\(d\\\) \\\\(e\\\\) \\\\\(f\\\\\)/).to_plain_s.should match(r)
+
+    # Cannot handle the following cases:
+    #(r=/a{3}bc/).to_plain_s.should match(r)
+    #(r=/a{1,3}bc/).to_plain_s.should match(r)
+  end
+end
+
+=end
+

data/lib/quality_extensions/safe_method.rb

@@ -0,0 +1,100 @@
+#--
+# 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::
+#++
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+require 'singleton'
+require 'rubygems'
+require 'builder/blankslate'
+#require 'facets/basicobject'
+#puts Object.methods.include?(:blank_slate_method_added) # not there?
+
+
+class Object
+  # not sure if receiver responds_to?
+  def _r?(*args)
+    if respond_to(args[0])
+      send *args
+    else
+      nil
+    end
+  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
+