facets 3.1.0 → 3.2.1

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

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

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'

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

@@ -8,7 +8,7 @@ require_relative 'symbol/op_div.rb'
 require_relative 'symbol/plain.rb'
 require_relative 'symbol/query.rb'
 require_relative 'symbol/setter.rb'
-require_relative 'symbol/succ.rb'
+#require_relative 'symbol/succ.rb'  # removed: now provided by Ruby
 require_relative 'symbol/thrown.rb'
 require_relative 'symbol/variablize.rb'
 

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.1'
 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.

data/lib/standard/facets/cgi/escape_html.rb

@@ -2,26 +2,25 @@ require 'cgi'
 
 class CGI
 
-  # Extends `#escape_html` to support escape modes. By default all strings
-  # are escaped on `&`, `>` and `<`. Add the `:nonstandard` mode to omit
-  # this conversion.
+  # Extended HTML/XHTML escaping with mode support. Unlike Ruby's built-in
+  # `CGI.escape_html`, this supports additional escape modes.
   #
-  # If no mode is given then the `:default` mode is used.
-  #
-  # Available modes include:
+  # Available modes:
   # * `:quote`     - escapes single and double quotes
   # * `:newlines`  - escapes newline characters (\r and \n)
   # * `:ampersand` - escapes the ampersand sign
   # * `:brackets`  - escapes less-than and greater-than signs
   # * `:default`   - escapes double quotes
   #
+  # By default all strings are escaped on `&`, `>`, `<` and `"`.
+  #
   # @example
-  #   escape_html("<tag>")  #=> "&lt;tag&gt;"
-  #   escape_html("Example\nString", :newlines)  #=> "Example&#13;&#10;String"
-  #   escape_html("\"QUOTE\"", false)  #=> "\"QUOTE\""
+  #   CGI.escape_xhtml("<tag>")  #=> "&lt;tag&gt;"
+  #   CGI.escape_xhtml("Example\nString", :newlines)  #=> "Example&#13;&#10;String"
+  #   CGI.escape_xhtml("\"QUOTE\"", false)  #=> "\"QUOTE\""
   #
-  def self.escape_html(string, *modes)
-    modes << :defualt if modes.empty?
+  def self.escape_xhtml(string, *modes)
+    modes << :default if modes.empty?
 
     unless modes.include?(:nonstandard)
       string = string.gsub(/&/, '&amp;').gsub(/>/, '&gt;').gsub(/</, '&lt;')
@@ -32,7 +31,7 @@ class CGI
         case mode
         when :quote, :quotes
           string.gsub(%r|"|,'&quot;').gsub(%r|'|,'&#39;')
-        when :newlines, :newlines
+        when :newlines
           string.gsub(/[\r\n]+/,'&#13;&#10;')
         when :ampersand
           string.gsub(/&/, '&amp;')
@@ -41,23 +40,13 @@ class CGI
         when :default, true
           string.gsub(/\"/, '&quot;')
         when false
+          string
         else
-          raise ArgumentError, "unrecognized HTML escape mode -- #{node}"
+          raise ArgumentError, "unrecognized HTML escape mode -- #{mode}"
         end
     end
-  end
 
-  class << self
-    # @deprecated
-    alias :escapeHTML :escape_html
-  end
-
-  if RUBY_VERSION < '1.9'
-    class << self
-      alias :unescape_html :unescapeHTML
-      alias :escape_element :escapeElement
-      alias :unescape_element :unescapeElement
-    end
+    string
   end
 
 end

data/lib/standard/facets/cloneable.rb

@@ -1,67 +1,20 @@
-# Clonable provides a standard basis for adding deep cloneablity to a class
-# via the standard #dup and #clone methods.
-#
-# Cloneable was originally ported from Jim Weirich's Rake.
-# The current version is the work of Ken Bloom.
-#
-# DEPRECATED: A better approach is to provide a #deep_dup and and a #deep_clone,
-# then if a class needs these for #dup and #clone they can just alias them.
-#
-# CREDIT: Ken Bloom
+# @deprecated Use deep_dup/deep_clone instead, or define your own
+#   initialize_copy method.
+warn "facets/cloneable is deprecated. Use deep_dup/deep_clone instead.", uplevel: 1
 
 module Cloneable
 
   def initialize_copy(sibling)
-    # First duplicate my superclass' state. Note that if it's duplicating
-    # instance variables, this will be overwritten, but this is important
-    # because we could be dealing with a C extension with state hidden from
-    # the Ruby interpreter.
     super
-
-    # We want to know if we're being dup'ed or clone'd, because we want to
-    # preserve the state of our internals the same way our state is being
-    # preserved. (If we can't figure it out, we'll just use #dup.)
     operation = (
       copy_call  = caller.find{|x| x !~ /'initialize_copy'/}
       copy_match = copy_call.match(/`(dup|clone)'/)
       copy_match ? copy_match[1] : :dup
     )
-
     sibling.instance_variables.each do |ivar|
       value = sibling.instance_variable_get(ivar)
-
-      # Set my instance variable to be a #dup or #clone
-      # or my sibling, depending on what's happening to me right now.
       instance_variable_set(ivar, value.send(operation))
     end
   end
 
-  # TODO: Is there a more robust means of determining if clone or dup is used?
-  #def clone
-  #  @_copy_operation = :clone
-  #  super
-  #end
-  #
-  #def dup
-  #  @_copy_operation = :dup
-  #  super
-  #end
-
-end 
-
-
-
-# OLD VERSION
-
-#module Cloneable
-#  def clone
-#    sibling = self.class.new
-#    instance_variables.each do |ivar|
-#      value = self.instance_variable_get(ivar)
-#      sibling.instance_variable_set(ivar, value.dup) #rake_dup)
-#    end
-#    sibling
-#  end
-#  alias_method :dup, :clone
-#end
-
+end

data/lib/standard/facets/continuation.rb

@@ -1,56 +1,2 @@
-if defined?(Continuation)
-
-  # = Continuation Extension
-  #
-  # Creates a continuation in a way that is easier to use than callcc.
-  # On the initial call this will return the created Continuation and
-  # the arguments you gave to Continuation.create in an Array. If you
-  # then issue .call() on the Continuation execution will jump back to
-  # the point of time where you initially invoked Continuation.create,
-  # but this time it will return the Continuation and the arguments
-  # you supplied in an Array.
-  #
-  # You can supply a block instead of default arguments which will
-  # cause that block to be executed once and its result to be returned
-  # along side the created Continuation, but this form is confusing
-  # and does only rarely make sense.
-  #
-  #   # Count from 0 to 10
-  #   cc, counter = Continuation.create(0)
-  #   counter   #~> 0..10
-  #   cc.call(counter + 1) if counter < 10
-  #
-  #   # Implement something similar to Array#inject using Continuations.
-  #   # For simplicity's sake, this is not fully compatible with the real
-  #   # inject. Make sure that you understand Array#inject before you try
-  #   # to understand this.
-  #   class ::Array
-  #     def cc_inject(value = nil)
-  #       copy = self.clone
-  #       cc, result, item = Continuation.create(value, nil)
-  #       next_item = copy.shift
-  #       if result and item
-  #         # Aggregate the result using the block.
-  #         cc.call(yield(result, item), next_item)
-  #       elsif next_item
-  #         # item not yet set and Array is not empty:
-  #         # This means we did not get a value and thus need to use the
-  #         # first item from the Array before we can start using the
-  #         # block to aggregate the result.
-  #         cc.call(next_item, result)
-  #       end
-  #
-  #       return result
-  #    end
-  #  end
-  #  [1,2,3,4,5].cc_inject { |acc, n| acc + n } # => 15
-  #
-  def Continuation.create(*args, &block)
-    args = [args] if not args.nil? and not args.is_a? Array # 1.6.8 compatibility
-    cc = nil; result = callcc {|c| cc = c; block.call(cc) if block and args.empty?}
-    result ||= args
-    return *[cc, *result]
-  end
-
-end
-
+# @deprecated callcc is obsolete in Ruby. Use Fiber instead.
+warn "facets/continuation is deprecated. callcc is obsolete; use Fiber instead.", uplevel: 1

data/lib/standard/facets/crypt3.rb

@@ -0,0 +1,126 @@
+# Crypt3 is a pure Ruby version of crypt(3), a salted one-way hashing
+# of a password.
+#
+# Supported hashing algorithms are: md5, sha1, sha256, sha384, sha512, rmd160.
+#
+# Only the md5 hashing algorithm is standard and compatible with crypt(3),
+# the others are not standard.
+#
+# Originally written by Poul-Henning Kamp (Beer-Ware License).
+# Adapted by guillaume.pierronnet based on FreeBSD src/lib/libcrypt/crypt.c
+#
+# Copyright (c) 2002 Poul-Henning Kamp
+# License: BSD-2-Clause
+
+module Crypt3
+
+  VERSION = '1.2.0'
+
+  # Base 64 character set.
+  ITOA64 = "./0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+
+  # A pure ruby version of crypt(3), a salted one-way hashing of a password.
+  #
+  # Automatically generates an 8-byte salt if none given.
+  #
+  #   Crypt3.crypt('password')           #=> "$1$xxxxxxxx$hash..."
+  #   Crypt3.crypt('password', :sha256)  #=> "$1$xxxxxxxx$hash..."
+  #
+  # password - The phrase to encrypt. [String]
+  # algo     - The algorithm to use. [Symbol]
+  # salt     - Cryptographic salt, random if nil. [String]
+  # magic    - The magic prefix. [String]
+  #
+  # Returns the cryptographic hash. [String]
+  def self.crypt(password, algo = :md5, salt = nil, magic = '$1$')
+    salt ||= generate_salt(8)
+
+    case algo
+    when :md5
+      require "digest/md5"
+    when :sha1
+      require "digest/sha1"
+    when :rmd160
+      require "digest/rmd160"
+    when :sha256, :sha384, :sha512
+      require "digest/sha2"
+    else
+      raise(ArgumentError, "unknown algorithm: #{algo}")
+    end
+
+    digest_class = Digest.const_get(algo.to_s.upcase)
+
+    m = digest_class.new
+    m.update(password + magic + salt)
+
+    mixin = digest_class.new.update(password + salt + password).digest
+    password.length.times do |i|
+      m.update(mixin[i % 16].chr)
+    end
+
+    i = password.length
+    while i != 0
+      if (i & 1) != 0
+        m.update("\x00")
+      else
+        m.update(password[0].chr)
+      end
+      i >>= 1
+    end
+
+    final = m.digest
+
+    1000.times do |i|
+      m2 = digest_class.new
+      m2.update((i & 1) != 0 ? password : final)
+      m2.update(salt) if (i % 3) != 0
+      m2.update(password) if (i % 7) != 0
+      m2.update((i & 1) != 0 ? final : password)
+      final = m2.digest
+    end
+
+    rearranged = ""
+    [[0, 6, 12], [1, 7, 13], [2, 8, 14], [3, 9, 15], [4, 10, 5]].each do |a, b, c|
+      v = final.getbyte(a) << 16 | final.getbyte(b) << 8 | final.getbyte(c)
+      4.times do
+        rearranged += ITOA64[v & 0x3f]
+        v >>= 6
+      end
+    end
+
+    v = final.getbyte(11)
+    2.times do
+      rearranged += ITOA64[v & 0x3f]
+      v >>= 6
+    end
+
+    magic + salt + '$' + rearranged
+  end
+
+  # Check the validity of a password against a hashed string.
+  #
+  #   Crypt3.check('password', '$1$xxxxxxxx$hash...')  #=> true
+  #
+  # password - The phrase that was encrypted. [String]
+  # hash     - The cryptographic hash. [String]
+  # algo     - The algorithm used. [Symbol]
+  #
+  # Returns true if valid. [Boolean]
+  def self.check(password, hash, algo = :md5)
+    magic, salt = hash.split('$')[1, 2]
+    magic = '$' + magic + '$'
+    self.crypt(password, algo, salt, magic) == hash
+  end
+
+  # Generate a random salt of the given size.
+  #
+  #   Crypt3.generate_salt(8)  #=> "xK3d9Wq2"
+  #
+  # size - The size of the salt. [Integer]
+  #
+  # Returns random salt. [String]
+  def self.generate_salt(size)
+    (1..size).map { ITOA64[rand(ITOA64.size)] }.join
+  end
+
+end

data/lib/standard/facets/date/cmp.rb

@@ -0,0 +1,32 @@
+
+require 'date'
+
+class Time
+	alias_method :old_compare, :<=>
+	private :old_compare
+	
+	# Allow for Date <=> DateTime <=> Time, to work as expected.
+	
+	def <=>(other)
+		if Date === other or DateTime === other
+			self.to_datetime <=> other
+		else
+			old_compare(other)
+		end
+	end
+end
+
+class Date
+	alias_method :old_compare, :<=>
+	private :old_compare
+	
+	# Allow for Date <=> DateTime <=> Time, to work as expected.
+	
+	def <=>(other)
+		if Time === other
+			self.to_datetime <=> other.to_datetime
+		else
+			old_compare(other)
+		end
+	end
+end

data/lib/standard/facets/date.rb

@@ -1,5 +1,6 @@
 require 'date'
 require 'facets/time/stamp'
+require 'facets/date/cmp'
 
 # = Date
 #

data/lib/standard/facets/digest.rb

@@ -1,2 +1 @@
-require 'facets/digest/base64digest'
 require 'facets/digest/salted_digest'

data/lib/standard/facets/fileutils/cp_rx.rb

@@ -14,7 +14,6 @@ module FileUtils
   # subdirectory is automatically skipped as well.
 
   def cp_rx(src, dest, options = {}, &filter)
-	  fu_check_options(options, OPT_TABLE['cp_r'])
     if options[:verbose]
 	    fu_output_message("cp -r#{options[:preserve] ? 'p' : ''}#{options[:remove_destination] ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}")
     end
@@ -41,4 +40,3 @@ module FileUtils
   end
 
 end
-

data/lib/standard/facets/fileutils/ln_r.rb

@@ -27,7 +27,6 @@ module FileUtils
     #
     # TODO: Why --remove-destination and not just --force?
     def ln_r(src, dest, options = {})
-      fu_check_options options, OPT_TABLE['ln_r']
       fu_output_message "ln -r#{options[:remove_destination] ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
       return if options[:noop]
       options = options.dup

data/lib/standard/facets/find/select.rb

@@ -1,5 +1,3 @@
-require 'facets/enumerator'
-
 module Find
   # Identical to find except select returns the matching files as an array.
   # (find returns nil, which is not very useful if you actually wanted an array.)