Class: HebrewDate

Inherits:
Delegator
  • Object
show all
Extended by:
HebrewDateSupport::HolidayMethods::ClassMethods
Includes:
HebrewDateSupport::HolidayMethods, HebrewDateSupport::ParshaMethods
Defined in:
lib/hebrew_date.rb

Overview

A class that represents a date in both the Gregorian and Hebrew calendars simultaneously. Note that you may call any Date methods on this class and it should respond accordingly.

Constant Summary collapse

HEBREW_EPOCH = 
-1373429
HEBREW_MONTH_NAMES = 
['Nissan', 'Iyar', 'Sivan', 'Tammuz', 'Av', 'Elul',
'Tishrei', 'Cheshvan', 'Kislev', 'Teves', 'Shvat',
'Adar', 'Adar II']

Constants included from HebrewDateSupport::HolidayMethods::ClassMethods

HebrewDateSupport::HolidayMethods::ClassMethods::HOLIDAYS

Constants included from HebrewDateSupport::ParshaMethods

HebrewDateSupport::ParshaMethods::MON_LONG, HebrewDateSupport::ParshaMethods::MON_LONG_LEAP, HebrewDateSupport::ParshaMethods::MON_LONG_LEAP_ISRAEL, HebrewDateSupport::ParshaMethods::MON_SHORT, HebrewDateSupport::ParshaMethods::MON_SHORT_LEAP, HebrewDateSupport::ParshaMethods::MON_SHORT_LEAP_ISRAEL, HebrewDateSupport::ParshaMethods::PARSHA_NAMES, HebrewDateSupport::ParshaMethods::SAT_LONG, HebrewDateSupport::ParshaMethods::SAT_LONG_LEAP, HebrewDateSupport::ParshaMethods::SAT_SHORT, HebrewDateSupport::ParshaMethods::SAT_SHORT_LEAP, HebrewDateSupport::ParshaMethods::THU_LONG, HebrewDateSupport::ParshaMethods::THU_LONG_LEAP, HebrewDateSupport::ParshaMethods::THU_NORMAL, HebrewDateSupport::ParshaMethods::THU_NORMAL_ISRAEL, HebrewDateSupport::ParshaMethods::THU_SHORT_LEAP

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HebrewDateSupport::HolidayMethods::ClassMethods

from_holiday

Methods included from HebrewDateSupport::HolidayMethods

#candle_lighting_day?, #first_day_yom_tov?, #havdala_day?, #holiday, #omer, #omer_to_s, #rosh_chodesh?

Methods included from HebrewDateSupport::ParshaMethods

#parsha

Constructor Details

#initialize(year_or_date_object = nil, month = nil, date = nil) ⇒ HebrewDate 



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/hebrew_date.rb', line 64

def initialize(year_or_date_object=nil, month=nil, date=nil)
  @abs_date = 0

  if month && date
    @year = year_or_date_object
    @month = month
    @date = date
  else
    date = year_or_date_object || Date.today
    @year = date.year
    @month = date.month
    @date = date.mday
  end
  @israeli = self.class.israeli
  @ashkenaz = self.class.ashkenaz
  @debug = self.class.debug
  set_date(@year, @month, @date)
  super(Date.new)
end

Class Attribute Details

.ashkenaz ⇒ Boolean 



29
30
31
 
# File 'lib/hebrew_date.rb', line 29

def ashkenaz
  @ashkenaz
end

.debug ⇒ Object 



39
40
41
 
# File 'lib/hebrew_date.rb', line 39

def debug
  @debug
end

.israeli ⇒ Boolean 



32
33
34
 
# File 'lib/hebrew_date.rb', line 32

def israeli
  @israeli
end

.replace_saturday ⇒ Boolean 



36
37
38
 
# File 'lib/hebrew_date.rb', line 36

def replace_saturday
  @replace_saturday
end

Instance Attribute Details

#abs_date ⇒ Object (readonly) 



62
63
64
 
# File 'lib/hebrew_date.rb', line 62

def abs_date
  @abs_date
end

#date ⇒ Integer (readonly) 



50
51
52
 
# File 'lib/hebrew_date.rb', line 50

def date
  @date
end

#hebrew_date ⇒ Integer (readonly) 



59
60
61
 
# File 'lib/hebrew_date.rb', line 59

def hebrew_date
  @hebrew_date
end

#hebrew_month ⇒ Integer (readonly) 



56
57
58
 
# File 'lib/hebrew_date.rb', line 56

def hebrew_month
  @hebrew_month
end

#hebrew_year ⇒ Integer (readonly) 



53
54
55
 
# File 'lib/hebrew_date.rb', line 53

def hebrew_year
  @hebrew_year
end

#month ⇒ Integer (readonly) 



47
48
49
 
# File 'lib/hebrew_date.rb', line 47

def month
  @month
end

#year ⇒ Integer (readonly) 



44
45
46
 
# File 'lib/hebrew_date.rb', line 44

def year
  @year
end

Class Method Details

.hebrew_leap_year?(year) ⇒ Boolean

Is this a Hebrew leap year?



405
406
407
 
# File 'lib/hebrew_date.rb', line 405

def hebrew_leap_year?(year)
  (((7 * year) + 1).remainder(19)) < 7
end

.hebrew_month_to_s(month, year = nil) ⇒ String

Get the name of the given Hebrew month.



314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/hebrew_date.rb', line 314

def self.hebrew_month_to_s(month, year=nil)
  year ||= HebrewDate.new.hebrew_year
  if hebrew_leap_year?(year) && month == 12
    'Adar I'
  else
    name = HEBREW_MONTH_NAMES[month - 1]
    if name == 'Teves' && !self.ashkenaz
      name = 'Tevet'
    end
    name
  end
end

.last_month_of_hebrew_year(year) ⇒ Integer

The last month in the Hebrew year (12 or 13).



412
413
414
 
# File 'lib/hebrew_date.rb', line 412

def last_month_of_hebrew_year(year)
  hebrew_leap_year?(year) ? 13 : 12
end

.new_from_hebrew(year, month, date) ⇒ Object

Create a HebrewDate with initialized Hebrew date values.



147
148
149
150
151
 
# File 'lib/hebrew_date.rb', line 147

def self.new_from_hebrew(year, month, date)
  d = self.new
  d.set_hebrew_date(year, month, date)
  d
end

Instance Method Details

#<=>(other) ⇒ Integer

Comparison operator.



116
117
118
 
# File 'lib/hebrew_date.rb', line 116

def <=>(other)
  self.to_date <=> other.to_date
end

#__getobj__ ⇒ Object 



98
99
100
 
# File 'lib/hebrew_date.rb', line 98

def __getobj__
  self.to_date
end

#__setobj__(obj) ⇒ Object 



103
104
105
 
# File 'lib/hebrew_date.rb', line 103

def __setobj__(obj)
  # do nothing
end

#back ⇒ HebrewDate

Move back one day.



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/hebrew_date.rb', line 267

def back
  # Change Gregorian date
  if @date == 1
    if @month == 1
      @month = 12
      @year -= 1
    else
      @month -= 1
    end

    # change to last day of previous month
    @date = last_day_of_month
  else
    @date -= 1
  end

  # Change Hebrew date
  if @hebrew_date == 1
    if @hebrew_month == 1 # Nisan
      @hebrew_month = last_month_of_hebrew_year
    elsif @hebrew_month == 7 # Rosh Hashana
      @hebrew_year -= 1
      @hebrew_month -= 1
    else
      @hebrew_month -= 1
    end
    @hebrew_date = last_day_of_hebrew_month
  else
    @hebrew_date -= 1
  end

  # Change the absolute date
  @abs_date -= 1

  self
end

#clone ⇒ HebrewDate

Get a clone of this object.



109
110
111
 
# File 'lib/hebrew_date.rb', line 109

def clone
  self.class.new(self.to_date)
end

#day ⇒ Integer

Get the day of the week.



377
378
379
 
# File 'lib/hebrew_date.rb', line 377

def day
  to_date.strftime('%w').to_i + 1
end

#downto(min, &block) ⇒ Enumerator|self

This method is equivalent to step(min, -1){|date| …}.



130
131
132
133
 
# File 'lib/hebrew_date.rb', line 130

def downto(min, &block)
  return to_enum(:downto, min) unless block_given?
  self.step(min, -1, &block)
end

#forward ⇒ HebrewDate

Move forward one day.



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/hebrew_date.rb', line 214

def forward
  # Change Gregorian date
  if @date == last_day_of_month
    if @month == 12
      # last day of year
      @year += 1
      @month = 1
      @date = 1
    else
      @month += 1
      @date = 1
    end
  else
    # if not last day of month
    @date += 1
  end

  # Change Hebrew date
  if @hebrew_date == last_day_of_hebrew_month
    if @hebrew_month == 6
      # last day of Elul (i.e. last day of Hebrew year)
      @hebrew_year += 1
      @hebrew_month += 1
      @hebrew_date = 1
    elsif @hebrew_month == last_month_of_hebrew_year
      # last day of Adar or Adar II
      @hebrew_month = 1
      @hebrew_date = 1
    else
      @hebrew_month += 1
      @hebrew_date = 1
    end
  else
    # not last day of month
    @hebrew_date += 1
  end

  # increment the absolute date
  @abs_date += 1

  self
end

#hebrew_leap_year? ⇒ Boolean

Is this a Hebrew leap year?



426
427
428
 
# File 'lib/hebrew_date.rb', line 426

def hebrew_leap_year?
  self.class.hebrew_leap_year?(@hebrew_year)
end

#hebrew_month_to_s ⇒ String

Get the name of the current Hebrew month.



306
307
308
 
# File 'lib/hebrew_date.rb', line 306

def hebrew_month_to_s
  self.class.hebrew_month_to_s(@hebrew_month, @hebrew_year)
end

#inspect ⇒ Object 



85
86
87
 
# File 'lib/hebrew_date.rb', line 85

def inspect
  strftime('*Y-*-m-*-d (%Y-%-m-%-d)')
end

#last_day_of_hebrew_month(month = nil) ⇒ Integer

Last day of the current Hebrew month.



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/hebrew_date.rb', line 433

def last_day_of_hebrew_month(month=nil)
  month ||= @hebrew_month
  if month == 2 ||
    month == 4 ||
    month == 6 ||
    (month == 8 && !_cheshvan_long?) ||
    (month == 9 && _kislev_short?) ||
    month == 10 ||
    (month == 12 && !hebrew_leap_year?) ||
    month == 13
    29
  else
    30
  end
end

#last_day_of_month(month = nil) ⇒ Integer

The last day of the Gregorian month.



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/hebrew_date.rb', line 384

def last_day_of_month(month=nil)
  month ||= @month
  case month
    when 2
      if (((@year.remainder(4)) == 0) && ((@year.remainder(100)) != 0)) ||
        ((@year.remainder(400)) == 0)
        29
      else
        28
      end
    when 4, 6, 9, 11
      30
    else
      31
  end
end

#last_month_of_hebrew_year ⇒ Integer

The last month in this Hebrew year (12 or 13).



420
421
422
 
# File 'lib/hebrew_date.rb', line 420

def last_month_of_hebrew_year
  self.class.last_month_of_hebrew_year(@hebrew_year)
end

#next ⇒ HebrewDate Also known as: succ

This does not modify the current date, but creates a new one.



259
260
261
 
# File 'lib/hebrew_date.rb', line 259

def next
  self + 1
end

#set_date(year, month, date) ⇒ void

This method returns an undefined value.

Set the Gregorian date of this HebrewDate.



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/hebrew_date.rb', line 158

def set_date(year, month, date)
  # precond should be 1->12 anyways, but just in case...
  return "Illegal value for year: #{year}" if year < 0
  return "Illegal value for month: #{month}" if month > 12 || month < 0
  return "Illegal value for date: #{date}" if date < 0

  # make sure date is a valid date for the given month.
  # If not, set to last day of month
  last_day = last_day_of_month(month)
  date = last_day if date > last_day

  @year = year
  @month = month
  @date = date

# init the Hebrew date
  @abs_date = _date_to_abs_date(@year, @month, @date)
  _abs_date_to_hebrew_date!
end

#set_hebrew_date(year, month, date) ⇒ void

This method returns an undefined value.

Set the Hebrew date.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/hebrew_date.rb', line 183

def set_hebrew_date(year, month, date)
  return "Illegal value for Hebrew year: #{year}" if year < 0
  if month < 0 || month > last_month_of_hebrew_year
    return "Illegal value for Hebrew month: #{month}"
  end
  return "Illegal value for Hebrew date: #{date}" if date < 0

  # make sure date is valid for this month;
  # otherwise, set to last day of month
  last_day = last_day_of_hebrew_month(month)
  date = last_day if date > last_day

  @hebrew_year = year
  @hebrew_month = month
  @hebrew_date = date

  # reset gregorian date
  @abs_date =
    _hebrew_date_to_abs_date(@hebrew_year, @hebrew_month, @hebrew_date)
  _abs_date_to_date!

end

#shabbos? ⇒ Boolean Also known as: shabbat? 



328
329
330
 
# File 'lib/hebrew_date.rb', line 328

def shabbos?
  self.saturday?
end

#step(limit, step = 1, &block) ⇒ Object

Iterates evaluation of the given block, which takes a HebrewDate object. The limit should be a Date or HebrewDate object.



122
123
124
125
 
# File 'lib/hebrew_date.rb', line 122

def step(limit, step=1, &block)
  return to_enum(:step, limit, step) unless block_given?
  (self..limit).step(step) { |date| yield(date) }
end

#strftime(format) ⇒ String

Extend the Date strftime method by replacing Hebrew fields. You can denote Hebrew fields by using the * flag. Also note that ::replace_saturday will replace the %A, %^A, %a and %^a flags with Shabbat/Shabbos. Supported flags are:

* *Y - Hebrew year
* *m - Hebrew month, zero-padded
* *_m - Hebrew month, blank-padded
* *-m - Hebrew month, no-padded
* *B - Hebrew month, full name
* *^B - Hebrew month, full name uppercase
* *b - Hebrew month, 3 letters
* *^b - Hebrew month, 3 letters uppercase
* *h - same as %*b
* *d - Hebrew day of month, zero-padded
* *-d - Hebrew day of month, no-padded
* *e - Hebrew day of month, blank-padded



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/hebrew_date.rb', line 352

def strftime(format)
  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, ' '))
  if HebrewDate.replace_saturday && @hebrew_date.day == 7
    shab_name = HebrewDate.ashkenaz ? 'Shabbos' : 'Shabbat'
    format = format.gsub('%A', shab_name)
      .gsub('%^A', shab_name.upcase)
      .gsub('%a', shab_name[0..2])
      .gsub('%^a', shab_name[0..2].upcase)
  end
  super(format)
end

#to_date ⇒ Date

Return a Ruby Date corresponding to the Gregorian date.



208
209
210
 
# File 'lib/hebrew_date.rb', line 208

def to_date
  Date.new(@year, @month, @date)
end

#upto(max, &block) ⇒ Enumerator|self

This method is equivalent to step(max, 1){ |date| …}.



138
139
140
141
 
# File 'lib/hebrew_date.rb', line 138

def upto(max, &block)
  return to_enum(:upto, max) unless block_given?
  self.step(max, 1, &block)
end