facets 2.8.4 → 2.9.0.pre.1

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

@@ -1,97 +1 @@
-require 'facets/time/set'
-
-class Time
-
-  if defined?(::ActiveSupport) && method_defined?(:since)
-
-    alias_method :in, :since
-    alias_method :hence, :since
-
-  else
-
-    # Returns a new Time representing the time
-    # a number of time-units ago.
-    #
-    def ago(number, units=:seconds)
-      return hence(-number, units) if number < 0
-
-      time = (
-        case units.to_s.downcase.to_sym
-        when :years
-          set(:year => (year - number))
-        when :months
-          new_month = ((month - number - 1) % 12) + 1
-          y = (number / 12) + (new_month > month ? 1 : 0)
-          set(:year => (year - y), :month => new_month)
-        when :weeks
-          self - (number * 604800)
-        when :days
-          self - (number * 86400)
-        when :hours
-          self - (number * 3600)
-        when :minutes
-          self - (number * 60)
-        when :seconds, nil
-          self - number
-        else
-          raise ArgumentError, "unrecognized time units -- #{units}"
-        end
-      )
-      dst_adjustment(time)
-    end
-    #
-    # Returns a new Time representing the time
-    # a number of time-units hence.
-
-    def hence(number, units=:seconds)
-      return ago(-number, units) if number < 0
-
-      time = (
-        case units.to_s.downcase.to_sym
-        when :years
-          set( :year=>(year + number) )
-        when :months
-          new_month = ((month + number - 1) % 12) + 1
-          y = (number / 12) + (new_month < month ? 1 : 0)
-          set(:year => (year + y), :month => new_month)
-        when :weeks
-          self + (number * 604800)
-        when :days
-          self + (number * 86400)
-        when :hours
-          self + (number * 3600)
-        when :minutes
-          self + (number * 60)
-        when :seconds
-          self + number
-        else
-          raise ArgumentError, "unrecognized time units -- #{units}"
-        end
-      )
-      dst_adjustment(time)
-    end
-
-    alias_method :in, :hence
-    alias_method :since, :hence
-
-    # Adjust DST
-    #
-    # TODO: Can't seem to get this to pass ActiveSupport tests.
-    # Even though it is essentially identical to the
-    # ActiveSupport code (see Time#since in time/calculations.rb).
-    # It handles all but 4 tests.
-    def dst_adjustment(time)
-      self_dst = self.dst? ? 1 : 0
-      time_dst = time.dst? ? 1 : 0
-      seconds  = (self - time).abs
-      if (seconds >= 86400 && self_dst != time_dst)
-        time + ((self_dst - time_dst) * 60 * 60)
-      else
-        time
-      end
-    end
-
-  end
-
-end
-
+require 'facets/time/in'

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

@@ -0,0 +1,93 @@
+require 'facets/time/set'
+require 'facets/time/dst_adjustment'
+
+class Time
+
+  # Returns a new Time representing the time a number of
+  # time-units in the futue.
+  #
+  #   t = Time.utc(2010,10,10,0,0,0)
+  #
+  #   t.in(4, :days)             #=>  Time.utc(2010,10,14,0,0,0)
+  #
+  # More than one unit of time can be given.
+  #
+  #   t.in(4, :days, 3, :hours)  #=>  Time.utc(2010,10,14,3,0,0)
+  #
+  # The #in method can also take a hash.
+  #
+  #   t.in(:days=>4, :hours=>3)  #=>  Time.utc(2010,10,14,3,0,0)
+  #
+  def in(*time_units)
+    time_hash = Hash===time_units.last ? time_units.pop : {}
+    time_units << :seconds if time_units.size % 2 == 1
+    time_hash.each{ |units, number| time_units << [number, units] }
+    time = self
+    time_units.flatten.each_slice(2) do |number, units|
+      next time = time.ago(-number, units) if number < 0
+      time = (
+        case units.to_s.downcase.to_sym
+        when :years, :year
+          time.set( :year=>(year + number) )
+        when :months, :month
+          new_month = ((month + number - 1) % 12) + 1
+          y = (number / 12) + (new_month < month ? 1 : 0)
+          time.set(:year => (year + y), :month => new_month)
+        when :weeks, :week
+          time + (number * 604800)
+        when :days, :day
+          time + (number * 86400)
+        when :hours, :hour
+          time + (number * 3600)
+        when :minutes, :minute, :mins, :min
+          time + (number * 60)
+        when :seconds, :second, :secs, :sec, nil
+          time + number
+        else
+          raise ArgumentError, "unrecognized time units -- #{units}"
+        end
+      )
+    end
+    dst_adjustment(time)
+  end
+
+  # Returns a new Time representing the time
+  # a number of time-units ago.
+  #
+  def ago(*time_units)
+    time_hash = Hash===time_units.last ? time_units.pop : {}
+    time_units << :seconds if time_units.size % 2 == 1    
+    time_hash.each{ |units, number| time_units << [number, units] }
+    time = self
+    time_units.each_slice(2) do |number, units|
+      next time = time.in(-number, units) if number < 0
+      time = (
+        case units.to_s.downcase.to_sym
+        when :years, :year
+          time.set(:year => (year - number))
+        when :months, :month
+          new_month = ((month - number - 1) % 12) + 1
+          y = (number / 12) + (new_month > month ? 1 : 0)
+          time.set(:year => (year - y), :month => new_month)
+        when :weeks, :week
+          time - (number * 604800)
+        when :days, :day
+          time - (number * 86400)
+        when :hours, :hour
+          time - (number * 3600)
+        when :minutes, :minute, :mins, :min
+          time - (number * 60)
+        when :seconds, :second, :secs, :sec, nil
+          time - number
+        else
+          raise ArgumentError, "unrecognized time units -- #{units}"
+        end
+      )
+    end
+    dst_adjustment(time)
+  end unless method_defined?(:ago)
+
+  # Alias for #in.
+  alias_method :hence, :in unless method_defined?(:hence)
+
+end

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

@@ -0,0 +1,21 @@
+require 'facets/time/trunc'
+
+class Time
+
+  # Round time at the nearest range (in seconds).
+  #
+  #   t1 = Time.now
+  #   t2 = t1.round_to(60*60)
+  #   t2.min #=> 0
+  #   t2.sec #=> 0
+  #
+  # TODO: What about `round(:minute)`?
+  #
+  # TODO: Fractional seconds should round the usec.
+  #
+  def round_to(seconds)
+    (self + seconds / 2.0).trunc(seconds)
+  end
+
+end
+

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

@@ -3,11 +3,17 @@ class Time
   # Like change but does not reset earlier times.
   #
   # NOTE: It would be better, probably if this were called "change".
-  #       and that #change were called "reset".
+  # and that #change were called "reset".
   #
   def set(options)
-    opts={}; options.each_pair{ |k,v| opts[k] = v.to_i }
-    self.class.send( self.utc? ? :utc : :local,
+    opts={}
+    options.each_pair do |k,v| 
+      k = :min if k.to_s =~ /^min/
+      k = :sec if k.to_s =~ /^sec/
+      opts[k] = v.to_i 
+    end
+    self.class.send(
+      self.utc? ? :utc : :local,
       opts[:year]  || self.year,
       opts[:month] || self.month,
       opts[:day]   || self.day,

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

@@ -27,7 +27,8 @@ class Time
 
   # Create a time stamp.
   #
-  #   Time.now.stamp(:short)    #=> "01 Dec 15:15"
+  #   t = Time.at(10000)
+  #   t.stamp(:short)    #=> "31 Dec 21:46"
   #
   # Supported formats come from the Time::FORMAT constant.
   #

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

@@ -9,8 +9,8 @@ class Time
       getlocal 
     end
 
-    # A method to keep Time, Date and DateTime instances interchangeable on conversions.
-    # In this case, it simply returns +self+.
+    # A method to keep Time, Date and DateTime instances interchangeable
+    # on conversions. In this case, it simply returns +self+.
     #def to_time
     #  self
     #end

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

@@ -3,9 +3,9 @@ class Time
   # Truncate time at give range (in seconds).
   #
   #   t = Time.now
-  #   =>
-  #   t.trunc(60*60) # 1 hour
-  #   =>
+  #   t = t.trunc(60*60)
+  #   t.min #=> 0
+  #   t.sec #=> 0
   #
   def trunc(amount)
     self - (self.to_i % amount)

data/lib/core/facets/to_hash.rb

@@ -36,12 +36,11 @@ class Array
   # This has been left in for backward compatability.
   #
   # NOTE: The use of a +values+ parameter has been deprecated
-  # because that functionality is as simple as:
+  # because that functionality is as simple as ...
   #
   #   array1.zip(array2).to_h
   #
-  # CREDIT: Robert Klemme
-  # CREDIT: Trans
+  # CREDIT: Robert Klemme, Trans
   #
   #--
   # The +True+ option in the case statement provides some
@@ -75,19 +74,19 @@ class Array
   # #to_h_flat.
   #
   #   a = [ [:a,1], [:b,2] ]
-  #   a.to_h  #=> { :a=>1, :b=>2 }
+  #   a.to_h_auto  #=> { :a=>1, :b=>2 }
   #
   # If the array contains only arrays, but are not perfect pairs,
   # then #to_h_multi is called.
   #
   #   a = [ [:a,1,2], [:b,2], [:c], [:d] ]
-  #   a.to_h  #=> { :a=>[1,2], :b=>[2], :c=>[], :d=>[] }
+  #   a.to_h_auto  #=> { :a=>[1,2], :b=>[2], :c=>[], :d=>[] }
   #
   # If the array contians objects other then arrays then
   # the #to_h_splat method is called.
   #
   #   a = [ [:a,1,2], 2, :b, [:c,3], 9 ]
-  #   a.to_h  #=> { [:a,1,2]=>2, :b=>[:c,3], 9=>nil } 
+  #   a.to_h_auto  #=> { [:a,1,2]=>2, :b=>[:c,3], 9=>nil } 
   #
   def to_h_auto
     pairs = true
@@ -137,9 +136,11 @@ class Array
     Hash[*a]
   end
 
+  #--
   #def to_h_flat
   #  each_slice(2).inject({}) {|ha,(k,v)| ha[k]=v; ha}
   #end 
+  #++
 
   # When a mixed or multi-element accociative array
   # is used, the result is as follows:
@@ -151,7 +152,7 @@ class Array
   # the value will be set to the last occuring value.
   #
   #   a = [ :x, [:x], [:x,1,2], [:x,3], [:x,4] ]
-  #   a.to_h_assoc  #=> { :x=>4 }
+  #   a.to_h_assoc  #=> { :x=>[4] }
   #
   def to_h_assoc
     h = {}
@@ -182,6 +183,7 @@ class Array
     h
   end
 
+  #--
   #def to_h_multi
   #  inject({}) {|h,a| h[a.first] = a[1..-1]; h}
   #end
@@ -194,6 +196,7 @@ class Array
   #  end
   #  h
   #end
+  #++
 
 end
 
@@ -207,11 +210,10 @@ class Hash
 
   def to_h; rehash; end
 
-  # Returns _self_.
-  #
-  # CREDIT: Trans
-
-  def to_hash; self; end
+  unless method_defined?(:to_hash) # 1.9.?+
+    # Returns _self_.
+    def to_hash; self; end
+  end
 
 end
 
@@ -246,9 +248,11 @@ module Enumerable
     to_a.to_h_multi
   end
 
+  #--
   #def to_hash
   #  to_a.to_hash
   #end
+  #++
 
 end
 

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

@@ -7,13 +7,13 @@ class UnboundMethod
     # Be aware that in ruby 1.9 UnboundMethod#name is defined already,
     # but it returns a Symbol not a String.
     #
-    #   class X
+    #   class NameExample
     #     def foo; end
     #   end
     #
-    #   meth = X.instance_method(:foo)
+    #   meth = NameExample.instance_method(:foo)
     #
-    #   meth.name  #=> :foo
+    #   meth.name.to_sym  #=> :foo
     #
     # CREDIT: Trans
 

data/lib/more/facets/argvector.rb

@@ -19,7 +19,7 @@
 #   cargs.flags         #=> ['a']
 #   cargs.preoptions    #=> {'a'=>true}
 #   cargs.preflags      #=> ['a']
-#   cargs.subcommand    #=> ['foo',{'b'=>'2'}]
+#   cargs.subcommand    #=> ['foo', [], {'b'=>'2'}]
 #
 # == Authors
 #
@@ -60,7 +60,7 @@ require 'shellwords'
 #   cargs.flags         #=> ['a']
 #   cargs.preoptions    #=> {'a'=>true}
 #   cargs.preflags      #=> ['a']
-#   cargs.subcommand    #=> ['foo',{'b'=>'2'}]
+#   cargs.subcommand    #=> ['foo', [], {'b'=>'2'}]
 #
 class Argvector
 
@@ -71,9 +71,9 @@ class Argvector
   attr :line
   attr :argv
   attr :arity
-  #attr :opts
+  ##attr :opts
 
-  #alias :flags :options
+  ##alias :flags :options
 
   # Takes the command line string (or array) and options.
   # Options have flags and end with a hash of option arity.
@@ -87,7 +87,6 @@ class Argvector
   public
 
   # Returns operand array.
-
   def operands
     @operands
   end
@@ -96,20 +95,17 @@ class Argvector
   alias arguments operands
 
   # Returns options hash.
-
   def options
     @options
   end
 
   # Returns [operands, options], which is good for plugging
   # directly into a method.
-
   def parameters
     return @operands, @options
   end
 
   # Return flags, which are true options.
-
   def flags
     f = []
     @options.each do |k, v|
@@ -123,7 +119,6 @@ class Argvector
   # Assumes the first operand is a "subcommand" and
   # returns it and the argments following it as
   # parameters.
-
   def subcommand_with_parameters
     opts, args = *parse_preoptions(argv)
     cmd = args.shift
@@ -163,7 +158,7 @@ class Argvector
   #   cargs = Argvector.new(line)
   #   opts = cargs.preoptions
   #   opts #=> {"trace"=>true}
-
+  #
   def preoptions
     preopts, remainder = *parse_preoptions(argv)
     return preopts
@@ -171,7 +166,6 @@ class Argvector
 
   # Same as +flags+ but only returns flags in the
   # preoptions.
-
   def preflags
     preopts, remainder = *parse_preoptions(argv)
     f = []
@@ -184,7 +178,6 @@ class Argvector
   end
 
   # Like parameters but without allowing for duplicate options.
-
   def parameters_without_duplicates
     opts = {}
     @options.each do |k,v|
@@ -197,15 +190,16 @@ class Argvector
     return @operands, opts
   end
 
-  private # ------------------
+  #private
 
   # Basic parser partitions the command line into options and
   # operands. Options are converted to a hash and the two 
   # parts are returned.
   #
   #   line = "--trace stamp --file=VERSION"
+  #   argv = Argvector.new(line)
   #
-  #   args, keys = *parse_command(line)
+  #   args, keys = *argv.parse
   #
   #   args #=> ["stamp"]
   #   keys #=> {"trace"=>true, "file"=>"VERSION"}
@@ -223,7 +217,6 @@ class Argvector
 
   # First pass parser to split the command line into an
   # array using Shellwords, if not already so divided.
-
   def parse_line(line=nil)
     if line
       case line
@@ -240,16 +233,15 @@ class Argvector
     return line, argv
   end
 
-  # Ensure opts are a uniform.
-  #
-  #def clean_opts( opts )
-  #  opts2 = opts.collect{ |o| o.to_sym }
-  #  opts2 = opts2 & [:simple, :repeat]  # valid options only
-  #  return opts2
-  #end
+  ## Ensure opts are a uniform.
+  ##
+  ##def clean_opts( opts )
+  ##  opts2 = opts.collect{ |o| o.to_sym }
+  ##  opts2 = opts2 & [:simple, :repeat]  # valid options only
+  ##  return opts2
+  ##end
 
   # Ensure arity is uniform.
-
   def parse_arity(arity)
     arity2 = {}
     arity.each{ |k,v| arity2[k.to_s] = v.to_i }
@@ -258,9 +250,8 @@ class Argvector
 
   # Parse preoptions. A "preoption" is one that
   # occurs before the first operans (if any).
-
   def parse_preoptions(args)
-    #args = args.dup
+    ##args = args.dup
     args = multi_flag(args) #unless opts.include?(:simple)
 
     flags = []
@@ -283,18 +274,18 @@ class Argvector
     return flags, args
   end
 
-  # Parse flags takes the command line and
-  # transforms it such that flags (eg. -x and --x)
-  # are elemental associative arrays.
+  # Parse flags takes the command line and transforms it such that
+  # flags (eg. -x and --x) are elemental associative arrays.
   #
   #   line = "--foo hello --try=this"
+  #   argv = Argvector.new(line)
   #
-  #   parse_flags(line) #=> [ [foo,true], hello, ["try","this"] ]
+  #   args = line.split(/\s/)
+  #   argv.assoc_options(args)  #=> [ ["foo",true], "hello", ["try","this"] ]
   #
   def assoc_options(args)
-    #args = args.dup
+    ##args = args.dup
     args = multi_flag(args) #unless opts.include?(:simple)
-
     i = 0
     while i < args.size
       arg = args[i]
@@ -322,7 +313,6 @@ class Argvector
 
   # Split single letter option groupings into separate options.
   # ie. -xyz => -x -y -z
-
   def multi_flag(args=nil)
     args ||= argv
     args.collect { |arg|
@@ -336,7 +326,6 @@ class Argvector
 
   # Format flag options. This converts the associative array of
   # options/flags into a hash. Repeat options will be placed in arrays.
-
   def format_options(assoc_options)
     opts = {}
     assoc_options.each do |k,v|
@@ -351,3 +340,4 @@ class Argvector
 
 end
 
+ArgVector = Argvector