timespan 0.2.8 → 0.3.1

data/README.md

@@ -113,6 +113,43 @@ account.period.end_date
 account.period.days
 account.period.duration # => Duration
 
+## Searching periods
+
+```ruby
+Account.where(:'period.from'.lt => 6.days.ago.to_i)
+Account.where(:'period.from'.gt => 3.days.ago.to_i)
+
+# in range
+Account.where(:'period.from'.gt => 3.days.ago.to_i, :'period.to'.lt => Time.now.utc.to_i)
+```
+
+Make it easier by introducing a class helper:
+
+```ruby
+class Account
+  include Mongoid::Document
+  field :period, :type => TimeSpan
+
+  def self.between from, to
+    Account.where(:'period.from'.gt => from.to_i, :'period.to'.lte => to.to_i)
+  end
+end
+```
+
+`Account.between(6.days.ago, 1.day.ago)`
+
+Alternatively auto-generate a `#between` helper for the field:
+
+```ruby
+class Account
+  include Mongoid::Document
+  field :period, :type => TimeSpan, :between => true
+```
+
+`Account.period_between(6.days.ago, 1.day.ago)`
+
+See the `mongoid_search_spec.rb` for examples:
+
 ## Chronic duration
 
 Is used to parse duration strings if Spanner can't be handle it
@@ -148,6 +185,27 @@ Currently it also uses Duration, which conflicts with the 'ruby-duration' gem.
   1.week.each(10.hours) {|ten_hour_segment| ...} #=> Using a custom iterator of 10 hours. There would be 17 of them, but notice that the last iteration will only be 8 hours.
 ``
 
+## Configuration and overrides
+
+Timespan by default uses `Time.now.utc` to set the current time, fx used when either `end_date` or `start_date` otherwise would be nil. This is used in order to work with Mongoid (see [issue #400](https://github.com/mongoid/mongoid/issues/400))
+
+You can customize `now` to return fx `Time.now`, `Date.today` or whatever suits you.
+
+```ruby
+class Timespan
+  def now
+    Time.now # or Date.today
+  end
+end
+```
+
+By default the `TimeSpan` is stored using `:from` and `:to` for the start and end times. This can be customized as follows: 
+
+```ruby
+TimeSpan.start_field = :start
+TimeSpan.end_field = :end
+```
+
 ## Contributing to Timespan
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.2.8
+0.3.1

data/lib/timespan/compare.rb

@@ -22,7 +22,7 @@ class Timespan
   	include Comparable
 
     def time_left time = nil
-      time_compare = time || Time.now
+      time_compare = time || now
       diff = end_time - time_compare
       Timespan::TimeDuration.new(diff)
     end

data/lib/timespan/mongoid.rb

@@ -1,12 +1,40 @@
 require "timespan"
 require "mongoid/fields"
 
+# http://whytheluckystiff.net/articles/seeingMetaclassesClearly.html
+class Object 
+  def meta_def name, &blk
+    (class << self; self; end).instance_eval { define_method name, &blk }
+  end
+end
+
+Mongoid::Fields.option :between do |model, field, options|  
+  name = field.name.to_sym
+  model.class_eval do
+    meta_def :"#{name}_between" do |from, to|
+      self.where(:"#{name}.#{TimeSpan.start_field}".gte => from.to_i, :"#{name}.#{TimeSpan.end_field}".lte => to.to_i)
+    end
+  end
+end
+
 # Mongoid serialization support for Timespan type.
 module Mongoid
   module Fields
     class Timespan
       include Mongoid::Fields::Serializable
     
+      class << self
+        attr_writer :start_field, :end_field
+
+        def start_field
+          @start_field || :from
+        end
+
+        def end_field
+          @end_field || :to
+        end
+      end
+
       def self.instantiate(name, options = {})
         super
       end
@@ -15,9 +43,9 @@ module Mongoid
       #
       # @param [Hash] Timespan as hash
       # @return [Timespan] deserialized Timespan
-      def deserialize(timespan_hash)
-        return if !timespan_hash
-        ::Timespan.new(:from => timespan_hash[:from], :to => timespan_hash[:to])
+      def deserialize(hash)
+        return if !hash
+        ::Timespan.new :from => from(hash), :to => to(hash)
       end
 
       # Serialize a Timespan or a Hash (with Timespan units) or a Duration in some form to
@@ -27,8 +55,35 @@ module Mongoid
       # @return [Hash] Timespan in seconds
       def serialize(value)
         return if value.blank?
-        timespan = ::Timespan.new(value)
-        {:from => timespan.start_time, :to => timespan.end_time, :duration => timespan.duration.total}
+        timespan = case value
+        when ::Timespan
+          value
+        else
+          ::Timespan.new(value)
+        end
+        {:from => serialize_time(timespan.start_time), :to => serialize_time(timespan.end_time.to_i), :duration => timespan.duration.total }
+      end
+
+      protected
+
+      def from hash
+        from_value = hash['from'] || hash[:from]
+        raise ArgumentError, ":from is nil, #{hash.inspect}" if from_value.nil?
+        deserialize_time from_value
+      end
+
+      def to hash
+        to_value = hash['to'] || hash[:to]
+        raise ArgumentError, ":to is nil, #{hash.inspect}" if to_value.nil?
+        deserialize_time to_value
+      end
+
+      def serialize_time time
+        time.to_i
+      end
+
+      def deserialize_time millisecs
+        Time.at millisecs
       end
     end
   end

data/lib/timespan.rb

@@ -120,8 +120,12 @@ class Timespan
 	end		
 
 	def default_from_now!
-		self.start_time = Time.now unless start_time || (end_time && duration)
-		self.end_time = Time.now unless end_time || (start_time && duration)
+		self.start_time = now unless start_time || (end_time && duration)
+		self.end_time = now unless end_time || (start_time && duration)
+	end
+
+	def now
+		Time.now.utc
 	end
 
 	def validate!

data/spec/timespan/mongoid/account.rb

@@ -1,10 +1,14 @@
 class Account
-	include Mongoid::Document
-	field :period, :type => TimeSpan
+	include Mongoid::Document  
+	field :period, :type => TimeSpan, :between => true
 
   def self.create_it! duration
     s = self.new
     s.period = {duration: duration}
     s
   end
+
+  def self.between from, to
+    Account.where(:'period.from'.gt => from.to_i, :'period.to'.lte => to.to_i)
+  end
 end

data/spec/timespan/mongoid/mongoid_search_spec.rb

@@ -0,0 +1,40 @@
+require 'timespan/mongoid/spec_helper'
+
+describe TimeSpan do
+  subject { account }
+
+  context '3 Accounts with periods serialized' do
+    before do
+      Account.delete_all
+      @acc1 = Account.create :period => Timespan.new(:start_date => 2.days.ago)
+      @acc2 = Account.create :period => Timespan.new(:start_date => 5.days.ago, :end_date => 2.days.ago)
+      @acc3 = Account.create :period => Timespan.new(:start_date => 10.days.ago)
+
+      # puts [@acc1._id, @acc2._id, @acc3._id]
+    end
+
+    describe 'find accounts within specific period' do
+      it 'should find a single period less than 6 days old' do
+        Account.where(:'period.from'.lt => 6.days.ago.to_i).first.should == @acc3
+      end
+
+      it 'should find a single period later than 3 days old' do
+        Account.where(:'period.from'.gt => 3.days.ago.to_i).first.should == @acc1
+      end
+
+      describe 'find a single period that is within period from 6 days ago to tomorrow' do
+        it 'should use Account.where' do
+          Account.where(:'period.from'.gt => 6.days.ago.to_i, :'period.to'.lte => 1.day.ago.to_i).first.should == @acc2
+        end
+
+        it 'should use Account class helper #between' do
+          Account.between(6.days.ago, 1.day.ago).first.should == @acc2
+        end
+
+        it 'should use Account class generated helper #period_between' do
+          Account.period_between(6.days.ago, 1.day.ago).first.should == @acc2
+        end
+      end
+    end
+  end
+end

data/spec/timespan/mongoid/mongoid_timespan_spec.rb

@@ -1,6 +1,6 @@
 require 'timespan/mongoid/spec_helper'
 
-describe Timespan do
+describe TimeSpan do
 	subject { account }
 
   let(:from) { Chronic.parse("1 day ago") }
@@ -18,7 +18,19 @@ describe Timespan do
     end
   end
 
-  context '2 days duration using integer' do
+  context '2 days duration using Timespan' do
+    let(:account) do 
+      Account.create :period => Timespan.new(:duration => 2.days)
+    end
+
+    describe '.start_date' do
+      it 'should default to today' do
+        DateTime.parse(subject.period.start_date.to_s).strftime('%d %b %Y').should == Date.today.strftime('%d %b %Y')
+      end
+    end
+  end
+
+  context '2 days duration using :duration => integer via ActiveSupport::Duration' do
     let(:account) do 
       Account.create :period => {:duration => 2.days }
     end
@@ -30,7 +42,7 @@ describe Timespan do
     end
   end
 
-  context '2 days using integer' do
+  context '2 days using integer via ActiveSupport::Duration' do
     let(:account) do 
       Account.create :period => 2.days
     end
@@ -42,7 +54,7 @@ describe Timespan do
     end
   end
 
-  context '2 days duration (from now - default)' do
+  context '2 days duration using string' do
     let(:account) do 
       Account.create :period => {:duration => '2 days'}
     end

data/timespan.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "timespan"
-  s.version = "0.2.8"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Kristian Mandrup"]
-  s.date = "2012-05-29"
+  s.date = "2012-05-30"
   s.description = "Makes it easy to calculate time distance in different units"
   s.email = "kmandrup@gmail.com"
   s.extra_rdoc_files = [
@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
     "spec/timespan/duration_macros_spec.rb",
     "spec/timespan/locales/duration_da.yml",
     "spec/timespan/mongoid/account.rb",
+    "spec/timespan/mongoid/mongoid_search_spec.rb",
     "spec/timespan/mongoid/mongoid_timespan_spec.rb",
     "spec/timespan/mongoid/spec_helper.rb",
     "spec/timespan/printer_spec.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timespan
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-29 00:00:00.000000000 Z
+date: 2012-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -232,6 +232,7 @@ files:
 - spec/timespan/duration_macros_spec.rb
 - spec/timespan/locales/duration_da.yml
 - spec/timespan/mongoid/account.rb
+- spec/timespan/mongoid/mongoid_search_spec.rb
 - spec/timespan/mongoid/mongoid_timespan_spec.rb
 - spec/timespan/mongoid/spec_helper.rb
 - spec/timespan/printer_spec.rb
@@ -255,7 +256,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 43834805566888461
+      hash: -4280308012345220837
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: