astronoby 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25e45175dabf69ffa0c98ffdf3e93cb21b9ce004fe4e0ffe61a4cfc92794ae44
-  data.tar.gz: 2d1ad05a74a171c71f6ff0a7fa7c3af1874f07379c8be407ff633d61ad4dd78e
+  metadata.gz: 3c65785b0c459ba8add86fcceb906205caa79a80f47b7f33c0b7ee008173fd14
+  data.tar.gz: 66478c6055d84e34f560490f225ae3e3d5020972e729b37e8f6f0a6566ae173e
 SHA512:
-  metadata.gz: 74cdfbf511e8094bd410c67ed86eaff12f03124bec48c769eb3e6ebf1fd54870145a556cc82214db5147bd2c6e4631d0514973a76648d0e68d8770162401d338
-  data.tar.gz: 7a6c7f98fff52a04d60dc5c4eced47610900aa10a64f8016000b9294276d547d4d350ef0d269a25f42ae9b0078d110ad9b73884f3834e55a12084274f358ae15
+  metadata.gz: 4bae651aabaec62d258a768952eb3cd830d99639acf33f02b9f0ab6fd2eeff8215d9a30087a5818736b777c1a86344918f98f33f987f65829a8712cb20477c55
+  data.tar.gz: 401659e2d49599246ad2ea1a455a6d60b9797c49e730cacf8a614f4235929263c9318644373a96ea496969fcb814cc93144a8dbfffd0a0318e1628500bb1c8e8

data/CHANGELOG.md

@@ -1,10 +1,99 @@
 # Changelog
 
-## 0.2.0 - 2024-03-24
+## 0.4.0 - 2024-04-29
+
+_If you are upgrading: please see [UPGRADING.md]._
+
+[UPGRADING.md]: https://github.com/rhannequin/astronoby/blob/main/UPGRADING.md
+
+### Bug fixes
+
+* Fix ecliptic to equatorial epoch ([#56])
+
+[#56]: https://github.com/rhannequin/astronoby/pull/56
+
+### Features
+
+* Add twilight times ([#49])
+* Add interpolation method ([#52])
+* Add decimal_hour_to_time util ([#53])
+* Calculate leap seconds for an instant ([#54])
+* Add `Angle#-@` ([#55])
+* Enable equivalence and hash equality to `Observer` ([#57])
+* Twilight events dedicated class ([#61])
+
+[#49]: https://github.com/rhannequin/astronoby/pull/49
+[#52]: https://github.com/rhannequin/astronoby/pull/52
+[#53]: https://github.com/rhannequin/astronoby/pull/53
+[#54]: https://github.com/rhannequin/astronoby/pull/54
+[#55]: https://github.com/rhannequin/astronoby/pull/55
+[#57]: https://github.com/rhannequin/astronoby/pull/57
+[#61]: https://github.com/rhannequin/astronoby/pull/61
+
+### Improvements
+
+* Upgrade bundler from 2.3.11 to 2.5.7 by @dorianmariecom ([#45])
+* Drop `BigDecimal` ([#46])
+* Bump rake from 13.1.0 to 13.2.0 ([#47])
+* Increase Ruby versions support ([#48])
+* Bump rake from 13.2.0 to 13.2.1 ([#51])
+* Dedicated constants class ([#62])
+* Improve accuracy of equation of time ([#63])
+* Twilight times better accuracy ([#65])
+* Update UPGRADING.md ([#66])
+* release: Bump version to 0.4.0 ([#67])
+
+[#45]: https://github.com/rhannequin/astronoby/pull/45
+[#46]: https://github.com/rhannequin/astronoby/pull/46
+[#47]: https://github.com/rhannequin/astronoby/pull/47
+[#48]: https://github.com/rhannequin/astronoby/pull/48
+[#51]: https://github.com/rhannequin/astronoby/pull/51
+[#62]: https://github.com/rhannequin/astronoby/pull/62
+[#63]: https://github.com/rhannequin/astronoby/pull/63
+[#65]: https://github.com/rhannequin/astronoby/pull/65
+[#66]: https://github.com/rhannequin/astronoby/pull/66
+[#67]: https://github.com/rhannequin/astronoby/pull/67
+
+### Backward-incompatible changes
+
+* More accurate rising, transit and setting times ([#50])
+* Observation events dedicated and centralized class ([#60])
+* Change `Astronoby::Sun` constructor ([#64])
+
+[#50]: https://github.com/rhannequin/astronoby/pull/50
+[#60]: https://github.com/rhannequin/astronoby/pull/60
+[#64]: https://github.com/rhannequin/astronoby/pull/64
+
+### New Contributors
+
+* @dorianmariecom made their first contribution in [#45]
+
+[#45]: https://github.com/rhannequin/astronoby/pull/45
+
+**Full Changelog**: https://github.com/rhannequin/astronoby/compare/v0.3.0...v0.4.0
+
+## 0.3.0 - 2024-03-29
 
 _If you are upgrading: please see [`UPGRADING.md`]._
 
-[`UPGRADING.md`]: https://github.com/rhannequin/astronoby/blob/main/UPGRADING.md
+### Improvements
+
+* Drop `Angle#==` ([#42])
+* Improved accuracy with Sun's location predictions ([#41])
+
+### Breaking changes
+
+* **breaking:** Difference between true and apparent ecliptic and equatorial
+  coordinates ([#41])
+* **breaking:** Rename `Angle::as_*` into `Angle::from_*` ([#43])
+
+[#41]: https://github.com/rhannequin/astronoby/pull/41
+[#42]: https://github.com/rhannequin/astronoby/pull/42
+[#43]: https://github.com/rhannequin/astronoby/pull/43
+
+## 0.2.0 - 2024-03-24
+
+_If you are upgrading: please see [`UPGRADING.md`]._
 
 ### Features
 
@@ -74,3 +163,5 @@ _If you are upgrading: please see [`UPGRADING.md`]._
 
 * Add `Astronoby::Angle`
 * Support angles in degrees and radians
+
+[`UPGRADING.md`]: https://github.com/rhannequin/astronoby/blob/main/UPGRADING.md

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    astronoby (0.2.0)
+    astronoby (0.4.0)
       matrix (~> 0.4.2)
       rake (~> 13.0)
       rspec (~> 3.0)
@@ -21,7 +21,7 @@ GEM
       racc
     racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.1)
     regexp_parser (2.9.0)
     rexml (3.2.6)
     rspec (3.13.0)
@@ -77,4 +77,4 @@ DEPENDENCIES
   standard (~> 1.3)
 
 BUNDLED WITH
-   2.3.11
+   2.5.7

data/README.md

@@ -28,27 +28,125 @@ This library is still in heavy development. The public is not stable, please
 be aware new minor versions will probably lead to breaking changes until a
 major one is released.
 
+### Angle manipulation
+
+```rb
+angle1 = Astronoby::Angle.from_degrees(90)
+angle2 = Astronoby::Angle.from_radians(Math::PI / 2)
+angle3 = Astronoby::Angle.from_hours(12)
+
+angle1 == angle2
+# => true
+
+angle1 < angle3
+# => true
+
+angle = angle1 + angle2 + angle3
+angle.cos
+# => 1.0
+```
+
+### Coordinates conversion
+
+```rb
+equatorial = Astronoby::Coordinates::Equatorial.new(
+  right_ascension: Astronoby::Angle.from_hms(17, 43, 54),
+  declination: Astronoby::Angle.from_dms(-22, 10, 0)
+)
+
+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)
+)
+
+horizontal.altitude.str(:dms)
+# => "-73° 27′ 19.1557″"
+
+horizontal.azimuth.str(:dms)
+# => "+341° 33′ 21.587″"
+```
+
 ### Sun's location in the sky
 
 ```rb
 time = Time.utc(2023, 2, 17, 11, 0, 0)
-epoch = Astronoby::Epoch.from_time(time)
 
-latitude = Astronoby::Angle.as_degrees(48.8566)
-longitude = Astronoby::Angle.as_degrees(2.3522)
+latitude = Astronoby::Angle.from_degrees(48.8566)
+longitude = Astronoby::Angle.from_degrees(2.3522)
 
-sun = Astronoby::Sun.new(epoch: epoch)
+sun = Astronoby::Sun.new(time: time)
 
 horizontal_coordinates = sun.horizontal_coordinates(
   latitude: latitude,
   longitude: longitude
 )
 
-horizontal_coordinates.altitude.degrees.to_f
-# => 27.502365130176567
+horizontal_coordinates.altitude.degrees
+# => 27.500082409271247
 
 horizontal_coordinates.altitude.str(:dms)
-# => "+27° 30′ 8.5144″"
+# => "+27° 30′ 0.2966″"
+```
+
+### Sunrise and sunset times and azimuths
+
+```rb
+time = Time.new(2015, 2, 5)
+observer = Astronoby::Observer.new(
+  latitude: Astronoby::Angle.from_degrees(38),
+  longitude: Astronoby::Angle.from_degrees(-78)
+)
+sun = Astronoby::Sun.new(time: time)
+observation_events = sun.observation_events(observer: observer)
+
+observation_events.rising_time
+# => 2015-02-05 12:12:59 UTC
+
+observation_events.rising_azimuth.str(:dms)
+# => "+109° 46′ 43.145″"
+
+observation_events.transit_time
+# => 2015-02-05 17:25:59 UTC
+
+observation_events.transit_altitude.str(:dms)
+# => "+36° 8′ 15.7638″"
+
+observation_events.setting_time
+# => 2015-02-05 22:39:27 UTC
+
+observation_events.setting_azimuth.str(:dms)
+# => "+250° 23′ 33.614″"
+```
+
+### Twilight times
+
+```rb
+time = Time.new(2024, 1, 1)
+sun = Astronoby::Sun.new(time: time)
+observer = Astronoby::Observer.new(
+  latitude: Astronoby::Angle.from_degrees(48.8566),
+  longitude: Astronoby::Angle.from_degrees(2.3522)
+)
+twilight_events = sun.twilight_events(observer: observer)
+
+twilight_events.morning_astronomical_twilight_time
+# => 2024-01-01 05:49:25 UTC
+
+twilight_events.morning_nautical_twilight_time
+# => 2024-01-01 06:27:42 UTC
+
+twilight_events.morning_civil_twilight_time
+# => 2024-01-01 07:07:50 UTC
+
+twilight_events.evening_civil_twilight_time
+# => 2024-01-01 16:40:01 UTC
+
+twilight_events.evening_nautical_twilight_time
+# => 2024-01-01 17:20:10 UTC
+
+twilight_events.evening_astronomical_twilight_time
+# => 2024-01-01 17:58:26 UTC
 ```
 
 ### Solstice and Equinox times
@@ -57,10 +155,10 @@ horizontal_coordinates.altitude.str(:dms)
 year = 2024
 
 Astronoby::EquinoxSolstice.march_equinox(year)
-# => 2024-03-20 03:05:00 UTC
+# => 2024-03-20 03:05:08 UTC
 
 Astronoby::EquinoxSolstice.june_solstice(year)
-# => 2024-06-20 20:50:14 UTC
+# => 2024-06-20 20:50:18 UTC
 ```
 
 ## Precision

data/UPGRADING.md

@@ -7,6 +7,80 @@ 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.3.0 to 0.4.0
+
+### `Body` class removed ([#50])
+
+The different behaviors from `Body` have been moved to other classes like
+`Events::ObservationEvents`.
+
+[#50]: https://github.com/rhannequin/astronoby/pull/50
+
+### Rising and setting times and azimuths removed from `Sun` ([#60])
+
+`#rising_time`, `#rising_azimuth`, `#setting_time` and `#setting_azimuth`
+have been removed from `Astronoby::Sun` and moved to
+`Astronoby::Events::ObservationEvents`.
+
+[#60]: https://github.com/rhannequin/astronoby/pull/60
+
+### `Sun` constructor changed ([#64])
+
+The `Sun` constructor now doesn't accept the `epoch` key argument anymore,
+but only a new `time` key argument.
+
+[#64]: https://github.com/rhannequin/astronoby/pull/64
+
+## Upgrading from 0.2.0 to 0.3.0
+
+### `Sun#ecliptic_coordinates` method removed (#41)
+
+Removed in favor of `#true_ecliptic_coordinates` and
+`#apparent_ecliptic_coordinates`.
+
+### `Coordinates::Ecliptic#to_horizontal` method removed (#41)
+
+Removed in favor of `#to_true_horizontal` and
+`#to_apparent_horizontal`.
+
+### `Sun#true_ecliptic_coordinates` method added (#41)
+
+Returns the true ecliptic coordinates for the date's epoch.
+
+### `Sun#apparent_ecliptic_coordinates` method added (#41)
+
+Returns the apparent ecliptic coordinates for the date's epoch, including
+corrections for the nutation and aberration.
+
+### `Coordinates::Ecliptic#to_true_horizontal` method added (#41)
+
+Returns the true equatorial coordinates for ths date's epoch.
+
+### `Coordinates::Ecliptic#to_apparent_horizontal` method added (#41)
+
+Returns the apparent equatorial coordinates for the date's epoch, including
+corrections for the obliquity.
+
+### `Angle::as_radians` renamed into `Angle::from_radians` (#43)
+
+Behaviour not changed.
+
+### `Angle::as_degrees` renamed into `Angle::from_degrees` (#43)
+
+Behaviour not changed.
+
+### `Angle::as_hours` renamed into `Angle::from_hours` (#43)
+
+Behaviour not changed.
+
+### `Angle::as_dms` renamed into `Angle::from_dms` (#43)
+
+Behaviour not changed.
+
+### `Angle::as_hms` renamed into `Angle::from_hms` (#43)
+
+Behaviour not changed.
+
 ## Upgrading from 0.1.0 to 0.2.0
 
 ### `Observer` class added (#29)

data/lib/astronoby/aberration.rb

@@ -2,6 +2,8 @@
 
 module Astronoby
   class Aberration
+    MAXIMUM_SHIFT = Angle.from_degrees(20.5)
+
     def self.for_ecliptic_coordinates(coordinates:, epoch:)
       new(coordinates, epoch).apply
     end
@@ -17,16 +19,16 @@ module Astronoby
     #  Edition: Cambridge University Press
     #  Chapter: 36 - Aberration
     def apply
-      delta_longitude = Angle.as_degrees(
-        -20.5 * (
+      delta_longitude = Angle.from_degrees(
+        -MAXIMUM_SHIFT.degrees * (
           sun_longitude - @coordinates.longitude
-        ).cos / @coordinates.latitude.cos / 3600
+        ).cos / @coordinates.latitude.cos / Constants::SECONDS_PER_DEGREE
       )
 
-      delta_latitude = Angle.as_degrees(
-        -20.5 *
+      delta_latitude = Angle.from_degrees(
+        -MAXIMUM_SHIFT.degrees *
         (sun_longitude - @coordinates.longitude).sin *
-        @coordinates.latitude.sin / 3600
+        @coordinates.latitude.sin / Constants::SECONDS_PER_DEGREE
       )
 
       Coordinates::Ecliptic.new(
@@ -36,7 +38,10 @@ module Astronoby
     end
 
     def sun_longitude
-      @_sun_longitude ||= Sun.new(epoch: @epoch).ecliptic_coordinates.longitude
+      @_sun_longitude ||= Sun
+        .new(time: Epoch.to_utc(@epoch))
+        .true_ecliptic_coordinates
+        .longitude
     end
   end
 end

data/lib/astronoby/angle.rb

@@ -1,23 +1,10 @@
 # frozen_string_literal: true
 
-require "bigdecimal/math"
-
 module Astronoby
   class Angle
     include Comparable
 
-    PRECISION = 14
-    PI = BigMath.PI(PRECISION)
-    PI_IN_DEGREES = BigDecimal("180")
-
-    FULL_CIRCLE_IN_RADIANS = (2 * PI)
-
-    RADIAN_PER_HOUR = PI / BigDecimal("12")
-    MINUTES_PER_DEGREE = BigDecimal("60")
-    MINUTES_PER_HOUR = BigDecimal("60")
-    SECONDS_PER_MINUTE = BigDecimal("60")
-    SECONDS_PER_HOUR = MINUTES_PER_HOUR * SECONDS_PER_MINUTE
-
+    MIN_PRECISION = 10
     FORMATS = %i[dms hms].freeze
 
     class << self
@@ -25,73 +12,77 @@ module Astronoby
         new(0)
       end
 
-      def as_radians(radians)
-        normalized_radians = radians.remainder(FULL_CIRCLE_IN_RADIANS)
+      def from_radians(radians)
+        normalized_radians = radians.remainder(Constants::RADIANS_PER_CIRCLE)
         new(normalized_radians)
       end
 
-      def as_degrees(degrees)
-        radians = degrees / PI_IN_DEGREES * PI
-        as_radians(radians)
+      def from_degrees(degrees)
+        radians = degrees / Constants::PI_IN_DEGREES * Math::PI
+        from_radians(radians)
       end
 
-      def as_hours(hours)
-        radians = hours * RADIAN_PER_HOUR
-        as_radians(radians)
+      def from_hours(hours)
+        radians = hours * Constants::RADIAN_PER_HOUR
+        from_radians(radians)
       end
 
-      def as_hms(hour, minute, second)
-        hours = hour + minute / MINUTES_PER_HOUR + second / SECONDS_PER_HOUR
-        as_hours(hours)
+      def from_hms(hour, minute, second)
+        hours = hour +
+          minute / Constants::MINUTES_PER_HOUR +
+          second / Constants::SECONDS_PER_HOUR
+        from_hours(hours)
       end
 
-      def as_dms(degree, minute, second)
+      def from_dms(degree, minute, second)
         sign = degree.negative? ? -1 : 1
-        degrees = degree.abs + minute / MINUTES_PER_HOUR + second / SECONDS_PER_HOUR
-        as_degrees(sign * degrees)
+        degrees = degree.abs +
+          minute / Constants::MINUTES_PER_HOUR +
+          second / Constants::SECONDS_PER_HOUR
+        from_degrees(sign * degrees)
       end
 
       def asin(ratio)
         radians = Math.asin(ratio)
-        as_radians(radians)
+        from_radians(radians)
       end
 
       def acos(ratio)
         radians = Math.acos(ratio)
-        as_radians(radians)
+        from_radians(radians)
       end
 
       def atan(ratio)
         radians = Math.atan(ratio)
-        as_radians(radians)
+        from_radians(radians)
       end
     end
 
     attr_reader :radians
 
     def initialize(radians)
-      @radians = if radians.is_a?(Integer) || radians.is_a?(BigDecimal)
-        BigDecimal(radians)
-      else
-        BigDecimal(radians, PRECISION)
-      end
+      @radians = radians
       freeze
     end
 
     def degrees
-      @radians * PI_IN_DEGREES / PI
+      @radians * Constants::PI_IN_DEGREES / Math::PI
     end
 
     def hours
-      @radians / RADIAN_PER_HOUR
+      @radians / Constants::RADIAN_PER_HOUR
     end
 
     def +(other)
-      self.class.as_radians(radians + other.radians)
+      self.class.from_radians(radians + other.radians)
     end
 
     def -(other)
-      self.class.as_radians(@radians - other.radians)
+      self.class.from_radians(@radians - other.radians)
+    end
+
+    def -@
+      self.class.from_radians(-@radians)
     end
 
     def sin
@@ -118,20 +109,16 @@ module Astronoby
       radians.zero?
     end
 
-    def ==(other)
-      other.is_a?(self.class) && radians == other.radians
-    end
-    alias_method :eql?, :==
-
     def hash
       [radians, self.class].hash
     end
 
     def <=>(other)
-      return nil unless other.is_a?(self.class)
+      return unless other.is_a?(self.class)
 
       radians <=> other.radians
     end
+    alias_method :eql?, :==
 
     def str(format)
       case format
@@ -148,31 +135,32 @@ module Astronoby
       sign = deg.negative? ? "-" : "+"
       absolute_degrees = deg.abs
       degrees = absolute_degrees.floor
-      decimal_minutes = MINUTES_PER_DEGREE * (absolute_degrees - degrees)
+      decimal_minutes = Constants::MINUTES_PER_DEGREE *
+        (absolute_degrees - degrees)
       absolute_decimal_minutes = (
-        MINUTES_PER_DEGREE * (absolute_degrees - degrees)
+        Constants::MINUTES_PER_DEGREE * (absolute_degrees - degrees)
       ).abs
       minutes = decimal_minutes.floor
-      seconds = SECONDS_PER_MINUTE * (
+      seconds = Constants::SECONDS_PER_MINUTE * (
         absolute_decimal_minutes - absolute_decimal_minutes.floor
       )
 
-      Dms.new(sign, degrees, minutes, seconds.to_f.floor(4))
+      Dms.new(sign, degrees, minutes, seconds.floor(4))
     end
 
     def to_hms(hrs)
       absolute_hours = hrs.abs
       hours = absolute_hours.floor
-      decimal_minutes = MINUTES_PER_HOUR * (absolute_hours - hours)
+      decimal_minutes = Constants::MINUTES_PER_HOUR * (absolute_hours - hours)
       absolute_decimal_minutes = (
-        MINUTES_PER_HOUR * (absolute_hours - hours)
+        Constants::MINUTES_PER_HOUR * (absolute_hours - hours)
       ).abs
       minutes = decimal_minutes.floor
-      seconds = SECONDS_PER_MINUTE * (
+      seconds = Constants::SECONDS_PER_MINUTE * (
         absolute_decimal_minutes - absolute_decimal_minutes.floor
       )
 
-      Hms.new(hours, minutes, seconds.to_f.floor(4))
+      Hms.new(hours, minutes, seconds.floor(4))
     end
   end
 end