date-casually 0.1.0 → 0.2.0

data/README.rdoc

@@ -24,8 +24,8 @@ If you'd like to change what increments of time DateCasually returns you can use
 
 You can also pass in multiple options:
 
-  (Date.today + 1).casual(:as => :days, :months, :years) 
-    #=> 'less than a month from now'
+  (Date.today + 12).casual(:as => :days, :months, :years) 
+    #=> 'tomorrow'
     
 The default :as options for DatCasually are:
   

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/date-casually.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{date-casually}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Theo Mills"]
-  s.date = %q{2010-08-26}
+  s.date = %q{2010-09-05}
   s.description = %q{If you've never liked (and always seem to forget) the name of the Rails distance_of_time_in_words_to_now helper method, then it's time to date casually.}
   s.email = %q{twmills@twmills.com}
   s.extra_rdoc_files = [
@@ -28,14 +28,13 @@ Gem::Specification.new do |s|
      "lib/date-casually/calculator.rb",
      "lib/date-casually/config.rb",
      "lib/date-casually/translator.rb",
-     "lib/date-casually/translators/day_of_week.rb",
-     "lib/date-casually/translators/days.rb",
-     "lib/date-casually/translators/months.rb",
-     "lib/date-casually/translators/weeks.rb",
-     "lib/date-casually/translators/years.rb",
+     "lib/date-casually/translator/day_of_week.rb",
+     "lib/date-casually/translator/days.rb",
+     "lib/date-casually/translator/months.rb",
+     "lib/date-casually/translator/weeks.rb",
+     "lib/date-casually/translator/years.rb",
      "lib/extensions/date.rb",
      "lib/locale/en.yml",
-     "lib/locale/en.yml.sorted",
      "lib/util/alphabetize_yaml.rb",
      "test/helper.rb",
      "test/test_calculator.rb",
@@ -45,8 +44,7 @@ Gem::Specification.new do |s|
      "test/test_months.rb",
      "test/test_translator.rb",
      "test/test_weeks.rb",
-     "test/test_years.rb",
-     "test/timeline.rb"
+     "test/test_years.rb"
   ]
   s.homepage = %q{http://github.com/twmills/date-casually}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -62,8 +60,7 @@ Gem::Specification.new do |s|
      "test/test_months.rb",
      "test/test_translator.rb",
      "test/test_weeks.rb",
-     "test/test_years.rb",
-     "test/timeline.rb"
+     "test/test_years.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/date-casually/calculator.rb

@@ -1,43 +1,137 @@
 module DateCasually
   
-  # Contains short-cut calculations for determing the distance between
-  # today and a supplied date.
-  class Calculator
-
+  # Contains convenience calculations for determing the distance between
+  # today and a supplied date. All methods are module methods and should be called
+  # on the Calculator module. 
+  # For example:
+  #
+  #   DateCasually::Calculator.number_of_weeks_from_today(Date.today + 28)
+  #   #=> 4
+  #
+  module Calculator
+    
+    # Returns the number of full weeks from the supplied date to today's date.
+    #
+    # date  - The Date used to compare against today's date and determine the number
+    #         of weeks between the two.
+    #
+    # Examples (if today is 2010-09-03)
+    #
+    #   DateCasually::Calculator.number_of_weeks_from_today(Date.today + 28)
+    #   #=> 4
+    #  
+    #   DateCasually::Calculator.number_of_weeks_from_today(Date.today)
+    #   #=> 0
+    #
+    # Returns the number of weeks between the supplied date and today.
     def self.number_of_weeks_from_today(date)
       ((Date.today - date) / 7).to_i.abs
     end
     
+    # Returns the number of months from to today's date to the supplied date. 
+    #
+    # date  - The Date used to compare against today's date and determine the number
+    #         of months between the two.
+    #
+    # Examples (if today is 2010-09-03)
+    #
+    #   DateCasually::Calculator.number_of_months_from_today(Date.today + 28)
+    #   #=> 1
+    #  
+    # Returns the number of months between the supplied date and today.
     def self.number_of_months_from_today(date)
       ((Date.today.month - date.month) + 12 * (Date.today.year - date.year)).abs      
     end
     
+    # Returns the number of years from to today's date to the supplied date. 
+    #
+    # date  - The Date used to compare against today's date and determine the number
+    #         of years between the two.
+    #
+    # Examples (if today is 2010-09-03)
+    #
+    #   DateCasually::Calculator.number_of_months_from_today(Date.today + 365)
+    #   #=> 1
+    #  
+    # Returns the number of years between the supplied date and today.
     def self.number_of_years_from_today(date)
       years_diff = (Date.today.year - date.year).abs
     end
     
+    # Returns a range of dates for the current week. Starts with Sunday and ends 
+    # on Saturday.
+    #
+    # Examples (if today is 2010-09-03)
+    #
+    #   DateCasually::Calculator.this_week_range.to_s #to_s used for clarity
+    #   #=> "2010-08-29..2010-09-04"
+    #  
+    # Returns a range of dates for the current week.
     def self.this_week_range
       self.this_past_sunday..(self.this_past_sunday + 6)
     end
     
+    # Returns a range of dates for the coming week. Starts with Sunday and ends 
+    # on Saturday.
+    #
+    # Examples (if today is 2010-09-03)
+    #   
+    #   DateCasually::Calculator.next_week_range.to_s #to_s used for clarity
+    #   #=> "2010-09-05..2010-09-11"
+    #  
+    # Returns a range of dates for the coming week.
     def self.next_week_range
       self.next_sunday..(self.next_sunday + 6)
     end
-
+    
+    # Returns a range of dates for the previous week. Starts with Sunday and ends 
+    # on Saturday.
+    #
+    # Examples (if today is 2010-09-03)
+    #   
+    #   DateCasually::Calculator.last_week_range.to_s #to_s used for clarity
+    #   #=> "2010-08-22..2010-08-28"
+    #  
+    # Returns a range of dates for the previous week.
     def self.last_week_range
       self.last_sunday..(self.last_sunday + 6)
     end
     
+    # Returns a range of dates for the coming week. Starts with Sunday and ends 
+    # on Saturday.
+    #
+    # Examples (if today is 2010-09-03)
+    #   
+    #   DateCasually::Calculator.next_week_range.to_s #to_s used for clarity
+    #   #=> "2010-09-05..2010-09-11"
+    #  
+    # Returns a range of dates for the coming week.
     def self.next_sunday
       date = Date.today
       (date.wday == 0) ? (date += 7) : (date += 1 until (date.wday == 0))
       date
     end
     
+    # Returns the date of last week's Sunday.
+    #
+    # Examples (if today is 2010-09-03)
+    #   
+    #   DateCasually::Calculator.last_sunday.to_s #to_s used for clarity
+    #   #=> "2010-08-22"
+    #  
+    # Returns the Date of last week's Sunday.
     def self.last_sunday
       self.this_past_sunday - 7
     end
     
+    # Returns the date of the most recent Sunday in the past.
+    #
+    # Examples (if today is 2010-09-03)
+    #   
+    #   DateCasually::Calculator.this_past_sunday.to_s #to_s used for clarity
+    #   #=> "2010-08-29"
+    #  
+    # Returns the Date of the most recent Sunday in the past.
     def self.this_past_sunday
       date = Date.today
       (date.wday == 0) ? date : (date -= 1 until (date.wday == 0)) 

data/lib/date-casually/config.rb

@@ -1,14 +1,55 @@
 module DateCasually  
-  class Config
+  
+  # Contains global configuration options for DateCasually. These options 
+  # may be changed globally at runtime by using the designated class method. 
+  # For example:
+  #
+  #   DateCasually::Config.as :years
+  #   (Date.today + 2).casual
+  #   #=> "less than a year from now"
+  #
+  module Config
+    
     class << self
+      
+      # Gets and sets a map that tells DateCasually which translation options to use 
+      # when translating the current date. Values should be passed as an array of symbols.
+      # Possible values are :day, :week, :month, :year, :day_of_week. 
+      #
+      # Examples:
+      #
+      #   date = Date.new(2010, 8, 30)
+      #
+      #   (date + 6).casual(:day_of_week)
+      #   #=> 'next week'
+      #
+      #   (date + 1).casual(:months) 
+      #   #=> 'less than a month from now'
+      #
+      #   (date + 660).casual(:months)
+      #   #=> '21 months from now'
+      #
+      #   (date + 660).casual(:months, :years)
+      #   #=> 'a couple of years from now'      
+      #
       attr_accessor :as
     end
     
+    # Resets the classes configuration options back to their defaults. Used
+    # primarily to reset the class configuration options when the module 
+    # gets loaded.
+    #
+    # Example:
+    #
+    #   self.reset
+    #
+    # Returns nothing.
     def self.reset
       self.as = [:days, :weeks, :months, :years]
     end
     
-    #reset the first time we are loaded.
+    # Reset the first time we are loaded.
     self.reset
+    
   end
 end

data/lib/date-casually/{translators → translator}/day_of_week.rb

@@ -1,6 +1,6 @@
 module DateCasually
-  module Translators  
-    class DayOfWeek    
+  module Translator 
+    module DayOfWeek    
     
       # Scopes for translation into day of week
       def self.translate(date)

data/lib/date-casually/{translators → translator}/days.rb

@@ -1,6 +1,6 @@
 module DateCasually
-  module Translators  
-    class Days    
+  module Translator
+    module Days    
     
       # Scopes for translation into days
       def self.translate(date)

data/lib/date-casually/{translators → translator}/months.rb

@@ -1,7 +1,6 @@
 module DateCasually
-  module Translators
-  
-    class Months    
+  module Translator
+    module Months    
       
       # Scopes for translation into months
       def self.translate(date)

data/lib/date-casually/{translators → translator}/weeks.rb

@@ -1,6 +1,6 @@
 module DateCasually
-  module Translators  
-    class Weeks    
+  module Translator 
+    module Weeks    
 
         # Scopes for translation into weeks
         def self.translate(date)

data/lib/date-casually/{translators → translator}/years.rb

@@ -1,6 +1,6 @@
 module DateCasually
-  module Translators  
-    class Years    
+  module Translator
+    module Years    
 
       # Scopes for translation into years
       def self.translate(date)

data/lib/date-casually/translator.rb

@@ -1,14 +1,20 @@
 module DateCasually
   
-  # The Translator class is the core of the date-casually functionality,
-  # translating the supplied date to its casual equivalent. 
-  class Translator
+  # The core of the date-casually functionality, translating the supplied date to 
+  # its casual equivalent. This module is primarily intended to be used from the
+  # DateCasually Date extension class. All methods are module methods and should be called
+  # on the Translator module. 
+  # For example:
+  #
+  #   DateCasually::Translator.number_of_weeks_from_today(Date.today + 28)
+  #   #=> 4
+  #  
+  module Translator
     
     # The possible options and order of the :as toggle
     AS_OPTIONS = [:days, :day_of_week, :weeks, :months, :years]
     
-    # 
-    # This method takes the supplied date and determines how it should be translated 
+    # Public: Takes the supplied date and determines how it should be translated 
     # into its casual equivalent. If the :as option is passed with a valid value,
     # then the date is evaluated against that scope, e.g. :as=>:day_of_week.
     # Otherwise, the Translator iterates through all the available scopes until a
@@ -20,37 +26,72 @@ module DateCasually
     #
     def self.casual(date, options = {})
       
-      # Process in order until we hit a condition that matches
-      # the supplied date.
+      # Loop through the :as options and try to translate the date
+      # for the given options.
       translator = nil
       self.as_options(options).each do |option|
-          translator = self.get_translator(option)
+          translator = self.get_module(option)
           translation = translator.translate(date)
           return translation unless translation.nil?
       end              
       
-      # If no conditions are caught, use our last :as option to create
+      # If no translations are found, use our last translator to create
       # explicit counts. I.e. 470 days ago, 46 months from now, 4 years from now, etc.
       unless translator.nil?
         translation = translator.translate_count(date)      
         return translation unless translation.nil?
       end
       
+      # This should never be encountered. If it is, we've got a bug and want to
+      # be vocal about it.
       raise "[date-casually] No ruleset defined for this date: #{date}"
     end
     
+    # Determines which :as options to use during translation. If no :as option is passed
+    # at runtime, use the definition in the Config module. Since the :as values must occur
+    # in a chronological order (e.g. :days, :weeks, :months), this method ensures the values
+    # are correctly ordered before returning them. It also parses out any values that aren't
+    # found in the AS_OPTIONS constant.
+    #
+    # options - Hashmap of DateCasually options. 
     # 
-    # Process :as option if passed, otherwise use global config
+    # Example:
+    #   options[:as] = :weeks, :days, :years, :months, :foobar
+    #   DateCasually::Translator.as_options(options)
+    #   # => :days, :weeks, :days, :months, :years
+    #
+    # Returns Array of :as configuration options, sorted like the AS_OPTIONS array.
     def self.as_options(options)
       as = []
       as << (!options.nil? && options.has_key?(:as) ? options[:as] : DateCasually::Config.as)
       self::AS_OPTIONS & as.flatten
     end
     
-    def self.get_translator(sym)
-      DateCasually::Translators.const_get(self.camelcase(sym.to_s))
+    # Dynamically returns the translator module that corresponds to the 
+    # supplied symbol. The symbol should correspond to one of those found
+    # in the AS_OPTIONS array, though this is not enforced.
+    #
+    # sym - Symbol that corresponds to the supplied symbol. 
+    # 
+    # Example:
+    #   DateCasually::Translator.get_module(:days)
+    #   # => Days
+    #
+    # Returns Module that corresponds to the supplied symbol
+    def self.get_module(sym)
+      const_get(self.camelcase(sym.to_s))
     end
     
+    # Converts a string to the camel case format, removing any underscores and upcasing
+    # the character that immediately follow them.
+    #
+    # string - String to be converted to camel case. 
+    # 
+    # Example:
+    #   DateCasually::Translator.camelcase("day_of_week")
+    #   # => "DayOfWeek"
+    #
+    # Returns String in the camelcase format
     def self.camelcase(string)
       string.downcase.gsub(/\b[a-z]|_+[a-z]/) { |a| a.upcase }.gsub(/\s|_/,'')
     end

data/lib/date-casually.rb

@@ -3,14 +3,15 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rubygems'
 require 'date'
 require 'i18n'
+
 require "date-casually/config"
 require "date-casually/calculator"
 require "date-casually/translator"
-require "date-casually/translators/days"
-require "date-casually/translators/weeks"
-require "date-casually/translators/months"
-require "date-casually/translators/day_of_week"
-require "date-casually/translators/years"
+require "date-casually/translator/days"
+require "date-casually/translator/weeks"
+require "date-casually/translator/months"
+require "date-casually/translator/day_of_week"
+require "date-casually/translator/years"
 require "extensions/date"
 
 # load up translations

data/lib/extensions/date.rb

@@ -1,4 +1,40 @@
+# The Date class gets monkey-patched (gasp!) to activate DateCasually features
+# via the 'casual' method. 
 class Date
+  
+  # Public: Translates the current date object (self) into its language-based
+  # equivalent.
+  #
+  # options  - List of options to control what the casual method outputs.
+  #            :as - Tells DateCasually which date ranges to use when translating 
+  #                  the current date. Values should be passed an array of symbols.
+  #                  Possible values are :day, :week, :month, :year, :day_of_week.
+  #
+  # Examples
+  #   date = Date.new(2010, 8, 30)
+  #
+  #   (date + 1).casual
+  #   #=> 'tomorrow'
+  #  
+  #   (date - 1).casual
+  #   #=> 'yesterday'
+  #
+  #   (date + 6).casual
+  #   #=> 'next week'
+  #
+  #   (date + 6).casual(:day_of_week)
+  #   #=> 'next week'
+  #
+  #   (date + 1).casual(:months) 
+  #   #=> 'less than a month from now'
+  #
+  #   (date + 660).casual(:months)
+  #   #=> '21 months from now'
+  #
+  #   (date + 660).casual(:months, :years)
+  #   #=> 'a couple of years from now'
+  #
+  # Returns language translation of the current date.
   def casual(options = {})
     DateCasually::Translator.casual(self, options)
   end  

data/lib/locale/en.yml

@@ -1,93 +1,92 @@
-en:
-  date:
-    casual:
-      today: "today"
-      tomorrow: "tomorrow"
-      yesterday: "yesterday"
-      next_week: "next week"
-      last_week: "last week"
-      this_wday_0: "this Sunday"
-      this_wday_1: "this Monday"
-      this_wday_2: "this Tuesday"
-      this_wday_3: "this Wednesday"
-      this_wday_4: "this Thursday"
-      this_wday_5: "this Friday"            
-      this_wday_6: "this Saturday"  
-      this_past_wday_0: "this past Sunday"
-      this_past_wday_1: "this past Monday"
-      this_past_wday_2: "this past Tuesday"
-      this_past_wday_3: "this past Wednesday"
-      this_past_wday_4: "this past Thursday"
-      this_past_wday_5: "this past Friday"            
-      this_past_wday_6: "this past Saturday"  
-      next_wday_0: "next Sunday"
-      next_wday_1: "next Monday"
-      next_wday_2: "next Tuesday"
-      next_wday_3: "next Wednesday"
-      next_wday_4: "next Thursday"
-      next_wday_5: "next Friday"            
-      next_wday_6: "next Saturday"
-      last_wday_0: "last Sunday"
-      last_wday_1: "last Monday"
-      last_wday_2: "last Tuesday"
-      last_wday_3: "last Wednesday"
-      last_wday_4: "last Thursday"
-      last_wday_5: "last Friday"            
-      last_wday_6: "last Saturday"  
-      wdays_from_now_0: "%{number} Sundays from now" 
-      wdays_from_now_1: "%{number} Mondays from now" 
-      wdays_from_now_2: "%{number} Tuesdays from now" 
-      wdays_from_now_3: "%{number} Wednesdays from now"   
-      wdays_from_now_4: "%{number} Thursdays from now"         
-      wdays_from_now_5: "%{number} Fridays from now" 
-      wdays_from_now_6: "%{number} Saturdays from now"
-      wdays_ago_0: "%{number} Sundays ago" 
-      wdays_ago_1: "%{number} Mondays ago" 
-      wdays_ago_2: "%{number} Tuesdays ago" 
-      wdays_ago_3: "%{number} Wednesdays ago"   
-      wdays_ago_4: "%{number} Thursdays ago"         
-      wdays_ago_5: "%{number} Fridays ago" 
-      wdays_ago_6: "%{number} Saturdays ago" 
-      one_day_ago: "one day ago"
-      days_ago: "%{number} days ago"
-      a_week_ago: "a week ago"
-      more_than_a_week_ago: "more than a week ago"
-      weeks_ago: "%{number} weeks ago"
-      exactly_one_month_ago: "exactly one month ago"
-      exactly_one_month_from_now: "exactly one month from now"
-      more_than_a_month_ago: "more than a month ago"
-      less_than_a_month_ago: "less than a month ago"
-      more_than_a_month_from_now: "more than a month from now"
-      less_than_a_month_from_now: "less than a month from now"
-      more_than_a_week_ago: "more than a week ago"
-      less_than_a_week_ago: "less than a week ago"
-      more_than_a_week_from_now: "more than a week from now"
-      less_than_a_week_from_now: "less than a week from now"
-      about_a_week_from_now: "about a week from now"
-      about_a_week_ago: "about a week ago"
-      more_than_a_year_ago: "more than a year ago"
-      less_than_a_year_ago: "less than a year ago"
-      more_than_a_year_from_now: "more than a year from now"
-      less_than_a_year_from_now: "less than a year from now"      
-      months_ago: "%{number} months ago"
-      next_month: "next month"
-      last_month: "last month"
-      a_year_ago: "a year ago"
-      a_year_from_now: "a year from now"
-      years_ago: "%{number} years ago"
-      next_year: "next year"
-      last_year: "last year"
-      days_from_now: "%{number} days from now"
-      weeks_from_now: "%{number} weeks from now"
-      months_from_now: "%{number} months from now"
-      years_from_now: "%{number} years from now"
-      in_a_couple_of_days: "in a couple of days"
-      in_a_couple_of_weeks: "in a couple of weeks"
-      couple_of_months_ago: "a couple of months ago"
-      couple_of_months_from_now: "a couple of months from now"  
-      couple_of_days_from_now: "a couple of days from now"  
-      couple_of_days_ago: "a couple of days ago"  
-      couple_of_weeks_ago: "a couple of weeks ago"  
-      couple_of_weeks_from_now: "a couple of weeks from now"  
-      couple_of_years_ago: "a couple of years ago"
-      couple_of_years_from_now: "a couple of years from now"  
+en: 
+  date: 
+    casual: 
+      a_week_ago: a week ago
+      a_year_ago: a year ago
+      a_year_from_now: a year from now
+      about_a_week_ago: about a week ago
+      about_a_week_from_now: about a week from now
+      couple_of_days_ago: a couple of days ago
+      couple_of_days_from_now: a couple of days from now
+      couple_of_months_ago: a couple of months ago
+      couple_of_months_from_now: a couple of months from now
+      couple_of_weeks_ago: a couple of weeks ago
+      couple_of_weeks_from_now: a couple of weeks from now
+      couple_of_years_ago: a couple of years ago
+      couple_of_years_from_now: a couple of years from now
+      days_ago: %{number} days ago
+      days_from_now: %{number} days from now
+      exactly_one_month_ago: exactly one month ago
+      exactly_one_month_from_now: exactly one month from now
+      in_a_couple_of_days: in a couple of days
+      in_a_couple_of_weeks: in a couple of weeks
+      last_month: last month
+      last_wday_0: last Sunday
+      last_wday_1: last Monday
+      last_wday_2: last Tuesday
+      last_wday_3: last Wednesday
+      last_wday_4: last Thursday
+      last_wday_5: last Friday
+      last_wday_6: last Saturday
+      last_week: last week
+      last_year: last year
+      less_than_a_month_ago: less than a month ago
+      less_than_a_month_from_now: less than a month from now
+      less_than_a_week_ago: less than a week ago
+      less_than_a_week_from_now: less than a week from now
+      less_than_a_year_ago: less than a year ago
+      less_than_a_year_from_now: less than a year from now
+      months_ago: %{number} months ago
+      months_from_now: %{number} months from now
+      more_than_a_month_ago: more than a month ago
+      more_than_a_month_from_now: more than a month from now
+      more_than_a_week_ago: more than a week ago
+      more_than_a_week_from_now: more than a week from now
+      more_than_a_year_ago: more than a year ago
+      more_than_a_year_from_now: more than a year from now
+      next_month: next month
+      next_wday_0: next Sunday
+      next_wday_1: next Monday
+      next_wday_2: next Tuesday
+      next_wday_3: next Wednesday
+      next_wday_4: next Thursday
+      next_wday_5: next Friday
+      next_wday_6: next Saturday
+      next_week: next week
+      next_year: next year
+      one_day_ago: one day ago
+      this_past_wday_0: this past Sunday
+      this_past_wday_1: this past Monday
+      this_past_wday_2: this past Tuesday
+      this_past_wday_3: this past Wednesday
+      this_past_wday_4: this past Thursday
+      this_past_wday_5: this past Friday
+      this_past_wday_6: this past Saturday
+      this_wday_0: this Sunday
+      this_wday_1: this Monday
+      this_wday_2: this Tuesday
+      this_wday_3: this Wednesday
+      this_wday_4: this Thursday
+      this_wday_5: this Friday
+      this_wday_6: this Saturday
+      today: today
+      tomorrow: tomorrow
+      wdays_ago_0: %{number} Sundays ago
+      wdays_ago_1: %{number} Mondays ago
+      wdays_ago_2: %{number} Tuesdays ago
+      wdays_ago_3: %{number} Wednesdays ago
+      wdays_ago_4: %{number} Thursdays ago
+      wdays_ago_5: %{number} Fridays ago
+      wdays_ago_6: %{number} Saturdays ago
+      wdays_from_now_0: %{number} Sundays from now
+      wdays_from_now_1: %{number} Mondays from now
+      wdays_from_now_2: %{number} Tuesdays from now
+      wdays_from_now_3: %{number} Wednesdays from now
+      wdays_from_now_4: %{number} Thursdays from now
+      wdays_from_now_5: %{number} Fridays from now
+      wdays_from_now_6: %{number} Saturdays from now
+      weeks_ago: %{number} weeks ago
+      weeks_from_now: %{number} weeks from now
+      years_ago: %{number} years ago
+      years_from_now: %{number} years from now
+      yesterday: yesterday

data/lib/util/alphabetize_yaml.rb

@@ -1,3 +1,7 @@
+# This file is used to alphabetize the locale YAML files. It doesn't
+# overwrite them, but instead creates sorted copies of them with a 
+# ".sorted" file # extension.
+
 require 'yaml'
 class Hash
   def to_sorted_yaml( opts = {} )
@@ -21,7 +25,7 @@ class Hash
   end
   
 end
-files = Dir.glob(File.join(File.dirname(__FILE__),"*.yml"))
+files = Dir.glob(File.join("..","locale","*.yml"))
 
 files.each do |file|
   hash = YAML::load(File.read(file))

data/test/helper.rb

@@ -12,10 +12,14 @@ t = Time.local(2008, 9, 1, 10, 5, 0)
 Timecop.travel(t)
 
 class Test::Unit::TestCase
+  
+  # Returns a Date object from Chronic's Time object
   def parse(string)
     Date.parse(Chronic.parse(string).strftime('%b %d, %Y'))
   end
-
+  
+  # Convenience method to generate method names for both
+  # the test cases that include the :as option, and those that don't.
   def self.method_name(name, options)
     if (options != nil) && options.has_key?(:as)
       "test_#{name}_as_#{options[:as]}"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: date-casually
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Theo Mills
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-26 00:00:00 -05:00
+date: 2010-09-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -87,14 +87,13 @@ files:
 - lib/date-casually/calculator.rb
 - lib/date-casually/config.rb
 - lib/date-casually/translator.rb
-- lib/date-casually/translators/day_of_week.rb
-- lib/date-casually/translators/days.rb
-- lib/date-casually/translators/months.rb
-- lib/date-casually/translators/weeks.rb
-- lib/date-casually/translators/years.rb
+- lib/date-casually/translator/day_of_week.rb
+- lib/date-casually/translator/days.rb
+- lib/date-casually/translator/months.rb
+- lib/date-casually/translator/weeks.rb
+- lib/date-casually/translator/years.rb
 - lib/extensions/date.rb
 - lib/locale/en.yml
-- lib/locale/en.yml.sorted
 - lib/util/alphabetize_yaml.rb
 - test/helper.rb
 - test/test_calculator.rb
@@ -105,7 +104,6 @@ files:
 - test/test_translator.rb
 - test/test_weeks.rb
 - test/test_years.rb
-- test/timeline.rb
 has_rdoc: true
 homepage: http://github.com/twmills/date-casually
 licenses: []
@@ -150,4 +148,3 @@ test_files:
 - test/test_translator.rb
 - test/test_weeks.rb
 - test/test_years.rb
-- test/timeline.rb

data/lib/locale/en.yml.sorted

@@ -1,85 +0,0 @@
-en: 
-  date: 
-    casual: 
-      a_week_ago: a week ago
-      a_year_ago: a year ago
-      a_year_from_now: a year from now
-      about_a_week_ago: about a week ago
-      about_a_week_from_now: about a week from now
-      couple_of_days_ago: a couple of days ago
-      couple_of_days_from_now: a couple of days from now
-      couple_of_months_ago: a couple of months ago
-      couple_of_months_from_now: a couple of months from now
-      couple_of_weeks_ago: a couple of weeks ago
-      couple_of_weeks_from_now: a couple of weeks from now
-      couple_of_years_ago: a couple of years ago
-      couple_of_years_from_now: a couple of years from now
-      days_ago: {{number}} days ago
-      days_from_now: {{number}} days from now
-      exactly_one_month_ago: exactly one month ago
-      exactly_one_month_from_now: exactly one month from now
-      in_a_couple_of_days: in a couple of days
-      in_a_couple_of_weeks: in a couple of weeks
-      last_month: last month
-      last_wday_0: last Sunday
-      last_wday_1: last Monday
-      last_wday_2: last Tuesday
-      last_wday_3: last Wednesday
-      last_wday_4: last Thursday
-      last_wday_5: last Friday
-      last_wday_6: last Saturday
-      last_week: last week
-      last_year: last year
-      less_than_a_month_ago: less than a month ago
-      less_than_a_month_from_now: less than a month from now
-      less_than_a_week_ago: less than a week ago
-      less_than_a_week_from_now: less than a week from now
-      less_than_a_year_ago: less than a year ago
-      less_than_a_year_from_now: less than a year from now
-      months_ago: {{number}} months ago
-      months_from_now: {{number}} months from now
-      more_than_a_month_ago: more than a month ago
-      more_than_a_month_from_now: more than a month from now
-      more_than_a_week_ago: more than a week ago
-      more_than_a_week_from_now: more than a week from now
-      more_than_a_year_ago: more than a year ago
-      more_than_a_year_from_now: more than a year from now
-      next_month: next month
-      next_wday_0: next Sunday
-      next_wday_1: next Monday
-      next_wday_2: next Tuesday
-      next_wday_3: next Wednesday
-      next_wday_4: next Thursday
-      next_wday_5: next Friday
-      next_wday_6: next Saturday
-      next_week: next week
-      next_year: next year
-      one_day_ago: one day ago
-      this_past_wday_0: this past Sunday
-      this_past_wday_1: this past Monday
-      this_past_wday_2: this past Tuesday
-      this_past_wday_3: this past Wednesday
-      this_past_wday_4: this past Thursday
-      this_past_wday_5: this past Friday
-      this_past_wday_6: this past Saturday
-      this_wday_0: this Sunday
-      this_wday_1: this Monday
-      this_wday_2: this Tuesday
-      this_wday_3: this Wednesday
-      this_wday_4: this Thursday
-      this_wday_5: this Friday
-      this_wday_6: this Saturday
-      today: today
-      tomorrow: tomorrow
-      wdays_ago_0: {{number}} Sundays ago
-      wdays_ago_1: {{number}} Mondays ago
-      wdays_ago_2: {{number}} Tuesdays ago
-      wdays_ago_3: {{number}} Wednesdays ago
-      wdays_ago_4: {{number}} Thursdays ago
-      wdays_ago_5: {{number}} Fridays ago
-      wdays_ago_6: {{number}} Saturdays ago
-      weeks_ago: {{number}} weeks ago
-      weeks_from_now: {{number}} weeks from now
-      years_ago: {{number}} years ago
-      years_from_now: {{number}} years from now
-      yesterday: yesterday

data/test/timeline.rb

@@ -1,11 +0,0 @@
-require 'helper'
-# max = 400
-# as = :week
-# max.downto(1).each do |x|
-#   puts "+#{(Date.today + x).to_s} = #{(Date.today + x).casual(:as => as)}"
-# end
-# 1.upto(max).each do |x|
-#   puts "-#{(Date.today - x).to_s} = #{(Date.today - x).casual(:as => as)}"
-# end
-DateCasually::Config.as = :months
-puts (Date.today + 1).casual