zmanim 0.1.0

data/lib/zmanim/limudim/anchor/day_of_month_anchor.rb

@@ -0,0 +1,49 @@
+module Zmanim::Limudim::Anchor
+  class DayOfMonthAnchor
+    attr_reader :day
+    def initialize(day)
+      @day = day
+    end
+
+    def next_occurrence(jewish_date)
+      occurrence = Zmanim::HebrewCalendar::JewishDate.new(jewish_date.jewish_year, jewish_date.jewish_month, day)
+      increment_month(occurrence) if occurrence <= jewish_date
+      occurrence
+    end
+
+    def previous_occurrence(jewish_date)
+      occurrence = Zmanim::HebrewCalendar::JewishDate.new(jewish_date.jewish_year, jewish_date.jewish_month, day)
+      decrement_month(occurrence) if occurrence >= jewish_date
+      occurrence
+    end
+
+    def current_or_previous_occurrence(jewish_date)
+      occurrence = Zmanim::HebrewCalendar::JewishDate.new(jewish_date.jewish_year, jewish_date.jewish_month, day)
+      decrement_month(occurrence) if occurrence > jewish_date
+      occurrence
+    end
+
+    private
+
+    def increment_month(jewish_date)
+      if jewish_date.jewish_month == jewish_date.months_in_jewish_year
+        jewish_date.jewish_month = 1
+      elsif jewish_date.jewish_month == 6
+        jewish_date.forward!(29)
+      else
+        jewish_date.jewish_month += 1
+      end
+    end
+
+    def decrement_month(jewish_date)
+      if jewish_date.jewish_month == 1
+        jewish_date.jewish_month = jewish_date.months_in_jewish_year
+      elsif jewish_date.jewish_month == 7
+        back_days = jewish_date.jewish_day == 30 ? 30 : 29
+        jewish_date.back!(back_days)
+      else
+        jewish_date.jewish_month -= 1
+      end
+    end
+  end
+end

data/lib/zmanim/limudim/anchor/day_of_week_anchor.rb

@@ -0,0 +1,26 @@
+module Zmanim::Limudim::Anchor
+  class DayOfWeekAnchor
+    attr_reader :day_of_week
+    def initialize(day_of_week)
+      @day_of_week = day_of_week
+    end
+
+    def next_occurrence(date)
+      offset = day_of_week - date.day_of_week
+      offset += 7 if offset <= 0
+      date + offset
+    end
+
+    def previous_occurrence(date)
+      offset = day_of_week - date.day_of_week
+      offset -= 7 if offset >= 0
+      date + offset
+    end
+
+    def current_or_previous_occurrence(date)
+      offset = day_of_week - date.day_of_week
+      offset -= 7 if offset > 0
+      date + offset
+    end
+  end
+end

data/lib/zmanim/limudim/anchor/day_of_year_anchor.rb

@@ -0,0 +1,27 @@
+module Zmanim::Limudim::Anchor
+  class DayOfYearAnchor
+    attr_reader :month, :day
+    def initialize(month, day)
+      @month = month
+      @day = day
+    end
+
+    def next_occurrence(jewish_date)
+      occurrence = Zmanim::HebrewCalendar::JewishDate.new(jewish_date.jewish_year, month, day)
+      occurrence.jewish_year += 1 if occurrence <= jewish_date
+      occurrence
+    end
+
+    def previous_occurrence(jewish_date)
+      occurrence = Zmanim::HebrewCalendar::JewishDate.new(jewish_date.jewish_year, month, day)
+      occurrence.jewish_year -= 1 if occurrence >= jewish_date
+      occurrence
+    end
+
+    def current_or_previous_occurrence(jewish_date)
+      occurrence = Zmanim::HebrewCalendar::JewishDate.new(jewish_date.jewish_year, month, day)
+      occurrence.jewish_year -= 1 if occurrence > jewish_date
+      occurrence
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+require 'zmanim/limudim/limud_calculator'
+
+module Zmanim::Limudim::Calculators
+  class DafYomiBavli
+    include Zmanim::Limudim::LimudCalculator
+
+    def initial_cycle_date
+      jewish_date(Date.parse('1923-09-11'))
+    end
+
+    def default_starting_page
+      2
+    end
+
+    def starting_page(units, unit_name)
+      case units.keys.index(unit_name.to_sym)
+        when 36
+          23
+        when 37
+          26
+        when 38
+          34
+        else
+          default_starting_page
+      end
+    end
+
+    def default_units
+      { berachos: 64, shabbos: 157, eruvin: 105, pesachim: 121, shekalim: 22, yoma: 88, sukkah: 56, beitzah: 40, rosh_hashanah: 35,
+        taanis: 31, megillah: 32, moed_katan: 29, chagigah: 27, yevamos: 122, kesubos: 112, nedarim: 91, nazir: 66, sotah: 49,
+        gitin: 90, kiddushin: 82, bava_kamma: 119, bava_metzia: 119, bava_basra: 176, sanhedrin: 113, makkos: 24, shevuos: 49,
+        avodah_zarah: 76, horiyos: 14, zevachim: 120, menachos: 110, chullin: 142, bechoros: 61, arachin: 34, temurah: 34,
+        kerisos: 28, meilah: 22, kinnim: 25, tamid: 33, midos: 37, niddah: 73 }
+    end
+
+    def cycle_end_calculation
+      ->(start_date, iteration) do
+        duration = iteration < 8 ? 2702 : 2711
+        start_date + (duration - 1)
+      end
+    end
+
+    def cycle_units_calculation
+      ->(cycle) do
+        if cycle.iteration < 8
+          default_units.merge(shekalim: 13)
+        else
+          default_units
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+require 'zmanim/limudim/limud_calculator'
+
+module Zmanim::Limudim::Calculators
+  class DafYomiYerushalmi
+    include Zmanim::Limudim::LimudCalculator
+
+    def initial_cycle_date
+      jewish_date(Date.parse('1980-02-02'))
+    end
+
+    def default_units
+      { berachos: 68, peah: 37, demai: 34, kilayim: 44, shviis: 31, terumos: 59, maasros: 26, maaser_sheni: 33,
+        chalah: 28, orlah: 20, bikurim: 13, shabbos: 92, eruvin: 65, pesachim: 71, beitzah: 22, rosh_hashanah: 22,
+        yoma: 42, sukkah: 26, taanis: 26, shekalim: 33, megilah: 34, chagigah: 22, moed_katan: 19, yevamos: 85,
+        kesubos: 72, sotah: 47, nedarim: 40, nazir: 47, gitin: 54, kiddushin: 48, bava_kama: 44, bava_metzia: 37,
+        bava_basra: 34, sanhedrin: 44, makos: 9, shevuos: 57, avodah_zarah: 37, horayos: 19, niddah: 13 }
+    end
+
+    def cycle_end_calculation
+      ->(start_date, iteration) do
+        end_date = start_date + (1554 - 1)
+        found_skips_between = ->(a, b) do
+          (a.jewish_year..b.jewish_year).sum do |year|
+            skip_days.count do |m, d|
+              Zmanim::HebrewCalendar::JewishDate.new(year, m, d).between?(a,b)
+            end
+          end
+        end
+        while (found_days = found_skips_between.(start_date, end_date)) > 0 do
+          start_date, end_date = end_date + 1, end_date + found_days
+        end
+        end_date
+      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
+    end
+
+    def skip_interval?(interval)
+      matches_skip_day?(interval.start_date)
+    end
+
+    private
+
+    def matches_skip_day?(date)
+      skip_days.any?{|m, d| date.jewish_month == m && date.jewish_day == d}
+    end
+
+    def skip_days
+      [[5, 9], [7, 10]]
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+require 'zmanim/limudim/limud_calculator'
+
+module Zmanim::Limudim::Calculators
+  class MishnaYomis
+    include Zmanim::Limudim::LimudCalculator
+
+    def initial_cycle_date
+      jewish_date(Date.parse('1947-05-20'))
+    end
+
+    def unit_step
+      2
+    end
+
+    # formatted as `{maseches => {perek => mishna_count, ...}, ... }`
+    def default_units
+      self.class.default_units
+    end
+
+    def cycle_end_calculation
+      ->(start_date, iteration) do
+        start_date + ((4192/2) - 1)
+      end
+    end
+
+    def self.default_units
+      @default_units ||= Hash[
+          { berachos: [5,8,6,7,5,8,5,8,5], peah: [6,8,8,11,8,11,8,9], demai: [4,5,6,7,11,12,8], kilayim: [9,11,7,9,8,9,8,6,10],
+            sheviis: [8,10,10,10,9,6,7,11,9,9], terumos: [10,6,9,13,9,6,7,12,7,12,10], maasros: [8,8,10,6,8], maaser_sheni: [7,10,13,12,15],
+            chalah: [9,8,10,11], orlah: [9,17,9], bikurim: [11,11,12,5], shabbos: [11,7,6,2,4,10,4,7,7,6,6,6,7,4,3,8,8,3,6,5,3,6,5,5],
+            eruvin: [10,6,9,11,9,10,11,11,4,15], pesachim: [7,8,8,9,10,6,13,8,11,9], shekalim: [7,5,4,9,6,6,7,8], yoma: [8,7,11,6,7,8,5,9],
+            sukkah: [11,9,15,10,8], beitzah: [10,10,8,7,7], rosh_hashanah: [9,8,9,9], taanis: [7,10,9,8], megillah: [11,6,6,10],
+            moed_katan: [10,5,9], chagigah: [8,7,8], yevamos: [4,10,10,13,6,6,6,6,6,9,7,6,13,9,10,7], kesubos: [10,10,9,12,9,7,10,8,9,6,6,4,11],
+            nedarim: [4,5,11,8,6,10,9,7,10,8,12], nazir: [7,10,7,7,7,11,4,2,5], sotah: [9,6,8,5,5,4,8,7,15], gitin: [6,7,8,9,9,7,9,10,10],
+            kiddushin: [10,10,13,14], bava_kamma: [4,6,11,9,7,6,7,7,12,10], bava_metzia: [8,11,12,12,11,8,11,9,13,6],
+            bava_basra: [6,14,8,9,11,8,4,8,10,8], sanhedrin: [6,5,8,5,5,6,11,7,6,6,6], makkos: [10,8,16], shevuos: [7,5,11,13,5,7,8,6],
+            eduyos: [14,10,12,12,7,3,9,7], avodah_zarah: [9,7,10,12,12], avos: [18,16,18,22,23,11], horiyos: [5,7,8],
+            zevachim: [4,5,6,6,8,7,6,12,7,8,8,6,8,10], menachos: [4,5,7,5,9,7,6,7,9,9,9,5,11], chullin: [7,10,7,7,5,7,6,6,8,4,2,5],
+            bechoros: [7,9,4,10,6,12,7,10,8], arachin: [4,6,5,4,6,5,5,7,8], temurah: [6,3,5,4,6,5,6], kerisos: [7,6,10,3,8,9],
+            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],
+            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
+  end
+end

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

@@ -0,0 +1,91 @@
+require 'zmanim/limudim/limud_calculator'
+
+module Zmanim::Limudim::Calculators
+  class Parsha
+    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(7, in_israel ? 23 : 24)
+    end
+
+    def default_units
+      %i(bereishis noach lech_lecha vayeira chayei_sarah toldos vayeitzei vayishlach vayeishev mikeitz vayigash vayechi
+         shemos vaeirah bo beshalach yisro mishpatim terumah tetzaveh ki_sisa vayakheil pekudei
+         vayikra tzav shemini tazria metzora acharei kedoshim emor behar bechukosai
+         bamidbar naso behaalosecha shelach korach chukas balak pinchas matos masei
+         devarim vaeschanan eikev reei shoftim ki_seitzei ki_savo nitzavim vayeilech haazinu vezos_haberacha)
+    end
+
+    def cycle_end_calculation
+      ->(start_date, iteration) do
+        perpetual_cycle_anchor.next_occurrence(start_date) - 1
+      end
+    end
+
+    def interval_end_calculation
+      ->(cycle, start_date) do
+        skips = in_israel ?
+                        [[1, (15..21)], [3, [6]], [7, [1,2,10] + (15..21).to_a]] :
+                        [[1, (15..22)], [3, [6,7]], [7, [1,2,10] + (15..22).to_a]]
+        end_date = start_date + (7 - start_date.day_of_week)
+        while skips.detect{|month, days| month == end_date.jewish_month && days.include?(end_date.jewish_day) } do
+          end_date += 7
+        end
+        end_date > cycle.end_date ? cycle.end_date : end_date
+      end
+    end
+
+    def cycle_units_calculation
+      ->(cycle) do
+        kviah = Zmanim::HebrewCalendar::HebrewDateFormatter.new.format_kviah(cycle.start_date.jewish_year)
+        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] :
+                         {
+                             'בחה' => [%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]
+        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]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require 'zmanim/limudim/limud_calculator'
+
+module Zmanim::Limudim::Calculators
+  class TehillimMonthly
+    include Zmanim::Limudim::LimudCalculator
+
+    def tiered_units?
+      false
+    end
+
+    def perpetual_cycle_anchor
+      Zmanim::Limudim::Anchor::DayOfMonthAnchor.new(1)
+    end
+
+    def default_units
+      [9,17,22,28,34,38,43,48,54,59,65,68,71,76,78,82,87,89,96,103,105,
+       107,112,118,119,119,134,139,144,150]
+    end
+
+    def cycle_end_calculation
+      ->(start_date, iteration) do
+        perpetual_cycle_anchor.next_occurrence(start_date) - 1
+      end
+    end
+
+    def unit_for_interval(units, interval)
+      start, stop = case interval.iteration
+        when 1
+          [1, units[interval.iteration - 1]]
+        when 25
+          [[119, 1], [119, 30]]
+        when 26
+          [[119, 40], [119, 400]]
+        else
+          [units[interval.iteration - 2] + 1, units[interval.iteration - 1]]
+      end
+      if interval.end_date.jewish_day == 29 && interval.end_date.days_in_jewish_month == 29
+        stop = units[interval.iteration]
+      end
+      Zmanim::Limudim::Unit.new(start, stop)
+    end
+  end
+end

data/lib/zmanim/limudim/cycle.rb

@@ -0,0 +1,40 @@
+module Zmanim::Limudim
+  class Cycle
+    attr_reader :start_date, :end_date, :iteration
+
+    def initialize(start_date, end_date, iteration)
+      @start_date = start_date
+      @end_date = end_date
+      @iteration = iteration
+    end
+
+    def self.from_perpetual_anchor(anchor, cycle_end_calculation, date)
+      start_date = anchor.current_or_previous_occurrence(date)
+      end_date = cycle_end_calculation.(start_date, nil)
+      Cycle.new(start_date, end_date, nil)
+    end
+
+    def self.from_cycle_initiation(initial_cycle_date, cycle_end_calculation, date)
+      return nil if initial_cycle_date > date
+      iteration = 1
+      end_date = cycle_end_calculation.(initial_cycle_date, iteration)
+      cycle = Cycle.new(initial_cycle_date, end_date, iteration)
+      while date > cycle.end_date
+        cycle = cycle.next(cycle_end_calculation)
+      end
+      cycle
+    end
+
+    def next(cycle_end_calculation)
+      return nil unless iteration
+      new_iteration = iteration + 1
+      new_start_date = end_date + 1
+      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/interval.rb

@@ -0,0 +1,37 @@
+module Zmanim::Limudim
+  class Interval
+    attr_reader :start_date, :end_date, :iteration, :cycle
+
+    def initialize(start_date, end_date, iteration, cycle)
+      @start_date = start_date
+      @end_date = end_date
+      @iteration = iteration
+      @cycle = cycle
+    end
+
+    def self.first_for_cycle(cycle, interval_end_calculation)
+      start_date = cycle.start_date
+      iteration = 1
+      end_date = interval_end_calculation.(cycle, start_date)
+      Interval.new(start_date, end_date, iteration, cycle)
+    end
+
+    def next(interval_end_calculation)
+      next_for_iteration(iteration+1, interval_end_calculation)
+    end
+
+    def skip(interval_end_calculation)
+      next_for_iteration(iteration, interval_end_calculation)
+    end
+
+    private
+
+    def next_for_iteration(new_iteration, interval_end_calculation)
+      return nil if end_date >= cycle.end_date    # paranoid check to remain in cycle bounds
+      new_start_date = end_date + 1
+      new_end_date = interval_end_calculation.(cycle, new_start_date)
+      Interval.new(new_start_date, new_end_date, new_iteration, cycle)
+    end
+
+  end
+end