chronomize 0.0.1

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,64 @@
+# Chronomize
+
+A simple tool for navigating relative to a date, with knowledge about how current that date is.
+
+## Usage
+
+Navigation surrounding today's date.
+
+    navigation = Chronomize.new(Date.today)
+
+    navigation.previous
+    => 'March 6, 2012 (yesterday)'
+
+    navigation.current
+    => 'March 7, 2012 (today)'
+
+    navigation.next
+    => 'March 8, 2012 (tomorrow)'
+
+Navigation with a different date selected.
+
+    navigation = Chronomize.new(Date.yesterday)
+
+    navigation.previous
+    => 'March 5, 2012'
+
+    navigation.current
+    => 'March 6, 2012 (yesterday)'
+
+    navigation.next
+    => 'March 7, 2012 (today)'
+
+### Day names
+
+    navigation = Chronomize.new(Date.today, :today => 'aujourd\'hui', :yesterday => 'hier', :tomorrow => 'demain')
+
+### Add symbols to accentuate previous / next
+
+    navigation = Chronomize.new(Date.today, :previous => '<', :next => '>')
+
+    navigation.previous
+    => '< March 6, 2012 (yesterday)'
+
+    navigation.current
+    => 'March 7, 2012 (today)'
+
+    navigation.next
+    => 'March 8, 2012 (tomorrow) >'
+
+### Change date format
+
+Use any valid strftime format.
+
+    navigation = Chronomize.new(Date.today, :date_format => '%-d.%-m.%Y')
+
+    navigation.previous
+    => '6.3.2012 (yesterday)'
+
+    navigation.current
+    => '7.3.2012 (today)'
+
+    navigation.next
+    => '8.3.2012 (tomorrow)'
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/chronomize.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "chronomize"
+  s.version     = "0.0.1"
+  s.authors     = ["Katrina Owen"]
+  s.email       = ["katrina.owen@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Simple dateful navigation.}
+  s.description = %q{Creates labels for a window of dates, with knowledge about it's relationship to the current date.}
+
+  s.rubyforge_project = "chronomize"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "timecop"
+  # s.add_runtime_dependency "i18n"
+end

data/lib/chronomize.rb

@@ -0,0 +1,54 @@
+require 'date'
+require 'extensions/date'
+
+class Chronomize
+
+  attr_accessor :date, :date_format, :yesterday, :today, :tomorrow, :backward, :forward
+  def initialize(date, options = {})
+    self.date = date
+    self.date_format = options[:date_format] || "%B %-d, %Y"
+    self.yesterday = options.fetch(:yesterday) { 'yesterday' }
+    self.today = options.fetch(:today) { 'today' }
+    self.tomorrow = options.fetch(:tomorrow) { 'tomorrow' }
+    self.backward = options[:previous]
+    self.forward = options[:next]
+  end
+
+  def previous
+    label_for day(-1), :backward
+  end
+
+  def current
+    label_for day(0)
+  end
+
+  def next
+    label_for day(1), :forward
+  end
+
+  def day(n)
+    date + n
+  end
+
+  def label_for(date, direction = nil)
+    pieces = [] << format(date) << chronicality(date)
+    pieces.push forward if direction == :forward
+    pieces.unshift backward if direction == :backward
+    pieces.compact.join(" ")
+  end
+
+  def format(date)
+    date.strftime(date_format)
+  end
+
+  def chronicality(date)
+    if Date.yesterday?(date)
+      "(#{yesterday})" if yesterday
+    elsif Date.today?(date)
+      "(#{today})" if today
+    elsif Date.tomorrow?(date)
+      "(#{tomorrow})" if tomorrow
+    end
+  end
+
+end

data/lib/extensions/date.rb

@@ -0,0 +1,15 @@
+class Date
+  class << self
+    def today?(date)
+      Date.today == date
+    end
+
+    def yesterday?(date)
+      (Date.today - 1) == date
+    end
+
+    def tomorrow?(date)
+      (Date.today + 1) == date
+    end
+  end
+end

data/spec/chronomize_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Chronomize do
+
+  let(:feb3) { Date.new(2012, 2, 3) }
+  let(:feb4) { Date.new(2012, 2, 4) }
+  let(:feb5) { Date.new(2012, 2, 5) }
+  let(:feb6) { Date.new(2012, 2, 6) }
+  let(:feb7) { Date.new(2012, 2, 7) }
+  let(:feb8) { Date.new(2012, 2, 8) }
+  let(:feb9) { Date.new(2012, 2, 9) }
+
+  before(:each) { Timecop.freeze(feb7) }
+
+  context "today" do
+    subject { Chronomize.new(feb7) }
+
+    its(:previous) { should eq('February 6, 2012 (yesterday)') }
+    its(:current) { should eq('February 7, 2012 (today)') }
+    its(:next) { should eq('February 8, 2012 (tomorrow)') }
+  end
+
+  context "tomorrow" do
+    subject { Chronomize.new(feb8) }
+
+    its(:previous) { should eq('February 7, 2012 (today)') }
+    its(:current) { should eq('February 8, 2012 (tomorrow)') }
+    its(:next) { should eq('February 9, 2012') }
+  end
+
+  context "yesterday" do
+    subject { Chronomize.new(feb6) }
+
+    its(:previous) { should eq('February 5, 2012') }
+    its(:current) { should eq('February 6, 2012 (yesterday)') }
+    its(:next) { should eq('February 7, 2012 (today)') }
+  end
+
+  context "last week" do
+    subject { Chronomize.new(feb4) }
+    its(:previous) { should eq('February 3, 2012') }
+    its(:current) { should eq('February 4, 2012') }
+    its(:next) { should eq('February 5, 2012') }
+  end
+
+  context "with symbols" do
+    subject { Chronomize.new(feb6, :previous => '<~', :next => '~>') }
+    its(:previous) { should eq('<~ February 5, 2012') }
+    its(:current) { should eq('February 6, 2012 (yesterday)') }
+    its(:next) { should eq('February 7, 2012 (today) ~>') }
+  end
+
+  context "with alternate day names" do
+    subject { Chronomize.new(feb7, :today => "aujourd'hui", :yesterday => 'hier', :tomorrow => 'demain') }
+
+    its(:previous) { should eq('February 6, 2012 (hier)') }
+    its(:current) { should eq('February 7, 2012 (aujourd\'hui)') }
+    its(:next) { should eq('February 8, 2012 (demain)') }
+  end
+
+  context "without day names" do
+    subject { Chronomize.new(feb7, :today => nil, :yesterday => nil, :tomorrow => nil) }
+
+    its(:previous) { should eq('February 6, 2012') }
+    its(:current) { should eq('February 7, 2012') }
+    its(:next) { should eq('February 8, 2012') }
+  end
+
+  context "with alternate date format" do
+    subject { Chronomize.new(feb4, :date_format => '%-d.%-m.%Y') }
+
+    its(:previous) { should eq('3.2.2012') }
+    its(:current) { should eq('4.2.2012') }
+    its(:next) { should eq('5.2.2012') }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'chronomize'
+require 'timecop'
+
+RSpec.configure do |config|
+  config.backtrace_clean_patterns = [
+    /\/lib\d*\/ruby\//,
+    /bin\//,
+    /spec\/spec_helper\.rb/,
+    /lib\/rspec\/(core|expectations|matchers|mocks)/
+  ]
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: chronomize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Katrina Owen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70312046276940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70312046276940
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70312046276420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70312046276420
+description: Creates labels for a window of dates, with knowledge about it's relationship
+  to the current date.
+email:
+- katrina.owen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- chronomize.gemspec
+- lib/chronomize.rb
+- lib/extensions/date.rb
+- spec/chronomize_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: chronomize
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Simple dateful navigation.
+test_files:
+- spec/chronomize_spec.rb
+- spec/spec_helper.rb