shire 0.0.1

data/LICENSE

@@ -0,0 +1,15 @@
+Copyright (C) 2006  Stephen Arneil
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

data/README

@@ -0,0 +1,58 @@
+= Shire -- Time and Date extensions for hobbits
+
+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.
+
+
+== Download
+
+The latest version of Shire can be found at
+
+* http://rubyforge.org/frs/?group_id=2703
+
+The project home page can be found at 
+
+* http://shire.rubyforge.org
+
+
+== Installation
+
+The preferred method of installing Shire is through its GEM file. You'll need to have
+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
+
+
+== Time Example
+
+  require 'shire'
+  
+  time = Time.utc 2006, 12, 21
+  puts time.shire_on_date
+
+  # Mersday 30 Foreyule 7470
+
+
+== Date Example
+  
+  require 'date'
+  require 'shire'
+
+  date = Date.civil 2007, 9, 27
+  puts date.shire_on_date
+
+  # Hevensday 5 Winterfilth 7471
+  #
+  # Gandalf and the Hobbits leave Rivendell, 1419.
+
+
+== License
+
+Shire is released under the GPL license.
+
+
+== Support
+
+You can find the Shire RubyForge page at http://rubyforge.org/projects/shire.

data/lib/shire/core_ext/date.rb

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

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

@@ -0,0 +1,206 @@
+module Shire
+  module CoreExtensions
+    module Time
+      module Calculations   
+        # 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
+        end
+        
+        # Returns the holiday day 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
+        
+        def shire_events
+          calculate_shire
+          if shire_holiday?
+            Constants::SHIRE_EVENTS[0][shire_holiday]
+          else
+            Constants::SHIRE_EVENTS[shire_month][shire_day]
+          end          
+        end
+        
+        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
+            "#{shire_to_s}\n"
+          end
+        end
+        
+        # Returns the date.
+        def shire_to_s
+          calculate_shire
+          if shire_holiday?
+            if shire_wday?
+              "#{shire_day_name} #{shire_holiday_name} #{shire_year}"
+            else
+              "#{shire_holiday_name} #{shire_year}"
+            end
+          else
+        	  "#{shire_day_name} #{shire_day} #{shire_month_name} #{shire_year}"
+        	end
+        end
+        
+        private
+        
+        def calculate_shire
+          return if self.instance_variables.include? '@shire_calculated'
+          @shire_year = year + 5464
+          @shire_yday = yday + 9      
+          calculate_year_adjustments                
+          calculate_year_yday_and_leap_year
+          calculate_holiday
+          calculate_shire_wday
+          calculate_month_and_day
+          @shire_calculated = true
+        end
+        
+        def calculate_year_adjustments
+          modyear = @shire_year % 400
+          if (modyear > 300) && (modyear < 364): @shire_yday += 1
+          elsif modyear == 364: @shire_yday += 1
+          elsif ((modyear > 64) && (modyear < 100)) || ((modyear > 164) && (modyear < 200)): @shire_yday -= 1
+          elsif (modyear == 100) || (modyear == 200): @shire_yday -= 1
+          end
+        end
+        
+        def calculate_year_yday_and_leap_year
+          calculate_leap_year          
+          if @shire_leap_year && @shire_yday > 366
+            @shire_year += 1
+            @shire_yday -= 366
+            @shire_leap_year = false
+          elsif !@shire_leap_year && @shire_yday > 365
+            @shire_year += 1
+            @shire_yday -= 365
+            calculate_leap_year
+          end
+        end
+        
+        def calculate_leap_year
+          @shire_leap_year = false
+          @shire_leap_year = true if (@shire_year % 4 == 0) && (@shire_year % 100 != 0)
+          @shire_leap_year = true if @shire_year % 400 == 0
+        end
+        
+        def calculate_holiday
+          @shire_holiday = nil
+          @shire_yday_365 = @shire_yday
+          if @shire_leap_year
+            @shire_holiday = 4 if @shire_yday == 184
+            @shire_yday_365 -= 1 if @shire_yday > 184
+          end
+          unless @shire_holiday
+            case @shire_yday_365
+            when 1: @shire_holiday = 1
+            when 182: @shire_holiday = 2
+            when 183: @shire_holiday = 3
+            when 184: @shire_holiday = 5
+            when 365: @shire_holiday = 6
+            end   
+          end        
+        end
+        
+        def calculate_shire_wday
+          @shire_yday_364 = @shire_yday_365
+          @shire_yday_364 -= 1 if @shire_yday_364 > 183
+          if @shire_holiday == 3 || @shire_holiday == 4
+            @shire_wday = nil
+          else
+            @shire_wday = (@shire_yday_364 - 1) % 7
+          end
+        end
+          
+        def calculate_month_and_day
+          if @shire_holiday
+            @shire_month = nil
+            @shire_day = nil
+          else
+            @shire_yday_360 = @shire_yday_364
+            @shire_yday_360 -= 1
+            @shire_yday_360 -= 2 if @shire_yday_360 > 180
+            @shire_month = ((@shire_yday_360 - 1) / 30) + 1 
+            @shire_day = ((@shire_yday_360 - 1) % 30) + 1
+          end
+        end
+      end
+    end
+  end      
+end

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

@@ -0,0 +1,169 @@
+module Shire
+  module CoreExtensions
+    module Time
+      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_EVENTS = {
+          0 => {
+            3 => "Wedding of King Elessar and Arwen, 1419.\n"
+          },
+          1 => { 
+            8  => "The Company of the Ring reaches Holland, 1419.\n",
+      	    13 => "The Company of the Ring reaches the West-gate of Moria at nightfall, 1419.\n",
+      	    14 => "The Company of the Ring spends the night in Moria hall 21, 1419.\n",
+      	    15 => "The Bridge of Khazad-dum, and the fall of Gandalf, 1419.\n",
+      	    17 => "The Company of the Ring comes to Caras Galadhon at evening, 1419.\n",
+      	    23 => "Gandalf pursues the Balrog to the peak of Zirakzigil, 1419.\n",
+      	    25 => "Gandalf casts down the Balrog, and passes away.\n" +
+      	      "His body lies on the peak of Zirakzigil, 1419.\n"
+      	  },
+          2 => {
+            14 => "Frodo and Sam look in the Mirror of Galadriel, 1419.\n" +
+      	      "Gandalf returns to life, and lies in a trance, 1419.\n",
+      	    16 => "Company of the Ring says farewell to Lorien --\n" +
+      	      "Gollum observes departure, 1419.\n",
+      	    17 => "Gwaihir the eagle bears Gandalf to Lorien, 1419.\n",
+      	    25 => "The Company of the Ring pass the Argonath and camp at Parth Galen, 1419.\n" +
+      	      "First battle of the Fords of Isen -- Theodred son of Theoden slain, 1419.\n",
+      	    26 => "Breaking of the Fellowship, 1419.\n" +
+      	      "Death of Boromir; his horn is heard in Minas Tirith, 1419.\n" +
+      	      "Meriadoc and Peregrin captured by Orcs -- Aragorn pursues, 1419.\n" +
+      	      "Eomer hears of the descent of the Orc-band from Emyn Muil, 1419.\n" +
+      	      "Frodo and Samwise enter the eastern Emyn Muil, 1419.\n",
+      	    27 => "Aragorn reaches the west-cliff at sunrise, 1419.\n" +
+      	      "Eomer sets out Eastfold against Theoden's orders to pursue the Orcs, 1419.\n",
+      	    28 => "Eomer overtakes the Orcs just outside of Fangorn Forest, 1419.\n",
+      	    29 => "Meriodoc and Pippin escape and meet Treebeard, 1419.\n" +
+      	      "The Rohirrim attack at sunrise and destroy the Orcs, 1419.\n" +
+      	      "Frodo descends from the Emyn Muil and meets Gollum, 1419.\n" +
+      	      "Faramir sees the funeral boat of Boromir, 1419.\n",
+      	    30 => "Entmoot begins, 1419.\n" +
+      	      "Eomer, returning to Edoras, meets Aragorn, 1419.\n"
+      	  },
+          3 => { 
+            1 => "Aragorn meets Gandalf the White, and they set out for Edoras, 1419.\n" +
+      	      "Faramir leaves Minas Tirith on an errand to Ithilien, 1419.\n",
+      	    2 => "The Rohirrim ride west against Saruman, 1419.\n" +
+      	      "Second battle at the Fords of Isen; Erkenbrand defeated, 1419.\n" +
+      	      "Entmoot ends.  Ents march on Isengard and reach it at night, 1419.\n",
+      	    3 => "Theoden retreats to Helm's Deep; battle of the Hornburg begins, 1419.\n" +
+      	      "Ents complete the destruction of Isengard.\n",
+      	    4 => "Theoden and Gandalf set out from Helm's Deep for Isengard, 1419.\n" +
+      	      "Frodo reaches the slag mound on the edge of the of the Morannon, 1419.\n",
+      	    5 => "Theoden reaches Isengard at noon; parley with Saruman in Orthanc, 1419.\n" +
+      	      "Gandalf sets out with Peregrin for Minas Tirith, 1419.\n",
+      	    6 => "Aragorn overtaken by the Dunedain in the early hours, 1419.\n", 
+      	    7 => "Frodo taken by Faramir to Henneth Annun, 1419.\n" +
+      	      "Aragorn comes to Dunharrow at nightfall, 1419.\n", 
+      	    8 => "Aragorn takes the \"Paths of the Dead\", and reaches Erech at midnight, 1419.\n"+
+      	      "Frodo leaves Henneth Annun, 1419.\n",
+      	    9 => "Gandalf reaches Minas Tirith, 1419.\n" +
+      	      "Darkness begins to flow out of Mordor, 1419.\n",
+      	    10 => "The Dawnless Day, 1419.\n" +
+      	      "The Rohirrim are mustered and ride from Harrowdale, 1419.\n" +
+      	      "Faramir rescued by Gandalf at the gates of Minas Tirith, 1419.\n" +
+      	      "An army from the Morannon takes Cair Andros and passes in Anorien, 1419.\n",
+      	    11 => "Gollum visits Shelob, 1419.\n" +
+      	      "Denethor sends Faramir to Osgiliath, 1419.\n" +
+      	      "Eastern Rohan is invaded and Lorien assaulted, 1419.\n",
+      	    12 => "Gollum leads Frodo in Shelob's lair, 1419.\n" +
+      	      "Ents defeat the invaders of Rohan, 1419.\n",
+      	    13 => "Frodo captured by the Orcs of Cirith Ungol, 1419.\n" +
+      	      "The Pelennor is overrun and Faramir is wounded, 1419.\n" +
+      	      "Aragorn reaches Pelargir and captures the fleet of Umbar, 1419.\n",
+      	    14 => "Samwise finds Frodo in the tower of Cirith Ungol, 1419.\n" +
+      	      "Minas Tirith besieged, 1419.\n",
+      	    15 => "Witch King breaks the gates of Minas Tirith, 1419.\n" +
+      	      "Denethor, Steward of Gondor, burns himself on a pyre, 1419.\n" +
+      	      "The battle of the Pelennor occurs as Theoden and Aragorn arrive, 1419.\n" +
+      	      "Thranduil repels the forces of Dol Guldur in Mirkwood, 1419.\n" +
+      	      "Lorien assaulted for second time, 1419.\n",
+      	    17 => "Battle of Dale, where King Brand and King Dain Ironfoot fall, 1419.\n" +
+      	      "Shagrat brings Frodo's cloak, mail-shirt, and sword to Barad-dur, 1419.\n",
+      	    18 => "Host of the west leaves Minas Tirith, 1419.\n" +
+      	      "Frodo and Sam overtaken by Orcs on the road from Durthang to Udun, 1419.\n",
+      	    19 => "Frodo and Sam escape the Orcs and start on the road toward Mount Doom, 1419.\n",
+      	    22 => "Lorien assaulted for the third time, 1419.\n",
+      	    24 => "Frodo and Sam reach the base of Mount Doom, 1419.\n",
+      	    25 => "Battle of the Host of the West on the slag hill of the Morannon, 1419.\n" +
+      	      "Gollum siezes the Ring of Power and falls into the Cracks of Doom, 1419.\n" +
+      	      "Downfall of Barad-dur and the passing of Sauron!, 1419.\n" +
+      	      "Birth of Elanor the Fair, daughter of Samwise, 1421.\n" +
+      	      "Fourth age begins in the reckoning of Gondor, 1421.\n",
+      	    27 => "Bard II and Thorin III Stonehelm drive the enemy from Dale, 1419.\n",
+      	    28 => "Celeborn crosses the Anduin and begins destruction of Dol Guldur, 1419.\n"
+          },
+          4 => {
+            6 => "The mallorn trea flowers in the party field, 1420.\n",
+            8 => "Ring bearers are honored on the fields of Cormallen, 1419.\n",
+            12 => "Gandalf arrives in Hobbiton, 1418\n"
+          },
+          5 => { 
+            1 => "Crowning of King Elessar, 1419.\n" +
+      	    "Samwise marries Rose, 1420.\n"
+      	  },
+          6 => { 
+            20 => "Sauron attacks Osgiliath, 1418.\n" +
+      	    "Thranduil is attacked, and Gollum escapes, 1418.\n"
+      	  },
+          7 => { 
+            4 => "Boromir sets out from Minas Tirith, 1418\n",
+      	    10 => "Gandalf imprisoned in Orthanc, 1418\n",
+      	    19 => "Funeral Escort of King Theoden leaves Minas Tirith, 1419.\n"
+      	  },
+          8 => { 
+            10 => "Funeral of King Theoden, 1419.\n"
+      	  },
+          9 => { 
+            18 => "Gandalf escapes from Orthanc in the early hours, 1418.\n",
+      	    19 => "Gandalf comes to Edoras as a beggar, and is refused admintance, 1418",
+      	    20 => "Gandalf gains entrance to Edoras.  Theoden commands him to go:\n" +
+      	      "\"Take any horse, only be gone ere tomorrow is old\", 1418.\n",
+      	    21 => "The hobbits return to Rivendell, 1419.\n",
+      	    22 => "Birthday of Bilbo and Frodo.\n" +
+      	      "The Black Riders reach Sarn Ford at evening;\n" +
+      	      "  they drive off the guard of Rangers, 1418.\n" +
+      	      "Saruman comes to the Shire, 1419.\n",   
+      	    23 => "Four Black Riders enter the shire before dawn.  The others pursue \n" +
+      	      "the Rangers eastword and then return to watch the Greenway, 1418.\n" +
+      	      "A Black Rider comes to Hobbiton at nightfall, 1418.\n" +
+      	      "Frodo leaves Bag End, 1418.\n" +
+      	      "Gandalf having tamed Shadowfax rides from Rohan, 1418.\n",
+      	    26 => "Frodo comes to Bombadil, 1418\n",
+      	    28 => "The Hobbits are captured by a barrow-wight, 1418.\n",
+      	    29 => "Frodo reaches Bree at night, 1418.\n" +
+      	      "Frodo and Bilbo depart over the sea with the three Keepers, 1421.\n" +
+      	      "End of the Third Age, 1421.\n",
+      	    30 => "Crickhollow and the inn at Bree are raided in the early hours, 1418.\n" +
+      	      "Frodo leaves Bree, 1418.\n",
+          },
+          10 => { 
+            3 => "Gandalf attacked at night on Weathertop, 1418.\n",
+      	    5 => "Gandalf and the Hobbits leave Rivendell, 1419.\n",
+      	    6 => "The camp under weathertop is attacked at night and Frodo is wounded, 1418.\n",
+      	    11 => "Glorfindel drives the Black Riders off the Bridge of Mitheithel, 1418.\n",
+      	    13 => "Frodo crosses the Bridge of Mitheithel, 1418.\n",
+      	    18 => "Glorfindel finds Frodo at dusk, 1418.\n" +
+      		    "Gandalf reaches Rivendell, 1418.\n",
+      	    20 => "Escape across the Ford of Bruinen, 1418.\n",
+      	    24 => "Frodo recovers and wakes, 1418.\n" +
+      		    "Boromir arrives at Rivendell at night, 1418.\n",
+      	    25 => "Council of Elrond, 1418.\n",
+      	    30 => "The four Hobbits arrive at the Brandywine Bridge in the dark, 1419.\n"
+      	  }, 
+          11 => { 
+            3 => "Battle of Bywater and passing of Saruman, 1419.\n" +
+      		    "End of the War of the Ring, 1419.\n"
+      	  },
+          12 => { 
+            25 => "The Company of the Ring leaves Rivendell at dusk.\n"
+      	  }
+        }
+      end
+    end
+  end      
+end

data/lib/shire/core_ext/time.rb

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

data/lib/shire/core_ext.rb

@@ -0,0 +1 @@
+Dir[File.dirname(__FILE__) + "/core_ext/*.rb"].each { |file| require(file) }

data/lib/shire/version.rb

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

data/lib/shire.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'shire/core_ext'

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+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
+summary: Shire time.
+require_paths: 
+- lib
+email: stephen@arneil.com
+homepage: http://shire.rubyforge.org
+rubyforge_project: shire
+description: Time and Date extensions for hobbits
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Stephen Arneil
+files: 
+- CHANGELOG
+- README
+- LICENSE
+- lib/shire
+- lib/shire.rb
+- 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
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+