ttilley-time_crisis 0.0.1 → 0.0.2

data/.gitignore

@@ -1,3 +1,4 @@
+nbproject
 *.sw?
 .DS_Store
 coverage

data/README.markdown

@@ -0,0 +1,57 @@
+Arbitrary Date Ranges
+=====================
+
+You can create a Range with a beginning and end Date using the convenience methods 'for' and 'from'. 'for' will create a range into the future while 'from' creates a range into the past.
+
+	Date.today.for(2, 'years')
+	 => Fri, 18 Sep 2009..Sat, 17 Sep 2011 
+
+	Date.today.from(2, 'years')
+	 => Wed, 19 Sep 2007..Fri, 18 Sep 2009 
+
+If you want to be more literal in your syntax, you can use the range method directly:
+
+	Date.today.range(2, 'months', 'future')
+	 => Fri, 18 Sep 2009..Tue, 17 Nov 2009 
+
+	Date.today.range(2, 'months', 'past')
+	 => Sun, 19 Jul 2009..Fri, 18 Sep 2009 
+
+There is also a class method for defining ranges that allows you to specify a beginning and end for the range, or just one of beginning or end and then the scale (months, years) and unit (number of scale).
+
+	Date.range(:begin => Date.today, :scale => 'months', :unit => 3)
+	 => Fri, 18 Sep 2009..Thu, 17 Dec 2009 
+
+	Date.range(:begin => Date.civil(2008, 3, 1), :end => Date.civil(2008, 12, 31))
+	 => Sat, 01 Mar 2008..Wed, 31 Dec 2008 
+
+Named Months
+============
+
+A range of dates for a month can be created using that month's name, optionally passing in a year.
+
+	Date.february # 28 days in feb 2009
+	 => Sun, 01 Feb 2009..Sat, 28 Feb 2009 
+
+	Date.february(2008) # 29 days in feb 2008
+	 => Fri, 01 Feb 2008..Fri, 29 Feb 2008 
+
+
+Meteorological Season Calculations
+==================================
+
+	Date.civil(2009, 4, 1).meteorological_spring?
+	 => true 
+
+	Date.civil(2009, 4, 1).meteorological_winter?
+	 => false 
+
+	Date.civil(2009, 10, 1).meteorological_season
+	 => "fall" 
+
+	Date.today.beginning_of_meteorological_summer
+	 => Mon, 01 Jun 2009 
+
+
+
+Copyright (c) 2009 Travis Tilley. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:major: 0
 :minor: 0
-:patch: 1
+:patch: 2
+:major: 0

data/lib/time_crisis/date_range.rb

@@ -1,54 +1,102 @@
-module TimeCrisis::DateRange
-  module InstanceMethods
-    def from(unit, scale)
-      range(unit, scale, 'past')
+class TimeCrisis::DateRange < Range
+  def initialize(*args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+
+    # make compatibile with Range's normal arguments
+    options[:begin] = args.shift unless args.empty?
+    options[:end] = args.shift unless args.empty?
+    options[:exclude_end] = args.shift unless args.empty?
+
+    start = options[:begin].nil? ? false : options[:begin].to_date
+    stop = options[:end].nil? ? false : options[:end].to_date
+
+    unit = options[:unit] || 1
+    scale = options[:scale] || 'years'
+    scale = scale.pluralize if scale.respond_to?(:pluralize)
+
+    if start && !stop
+      stop = start.advance({scale.to_sym => unit, :days => -1})
+    elsif !start && stop
+      start = stop.advance({scale.to_sym => -unit, :days => 1})
     end
 
-    def for(unit, scale)
-      range(unit, scale, 'future')
+    super(start, stop, options[:exclude_end] || false)
+  end
+
+  def include?(datelike)
+    super(datelike.to_date)
+  end
+
+  def each_slice_by_date(*args, &block)
+    dates = args.map! do |datelike|
+      date = datelike.to_date
+      raise ArgumentError, "Date not within range: #{date}" unless self.include?(date)
+      date
     end
+    dates.sort!
 
-    def range(unit=nil, scale=nil, direction=nil)
-      direction ||= 'past'
-      unit ||= 1
-      scale ||= 'years'
+    start = self.begin
 
-      scale = scale.pluralize if scale.respond_to?(:pluralize)
+    dates.each do |date|
+      yield self.class.new(start, date, true)
+      start = date
+    end
+
+    yield self.class.new(start, self.end, self.exclude_end?)
+  end
 
-      period_base = self.to_date
-      period_advance = period_base.advance({
-        scale.to_sym => (direction == 'past' ? -unit : unit)
-      })
+  def each_slice_by_period(period, unit=1, &block)
+    start = self.begin
+    nstart = start.advance(period.to_sym => unit)
 
-      # I'd rather be using ..., but I need to flip-flop the range order
-      if direction == 'past'
-        (period_advance.advance(:days => 1))..period_base
-      else
-        period_base..(period_advance.advance(:days => -1))
-      end    
+    raise ArgumentError, "Period exceeds range" if nstart >= self.real_end
+
+    while nstart < self.real_end
+      yield self.class.new(start, nstart, true)
+      start = nstart
+      nstart = start.advance(period.to_sym => unit)
     end
+
+    yield self.class.new(start, self.end, self.exclude_end?)
+  end
+
+  def each_month(&block)
+    each_slice_by_period(:months, 1, &block)
   end
-  
+
+  def each_year(&block)
+    each_slice_by_period(:years, 1, &block)
+  end
+
+  protected
+
+  def real_end
+    @real_end ||= self.exclude_end? ? self.end.advance({:days => -1}) : self.end
+  end
+end
+
+module TimeCrisis::DateRange::Date
+  module InstanceMethods
+    def from(unit, scale)
+      self.range(unit, scale, 'past')
+    end
+
+    def for(unit, scale)
+      self.range(unit, scale, 'future')
+    end
+
+    def range(unit=1, scale='years', direction='past')
+      selfkey = direction == 'past' ? :end : :begin
+      self.class.range({selfkey => self, :unit => unit, :scale => scale})
+    end
+  end
+
   module ClassMethods
-    def range(options={})
-      start = options[:begin].nil? ? false : options[:begin].to_date
-      stop = options[:end].nil? ? false : options[:end].to_date
-      
-      scale = options[:scale] || 'years'
-      unit = options[:unit] || 1
-            
-      if start && !stop
-        start.for(unit, scale)
-      elsif !start && stop
-        stop.from(unit, scale)
-      elsif start && stop
-        (start..stop)
-      else
-        raise ArgumentError, "Cannot create a range with neither start nor end..."
-      end
+    def range(*args)
+      TimeCrisis::DateRange.new(*args)
     end
   end
 end
 
-Date.send(:include, TimeCrisis::DateRange::InstanceMethods)
-Date.extend(TimeCrisis::DateRange::ClassMethods)
+Date.send(:include, TimeCrisis::DateRange::Date::InstanceMethods)
+Date.extend(TimeCrisis::DateRange::Date::ClassMethods)

data/lib/time_crisis/meteorological_seasons.rb

@@ -1,50 +1,50 @@
 module TimeCrisis
-  # Meteorological seasons are reckoned by temperature, with summer being 
-  # the hottest quarter of the year and winter the coldest quarter of the 
-  # year. Using this reckoning, the Roman calendar began the year and the 
-  # spring season on the first of March, with each season occupying three 
-  # months. In 1780 the Societas Meteorologica Palatina, an early 
-  # international organization for meteorology, defined seasons as groupings 
-  # of three whole months. Ever since, professional meteorologists 
-  # everywhere have used this definition. So, in meteorology for the 
-  # Northern hemisphere: spring begins on 1 March, summer on 1 June, autumn 
+  # Meteorological seasons are reckoned by temperature, with summer being
+  # the hottest quarter of the year and winter the coldest quarter of the
+  # year. Using this reckoning, the Roman calendar began the year and the
+  # spring season on the first of March, with each season occupying three
+  # months. In 1780 the Societas Meteorologica Palatina, an early
+  # international organization for meteorology, defined seasons as groupings
+  # of three whole months. Ever since, professional meteorologists
+  # everywhere have used this definition. So, in meteorology for the
+  # Northern hemisphere: spring begins on 1 March, summer on 1 June, autumn
   # on 1 September, and winter on 1 December.
   # - http://en.wikipedia.org/wiki/Season
   module MeteorologicalSeasons
     def beginning_of_meteorological_spring
       ::Date.civil(self.year, 3, 1)
     end
-    
+
     def beginning_of_meteorological_summer
       ::Date.civil(self.year, 6, 1)
     end
-    
+
     def beginning_of_meteorological_autumn
       ::Date.civil(self.year, 9, 1)
     end
     alias beginning_of_meteorological_fall beginning_of_meteorological_autumn
-    
+
     def beginning_of_meteorological_winter
       ::Date.civil(self.year, 12, 1)
     end
-    
+
     def meteorological_spring?
       (beginning_of_meteorological_spring...beginning_of_meteorological_summer).include?(self)
     end
-    
+
     def meteorological_summer?
       (beginning_of_meteorological_summer...beginning_of_meteorological_autumn).include?(self)
     end
-    
+
     def meteorological_autumn?
       (beginning_of_meteorological_autumn...beginning_of_meteorological_winter).include?(self)
     end
-    
+
     def meteorological_winter?
       (beginning_of_year...beginning_of_meteorological_spring).include?(self) ||
-      (beginning_of_meteorological_winter..end_of_year).include?(self)
+        (beginning_of_meteorological_winter..end_of_year).include?(self)
     end
-    
+
     def meteorological_season
       return 'spring' if meteorological_spring?
       return 'summer' if meteorological_summer?

data/lib/time_crisis/named_months.rb

@@ -12,7 +12,7 @@ module TimeCrisis
     def october(year=nil);    month_range(10, year); end
     def november(year=nil);   month_range(11, year); end
     def december(year=nil);   month_range(12, year); end
-    
+
     def month_range(month, year = nil)
       year ||= current.year
       base = ::Date.civil(year, month, 1)

data/lib/time_crisis/support/advance.rb

@@ -10,7 +10,7 @@ module TimeCrisis::Support::Advance
       d
     end
   end
-  
+
   module Time
     def advance(options)
       unless options[:weeks].nil?
@@ -29,7 +29,7 @@ module TimeCrisis::Support::Advance
       seconds_to_advance == 0 ? time_advanced_by_date : time_advanced_by_date.since(seconds_to_advance)
     end
   end
-  
+
   module DateTime
     def advance(options)
       d = to_date.advance(options)

data/lib/time_crisis/support/change.rb

@@ -7,33 +7,33 @@ module TimeCrisis::Support::Change
         options[:day]   || self.day
       )
     end
-    
+
     def beginning_of_year
       change(:month => 1, :day => 1)
     end
-    
+
     def end_of_year
       change(:month => 12, :day => 31)
     end
-    
+
     def beginning_of_month
       change(:day => 1)
     end
-    
+
     def end_of_month
       last_day = self.class.days_in_month(self.month, self.year)
       change(:day => last_day)
     end
-    
+
     def beginning_of_day
       to_time
     end
-    
+
     def end_of_day
       to_time.end_of_day
     end
   end
-  
+
   module Time
     def change(options={})
       ::Time.send(
@@ -47,33 +47,33 @@ module TimeCrisis::Support::Change
         options[:usec]  || ((options[:hour] || options[:min] || options[:sec]) ? 0 : usec)
       )
     end
-    
+
     def beginning_of_year
       change(:month => 1, :day => 1, :hour => 0, :min => 0, :sec => 0)
     end
-    
+
     def end_of_year
       change(:month => 12,:day => 31,:hour => 23, :min => 59, :sec => 59)
     end
-    
+
     def beginning_of_month
       change(:day => 1,:hour => 0, :min => 0, :sec => 0, :usec => 0)
     end
-    
+
     def end_of_month
       last_day = self.class.days_in_month(self.month, self.year)
       change(:day => last_day, :hour => 23, :min => 59, :sec => 59, :usec => 999999.999)
     end
-    
+
     def beginning_of_day
       change(:hour => 0, :min => 0, :sec => 0, :usec => 0)
     end
-    
+
     def end_of_day
       change(:hour => 23, :min => 59, :sec => 59, :usec => 999999.999)
     end
   end
-  
+
   module DateTime
     def change(options={})
       ::DateTime.civil(

data/lib/time_crisis/support/conversions.rb

@@ -5,53 +5,53 @@ module TimeCrisis::Support::Conversions
     def to_date
       self
     end if RUBY_VERSION < '1.9'
-    
+
     def to_time(form = :local)
       ::Time.send(form, year, month, day)
     end
-    
+
     def to_datetime
       ::DateTime.civil(year, month, day, 0, 0, 0, 0)
     end if RUBY_VERSION < '1.9'
   end
-  
+
   module Time
     def to_date
       ::Date.new(year, month, day)
     end
-    
+
     def to_time
       self
     end
-    
+
     def to_datetime
       ::DateTime.civil(year, month, day, hour, min, sec, Rational(utc_offset, 86400))
     end
   end
-  
+
   module DateTime
     def to_date
       ::Date.civil(year, month, day)
     end
-    
+
     def to_time
       self.offset == 0 ? ::Time.utc(year, month, day, hour, min, sec) : self
     end
-    
+
     def to_datetime
       self
     end
   end
-  
+
   module String
     def to_time(form = :utc)
       d = ::Date._parse(self, false).values_at(:year, :mon, :mday, :hour, :min, :sec, :sec_fraction).map { |arg| arg || 0 }
       d[6] *= 1000000
       ::Time.send(form, *d)
     end
-    
+
     def to_date
-      ::Date.civil(::Date._parse(self, false).values_at(:year, :mon, :mday))
+      ::Date.civil(*::Date._parse(self, false).values_at(:year, :mon, :mday))
     end
 
     def to_datetime
@@ -66,10 +66,10 @@ end
 unless Time.instance_methods.include?('local_time')
   Date.class_eval do
     # Ruby 1.9 has Date#to_time which converts to localtime only.
-    remove_method :to_time if instance_methods.include?(:to_time)  
+    remove_method :to_time if instance_methods.include?(:to_time)
     include TimeCrisis::Support::Conversions::Date
   end
-  
+
   DateTime.class_eval do
     # Ruby 1.9 has DateTime#to_time which internally relies on Time.
     remove_method :to_time if instance_methods.include?(:to_time)

data/lib/time_crisis/support/current.rb

@@ -4,13 +4,13 @@ module TimeCrisis::Support::Current
       now
     end
   end
-  
+
   module Date
     def current
       today
     end
   end
-  
+
   module DateTime
     def current
       ::Time.now.to_datetime

data/lib/time_crisis/support/days_in_month.rb

@@ -1,6 +1,6 @@
 module TimeCrisis::Support::DaysInMonth
   GregorianDaysInMonth = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
-  
+
   def days_in_month(month, year = current.year)
     (month == 2 && ::Date.gregorian_leap?(year)) ? 29 : GregorianDaysInMonth[month]
   end

data/lib/time_crisis/support/readable_inspect.rb

@@ -3,7 +3,7 @@ module TimeCrisis::Support::ReadableInspect
     def readable_inspect
       strftime("%a, %d %b %Y")
     end
-    
+
     def self.included(base)
       base.class_eval do
         alias_method :default_inspect, :inspect
@@ -11,12 +11,12 @@ module TimeCrisis::Support::ReadableInspect
       end
     end
   end
-  
+
   module DateTime
     def readable_inspect
       to_s(:rfc822)
     end
-    
+
     def self.included(base)
       base.class_eval do
         alias_method :default_inspect, :inspect
@@ -26,8 +26,8 @@ module TimeCrisis::Support::ReadableInspect
   end
 end
 
-Date.send(:include, TimeCrisis::Support::ReadableInspect::Date) unless 
-  Date.instance_methods.include?('readable_inspect')
+Date.send(:include, TimeCrisis::Support::ReadableInspect::Date) unless
+Date.instance_methods.include?('readable_inspect')
 
-DateTime.send(:include, TimeCrisis::Support::ReadableInspect::DateTime) unless 
-  DateTime.instance_methods.include?('readable_inspect')
+DateTime.send(:include, TimeCrisis::Support::ReadableInspect::DateTime) unless
+DateTime.instance_methods.include?('readable_inspect')

data/time_crisis.gemspec

@@ -5,22 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{time_crisis}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Travis Tilley"]
-  s.date = %q{2009-09-17}
+  s.date = %q{2009-09-20}
   s.description = %q{date and time related extensions}
   s.email = %q{ttilley@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.markdown"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.markdown",
      "Rakefile",
      "VERSION.yml",
      "lib/time_crisis.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ttilley-time_crisis
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Travis Tilley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-17 00:00:00 -07:00
+date: 2009-09-20 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,12 +30,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION.yml
 - lib/time_crisis.rb

data/README.rdoc

@@ -1,7 +0,0 @@
-= Time Crisis
-
-Various date and time related methods. Meteorological season calculations, date ranges, and named months and currently included.
-
-== Copyright
-
-Copyright (c) 2009 Travis Tilley. See LICENSE for details.