astronoby 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d5ac807296bab40ecf868557f3a6a7a1022360f78860b46332e87e5a2fd2697
-  data.tar.gz: 26682e9092af30150eff0b47edb5a1476341f0d133c39ced8754148e6a4b0927
+  metadata.gz: 1c5bcfe7077b3772243f90a9c8a9ac8b0b0d90fdce2c777d6f05ab88062bc94c
+  data.tar.gz: ecd3bbbbcf699c1bde1b2fd6a92ccd7dc45ed1839cb3e6e6549ddb2d52002e48
 SHA512:
-  metadata.gz: 5ae6f829d9c23476edd3c24411426a2c8c1aa6e432c19ee999889b01d9b7843476ea14c163bd083659e768a12a6b772cf46488dfebfa5c5c8f7449a2580bc420
-  data.tar.gz: 54e3f4ce4090c120b3156d4429fb3fbc6c2830ec816355931d8b416b734210a4d82af3ef5c058a4795b27e753b748f524a0419c2f3696603c5b05ee2b60a71cd
+  metadata.gz: a97c4ee597dbcd5b3adbb9da8402dd95d413d120e51c263675a8019e839496168d4a893c473b6dbf1687463eb8e2f4749b13a9acab1205488944ae49f160de83
+  data.tar.gz: 70b0f12a52a668e1f3948a20fb5fe38b59e42ed0531381b8a5a03d130d1e64b2e7ba2c56806982d1f0e667dc47776a54609d7a35a5b067594b78295a440cf020

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/CHANGELOG.md

@@ -1,6 +1,28 @@
-## [Unreleased]
+# Changelog
 
-## [0.0.1] - 2022-04-20
+## 0.1.0 - 2024-02-28
 
-- Add `Astronoby::Angle`
-- Support angles in degrees and radians
+### Features
+
+* Support angles in hours
+* Support coordinates
+  * `Astronoby::Coordinates::Horizontal`
+  * `Astronoby::Coordinates::Equatorial`
+  * `Astronoby::Coordinates::Ecliptic`
+* Add new body `Astronoby::Sun`
+* Add `Astronoby::Aberration`
+* Add `Astronoby::Epoch`
+* Add `Astronoby::MeanObliquity`
+* Add `Astronoby::TrueObliquity`
+* Add `Astronoby::Nutation`
+* Add `Astronoby::Precession`
+* Add `Astronoby::Refraction`
+* Add utils
+  * `Astronoby::Util::Astrodynamics`
+  * `Astronoby::Util::Time`
+  * `Astronoby::Util::Trigonometry`
+
+## 0.0.1 - 2022-04-20
+
+* Add `Astronoby::Angle`
+* Support angles in degrees and radians

data/CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing to Astronoby
+
+By participating in this project, you agree to follow the [code of conduct].
+
+[code of conduct]: https://github.com/rhannequin/astronoby/blob/main/CODE_OF_CONDUCT.md
+
+Here are some ways *you* can contribute:
+
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small** : fix typos, add comments, etc.)
+* by refactoring code
+* by closing [issues]
+* by reviewing patches
+
+[issues]: https://github.com/rhannequin/astronoby/issues
+
+## Submitting an Issue
+
+* We use the [GitHub issue tracker][issues] to track bugs and features.
+* Before submitting a bug report or feature request, check to make sure it hasn't
+  already been submitted.
+* When submitting a bug report, please include any other details that may be
+  necessary to reproduce the bug, including your gem version, Ruby version, and
+  operating system.
+
+## Cleaning up issues
+
+* Issues that have no response from the submitter will be closed after 30 days.
+* Issues will be closed once they're assumed to be fixed or answered. If the
+  maintainer is wrong, it can be opened again.
+* If your issue is closed by mistake, please understand and explain the issue.
+  We will happily reopen the issue.
+
+## Submitting a Pull Request
+
+1. [Fork][fork] the [official repository][repo].
+1. [Create a topic branch.][branch]
+1. Implement your feature or bug fix.
+1. Add, commit, and push your changes.
+1. [Submit a pull request.][pr]
+
+### Notes
+
+* Please add tests if you changed code. Contributions without tests won't be accepted.
+* If you don't know how to add tests, please put in a PR and leave a comment
+  asking for help. We love helping!
+* Please don't update the Gem version.
+
+## Setting up
+
+```sh
+bin/setup
+```
+
+## Running the test suite
+
+The default rake task will run the full test suite:
+
+```sh
+bundle exec rake
+```
+
+To run an individual rspec test, you can provide a path and line number:
+
+```sh
+bundle exec rspec spec/path/to/spec.rb:123
+```
+
+## Formatting
+
+Use [standard] to automatically format your code:
+
+```sh
+bundle exec standardrb --fix
+```
+
+[repo]: https://github.com/rhannequin/astronoby/tree/main
+[fork]: https://help.github.com/articles/fork-a-repo/
+[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
+[pr]: https://help.github.com/articles/using-pull-requests/
+[standard]: https://github.com/testdouble/standard
+
+Inspired by https://github.com/thoughtbot/factory_bot/blob/main/CONTRIBUTING.md

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    astronoby (0.0.1)
+    astronoby (0.1.0)
+      matrix (~> 0.4.2)
       rake (~> 13.0)
       rspec (~> 3.0)
 
@@ -10,53 +11,67 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    matrix (0.4.2)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
-    prettier (2.1.0)
+      racc
+    racc (1.7.0)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.3.0)
+    rake (13.1.0)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.27.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.52.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.17.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.13.3)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.18.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    standard (1.10.0)
-      rubocop (= 1.27.0)
-      rubocop-performance (= 1.13.3)
-    unicode-display_width (2.1.0)
+    ruby-progressbar (1.13.0)
+    standard (1.29.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.52.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.1.0)
+    standard-custom (1.0.1)
+      lint_roller (~> 1.0)
+    standard-performance (1.1.0)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.18.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
   astronoby!
-  prettier (~> 2.0)
   standard (~> 1.3)
 
 BUNDLED WITH

data/README.md

@@ -1,6 +1,15 @@
-# Astronoby ![specs](https://github.com/rhannequin/astronoby/workflows/Ruby/badge.svg)
+# Astronoby
 
-Ruby library to provide a useful API to compute astronomical calculations, based on _Astronomical Algorithms_ by Jean Meeus.
+[![Tests](https://github.com/rhannequin/astronoby/workflows/Ruby/badge.svg)](https://github.com/rhannequin/astronoby/actions?query=workflow%3ARuby)
+
+Ruby library to provide a useful API to compute astronomical calculations, based
+on astrometry books.
+
+The main reference is:
+- _Astronomical Algorithms_ by Jean Meeus
+- _Celestial Calculations_ by J. L. Lawrence
+- _Practical Astronomy with your Calculator or Spreadsheet_ by Peter
+  Duffet-Smith and Jonathan Zwart
 
 ## Installation
 
@@ -8,28 +17,76 @@ Install the gem and add to the application's Gemfile by executing:
 
     $ bundle add astronoby
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+If bundler is not being used to manage dependencies, install the gem by
+executing:
 
     $ gem install astronoby
 
 ## Usage
 
-Library still heavily in development.
+This library is still in heavy development. The following API is likely to 
+change any time.
+
+```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)
+
+sun = Astronoby::Sun.new(epoch: epoch)
+
+horizontal_coordinates = sun.horizontal_coordinates(
+  latitude: latitude,
+  longitude: longitude
+)
+
+horizontal_coordinates.altitude.degrees.to_f
+# => 27.502365130176567
+
+horizontal_coordinates.altitude.str(:dms)
+# => "+27° 30′ 8.5144″"
+```
+
+## Precision
+
+The current precision for the Sun's apparent location in the sky, compared 
+to values computed by the [IMCCE] is approximately 1 arc minute. It corresponds
+to twice the apparent size of Jupiter when it is the closest to Earth.
+
+While the precision is not enough for very high accuracy computations, it is
+equal to the Human naked eye's angular resolution.
+
+[IMCCE]: https://www.imcce.fr
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and the created tag, and push the `.gem` file to [rubygems.org].
+
+[rubygems.org]: https://rubygems.org
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/rhannequin/astronoby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rhannequin/astronoby/blob/main/CODE_OF_CONDUCT.md).
+Please see [CONTRIBUTING.md](https://github.com/rhannequin/astronoby/blob/main/CONTRIBUTING.md).
+
+[code of conduct]: https://github.com/rhannequin/astronoby/blob/main/CODE_OF_CONDUCT.md
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License].
+
+[MIT License]: https://opensource.org/licenses/MIT
 
 ## Code of Conduct
 
-Everyone interacting in the Astronoby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rhannequin/astronoby/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Astronoby project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of conduct].
+
+[code of conduct]: https://github.com/rhannequin/astronoby/blob/main/CODE_OF_CONDUCT.md

data/lib/astronoby/aberration.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Astronoby
+  class Aberration
+    def self.for_ecliptic_coordinates(coordinates:, epoch:)
+      new(coordinates, epoch).apply
+    end
+
+    def initialize(coordinates, epoch)
+      @coordinates = coordinates
+      @epoch = epoch
+    end
+
+    # Source:
+    #  Title: Practical Astronomy with your Calculator or Spreadsheet
+    #  Authors: Peter Duffett-Smith and Jonathan Zwart
+    #  Edition: Cambridge University Press
+    #  Chapter: 36 - Aberration
+    def apply
+      delta_longitude = Angle.as_degrees(
+        -20.5 * (
+          sun_longitude - @coordinates.longitude
+        ).cos / @coordinates.latitude.cos / 3600
+      )
+
+      delta_latitude = Angle.as_degrees(
+        -20.5 *
+        (sun_longitude - @coordinates.longitude).sin *
+        @coordinates.latitude.sin / 3600
+      )
+
+      Coordinates::Ecliptic.new(
+        latitude: @coordinates.latitude + delta_latitude,
+        longitude: @coordinates.longitude + delta_longitude
+      )
+    end
+
+    def sun_longitude
+      @_sun_longitude ||= Sun.new(epoch: @epoch).ecliptic_coordinates.longitude
+    end
+  end
+end

data/lib/astronoby/angle.rb

@@ -4,39 +4,173 @@ require "bigdecimal/math"
 
 module Astronoby
   class Angle
-    UNITS = [
-      DEGREES = :degrees,
-      RADIANS = :radians
-    ].freeze
+    PRECISION = 14
+    PI = BigMath.PI(PRECISION)
+    PI_IN_DEGREES = BigDecimal("180")
 
-    UNIT_CLASS_NAMES = {
-      DEGREES => "Astronoby::Degree",
-      RADIANS => "Astronoby::Radian"
-    }
+    FULL_CIRCLE_IN_RADIANS = (2 * PI)
 
-    PI = BigMath.PI(10)
+    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
+
+    FORMATS = %i[dms hms].freeze
 
     class << self
-      UNIT_CLASS_NAMES.each do |unit, class_name|
-        define_method("as_#{unit}") do |angle|
-          Kernel.const_get(class_name).new(angle)
-        end
+      def zero
+        new(0)
+      end
+
+      def as_radians(radians)
+        normalized_radians = radians.remainder(FULL_CIRCLE_IN_RADIANS)
+        new(normalized_radians)
+      end
+
+      def as_degrees(degrees)
+        radians = degrees / PI_IN_DEGREES * PI
+        as_radians(radians)
+      end
+
+      def as_hours(hours)
+        radians = hours * RADIAN_PER_HOUR
+        as_radians(radians)
+      end
+
+      def as_hms(hour, minute, second)
+        hours = hour + minute / MINUTES_PER_HOUR + second / SECONDS_PER_HOUR
+        as_hours(hours)
+      end
+
+      def as_dms(degree, minute, second)
+        sign = degree.negative? ? -1 : 1
+        degrees = degree.abs + minute / MINUTES_PER_HOUR + second / SECONDS_PER_HOUR
+        as_degrees(sign * degrees)
+      end
+
+      def asin(ratio)
+        radians = Math.asin(ratio)
+        as_radians(radians)
       end
+
+      def acos(ratio)
+        radians = Math.acos(ratio)
+        as_radians(radians)
+      end
+
+      def atan(ratio)
+        radians = Math.atan(ratio)
+        as_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
+      freeze
+    end
+
+    def degrees
+      @radians * PI_IN_DEGREES / PI
+    end
+
+    def hours
+      @radians / RADIAN_PER_HOUR
     end
 
-    UNITS.each do |unit|
-      define_method("to_#{unit}") do
-        raise NotImplementedError, "#{self.class} must implement #to_#{unit} method."
+    def +(other)
+      self.class.as_radians(radians + other.radians)
+    end
+
+    def -(other)
+      self.class.as_radians(@radians - other.radians)
+    end
+
+    def sin
+      Math.sin(radians)
+    end
+
+    def cos
+      Math.cos(radians)
+    end
+
+    def tan
+      Math.tan(radians)
+    end
+
+    def positive?
+      radians > 0
+    end
+
+    def negative?
+      radians < 0
+    end
+
+    def zero?
+      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)
+
+      radians <=> other.radians
+    end
+
+    def str(format)
+      case format
+      when :dms then to_dms(degrees).format
+      when :hms then to_hms(hours).format
+      else
+        raise UnsupportedFormatError.new(
+          "Expected a format between #{FORMATS.join(", ")}, got #{format}"
+        )
       end
     end
 
-    def initialize(angle, unit:)
-      @angle = BigDecimal(angle)
-      @unit = unit
+    def to_dms(deg)
+      sign = deg.negative? ? "-" : "+"
+      absolute_degrees = deg.abs
+      degrees = absolute_degrees.floor
+      decimal_minutes = MINUTES_PER_DEGREE * (absolute_degrees - degrees)
+      absolute_decimal_minutes = (
+        MINUTES_PER_DEGREE * (absolute_degrees - degrees)
+      ).abs
+      minutes = decimal_minutes.floor
+      seconds = SECONDS_PER_MINUTE * (
+        absolute_decimal_minutes - absolute_decimal_minutes.floor
+      )
+
+      Dms.new(sign, degrees, minutes, seconds.to_f.floor(4))
     end
 
-    def value
-      @angle
+    def to_hms(hrs)
+      absolute_hours = hrs.abs
+      hours = absolute_hours.floor
+      decimal_minutes = MINUTES_PER_HOUR * (absolute_hours - hours)
+      absolute_decimal_minutes = (
+        MINUTES_PER_HOUR * (absolute_hours - hours)
+      ).abs
+      minutes = decimal_minutes.floor
+      seconds = SECONDS_PER_MINUTE * (
+        absolute_decimal_minutes - absolute_decimal_minutes.floor
+      )
+
+      Hms.new(hours, minutes, seconds.to_f.floor(4))
     end
   end
 end

data/lib/astronoby/angles/dms.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Astronoby
+  class Dms
+    attr_reader :sign, :degrees, :minutes, :seconds
+
+    def initialize(sign, degrees, minutes, seconds)
+      @sign = sign
+      @degrees = degrees
+      @minutes = minutes
+      @seconds = seconds
+    end
+
+    def format
+      "#{sign}#{degrees}° #{minutes}′ #{seconds}″"
+    end
+  end
+end

data/lib/astronoby/angles/hms.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Astronoby
+  class Hms
+    attr_reader :hours, :minutes, :seconds
+
+    def initialize(hours, minutes, seconds)
+      @hours = hours
+      @minutes = minutes
+      @seconds = seconds
+    end
+
+    def format
+      "#{hours}h #{minutes}m #{seconds}s"
+    end
+  end
+end