facets 2.9.2 → 2.9.3

data/{src/core-uncommon → lib/core}/facets/string/crypt.rb

@@ -5,9 +5,12 @@ class String
   # Common Unix cryptography method.
   # This adds a default salt to the built-in crypt method.
   #
-  # NOTE: This is not (presently) a common core extension and is not
+  # NOTE: This method is not a common core extension and is not
   # loaded automatically when using <code>require 'facets'</code>.
-
+  #
+  # @uncommon
+  #   require 'facets/string/crypt'
+  #
   def crypt(salt=nil)
     salt ||= (
       (rand(26) + (rand(2) == 0 ? 65 : 97) ).chr +

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

@@ -1,11 +1,18 @@
 class String
 
-  # Translate a (class or module) name to a suitable method name.
+  # Translate a class or module name to a suitable method name.
   #
   #   "My::CoolClass".methodize  #=> "my__cool_class"
   #
-  #--
-  # Rails definition ...
+  def methodize
+    gsub(/([A-Z]+)([A-Z])/,'\1_\2').
+    gsub(/([a-z])([A-Z])/,'\1_\2').
+    gsub('/' ,'__').
+    gsub('::','__').
+    downcase
+  end
+
+  # Compare to ActiveSupport's definition:
   #
   #    gsub(/\//, '__').
   #    gsub(/::/, '__').
@@ -14,14 +21,6 @@ class String
   #    tr("-", "_").
   #    downcase
   #
-  #++
-  def methodize
-    gsub(/([A-Z]+)([A-Z])/,'\1_\2').
-    gsub(/([a-z])([A-Z])/,'\1_\2').
-    gsub('/' ,'__').
-    gsub('::','__').
-    downcase
-  end
 
 end
 

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

@@ -2,30 +2,30 @@ class String
 
   # Converts a string to module name representation.
   #
-  # This is essentially #camelcase. It also converts
-  # '/' to '::' which is useful for converting
-  # paths to namespaces.
+  # This is essentially #camelcase, but it also converts
+  # '/' to '::' which is useful for converting paths to
+  # namespaces.
   #
   # Examples
   #
   #   "method_name".modulize    #=> "MethodName"
   #   "method/name".modulize    #=> "Method::Name"
   #
-  #--
-  # Rails definition ...
+  def modulize
+    #gsub('__','/').  # why was this ever here?
+    gsub(/__(.?)/){ "::#{$1.upcase}" }.
+    gsub(/\/(.?)/){ "::#{$1.upcase}" }.
+    gsub(/(?:_+|-+)([a-z])/){ $1.upcase }.
+    gsub(/(\A|\s)([a-z])/){ $1 + $2.upcase }
+  end
+
+  # Compare to ActiveSupport's definition:
   #
   #    gsub(/__(.?)/){ "::#{$1.upcase}" }.
   #    gsub(/\/(.?)/){ "::#{$1.upcase}" }.
   #    gsub(/(?:_+)([a-z])/){ $1.upcase }.
   #    gsub(/(^|\s+)([a-z])/){ $1 + $2.upcase }
   #
-  #++
-  def modulize
-    gsub('__','/').
-    gsub(/\/(.?)/){ "::#{$1.upcase}" }.
-    gsub(/(?:_+|-+)([a-z])/){ $1.upcase }.
-    gsub(/(\A|\s)([a-z])/){ $1 + $2.upcase }
-  end
 
 end
 

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

@@ -26,6 +26,7 @@
 # 3. This notice may not be removed or altered from any source distribution.
 #++
 
+#
 class String
 
   # 'Natural order' comparison of strings, e.g. ...
@@ -40,7 +41,8 @@ class String
   #
   # TODO: Invert case flag?
   #
-  # CREDIT: Alan Davies, Martin Pool
+  # @author Alan Davies
+  # @author Martin Pool
 
   def natcmp(str2, caseInsensitive=false)
     str1 = self.dup

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

@@ -1,20 +1,24 @@
 class String
 
-  # Converts a camelcase name (e.g. class or module name) to a unix path.
+  # Transforms a namespace, i.e. a class or module name, into a viable 
+  # file path.
   #
   #   "ExamplePathize".pathize           #=> "example_pathize"
   #   "ExamplePathize::Example".pathize  #=> "example_pathize/example"
   #
+  # Compare this method to {String#modulize) and {String#methodize).
+  #
   def pathize
     gsub(/([A-Z]+)([A-Z])/,'\1_\2').
     gsub(/([a-z])([A-Z])/,'\1_\2').
     gsub('__','/').
     gsub('::','/').
+    gsub(/\s+/, '').                # spaces are bad form
+    gsub(/[?%*:|"<>.]+/, '').   # reserved characters
     downcase
   end
 
-  #--
-  # Rails definition ...
+  # Compare to Rails definition:
   #
   #    gsub(/__/, '/').
   #    gsub(/::/, '/').
@@ -22,7 +26,7 @@ class String
   #    gsub(/([a-z\d])([A-Z])/,'\1_\2').
   #    tr("-", "_").
   #    downcase
-  #++
+  #
 
 end
 

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

@@ -0,0 +1 @@
+require 'facets/roman'

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

@@ -1,21 +1,31 @@
 class String
 
-  # The reverse of +camelcase+. Makes an underscored of a camelcase string.
+  # Underscore a string such that camelcase, dashes and spaces are
+  # replaced by underscores. This is the reverse of {#camelcase},
+  # albeit not an exact inverse.
   #
-  # Changes '::' to '/' to convert namespaces to paths.
-  #
-  # Examples
-  #   "SnakeCase".snakecase           #=> "snake_case"
-  #   "Snake-Case".snakecase          #=> "snake_case"
-  #   "SnakeCase::Errors".snakecase   #=> "snake_case/errors"
+  #   "SnakeCase".snakecase         #=> "snake_case"
+  #   "Snake-Case".snakecase        #=> "snake_case"
+  #   "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.
+
   def snakecase
-    gsub(/::/, '/').  # NOT SO SURE ABOUT THIS
+    #gsub(/::/, '/').
     gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
     gsub(/([a-z\d])([A-Z])/,'\1_\2').
-    tr("-", "_").
+    tr('-', '_').
+    gsub(/\s/, '_').
+    gsub(/__+/, '_').
     downcase
   end
 
+  #
+  alias_method :underscore, :snakecase
+
+  # TODO: Add *separators to #snakecase, like camelcase.
+
 end
 

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

@@ -1,15 +1,27 @@
 class String
 
-  # Title case.
+  # Transform a string into a form that makes for an acceptable title.
   #
   #   "this is a string".titlecase
   #   #=> "This Is A String"
   #
-  # CREDIT: Eliazar Parra
+  # @author Eliazar Parra
+  # @author Angelo Lakra (apostrophe fix)
 
   def titlecase
+    tr('_', ' ').
+    gsub(/\s+/, ' ').
     gsub(/\b\w/){ $`[-1,1] == "'" ? $& : $&.upcase }
   end
 
+  # Transform a string into a sentence like form.
+  #
+  #   "This Is A String".briefcase
+  #   #=> "This is a string"
+  #
+  def briefcase
+    titlecase.capitalize
+  end
+
 end
 

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

@@ -1,22 +1 @@
-class String
-
-  # The reverse of +camelcase+. Makes an underscored of a camelcase string.
-  #
-  # Changes '::' to '/' to convert namespaces to paths.
-  #
-  # Examples
-  #
-  #   "SnakeCase".underscore           #=> "snake_case"
-  #   "Snake-Case".underscore          #=> "snake_case"
-  #   "SnakeCase::Errors".underscore   #=> "snake_case/errors"
-  #
-  def underscore
-    gsub(/::/, '/').
-    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-    gsub(/([a-z\d])([A-Z])/,'\1_\2').
-    tr("-", "_").
-    downcase
-  end
-
-end
-
+require 'facets/string/snakecase'

data/lib/core/facets/struct.rb

@@ -1,8 +1,4 @@
-# Require all Struct core extensions.
+require 'facets/kernel/require_relative'
 
-if RUBY_VERSION < '1.9'
-  require "facets/struct/attributes.rb"
-else
-  require_relative "struct/attributes.rb"
-end
+require_relative 'struct/attributes.rb'
 

data/lib/core/facets/symbol.rb

@@ -1,32 +1,16 @@
-# Require all Symbol core extensions.
+require 'facets/kernel/require_relative'
 
-if RUBY_VERSION < '1.9'
-  require "facets/symbol/as_s.rb"
-  require "facets/symbol/bang.rb"
-  require "facets/symbol/chomp.rb"
-  require "facets/symbol/generate.rb"
-  require "facets/symbol/not.rb"
-  require "facets/symbol/op_div.rb"
-  require "facets/symbol/plain.rb"
-  require "facets/symbol/query.rb"
-  require "facets/symbol/setter.rb"
-  require "facets/symbol/succ.rb"
-  require "facets/symbol/thrown.rb"
-  require "facets/symbol/to_proc.rb"
-  require "facets/symbol/variablize.rb"
-else
-  require_relative "symbol/as_s.rb"
-  require_relative "symbol/bang.rb"
-  require_relative "symbol/chomp.rb"
-  require_relative "symbol/generate.rb"
-  require_relative "symbol/not.rb"
-  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/thrown.rb"
-  require_relative "symbol/to_proc.rb"
-  require_relative "symbol/variablize.rb"
-end
+require_relative 'symbol/as_s.rb'
+require_relative 'symbol/bang.rb'
+require_relative 'symbol/chomp.rb'
+require_relative 'symbol/generate.rb'
+require_relative 'symbol/not.rb'
+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/thrown.rb'
+require_relative 'symbol/to_proc.rb'
+require_relative 'symbol/variablize.rb'
 

data/lib/core/facets/symbol/plain.rb

@@ -12,6 +12,10 @@ class Symbol
     !(c == '=' || c == '?' || c == '!')
   end
 
+  # Alias for `#plain?` method. Likely this should have been the original
+  # and only name, but such is life.
+  alias_method :reader?, :plain?
+
   # Symbol ends in `=`.
   #
   #   :a=.setter? #=> true
@@ -21,6 +25,10 @@ class Symbol
     to_s[-1,1] == '='
   end
 
+  # Alias for `#setter?` method. Likely this should have been the original
+  # and only name, but such is life.
+  alias_method :writer?, :setter?
+
   # Symbol ends in `?`.
   #
   #   :a?.query? #=> true

data/lib/core/facets/time.rb

@@ -1,36 +1,18 @@
-# Require all Time core extensions.
+require 'facets/kernel/require_relative'
 
-if RUBY_VERSION < '1.9'
-  require "facets/time/ago.rb"
-  require "facets/time/change.rb"
-  require "facets/time/dst_adjustment.rb"
-  require "facets/time/elapse.rb"
-  require "facets/time/future.rb"
-  require "facets/time/hence.rb"
-  require "facets/time/in.rb"
-  require "facets/time/less.rb"
-  require "facets/time/past.rb"
-  require "facets/time/round_to.rb"
-  require "facets/time/set.rb"
-  require "facets/time/shift.rb"
-  require "facets/time/stamp.rb"
-  require "facets/time/to_time.rb"
-  require "facets/time/trunc.rb"
-else
-  require_relative "time/ago.rb"
-  require_relative "time/change.rb"
-  require_relative "time/dst_adjustment.rb"
-  require_relative "time/elapse.rb"
-  require_relative "time/future.rb"
-  require_relative "time/hence.rb"
-  require_relative "time/in.rb"
-  require_relative "time/less.rb"
-  require_relative "time/past.rb"
-  require_relative "time/round_to.rb"
-  require_relative "time/set.rb"
-  require_relative "time/shift.rb"
-  require_relative "time/stamp.rb"
-  require_relative "time/to_time.rb"
-  require_relative "time/trunc.rb"
-end
+require_relative 'time/ago.rb'
+require_relative 'time/change.rb'
+require_relative 'time/dst_adjustment.rb'
+require_relative 'time/elapse.rb'
+require_relative 'time/future.rb'
+require_relative 'time/hence.rb'
+require_relative 'time/in.rb'
+require_relative 'time/less.rb'
+require_relative 'time/past.rb'
+require_relative 'time/round_to.rb'
+require_relative 'time/set.rb'
+require_relative 'time/shift.rb'
+require_relative 'time/stamp.rb'
+require_relative 'time/to_time.rb'
+require_relative 'time/trunc.rb'
 

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

@@ -3,6 +3,8 @@ require 'facets/time/dst_adjustment'
 
 class Time
 
+  # TODO: Deprecate use of #dst-adjustment in Time#shift ?
+
   # Returns a new Time representing the time shifted by the time-units given.
   # Positive number shift the time forward, negative number shift the time 
   # backward.

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

@@ -1,19 +1,21 @@
 class Time
 
+  # TODO: Time::Formats need improvement!
   unless const_defined?('FORMAT')
     FORMAT = {
-      :db      => "%Y-%m-%d %H:%M:%S",
-      :dbase   => "%Y-%m-%d %H:%M:%S",
-      :datbase => "%Y-%m-%d %H:%M:%S",
-      :utc     => "%Y-%m-%d %H:%M:%S",
-      :number  => "%Y%m%d%H%M%S",
-      :short   => "%d %b %H:%M",
-      :time    => "%H:%M",
-      :long    => "%B %d, %Y %H:%M",
-      :day1st  => "%d-%m-%Y %H:%M",
-      :dmYHM   => "%d-%m-%Y %H:%M",
-      :rfc822  => "%a, %d %b %Y %H:%M:%S %z",
-      nil      => "%a %b %d %H:%M:%S %Z %Y"
+      :utc      => "%Y-%m-%d %H:%M:%S",
+      :utcT     => "%Y-%m-%dT%H:%M:%S",
+      :db       => "%Y-%m-%d %H:%M:%S",
+      :database => "%Y-%m-%d %H:%M:%S",
+      :number   => "%Y%m%d%H%M%S",
+      :short    => "%d %b %H:%M",
+      :time     => "%H:%M",
+      :long     => "%B %d, %Y %H:%M",
+      :day1st   => "%d-%m-%Y %H:%M",
+      :dmYHM    => "%d-%m-%Y %H:%M",
+      :rfc822   => "%a, %d %b %Y %H:%M:%S %z",
+      :ruby18   => "%a %b %d %H:%M:%S %z %Y",
+      nil       => "%Y-%m-%d %H:%M:%S %z"
     }
   end
 

data/lib/core/facets/unboundmethod.rb

@@ -1,10 +1,5 @@
-# Require all UnboundMethod core extensions.
+require 'facets/kernel/require_relative'
 
-if RUBY_VERSION < '1.9'
-  require "facets/unboundmethod/arguments.rb"
-  require "facets/unboundmethod/name.rb"
-else
-  require_relative "unboundmethod/arguments.rb"
-  require_relative "unboundmethod/name.rb"
-end
+require_relative 'unboundmethod/arguments.rb'
+require_relative 'unboundmethod/name.rb'