chronicle 0.0.6 → 0.1.0

data/lib/chronicle.rb

@@ -51,7 +51,7 @@ module Chronicle
       "3 minutes ago",
       "2 minutes ago",
       "1 minute ago",
-      "just now",
+      "right now",
       "1 minute from now",
       "2 minutes from now",
       "3 minutes from now",
@@ -98,59 +98,60 @@ module Chronicle
     def initialize(collection, options)
       
       eras = options[:eras]
-      
-      # Sort order, defaut is new to old
-      order = options[:order] || :desc
-      
+            
       # Remove objects with nil timestamps
-      collection = collection.reject {|obj| obj.send(options[:date_attr]).nil? }
+      collection.reject! {|obj| obj.send(options[:date_attr]).nil? }
+      
+      # Determine whether collection contains future or past timestamps
+      if collection.all? { |obj| obj.send(options[:date_attr]) < Time.now }
+        order = :past
+      elsif collection.all? { |obj| obj.send(options[:date_attr]) > Time.now }
+        order = :future
+      else
+        raise "Chronicle collections must be entirely in the past or the future."
+      end
             
       # Sort collection by date
-      collection = collection.sort_by {|obj| obj.send(options[:date_attr])}
-      collection = collection.reverse if order == :desc
+      # For past collections, newest objects come first 
+      # For future collections, oldest objects come first
+      collection = collection.sort_by {|obj| obj.send(options[:date_attr]) }
+      collection.reverse! if order == :past
+
+      # Force inclusion of 'now' era in case it's missing.
+      eras.push('right now').uniq!
       
+      # Parse era strings using Chronic
       # Ensure all eras can be parsed
-      eras.each do |era|
-        raise "Could not parse era: #{era}" if Chronic.parse(era).nil?
-      end
+      # { "7 years ago" => 2006-01-02 23:29:05 -0800, ... }
+      era_date_pairs = eras.inject({}) {|h,era|
+        h[era] = Chronic.parse(era)
+        raise "Could not parse era: #{era}" if h[era].nil?
+        h
+      }
 
-      if order == :desc && Time.now > collection.first.send(options[:date_attr])
-        eras << "just now" 
-      end
-      
-      # Parse date strings
-      # { "7 years ago"=>2006-01-02 23:29:05 -0800, ... }
-      era_date_pairs = eras.inject({}) {|h,e| h[e] = Chronic.parse(e); h }
-          
-      # Sort eras oldest to newest
-      eras = eras.sort_by {|era| Chronic.parse(era) }
-      # .. or newest to oldest
-      eras = eras.reverse unless order == :desc
+      # Sort eras by date
+      # For past collections, newest eras come first
+      # For future collections, oldest eras come first
+      eras = eras.sort_by {|era| era_date_pairs[era] }
+      eras.reverse! if order == :future
     
-      if order == :desc
-
-        # Initialize all hash keys chronologically (newest to oldest)
-        eras.reverse.each {|era| self[era] = [] }
-        
-        # Find the oldest era in which each object was created
-        collection.each do |obj|
-          # puts ("\n #{obj.send(options[:date_attr])} < #{era_date_pairs[era]}")
-          era = eras.find {|era| obj.send(options[:date_attr]) < era_date_pairs[era]  }
-          self[era] << obj
-        end
-      else
-        
-        # Initialize all hash keys chronologically (oldest to newest)
-        eras.reverse.each {|era| self[era] = [] }
-        
-        # Find the newest era in which each object was created
-        collection.each do |obj|
-          era = eras.find {|era| obj.send(options[:date_attr]) > era_date_pairs[era]  }
-          self[era] << obj
+      # Initialize all hash keys chronologically
+      eras.reverse.each {|era| self[era] = [] }
+      
+      collection.each do |obj|
+        era = eras.find do |era|
+          if order == :future
+            # Find newest possible era for the object
+            obj.send(options[:date_attr]) > era_date_pairs[era]
+          else
+            # Find oldest possible era for the object
+            obj.send(options[:date_attr]) < era_date_pairs[era]
+          end
         end
+        self[era] << obj
       end
     
-      # Remove keys for empty eras
+      # Remove empty eras
       self.keys.each {|k| self.delete(k) if self[k].empty? }
     
       self

data/lib/chronicle/version.rb

@@ -1,3 +1,3 @@
 module Chronicle
-  VERSION = "0.0.6"
+  VERSION = "0.1.0"
 end

data/spec/chronicle_spec.rb

@@ -6,54 +6,114 @@ describe Chronicle do
     @minute = 60
     @hour = @minute*60
     @day = @hour*24
-    @things = [
-      double("thing", :created_at => Time.now - 39*@day),
-      double("thing", :created_at => Time.now - 8*@day),
-      double("thing", :created_at => Time.now - 9*@day),
-      double("thing", :created_at => Time.now - 3*@day),
-      double("thing", :created_at => Time.now - 10*@minute),
-      double("thing", :created_at => Time.now)
-    ]
-    
-    @chronicle = Chronicle.new(@things)
   end
+  
+  context "dates in the past and the future" do
+    
+    before do
+      offsets = [@day, -@day]
+      @things = offsets.map do |offset|
+        double("thing", :created_at => Time.now+offset)
+      end
+    end
 
-  it "doesn't have any empty eras" do
-    @chronicle.values.all? {|v| !v.empty? }.should == true
+    it "raises an error" do
+      expect { Chronicle.new(@things) }.to raise_error("Chronicle collections must be entirely in the past or the future.")
+    end
+    
   end
   
-  it "sorts era keys from newest to oldest" do
-    @chronicle.keys.first.should == 'just now'
-    @chronicle.keys.last.should == '1 month ago'
-  end
+  context "dates in the past" do
+    
+    before do
+      offsets = [-39*@day, -8*@day, -9*@day, -3*@day, -10*@minute, 0]
+      @things = offsets.map do |offset|
+        double("thing", :created_at => Time.now+offset)
+      end
+      @chronicle = Chronicle.new(@things)
+    end
+
+    it "doesn't have any empty eras" do
+      @chronicle.values.all? {|v| !v.empty? }.should == true
+    end
   
-  it "sorts objects in eras from newest to oldest" do
-    era = @chronicle['1 week ago']
-    era.size.should == 2
-    era.last.created_at.should be < era.first.created_at
-  end
+    it "sorts era keys from newest to oldest" do
+      @chronicle.keys.first.should == 'right now'
+      @chronicle.keys.last.should == '1 month ago'
+    end
   
-  it "doesn't lose any items during processing" do
-    @chronicle.values.flatten.size.should == @things.size
-  end
+    it "sorts objects in eras from newest to oldest" do
+      era = @chronicle['1 week ago']
+      era.size.should == 2
+      era.last.created_at.should be < era.first.created_at
+    end
   
-  it "accounts for objects that were just created" do
-    now = @chronicle['just now']
-    now.should_not be_empty
-    now.should be_an(Array)
-    now.first.should == @things.last
+    it "doesn't lose any items during processing" do
+      @chronicle.values.flatten.size.should == @things.size
+    end
+  
+    it "accounts for objects that were just created" do
+      now = @chronicle['right now']
+      now.should_not be_empty
+      now.should be_an(Array)
+      now.first.should == @things.last
+    end
+    
   end
   
+  context "dates in the future" do
+    
+    before(:each) do
+      @things = [
+        double("thing", :created_at => Time.now + 39*@day),
+        double("thing", :created_at => Time.now + 9*@day),
+        double("thing", :created_at => Time.now + 8*@day),
+        double("thing", :created_at => Time.now + 3*@day),
+        double("thing", :created_at => Time.now + 9*@minute),
+        double("thing", :created_at => Time.now + 2),
+      ]
+      @chronicle = Chronicle.new(@things, order: :asc)
+    end
+
+    it "doesn't have any empty eras" do
+      @chronicle.values.all? {|v| !v.empty? }.should == true
+    end
+      
+    it "sorts era keys from oldest to newest" do
+      @chronicle.keys.first.should == 'right now'
+      @chronicle.keys.last.should == '1 month from now'
+    end
+      
+    it "sorts objects in eras from oldest to newest" do
+      era = @chronicle['1 week from now']
+      era.size.should == 2
+      era.last.created_at.should be > era.first.created_at
+    end
+      
+    it "doesn't lose any items during processing" do
+      @chronicle.values.flatten.size.should == @things.size
+    end
+    
+  end
+
   context "custom eras" do
+
+    before do
+      offsets = [-39*@day, -8*@day, -9*@day, -3*@day, -10*@minute, 0]
+      @things = offsets.map do |offset|
+        double("thing", :created_at => Time.now+offset)
+      end
+      @chronicle = Chronicle.new(@things)
+    end
     
-    it "add 'just now' to the list of eras if it's missing, to keep from losing very new objects" do
+    it "add 'right now' to the list of eras if it's missing, to keep from losing very new objects" do
       @chronicle = Chronicle.new(@things, :eras => ['3 minutes ago', '35 days ago'])
-      @chronicle.keys.first.should == 'just now'
+      @chronicle.keys.first.should == 'right now'
     end
 
     it "allows custom eras to be set in any order" do
-      @chronicle = Chronicle.new(@things, :eras => ['just now', '35 days ago', '3 minutes ago'])
-      @chronicle.keys.should == ['just now', '3 minutes ago', '35 days ago']
+      @chronicle = Chronicle.new(@things, :eras => ['right now', '35 days ago', '3 minutes ago'])
+      @chronicle.keys.should == ['right now', '3 minutes ago', '35 days ago']
     end
     
     it "raises an exception for eras that cannot be parsed" do
@@ -79,7 +139,7 @@ describe Chronicle do
       @chronicle = Chronicle.new(@things, :date_attr => :updated_at)
       @chronicle.values.flatten.size.should == @things.size
       @chronicle.keys.last.should == '1 year ago'
-      @chronicle.keys.first.should == 'just now'
+      @chronicle.keys.first.should == 'right now'
     end
     
     it "gracefully ignores objects with nil timestamps" do
@@ -93,40 +153,5 @@ describe Chronicle do
     end
   
   end
-  
-  context "future dates" do
-    
-    before(:each) do
-      @things = [
-        double("thing", :created_at => Time.now + 39*@day),
-        double("thing", :created_at => Time.now + 8*@day),
-        double("thing", :created_at => Time.now + 9*@day),
-        double("thing", :created_at => Time.now + 3*@day),
-        double("thing", :created_at => Time.now + 9*@minute),
-      ]
-      @chronicle = Chronicle.new(@things, order: :asc)
-    end
-
-    it "doesn't have any empty eras" do
-      @chronicle.values.all? {|v| !v.empty? }.should == true
-    end
-      
-    it "sorts era keys from oldest to newest" do
-      @chronicle.keys.first.should == '5 minutes from now'
-      @chronicle.keys.last.should == '1 month from now'
-    end
-      
-    it "sorts objects in eras from oldest to newest" do
-      era = @chronicle['1 week from now']
-      era.size.should == 2
-      era.last.created_at.should be > era.first.created_at
-    end
-      
-    it "doesn't lose any items during processing" do
-      @chronicle.values.flatten.size.should == @things.size
-    end
-    
-  end
-
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chronicle
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2013-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hoe
@@ -106,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4597408090393416326
+      hash: 408063275270650171
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -115,7 +115,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4597408090393416326
+      hash: 408063275270650171
 requirements: []
 rubyforge_project: chronicle
 rubygems_version: 1.8.24