dotiw 0.2.4

data/.gitignore

@@ -0,0 +1,2 @@
+tmp
+spec/fixtures/database.yml

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Bigg
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,117 @@
+# dotiw
+
+dotiw is a plugin for Rails that overrides the default `distance_of_time_in_words` and provides a more accurate output. Do you crave accuracy down to the second? So do I. That's why I made this plugin. Take this for a totally kickass example:
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, true)
+    => "1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds"
+     
+Also if one of the measurement is zero it will not output it:
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.year + 2.months + 4.hours + 5.minutes + 6.seconds, true)
+    => "1 year, 2 months, 4 hours, 5 minutes, and 6 seconds"
+     
+Better than "about 1 year", am I right? Of course I am.
+
+This takes the same options plus an additional one on the end for passing options to the output (which uses `to_sentence`). 
+
+Oh, and did I mention it supports I18n? Oh yeah.
+
+## distance\_of\_time\_in\_words\_hash
+
+Don't like any format you're given? That's cool too! Here, have an indifferent hash version:
+
+    >> distance_of_time_in_words_hash(Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds)
+    => {"days"=>3, "seconds"=>6, "minutes"=>5, "years"=>1, "hours"=>4, "months"=>2}
+
+Indiferrent means that you can access all keys by their `String` or `Symbol` version.
+
+### Options
+
+#### :locale
+
+The keys can be in your local language too:
+
+    >> distance_of_time_in_words_hash(Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, :locale => "es")
+    => {"horas"=>4, "días"=>3, "minutos"=>5, "segundos"=>6, "años"=>1, "meses"=>2}
+    
+You are not guaranteed the order of the hash in Ruby 1.8.
+
+## distance\_of\_time\_in\_words
+
+### Options
+
+The third argument for this method is whether or not to include seconds. By default this is `false` (because in Rails' `distance_of_time_in_words` it is), you can turn it on though by passing `true` as the third argument:
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.year + 1.second, true)
+    => "1 year, and 1 second" 
+    
+Yes this could just be merged into the options hash but I'm leaving it here to ensure "backwards-compatibility".
+
+#### :locale
+
+You can pass in a locale and it'll output it in whatever language you want (provided you have translations, otherwise it'll default to English):
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.minute, false, :locale => "es")
+    => "1 minuto"
+    
+This will also be passed to `to_sentence`
+
+#### :only
+
+**Note that values passed into this option must be passed in as strings!**
+
+Only want a specific measurement of time? No problem!
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute, false, :only => "minutes")
+    => "1 minute"
+
+You only want some? No problem too!
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.day + 1.minute, false, :only => ["minutes", "hours"])
+    => "1 hour and 1 minute"
+
+#### :except
+
+**Note that values passed into this option must be passed in as strings!**
+
+Don't want a measurement of time? No problem!
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute, false, :except => "minutes")
+    => "1 hour"
+
+Culling a whole group of measurements of time:
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.day + 1.minute, false, :except => ["minutes", "hours"])
+    => "1 day"
+    
+#### :words_connector
+
+**This is an option for `to_sentence`, defaults to ', '**
+
+Using something other than a comma:
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, { :words_connector => ' - ' })
+    => "1 hour - 1 minute, and 1 second"
+    
+#### :two\_words\_connector
+
+**This is an option for `to_sentence`, defaults to ' and '**
+
+Using something other than 'and':
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute, true, { :two_words_connector => ' plus ' })
+    => "1 hour plus 1 minute"
+
+#### :last\_word\_connector 
+
+**This is an option for `to_sentence`, defaults to ', and '**
+
+Using something other than ', and':
+
+    >> distance_of_time_in_words(Time.now, Time.now + 1.hour + 1.minute + 1.second, true, { :last_word_connector => ', finally ' })
+    => "1 hour, 1 minute, finally 1 second"
+    
+## Contributors
+
+chendo - for talking through it with me and drawing on the whiteboard
+Derander - correct Spanish translations

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dotiw"
+    gem.summary = %Q{Better distance_of_time_in_words for Rails}
+    gem.description = %Q{Better distance_of_time_in_words for Rails}
+    gem.email = "radarlistener@gmail.com"
+    gem.homepage = "http://github.com/radar/dotiw"
+    gem.authors = ["Ryan Bigg"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dotiw #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.2.4

data/dotiw.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dotiw}
+  s.version = "0.2.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Bigg"]
+  s.date = %q{2009-10-18}
+  s.description = %q{Better distance_of_time_in_words for Rails}
+  s.email = %q{radarlistener@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "dotiw.gemspec",
+     "lib/dotiw.rb",
+     "lib/i18n.rb",
+     "rails/init.rb",
+     "spec/dotiw_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/translations/en.yml",
+     "spec/translations/es.yml"
+  ]
+  s.homepage = %q{http://github.com/radar/dotiw}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Better distance_of_time_in_words for Rails}
+  s.test_files = [
+    "spec/dotiw_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end

data/lib/dotiw.rb

@@ -0,0 +1,96 @@
+module ActionView
+  module Helpers
+    module DateHelper
+      def distance_of_time_in_words_hash(from_time, to_time, options={})
+        output = HashWithIndifferentAccess.new
+        from_time = from_time.to_time if from_time.respond_to?(:to_time)
+        to_time = to_time.to_time if to_time.respond_to?(:to_time)
+        
+        distance = (from_time - to_time).abs
+        I18n.with_options :locale => options[:locale] do |locale|
+          while distance > 0
+            if distance < 1.minute
+              output[locale.t(:seconds, :default => "seconds")] = distance.to_i
+              distance = 0
+            elsif distance < 1.hour
+              output[locale.t(:minutes, :default => "minutes")], distance = distance.divmod(1.minute)
+            elsif distance < 1.day
+              output[locale.t(:hours, :default => "hours")], distance = distance.divmod(1.hour)
+            elsif distance < 28.days
+              output[locale.t(:days, :default => "days")], distance = distance.divmod(1.day)
+              # Time has to be greater than a month
+            else
+              smallest, largest = from_time < to_time ? [from_time, to_time] : [to_time, from_time]   
+            
+              months = (largest.year - smallest.year) * 12 + (largest.month - smallest.month)
+              years, months = months.divmod(12)
+            
+              days = largest.day - smallest.day
+              
+              # Will otherwise incorrectly say one more day if our range goes over a day. 
+              days -= 1 if largest.hour < smallest.hour
+            
+              if days < 0
+                # Convert the last month to days and add to total
+                months -= 1
+                last_month = largest.advance(:months => -1)
+                days += Time.days_in_month(last_month.month, last_month.year)              
+              end
+            
+              if months < 0
+                # Convert a year to months
+                years -= 1
+                months += 12
+              end
+            
+              output[locale.t(:years, :default => "years")] = years
+              output[locale.t(:months, :default => "months")] = months
+              output[locale.t(:days, :default => "days")] = days
+            
+              total_days, distance = distance.divmod(1.day)
+            end
+          end
+        end
+        output
+      end
+      
+      def distance_of_time_in_words(from_time, to_time, include_seconds = false, options = {})
+        hash = distance_of_time_in_words_hash(from_time, to_time, options)
+        hash.delete(:seconds) if !include_seconds
+        I18n.with_options :locale => options[:locale] do |locale|
+          # Remove all the values that are nil.
+          time_measurements = [locale.t(:years, :default => "years"),
+                               locale.t(:months, :default => "months"),
+                               locale.t(:weeks, :default => "weeks"),
+                               locale.t(:days, :default => "days"),
+                               locale.t(:hours, :default => "hours"),
+                               locale.t(:minutes, :default => "minutes"),
+                               locale.t(:seconds, :default => "seconds")].delete_if do |key|
+            hash[key].nil? || hash[key].zero? || 
+            # Remove the keys that we don't want.
+            (!options[:except].nil? && options[:except].include?(key)) ||
+            # keep the keys we only want.
+            (options[:only] && !options[:only].include?(key))
+          end
+          
+          options.delete(:except)
+          options.delete(:only)
+          output = []
+          time_measurements.each do |key|
+            name = hash[key] > 1 ? key : key.singularize
+            output += ["#{hash[key]} #{name}"]
+          end
+          
+          # maybe only grab the first few values
+          if options[:precision]
+            output = output[0...options[:precision]]
+            options.delete(:precision)
+          end
+        
+          output.to_sentence(options)
+        end    
+      end
+    end
+  end
+end
+       

data/lib/i18n.rb

@@ -0,0 +1,5 @@
+class I18n
+  def p(key)
+    t(key, :default => key)
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'dotiw'

data/spec/dotiw_spec.rb

@@ -0,0 +1,107 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+require 'dotiw'
+
+describe "A better distance_of_time_in_words" do
+  include ActionView::Helpers::DateHelper
+  include ActionView::Helpers::TextHelper
+  
+  before do
+    I18n.locale = :en
+    time = "01-08-2009".to_time
+    Time.stub!(:now).and_return(time)
+    Time.zone.stub!(:now).and_return(time)
+  end
+  
+  describe "hash version" do
+    describe "giving correct numbers of" do
+      
+      [:years, :months, :days, :minutes, :seconds].each do |name|
+        describe name do
+          it "exactly" do
+            hash = distance_of_time_in_words_hash(Time.now, Time.now + 1.send(name))
+            hash[name].should eql(1)    
+          end
+
+          it "two" do
+            hash = distance_of_time_in_words_hash(Time.now, Time.now + 2.send(name))
+            hash[name].should eql(2)
+          end    
+        end
+      end
+      
+      it "should be happy with lots of measurements" do
+        hash = distance_of_time_in_words_hash(Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds)
+        hash[:years].should eql(1)
+        hash[:months].should eql(2)
+        hash[:days].should eql(3)
+        hash[:hours].should eql(4)
+        hash[:minutes].should eql(5)
+        hash[:seconds].should eql(6)
+      end
+      
+      it "debe estar contento con las mediciones en español" do
+        hash = distance_of_time_in_words_hash(Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, :locale => "es")
+        hash[:años].should eql(1)
+        hash[:meses].should eql(2)
+        hash[:días].should eql(3)
+        hash[:horas].should eql(4)
+        hash[:minutos].should eql(5)
+        hash[:segundos].should eql(6)
+      end
+        
+    
+      it "debe hablar español" do
+        I18n.locale = :es
+        hash = distance_of_time_in_words_hash(Time.now, Time.now + 5.days)  
+        hash["días"].should eql(5)
+      end
+    end
+  end
+  
+  describe "real version" do
+    it "debe hablar español" do
+      distance_of_time_in_words(Time.now, Time.now + 5.days, true, :locale => "es").should eql("5 días")
+    end
+    
+    [
+      [Time.now, Time.now + 5.days + 3.minutes, "5 days and 3 minutes"],
+      [Time.now, Time.now + 1.minute, "1 minute"],
+      [Time.now, Time.now + 3.years, "3 years"],
+      [Time.now, Time.now + 10.years, "10 years"],
+      [Time.now, Time.now + 3.hour, "3 hours"],
+      [Time.now, Time.now + 13.months, "1 year and 1 month"],
+      # Any numeric sequence is merely coincidental.
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, "1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds"],
+      ["2009-3-16".to_time, "2008-4-14".to_time, "11 months and 2 days"],
+      ["2009-3-16".to_time + 1.minute, "2008-4-14".to_time, "11 months, 2 days, and 1 minute"],
+      ["2009-4-14".to_time, "2008-3-16".to_time, "1 year and 29 days"],
+      ["2009-2-01".to_time, "2009-3-01".to_time, "1 month"],
+      ["2008-2-01".to_time, "2008-3-01".to_time, "1 month"]
+    ].each do |start, finish, output|
+      it "should be #{output}" do
+        distance_of_time_in_words(start, finish, true).should eql(output)
+      end
+    end
+  end
+  
+  describe "with output options" do
+   [
+      # Any numeric sequence is merely coincidental.
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :except => "minutes" }, "1 year, 2 months, 3 days, 4 hours, and 6 seconds"],
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :words_connector => " - " }, "1 year - 2 months - 3 days - 4 hours - 5 minutes, and 6 seconds"],
+      [Time.now, Time.now + 5.minutes + 6.seconds, { :two_words_connector => " - " }, "5 minutes - 6 seconds"],
+      [Time.now, Time.now + 4.hours +  5.minutes + 6.seconds, { :last_word_connector => " - " }, "4 hours, 5 minutes - 6 seconds"],
+      [Time.now, Time.now + 1.hour + 1.minute, { :except => "minutes"}, "1 hour"],
+      [Time.now, Time.now + 1.hour + 1.day + 1.minute, { :except => ["minutes", "hours"]}, "1 day"],
+      [Time.now, Time.now + 1.hour + 1.day + 1.minute, { :only => ["minutes", "hours"]}, "1 hour and 1 minute"],
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :precision => 2 }, "1 year and 2 months"],
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :precision => 3 }, "1 year, 2 months, and 3 days"],
+      [Time.now, Time.now + 1.year + 2.months + 3.days + 4.hours + 5.minutes + 6.seconds, { :precision => 10 }, "1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds"]
+    ].each do |start, finish, options, output|
+      it "should be #{output}" do
+        distance_of_time_in_words(start, finish, true, options).should eql(output)
+      end
+    end
+  end
+    
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+$:.unshift(File.join(File.dirname(__FILE__), "../lib"))
+
+require 'action_controller'
+require 'activesupport'
+require 'dotiw'
+require 'spec'
+
+# Define time zone before loading, just like in the real world
+zone = "UTC"
+Time.zone = zone
+
+I18n.load_path << Dir[File.join(File.dirname(__FILE__), "translations", "*")]
+I18n.locale = :en
+
+# bootstraping the plugin through init.rb
+# tests how it would load in a real application
+load File.dirname(__FILE__) + "/../rails/init.rb"

data/spec/translations/en.yml

@@ -0,0 +1,9 @@
+en:
+  seconds: seconds
+  minutes: minutes
+  hours: hours
+  days: days
+  weeks: weeks
+  months: months
+  years: years
+  

data/spec/translations/es.yml

@@ -0,0 +1,9 @@
+es:
+  seconds: segundos
+  minutes: minutos
+  hours: horas
+  days: días
+  weeks: semanas
+  months: meses
+  years: años
+  

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: dotiw
+version: !ruby/object:Gem::Version 
+  version: 0.2.4
+platform: ruby
+authors: 
+- Ryan Bigg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-18 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Better distance_of_time_in_words for Rails
+email: radarlistener@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- dotiw.gemspec
+- lib/dotiw.rb
+- lib/i18n.rb
+- rails/init.rb
+- spec/dotiw_spec.rb
+- spec/spec_helper.rb
+- spec/translations/en.yml
+- spec/translations/es.yml
+has_rdoc: true
+homepage: http://github.com/radar/dotiw
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Better distance_of_time_in_words for Rails
+test_files: 
+- spec/dotiw_spec.rb
+- spec/spec_helper.rb