facets 3.1.0 → 3.2.0

data/demo/core/comparable/op_get.md

@@ -1,32 +0,0 @@
-## Comparable.[]
-
-    require 'facets/comparable/op_get'
-
-Allows `Comparable` to be included as a *parmetric mixin*. This makes it easy to define
-a class as comparable on a limited set of attributes.
-
-    c = Class.new do
-      include Comparable[:a,:b]
-
-      attr_accessor :a, :b
-
-      def initialize(a,b)
-        @a=a; @b=b
-      end
-    end
-
-    a = [c.new(10,20),c.new(10,30)]
-    a.sort.assert == a
-
-    a = [c.new(10,30),c.new(10,20)]
-    a.sort.assert == a.reverse
-
-    a = [c.new(10,10),c.new(20,10)]
-    a.sort.assert == a
-
-    a = [c.new(20,10),c.new(10,10)]
-    a.sort.assert == a.reverse
-
-    a = [c.new(10,30),c.new(20,10)]
-    a.sort.assert == a
-

data/demo/core/dir/ascend.md

@@ -1,24 +0,0 @@
-## Dir#ascend
-
-    require 'facets/dir/ascend'
-
-    path = 'A/B/C'
-
-    tmp = []
-
-    Dir.ascend(path) do |d|
-      tmp << d
-    end
-
-    tmp.assert == %w{A/B/C A/B A}
-
-Exclude current path.
-
-    tmp = []
-
-    Dir.ascend(path, false) do |d|
-      tmp << d
-    end
-    
-    tmp.assert == %w{A/B A}
-

data/demo/core/dir/descend.md

@@ -1,16 +0,0 @@
-## Dir#descend
-
-    require 'facets/dir/descend'
-
-Descend thru a file path.
-
-    path = 'A/B/C'
-
-    tmp = []
-
-    Dir.descend(path) do |d|
-      tmp << d
-    end
-
-    tmp.assert == %w{A A/B A/B/C}
-

data/demo/core/dir/multiglob.md

@@ -1,41 +0,0 @@
-## Dir#multiglob
-
-Dir#multglob is like Dir#glob but it can handle more than one match
-parameter at a time.
-
-Given a directory 'multiglob' containing:
-
-    A.txt
-    A/B.txt
-    A/B/C.txt
-
-We can use #multglob to find multiple matches.
-
-    require 'facets/dir/multiglob'
-
-    x = %w{
-      multiglob/A
-      multiglob/A.txt
-    }
-
-    r = Dir.multiglob('multiglob/A', 'multiglob/A.*').sort
-
-    r.assert == x
-
-## Dir#multiglob_r
-
-Dir#multiglob_r is like #multiglob but automatically searches
-directories recrusively.
-
-    x = %w{
-      multiglob/A 
-      multiglob/A/B
-      multiglob/A.txt
-      multiglob/A/B.txt
-      multiglob/A/B/C.txt
-    }.sort
-
-    r = Dir.multiglob_r('multiglob/*').sort
-
-    r.assert == x
-

data/demo/core/dir/parent.md

@@ -1,6 +0,0 @@
-## Dir#parent
-
-    require 'facets/dir/parent'
-
-    Dir.assert.parent?("a/b/c", "a/b/c/d")
-

data/demo/core/dir/recurse.md

@@ -1,41 +0,0 @@
-## Dir#recurse
-
-Given a directory 'recurse' containing:
-
-    A.txt
-    A/B.txt
-    A/B/C.txt
-
-We can use #recurse to gather a complete recursive
-list of all the entries.
-
-    require 'facets/dir/recurse'
-
-    x = %w{
-      recurse/A
-      recurse/A.txt
-      recurse/A/B
-      recurse/A/B.txt
-      recurse/A/B/C.txt
-    }.sort
-
-    r = Dir.recurse('recurse').sort
-
-    r.assert == x
-
-## Dir#ls_r
-
-Dir#ls_r is an alias for #recurse which can also be used to gather
-a complete recursive list of all the entries.
-
-    x = %w{
-      recurse/A
-      recurse/A.txt
-      recurse/A/B
-      recurse/A/B.txt
-      recurse/A/B/C.txt
-    }.sort
-
-    r = Dir.ls_r('recurse').sort
-
-    r.assert == x

data/demo/core/exception/detail.md

@@ -1,19 +0,0 @@
-## Exception#detail
-
-    require 'facets/exception/detail'
-
-Provides a more detailed error message.
-
-    begin
-      raise ArgumentError
-    rescue ArgumentError => err
-      r = err.detail
-      r.assert.include?('ArgumentError')
-    end
-
-The output of `#detail` looks something like this:
-
-    ArgumentError: ArgumentError
-      example.rb:4:in `<main>'
-      LOGGED FROM: example.rb:6:in `rescue in <main>'
-

data/demo/core/facets.md

@@ -1,6 +0,0 @@
-# Requiring Facets
-
-We should be able to require all the core libraries by simply calling,
-
-    require 'facets'
-

data/demo/core/filetest/root.md

@@ -1,13 +0,0 @@
-## FileTest#root?
-
-    require 'facets/filetest/root'
-
-Returns true if the given directory is the file system root.
-Obviously on a Linux system them means `/`.
-
-    FileTest.assert.root?('/')
-
-Anything else will return false.
-
-    FileTest.refute.root?('/home')
-

data/demo/core/hash/recursively.md

@@ -1,21 +0,0 @@
-## Hash#recursively
-
-    require 'facets/hash/recursively'
-
-    h = {:a=>1, :b=>{:c=>3}}
-
-Without a block passed to the `#recursively` method, the block passed to the
-enumeratig method will be used for both recursive and non-recursive yields.
-
-    r = h.recursively.map{ |k,v| [k.to_s, v] }
-
-    r.assert == [['a', 1], ['b', [['c', 3]]]]
-
-But if we pass a block to `#recursively` we can treat the recusive yield 
-separately, which in turn allows us to manipulate the non-recursive
-yields with a different procedure.
-
-    r = h.recursively{ |k,v| [k.to_s, v] }.map{ |k,v| [k.to_s,v.to_s] }
-
-    r.assert == [['a','1'], ['b', [['c', '3']]]]
-

data/demo/core/indexable.md

@@ -1,95 +0,0 @@
-# Indexable
-
-Indexable it a module, like Enumerable, but provides methods specific
-to an indexable collection. The Indexable module can be used independently,
-but Facets can also automatically use it to extend Array.
-
-    require 'facets/array/indexable'
-
-## Indexable#head
-
-    a = [1,2,3,4,5]
-    a.head.assert = [1]
-
-## Indexable#tail
-
-    a = [1,2,3,4,5]
-    a.tail.assert = [2,3,4,5]
-
-## Indexable#foot
-
-    a = [1,2,3,4,5]
-    a.foot.assert = [5]
-
-## Indexable#body
-
-    a = [1,2,3,4,5]
-    a.body.assert = [1,2,3,4]
-
-## Indexable#mid
-
-    a = [1,2,3,4,5]
-    b = [1,2,3,4,5,6]
-    a.mid.assert = 3
-    b.mid.assert = 4
-    a.mid(1).assert = 4
-    b.mid(1).assert = 5
-    b.mid(2).assert = 6
-    b.mid(-1).assert = 3
-
-## Indexable#middle
-
-    a = [1,2,3,4,5]
-    b = [1,2,3,4,5,6]
-    a.middle.assert = [3]
-    b.middle.assert = [3,4]
-
-## Indexable#thru
-
-    [0,1,2,3,4,5].thru(2,4).assert = [2,3,4]
-    [0,1,2,3,4,5].thru(0,1).assert = [0,1]
-
-## Indexable#first=
-
-    a = [1,2]
-    a.first = 0
-    a.assert = [0,2]
-
-## Indexable#last=
-
-    a = [1,2]
-    a.last = 3
-    a.assert = [1,3]
-
-## Indexable#ends
-
-    [1,2,3,4,5].ends.assert = 4
-
-## Indexable#pos
-
-    a = [1,2,3,4,5]
-    a.pos(1).assert = 0
-    a.pos(-1).assert = 4
-
-## Indexable#range
-
-    a = [1,2,3,4,5]
-    b = [1,2,3,4,5,6]
-    a.range.assert = (0..4)
-    b.range.assert = (0..5)
-    a.range(2,4).assert = (1..3)
-    b.range(2,3).assert = (1..2)
-    b.range(4,2).assert = (3..1)
-
-## Indexable#first!
-
-    a = [1,2,3]
-    a.first!.assert = 1
-    a.assert = [2,3]
-
-## Indexable#last!
-
-    a = [1,2,3]
-    a.last!.assert = 3
-    a.assert = [1,2]
-

data/demo/core/integer/bitmask.md

@@ -1,46 +0,0 @@
-## Integer#bit
-
-    require 'facets/integer/bitmask'
-
-    0.bit(0).assert == 1
-    0.bit(1).assert == 2
-    0.bit(2).assert == 4
-    0.bit(3).assert == 8
-
-Negate
-
-    1.bit(~0).assert == 0
-    2.bit(~1).assert == 0
-    4.bit(~2).assert == 0
-    8.bit(~3).assert == 0
-
-## Integer#bit?
-
-    a = 8
-    assert(! a.bit?(0))
-    assert(! a.bit?(1))
-    assert(! a.bit?(2))
-    assert(  a.bit?(3))
-    assert(! a.bit?(4))
-    assert(! a.bit?(5))
-
-## Integer#bit_clear
-
-    1.bit_clear(0).assert == 0
-    2.bit_clear(1).assert == 0
-    4.bit_clear(2).assert == 0
-    8.bit_clear(3).assert == 0
-
-## Integer#bitmask
-
-    a =  1
-    m = Bit(4)
-    a = a.bitmask(m)
-    a.assert == 17
-    assert( a.bitmask?(m) )
-
-## Kernel#Bit
-
-    n = Bit(4)
-    n.assert == 16
-

data/demo/core/integer/factorial.md

@@ -1,10 +0,0 @@
-## Integer#factorial
-
-    require 'facets/integer/factorial'
-
-    0.factorial.assert == 1
-    1.factorial.assert == 1
-    2.factorial.assert == 2
-    3.factorial.assert == 6
-    4.factorial.assert == 24
-

data/demo/core/integer/length.md

@@ -1,7 +0,0 @@
-## Numeric#length
-
-    require 'facets/numeric/length'
-
-    10.length.assert == 10
-    10.0.length.assert == 10
-

data/demo/core/integer/multiple.md

@@ -1,12 +0,0 @@
-## Integer#multiple?
-
-    require 'facets/integer/multiple'
-
-Is a number an even multiple of another?
-
-    1.multiple?(2)  #=> false
-    5.multiple?(3)  #=> false
-
-    2.multiple?(2)  #=> true
-    6.multiple?(3)  #=> true
-

data/demo/core/integer/of.md

@@ -1,11 +0,0 @@
-## Integer#of
-
-    require 'facets/integer/of'
-
-Similar to `Enumerable#map` and `Enumerable#collect` but for a number
-of times.
-
-    a = 4
-    b = a.of{ |i| i*2 }
-    b.assert == [0,2,4,6]
-

data/demo/core/integer/ordinal.md

@@ -1,11 +0,0 @@
-## Integer#ordinal
-
-    require 'facets/integer/ordinal'
-
-Produce the ordinal name of a number.
-
-    1.ordinal.assert == '1st'
-    2.ordinal.assert == '2nd'
-    3.ordinal.assert == '3rd'
-    4.ordinal.assert == '4th'
-

data/demo/core/integer/times_collect.md

@@ -1,9 +0,0 @@
-## Integer#times_collect
-
-    require 'facets/integer/of'
-
-    a = 4
-    b = a.times_collect{ |i| i*2 }
-    b.assert == [0,2,4,6]
-
-See `Integer#of` which is an alias.

data/demo/core/matchdata/match.md

@@ -1,7 +0,0 @@
-## MatchData#match
-
-    require 'facets/matchdata/match'
-
-    md = /X(a)(b)(c)X/.match("YXabcXY")
-    md.match.assert == "XabcX"
-

data/demo/core/matchdata/matchset.md

@@ -1,7 +0,0 @@
-## MatchData#matchset
-
-    require 'facets/matchdata/matchset'
-
-    md = /(bb)(cc(dd))(ee)/.match "XXaabbccddeeffXX"
-    md.matchset.assert == ["XXaa", [["bb"], ["cc", ["dd"]], ["ee"]], "ffXX"]
-

data/demo/core/matchdata/matchtree.md

@@ -1,10 +0,0 @@
-## MatchData#matchtree
-
-    require 'facets/matchdata/matchtree'
-
-    md = /(bb)(cc(dd))(ee)/.match "XXaabbccddeeffXX"
-    md.matchtree.assert == [["bb"], ["cc", ["dd"]], ["ee"]]
-
-    md = /(bb)c(c(dd))(ee)/.match "XXaabbccddeeffXX"
-    md.matchtree.assert == [["bb"], "c", ["c", ["dd"]], ["ee"]]
-

data/demo/core/module/cattr.md

@@ -1,43 +0,0 @@
-## Class#cattr
-
-    require 'facets/module/cattr'
-
-    class CAttrMockObject
-      def initialize
-        @@a = 10
-      end
-      def b ; @@b ; end
-    end
-
-    Exception.refute.raised? do
-      CAttrMockObject.class_eval{ cattr :a }
-    end
-    t = CAttrMockObject.new
-    t.a.assert == 10
-
-## Class#cattr_reader
-
-    Exception.refute.raised? do
-      CAttrMockObject.class_eval { cattr_reader :a }
-    end
-    t = CAttrMockObject.new
-    t.a.assert == 10
-
-## Class#cattr_writer
-
-    Exception.refute.raised? do
-      CAttrMockObject.class_eval { cattr_writer :b }
-    end
-    t = CAttrMockObject.new
-    t.b = 5
-    t.b.assert == 5
-
-## Class#cattr_accessor
-
-    Exception.refute.raised? do
-      CAttrMockObject.class_eval { cattr_accessor :c }
-    end
-    t = CAttrMockObject.new
-    t.c = 50
-    t.c.assert == 50
-

data/demo/core/module/class_extend.md

@@ -1,64 +0,0 @@
-## Module#class_extend
-
-    require 'facets/module/class_extend'
-
-Module using class_extend
-
-    mix = Module.new do
-      def i ; end
-      class_extend do
-        def n ; 42   ; end
-        def s ; self ; end
-      end
-    end
-
-Extends module
-
-    mix.n.assert == 42
-    mix.s.assert == mix
-
-Has expected methods
-
-    mix.instance_methods.map{ |m| m.to_s }.assert == ['i']
-
-transfers class methods to including class
-
-    mod = Module.new do
-      include mix
-    end
-    mod.n.assert == 42
-    mod.s.assert == mod
-
-Doesn't overwrite instance methods
-
-    c = Class.new do
-      include mix
-      def n ; 11 ; end
-    end
-    c.new.n.assert == 11
-
-Is overridable via including module
-
-    mod = Module.new do
-      include mix
-      class_extend do
-        def n ; super + 1 ; end
-      end
-    end
-    mod.n.assert == 43  # notice the difference!
-    mod.s.assert == mod
-
-Transfers class methods thru multiple levels of include
-
-    alt = Module.new do
-      include mix
-      class_extend do
-        def n ; super + 1 ; end
-      end
-    end
-    mod = Module.new do
-      include alt
-    end
-    mod.n.assert == 43
-    mod.s.assert == mod
-