facets 2.1.3 → 2.2.0

data/lib/core/facets/integer/bitmask.rb

@@ -1,36 +1,20 @@
-# = Bitmask
-#
-# Bitmask extends the Integer class to allow for easy manipulation
-# of a number as a bit field.
-#
-# == Examples
-#
-#   0xb0100.bit(-3)  #=> 0
-#
-# == Authors and Contributors
-#
-# * George Moschovitis
-# * Thomas Sawyer
-#
-# == Copyright (c) 2005 George Moschovitis
-#
-#   Ruby License
-#
-#   This module is free software. You may use, modify, and/or redistribute this
-#   software under the same terms as Ruby.
-#
-#   This program is distributed in the hope that it will be useful, but WITHOUT
-#   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-#   FOR A PARTICULAR PURPOSE.
-
-#
 class Integer
 
-  # Bit.
+  # Set a bit.
+  #
+  #   0.bit!(4)  #=> 8
+  #
+  # Using an inverted bit will clear a bit.
+  #
+  #   10.bit!(~3)      #=> 2
+  #   0xb0100.bit(~3)  #=> 0
+  #
+  #   CREDIT: Thomas Sawyer
+  #   CREDIT: George Moschovitis
 
-  def bit!(bit)
+  def bit(bit)
     if bit < 0
-      mask = (1 << bit)
+      mask = (1 << ~bit)
       self & ~mask
     else
       mask = (1 << bit)
@@ -38,104 +22,83 @@ class Integer
     end
   end
 
-  def bit?(bit)
-    mask = (1 << bit)
-    (self & mask) != 0
-  end
-
-  def bitmask!(mask)
-    if mask < 0
-      self & ~mask
-    else
-      self | mask
-    end
-  end
-
-  def bitmask?(mask)
-    (self & mask) != 0
-  end
-
-  # TODO The following may be deprecated.
+  # Old name. Probably will be deprecated.
+  alias_method :bit!, :bit
 
+  # Clear bit.
   #
-  def set_bit(bit)
-    mask = (1 << bit)
-    self | mask
-  end
+  #   CREDIT: George Moschovitis
 
   def clear_bit(bit)
     mask = (1 << bit)
     self & ~mask
   end
 
-  alias_method :test_bit, :bit?
-  alias_method :bit_set?, :bit?
-
-  def set_bitmask(mask)
-    self | mask
-  end
+  # Is a bit set?
+  #
+  #   8.bit?(3)  #=> true
+  #   8.bit?(2)  #=> false
+  #
+  #   CREDIT: Thomas Sawyer
+  #   CREDIT: George Moschovitis
 
-  def clear_bitmask(mask)
-    self & ~mask
+  def bit?(bit)
+    mask = (1 << bit)
+    (self & mask) != 0
   end
 
-  alias_method :test_bitmask, :bitmask?
+  # Apply a bitmask.
+  #
+  #   1.bitmask(6) #=> 7
+  #
+  # Using a inverted bitmask clears bits.
+  #
+  #   7.bitmask(~2) #=> 5
+  #   5.bitmask(~2) #=> 5
+  #
+  #   CREDIT: George Moschovitis
 
-end
+  def bitmask(mask)
+    if mask < 0
+      self & mask
+    else
+      self | mask
+    end
+  end
 
+  # Old name. Probably will be deprecated.
+  alias_method :bitmask!, :bitmask
 
-module Kernel
+  # Is bitmask set?
+  #
+  #   7.bitmask?(7) #=> true
+  #   7.bitmask?(5) #=> true
+  #   8.bitmask?(3) #=> false
+  #
+  #   CREDIT: George Moschovitis
 
-  def bitmask(bit)
-    1 << bit
+  def bitmask?(mask)
+    (self & mask) != 0
   end
 
 end
 
 
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-
-=begin test
-
-  require 'test/unit'
-
-  class TestIntegerBitmask < Test::Unit::TestCase
-
-    def test_001
-      assert_equal( 1, 0.set_bit(0) )
-      assert_equal( 2, 0.set_bit(1) )
-      assert_equal( 4, 0.set_bit(2) )
-      assert_equal( 8, 0.set_bit(3) )
-    end
-
-    def test_002
-      assert_equal( 0, 1.clear_bit(0) )
-      assert_equal( 0, 2.clear_bit(1) )
-      assert_equal( 0, 4.clear_bit(2) )
-      assert_equal( 0, 8.clear_bit(3) )
-    end
+module Kernel
 
-    def test_003
-      a =  1
-      m = bitmask(4)
-      a = a.set_bitmask(m)
-      assert_equal( 17, a )
-      assert( a.test_bitmask(m) )
-      assert( a.test_bit(4) )
-      assert( a.bit_set?(4) )
-      assert( ! a.test_bit(12) )
-    end
+  # Create a single bit bitmask.
+  #
+  #   Bit(0)  #=> 1
+  #   Bit(1)  #=> 2
+  #   Bit(2)  #=> 4
+  #
+  # This is equivalent to n-shift: "1 << n".
+  #
+  #   CREDIT: Thomas Sawyer
+  #   CREDIT: George Moschovitis
 
+  def Bit(n)
+    1 << Integer(n)
   end
 
-=end
-
-
-# Author::    George Moschovitis
-# Copyright:: Copyright (c) 2005 George Moschovitis
-# License::   Ruby License
+end

data/lib/core/facets/integer/factorial.rb

@@ -1,17 +1,3 @@
-# = FILE
-#
-#   interger/factorial.rb
-#
-# = DESCRIPTION
-#
-#   Factorial extension for Integer class.
-#
-# = AUTHORS
-#
-#   CREDIT Malte Milatz
-
-#
-
 class Integer
 
   # Calculate the factorial of an integer.
@@ -20,6 +6,7 @@ class Integer
   #   3.factorial  #=> 6
   #   3.factorial  #=> 24
   #
+  #  CREDIT: Malte Milatz
 
   def factorial
     return 1 if zero?
@@ -28,11 +15,7 @@ class Integer
     f
   end
 
-  #--
-  # TODO Pick one of these and deprecate the other. But which?
-  #++
   alias_method( :fac, :factorial )
-  alias_method( :fact, :factorial )
 
   #-- OLD CODE
   #def factorial
@@ -44,29 +27,3 @@ class Integer
   #++
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TCInteger < Test::Unit::TestCase
-
-    def test_factorial
-      assert_equal(  1, 0.factorial )
-      assert_equal(  1, 1.factorial )
-      assert_equal(  2, 2.factorial )
-      assert_equal(  6, 3.factorial )
-      assert_equal( 24, 4.factorial )
-    end
-
-  end
-
-=end

data/lib/core/facets/integer/multiples.rb

@@ -1,28 +1,32 @@
 class Integer
 
-  # Returns true if this integer is odd, false otherwise.
-  #
-  #   2.odd?            #=> false
-  #   3.odd?            #=> true
-  #
-  #   -99.odd?          # -> true
-  #   -98.odd?          # -> false
-  #
-  #   CREDIT Gavin Sinclair
-
-  def odd?
-    self % 2 == 1
-  end
-
-  # Returns true if this integer is even, false otherwise.
-  #
-  #   2.even?  #=> true
-  #   3.even?  #=> false
-  #
-  #   CREDIT Gavin Sinclair
+  unless (RUBY_VERSION[0,3] == '1.9')
+
+    # Returns true if this integer is odd, false otherwise.
+    #
+    #   2.odd?            #=> false
+    #   3.odd?            #=> true
+    #
+    #   -99.odd?          # -> true
+    #   -98.odd?          # -> false
+    #
+    #   CREDIT: Gavin Sinclair
+
+    def odd?
+      self % 2 == 1
+    end
+
+    # Returns true if this integer is even, false otherwise.
+    #
+    #   2.even?  #=> true
+    #   3.even?  #=> false
+    #
+    #   CREDIT: Gavin Sinclair
+
+    def even?
+      self % 2 == 0
+    end
 
-  def even?
-    self % 2 == 0
   end
 
   # Is is a multiple of a given number?
@@ -30,6 +34,7 @@ class Integer
   #   7.multiple?(2)  #=> false
   #   8.multiple?(2)  #=> true
   #
+  #  CREDIT: Trans
 
   def multiple?(number)
     self % number == 0

data/lib/core/facets/integer/of.rb

@@ -1,5 +1,3 @@
-
-#
 class Integer
 
   # Like #times but returns a collection of the yield results.
@@ -7,6 +5,7 @@ class Integer
   #   a = 3.of { |i| "#{i+1}" }
   #   a => [ "1", "2", "3" ]
   #
+
   def of(&block)
     Array.new(self, &block)
   end
@@ -21,34 +20,3 @@ class Integer
   alias_method :times_map, :of
 
 end
-
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestIntegerEnumerate < Test::Unit::TestCase
-
-    def test_of
-      a = 4
-      b = a.of{ |i| i*2 }
-      assert_equal( [0,2,4,6], b )
-    end
-
-    def test_times_collect
-      a = 4
-      b = a.times_collect{ |i| i*2 }
-      assert_equal( [0,2,4,6], b )
-    end
-
-  end
-
-=end

data/lib/core/facets/kernel.rb

@@ -1,10 +1,8 @@
-require 'facets/kernel/require_esc.rb'
 require 'facets/kernel/callstack.rb'
 require 'facets/kernel/super.rb'
 require 'facets/kernel/val.rb'
 require 'facets/kernel/metaid.rb'
 require 'facets/kernel/instance.rb'
-require 'facets/kernel/tap.rb'
 require 'facets/kernel/ergo.rb'
 require 'facets/kernel/object.rb'
 require 'facets/kernel/withattr.rb'
@@ -18,4 +16,8 @@ require 'facets/kernel/ask.rb'
 require 'facets/kernel/respond.rb'
 require 'facets/kernel/silence.rb'
 require 'facets/kernel/report.rb'
+require 'facets/kernel/returning.rb'
+
+# remove for 1.9
+require 'facets/kernel/tap.rb'
 

data/lib/core/facets/kernel/ask.rb

@@ -1,10 +1,22 @@
 module Kernel
 
-  private
+  module_function
 
-  # Convenience method to get simple console reply.
+  # Very simple convenience method to get a console reply.
+  #
+  #   ask "Are you happy?", "Yn"
+  #
+  # On the command line one would see.
+  #
+  #   $ Are you happy? [Yn]
+  #
+  # Responding:
+  #
+  #   $ Are you happy? [Yn] Y <ENTER>
+  #
+  # The ask method would return "Y".
 
-  def ask( question, answers=nil )
+  def ask(question, answers=nil)
     print "#{question}"
     print " [#{answers}] " if answers
     until inp = $stdin.gets ; sleep 1 ; end ; puts

data/lib/core/facets/kernel/callstack.rb

@@ -1,22 +1,10 @@
-# TITLE:
-#
-#   Callstack Methods
-#
-# FILE:
-#
-#   kernel/callstack.rb
-#
-# DESCRIPTION:
-#
-#   Kernel extensions related to cflow.
-#
-# AUTHORS:
-#
-#   CREDIT Thomas Sawyer
-
-#
 module Kernel
 
+  unless (RUBY_VERSION[0,3] == '1.9')
+
+
+  end
+
   alias_method :pp_call_stack, :caller
 
   # Parse a caller string and break it into its components,
@@ -39,6 +27,8 @@ module Kernel
   # in a different format, _prior_ to requiring this, then the
   # results will be indeterminate.
   #
+  #   CREDIT: Trans
+
   def call_stack( level = 1 )
     call_str_array = pp_call_stack(level)
     stack = []
@@ -54,66 +44,45 @@ module Kernel
 
   private
 
-  # Retreive the current running method name.
-  # There is a lot of debate on what to call this.
-  # #called differs from #method_name only by the fact
-  # that it returns a symbol, rather then a string.
-  #
-  #   def tester; called; end
-  #   tester  #=> :tester
-  #
-  def called
-    /\`([^\']+)\'/.match(caller(1).first)[1].to_sym
-  end
 
-  # Retreive the current running method name.
-  #
-  # There is a lot of debate on what to call this.
-  # #me returns a symbol, not a string.
-  #
-  #   def tester; __method__; end
-  #   tester  #=> :tester
-  #
-  def callee
-    /\`([^\']+)\'/.match(caller(1).first)[1].to_sym
-  end
+  if (RUBY_VERSION[0,3] == '1.9')
 
-  # Technically __callee__ should provided alias names,
-  # where __method__ should not. But we'll have to
-  # leave that distinction to Ruby 1.9+.
+    alias_method :callee, :__callee__
+    alias_method :called, :__callee__
 
-  alias_method :__callee__, :callee
-  alias_method :__method__, :callee
+  else
 
-end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TCKernel < Test::Unit::TestCase
-
-    def test_call_stack
-      assert_nothing_raised{ call_stack }
+    # Retreive the current running method name.
+    # There is a lot of debate on what to call this.
+    # #called differs from #method_name only by the fact
+    # that it returns a symbol, rather then a string.
+    #
+    #   def tester; called; end
+    #   tester  #=> :tester
+    #
+    def called
+      /\`([^\']+)\'/.match(caller(1).first)[1].to_sym
     end
 
-    def test_called
-      assert_equal( :test_called, called )
+    # Retreive the current running method name.
+    #
+    # There is a lot of debate on what to call this.
+    # #me returns a symbol, not a string.
+    #
+    #   def tester; __method__; end
+    #   tester  #=> :tester
+    #
+    def callee
+      /\`([^\']+)\'/.match(caller(1).first)[1].to_sym
     end
 
-    def test_method_name
-      assert_equal( "test_method_name", callee.to_s )
-    end
+    # Technically __callee__ should provided alias names,
+    # where __method__ should not. But we'll have to
+    # leave that distinction to Ruby 1.9+.
 
-  end
+    alias_method :__callee__, :called
+    alias_method :__method__, :called
 
-=end
+  end
 
+end