time_ext 0.2.0 → 0.2.1

data/README.md

@@ -14,7 +14,7 @@ This gem extends the abilities of Ruby's built-in Time class by building on top
 
     require "time/ext" # or "time_ext"
     Time.utc(2010, 6, 19).round(:month) #=> Thu Jul 01 00:00:00 UTC 2010
-    #=> Beginning of this week, or next week depending on which date is closest
+    #=> Beginning of this month, or beginning of next month depending on which is closest
     Time.now.each_hour.until(6.hours.from_now) { |t| puts t.to_s }
     #=> Prints the time at one hour interals from now till 6 hours from now
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/lib/time_ext/backwards_compatibility.rb

@@ -0,0 +1,14 @@
+module TimeExt
+  # Provides helper methods used by TimeExt::Calculations for backwards compatibility with ActiveSupport.
+  module BackwardsCompatibility
+    
+    def days_into_week
+      defined?(DAYS_INTO_WEEK) ? DAYS_INTO_WEEK : { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6 }
+    end
+  
+    def common_year_days_in_month
+      defined?(COMMON_YEAR_DAYS_IN_MONTH) ? COMMON_YEAR_DAYS_IN_MONTH : [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+    end
+    
+  end
+end

data/lib/time_ext/calculations.rb

@@ -0,0 +1,193 @@
+module TimeExt
+  # Adds an even greater extent of calculation methods on top of those already provided by ActiveSupport.
+  module Calculations
+  
+    # Returns a new Time representing the start of the unit specified (second by default).
+    def floor(unit = :sec)
+      self.send("beginning_of_#{unit}")
+    end
+    alias :beginning_of :floor
+    alias :at_beginning_of :floor
+  
+    # Returns a new Time representing the start of the next unit specified (second by default).
+    def ceil(unit = :sec)
+      self.send("next_#{unit}").send("beginning_of_#{unit}")
+    end
+    alias :beginning_of_next :ceil
+    alias :at_beginning_of_next :ceil
+  
+    # Returns a new Time representing the start of the current or next unit specified (second by default) depending which is closest
+    def round(unit = :sec)
+      next_unit = self.ceil(unit)
+      this_unit = self.floor(unit)
+      (self - this_unit) < (next_unit - self) ? this_unit : next_unit
+    end
+    alias :beginning_of_closest :round
+  
+    # Returns a new Time representing the previoius unit specified (defaults to second).
+    def prev(unit = :sec)
+      send("prev_#{unit}")
+    end
+  
+    # Returns a new Time representing the next unit specified (defaults to second).
+    def next(unit = :sec)
+      send("next_#{unit}")
+    end
+  
+    # Short-hand for seconds_ago(1).
+    def prev_second
+      seconds_ago(1)
+    end
+    alias :prev_sec :prev_second
+  
+    # Short-hand for seconds_since(1).
+    def next_second
+      seconds_since(1)
+    end
+    alias :next_sec :next_second
+  
+    # Short-hand for minutes_ago(1).
+    def prev_minute
+      minutes_ago(1)
+    end
+    alias :prev_min :prev_minute
+  
+    # Short-hand for minutes_since(1).
+    def next_minute
+      minutes_since(1)
+    end
+    alias :next_min :next_minute
+  
+    # Short-hand for hours_ago(1).
+    def prev_hour
+      hours_ago(1)
+    end
+  
+    # Short-hand for hours_since(1).
+    def next_hour
+      hours_since(1)
+    end
+  
+    # Short-hand for days_ago(1).
+    def prev_day
+      days_ago(1)
+    end
+  
+    # Short-hand for days_since(1).
+    def next_day
+      days_since(1)
+    end
+  
+    # Returns a new Time representing the start of the given day in the previous week (default is Monday).
+    def prev_week(day = :monday)
+      weeks_ago(1).beginning_of_week.since(days_into_week[day].day).change(:hour => 0)
+    end
+  
+    # Short-hand for quarters_since(1).beginning_of_quarter.
+    def next_quarter
+      quarters_since(1).beginning_of_quarter
+    end
+  
+    # Short-hand for quarters_ago(1).beginning_of_quarter.
+    def prev_quarter
+      quarters_ago(1).beginning_of_quarter
+    end
+  
+    # Returns a new Time representing the time a number of specified minutes ago.
+    def minutes_ago(minutes)
+      ago(minutes.minutes)
+    end
+    alias :mins_ago :minutes_ago
+  
+    # Returns a new Time representing the time a number of specified minutes in the future.
+    def minutes_since(minutes)
+      since(minutes.minutes)
+    end
+    alias :mins_since :minutes_since
+  
+    # Returns a new Time representing the time a number of specified hours ago.
+    def hours_ago(hours)
+      ago(hours.hours)
+    end
+  
+    # Returns a new Time representing the time a number of specified hours in the future.
+    def hours_since(hours)
+      since(hours.hours)
+    end
+  
+    # Returns a new Time representing the time a number of specified days ago.
+    def days_ago(days)
+      ago(days.days)
+    end
+  
+    # Returns a new Time representing the time a number of specified days in the future.
+    def days_since(days)
+      since(days.days)
+    end
+  
+    # Returns a new Time representing the time a number of specified weeks ago.
+    def weeks_ago(weeks)
+      ago(weeks.weeks)
+    end
+  
+    # Returns a new Time representing the time a number of specified weeks in the future.
+    def weeks_since(weeks)
+      since(weeks.weeks)
+    end
+  
+    # Returns a new Time representing the time a number of specified quarters (3 months) ago.
+    def quarters_ago(quarters)
+      ago((quarters * 3).months)
+    end
+  
+    # Returns a new Time representing the time a number of specified quarters (3 months) in the future.
+    def quarters_since(quarters)
+      since((quarters * 3).months)
+    end
+  
+    # Returns a new Time representing the end of the unit specified (defaults to second).
+    def end_of(unit = :sec)
+      send("end_of_#{unit}")
+    end
+  
+    # Returns a new Time representing the start of the second, XX:XX:XX.000000 (.000000000 in ruby1.9).
+    def beginning_of_second
+      change(:usec => 0)
+    end
+    alias :beginning_of_sec :beginning_of_second
+    alias :at_beginning_of_sec :beginning_of_second
+    alias :at_beginning_of_second :beginning_of_second
+  
+    # Returns a new Time representing the end of the hour, XX:XX:XX.999999 (.999999999 in ruby1.9).
+    def end_of_second
+      change(:usec => 999999.999)
+    end
+    alias :end_of_sec :end_of_second
+  
+    # Returns a new Time representing the start of the minute (XX:XX:00).
+    def beginning_of_minute
+      change(:sec => 0, :usec => 0)
+    end
+    alias :beginning_of_min :beginning_of_minute
+    alias :at_beginning_of_min :beginning_of_minute
+    alias :at_beginning_of_minute :beginning_of_minute
+  
+    # Returns a new Time representing the end of the hour, XX:XX:59.999999 (.999999999 in ruby1.9).
+    def end_of_minute
+      change(:sec => 59, :usec => 999999.999)
+    end
+    alias :end_of_min :end_of_minute
+  
+    # Returns a new Time representing the start of the hour (XX:00:00).
+    def beginning_of_hour
+      change(:min => 0, :sec => 0, :usec => 0)
+    end
+    alias :at_beginning_of_hour :beginning_of_hour
+  
+    # Returns a new Time representing the end of the hour, XX:59:59.999999 (.999999999 in ruby1.9).
+    def end_of_hour
+      change(:min => 59, :sec => 59, :usec => 999999.999)
+    end
+  
+  end
+end

data/lib/time_ext/core_ext/time.rb

@@ -0,0 +1,12 @@
+class Time
+  include TimeExt::MethodChain
+  include TimeExt::BackwardsCompatibility
+  include TimeExt::Calculations
+  include TimeExt::Iterations
+  
+  # Aliases to keep available method names to a standard pattern.
+  alias :secs_ago :ago
+  alias :seconds_ago :ago
+  alias :secs_since :since
+  alias :seconds_since :since
+end

data/lib/time_ext/iterations.rb

@@ -0,0 +1,82 @@
+module TimeExt
+  # Allows you to iterate over Time objects with #each and other methods almost as if it was an Array or Hash.
+  module Iterations
+
+    # Used by #each, #map_each and similar methods to iterate over ranges of time.
+    def iterate(unit, options = {}, &block)
+      options.reverse_merge!(:map_result => false, :beginning_of => false, :include_start => false)
+      if block_given?
+        units = [:year, :month, :day, :hour, :min, :sec, :usec]
+        parent_unit = units[units.index(unit)-1]
+        @until ||= (!parent_unit.nil?) ? self.send("#{parent_unit}s_since", 1) : self.send("#{unit}s_since", 1)
+        time = self.clone
+        direction = (self < @until) ? :f : :b
+        succ_method = (direction == :f) ? "next_#{unit}" : "prev_#{unit}"
+        time = time.beginning_of(unit) if options[:beginning_of]
+        time = time.send(succ_method) if !options[:include_start]
+        results = []
+        while (direction == :f && time <= @until) || (direction == :b && time >= @until)
+          options[:map_result] ? results << yield(time) : yield(time)
+          time = time.send(succ_method)
+        end
+        options[:map_result] ? results : self
+      else
+        add_to_chain(:iterate, unit, options)
+        self
+      end
+    end
+
+    # Used togeter with #each and other iteration methods to specify end of interation.
+    def until(time, &block)
+      time = time.to_time if time.is_a?(::Date)
+      @until = time
+      return call_chain(block) if block_given?
+      self
+    end
+    alias :till :until
+
+    # Used together with #each and other interation methods to specify start of iteration, and end will be current object.
+    def from(time, &block)
+      time = time.to_time if time.is_a?(::Date)
+      method, args = @method_chain.pop if block_given?
+      if !method.nil?
+        time.until(self).send(method, *args, &block)
+      else
+        time.until(self)
+      end
+    end
+
+    # Executes passed block for each "unit" of time specified, with a new time object for each interval passed to the block.
+    def each(unit, options = {}, &block)
+      iterate(unit, options.merge(:map_result => false), &block)
+    end
+
+    # Executes passed block for each "unit" of time specified, with a new time object set to the beginning of "unit" for each interval passed to the block.
+    def beginning_of_each(unit, options = {}, &block)
+      iterate(unit, options.merge(:map_result => false, :beginning_of => true), &block)
+    end
+
+    # Executes passed block for each "unit" of time specified, returning an array with the return values from the passed block.
+    def map_each(unit, options = {}, &block)
+      iterate(unit, options.merge(:map_result => true), &block)
+    end
+    alias :map :map_each
+
+    # Executes passed block for each "unit" of time specified, returning an array with the return values from passed block. Additionally the time object passed into the block is set to the beginning of specified "unit".
+    def map_beginning_of_each(unit, options = {}, &block)
+      iterate(unit, options.merge(:map_result => true, :beginning_of => true), &block)
+    end
+
+    # Dynamically define convenience methods, like #each_hour instead of #each(:hour).
+    [:year, :month, :day, :hour, :min, :sec].each do |unit|
+      [:each, :beginning_of_each, :map_each, :map_beginning_of_each, :map].each do |method|
+        define_method "#{method}_#{unit}" do |*args, &block|
+          send(method, unit, *args, &block)
+        end
+        class_eval { alias :"#{method}_minute" :"#{method}_min" } if unit == :min
+        class_eval { alias :"#{method}_second" :"#{method}_sec" } if unit == :sec
+      end
+    end
+
+  end
+end

data/lib/time_ext/method_chain.rb

@@ -1,4 +1,5 @@
 module TimeExt
+  # Allows iterators' #until and #from methods to chain back to the parent iteration method.
   module MethodChain
     
     def add_to_chain(method, *args, &block)

data/lib/time_ext.rb

@@ -1,13 +1,8 @@
 require 'rubygems'
 require 'active_support'
-require 'time_ext/method_chain'
-require 'time_ext/core_ext/time/calculations'
-require 'time_ext/core_ext/time/iterations'
 
-module TimeExt
-  
-  module Base
-    TIME_EXT_UNITS = [:year, :month, :day, :hour, :min, :sec, :usec]
-  end
-  
-end
+require 'time_ext/backwards_compatibility'
+require 'time_ext/calculations'
+require 'time_ext/iterations'
+require 'time_ext/method_chain'
+require 'time_ext/core_ext/time'

data/spec/time_iterations_spec.rb

@@ -52,6 +52,8 @@ describe "Time Iterations" do
     match = (1..6).map { |i| @now + i.hours }
     @now.map_each_hour.until(@now + 6.hours) { |time| time }.should == match
     @now.until(@now + 6.hours).map_each(:hour) { |time| time }.should == match
+    # check so the #map alias for #map_each works
+    @now.map_hour.until(@now + 6.hours) { |time| time }.should == match
   end
   
   it "should iterate over time objects backwards with #until set in the past" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: time_ext
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Jim Myhrberg
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-29 00:00:00 +03:00
+date: 2010-08-03 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,8 +82,10 @@ files:
 - VERSION
 - lib/time/ext.rb
 - lib/time_ext.rb
-- lib/time_ext/core_ext/time/calculations.rb
-- lib/time_ext/core_ext/time/iterations.rb
+- lib/time_ext/backwards_compatibility.rb
+- lib/time_ext/calculations.rb
+- lib/time_ext/core_ext/time.rb
+- lib/time_ext/iterations.rb
 - lib/time_ext/method_chain.rb
 - spec/spec.opts
 - spec/spec_helper.rb

data/lib/time_ext/core_ext/time/calculations.rb

@@ -1,206 +0,0 @@
-class Time
-  
-  # Helper method for backwards compatibility with ActiveSupport.
-  def days_into_week
-    defined?(DAYS_INTO_WEEK) ? DAYS_INTO_WEEK : { :monday => 0, :tuesday => 1, :wednesday => 2, :thursday => 3, :friday => 4, :saturday => 5, :sunday => 6 }
-  end
-  
-  # Helper method for backwards compatibility with ActiveSupport.
-  def common_year_days_in_month
-    defined?(COMMON_YEAR_DAYS_IN_MONTH) ? COMMON_YEAR_DAYS_IN_MONTH : [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
-  end
-  
-  # Returns a new Time representing the start of the unit specified (second by default).
-  def floor(unit = :sec)
-    self.send("beginning_of_#{unit}")
-  end
-  alias :beginning_of :floor
-  alias :at_beginning_of :floor
-  
-  # Returns a new Time representing the start of the next unit specified (second by default).
-  def ceil(unit = :sec)
-    self.send("next_#{unit}").send("beginning_of_#{unit}")
-  end
-  alias :beginning_of_next :ceil
-  alias :at_beginning_of_next :ceil
-  
-  # Returns a new Time representing the start of the current or next unit specified (second by default) depending which is closest
-  def round(unit = :sec)
-    next_unit = self.ceil(unit)
-    this_unit = self.floor(unit)
-    (self - this_unit) < (next_unit - self) ? this_unit : next_unit
-  end
-  alias :beginning_of_closest :round
-  
-  # Returns a new Time representing the previoius unit specified (defaults to second).
-  def prev(unit = :sec)
-    send("prev_#{unit}")
-  end
-  
-  # Returns a new Time representing the next unit specified (defaults to second).
-  def next(unit = :sec)
-    send("next_#{unit}")
-  end
-  
-  # Short-hand for seconds_ago(1).
-  def prev_second
-    seconds_ago(1)
-  end
-  alias :prev_sec :prev_second
-  
-  # Short-hand for seconds_since(1).
-  def next_second
-    seconds_since(1)
-  end
-  alias :next_sec :next_second
-  
-  # Short-hand for minutes_ago(1).
-  def prev_minute
-    minutes_ago(1)
-  end
-  alias :prev_min :prev_minute
-  
-  # Short-hand for minutes_since(1).
-  def next_minute
-    minutes_since(1)
-  end
-  alias :next_min :next_minute
-  
-  # Short-hand for hours_ago(1).
-  def prev_hour
-    hours_ago(1)
-  end
-  
-  # Short-hand for hours_since(1).
-  def next_hour
-    hours_since(1)
-  end
-  
-  # Short-hand for days_ago(1).
-  def prev_day
-    days_ago(1)
-  end
-  
-  # Short-hand for days_since(1).
-  def next_day
-    days_since(1)
-  end
-  
-  # Returns a new Time representing the start of the given day in the previous week (default is Monday).
-  def prev_week(day = :monday)
-    weeks_ago(1).beginning_of_week.since(days_into_week[day].day).change(:hour => 0)
-  end
-  
-  # Short-hand for quarters_since(1).beginning_of_quarter.
-  def next_quarter
-    quarters_since(1).beginning_of_quarter
-  end
-  
-  # Short-hand for quarters_ago(1).beginning_of_quarter.
-  def prev_quarter
-    quarters_ago(1).beginning_of_quarter
-  end
-  
-  # Aliases to keep available method names to a standard pattern.
-  alias :secs_ago :ago
-  alias :seconds_ago :ago
-  alias :secs_since :since
-  alias :seconds_since :since
-  
-  # Returns a new Time representing the time a number of specified minutes ago.
-  def minutes_ago(minutes)
-    ago(minutes.minutes)
-  end
-  alias :mins_ago :minutes_ago
-  
-  # Returns a new Time representing the time a number of specified minutes in the future.
-  def minutes_since(minutes)
-    since(minutes.minutes)
-  end
-  alias :mins_since :minutes_since
-  
-  # Returns a new Time representing the time a number of specified hours ago.
-  def hours_ago(hours)
-    ago(hours.hours)
-  end
-  
-  # Returns a new Time representing the time a number of specified hours in the future.
-  def hours_since(hours)
-    since(hours.hours)
-  end
-  
-  # Returns a new Time representing the time a number of specified days ago.
-  def days_ago(days)
-    ago(days.days)
-  end
-  
-  # Returns a new Time representing the time a number of specified days in the future.
-  def days_since(days)
-    since(days.days)
-  end
-  
-  # Returns a new Time representing the time a number of specified weeks ago.
-  def weeks_ago(weeks)
-    ago(weeks.weeks)
-  end
-  
-  # Returns a new Time representing the time a number of specified weeks in the future.
-  def weeks_since(weeks)
-    since(weeks.weeks)
-  end
-  
-  # Returns a new Time representing the time a number of specified quarters (3 months) ago.
-  def quarters_ago(quarters)
-    ago((quarters * 3).months)
-  end
-  
-  # Returns a new Time representing the time a number of specified quarters (3 months) in the future.
-  def quarters_since(quarters)
-    since((quarters * 3).months)
-  end
-  
-  # Returns a new Time representing the end of the unit specified (defaults to second).
-  def end_of(unit = :sec)
-    send("end_of_#{unit}")
-  end
-  
-  # Returns a new Time representing the start of the second, XX:XX:XX.000000 (.000000000 in ruby1.9).
-  def beginning_of_second
-    change(:usec => 0)
-  end
-  alias :beginning_of_sec :beginning_of_second
-  alias :at_beginning_of_sec :beginning_of_second
-  alias :at_beginning_of_second :beginning_of_second
-  
-  # Returns a new Time representing the end of the hour, XX:XX:XX.999999 (.999999999 in ruby1.9).
-  def end_of_second
-    change(:usec => 999999.999)
-  end
-  alias :end_of_sec :end_of_second
-  
-  # Returns a new Time representing the start of the minute (XX:XX:00).
-  def beginning_of_minute
-    change(:sec => 0, :usec => 0)
-  end
-  alias :beginning_of_min :beginning_of_minute
-  alias :at_beginning_of_min :beginning_of_minute
-  alias :at_beginning_of_minute :beginning_of_minute
-  
-  # Returns a new Time representing the end of the hour, XX:XX:59.999999 (.999999999 in ruby1.9).
-  def end_of_minute
-    change(:sec => 59, :usec => 999999.999)
-  end
-  alias :end_of_min :end_of_minute
-  
-  # Returns a new Time representing the start of the hour (XX:00:00).
-  def beginning_of_hour
-    change(:min => 0, :sec => 0, :usec => 0)
-  end
-  alias :at_beginning_of_hour :beginning_of_hour
-  
-  # Returns a new Time representing the end of the hour, XX:59:59.999999 (.999999999 in ruby1.9).
-  def end_of_hour
-    change(:min => 59, :sec => 59, :usec => 999999.999)
-  end
-  
-end

data/lib/time_ext/core_ext/time/iterations.rb

@@ -1,79 +0,0 @@
-class Time
-  include TimeExt::MethodChain
-  
-  # Used by #each, #map_each and similar methods to iterate over ranges of time.
-  def iterate(unit, options = {}, &block)
-    options.reverse_merge!(:map_result => false, :beginning_of => false, :include_start => false)
-    if block_given?
-      units = [:year, :month, :day, :hour, :min, :sec, :usec]
-      parent_unit = units[units.index(unit)-1]
-      @until ||= (!parent_unit.nil?) ? self.send("#{parent_unit}s_since", 1) : self.send("#{unit}s_since", 1)
-      time = self.clone
-      direction = (self < @until) ? :f : :b
-      succ_method = (direction == :f) ? "next_#{unit}" : "prev_#{unit}"
-      time = time.beginning_of(unit) if options[:beginning_of]
-      time = time.send(succ_method) if !options[:include_start]
-      results = []
-      while (direction == :f && time <= @until) || (direction == :b && time >= @until)
-        options[:map_result] ? results << yield(time) : yield(time)
-        time = time.send(succ_method)
-      end
-      options[:map_result] ? results : self
-    else
-      add_to_chain(:iterate, unit, options)
-      self
-    end
-  end
-  
-  # Used togeter with #each and other iteration methods to specify end of interation.
-  def until(time, &block)
-    time = time.to_time if time.is_a?(::Date)
-    @until = time
-    return call_chain(block) if block_given?
-    self
-  end
-  alias :till :until
-  
-  # Used together with #each and other interation methods to specify start of iteration, and end will be current object.
-  def from(time, &block)
-    time = time.to_time if time.is_a?(::Date)
-    method, args = @method_chain.pop if block_given?
-    if !method.nil?
-      time.until(self).send(method, *args, &block)
-    else
-      time.until(self)
-    end
-  end
-  
-  # Executes passed block for each "unit" of time specified, with a new time object for each interval passed to the block.
-  def each(unit, options = {}, &block)
-    iterate(unit, options.merge(:map_result => false), &block)
-  end
-  
-  # Executes passed block for each "unit" of time specified, with a new time object set to the beginning of "unit" for each interval passed to the block.
-  def beginning_of_each(unit, options = {}, &block)
-    iterate(unit, options.merge(:map_result => false, :beginning_of => true), &block)
-  end
-  
-  # Executes passed block for each "unit" of time specified, returning an array with the return values from the passed block.
-  def map_each(unit, options = {}, &block)
-    iterate(unit, options.merge(:map_result => true), &block)
-  end
-  
-  # Executes passed block for each "unit" of time specified, returning an array with the return values from passed block. Additionally the time object passed into the block is set to the beginning of specified "unit".
-  def map_beginning_of_each(unit, options = {}, &block)
-    iterate(unit, options.merge(:map_result => true, :beginning_of => true), &block)
-  end
-  
-  # Dynamically define convenience methods, like #each_hour instead of #each(:hour).
-  [:year, :month, :day, :hour, :min, :sec].each do |unit|
-    [:each, :beginning_of_each, :map_each, :map_beginning_of_each].each do |method|
-      define_method "#{method}_#{unit}" do |*args, &block|
-        send(method, unit, *args, &block)
-      end
-      class_eval { alias :"#{method}_minute" :"#{method}_min" } if unit == :min
-      class_eval { alias :"#{method}_second" :"#{method}_sec" } if unit == :sec
-    end
-  end
-  
-end