facets 3.0.0 → 3.2.0

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/object/dup.rb

@@ -1,20 +1,4 @@
 class Object
-  # Override this in a child class if it cannot be dup'ed.
-  #
-  #   obj1 = Object.new
-  #   obj2 = obj1.dup!
-  #   obj2.equal?(obj1)    #=> false
-  #
-  # CREDIT: Dan Kubb (extlib)
-  def dup!
-    dup
-  end
-
-  # Alternative name for #dup!
-  def try_dup
-    dup!
-  end
-
   # Can you safely call #dup on this object?
   #
   # Returns +false+ for +nil+, +false+, +true+, symbols, and numbers;
@@ -24,56 +8,26 @@ class Object
 end
 
 class NilClass
-  # Since NilClass is immutable it cannot be duplicated.
-  # For this reason #try_dup returns +self+.
-  #
-  #   nil.dup!  #=> nil
-  #
-  def dup!   ; self  ; end
   def dup?   ; false ; end
   def clone? ; false ; end
 end
 
 class FalseClass
-  # Since FalseClass is immutable it cannot be duplicated.
-  # For this reason #try_dup returns +self+.
-  #
-  #   false.dup!  #=> false
-  #
-  def dup!   ; self  ; end
   def dup?   ; false ; end
   def clone? ; false ; end
 end
 
 class TrueClass
-  # Since TrueClass is immutable it cannot be duplicated.
-  # For this reason #try_dup returns +self+.
-  #
-  #   true.dup!  #=> true
-  #
-  def dup!   ; self  ; end
   def dup?   ; false ; end
   def clone? ; false ; end
 end
 
 class Symbol
-  # Since Symbol is immutable it cannot be duplicated.
-  # For this reason #try_dup returns +self+.
-  #
-  #   :a.dup!  #=> :a
-  #
-  def dup!   ; self  ; end
   def dup?   ; false ; end
   def clone? ; false ; end
 end
 
 class Numeric
-  # Since Numeric is immutable it cannot be duplicated.
-  # For this reason #try_dup returns +self+.
-  #
-  #   1.dup!  #=> 1
-  #
-  def dup!   ; self  ; end
   def dup?   ; false ; end
   def clone? ; false ; end
 end

data/lib/core/facets/proc/bind.rb

@@ -1,5 +1,3 @@
-require 'facets/kernel/singleton_class'
-
 class Proc
 
   # Bind a Proc to an object returning a Method.

data/lib/core/facets/proc/compose.rb

@@ -1,42 +1,21 @@
 class Proc
 
-  # Returns a new proc that is the functional
-  # composition of two procs, in order.
-  #
-  #   a = lambda { |x| x + 4 }
-  #   b = lambda { |y| y / 2 }
-  #
-  #   a.compose(b).call(4)  #=> 6
-  #   b.compose(a).call(4)  #=> 4
-  #
-  # CREDIT: Dave
-
+  # @deprecated Use Proc#>> or Proc#<< instead (built-in since Ruby 2.6).
   def compose(g)
-    raise ArgumentError, "arity count mismatch" unless arity == g.arity
-    lambda{ |*a| self[ *g[*a] ] }
+    warn "Proc#compose is deprecated. Use Proc#<< instead (right-to-left composition).", uplevel: 1
+    self << g
   end
 
-  # Operator for Proc#compose and Integer#times_collect/of.
-  #
-  #   a = lambda { |x| x + 4 }
-  #   b = lambda { |y| y / 2 }
-  #
-  #   (a * b).call(4)  #=> 6
-  #   (b * a).call(4)  #=> 4
-  #
-  # CREDIT: Dave
-
+  # @deprecated Use Proc#>> or Proc#<< for composition (built-in since Ruby 2.6).
   def *(x)
-    if Integer===x
-      # collect times
+    warn "Proc#* is deprecated. Use Proc#<< for composition (right-to-left).", uplevel: 1
+    if Integer === x
       c = []
       x.times{|i| c << call(i)}
       c
     else
-      # compose procs
-      lambda{|*a| self[x[*a]]}
+      self << x
     end
   end
 
 end
-

data/lib/core/facets/proc/to_method.rb

@@ -1,5 +1,4 @@
 require 'facets/proc/bind'
-require 'facets/kernel/singleton_class'
 
 class Proc
 

data/lib/core/facets/proc/update.rb

@@ -1,6 +1,13 @@
 class Proc
 
-  # Use a Proc as an observable.
+  # Alias for #call, allowing a Proc to be used as an Observer.
+  #
+  # Ruby's Observable module (now the `observer` gem, removed from
+  # stdlib in Ruby 3.2) calls #update on observers. This alias
+  # lets a Proc serve as an observer directly.
+  #
+  # TODO: Consider submitting a PR to the observer gem to include
+  # this extension there instead.
   #
   # CREDIT: Tim Pease
 

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

@@ -0,0 +1,42 @@
+class Range
+
+  # Returns the intersection of two or more ranges — the region they
+  # all share. Returns nil if the ranges do not overlap.
+  #
+  # Works with any comparable type: integers, floats, dates, strings, etc.
+  #
+  # Examples
+  #
+  #     Range.intersection(1..10, 5..15)         #=> 5..10
+  #     Range.intersection(1..5, 3..7, 4..9)     #=> 4..5
+  #     Range.intersection(1..3, 5..7)            #=> nil
+  #     Range.intersection(1.0..5.0, 2.5..4.5)   #=> 2.5..4.5
+  #
+  # Also available as an instance method:
+  #
+  #     (1..10).intersection(5..15)              #=> 5..10
+  #
+  # CREDIT: Trans
+
+  def self.intersection(*ranges)
+    return nil if ranges.empty?
+    ranges.reduce do |result, r|
+      return nil unless result.overlap?(r)
+      new_first = result.first > r.first ? result.first : r.first
+      new_last  = result.last  < r.last  ? result.last  : r.last
+      new_first..new_last
+    end
+  end
+
+  # Returns the intersection of this range with one or more other ranges.
+  # Returns nil if the ranges do not overlap.
+  #
+  #     (1..10).intersection(5..15)        #=> 5..10
+  #     (1..10).intersection(5..15, 8..20) #=> 8..10
+  #     (1..3).intersection(5..7)          #=> nil
+  #
+  def intersection(*others)
+    Range.intersection(self, *others)
+  end
+
+end

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

@@ -0,0 +1,27 @@
+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(value = 1, min: nil, max: nil)
+    if min or max
+      min ||= 0
+      max ||= 0
+    else
+      min = max = value
+    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/ascii_only.rb

@@ -21,7 +21,7 @@ class String
       :replace                     => alt,       # Use a blank for those replacements
       :UNIVERSAL_NEWLINE_DECORATOR => true       # Always break lines with \n
     }
-    self.encode(Encoding.find('ASCII'), encoding_options)
+    self.encode(Encoding.find('ASCII'), **encoding_options)
   end
 
   # Modify string keeping only ASCII characters.
@@ -46,7 +46,7 @@ class String
       :replace                     => alt,       # Use a blank for those replacements
       :UNIVERSAL_NEWLINE_DECORATOR => true       # Always break lines with \n
     }
-    self.encode!(Encoding.find('ASCII'), encoding_options)
+    self.encode!(Encoding.find('ASCII'), **encoding_options)
   end
 
 end

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

@@ -1,5 +1,3 @@
-require "facets/enumerator"
-
 class String
 
   # Returns an Enumerator for iterating over each

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

@@ -0,0 +1,21 @@
+class String
+
+  # Dashcase a string such that camelcase, underscores and spaces are
+  # replaced by dashes. This is similar to {#underscore},
+  # but with dashes instead of underscores.
+  #
+  #   "DashCase".dashcase         #=> "dash-case"
+  #   "Dash-Case".dashcase        #=> "dash-case"
+  #   "Dash Case".dashcase        #=> "dash-case"
+  #   "Dash  -  Case".dashcase    #=> "dash-case"
+
+  def dashcase
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr('_', '-').
+    gsub(/\s/, '-').
+    gsub(/__+/, '-').
+    downcase
+  end
+
+end

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/lchomp.rb

@@ -1,6 +1,6 @@
 class String
 
-  # Left chomp.
+  # Left chomp. Alias for #delete_prefix.
   #
   #   "help".lchomp("h")  #=> "elp"
   #   "help".lchomp("k")  #=> "help"
@@ -8,26 +8,19 @@ class String
   # CREDIT: Trans
 
   def lchomp(match)
-    if index(match) == 0
-      self[match.size..-1]
-    else
-      self.dup
-    end
+    delete_prefix(match)
   end
 
-  # In-place left chomp.
+  # In-place left chomp. Alias for #delete_prefix!.
   #
-  #   "help".lchomp("h")  #=> "elp"
-  #   "help".lchomp("k")  #=> "help"
+  #   s = "help"
+  #   s.lchomp!("h")  #=> "elp"
+  #   s                #=> "elp"
   #
   # CREDIT: Trans
 
   def lchomp!(match)
-    if index(match) == 0
-      self[0...match.size] = ''
-      self
-    end
+    delete_prefix!(match)
   end
 
 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/newlines.rb

@@ -1,5 +1,3 @@
-require "facets/enumerator"
-
 class String
 
   # Returns an Enumerator for iterating over each

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/core/facets/string/snakecase.rb

@@ -9,11 +9,11 @@ class String
   #   "Snake Case".snakecase        #=> "snake_case"
   #   "Snake  -  Case".snakecase    #=> "snake_case"
   #
-  # Note, this method no longer converts `::` to `/`, in that case
-  # use the {#pathize} method instead.
+  # Note, unlike #underscore this does not convert `::` to `/`.
+  # Use {#pathize} for that, or use {#underscore} for ActiveSupport
+  # compatible behavior.
 
   def snakecase
-    #gsub(/::/, '/').
     gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
     gsub(/([a-z\d])([A-Z])/,'\1_\2').
     tr('-', '_').
@@ -22,10 +22,17 @@ class String
     downcase
   end
 
+  # Like #snakecase but also converts '::' to '/' for
+  # namespace-to-path conversion. This is compatible with
+  # ActiveSupport's #underscore.
   #
-  alias_method :underscore, :snakecase
+  #   "SnakeCase".underscore        #=> "snake_case"
+  #   "Foo::Bar".underscore         #=> "foo/bar"
+  #
+  def underscore
+    gsub(/::/, '/').snakecase
+  end
 
   # TODO: Add *separators to #snakecase, like camelcase.
 
 end
-

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

@@ -7,6 +7,18 @@ class String
   def words
     self.split(/\s+/)
   end
-
+  
+  # Returns an array of words in the commonly-understood sense (not including punctuation).
+  # This takes into account international punctuation characters as well as English ones.
+  # 
+  #     'Slowly, grudgingly he said: "This has to stop."'.words
+  #      => ["Slowly", "grudgingly", "he", "said", "This", "has", "to", "stop"]
+  def words_without_punctuation
+    s = self.dup
+    s.gsub!(/[.?¿¡…!,:：;—"。？！、‘“”„«»〈〉《》，\/\[\]]/, ' ')
+    s.gsub!('- ', ' ')
+    s.squeeze!(" ")
+    s.strip.split(" ")
+  end  
 end
 

data/lib/core/facets/string.rb

@@ -3,7 +3,6 @@ require_relative 'string/align.rb'
 require_relative 'string/bracket.rb'
 require_relative 'string/camelcase.rb'
 require_relative 'string/capitalized.rb'
-require_relative 'string/characters.rb'
 require_relative 'string/cleanlines.rb'
 require_relative 'string/cleave.rb'
 require_relative 'string/cmp.rb'
@@ -53,8 +52,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/struct/attributes.rb

@@ -6,9 +6,8 @@ class Struct
   # This will eventually be deprecated in favor of #to_h.
 
   def attributes
-    h = {}
-    each_pair { |k,v| h[k] = v }
-    h
+    warn "Struct#attributes is deprecated. Use Struct#to_h instead.", uplevel: 1
+    to_h
   end
 
 end

data/lib/core/facets/time/trunc.rb

@@ -1,15 +1,22 @@
 class Time
 
-  # Truncate time at give range (in seconds).
+  # Truncate time to a given interval in seconds.
+  # Unlike Ruby's Time#floor which takes sub-second digit precision,
+  # this takes an interval in seconds.
   #
   #   t = Time.now
-  #   t = t.trunc(60*60)
+  #   t = t.floor_to(60*60)
   #   t.min #=> 0
   #   t.sec #=> 0
   #
-  def trunc(amount)
-    self - (self.to_i % amount)
+  def floor_to(seconds)
+    self - (self.to_i % seconds)
   end
 
-end
+  # @deprecated Use Time#floor_to instead.
+  def trunc(seconds)
+    warn "Time#trunc is deprecated. Use Time#floor_to instead.", uplevel: 1
+    floor_to(seconds)
+  end
 
+end

data/lib/core/facets/unboundmethod/arguments.rb

@@ -19,6 +19,7 @@ class UnboundMethod
   # CREDIT: Trans
 
   def arguments
+    warn "UnboundMethod#arguments is deprecated. Use UnboundMethod#parameters instead.", uplevel: 1
     ar = arity
     case ar <=> 0
     when 1

data/lib/core/facets/version.rb

@@ -1,19 +1,3 @@
 module Facets
-  #
-  def self.index
-    @index ||= (
-      require 'yaml'
-      YAML.load(File.new(File.dirname(__FILE__) + '/facets.yml'))
-    )
-  end
-
-  #
-  def self.const_missing(name)
-    key = name.to_s.downcase
-    index[key] || super(name)
-  end
-
-  # deprecate
-  VERSION = '3.0.0'
+  VERSION = '3.2.0'
 end
-

data/lib/core/facets.rb

@@ -8,7 +8,6 @@ require 'facets/comparable.rb'
 require 'facets/denumerable.rb'
 require 'facets/dir.rb'
 require 'facets/enumerable.rb'
-require 'facets/enumerator.rb'
 require 'facets/exception.rb'
 require 'facets/file.rb'
 require 'facets/filetest.rb'

data/lib/standard/facets/argvector.rb

@@ -29,7 +29,7 @@
 #
 # Copyright (c) 2006 Thomas Sawyer
 #
-# Ruby License
+# Ruby License / BSD-2 License
 #
 # This module is free software. You may use, modify, and/or
 # redistribute this software under the same terms as Ruby.