chronicle 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in chronicle.gemspec
+gemspec

data/README.md

@@ -0,0 +1,60 @@
+Chronicle
+=========
+
+Chronicle groups collections of ActiveRecord objects into chronologically ordered hashes.
+It uses [Chronic](https://github.com/mojombo/chronic/) to parse natural language dates 
+and [ActiveSupport::OrderedHash](http://apidock.com/rails/ActiveSupport/OrderedHash)
+to keep the hash order consistent.
+
+```ruby
+# Before...
+[
+  object_1,
+  object_2,
+  object_3,
+  object_4,
+  object_5,
+  object_6,
+  object_7,
+  object_8
+]
+
+# After... 
+{
+  "just now": [object_10, object_9],
+  "two hours ago": [object_8, object_7, object_6],
+  "yesterday": [object_5, object_4, object_3],
+  "6 months ago": [object_2],
+  "1 year ago": [object_1]
+}
+```
+
+Installation
+------------
+
+```ruby
+# Put this in your Gemfile and smoke it.
+gem 'chronicle'
+```
+
+Usage
+-----
+
+```ruby
+# Fetch some objects (presumably ActiveRecord)
+things = Thing.all
+
+# Put them into buckets, using Chronicle's default eras
+chronicle = Chronicle.new(things)
+
+# To deviate from the default eras...
+chronicle = Chronicle.new(things, :eras => ["5 minutes ago", "2 hours ago", "three weeks ago"])
+
+# To sort based on an attribute other than :created_at
+chronicle = Chronicle.new(things, :date_attr => :updated_at)
+```
+
+License
+-------
+
+MIT License. Do whatever you want.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/chronicle.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "chronicle/version"
+
+Gem::Specification.new do |s|
+  s.name        = "chronicle"
+  s.version     = Chronicle::VERSION
+  s.authors     = ["Zeke Sikelianos"]
+  s.email       = ["zeke@sikelianos.com"]
+  s.homepage    = "http://zeke.sikelianos.com"
+  s.summary     = %q{Chronicle groups collections of ActiveRecord objects into chronologically ordered hashes.}
+  s.description = %q{Chronicle groups collections of ActiveRecord objects into chronologically ordered hashes.}
+
+  s.rubyforge_project = "chronicle"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "hoe"
+  s.add_development_dependency 'rspec', '~> 2.8.0'
+  s.add_development_dependency 'autotest'
+
+  s.add_runtime_dependency "chronic"
+  s.add_dependency 'rails'
+end

data/lib/chronicle.rb

@@ -0,0 +1,82 @@
+require 'rubygems'
+require 'chronic'
+require 'active_support/all' # OrderedHash
+require 'chronicle'
+
+module Chronicle
+  
+  def self.new(collection, options={})  
+    defaults = {
+      :eras => Chronicle.default_eras,
+      :date_attr => :created_at
+    }
+    ChronicleHash.new(collection, defaults.merge(options))
+  end
+
+  def self.default_eras
+    [
+      "3 years ago",
+      "2 years ago",
+      "one year ago",
+      "6 months ago",
+      "3 months ago",
+      "2 months ago",
+      "one month ago",
+      "3 weeks ago",
+      "2 weeks ago",
+      "one week ago",
+      "6 days ago",
+      "4 days ago",
+      "3 days ago",
+      "2 days ago",
+      "yesterday",
+      "8 hours ago",
+      "4 hours ago",
+      "2 hours ago",
+      "1 hour ago",
+      "30 minutes ago",
+      "20 minutes ago",
+      "10 minutes ago",
+      "5 minutes ago",
+      "3 minutes ago",
+      "2 minutes ago",
+      "one minute ago",
+      "just now"
+    ]
+  end
+
+  class ChronicleHash < ActiveSupport::OrderedHash
+
+    def initialize(collection, options)
+      
+      eras = options[:eras]
+
+      # Make sure 'just now' is included, so no objects fall through the cracks
+      eras << "just now" unless eras.any? {|era| era =~ /now/i }
+    
+      # Ensure all eras can be parsed
+      eras.each do |era|
+        raise "Could not parse era: #{era}" if Chronic.parse(era).nil?
+      end
+      
+      # Sort eras oldest to newest
+      eras = eras.sort_by {|era| Chronic.parse(era) }
+    
+      # Initialize all OrderedHash keys chronologically (newest to oldest)
+      eras.reverse.each {|era| self[era] = [] }
+
+      # Find the oldest era in which each object was created
+      collection.sort_by {|obj| obj.send(options[:date_attr])}.reverse.each do |obj|
+        era = eras.find {|era| obj.send(options[:date_attr]) < Chronic.parse(era) }
+        self[era] << obj
+      end
+    
+      # Remove keys for empty eras
+      self.keys.each {|k| self.delete(k) if self[k].blank? }
+    
+      self
+    end
+    
+  end
+  
+end

data/lib/chronicle/version.rb

@@ -0,0 +1,3 @@
+module Chronicle
+  VERSION = "0.0.1"
+end

data/spec/chronicle_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe Chronicle do
+
+  before(:each) do
+    @things = [
+      double("thing", :created_at => 39.days.ago),
+      double("thing", :created_at => 8.days.ago),
+      double("thing", :created_at => 9.days.ago),
+      double("thing", :created_at => 3.days.ago),
+      double("thing", :created_at => 10.minutes.ago),
+      double("thing", :created_at => Time.now)
+    ]
+    
+    @chronicle = Chronicle.new(@things)
+  end
+
+  it "doesn't have any empty eras" do
+    @chronicle.values.all? {|v| v.present? }.should == true
+  end
+  
+  it "sorts era keys from newest to oldest" do
+    @chronicle.keys.first.should == 'just now'
+    @chronicle.keys.last.should == 'one month ago'
+  end
+  
+  it "sorts objects in eras from newest to oldest" do
+    era = @chronicle['one week ago']
+    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
+  
+  it "accounts for objects that were just created" do
+    now = @chronicle['just now']
+    now.should_not be_blank
+    now.should be_an(Array)
+    now.first.should == @things.last
+  end
+  
+  context "custom eras" do
+    
+    it "add 'just 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'
+    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']
+    end
+    
+    it "raises an exception for eras that cannot be parse" do
+      expect { Chronicle.new(@things, :eras => ['63 eons hence']) }.to raise_error("Could not parse era: 63 eons hence")
+    end
+    
+  end
+  
+  context "custom date attribute" do
+    
+    before(:each) do
+      @things = [
+        double("thing", :updated_at => 369.days.ago, :created_at => nil),
+        double("thing", :updated_at => 9.days.ago, :created_at => nil),
+        double("thing", :updated_at => 8.days.ago, :created_at => nil),
+        double("thing", :updated_at => 3.days.ago, :created_at => nil),
+        double("thing", :updated_at => 10.minutes.ago, :created_at => nil),
+        double("thing", :updated_at => Time.now, :created_at => nil)
+      ]
+    end
+
+    it "allows an alternative to created_at" do
+      @chronicle = Chronicle.new(@things, :date_attr => :updated_at)
+      @chronicle.values.flatten.size.should == @things.size
+      @chronicle.keys.last.should == 'one year ago'
+      @chronicle.keys.first.should == 'just now'
+    end
+  
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'chronicle'
+include Chronicle
+
+require 'active_support/all' # to get methods like blank? and starts_with?
+
+# include ActionView::Helpers
+include ActiveSupport
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: chronicle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Zeke Sikelianos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &70361455414560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70361455414560
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70361455413780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70361455413780
+- !ruby/object:Gem::Dependency
+  name: autotest
+  requirement: &70361455412920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70361455412920
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: &70361455411820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70361455411820
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70361455410980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70361455410980
+description: Chronicle groups collections of ActiveRecord objects into chronologically
+  ordered hashes.
+email:
+- zeke@sikelianos.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- chronicle.gemspec
+- lib/chronicle.rb
+- lib/chronicle/version.rb
+- spec/chronicle_spec.rb
+- spec/spec_helper.rb
+homepage: http://zeke.sikelianos.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: chronicle
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Chronicle groups collections of ActiveRecord objects into chronologically
+  ordered hashes.
+test_files: []