facets 2.1.3 → 2.2.0

data/lib/core/facets/array/rotate.rb

@@ -11,8 +11,8 @@ class Array
   #
   #   [1,2,3].rotate(-1)  #=> [2,3,1]
   #
-  #   CREDIT Florian Gross
-  #   CREDIT Thomas Sawyer
+  #   CREDIT: Florian Gross
+  #   CREDIT: Thomas Sawyer
 
   def rotate(n=1)
     self.dup.rotate!(n)
@@ -24,8 +24,8 @@ class Array
   #   a.rotate!
   #   a  #=> [3,1,2]
   #
-  #   CREDIT Florian Gross
-  #   CREDIT Thomas Sawyer
+  #   CREDIT: Florian Gross
+  #   CREDIT: Thomas Sawyer
 
   def rotate!(n=1)
     n = n.to_int

data/lib/core/facets/array/select.rb

@@ -5,6 +5,8 @@ class Array
   #   a = [1,2,3,4,5,6,7,8,9,10]
   #   a.select!{ |e| e % 2 == 0 }
   #   a  #=> [2,4,6,8,10]
+  #
+  #   CREDIT: Gavin Sinclair
 
   def select!  # :yield:
     reject!{ |e| not yield(e) }

data/lib/core/facets/array/splice.rb

@@ -1,9 +1,23 @@
 class Array
 
+  # Store a value at a givne index.
+  # Store is an alias for #[]=.
+
   alias_method :store, :[]=
 
-  # Like #store, but acts like slice!
-  # when given only one argument.
+  # Splice acts a combination of #slice! and #store.
+  # If two arguments are given it calls #store.
+  # If a single argument is give it calls slice!.
+  #
+  #   a = [1,2,3]
+  #   a.splice(1)    #=> 2
+  #   a              #=> [1,3]
+  #
+  #   a = [1,2,3]
+  #   a.splice(1,4)  #=> 4
+  #   a              #=>[1,4,3]
+  #
+  #   CREDIT: Trans
 
   def splice(*args)
     if args.size == 1

data/lib/core/facets/array/stackable.rb

@@ -1,12 +1,3 @@
-# TITLE:
-#   Stackable
-#
-# DESCRIPTION:
-#   Array extensions for stack maniipulation.
-#
-# NOTES:
-#   - TODO Better name than #place --top, put, or what?
-
 require 'facets/array/splice'
 require 'facets/stackable'
 
@@ -18,9 +9,11 @@ class Array
   # It is the converse of push.
   #
   #  a=[1,2,3]
-  #  a.place(9)   #=> [9,1,2,3]
-  #  a          #=> [9,1,2,3]
+  #  a.poke(9)   #=> [9,1,2,3]
+  #  a           #=> [9,1,2,3]
   #
+  #   CREDIT: Trans
+
   alias_method :poke, :unshift
 
   # Alias for shift which removes an object
@@ -31,34 +24,7 @@ class Array
   #   a.pull  #=> 1
   #   a       #=> [2,3]
   #
+  #   CREDIT: Trans
+
   alias_method :pull, :shift
 end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestArray < Test::Unit::TestCase
-
-    def test_poke
-      a = [2,3]
-      assert_equal( [1,2,3], a.poke(1) )
-      assert_equal( [4,1,2,3], a.poke(4) )
-    end
-
-    def test_pull
-      a = [1,2,3]
-      assert_equal( 1, a.pull )
-      assert_equal( [2,3], a )
-    end
-
-  end
-
-=end

data/lib/core/facets/binding.rb

@@ -1,3 +1,6 @@
 require 'facets/binding/eval.rb'
+require 'facets/binding/defined.rb'
+require 'facets/binding/self.rb'
+require 'facets/binding/here.rb'  # technically should be in kernel.
 require 'facets/binding/cflow.rb'
 require 'facets/binding/vars.rb'

data/lib/core/facets/binding/cflow.rb

@@ -10,27 +10,27 @@ require 'facets/kernel/callstack'
 #
 class Binding
 
-  def self.included(base)
-    base.send(:include, Eval)
-  end
+  # Returns line number.
 
-  # returns line number
   def __LINE__
     eval("__LINE__")
   end
 
-  # returns file name
+  # Returns file name.
+
   def __FILE__
     eval("__FILE__")
   end
 
-  # return the directory of the file
+  # Return the directory of the file.
+
   def __DIR__
     eval("File.dirname(__FILE__)")
   end
 
   # Returns the call stack, in array format.
-  def call_stack( level = 1 )
+
+  def call_stack(level=1)
     eval( "call_stack( #{level} )" )
   end
 
@@ -39,12 +39,14 @@ class Binding
   #   def tester; p called; end
   #   tester  #=> :tester
   #
+
   def called
     name = /\`([^\']+)\'/.match(caller(1).first)[1]
     return name.to_sym
   end
 
   # Returns the call stack, same format as Kernel#caller()
+
   def caller( skip=0 )
     eval("caller(#{skip})")
   end
@@ -56,66 +58,10 @@ class Binding
   #   def tester; p methodname; end
   #   tester  #=> "tester"
   #
+
   def methodname
     name = /\`([^\']+)\'/.match(caller(1).first)[1]
     return name
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestBindingCallStack < Test::Unit::TestCase
-
-    def setup
-      a = 1
-      b = 2
-      x = "hello"
-      # the line number must be updated if it moves
-      @bind = binding; @this_line_no = __LINE__
-      @this_file_name = File.basename( __FILE__ ) # why does it equal basename only?
-    end
-
-    def test___LINE__
-      assert_equal( @this_line_no, @bind.__LINE__ )
-    end
-
-    def test___FILE__
-      assert_equal( @this_file_name, File.basename( @bind.__FILE__ ) )
-    end
-
-    def test___DIR__
-      assert_equal( File.dirname( @bind.__FILE__ ), @bind.__DIR__ )
-    end
-
-    def test_call_stack
-      assert_instance_of( Array, @bind.call_stack )
-    end
-
-    def test_called
-      assert_equal( :setup, @bind.called )
-    end
-
-    def test_caller
-      # how to test?
-      assert_nothing_raised{ @bind.caller }
-    end
-
-    def test_methodname
-      assert_equal( 'setup', @bind.methodname )
-    end
-
-  end
-
-=end
-

data/lib/core/facets/binding/defined.rb

@@ -0,0 +1,10 @@
+class Binding
+
+  # Returns the nature of something within the context of the binding.
+  # Returns nil if that thing is not defined.
+
+  def defined?(x)
+    eval("defined? #{x}")
+  end
+
+end

data/lib/core/facets/binding/eval.rb

@@ -1,83 +1,17 @@
-# TITLE:
-#   Primary Binding Extensions
-#
-# SUMMARY:
-#   The heart of all binding extensions.
-#   Some of this will be standard Ruby in future version.
+unless (RUBY_VERSION[0,3] == '1.9')
 
-class Binding
+  class Binding
 
-  # Evaluate a Ruby source code string (or block) in the binding context.
+    # Evaluate a Ruby source code string (or block) in the binding context.
 
-  def eval(str) #='', &blk )
-    #if block_given?
-    #  Kernel.eval( self, &blk )
-    #elsif str
-      Kernel.eval(str, self)
-    #end
-  end
-
-  # Returns the nature of something, nil if that thing is not defined.
-
-  def defined?(x)
-    eval("defined? #{x}")
-  end
-
-  # Returns self of the binding context.
-
-  def self()
-    @self ||= eval("self")
-    @self
-  end
-
-end
-
-
-module Kernel
-  # A shorthand pronoun for binding().
-  #
-  #   a = 3
-  #   b = here
-  #   eval( "a", b )  #=> 3
-  #
-  alias_method :here, :binding
-end
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestBindingEval < Test::Unit::TestCase
-
-    def setup
-      x = "hello"
-      @bind = binding; @this_line_no = __LINE__
-    end
-
-    def test_eval
-      assert_equal( "hello", @bind.eval("x") )
-    end
-
-    def test_self
-      assert_equal( self, @bind.self )
-    end
-
-    def test_defined?
-      assert( @bind.defined?("x") )
-    end
-
-    def test_here
-      assert_instance_of( Binding, here )
+    def eval(str) #='', &blk )
+      #if block_given?
+      #  Kernel.eval( self, &blk )
+      #elsif str
+        Kernel.eval(str, self)
+      #end
     end
 
   end
 
-=end
-
+end

data/lib/core/facets/binding/here.rb

@@ -0,0 +1,9 @@
+module Kernel
+  # A shorthand pronoun for binding().
+  #
+  #   a = 3
+  #   b = here
+  #   eval( "a", b )  #=> 3
+  #
+  alias_method :here, :binding
+end

data/lib/core/facets/binding/self.rb

@@ -0,0 +1,10 @@
+class Binding
+
+  # Returns self of the binding context.
+
+  def self()
+    @self ||= eval("self")
+    @self
+  end
+
+end

data/lib/core/facets/binding/vars.rb

@@ -11,10 +11,6 @@ require 'facets/binding/eval.rb'
 #
 class Binding
 
-  def self.included(base) #:nodoc:
-    base.send(:include, Eval)
-  end
-
   # Returns the local variables defined in the binding context
   #
   #   a = 2
@@ -43,44 +39,3 @@ class Binding
   end
 
 end
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-  class TestBindingVariables < Test::Unit::TestCase
-
-    def setup
-      a = 1
-      b = 2
-      x = "hello"
-      # the line number must be updated if it moves
-      @bind = binding; @this_line_no = __LINE__
-      @this_file_name = File.basename( __FILE__ ) # why does it equal basename only?
-    end
-
-    def test_local_variables
-      assert_equal( ["a","b","x"], @bind.local_variables )
-    end
-
-    def test_op_store
-      assert_nothing_raised{ @bind["x"] = "goodbye" }
-      assert_equal( "goodbye", @bind["x"] )
-    end
-
-    def test_op_fetch
-      assert_equal( "hello", @bind["x"] )
-    end
-
-  end
-
-=end
-

data/lib/core/facets/boolean.rb

@@ -1,7 +1,35 @@
-# boolean.rb
-
-# As suggested by Ara T. Howard
+# = TITLE:
+#
+#   Boolean
+#
+# = DESCRIPTION:
+#
+#   Stackable mixin provides #pop, #push, #pull, etc.
+#   It depends on #slice, #splice and #insert.
+#
+# = COPYRIGHT:
+#
+#   Copyright (c) 2006 Thomas Sawyer
+#
+#   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.
+#
+#
+# = AUTHORS:
+#
+#   - Thomas Sawyer
+#
+# = NOTES:
+#
+#   - This was suggested by Ara T. Howard
 
+#
 class String
 
   # Interpret common affirmative string meanings as true,
@@ -131,103 +159,3 @@ class NilClass
     false
   end
 end
-
-
-
-
-#  _____         _
-# |_   _|__  ___| |_
-#   | |/ _ \/ __| __|
-#   | |  __/\__ \ |_
-#   |_|\___||___/\__|
-#
-=begin test
-
-  require 'test/unit'
-
-
-  class TestStringBoolean < Test::Unit::TestCase
-
-    def test_to_b
-      assert( 'true'.to_b )
-      assert( 'True'.to_b )
-      assert( 'yes'.to_b )
-      assert( 'YES'.to_b )
-      assert( 'on'.to_b )
-      assert( 'ON'.to_b )
-      assert( 't'.to_b )
-      assert( '1'.to_b )
-      assert( 'y'.to_b )
-      assert( 'Y'.to_b )
-      assert( '=='.to_b )
-      assert( ! 'nil'.to_b )
-      assert( ! 'false'.to_b )
-      assert( ! 'blahblahtrueblah'.to_b )
-      assert_equal( nil, 'nil'.to_b )
-      assert_equal( nil, 'null'.to_b )
-    end
-
-  end
-
-
-  class TestArrayBoolean < Test::Unit::TestCase
-
-    def test_to_b
-      a = []
-      assert_equal( false, a.to_b )
-    end
-
-  end
-
-
-  class TestNumericBoolean < Test::Unit::TestCase
-
-    def test_to_b
-      assert_equal( false, 0.to_b )
-      assert_equal( true, 1.to_b )
-    end
-
-  end
-
-
-  class TestKernelBoolean < Test::Unit::TestCase
-
-    def test_to_b
-      assert_equal( true, true.to_b )
-      assert_equal( false, false.to_b )
-      assert_equal( false, nil.to_b )
-    end
-
-    def test_false?
-      assert( false.false? )
-      assert( (1 == 2).false? )
-      assert( ! (1 == 1).false? )
-    end
-
-    def test_true?
-      assert( true.true? )
-      assert( (1 == 1).true? )
-      assert( ! (1 == 2).true? )
-    end
-
-    def test_bool?
-      assert_equal( true, true.bool? )
-      assert_equal( true, false.bool? )
-      assert_equal( false, nil.bool? )
-      assert_equal( false, 0.bool? )
-    end
-
-  end
-
-
-  class TestBoolean < Test::Unit::TestCase
-
-    def test_to_bool
-      assert_equal( true, true.to_bool )
-      assert_equal( false, false.to_bool )
-      assert_equal( false, nil.to_bool )
-    end
-
-  end
-
-=end