facets 3.0.0 → 3.1.0

data/lib/core/facets/hash/except.rb

@@ -7,6 +7,18 @@ class Hash
     hash
   end
 
+  # Replaces hash with new hash less the given keys.
+  #
+  #   h = {:a=>1, :b=>2, :c=>3}
+  #   h.except!(:a)  #=> {:b=>2,:c=>3}
+  #   h              #=> {:b=>2,:c=>3}
+  #
+  # Returns the hash.
+  def except!(*rejected)
+    rejected.each{ |k| delete(k) }
+    self
+  end
+
   # Replaces hash with new hash less the given keys.
   # This returns the hash of keys removed.
   #
@@ -15,7 +27,7 @@ class Hash
   #   h              #=> {:b=>2,:c=>3}
   #
   # Returns a Hash of the removed pairs.
-  def except!(*rejected)
+  def remove!(*rejected)
     removed = {}
     rejected.each{ |k| removed[k] = delete(k) }
     removed

data/lib/core/facets/indexable.rb

@@ -128,7 +128,7 @@ module Indexable
   #   %w{W o r l d}.from(3)  #=> %w{l d}
   #
   def from(i)
-    return self if i >= size
+    return [] if i >= size
     slice(i, size - i) #slice(-n..-1)
   end
 

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

@@ -26,7 +26,8 @@ module Kernel
 end
 
 class NilClass
-
+  FUNCTOR = Functor.new{ nil }
+  
   # Compliments Kernel#ergo.
   #
   #   "a".ergo{ |o| o.upcase } #=> "A"
@@ -35,8 +36,7 @@ class NilClass
   # CREDIT: Daniel DeLorme
 
   def ergo
-    @_ergo ||= Functor.new{ nil }
-    @_ergo unless block_given?
+    FUNCTOR unless block_given?
   end
 
 end

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

@@ -5,7 +5,7 @@ module Kernel
   # #equal?, then #eql?, then #==, and ending with #===.
   #
   #   1.like?(1.0)               #=> true
-  #   "string".likee?("string")   #=> true
+  #   "string".like?("string")   #=> true
   #   String.like?("string")     #=> true
   #
   def like?(x)

data/lib/core/facets/matchdata/matchtree.rb

@@ -0,0 +1,2 @@
+# Matchdata#matchtree is defined in
+require 'facets/matchdata/matchset'

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

@@ -0,0 +1,20 @@
+class Numeric
+  # Returns a string representation of the number e.g.
+  #   1000.delimit # => "1,000"
+  #   1000000.delimit # => "1,000,000"
+  #   (1000000.1234).delimit # => "1,000,000.1234"
+  #
+  # Can take a hash of options:
+  # * <tt>delimiter</tt> - defaults to "," but can be any string
+  # * <tt>separator</tt> - defaults to "." but can be any string
+  #
+  #   1000.delimit(:delimiter => "_") # => "1_000"
+  #   (1000.00).delimit(:delimiter => ".", :separator => ",") # => "1.000,00"
+  def delimit(options = {})
+    opts = { :delimiter => ',', :separator => '.' }.merge(options)
+    digits, decimals = self.to_s.split('.')
+    digits = digits.reverse.chars.each_slice(3).map(&:join).join(opts[:delimiter]).reverse
+    return digits unless decimals
+    [digits, decimals].join(opts[:separator])
+  end
+end

data/lib/core/facets/range/nudge.rb

@@ -0,0 +1,29 @@
+class Range
+
+  # Nudge range values
+  #
+  #   (1..5).nudge           #=> 2..6
+  #   (1..5).nudge(2)        #=> 3..7
+  #   (1..5).nudge(-2)       #=> -1..3
+  #   (1..5).nudge(min: 1)   #=> 2..5
+  #   (1..5).nudge(max: 1)   #=> 1..6
+  #
+  # CREDIT: Codeindulgence
+
+  def nudge(options_or_number = 1)
+    if options_or_number.instance_of? Fixnum
+      {:min => options_or_number, :max => options_or_number}
+      min = options_or_number
+      max = options_or_number
+    else
+      min = options_or_number[:min].to_i
+      max = options_or_number[:max].to_i
+    end
+
+    if exclude_end?
+      (self.min + min)...((self.max + 1) + max)
+    else
+      (self.min + min)..(self.max + max)
+    end
+  end
+end

data/lib/core/facets/string.rb

@@ -53,8 +53,6 @@ require_relative 'string/squish.rb'
 require_relative 'string/starts_with.rb'
 require_relative 'string/store.rb'
 require_relative 'string/subtract.rb'
-require_relative 'string/tab.rb'
-require_relative 'string/tabto.rb'
 require_relative 'string/titlecase.rb'
 require_relative 'string/to_re.rb'
 require_relative 'string/unbracket.rb'

data/lib/core/facets/string/indent.rb

@@ -73,12 +73,4 @@ class String
   def unindent!
     replace(unindent)
   end
-
-  # DEPRECATED: Use String#indent instead.
-  alias :tab  :indent
-  alias :tab! :indent!
-
-  #alias :backtab  :unindent
-  #alias :backtab! :unindent!
-
 end

data/lib/core/facets/string/margin.rb

@@ -52,8 +52,4 @@ class String
       str.indent(num - min)
     end
   end
-
-  # Original name of #margin.
-  alias :tabto :margin
-
 end

data/lib/core/facets/string/random.rb

@@ -2,6 +2,8 @@ class String
 
   # Create a random String of given length, using given character set
   #
+  # Character set is an Array which can contain Ranges, Arrays, Characters
+  #
   # Examples
   #
   #     String.random
@@ -19,6 +21,15 @@ class String
   #     String.random(10, ['0'..'9','A'..'F'] )
   #     => "3EBF48AD3D"
   #
+  #     BASE64_CHAR_SET =  ["A".."Z", "a".."z", "0".."9", '_', '-']
+  #     String.random(10, BASE64_CHAR_SET)
+  #     => "xM_1t3qcNn"
+  #
+  #     SPECIAL_CHARS = ["!", "@", "#", "$", "%", "^", "&", "*", "(", ")", "-", "_", "=", "+", "|", "/", "?", ".", ",", ";", ":", "~", "`", "[", "]", "{", "}", "<", ">"]
+  #     BASE91_CHAR_SET =  ["A".."Z", "a".."z", "0".."9", SPECIAL_CHARS]
+  #     String.random(10, BASE91_CHAR_SET)
+  #      => "S(Z]z,J{v;"
+  #
   # CREDIT: Tilo Sloboda
   #
   # SEE: https://gist.github.com/tilo/3ee8d94871d30416feba
@@ -26,9 +37,8 @@ class String
   # TODO: Move to random.rb in standard library?
 
   def self.random(len=32, character_set = ["A".."Z", "a".."z", "0".."9"])
-    characters = character_set.map { |i| i.to_a }.flatten
-    characters_len = characters.length
-    (0...len).map{ characters[rand(characters_len)] }.join
+    chars = character_set.map{|x| x.is_a?(Range) ? x.to_a : x }.flatten
+    Array.new(len){ chars.sample }.join
   end
 
 end

data/lib/core/facets/string/similarity.rb

@@ -4,19 +4,19 @@ class String
   # on the number of shared edges. To be effective, the strings
   # must be of length 2 or greater.
   #
-  #   "Alexsander".similarity("Aleksander")  #=> 0.9
+  #     "Alexsander".similarity("Aleksander")  #=> 0.9
   #
   # The way it works:
   #
   # 1. Converts each string into a "graph like" object, with edges ...
   #
-  #     "alexsander" -> [ alexsander, alexsand, alexsan ... lexsand ... san ... an, etc ]
-  #     "aleksander" -> [ aleksander, aleksand ... etc. ]
+  #        "alexsander" -> [ alexsander, alexsand, alexsan ... lexsand ... san ... an, etc ]
+  #        "aleksander" -> [ aleksander, aleksand ... etc. ]
   #
   # 2. Perform match, then remove any subsets from this matched set (i.e. a hit
   # on "san" is a subset of a hit on "sander") ...
   #
-  #     Above example, once reduced -> [ ale, sander ]
+  #        Above example, once reduced -> [ ale, sander ]
   #
   # 3. See's how many of the matches remain, and calculates a score based
   # on how many matches, their length, and compare to the length of the
@@ -24,7 +24,8 @@ class String
   #
   # Still a bit rough. Any suggestions for improvement are welcome.
   #
-  # CREDIT: Derek Lewis.
+  # CREDIT: Derek Lewis
+
   def similarity(str_in)
     return 0 if str_in == nil
     return 1 if self == str_in
@@ -82,7 +83,7 @@ class String
     score = 0.0
     matches.each{ |mm| score += mm.length }
     self.length > str_in.length ? largest = self.length : largest = str_in.length
-    return score/largest
+    return score/(largest+1)
   end
 
 end

data/lib/standard/facets/enumargs.rb

@@ -51,6 +51,11 @@ module Enumerable
           end
         }
       else
+        # this branch is used when the method has a variable number of arguments
+        #   resulting in an arity of -1.  Right now this is bugged as it does
+        #   not pass the argument to the each, and always passes the argument
+        #   to the method.  This makes methods like .min amdn .max to act
+        #   in an unexpected manner.
         class_eval %{
           def #{m}( *args, &yld )
             enum_for(:each).#{m}( *args, &yld )

data/lib/standard/facets/math/percentile.rb

@@ -5,7 +5,7 @@ module Math
   # +pcnt+ should be expressed as an integer, e.g. `percentile(90)` returns
   # the 90th percentile of the array.
   #
-  # Algorithm from NIST[http://www.itl.nist.gov/div898/handbook/prc/section2/prc252.htm]
+  # Algorithm from NIST[http://www.itl.nist.gov/div898/handbook/prc/section2/prc262.htm]
   #
   # NOTE: This is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.

data/lib/standard/facets/net/http.rb

@@ -2,13 +2,17 @@ require 'net/http'
 
 module Net
 
+  # Returns a response object for the given URL or raises
+  # an exception with the appropriate error status code if unable to
+  # complete the request
+  #
+  #   Net.download('http://example.com/')
+  #   Net.download('http://example.com/', 2) # fail after 2 redirects
+  #
   # CREDIT: Daniel Huckstep
-  def self.download(url, limit=10)
-    raise ArgumentError, 'HTTP redirect too deep' if limit == 0
-    #url = URI.parse(url)
-    #req = Net::HTTP::Get.new(url.path)
-    #req['User-Agent'] = "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9.0.7) Gecko/2009030422 Ubuntu/8.10 (intrepid) Firefox/3.0.7"
-    #resp = Net::HTTP.new(url.host, url.port).start { |http| http.request(req) }
+  def self.download(url, limit = nil)
+    limit ||= 10
+    raise ArgumentError, 'HTTP redirect too deep' if limit.zero?
     resp = Net::HTTP.get_response(URI.parse(url))
     case resp
     when Net::HTTPSuccess     then resp
@@ -17,16 +21,31 @@ module Net
     end
   end
 
+  # Downloads a given URL and saves it to disk at the specified path.
+  # If path is not provided or nil, then the last segment in the path of
+  # the URL is used as the file name.
+  #
+  # Takes a third parameters as a hash of options:
+  # * <tt>limit</tt> - passed to Net.download to limit number of redirects
+  # * <tt>mode</tt>, <tt>:open_args<tt>, etc - passed to File.write to save the file.
+  #   For details on those options, see File.write
+  #
+  #   # Saves robots.txt to PWD as robots.txt
+  #   Net.download_and_save('http://example.com/robots.txt')
+  #
+  #   # Saves robots.txt to PWD as example.txt
+  #   Net.download_and_save('http://example.com/robots.txt', 'example.txt')
+  #
+  #   # Saves robots.txt to PWD as robots.txt, and writes the result as binary
+  #   Net.download_and_save('http://example.com/robots.txt', nil, mode: 'wb')
+  #
   # CREDIT: Daniel Huckstep
-  def self.download_and_save(url, path=nil)
-    if path.nil?
-      path = File.expand_path(url.split('/').last)
-    else
-      path = File.expand_path(path)
-    end
+  def self.download_and_save(url, path = nil, options = {})
+    opts = options.dup
+    path = File.expand_path(path || url.split('/').last)
     raise ArgumentError.new('Save path is a directory') if File.directory?(path)
-    resp = download(url)
-    open(path,'w') { |file| file.write(resp.body) } if resp.is_a?(Net::HTTPSuccess)
+    resp = download(url, opts.delete(:limit))
+    File.write(path, resp.body, opts) if resp.is_a?(Net::HTTPSuccess)
   end
 end
 

data/lib/standard/facets/timer.rb

@@ -1,11 +1,11 @@
-require 'timeout'  # for TimeoutError
+require 'timeout'  # for Timeout::Error
 
 # = Timer
 #
 # Provides a strightforward means for controlling time critical execution.
 # Can be used as a "stop watch" timer or as a "time bomb" timer:
 #
-#   t = Timer.new(10) { raise TimeoutError, "timeout!" }
+#   t = Timer.new(10) { raise Timeout::Error, "timeout!" }
 #   t.start
 #     :      # done within 10sec timeout
 #   t.stop
@@ -107,7 +107,7 @@ class Timer
         if @on_timeout then
           @on_timeout.call @time_limit
         else
-          @current_thread.raise TimeoutError, "#{@time_limit} seconds past"
+          @current_thread.raise Timeout::Error, "#{@time_limit} seconds past"
         end
       }
     end

data/test/core/array/test_average.rb

@@ -0,0 +1,16 @@
+require 'facets/array/average'
+
+test_case Array do
+  method :average do
+    test 'Empty array returns nil' do
+      [].average.assert == nil
+    end
+
+    test 'Calculate average of array of numerical values' do
+      [1, 2, 3].average.assert == 2
+      [96, 35, 72, 30, 75, 33, 68, 13, 49, 71].average.assert == 54.2
+      [36, -67, -17, 85, -46, -64, -23, -13, 89, -47].average.assert == -6.7
+      [60.7829, 31.2622, 20.626, 78.8907, 61.5328].average.assert == 50.61892
+    end
+  end
+end

data/test/core/array/test_before.rb

@@ -23,5 +23,26 @@ test_case Array do
 
   end
 
+  method :after do
+
+    setup do
+      @sequence = ['a', 'b', 'c']
+    end
+
+    test "returns the following element" do
+      @sequence.after('a').assert == 'b'
+      @sequence.after('b').assert == 'c'
+    end
+
+    test "loops around from back to front" do
+      @sequence.after('c').assert == 'a'
+    end
+
+    test "non-member elements return nil" do
+      @sequence.after('d').assert == nil
+    end
+
+  end
+
 end
 

data/test/core/array/test_collapse.rb

@@ -5,10 +5,19 @@ test_case Array do
   method :collapse do
 
     test do
-      [1,nil,[1,2],nil,[[3]]].collapse.assert == [1,1,2,3]
+      [1, nil, [1, 2], nil, [[3]]].collapse.assert == [1, 1, 2, 3]
     end
 
   end
 
+  method :collapse! do
+
+    test do
+      a = [1, nil, [1, 2], nil, [[3]]]
+      a.collapse!
+      a.assert == [1, 1, 2, 3]
+
+    end
+  end
 end
 

data/test/core/array/test_delete_unless.rb

@@ -0,0 +1,17 @@
+covers 'facets/array/delete_unless'
+
+test_case Array do
+
+  method :delete_unless do
+
+    test 'with an explicit block' do
+      [1,2,3].delete_unless{ |x| x < 2 }.assert == [1]
+    end
+
+    test 'with an implicit block' do
+      [1,2,3].delete_unless(&:even?).assert == [2]
+    end
+
+  end
+
+end

data/test/core/array/test_delete_values.rb

@@ -0,0 +1,31 @@
+covers 'facets/array/delete_values'
+
+test_case Array do
+
+  method :delete_values do
+
+    test do
+      a = [1,2,3,4]
+      a.delete_values(1,2).assert == [1,2]
+      a.assert                    == [3,4]
+    end
+
+  end
+
+  method :delete_values_at do
+
+    test do
+      a = [1,2,3,4]
+      a.delete_values_at(1,2).assert == [2,3]
+      a.assert                       == [1,4]
+    end
+
+    test do
+      a = [1,2,3,4]
+      a.delete_values_at(0..2).assert == [1,2,3]
+      a.assert                        == [4]
+    end
+
+  end
+
+end