hebrew_date 1.0.2 → 1.0.3

data/doc/top-level-namespace.html

@@ -105,7 +105,7 @@
 </div>
 
     <div id="footer">
-  Generated on Thu Jan 16 19:44:44 2014 by
+  Generated on Sun Jan 26 12:16:13 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.7.3 (ruby-2.0.0).
 </div>

data/hebrew_date.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
   s.name         = 'hebrew_date'
   s.require_paths = %w(. lib)
-  s.version      = '1.0.2'
-  s.date         = '2014-01-21'
+  s.version      = '1.0.3'
+  s.date         = '2014-01-26'
   s.summary      = 'Hebrew/Jewish dates, times, and holidays.'
   s.description  = <<-EOF
    hebrew_date is a library designed to provide information about the Jewish

data/lib/hebrew_date.rb

@@ -12,8 +12,9 @@ require_relative 'support/parshiot.rb'
 # simultaneously. Note that you may call any Date methods on this class
 # and it should respond accordingly.
 class HebrewDate < Delegator
-  include HebrewDateSupport::Parshiot
-  include HebrewDateSupport::Holidays
+  include HebrewDateSupport::ParshaMethods
+  include HebrewDateSupport::HolidayMethods
+  # @!parse extend HebrewDateSupport::HolidayMethods::ClassMethods
 
   # @private
   HEBREW_EPOCH = -1373429
@@ -78,7 +79,23 @@ class HebrewDate < Delegator
 
   # @private
   def inspect
-    strftime('*Y *-m *-d')
+    strftime('*Y-*-m-*-d (%Y-%-m-%-d)')
+  end
+
+  # Add the dates specified (in days).
+  # @param [Fixnum] other_date the days to add.
+  # @return [HebrewDate]
+  def +(other_date)
+    date = self.to_date + other_date
+    HebrewDate.new(date.year, date.month, date.day)
+  end
+
+  # Subtract the dates specified (in days).
+  # @param [Fixnum] other_date the days to subtract.
+  # @return [HebrewDate]
+  def -(other_date)
+    date = self.to_date - other_date
+    HebrewDate.new(date.year, date.month, date.day)
   end
 
   # @private
@@ -167,7 +184,7 @@ class HebrewDate < Delegator
   end
 
   # Move forward one day.
-  # @return [void]
+  # @return [HebrewDate] the same HebrewDate object again, for chaining.
   def forward
     # Change Gregorian date
     if @date == last_day_of_month
@@ -207,10 +224,12 @@ class HebrewDate < Delegator
 
     # increment the absolute date
     @abs_date += 1
+
+    self
   end
 
   # Move back one day.
-  # @return [void]
+  # @return [HebrewDate] the same HebrewDate object again, for chaining.
   def back
     # Change Gregorian date
     if @date == 1
@@ -244,6 +263,8 @@ class HebrewDate < Delegator
 
     # Change the absolute date
     @abs_date -= 1
+
+    self
   end
 
   # Get the name of the current Hebrew month.
@@ -278,18 +299,19 @@ class HebrewDate < Delegator
   # @param format [String]
   # @return [String]
   def strftime(format)
-    format.gsub!('*Y', @hebrew_year.to_s)
-      .gsub!('*m', @hebrew_month.to_s.rjust(2, '0'))
-      .gsub!('*_m', @hebrew_month.to_s.rjust(2, ' '))
-      .gsub!('*-m', @hebrew_month.to_s)
-      .gsub!('*B', hebrew_month_to_s)
-      .gsub!('*^B', hebrew_month_to_s.upcase)
-      .gsub!('*b', hebrew_month_to_s[0, 3])
-      .gsub!('*^b', hebrew_month_to_s[0, 3].upcase)
-      .gsub!('*h', hebrew_month_to_s[0, 3])
-      .gsub!('*d', @hebrew_date.to_s.rjust(2, '0'))
-      .gsub!('*-d', @hebrew_date.to_s)
-      .gsub!('*e', @hebrew_date.to_s.rjust(2, ' '))
+    format = format.gsub('*Y', @hebrew_year.to_s)
+      .gsub('*m', @hebrew_month.to_s.rjust(2, '0'))
+      .gsub('*_m', @hebrew_month.to_s.rjust(2, ' '))
+      .gsub('*-m', @hebrew_month.to_s)
+      .gsub('*B', hebrew_month_to_s)
+      .gsub('*^B', hebrew_month_to_s.upcase)
+      .gsub('*b', hebrew_month_to_s[0, 3])
+      .gsub('*^b', hebrew_month_to_s[0, 3].upcase)
+      .gsub('*h', hebrew_month_to_s[0, 3])
+      .gsub('*d', @hebrew_date.to_s.rjust(2, '0'))
+      .gsub('*-d', @hebrew_date.to_s)
+      .gsub('*e', @hebrew_date.to_s.rjust(2, ' '))
+    super(format)
   end
 
   # Get the day of the week.
@@ -318,18 +340,33 @@ class HebrewDate < Delegator
     end
   end
 
-  # Is this a Hebrew leap year?
-  # @param year [Integer] Used internally.
-  # @return [Boolean]
-  def hebrew_leap_year?(year=nil)
-    year ||= @hebrew_year
-    (((7 * year) + 1).remainder(19)) < 7
+  class << self
+    # Is this a Hebrew leap year?
+    # @param year [Integer] the Hebrew year.
+    # @return [Boolean]
+    def hebrew_leap_year?(year)
+      (((7 * year) + 1).remainder(19)) < 7
+    end
+
+    # The last month in the Hebrew year (12 or 13).
+    # @param year [Integer] the Hebrew year.
+    # @return [Integer]
+    def last_month_of_hebrew_year(year)
+      hebrew_leap_year?(year) ? 13 : 12
+    end
+
   end
 
   # The last month in this Hebrew year (12 or 13).
   # @return [Integer]
   def last_month_of_hebrew_year
-    hebrew_leap_year? ? 13 : 12
+    self.class.last_month_of_hebrew_year(@hebrew_year)
+  end
+
+  # Is this a Hebrew leap year?
+  # @return [Boolean]
+  def hebrew_leap_year?
+    self.class.hebrew_leap_year?(@hebrew_year)
   end
 
   # Last day of the current Hebrew month.
@@ -407,10 +444,10 @@ class HebrewDate < Delegator
 		if (conjunction_parts >= 19440) || # If new moon is at or after midday,
 			(((conjunction_day.remainder(7)) == 2) &&	    # ...or is on a Tuesday...
 				(conjunction_parts >= 9924) &&	# at 9 hours, 204 parts or later...
-				!hebrew_leap_year?(year)) ||  # ...of a common year,
+				!HebrewDate.hebrew_leap_year?(year)) ||  # ...of a common year,
 			(((conjunction_day.remainder(7)) == 1) &&	 # ...or is on a Monday at...
 				(conjunction_parts >= 16789) && # 15 hours, 589 parts or later...
-				(hebrew_leap_year?(year - 1))) # at the end of a leap year
+				(HebrewDate.hebrew_leap_year?(year - 1))) # at the end of a leap year
 			# Then postpone Rosh HaShanah one day
 			alternative_day += 1
     end

data/lib/support/holidays.rb

@@ -1,5 +1,136 @@
 module HebrewDateSupport
-  module Holidays
+  module HolidayMethods
+    module ClassMethods
+
+      # A list of holidays which can be passed into the from_holiday method.
+      HOLIDAYS = [
+        :EREV_PESACH,
+        :PESACH,
+        :PESACH_2,
+        :PESACH_SHENI,
+        :YOM_HAATZMAUT,
+        :YOM_HAZIKARON,
+        :YOM_YERUSHALAYIM,
+        :LAG_BAOMER,
+        :EREV_SHAVUOT,
+        :SHAVUOT,
+        :TZOM_TAMMUZ,
+        :TISHA_BAV,
+        :TU_BAV,
+        :EREV_ROSH_HASHANA,
+        :ROSH_HASHANA,
+        :TZOM_GEDALIA,
+        :EREV_YOM_KIPPUR,
+        :YOM_KIPPUR,
+        :EREV_SUKKOT,
+        :SUKKOT,
+        :SHMINI_ATZERET,
+        :EREV_CHANUKAH,
+        :CHANUKAH,
+        :TZOM_TEVET,
+        :TU_BISHVAT,
+        :PURIM_KATAN,
+        :TAANIT_ESTHER,
+        :PURIM,
+        :SHUSHAN_PURIM
+      ]
+
+      # Given a holiday name, return a HebrewDate representing that holiday.
+      # @param holiday [Symbol] the name of the holiday. Possible values are
+      #   in the HOLIDAYS array.
+      # @param year [Integer] if given, the Hebrew year to search. Defaults
+      #   to the current year.
+      def from_holiday(holiday, year=nil)
+        year ||= HebrewDate.new.hebrew_year
+        case holiday
+          when :EREV_PESACH
+            HebrewDate.new_from_hebrew(year, 1, 14)
+          when :PESACH
+            HebrewDate.new_from_hebrew(year, 1, 15)
+          when :PESACH_2
+            HebrewDate.new_from_hebrew(year, 1, 21)
+          when :PESACH_SHENI
+            HebrewDate.new_from_hebrew(year, 2, 15)
+          when :YOM_HAZIKARON
+            HebrewDate.from_holiday(:YOM_HAATZMAUT).back
+          when :YOM_HAATZMAUT
+            date = HebrewDate.new_from_hebrew(year, 2, 5)
+            # Friday or Shabbat - move back to Thursday
+            # Monday - move forward to Tuesday
+            if date.day == 6
+              date.back
+            elsif date.day == 2
+              date.forward
+            elsif date.day == 7
+              date.set_hebrew_date(year, 2, 3)
+            end
+          when :LAG_BAOMER
+            HebrewDate.new_from_hebrew(year, 2, 18)
+          when :YOM_YERUSHALAYIM
+            HebrewDate.new_from_hebrew(year, 2, 28)
+          when :TZOM_TAMMUZ
+            date = HebrewDate.new_from_hebrew(year, 4, 17)
+            date.forward if date.day == 7
+            date
+          when :EREV_SHAVUOT
+            HebrewDate.new_from_hebrew(year, 3, 5)
+          when :SHAVUOT
+            HebrewDate.new_from_hebrew(year, 3, 6)
+          when :TISHA_BAV
+            date = HebrewDate.new_from_hebrew(year, 5, 9)
+            date.forward if date.day == 7
+            date
+          when :TU_BAV
+            HebrewDate.new_from_hebrew(year, 15, 9)
+          when :EREV_ROSH_HASHANA
+            HebrewDate.new_from_hebrew(year, 6, 29)
+          when :ROSH_HASHANA
+            HebrewDate.new_from_hebrew(year, 7, 1)
+          when :TZOM_GEDALIA
+            date = HebrewDate.new_from_hebrew(year, 7, 3)
+            date.forward if date.day == 7
+            date
+          when :EREV_YOM_KIPPUR
+            HebrewDate.new_from_hebrew(year, 7, 9)
+          when :YOM_KIPPUR
+            HebrewDate.new_from_hebrew(year, 7, 10)
+          when :EREV_SUKKOT
+            HebrewDate.new_from_hebrew(year, 7, 14)
+          when :SUKKOT
+            HebrewDate.new_from_hebrew(year, 7, 15)
+          when :SHMINI_ATZERET
+            HebrewDate.new_from_hebrew(year, 7, 22)
+          when :EREV_CHANUKAH
+            HebrewDate.new_from_hebrew(year, 9, 24)
+          when :CHANUKAH
+            HebrewDate.new_from_hebrew(year, 9, 25)
+          when :TZOM_TEVET
+            HebrewDate.new_from_hebrew(year, 10, 10)
+          when :TU_BISHVAT
+            HebrewDate.new_from_hebrew(year, 11, 15)
+          when :PURIM_KATAN
+            if HebrewDate.hebrew_leap_year?(year)
+              HebrewDate.new_from_hebrew(year, 12, 14)
+            end
+          when :TAANIT_ESTHER
+            date = HebrewDate.new_from_hebrew(year,
+                                HebrewDate.last_month_of_hebrew_year(year), 13)
+            if date.day == 7
+              date.set_hebrew_date(year, date.hebrew_month, 11)
+            elsif date.day == 6
+              date.back
+            end
+            date
+          when :PURIM
+            HebrewDate.new_from_hebrew(year,
+                               HebrewDate.last_month_of_hebrew_year(year), 14)
+          when :SHUSHAN_PURIM
+            HebrewDate.new_from_hebrew(year,
+                               HebrewDate.last_month_of_hebrew_year(year), 15)
+        end
+      end
+    end
+
     # Returns a string of the Jewish holiday or fast day for the current day,
     # or an empty string if there is no holiday for this day.
     # @param generic [Boolean] whether you want just a generic name
@@ -252,5 +383,9 @@ module HebrewDateSupport
       end
     end
 
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
   end
 end

data/lib/support/parshiot.rb

@@ -1,5 +1,5 @@
 module HebrewDateSupport
-  module Parshiot
+  module ParshaMethods
     # Parsha names in Ashkenazi and Sephardi pronunciation.
     # @private
     PARSHA_NAMES          = [

data/spec/hebrew_date_spec.rb

@@ -47,4 +47,49 @@ describe HebrewDate do
     HebrewDate.new(2014, 12, 17).holiday.should == 'Chanukah'
     HebrewDate.new(2014, 12, 25).holiday.should be_nil
   end
+
+  specify 'from holidays' do
+    HebrewDate.from_holiday(:ROSH_HASHANA, 5774).to_date.
+      should == Date.new(2013, 9, 5)
+    HebrewDate.from_holiday(:TZOM_GEDALIA, 5774).to_date.
+      should == Date.new(2013, 9, 8)
+    HebrewDate.from_holiday(:YOM_KIPPUR, 5774).to_date.
+      should == Date.new(2013, 9, 14)
+    HebrewDate.from_holiday(:SUKKOT, 5774).to_date.
+      should == Date.new(2013, 9, 19)
+    HebrewDate.from_holiday(:SHMINI_ATZERET, 5774).to_date.
+      should == Date.new(2013, 9, 26)
+    HebrewDate.from_holiday(:CHANUKAH, 5774).to_date.
+      should == Date.new(2013, 11, 28)
+    HebrewDate.from_holiday(:TZOM_TEVET, 5774).to_date.
+      should == Date.new(2013, 12, 13)
+    HebrewDate.from_holiday(:TU_BISHVAT, 5774).to_date.
+      should == Date.new(2014, 1, 16)
+    HebrewDate.from_holiday(:PURIM_KATAN, 5774).to_date.
+      should == Date.new(2014, 2, 14)
+    HebrewDate.from_holiday(:TAANIT_ESTHER, 5774).to_date.
+      should == Date.new(2014, 3, 13)
+    HebrewDate.from_holiday(:PURIM, 5774).to_date.
+      should == Date.new(2014, 3, 16)
+    HebrewDate.from_holiday(:EREV_PESACH, 5774).to_date.
+      should == Date.new(2014, 4, 14)
+    HebrewDate.from_holiday(:PESACH, 5774).to_date.
+      should == Date.new(2014, 4, 15)
+    HebrewDate.from_holiday(:PESACH_2, 5774).to_date.
+      should == Date.new(2014, 4, 21)
+    HebrewDate.from_holiday(:YOM_HAZIKARON, 5774).to_date.
+      should == Date.new(2014, 5, 5)
+    HebrewDate.from_holiday(:YOM_HAATZMAUT, 5774).to_date.
+      should == Date.new(2014, 5, 6)
+    HebrewDate.from_holiday(:LAG_BAOMER, 5774).to_date.
+      should == Date.new(2014, 5, 18)
+    HebrewDate.from_holiday(:YOM_YERUSHALAYIM, 5774).to_date.
+      should == Date.new(2014, 5, 28)
+    HebrewDate.from_holiday(:SHAVUOT, 5774).to_date.
+      should == Date.new(2014, 6, 4)
+    HebrewDate.from_holiday(:TZOM_TAMMUZ, 5774).to_date.
+      should == Date.new(2014, 7, 15)
+    HebrewDate.from_holiday(:TISHA_BAV, 5774).to_date.
+      should == Date.new(2014, 8, 5)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hebrew_date
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Daniel Orner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-21 00:00:00.000000000 Z
+date: 2014-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard