astronoby 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c65785b0c459ba8add86fcceb906205caa79a80f47b7f33c0b7ee008173fd14
-  data.tar.gz: 66478c6055d84e34f560490f225ae3e3d5020972e729b37e8f6f0a6566ae173e
+  metadata.gz: 43ef390a6ab6a498edbf148b2af44c906daf73ff9ba61b5aafeadd828fb550e4
+  data.tar.gz: b2cf0743676aa49f95f24c62b3d5d759553014bc52114260a71ecedfb9e6c1cb
 SHA512:
-  metadata.gz: 4bae651aabaec62d258a768952eb3cd830d99639acf33f02b9f0ab6fd2eeff8215d9a30087a5818736b777c1a86344918f98f33f987f65829a8712cb20477c55
-  data.tar.gz: 401659e2d49599246ad2ea1a455a6d60b9797c49e730cacf8a614f4235929263c9318644373a96ea496969fcb814cc93144a8dbfffd0a0318e1628500bb1c8e8
+  metadata.gz: 052bfebf4ddaf6ef3f24883fec090a831d38a9e4124dd5f561d6b1dd7074b6385502396edddd5496ab6066ff93acab4f220ec3aaa244ad0638c0b65fbaace55f
+  data.tar.gz: fe37ac2714328893b068ba958e37a3b057a76ddfa1b299a35f22be005687d3168d20e98ebe571db519bd6cf69227cc0f0dc4c0889dd9ca5bb9d1abb2b1ee550d

data/CHANGELOG.md

@@ -1,5 +1,65 @@
 # Changelog
 
+## 0.5.0 - 2024-06-11
+
+_If you are upgrading: please see [UPGRADING.md]._
+
+[UPGRADING.md]: https://github.com/rhannequin/astronoby/blob/main/UPGRADING.md
+
+### Features
+
+* Make `Sun#mean_anomaly` public ([#72])
+* Moon ecliptic coordinates ([#73])
+* Moon apparent geocentric equatorial coordinates ([#75])
+* Moon horizontal coordinates ([#76])
+* Assume Moon's equatorial coordinates are geocentric ([#77])
+* Use observer object for geocentric parallax ([#79])
+* Moon's phase angle and illuminated fraction ([#80])
+* Monthly Moon phases ([#82])
+* Rationalize negative degree angles ([#83])
+* Factorize Moon phases periodic terms ([#85])
+* Introduce observation events for Moon ([#86])
+
+[#72]: https://github.com/rhannequin/astronoby/pull/72
+[#73]: https://github.com/rhannequin/astronoby/pull/73
+[#75]: https://github.com/rhannequin/astronoby/pull/75
+[#76]: https://github.com/rhannequin/astronoby/pull/76
+[#77]: https://github.com/rhannequin/astronoby/pull/77
+[#79]: https://github.com/rhannequin/astronoby/pull/79
+[#80]: https://github.com/rhannequin/astronoby/pull/80
+[#82]: https://github.com/rhannequin/astronoby/pull/82
+[#83]: https://github.com/rhannequin/astronoby/pull/83
+[#85]: https://github.com/rhannequin/astronoby/pull/85
+[#86]: https://github.com/rhannequin/astronoby/pull/86
+
+### Improvements
+
+* Create FUNDING.yml ([#70])
+* Bump standard from 1.35.1 to 1.36.0 ([#71])
+* Bump rexml from 3.2.6 to 3.2.8 ([#74])
+* Expand the number of tested Ruby versions ([#84])
+* Add Ruby 3.1.6 and 3.3.2 coverage ([#88])
+* Improve and update documentation ([#87])
+* Update UPGRADING.md ([#89])
+
+[#70]: https://github.com/rhannequin/astronoby/pull/70
+[#71]: https://github.com/rhannequin/astronoby/pull/71
+[#74]: https://github.com/rhannequin/astronoby/pull/74
+[#84]: https://github.com/rhannequin/astronoby/pull/84
+[#88]: https://github.com/rhannequin/astronoby/pull/88
+[#87]: https://github.com/rhannequin/astronoby/pull/87
+[#89]: https://github.com/rhannequin/astronoby/pull/89
+
+### Backward-incompatible changes
+
+* Use Observer in Horizontal coordinates ([#69])
+* Introduce `Astronoby::Distance` value object ([#78])
+
+[#69]: https://github.com/rhannequin/astronoby/pull/69
+[#78]: https://github.com/rhannequin/astronoby/pull/78
+
+**Full Changelog**: https://github.com/rhannequin/astronoby/compare/v0.4.0...v0.5.0
+
 ## 0.4.0 - 2024-04-29
 
 _If you are upgrading: please see [UPGRADING.md]._

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    astronoby (0.4.0)
+    astronoby (0.5.0)
       matrix (~> 0.4.2)
       rake (~> 13.0)
       rspec (~> 3.0)
@@ -11,19 +11,20 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.1)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
     matrix (0.4.2)
     parallel (1.24.0)
-    parser (3.3.0.5)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.2.1)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
+    regexp_parser (2.9.1)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -37,7 +38,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.62.1)
+    rubocop (1.63.5)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -48,24 +49,25 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.2)
-      parser (>= 3.3.0.4)
-    rubocop-performance (1.20.2)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.0)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     ruby-progressbar (1.13.0)
-    standard (1.35.1)
+    standard (1.36.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.62.0)
+      rubocop (~> 1.63.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
+      standard-performance (~> 1.4)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.3.1)
+    standard-performance (1.4.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
+      rubocop-performance (~> 1.21.0)
+    strscan (3.1.0)
     unicode-display_width (2.5.0)
 
 PLATFORMS

data/README.md

@@ -11,6 +11,27 @@ The main reference is:
 - _Practical Astronomy with your Calculator or Spreadsheet_ by Peter
   Duffet-Smith and Jonathan Zwart
 
+## Content
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Angle manipulation](#angle-manipulation)
+  - [Coordinates conversion](#coordinates-conversion)
+  - [Sun](#sun)
+    - [Sun's location in the sky](#suns-location-in-the-sky)
+    - [Sunrise and sunset times and azimuths](#sunrise-and-sunset-times-and-azimuths)
+    - [Twilight times](#twilight-times)
+  - [Solstice and Equinox times](#solstice-and-equinox-times)
+  - [Moon](#moon)
+    - [Moon's location in the sky](#moons-location-in-the-sky)
+    - [Moon's current attributes](#moons-current-attributes)
+    - [Moon's phases of the month](#moons-phases-of-the-month)
+    - [Moonrise and moonset times and azimuths](#moonrise-and-moonset-times-and-azimuths)
+- [Precision](#precision)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -46,9 +67,35 @@ angle.cos
 # => 1.0
 ```
 
+### Distance manipulation
+
+```rb
+distance1 = Astronoby::Distance.from_astronomical_units(1)
+distance2 = Astronoby::Distance.from_kilometers(149_597_870.7)
+distance3 = Astronoby::Distance.from_meters(300)
+
+distance1 == distance2
+# => true
+
+distance1 > distance3
+# => true
+
+distance =
+  Astronoby::Distance.from_m(300) +
+  Astronoby::Distance.from_km(3)
+
+distance.km
+# => 3.3
+```
+
 ### Coordinates conversion
 
 ```rb
+observer = Astronoby::Observer.new(
+  latitude: Astronoby::Angle.from_degrees(38),
+  longitude: Astronoby::Angle.from_degrees(-78)
+)
+
 equatorial = Astronoby::Coordinates::Equatorial.new(
   right_ascension: Astronoby::Angle.from_hms(17, 43, 54),
   declination: Astronoby::Angle.from_dms(-22, 10, 0)
@@ -56,8 +103,7 @@ equatorial = Astronoby::Coordinates::Equatorial.new(
 
 horizontal = equatorial.to_horizontal(
   time: Time.new(2016, 1, 21, 21, 30, 0, "-05:00"),
-  latitude: Astronoby::Angle.from_degrees(38),
-  longitude: Astronoby::Angle.from_degrees(-78)
+  observer: observer
 )
 
 horizontal.altitude.str(:dms)
@@ -67,19 +113,22 @@ horizontal.azimuth.str(:dms)
 # => "+341° 33′ 21.587″"
 ```
 
-### Sun's location in the sky
+### Sun
+
+#### Sun's location in the sky
 
 ```rb
 time = Time.utc(2023, 2, 17, 11, 0, 0)
 
-latitude = Astronoby::Angle.from_degrees(48.8566)
-longitude = Astronoby::Angle.from_degrees(2.3522)
+observer = Astronoby::Observer.new(
+  latitude: Astronoby::Angle.from_degrees(48.8566),
+  longitude: Astronoby::Angle.from_degrees(2.3522)
+)
 
 sun = Astronoby::Sun.new(time: time)
 
 horizontal_coordinates = sun.horizontal_coordinates(
-  latitude: latitude,
-  longitude: longitude
+  observer: observer
 )
 
 horizontal_coordinates.altitude.degrees
@@ -89,7 +138,7 @@ horizontal_coordinates.altitude.str(:dms)
 # => "+27° 30′ 0.2966″"
 ```
 
-### Sunrise and sunset times and azimuths
+#### Sunrise and sunset times and azimuths
 
 ```rb
 time = Time.new(2015, 2, 5)
@@ -104,22 +153,22 @@ observation_events.rising_time
 # => 2015-02-05 12:12:59 UTC
 
 observation_events.rising_azimuth.str(:dms)
-# => "+109° 46′ 43.145″"
+# => "+109° 29′ 34.3674″"
 
 observation_events.transit_time
 # => 2015-02-05 17:25:59 UTC
 
 observation_events.transit_altitude.str(:dms)
-# => "+36° 8′ 15.7638″"
+# => "+36° 8′ 15.8197″"
 
 observation_events.setting_time
 # => 2015-02-05 22:39:27 UTC
 
 observation_events.setting_azimuth.str(:dms)
-# => "+250° 23′ 33.614″"
+# => "+250° 40′ 42.8609″"
 ```
 
-### Twilight times
+#### Twilight times
 
 ```rb
 time = Time.new(2024, 1, 1)
@@ -161,6 +210,92 @@ Astronoby::EquinoxSolstice.june_solstice(year)
 # => 2024-06-20 20:50:18 UTC
 ```
 
+### Moon
+
+#### Moon's location in the sky
+
+```rb
+time = Time.utc(2023, 2, 17, 11, 0, 0)
+
+observer = Astronoby::Observer.new(
+  latitude: Astronoby::Angle.from_degrees(48.8566),
+  longitude: Astronoby::Angle.from_degrees(2.3522)
+)
+
+moon = Astronoby::Moon.new(time: time)
+
+horizontal_coordinates = moon.horizontal_coordinates(
+  observer: observer
+)
+
+horizontal_coordinates.altitude.degrees
+# => 10.277834691708053
+
+horizontal_coordinates.altitude.str(:dms)
+# => "+10° 16′ 40.2048″"
+```
+
+#### Moon's current attributes
+
+```rb
+time = Time.utc(2024, 6, 1, 10, 0, 0)
+moon = Astronoby::Moon.new(time: time)
+
+moon.illuminated_fraction.round(2)
+# => 0.31
+
+moon.distance.km.round
+# => 368409
+
+moon.phase_angle.degrees.round
+# => 112
+```
+
+#### Moon's phases of the month
+
+```rb
+june_phases = Astronoby::Moon.monthly_phase_events(
+  year: 2024,
+  month: 6
+)
+
+june_phases.each { puts "#{_1.phase}: #{_1.time}" }
+# new_moon: 2024-06-06 12:37:41 UTC
+# first_quarter: 2024-06-14 05:18:28 UTC
+# full_moon: 2024-06-22 01:07:53 UTC
+# last_quarter: 2024-06-28 21:53:25 UTC
+```
+
+#### Moonrise and moonset times and azimuths
+
+```rb
+time = Time.utc(2024, 6, 1, 10, 0, 0)
+observer = Astronoby::Observer.new(
+  latitude: Astronoby::Angle.from_degrees(48.8566),
+  longitude: Astronoby::Angle.from_degrees(2.3522)
+)
+moon = Astronoby::Moon.new(time: time)
+observation_events = moon.observation_events(observer: observer)
+
+observation_events.rising_time
+# => 2024-06-01 00:35:36 UTC
+
+observation_events.rising_azimuth.str(:dms)
+# => "+93° 7′ 43.2347″"
+
+observation_events.transit_time
+# => 2024-06-01 02:42:43 UTC
+
+observation_events.transit_altitude.str(:dms)
+# => "+26° 59′ 30.9915″"
+
+observation_events.setting_time
+# => 2024-06-01 16:02:26 UTC
+
+observation_events.setting_azimuth.str(:dms)
+# => "+273° 29′ 30.0954″"
+```
+
 ## Precision
 
 The current precision for the Sun's apparent location in the sky, compared 

data/UPGRADING.md

@@ -7,6 +7,54 @@ changes to it as long as a major version has not been released.
 If you are already using Astronoby and wish to follow the changes to its
 public API, please read the upgrading notes for each release.
 
+## Upgrading from 0.4.0 to 0.5.0
+
+### `Sun#horizontal_coordinates` method signature changed ([#69])
+
+`Astronoby::Sun#horizontal_coordinates` expects an `observer`
+(`Astronoby::Observer`) key argument instead of `latitude` and `longitude`
+angles.
+
+[#69]: https://github.com/rhannequin/astronoby/pull/69
+
+### `Sun#distance` now returns an `Astronoby::Distance` ([#78])
+
+[#78]: https://github.com/rhannequin/astronoby/pull/78
+
+### `Coordinates::Equatorial#to_horizontal` method signature changed ([#69])
+
+`Astronoby::Coordinates::Equatorial#to_horizontal` expects an `observer`
+(`Astronoby::Observer`) key argument instead of `latitude` and `longitude`
+angles.
+
+### `Coordinates::Horizontal` constructor and attributes changed ([#69])
+
+`Astronoby::Coordinates::Horizontal::new` now expects an `observer`
+(`Astronoby::Observer`) key argument instead of `latitude` and `longitude`,
+and therefore now exposes `#observer` instead of `#latitude` and `#longitude`.
+
+### `GeocentricParallax#angle` method signature changed ([#78])
+
+`Astronoby::GeocentricParallax#angle`'s key argument `distance` is now
+expected to be an instance of `Astronoby::Distance` instead of a `Numeric`.
+
+### `GeocentricParallax#for_equatorial_coordinates` method signature changed ([#69])
+
+`Astronoby::GeocentricParallax#for_equatorial_coordinates` expects an
+`observer` (`Astronoby::Observer`) key argument instead of `latitude`,
+`longitude` and `elevation`.
+
+### `Observer` constructor changed ([#78])
+
+`Astronoby::Observer::new`'s key argument `distance` is now expected to be
+an instance of `Astronoby::Distance` instead of a `Numeric`.
+
+### `Refraction` methods signatures changed ([#69])
+
+`Astronoby::Refraction`'s constructor doesn't accept the `observer` key
+argument anymore. Therefore, the methods `::angle` and
+`::correct_horizontal_coordinates` neither.
+
 ## Upgrading from 0.3.0 to 0.4.0
 
 ### `Body` class removed ([#50])

data/lib/astronoby/astronomical_models/ephemeride_lunaire_parisienne.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Astronoby
+  class EphemerideLunaireParisienne
+    # Lunar theory: Éphéméride Lunaire Parisienne
+    # By Jean Chapront, Michelle Chapront-Touzé
+    # https://en.wikipedia.org/wiki/Ephemeride_Lunaire_Parisienne
+
+    DEGREES_UNIT = 10**-6
+
+    # @return [Array] Periodic terms for the Moon's longitude and distance
+    def self.periodic_terms_for_moon_longitude_and_distance
+      [
+        [0, 0, 1, 0, 6288774, -20905355],
+        [2, 0, -1, 0, 1274027, -3699111],
+        [2, 0, 0, 0, 658314, -2955968],
+        [0, 0, 2, 0, 213618, -569925],
+        [0, 1, 0, 0, -185116, 48888],
+        [0, 0, 0, 2, -114332, -3149],
+        [2, 0, -2, 0, 58793, 246158],
+        [2, -1, -1, 0, 57066, -152138],
+        [2, 0, 1, 0, 53322, -170733],
+        [2, -1, 0, 0, 45758, -204586],
+        [0, 1, -1, 0, -40923, -129620],
+        [1, 0, 0, 0, -34720, 108743],
+        [0, 1, 1, 0, -30383, 104755],
+        [2, 0, 0, -2, 15327, 10321],
+        [0, 0, 1, 2, -12528, 0],
+        [0, 0, 1, -2, 10980, 79661],
+        [4, 0, -1, 0, 10675, -34782],
+        [0, 0, 3, 0, 10034, -23210],
+        [4, 0, -2, 0, 8548, -21636],
+        [2, 1, -1, 0, -7888, 24208],
+        [2, 1, 0, 0, -6766, 30824],
+        [1, 0, -1, 0, -5163, -8379],
+        [1, 1, 0, 0, 4987, -16675],
+        [2, -1, 1, 0, 4036, -12831],
+        [2, 0, 2, 0, 3994, -10445],
+        [4, 0, 0, 0, 3861, -11650],
+        [2, 0, -3, 0, 3665, 14403],
+        [0, 1, -2, 0, -2689, -7003],
+        [2, 0, -1, 2, -2602, 0],
+        [2, -1, -2, 0, 2390, 10056],
+        [1, 0, 1, 0, -2348, 6322],
+        [2, -2, 0, 0, 2236, -9884],
+        [0, 1, 2, 0, -2120, 5751],
+        [0, 2, 0, 0, -2069, 0],
+        [2, -2, -1, 0, 2048, -4950],
+        [2, 0, 1, -2, -1773, 4130],
+        [2, 0, 0, 2, -1595, 0],
+        [4, -1, -1, 0, 1215, -3958],
+        [0, 0, 2, 2, -1110, 0],
+        [3, 0, -1, 0, -892, 3258],
+        [2, 1, 1, 0, -810, 2616],
+        [4, -1, -2, 0, 759, -1897],
+        [0, 2, -1, 0, -713, -2117],
+        [2, 2, -1, 0, -700, 2354],
+        [2, 1, -2, 0, 691, 0],
+        [2, -1, 0, -2, 596, 0],
+        [4, 0, 1, 0, 549, -1423],
+        [0, 0, 4, 0, 537, -1117],
+        [4, -1, 0, 0, 520, -1571],
+        [1, 0, -2, 0, -487, -1739],
+        [2, 1, 0, -2, -399, 0],
+        [0, 0, 2, -2, -381, -4421],
+        [1, 1, 1, 0, 351, 0],
+        [3, 0, -2, 0, -340, 0],
+        [4, 0, -3, 0, 330, 0],
+        [2, -1, 2, 0, 327, 0],
+        [0, 2, 1, 0, -323, 1165],
+        [1, 1, -1, 0, 299, 0],
+        [2, 0, 3, 0, 294, 0],
+        [2, 0, -1, -2, 0, 8752]
+      ]
+    end
+
+    # @return [Array] Periodic terms for the Moon's latitude
+    def self.periodic_terms_for_moon_latitude
+      [
+        [0, 0, 0, 1, 5128122],
+        [0, 0, 1, 1, 280602],
+        [0, 0, 1, -1, 277693],
+        [2, 0, 0, -1, 173237],
+        [2, 0, -1, 1, 55413],
+        [2, 0, -1, -1, 46271],
+        [2, 0, 0, 1, 32573],
+        [0, 0, 2, 1, 17198],
+        [2, 0, 1, -1, 9266],
+        [0, 0, 2, -1, 8822],
+        [2, -1, 0, -1, 8216],
+        [2, 0, -2, -1, 4324],
+        [2, 0, 1, 1, 4200],
+        [2, 1, 0, -1, -3359],
+        [2, -1, -1, 1, 2463],
+        [2, -1, 0, 1, 2211],
+        [2, -1, -1, -1, 2065],
+        [0, 1, -1, -1, -1870],
+        [4, 0, -1, -1, 1828],
+        [0, 1, 0, 1, -1794],
+        [0, 0, 0, 3, -1749],
+        [0, 1, -1, 1, -1565],
+        [1, 0, 0, 1, -1491],
+        [0, 1, 1, 1, -1475],
+        [0, 1, 1, -1, -1410],
+        [0, 1, 0, -1, -1344],
+        [1, 0, 0, -1, -1335],
+        [0, 0, 3, 1, 1107],
+        [4, 0, 0, -1, 1021],
+        [4, 0, -1, 1, 833],
+        [0, 0, 1, -3, 777],
+        [4, 0, -2, 1, 671],
+        [2, 0, 0, -3, 607],
+        [2, 0, 2, -1, 596],
+        [2, -1, 1, -1, 491],
+        [2, 0, -2, 1, -451],
+        [0, 0, 3, -1, 439],
+        [2, 0, 2, 1, 422],
+        [2, 0, -3, -1, 421],
+        [2, 1, -1, 1, -366],
+        [2, 1, 0, 1, -351],
+        [4, 0, 0, 1, 331],
+        [2, -1, 1, 1, 315],
+        [2, -2, 0, -1, 302],
+        [0, 0, 1, 3, -283],
+        [2, 1, 1, -1, -229],
+        [1, 1, 0, -1, 223],
+        [1, 1, 0, 1, 223],
+        [0, 1, -2, -1, -220],
+        [2, 1, -1, -1, -220],
+        [1, 0, 1, 1, -185],
+        [2, -1, -2, -1, 181],
+        [0, 1, 2, 1, -177],
+        [4, 0, -2, -1, 176],
+        [4, -1, -1, -1, 166],
+        [1, 0, 1, -1, -164],
+        [4, 0, 1, -1, 132],
+        [1, 0, -1, -1, -119],
+        [4, -1, 0, -1, 115],
+        [2, -2, 0, 1, 107]
+      ]
+    end
+  end
+end