timerange 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c894dba974163b967591d9fdaf8b18cfb1dcc4d
-  data.tar.gz: 1275ef9878ac3f4799dffafb8b9ed1f6504412fa
+  metadata.gz: 17b671b71b8905bfdd65ac8e0c3f620eb278f51f
+  data.tar.gz: 132d36c026b2da0f57cf3817228647eb74f210b9
 SHA512:
-  metadata.gz: 5ebd11f24a6c1673512d102e73e10952176981654cb2915c0785c095420cbde8df9f63e6c75827a00e27f227a3e80340bdd4e5b22a6fcff15128165d2c52aa1e
-  data.tar.gz: 3ae674ccabaf4bae6c58fdef2d331ffc77e6e4cc3017334b8816e29fbc79b1d8cd37ab6ee845255709d52dabe7026b38dcf7f13f11899d513b9a7a1851bbe008
+  metadata.gz: eb12938aa430be463edff9b7b763406c464677cf3309f2d6b32f0444c75ae04017903fa78275cec1992d99ca671d73ce0553141ffefdea7fae8447a528fc4ac5
+  data.tar.gz: fc04948e87a7d35967f8c0b2cd3aa24e546b5818b163903bfcc5ad6aad0578c327efaaf51b4605238e1eaebfd7fdb4bcd83a034e5bc1555895e00778f03d058d

data/README.md

@@ -13,9 +13,26 @@ gem 'timerange'
 ## Features
 
 ```ruby
-time_range = TimeRange.new(range: 7.days.ago..Time.now)
-time_range.step(:day)
-time_range.expand(:week)
+time_range = TimeRange.new(7.days.ago..Time.now)
+time_range.step(1.day)
+time_range.expand(:week).step(1.day)
+
+TimeRange.new("2014-06-01", "2014-06-07")
+TimeRange.new("2014-06-01", duration: 1.week)
+TimeRange.new(4.weeks.ago).expand_start(:week) # last 4 weeks
+
+TimeRange.today
+TimeRange.yesterday
+
+TimeRange.today + 4.weeks
+TimeRange.today - 4.weeks
+
+TimeRange.bucket(:hour, user.created_at)
+TimeRange.bucket(:day, user.created_at, day_start: 2) # 2 am
+TimeRange.bucket(:week, user.created_at, week_start: :mon) # start weeks on Monday
+TimeRange.bucket(:month, user.created_at, time_zone: "Pacific Time (US & Canada)")
+
+TimeRange.time_zone = "Pacific Time (US & Canada)" # defaults to Time.zone
 ```
 
 ## Contributing

data/lib/timerange.rb

@@ -1,34 +1,90 @@
+require "time"
 require "active_support/time"
+require "active_support/core_ext/module/attribute_accessors"
 
 class TimeRange < Range
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 
-  def initialize(options = {})
-    range = options[:range]
-    super(range.begin, range.end, range.exclude_end?)
+  mattr_accessor :time_zone
+
+  def initialize(b = nil, e = Time.now, exclude_end = false, options = {})
+    if b.is_a?(Range)
+      b, e, exclude_end = b.begin, b.end, b.exclude_end?
+    end
+
+    if b.is_a?(Hash)
+      options, b, e, exclude_end = b, nil, nil, false
+    elsif e.is_a?(Hash)
+      options, e, exclude_end = e, nil, false
+    end
+
+    time_zone = options[:time_zone] || self.class.time_zone || Time.zone || "Etc/UTC"
+    if time_zone.is_a?(ActiveSupport::TimeZone) or (time_zone = ActiveSupport::TimeZone[time_zone])
+      # do nothing
+    else
+      raise "Unrecognized time zone"
+    end
+    b = time_zone.parse(b) if b.is_a?(String)
+    e = time_zone.parse(e) if e.is_a?(String)
+    if options[:time_zone]
+      b = b.in_time_zone(b)
+      e = e.in_time_zone(e)
+    end
+
+    if options[:duration]
+      e = b + options[:duration]
+      exclude_end = true
+    end
+
+    super(b, e, exclude_end)
   end
 
-  def step(period, options = {})
-    arr = [bucket(period, self.begin, options)]
-    while v = arr.last + 1.send(period) and cover?(v)
+  # should step expand by default?
+  # TODO return enum
+  def step(period, options = {}, &block)
+    period = period.is_a?(Symbol) || period.is_a?(String) ? 1.send(period) : period
+    arr = [self.begin]
+    yield(arr.last) if block_given?
+    while v = arr.last + period and cover?(v)
+      yield(v) if block_given?
       arr << v
     end
     arr
   end
 
   def expand(period, options = {})
-    self.class.new(range: Range.new(bucket(period, self.begin, options), bucket(period, self.end + 1.send(period), options), true))
+    e =
+      if exclude_end? and self.end == bucket(period, self.end, options)
+        self.end
+      else
+        bucket(period, self.end + 1.send(period), options)
+      end
+    self.class.new(bucket(period, self.begin, options), e, true)
   end
 
-  def time_zone
-    Time.zone
+  def expand_start(period, options = {})
+    e = self.end
+    e = e.in_time_zone(options[:time_zone]) if options[:time_zone]
+    self.class.new(bucket(period, self.begin, options), e, exclude_end?)
   end
 
   def bucket(period, time, options = {})
-    day_start = 0
-    week_start = 6 # sunday
+    self.class.bucket(period, time, options)
+  end
+
+  def self.bucket(period, time, options = {})
+    time_zone = options[:time_zone] || Time.zone
+    day_start = options[:day_start] || 0
+    week_start = options[:week_start] || 6
+
+    week_start = [:mon, :tue, :wed, :thu, :fri, :sat, :sun].index((options[:week_start] || :sun).to_sym)
+    if !week_start
+      raise "Unrecognized :week_start option"
+    end
+
     time = time.to_time.in_time_zone(time_zone) - day_start.hours
 
+    period = period.to_sym
     time =
       case period
       when :second
@@ -45,8 +101,10 @@ class TimeRange < Range
         (time - ((7 - week_start + weekday) % 7).days).midnight
       when :month
         time.beginning_of_month
-      else # year
+      when :year
         time.beginning_of_year
+      else
+        raise "Invalid period"
       end
 
     time + day_start.hours
@@ -54,12 +112,20 @@ class TimeRange < Range
 
   def self.today
     date = Date.today
-    new(range: date..date).expand(:day)
+    new(date, date).expand(:day)
   end
 
   def self.yesterday
     date = Date.yesterday
-    new(range: date..date).expand(:day)
+    new(date, date).expand(:day)
+  end
+
+  def +(period)
+    self.class.new(self.begin + period, self.end + period, exclude_end?)
+  end
+
+  def -(period)
+    self.class.new(self.begin - period, self.end - period, exclude_end?)
   end
 
 end

data/test/test_helper.rb

@@ -2,3 +2,8 @@ require "bundler/setup"
 Bundler.require(:default)
 require "minitest/autorun"
 require "minitest/pride"
+require "timecop"
+
+Time.zone = "Pacific Time (US & Canada)"
+
+Timecop.freeze

data/test/time_range_test.rb

@@ -4,7 +4,43 @@ class TestTimeRange < Minitest::Test
 
   def test_time_range
     day = Time.parse("2014-06-01")
-    assert_equal 7, TimeRange.new(range: day..day).expand(:week).step(:day).size
+    assert_equal 7, TimeRange.new(day..day).expand(:week).step(:day).size
+  end
+
+  def test_today
+    day = Time.now.midnight
+    tr = TimeRange.today
+    assert_equal day, tr.begin
+    assert_equal day + 1.day, tr.end
+    assert tr.exclude_end?
+  end
+
+  def test_step_block
+    count = 0
+    TimeRange.today.expand(:week).step(:day) do |day|
+      count += 1
+    end
+    assert_equal 7, count
+  end
+
+  def test_duration
+    tr = TimeRange.new("2014-06-01", duration: 1.week)
+    day = Time.zone.parse("2014-06-01")
+    assert_equal day, tr.begin
+    assert_equal day + 1.week, tr.end
+    assert tr.exclude_end?
+  end
+
+  def test_last
+    tr = TimeRange.new(4.weeks.ago)
+    assert_equal 4.weeks.ago, tr.begin
+    assert_equal Time.zone.now, tr.end
+    assert !tr.exclude_end?
+  end
+
+  def test_math
+    assert_equal TimeRange.today, TimeRange.yesterday + 1.day
+    assert_equal TimeRange.yesterday, TimeRange.today - 1.day
   end
 
 end

data/timerange.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
+  spec.add_development_dependency "timecop"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timerange
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-21 00:00:00.000000000 Z
+date: 2014-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Time ranges for Ruby
 email:
 - andrew@chartkick.com