zmanim 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca99f24408a8ee9ef58732e6d92aa20150ec680b
-  data.tar.gz: eb8a70763999f4f75e72baa42f31fca8e702e1a1
+  metadata.gz: 34f16334bc5be809d6cfb0cfd526c90256d5eb34
+  data.tar.gz: 6e94981da77ece13e27c9bca543b272da20a0d54
 SHA512:
-  metadata.gz: '038a38a4022840534376573885d933b14d36693b995b0676cd2489ca9ce413ab7fced22635ba82a6cffda49e551d5a350963261f4536c5e916e8321a30f064f9'
-  data.tar.gz: db91a82beb8aab922ef8c055545397b04e6c07bb53e70430939843206cb7baef1c318c4f7ec71dd448ceb2ea6d430137f8ed5974cae68604b0312753118dab61
+  metadata.gz: 49f97be4628c3b48d1fecbce00a8d14b47e89d0f8950dfd84412c6e3ba172ed398f8ed30b8a8bd3ec28862750fc70d63dae8e571ec563a00fe517cf3d617288f
+  data.tar.gz: e4013fada5d08005b6e4206844d43df41dfba2b062e7d1a2e70819b48fc0552d9cec419e84b0ac3c8c8fe634f065f06f25be70ae1a78c5cd470f4b186435a502

data/CHANGELOG.md

@@ -4,6 +4,16 @@ 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.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

data/lib/zmanim/hebrew_calendar/jewish_calendar.rb

@@ -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
@@ -191,6 +221,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
@@ -217,12 +253,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?
@@ -390,5 +432,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/version.rb

@@ -1,3 +1,3 @@
 module Zmanim
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/zmanim/zmanim_calendar.rb

@@ -1,8 +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
@@ -10,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
@@ -22,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
@@ -37,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
@@ -53,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
 
@@ -77,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
@@ -86,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
@@ -97,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(elevation_adjusted_sunrise, elevation_adjusted_sunset) / 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.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Pinny Markowitz
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2018-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo