shire 0.0.1 → 0.1.0

data/CHANGELOG

@@ -0,0 +1,9 @@
+= Shire Changelog
+
+== Version 0.1.0
+
+* Added the shire command.
+
+== Version 0.0.1
+
+* Added extensions for the Time and Date classes.

data/README

@@ -4,6 +4,13 @@ Shire extends the Time and Date classes for hobbits.
 
 Shire is based on Tom Braun's DateTime::Fiction::JRRTolkien::Shire[http://search.cpan.org/~tbraun/DateTime-Fiction-JRRTolkien-Shire-0.02/] Perl module and is implemented in Ruby in the style of the ActiveSupport[http://rubyforge.org/projects/activesupport] core extensions.
 
+The methods that hobbits will find useful are listed in Shire::CoreExtensions::Time::Calculations.
+
+The <code>shire</code> command prints today's date:
+
+  % shire
+  Sunday 26 Foreyule 7470
+
 
 == Download
 
@@ -22,7 +29,7 @@ The preferred method of installing Shire is through its GEM file. You'll need to
 RubyGems[http://rubygems.rubyforge.org/wiki/wiki.pl] installed for that, though. If you have it,
 then use:
 
-  % [sudo] gem install shire-0.0.1.gem
+  % [sudo] gem install shire-0.1.0.gem
 
 
 == Time Example

data/bin/shire

@@ -0,0 +1,7 @@
+begin
+  require 'shire'
+rescue LoadError
+  require 'rubygems'
+  require 'shire'
+end
+puts Time.now.shire_on_date

data/lib/shire/core_ext/date.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/time/calculations'
 require File.dirname(__FILE__) + '/time/constants'
 
-class Date
+class Date #:nodoc:
   include Shire::CoreExtensions::Time::Constants
   include Shire::CoreExtensions::Time::Calculations
 end

data/lib/shire/core_ext/time.rb

@@ -1,7 +1,7 @@
 require File.dirname(__FILE__) + '/time/calculations'
 require File.dirname(__FILE__) + '/time/constants'
 
-class Time
+class Time #:nodoc:
   include Shire::CoreExtensions::Time::Constants
   include Shire::CoreExtensions::Time::Calculations
 end

data/lib/shire/core_ext/time/calculations.rb

@@ -1,87 +1,93 @@
-module Shire
-  module CoreExtensions
-    module Time
-      module Calculations   
+module Shire #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Time #:nodoc:
+      # Date calculations for hobbits.
+      module Calculations        
+        def self.method_added(method) #:nodoc:
+          return unless method.to_s =~ /^shire/
+          wrap_shire_method(method)
+        end
+        
+        def self.wrap_shire_method(method) #:nodoc:
+          wrapped_method = "wrapped_#{method}"
+          return if instance_methods.include? wrapped_method
+          alias_method wrapped_method, method
+          module_eval %{
+            def #{method}(*args)
+              calculate_shire
+              #{wrapped_method}(*args)
+            end
+          }
+          private wrapped_method 
+        end
+        
         # Returns the year.
         def shire_year
-          calculate_shire
           @shire_year
         end
         
         # Returns the day of the year.
         def shire_yday
-          calculate_shire
           @shire_yday    
         end
         
         # Returns whether the year is a leap year. 
         def shire_leap_year?
-          calculate_shire 
-          @shire_leap_year
+         @shire_leap_year
         end
         
-        # Returns the holiday day number or nil if the date is not a holiday.
+        # Returns the holiday number or nil if the date is not a holiday.
         def shire_holiday
-          calculate_shire 
           @shire_holiday
         end
         
         # Returns whether the date is a holiday.
         def shire_holiday?
-          calculate_shire 
           @shire_holiday != nil
         end
         
         # Returns the name of the holiday or nil if the date is not a holiday.
         def shire_holiday_name
-          calculate_shire 
           Constants::SHIRE_HOLIDAY_NAMES[shire_holiday] if shire_holiday?
         end
         
         # Returns the number of the day of the week or nil if not a day of the week.
         def shire_wday
-          calculate_shire 
           @shire_wday
         end
         
         # Returns whether the date is a day of the week.
         def shire_wday?
-          calculate_shire 
           @shire_wday != nil
         end
         
         # Returns the month number.
         def shire_month
-          calculate_shire 
           @shire_month    
         end
         
         # Returns the day of the month.
         def shire_day
-          calculate_shire 
           @shire_day    
         end
         
         # Returns the name of the day of the week or nil if not a day of the week.
         def shire_day_name
-          calculate_shire 
         	Constants::SHIRE_DAY_NAMES[shire_wday] if shire_wday
         end
         
         # Returns the traditional name of the day of the week or nil if not a day of the week.
         def shire_traditional_day_name
-          calculate_shire 
           Constants::SHIRE_TRADITIONAL_DAY_NAMES[shire_wday] if shire_wday
         end
         
         # Returns the name of the month or nil if not a day of a month.
         def shire_month_name
-          calculate_shire 
           Constants::SHIRE_MONTH_NAMES[shire_month]
         end
         
+        # Returns any events that occurred on this date. 
         def shire_events
-          calculate_shire
           if shire_holiday?
             Constants::SHIRE_EVENTS[0][shire_holiday]
           else
@@ -89,14 +95,13 @@ module Shire
           end          
         end
         
+        # Returns whether any events occurred on this date.
         def shire_events?
-          calculate_shire
           shire_events != nil
         end
         
         # Returns the date and any events that occurred on that date.
         def shire_on_date
-          calculate_shire 
           if shire_events?
             "#{shire_to_s}\n\n#{shire_events}"
           else
@@ -106,7 +111,6 @@ module Shire
         
         # Returns the date.
         def shire_to_s
-          calculate_shire
           if shire_holiday?
             if shire_wday?
               "#{shire_day_name} #{shire_holiday_name} #{shire_year}"

data/lib/shire/core_ext/time/constants.rb

@@ -1,12 +1,12 @@
-module Shire
-  module CoreExtensions
-    module Time
+module Shire #:nodoc:
+  module CoreExtensions #:nodoc:
+    module Time #:nodoc:
+      # Date constants for hobbits.
       module Constants
-        SHIRE_DAY_NAMES = ['Sterday', 'Sunday', 'Monday', 'Trewsday', 'Hevensday', 'Mersday', 'Highday']
-        SHIRE_TRADITIONAL_DAY_NAMES = ['Sterrendei', 'Sunnendei', 'Monendei', 'Trewesdei', 'Hevenesdei', 'Meresdei', 'Highdei']
-        SHIRE_MONTH_NAMES = [nil, 'Afteryule', 'Solmath', 'Rethe', 'Astron', 
-          'Thrimidge', 'Forelithe', 'Afterlithe', 'Wedmath', 'Halimath', 'Winterfilth', 'Blotmath', 'Foreyule']
-        SHIRE_HOLIDAY_NAMES = [nil, '2 Yule', '1 Lithe', "Midyear's day", 'Overlithe', '2 Lithe', '1 Yule']
+        SHIRE_DAY_NAMES = %w(Sterday Sunday Monday Trewsday Hevensday Mersday Highday)
+        SHIRE_TRADITIONAL_DAY_NAMES = %w(Sterrendei Sunnendei Monendei Trewesdei Hevenesdei Meresdei Highdei)
+        SHIRE_MONTH_NAMES = [nil] + %w(Afteryule Solmath Rethe Astron Thrimidge Forelithe Afterlithe Wedmath Halimath Winterfilth Blotmath Foreyule)
+        SHIRE_HOLIDAY_NAMES = [nil] + ['2 Yule', '1 Lithe', "Midyear's day", 'Overlithe', '2 Lithe', '1 Yule']
         SHIRE_EVENTS = {
           0 => {
             3 => "Wedding of King Elessar and Arwen, 1419.\n"

data/lib/shire/version.rb

@@ -1,8 +1,8 @@
-module Shire
-  module VERSION
+module Shire #:nodoc:
+  module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
-    TINY = 1
+    MINOR = 1
+    TINY = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: shire
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
-date: 2006-12-07 00:00:00 +00:00
+  version: 0.1.0
+date: 2006-12-17 00:00:00 +00:00
 summary: Shire time.
 require_paths: 
 - lib
@@ -36,20 +36,20 @@ files:
 - lib/shire/core_ext
 - lib/shire/core_ext.rb
 - lib/shire/version.rb
-- lib/shire/core_ext/date
 - lib/shire/core_ext/date.rb
 - lib/shire/core_ext/time
 - lib/shire/core_ext/time.rb
 - lib/shire/core_ext/time/calculations.rb
 - lib/shire/core_ext/time/constants.rb
+- bin/shire
 test_files: []
 
 rdoc_options: []
 
 extra_rdoc_files: []
 
-executables: []
-
+executables: 
+- shire
 extensions: []
 
 requirements: []