facets 1.1.0 → 1.2.0

data/lib/facets/core/nil_as_emptiness.rb

@@ -0,0 +1,34 @@
+
+# :title: NilClass as Emptiness/Nothingness
+#
+# The ideas here is to have nil act more like
+# an empty set than an error catcher.
+# So you get responses like
+#
+#   nil.include?(:x) # => nil
+#
+# instead of an error being raised.
+#
+# WARNING! One should be aware that in some rare cases
+# incompatabilites may arise when using these methods in
+# conjuction with other libraries.
+
+require 'facet/nilclass/to_f'
+require 'facet/nilclass/to_h'
+require 'facet/nilclass/op_fetch'
+require 'facet/nilclass/include'
+require 'facet/nilclass/empty'
+require 'facet/nilclass/size'
+#require 'facet/nilclass/length'
+
+# Effectively, the following is what happens:
+#
+# class NilClass
+#   def to_f; 0.0; end
+#   def to_h; {}; end
+#   def size; 0; end
+#   def length; 0; end
+#   def empty?; true; end
+#   def [](*args); nil; end
+#   def include?(*args); nil; end
+# end

data/lib/facets/core/nilclass.rb

@@ -0,0 +1,7 @@
+require 'facets/core/nilclass/empty'
+require 'facets/core/nilclass/include'
+require 'facets/core/nilclass/length'
+require 'facets/core/nilclass/op_fetch'
+require 'facets/core/nilclass/size'
+require 'facets/core/nilclass/to_f'
+require 'facets/core/nilclass/to_h'

data/lib/facets/core/nilclass/empty.rb

@@ -0,0 +1,32 @@
+
+class NilClass
+
+  # Allows <tt>nil</tt> to respond to #empty? method.
+  # Alwasy returns <tt>true</tt>.
+  #
+  #  nil.empty?   #=> true
+  #
+  def empty? ; true ; end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCNilClass < Test::Unit::TestCase
+
+    def test_empty?
+      assert( nil.empty? )
+    end
+
+  end
+
+=end

data/lib/facets/core/nilclass/include.rb

@@ -0,0 +1,32 @@
+
+class NilClass
+
+  # Allows <tt>nil</tt> to respond to #include? method.
+  # Alwasy returns <tt>nil</tt>.
+  #
+  #  nil.include?("abc")   #=> nil
+  #
+  def include?(*args); nil; end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCNilClass < Test::Unit::TestCase
+
+    def test_include?
+      assert_equal( nil, nil.include? )
+    end
+
+  end
+
+=end

data/lib/facets/core/nilclass/length.rb

@@ -0,0 +1,2 @@
+# stub
+require 'facet/nilclass/size'

data/lib/facets/core/nilclass/op_fetch.rb

@@ -0,0 +1,37 @@
+
+class NilClass
+
+  # Allows <tt>nil</tt> to respond to #[].
+  # Always returns nil.
+  #
+  #  nil[]   #=> nil
+  #
+  def [](*args)
+    nil
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCNilClass < Test::Unit::TestCase
+
+    def test_op_fetch
+      assert_equal( nil, nil[] )
+      assert_equal( nil, nil[1] )
+      assert_equal( nil, nil[1,2,3] )
+    end
+
+  end
+
+=end

data/lib/facets/core/nilclass/size.rb

@@ -0,0 +1,44 @@
+
+class NilClass
+
+  # Allows <tt>nil</tt> to respond to #size.
+  # Always returns <tt>0</tt>.
+  #
+  #  nil.size   #=> 0
+  #
+  def size; 0; end
+
+  # Allows <tt>nil</tt> to respond to #length.
+  # Always returns <tt>0</tt>.
+  #
+  #  nil.length   #=> 0
+  #
+  def length; 0; end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TC_NilClass < Test::Unit::TestCase
+
+    def test_length
+      assert_equal( 0, nil.length )
+    end
+
+    def test_size
+      assert_equal( 0, nil.size )
+    end
+
+  end
+
+=end

data/lib/facets/core/nilclass/to_f.rb

@@ -0,0 +1,32 @@
+
+class NilClass
+
+  # Returns zero float, similar to #to_i.
+  #
+  #  nil.to_f   #=> 0.0
+  #
+  def to_f; 0.0; end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCNilClass < Test::Unit::TestCase
+
+    def test_to_f
+      assert_equal( 0.0, nil.to_f )
+    end
+
+  end
+
+=end

data/lib/facets/core/nilclass/to_h.rb

@@ -0,0 +1,33 @@
+
+class NilClass
+
+  # Allows <tt>nil</tt> to create an empty hash,
+  # similar to #to_a and #to_s.
+  #
+  #  nil.to_h    #=> {}
+  #
+  def to_h; {}; end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCNilClass < Test::Unit::TestCase
+
+    def test_to_h
+      assert_equal( {}, nil.to_h )
+    end
+
+  end
+
+=end

data/lib/facets/core/numeric.rb

@@ -0,0 +1,5 @@
+require 'facets/core/numeric/ceil_multiple'
+require 'facets/core/numeric/distance'
+require 'facets/core/numeric/pred'
+require 'facets/core/numeric/succ'
+require 'facets/core/numeric/to_b'

data/lib/facets/core/numeric/ceil_multiple.rb

@@ -0,0 +1,40 @@
+#--
+# Credit goes to George Moschovitis
+#++
+
+class Numeric
+
+  # Returns the multiple ceil of a number.
+  def ceil_multiple(multiple)
+    # gmosx: to_f is needed!
+    # gmosx: IS THERE a more optimized way to do this?
+    return ((self.to_f/multiple).ceil*multiple)
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCNumeric < Test::Unit::TestCase
+
+    def test_ceil_multiple
+      assert_equal( 12.3, 12.3.ceil_multiple(0.1) )
+      assert_equal( 12.4, 12.31.ceil_multiple(0.1) )
+      assert_equal( 13, 12.3.ceil_multiple(1) )
+      assert_equal( 13, 12.31.ceil_multiple(1) )
+      assert_equal( 20, 12.3.ceil_multiple(10) )
+      assert_equal( 20, 12.31.ceil_multiple(10) )
+    end
+
+  end
+
+=end

data/lib/facets/core/numeric/pred.rb

@@ -0,0 +1,2 @@
+# stub
+require 'facet/numeric/succ'

data/lib/facets/core/numeric/succ.rb

@@ -0,0 +1,69 @@
+
+class Numeric
+
+  # Allows #succ to take _n_ increments.
+  #
+  #   3.succ(2)  #=> 5
+  #
+  def succ(n=nil)
+    n ||= 1
+    self + n
+  end
+
+  # Provides #pred as the opposite of #succ.
+  #
+  #   3.pred(2)  #=> 1
+  #
+  def pred(n=nil)
+    n ||= 1
+    self - n
+  end
+
+end
+
+
+class Integer
+
+  # This is needed to allow Integer to look back to
+  # its Numeric ancestor for the new definition of #succ.
+  #if instance_methods(false).include?( :succ )
+    remove_method( :succ )
+  #end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCNumeric < Test::Unit::TestCase
+
+    def test_pred
+      assert_equal(  3,  4.pred )
+      assert_equal( -3, -2.pred )
+      assert_equal(  2,  4.pred(2) )
+      assert_equal( -4, -2.pred(2) )
+      assert_equal(  6,  4.pred(-2) )
+      assert_equal(  0, -2.pred(-2) )
+    end
+
+    def test_succ
+      assert_equal(  5,  4.succ )
+      assert_equal( -1, -2.succ )
+      assert_equal(  6,  4.succ(2) )
+      assert_equal(  0, -2.succ(2) )
+      assert_equal(  2,  4.succ(-2) )
+      assert_equal( -4, -2.succ(-2) )
+    end
+
+  end
+
+=end

data/lib/facets/core/numeric/to_b.rb

@@ -0,0 +1,38 @@
+
+class Numeric
+
+  # Provides a boolean interpretation of self.
+  # If self == 0 then false else true.
+  #
+  #   0.to_b    #=> false
+  #   1.to_b    #=> true
+  #   2.3.to_b  #=> true
+  #
+  def to_b
+    self == 0 ? false : true
+  end
+
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TCNumeric < Test::Unit::TestCase
+
+    def test_to_b
+      assert_equal( false, 0.to_b )
+      assert_equal( true, 1.to_b )
+    end
+
+  end
+
+=end

data/lib/facets/core/ostruct/__merge__.rb

@@ -0,0 +1,52 @@
+
+require 'ostruct'
+require 'facet/ostruct/__update__'
+
+class OpenStruct
+
+  # Merge hash data creating a new OpenStruct object.
+  #
+  #   o = OpenStruct.new
+  #   o.ostruct_merge { :a => 2 }
+  #   o.a  #=> 2
+  #
+  def __merge__( other )
+    o = dup
+    o.__update__( other )
+    o
+  end
+
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+
+  require 'test/unit'
+
+  class TC_OpenStruct < Test::Unit::TestCase
+
+    def test_merge_1
+      o = OpenStruct.new( { :a => 1 } )
+      h = { :b => 2 }
+      q = o.__merge__( h )
+      assert_equal( 1, q.a )
+      assert_equal( 2, q.b )
+    end
+
+    def test_merge_2
+      o1 = OpenStruct.new( { :a => 1 } )
+      o2 = OpenStruct.new( { :b => 2 } )
+      q = o1.__merge__( o2 )
+      assert_equal( 1, q.a )
+      assert_equal( 2, q.b )
+    end
+
+  end
+
+=end