zmanim 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1f7a1368c46f18f412f39609c0d076d14e9786a5
-  data.tar.gz: f74bde128ee6b5131e1f55ede44feff17ac853f3
+SHA256:
+  metadata.gz: 60f1ce1f598d2bb45067fadbb609dca84e62e94da2144d6815c04a14083eeeb9
+  data.tar.gz: e83e26224f23d21216258f3e31ad65bafc18af91f250c09ab9e0a5941061aa34
 SHA512:
-  metadata.gz: cc70992c4c514e0ba3b77126dace5f4f216c9714b84bd4b5dbf0e80e14a1a994544e708f70c2e650e9aac5d125c3fd391bac4524318d8607fefc6ea874f55c5d
-  data.tar.gz: a85bc156410ea7493f1156e5f100b6a83e5cdb2fe99f90835c2f3c56b80d41c8727c791820ecc088743d05c31817bcc6fe21ff292014fd1f0a5c93590a9a5bb0
+  metadata.gz: '0868fb13463bc643a818c5faa9aad148659ea8597eceadbafbc4a544d8cc88f7b8ec069361939f860eb6c76c4c07b70f7e0100ab3b4e4ff2e19a73fb2dec9908'
+  data.tar.gz: 946ccd345d2fcb4612ff4b2b2782de1c78a822e97fd70b12b4c48569c51d98907aeb05dd9b97894fa0cc4a9397167e5af75e53492e625c9b2f425282ae9d8e08

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [0.4.0] - 2020-10-13
+### Added
+- `JewishCalendar#end_of_week` returns Shabbos for this week
+- Parshas Hashavua modifier to return blank Limud if the standard Parsha is not read this Shabbos
+- Daf Hashavua calculator
+### Changed
+- Refactor kviah calculation logic to JewishDate
+- Remove formatter dependency for Parsha calculator
+### Fixed
+- Added Lag B'Omer as significant day / yom tov
+- Fixed Lag B'Omer spelling for english formatted omer
+
+## [0.3.0] - 2018-09-17
+### Added
+- Elevations used in shaos zmanios calculations if use_elevation property is set
+- Hanetz and Shkia methods will use the appropriate calculation based on use_elevation setting
+- Support Alos and Tzais offset using temporal minutes
+- Various Assur Bemelacha related methods for calendar dates using JewishCalendar, 
+  as well as point-in-time using ZmanimCalendar.
+- Methods to determine Shabbos Mevorchim, first night of Vesein Tal Umatar,
+  and delayed candle lighting
+
+## [0.2.2] - 2018-08-31
+### Fixed
+- Typo in formatted Masechtos
+- Additional load sequence issues
+
+## [0.2.1] - 2018-04-30
+### Fixed
+- Additional load sequence issues 
+
+## [0.2.0] - 2018-04-22
+### Added
+- Pirkei Avos limudim calculation
+- Support for explicit skip_unit (used by DafYomiYerushalmi)
+- CHANGELOG (this file :) )
+### Changed
+- Refactored skip_interval to generic limud detection
+### Fixed
+- Cycle detection falsely identifies dates between cycle windows as belonging to a prior cycle
+- Load sequence can't find Zmanim module when loaded externally
+
+## [0.1.0] - 2018-01-09 (Original release)
+### Added
+- Port of KosherJava/zmanim library, primary functionality
+- Limudim calculation framework
+- Weekly Parsha, Tehillim (Month cycle), Mishna Yomis limudim calculation

data/lib/zmanim.rb

@@ -1,6 +1,6 @@
 require 'tzinfo'
-Dir[File.dirname(__FILE__) + "/**/*.rb"].each {|file| require file }
 
-module Zmanim
-  # Your code goes here...
-end
+module Zmanim; end
+module Zmanim::Limudim; end
+
+Dir[File.dirname(__FILE__) + "/**/*.rb"].each {|file| require file }

data/lib/zmanim/hebrew_calendar/hebrew_date_formatter.rb

@@ -1,4 +1,8 @@
 # encoding: UTF-8
+require 'zmanim/util/text_helper'
+require 'zmanim/util/hebrew_numeric_formatter'
+require_relative 'jewish_calendar'
+
 module Zmanim::HebrewCalendar
   class HebrewDateFormatter
     extend Zmanim::Util::TextHelper
@@ -42,7 +46,7 @@ module Zmanim::HebrewCalendar
         transliterated: Zmanim::HebrewCalendar::JewishCalendar::SIGNIFICANT_DAYS.each_with_object({}){|d, h|
           h[d] = titleize(d)
         }.merge(tzom_gedalyah: 'Fast of Gedalyah', tenth_of_teves: 'Tenth of Teves', tu_beshvat: "Tu B'Shvat",
-                taanis_esther: 'Fast of Esther', seventeen_of_tammuz: 'Seventeenth of Tammuz',
+                taanis_esther: 'Fast of Esther', lag_baomer: "Lag B'Omer", seventeen_of_tammuz: 'Seventeenth of Tammuz',
                 tisha_beav: "Tisha B'Av", tu_beav: "Tu B'Av", yom_hashoah: 'Yom HaShoah', yom_haatzmaut: "Yom Ha'atzmaut"),
         hebrew: {
             erev_rosh_hashana:   'ערב ראש השנה',
@@ -68,6 +72,7 @@ module Zmanim::HebrewCalendar
             pesach:              'פסח',
             chol_hamoed_pesach:  'חול המועד פסח',
             pesach_sheni:        'פסח שני',
+            lag_baomer:          'ל״ג בעומר',
             erev_shavuos:        'ערב שבועות',
             shavuos:             'שבועות',
             seventeen_of_tammuz: 'שבעה עשר בתמוז',
@@ -175,18 +180,15 @@ module Zmanim::HebrewCalendar
       if hebrew_format
         format_hebrew_number(number) + ' ' + hebrew_omer_prefix + 'עומר'
       else
-        number == 33 ? 'Lag BaOmer' : "Omer #{number}"
+        number == 33 ? "Lag B'Omer" : "Omer #{number}"
       end
     end
 
     def format_kviah(year)
       date = year.is_a?(Numeric) ? Zmanim::HebrewCalendar::JewishDate.new(year, 7, 1) : year
-      kviah = date.cheshvan_kislev_kviah
-      rosh_hashana_day = date.day_of_week
-      kviah_glyph = {chaseirim: 'ח', kesidran: 'כ', shelaimim: 'ש'}[kviah]
-      date.jewish_month = 1
-      pesach_day = date.day_of_week
-      "#{format_hebrew_number(rosh_hashana_day)}#{kviah_glyph}#{format_hebrew_number(pesach_day)}".delete(GERESH)
+      kviah_values = date.kviah
+      kviah_glyph = {chaseirim: 'ח', kesidran: 'כ', shelaimim: 'ש'}[kviah_values[:kviah]]
+      "#{format_hebrew_number(kviah_values[:rosh_hashana])}#{kviah_glyph}#{format_hebrew_number(kviah_values[:pesach])}".delete(GERESH)
     end
 
     def format_tefilah_additions(calendar, customs={walled_city: false, nusach: :ashkenaz})

data/lib/zmanim/hebrew_calendar/jewish_calendar.rb

@@ -8,7 +8,7 @@ module Zmanim::HebrewCalendar
                           erev_succos succos chol_hamoed_succos hoshana_rabbah shemini_atzeres simchas_torah
                           chanukah tenth_of_teves tu_beshvat
                           taanis_esther purim shushan_purim purim_katan shushan_purim_katan
-                          erev_pesach pesach chol_hamoed_pesach pesach_sheni erev_shavuos shavuos
+                          erev_pesach pesach chol_hamoed_pesach pesach_sheni lag_baomer erev_shavuos shavuos
                           seventeen_of_tammuz tisha_beav tu_beav
                           yom_hashoah yom_hazikaron yom_haatzmaut yom_yerushalayim)
 
@@ -30,6 +30,22 @@ module Zmanim::HebrewCalendar
       send("#{jewish_month_name}_significant_day")
     end
 
+    def assur_bemelacha?
+      day_of_week == 7 || yom_tov_assur_bemelacha?
+    end
+
+    def tomorrow_assur_bemelacha?
+      day_of_week == 6 || erev_yom_tov? || erev_yom_tov_sheni?
+    end
+
+    def candle_lighting?
+      tomorrow_assur_bemelacha?
+    end
+
+    def delayed_candle_lighting?
+      day_of_week != 6 && candle_lighting? && assur_bemelacha?
+    end
+
     def yom_tov?
       sd = significant_day
       sd && !sd.to_s.start_with?('erev_') && (!taanis? || sd == :yom_kippur)
@@ -39,17 +55,31 @@ module Zmanim::HebrewCalendar
       %i(pesach shavuos rosh_hashana yom_kippur succos shemini_atzeres simchas_torah).include?(significant_day)
     end
 
-    def chol_hamoed?
-      sd = significant_day
-      sd && (sd.to_s.start_with?('chol_hamoed_') || sd == :hoshana_rabbah)
-    end
-
     def erev_yom_tov?
       return false unless sd = significant_day
       sd.to_s.start_with?('erev_') || sd == :hoshana_rabbah ||
           (sd == :chol_hamoed_pesach && jewish_day == 20)
     end
 
+    def yom_tov_sheni?
+      (jewish_month == 7 && jewish_day == 2) ||
+          (!in_israel && ((jewish_month == 7 && [16, 23].include?(jewish_day)) ||
+                          (jewish_month == 1 && [16, 22].include?(jewish_day)) ||
+                          (jewish_month == 3 && jewish_day == 7)))
+    end
+
+    def erev_yom_tov_sheni?
+      (jewish_month == 7 && jewish_day == 1) ||
+          (!in_israel && ((jewish_month == 7 && [15, 22].include?(jewish_day)) ||
+                          (jewish_month == 1 && [15, 21].include?(jewish_day)) ||
+                          (jewish_month == 3 && jewish_day == 6)))
+    end
+
+    def chol_hamoed?
+      sd = significant_day
+      sd && (sd.to_s.start_with?('chol_hamoed_') || sd == :hoshana_rabbah)
+    end
+
     def taanis?
       %i(seventeen_of_tammuz tisha_beav tzom_gedalyah yom_kippur tenth_of_teves taanis_esther).include?(significant_day)
     end
@@ -123,6 +153,10 @@ module Zmanim::HebrewCalendar
       molad_as_datetime + 15
     end
 
+    def end_of_week
+      self + (7 - day_of_week)
+    end
+
     def daf_yomi_bavli
       Zmanim::Limudim::Calculators::DafYomiBavli.new.limud(self)
     end
@@ -131,8 +165,14 @@ module Zmanim::HebrewCalendar
       Zmanim::Limudim::Calculators::DafYomiYerushalmi.new.limud(self)
     end
 
-    def parshas_hashavua
-      Zmanim::Limudim::Calculators::Parsha.new(in_israel: in_israel).limud(self)
+    def daf_hashavua_bavli
+      Zmanim::Limudim::Calculators::DafHashavuaBavli.new.limud(self)
+    end
+
+    def parshas_hashavua(current_week_only: false)
+      limud = Zmanim::Limudim::Calculators::Parsha.new(in_israel: in_israel).limud(self)
+      limud.clear! if current_week_only && limud.interval.end_date > end_of_week
+      limud
     end
 
     def tehillim_portion
@@ -143,6 +183,10 @@ module Zmanim::HebrewCalendar
       Zmanim::Limudim::Calculators::MishnaYomis.new.limud(self)
     end
 
+    def pirkei_avos
+      Zmanim::Limudim::Calculators::PirkeiAvos.new(in_israel: in_israel).limud(self)
+    end
+
     def tefilah_additions(walled_city: false, nusach: :ashkenaz)
       additions = []
       if mashiv_haruach_starts?
@@ -187,6 +231,12 @@ module Zmanim::HebrewCalendar
       end
     end
 
+    def shabbos_mevorchim?
+      day_of_week == 7 &&
+          jewish_month != 6 &&
+          (23..29).include?(jewish_day)
+    end
+
     def mashiv_haruach_starts?
       jewish_month == 7 && jewish_day == 22
     end
@@ -213,12 +263,18 @@ module Zmanim::HebrewCalendar
     # for the 20th and 21st century.
     def vesein_tal_umatar?
       return false if day_of_week == 7 || yom_tov_assur_bemelacha?
-      start_date = JewishDate.new(jewish_year, 8, 7)
-      start_date.set_gregorian_date(start_date.gregorian_year, 12, gregorian_leap_year?(start_date.gregorian_year+1) ? 6 : 5) unless in_israel
+      start_date = gregorian_vesein_tal_umatar_start
       end_date = JewishDate.new(jewish_year, 1, 15)
       self.between?(start_date, end_date)
     end
 
+    def vesein_tal_umatar_starts_tonight?
+      return false if day_of_week == 6
+      start_date = gregorian_vesein_tal_umatar_start
+      (day_of_week == 7 && self == start_date) ||
+          self == (start_date - 1)
+    end
+
     def vesein_beracha?
       return false if day_of_week == 7 || yom_tov_assur_bemelacha?
       !vesein_tal_umatar?
@@ -257,6 +313,8 @@ module Zmanim::HebrewCalendar
     def iyar_significant_day
       if jewish_day == 14
         :pesach_sheni
+      elsif jewish_day == 18
+        :lag_baomer
       elsif use_modern_holidays
         # Note that this logic follows the current rules, which were last revised in 5764.
         # The calculations for years prior may not reflect the actual dates observed at that time.
@@ -386,5 +444,13 @@ module Zmanim::HebrewCalendar
         :shushan_purim
       end
     end
+
+    def gregorian_vesein_tal_umatar_start
+      start_date = JewishDate.new(jewish_year, 8, 7)
+      unless in_israel
+        start_date.set_gregorian_date(start_date.gregorian_year, 12, gregorian_leap_year?(start_date.gregorian_year + 1) ? 6 : 5)
+      end
+      start_date
+    end
   end
 end

data/lib/zmanim/hebrew_calendar/jewish_date.rb

@@ -157,6 +157,40 @@ module Zmanim::HebrewCalendar
       end
     end
 
+    def succ
+      self + 1
+    end
+
+    def step(limit, step=1, &block)
+      if step < 0
+        downto(limit, -step, &block)
+      else
+        upto(limit, step, &block)
+      end
+    end
+
+    def downto(limit, step=1)
+      raise ArgumentError, 'step argument must be greater than 0' if step <= 0
+      return to_enum(__method__, limit, step) unless block_given?
+      c = self
+      while c >= limit
+        yield c
+        c -= step
+      end
+      self
+    end
+
+    def upto(limit, step=1)
+      raise ArgumentError, 'step argument must be greater than 0' if step <= 0
+      return to_enum(__method__, limit, step) unless block_given?
+      c = self
+      while c <= limit
+        yield c
+        c += step
+      end
+      self
+    end
+
     def gregorian_year=(year)
       set_gregorian_date(year, gregorian_month, gregorian_day)
     end
@@ -275,6 +309,17 @@ module Zmanim::HebrewCalendar
       CHESHVAN_KISLEV_KEVIAH[(days_in_jewish_year(year) % 10) - 3]
     end
 
+    def kviah(year=jewish_year)
+      date = year.is_a?(Numeric) ? Zmanim::HebrewCalendar::JewishDate.new(year, 7, 1) : year
+      kviah = date.cheshvan_kislev_kviah
+      rosh_hashana_day = date.day_of_week
+      date.jewish_month = 1
+      pesach_day = date.day_of_week
+      {rosh_hashana: rosh_hashana_day,
+       kviah: kviah,
+       pesach: pesach_day}
+    end
+
     # Returns a new JewishDate as the molad for given month
     def molad(month=jewish_month, year=jewish_year)
       self.class.from_molad(chalakim_since_molad_tohu(year, month))

data/lib/zmanim/limudim/calculators/daf_hashavua_bavli.rb

@@ -0,0 +1,23 @@
+require 'zmanim/limudim/calculators/daf_yomi_bavli'
+
+module Zmanim::Limudim::Calculators
+  class DafHashavuaBavli < DafYomiBavli
+    def initial_cycle_date
+      jewish_date(Date.parse('2005-03-02'))
+    end
+
+    def cycle_end_calculation
+      ->(start_date, iteration){ start_date + ((2711*7) - start_date.day_of_week) }  # 2711 pages except first week * 7 days
+    end
+
+    def interval_end_calculation
+      ->(cycle, start_date){ start_date + (7 - start_date.day_of_week) }
+    end
+
+    def cycle_units_calculation
+      ->(cycle){ default_units }
+    end
+  end
+end
+
+

data/lib/zmanim/limudim/calculators/daf_yomi_yerushalmi.rb

@@ -33,12 +33,8 @@ module Zmanim::Limudim::Calculators
       end
     end
 
-    def unit_for_interval(units, interval)
-      if matches_skip_day?(interval.start_date)
-        Zmanim::Limudim::Unit.new('no_daf_today')
-      else
-        super
-      end
+    def skip_unit
+      Zmanim::Limudim::Unit.new('no_daf_today')
     end
 
     def skip_interval?(interval)

data/lib/zmanim/limudim/calculators/mishna_yomis.rb

@@ -40,7 +40,7 @@ module Zmanim::Limudim::Calculators
             meilah: [4,9,8,6,5,6], tamid: [4,5,9,3,6,4,3], midos: [9,6,8,7,4], kinnim: [4,5,6],
             keilim: [9,8,8,4,11,4,6,11,8,8,9,8,8,8,6,8,17,9,10,7,3,10,5,17,9,9,12,10,8,4], ohalos: [8,7,7,3,7,7,6,6,16,7,9,8,6,7,10,5,5,10],
             negaim: [6,5,8,11,5,8,5,10,3,10,12,7,12,13], parah: [4,5,11,4,9,5,12,11,9,6,9,11], taharos: [9,8,8,13,9,10,9,9,9,8],
-            mikvaos: [8,10,4,5,6,11,7,5,7,8], niddah: [7,7,7,7,9,14,5,4,11,8], machshirim: [6,11,8,10,11,8], zavim: [6,4,3,7,12],
+            mikvaos: [8,10,4,5,6,11,7,5,7,8], niddah: [7,7,7,7,9,14,5,4,11,8], machshirin: [6,11,8,10,11,8], zavim: [6,4,3,7,12],
             tevul_yom: [5,8,6,7], yadayim: [5,4,5,8], uktzin: [6,10,12]
           }.map{|k, v| [k, Hash[v.map.with_index{|m, p| [p+1, m]}]]}]
     end

data/lib/zmanim/limudim/calculators/parsha.rb

@@ -47,40 +47,40 @@ module Zmanim::Limudim::Calculators
 
     def cycle_units_calculation
       ->(cycle) do
-        kviah = Zmanim::HebrewCalendar::HebrewDateFormatter.new.format_kviah(cycle.start_date.jewish_year)
+        kviah_values = cycle.start_date.kviah.values
         modifications = in_israel ?
                          {
-                             'בחה' => [%i(matos masei), %i(nitzavim vayeilech)],
-                             'בשז' => [],
-                             'גכז' => [],
-                             'החא' => [],
-                             'השג' => [%i(nitzavim vayeilech)],
-                             'זחג' => [%i(matos masei), %i(nitzavim vayeilech)],
-                             'זשה' => [%i(matos masei), %i(nitzavim vayeilech)],
-                             'בחג' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei), %i(nitzavim vayeilech)],
-                             'בשה' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei), %i(nitzavim vayeilech)],
-                             'גכה' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei), %i(nitzavim vayeilech)],
-                             'הכז' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(matos masei)],
-                             'השא' => [%i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
-                             'זחא' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
-                             'זשג' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
-                         }[kviah] :
+                             [2,:chaseirim,5] => [%i(matos masei), %i(nitzavim vayeilech)],
+                             [2,:shelaimim,7] => [],
+                             [3,:kesidran,7] => [],
+                             [5,:chaseirim,1] => [],
+                             [5,:shelaimim,3] => [%i(nitzavim vayeilech)],
+                             [7,:chaseirim,3] => [%i(matos masei), %i(nitzavim vayeilech)],
+                             [7,:shelaimim,5] => [%i(matos masei), %i(nitzavim vayeilech)],
+                             [2,:chaseirim,3] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei), %i(nitzavim vayeilech)],
+                             [2,:shelaimim,5] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei), %i(nitzavim vayeilech)],
+                             [3,:kesidran,5] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei), %i(nitzavim vayeilech)],
+                             [5,:kesidran,7] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(matos masei)],
+                             [5,:shelaimim,1] => [%i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
+                             [7,:chaseirim,1] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
+                             [7,:shelaimim,3] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
+                         }[kviah_values] :
                          {
-                             'בחה' => [%i(chukas balak), %i(matos masei), %i(nitzavim vayeilech)],
-                             'בשז' => [%i(matos masei)],
-                             'גכז' => [%i(matos masei)],
-                             'החא' => [],
-                             'השג' => [%i(nitzavim vayeilech)],
-                             'זחג' => [%i(matos masei), %i(nitzavim vayeilech)],
-                             'זשה' => [%i(chukas balak), %i(matos masei), %i(nitzavim vayeilech)],
-                             'בחג' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei), %i(nitzavim vayeilech)],
-                             'בשה' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(chukas balak), %i(matos masei), %i(nitzavim vayeilech)],
-                             'גכה' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(chukas balak), %i(matos masei), %i(nitzavim vayeilech)],
-                             'הכז' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
-                             'השא' => [%i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
-                             'זחא' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
-                             'זשג' => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei), %i(nitzavim vayeilech)],
-                         }[kviah]
+                             [2,:chaseirim,5] => [%i(chukas balak), %i(matos masei), %i(nitzavim vayeilech)],
+                             [2,:shelaimim,7] => [%i(matos masei)],
+                             [3,:kesidran,7] => [%i(matos masei)],
+                             [5,:chaseirim,1] => [],
+                             [5,:shelaimim,3] => [%i(nitzavim vayeilech)],
+                             [7,:chaseirim,3] => [%i(matos masei), %i(nitzavim vayeilech)],
+                             [7,:shelaimim,5] => [%i(chukas balak), %i(matos masei), %i(nitzavim vayeilech)],
+                             [2,:chaseirim,3] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei), %i(nitzavim vayeilech)],
+                             [2,:shelaimim,5] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(chukas balak), %i(matos masei), %i(nitzavim vayeilech)],
+                             [3,:kesidran,5] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(chukas balak), %i(matos masei), %i(nitzavim vayeilech)],
+                             [5,:kesidran,7] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
+                             [5,:shelaimim,1] => [%i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
+                             [7,:chaseirim,1] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei)],
+                             [7,:shelaimim,3] => [%i(vayakheil pikudei), %i(tazria metzora), %i(acharei kedoshim), %i(behar bechukosai), %i(matos masei), %i(nitzavim vayeilech)],
+                         }[kviah_values]
         modifications.inject(default_units) do |transitioned_units, parsha_pair|
           index = transitioned_units.index(parsha_pair.first)
           transitioned_units[0...index] + [parsha_pair] + transitioned_units[(index + 2)..-1]

data/lib/zmanim/limudim/calculators/pirkei_avos.rb

@@ -0,0 +1,54 @@
+require 'zmanim/limudim/limud_calculator'
+
+module Zmanim::Limudim::Calculators
+  class PirkeiAvos
+    include Zmanim::Limudim::LimudCalculator
+
+    attr_reader :in_israel
+
+    def initialize(in_israel:false)
+      @in_israel = in_israel
+    end
+
+    def tiered_units?
+      false
+    end
+
+    def perpetual_cycle_anchor
+      Zmanim::Limudim::Anchor::DayOfYearAnchor.new(1, in_israel ? 22 : 23) # Day after Pesach
+    end
+
+    def default_units
+      @default_units ||= (1..6).to_a * 4    # 4 sub-cycles of 6 perakim, with the last sub-cycle being compressed as needed
+    end
+
+    def cycle_end_calculation
+      ->(start_date, _iteration) do
+        rosh_hashana = Zmanim::HebrewCalendar::JewishDate.new(start_date.jewish_year + 1, 7, 1)
+        rosh_hashana - rosh_hashana.day_of_week  # last Shabbos before Rosh Hashanah
+      end
+    end
+
+    def interval_end_calculation
+      ->(cycle, start_date) do
+        start_date + (7 - start_date.day_of_week)
+      end
+    end
+
+    def skip_interval?(interval)
+      !in_israel && [interval.end_date.jewish_month, interval.end_date.jewish_day] == [3,7]
+    end
+
+    def cycle_units_calculation
+      ->(cycle) do
+        cycle_weeks = ((cycle.end_date - cycle.start_date + 1) / 7.0).ceil
+        # If the cycle starts on a Friday, outside of israel the 2nd day of Shavuos will fall on Shabbos
+        # and we lose one week in the pirkei avos cycle
+        cycle_weeks -=1 if !in_israel && cycle.start_date.day_of_week == 6
+        unit_count = default_units.length
+        compress_weeks = (unit_count - cycle_weeks) * 2
+        default_units.first(unit_count - compress_weeks) + default_units.last(compress_weeks).each_slice(2).to_a
+      end
+    end
+  end
+end

data/lib/zmanim/limudim/cycle.rb

@@ -32,9 +32,5 @@ module Zmanim::Limudim
       new_end_date = cycle_end_calculation.(new_start_date, new_iteration)
       Cycle.new(new_start_date, new_end_date, new_iteration)
     end
-
-    def first_interval(interval_end_calculation)
-      Interval.first_for_cycle(self, interval_end_calculation)
-    end
   end
 end

data/lib/zmanim/limudim/limud.rb

@@ -7,6 +7,10 @@ module Zmanim::Limudim
       @unit = unit
     end
 
+    def clear!
+      @unit = nil
+    end
+
     def cycle
       interval.cycle
     end

data/lib/zmanim/limudim/limud_calculator.rb

@@ -5,14 +5,15 @@ module Zmanim::Limudim
     def limud(date)
       jewish_date = jewish_date(date)
       cycle = find_cycle(jewish_date)
-      return nil unless cycle
+      return nil unless cycle && cycle.end_date >= date
       units = cycle_units_calculation.(cycle)
-      interval = cycle.first_interval(interval_end_calculation)
+      interval = Interval.first_for_cycle(cycle, interval_end_calculation)
       while !jewish_date.between?(interval.start_date, interval.end_date) do
-        interval = interval.next(interval_end_calculation)
-        while !jewish_date.between?(interval.start_date, interval.end_date) && skip_interval?(interval)
-          interval = interval.skip(interval_end_calculation)
-        end
+        interval = if skip_interval?(interval)
+                     interval.skip(interval_end_calculation)
+                   else
+                     interval.next(interval_end_calculation)
+                   end
       end
       unit = unit_for_interval(units, interval)
       Zmanim::Limudim::Limud.new(interval, unit)
@@ -79,10 +80,15 @@ module Zmanim::Limudim
     end
 
     def unit_for_interval(units, interval)
+      return skip_unit if skip_interval?(interval)
       return tiered_units_for_interval(units, interval) if tiered_units?
       Unit.new(*units[interval.iteration-1])
     end
 
+    def skip_unit
+      nil
+    end
+
     def skip_interval?(interval)
       false
     end

data/lib/zmanim/limudim/limudim_formatter.rb

@@ -1,4 +1,7 @@
 # encoding: UTF-8
+require 'zmanim/util/text_helper'
+require 'zmanim/util/hebrew_numeric_formatter'
+
 module Zmanim::Limudim
   class LimudimFormatter
     include Zmanim::Util::TextHelper
@@ -70,7 +73,7 @@ module Zmanim::Limudim
         sheviis: 'שביעית',
         terumos: 'תרומות',
         maasros: 'מעשרות',
-        maaser_sheni: 'מעזר שני',
+        maaser_sheni: 'מעשר שני',
         chalah: 'חלה',
         orlah: 'ערלה',
         bikurim: 'בכורים',
@@ -121,7 +124,7 @@ module Zmanim::Limudim
         taharos: 'טהרות',
         mikvaos: 'מקואות',
         niddah: 'נדה',
-        machshirim: 'מכשירין',
+        machshirin: 'מכשירין',
         zavim: 'זבים',
         tevul_yom: 'טבול יום',
         yadayim: 'ידים',
@@ -135,6 +138,7 @@ module Zmanim::Limudim
     end
 
     def format_parsha(limud)
+      return '' unless limud && limud.unit
       prefix = hebrew_format ? 'פרשת ' : 'Parshas '
       prefix + limud.unit.render do |parsha|
         hebrew_format ? PARSHIYOS[parsha] : titleize(parsha)
@@ -159,6 +163,12 @@ module Zmanim::Limudim
       prefix + limud.unit.render {|e| format_number(e) }
     end
 
+    def format_avos(limud)
+      return '' unless unit = (limud && limud.unit)
+      prefix = hebrew_format ? 'פרקי אבות ' : 'Pirkei Avos '
+      prefix + unit.render {|e| format_number(e) }
+    end
+
     private
 
     def format_number(number)

data/lib/zmanim/version.rb

@@ -1,3 +1,3 @@
 module Zmanim
-  VERSION = "0.1.0"
+  VERSION = "0.4.0"
 end

data/lib/zmanim/zmanim_calendar.rb

@@ -1,6 +1,10 @@
+require_relative 'astronomical_calendar'
+require_relative 'hebrew_calendar/jewish_calendar'
+
 module Zmanim
   class ZmanimCalendar < AstronomicalCalendar
     attr_accessor :candle_lighting_offset
+    attr_writer :use_elevation
 
     ZENITH_16_POINT_1 = GEOMETRIC_ZENITH + 16.1
     ZENITH_8_POINT_5 = GEOMETRIC_ZENITH + 8.5
@@ -8,11 +12,31 @@ module Zmanim
     def initialize(opts={})
       super
       @candle_lighting_offset = opts[:candle_lighting_offset] || 18
+      @use_elevation = false
+    end
+
+    def use_elevation?
+      !!@use_elevation
+    end
+
+    def elevation_adjusted_sunrise
+      use_elevation? ? sunrise : sea_level_sunrise
+    end
+    alias_method :hanetz, :elevation_adjusted_sunrise
+
+    def elevation_adjusted_sunset
+      use_elevation? ? sunset : sea_level_sunset
     end
+    alias_method :shkia, :elevation_adjusted_sunset
 
     def tzais(opts={degrees: 8.5})
-      degrees, offset = extract_degrees_offset(opts)
-      offset_by_minutes(sunset_offset_by_degrees(GEOMETRIC_ZENITH + degrees), offset)
+      degrees, offset, zmanis_offset = extract_degrees_offset(opts)
+      sunset_for_degrees = degrees == 0 ? elevation_adjusted_sunset : sunset_offset_by_degrees(GEOMETRIC_ZENITH + degrees)
+      if zmanis_offset != 0
+        offset_by_minutes_zmanis(sunset_for_degrees, zmanis_offset)
+      else
+        offset_by_minutes(sunset_for_degrees, offset)
+      end
     end
 
     def tzais_72
@@ -20,12 +44,17 @@ module Zmanim
     end
 
     def alos(opts={degrees: 16.1})
-      degrees, offset = extract_degrees_offset(opts)
-      offset_by_minutes(sunrise_offset_by_degrees(GEOMETRIC_ZENITH + degrees), offset)
+      degrees, offset, zmanis_offset = extract_degrees_offset(opts)
+      sunrise_for_degrees = degrees == 0 ? elevation_adjusted_sunrise : sunrise_offset_by_degrees(GEOMETRIC_ZENITH + degrees)
+      if zmanis_offset != 0
+        offset_by_minutes_zmanis(sunrise_for_degrees, -zmanis_offset)
+      else
+        offset_by_minutes(sunrise_for_degrees, -offset)
+      end
     end
 
     def alos_72
-      alos(offset: -72)
+      alos(offset: 72)
     end
 
     alias_method :chatzos, :sun_transit
@@ -35,7 +64,7 @@ module Zmanim
     end
 
     def sof_zman_shma_gra
-      sof_zman_shma(sea_level_sunrise, sea_level_sunset)
+      sof_zman_shma(elevation_adjusted_sunrise, elevation_adjusted_sunset)
     end
 
     def sof_zman_shma_mga
@@ -51,22 +80,22 @@ module Zmanim
     end
 
     def sof_zman_tfila_gra
-      sof_zman_tfila(sea_level_sunrise, sea_level_sunset)
+      sof_zman_tfila(elevation_adjusted_sunrise, elevation_adjusted_sunset)
     end
 
     def sof_zman_tfila_mga
       sof_zman_tfila(alos_72, tzais_72)
     end
 
-    def mincha_gedola(day_start=sea_level_sunrise, day_end=sea_level_sunset)
+    def mincha_gedola(day_start=elevation_adjusted_sunrise, day_end=elevation_adjusted_sunset)
       shaos_into_day(day_start, day_end, 6.5)
     end
 
-    def mincha_ketana(day_start=sea_level_sunrise, day_end=sea_level_sunset)
+    def mincha_ketana(day_start=elevation_adjusted_sunrise, day_end=elevation_adjusted_sunset)
       shaos_into_day(day_start, day_end, 9.5)
     end
 
-    def plag_hamincha(day_start=sea_level_sunrise, day_end=sea_level_sunset)
+    def plag_hamincha(day_start=elevation_adjusted_sunrise, day_end=elevation_adjusted_sunset)
       shaos_into_day(day_start, day_end, 10.75)
     end
 
@@ -75,7 +104,7 @@ module Zmanim
     end
 
     def shaah_zmanis_gra
-      shaah_zmanis(sea_level_sunrise, sea_level_sunset)
+      shaah_zmanis(elevation_adjusted_sunrise, elevation_adjusted_sunset)
     end
 
     def shaah_zmanis_mga
@@ -84,7 +113,15 @@ module Zmanim
 
     def shaah_zmanis_by_degrees_and_offset(degrees, offset)
       opts = {degrees: degrees, offset: offset}
-      shaah_zmanis(alos(opts.merge(offset: -offset)), tzais(opts))
+      shaah_zmanis(alos(opts), tzais(opts))
+    end
+
+    def assur_bemelacha?(current_time, tzais: tzais(), in_israel: false)
+      tzais_time = tzais.is_a?(Hash) ? self.tzais(tzais) : tzais
+      jewish_calendar = HebrewCalendar::JewishCalendar.new(current_time.to_date)
+      jewish_calendar.in_israel = in_israel
+      (current_time.to_datetime <= tzais_time && jewish_calendar.assur_bemelacha?) ||
+          (current_time.to_datetime >= elevation_adjusted_sunset && jewish_calendar.tomorrow_assur_bemelacha?)
     end
 
     private
@@ -95,12 +132,18 @@ module Zmanim
     end
 
     def extract_degrees_offset(opts)
-      [opts[:degrees] || 0.0, opts[:offset] || 0]
+      [opts[:degrees] || 0.0, opts[:offset] || 0, opts[:zmanis_offset] || 0]
     end
 
     def offset_by_minutes(time, minutes)
       return unless time
       time + (minutes / (60 * 24).to_f)
     end
+
+    def offset_by_minutes_zmanis(time, minutes)
+      return unless time
+      shaah_zmanis_skew = shaah_zmanis_gra / HOUR_MILLIS
+      time + (minutes * shaah_zmanis_skew / (60 * 24).to_f)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zmanim
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Pinny Markowitz
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-01-09 00:00:00.000000000 Z
+date: 2020-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -104,10 +105,12 @@ files:
 - lib/zmanim/limudim/anchor/day_of_month_anchor.rb
 - lib/zmanim/limudim/anchor/day_of_week_anchor.rb
 - lib/zmanim/limudim/anchor/day_of_year_anchor.rb
+- lib/zmanim/limudim/calculators/daf_hashavua_bavli.rb
 - lib/zmanim/limudim/calculators/daf_yomi_bavli.rb
 - lib/zmanim/limudim/calculators/daf_yomi_yerushalmi.rb
 - lib/zmanim/limudim/calculators/mishna_yomis.rb
 - lib/zmanim/limudim/calculators/parsha.rb
+- lib/zmanim/limudim/calculators/pirkei_avos.rb
 - lib/zmanim/limudim/calculators/tehillim_monthly.rb
 - lib/zmanim/limudim/cycle.rb
 - lib/zmanim/limudim/interval.rb
@@ -130,7 +133,7 @@ homepage: https://github.com/pinnymz/ruby-zmanim
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -145,9 +148,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A Zmanim library for Ruby
 test_files: []