iers 0.2.0 → 0.3.1

data/lib/iers/configuration.rb

@@ -39,6 +39,7 @@ module IERS
 
     def cache_dir=(value)
       @cache_dir = Pathname(value)
+      invalidate
     end
 
     def sources=(value)
@@ -59,10 +60,12 @@ module IERS
 
     def finals_path=(value)
       @finals_path = value && Pathname(value)
+      invalidate(:finals)
     end
 
     def leap_second_path=(value)
       @leap_second_path = value && Pathname(value)
+      invalidate(:leap_seconds)
     end
 
     def interpolation=(value)
@@ -82,5 +85,15 @@ module IERS
 
       @lagrange_order = value
     end
+
+    private
+
+    # Settings staged on a detached Configuration govern nothing, so they must
+    # not reach into the parse the gem is actually serving.
+    def invalidate(*sources)
+      return unless IERS.active_configuration?(self)
+
+      Data.clear_loaded!(*sources)
+    end
   end
 end

data/lib/iers/data.rb

@@ -37,6 +37,7 @@ module IERS
         begin
           Downloader.new(timeout: config.download_timeout).fetch(url, dest)
           updated << source
+          clear_loaded!(source)
         rescue DownloadError => e
           errors[source] = e
         end
@@ -67,6 +68,8 @@ module IERS
         path = config.cache_dir.join(filename)
         path.delete if path.exist?
       end
+
+      clear_loaded!
     end
 
     # @param coverage_days_ahead [Integer, nil]
@@ -161,15 +164,33 @@ module IERS
       (Time.now - mtimes.min).to_i
     end
 
+    # @param sources [Array<Symbol>] data sources to drop (default: all)
     # @return [void]
-    def clear_loaded!
+    def clear_loaded!(*sources)
+      sources = FILENAMES.keys if sources.empty?
+      validate_sources!(sources)
+
       @mutex.synchronize do
-        @finals = nil
-        @leap_second_table = nil
+        @finals = nil if sources.include?(:finals)
+        @leap_second_table = nil if sources.include?(:leap_seconds)
       end
+
+      # Outside the mutex above: LeapSecond takes its own lock before calling
+      # back into Data, so taking them in that order here would invert it.
+      LeapSecond.clear_cached! if sources.include?(:leap_seconds)
+    end
+
+    def validate_sources!(sources)
+      unknown = sources - FILENAMES.keys
+      return if unknown.empty?
+
+      raise ConfigurationError,
+        "Unknown data source: #{unknown.map(&:inspect).join(", ")}. " \
+        "Valid sources: #{FILENAMES.keys.inspect}"
     end
 
-    private_class_method :resolve_path,
+    private_class_method :validate_sources!,
+      :resolve_path,
       :resolve_read_path,
       :validate_source!,
       :custom_paths_configured?,

data/lib/iers/delta_t.rb

@@ -14,11 +14,11 @@ module IERS
     end
 
     EARLIEST_YEAR = 1800.0
-    PRE_1972_MJD = 41317.0
+    LATEST_POLYNOMIAL_YEAR = 1986.0
     DAYS_PER_JULIAN_YEAR = 365.25
     YEAR_J2000 = 2000.0
 
-    # Espenak & Meeus (2014) polynomial segments for 1800–1972.
+    # Espenak & Meeus (2014) polynomial segments for 1800–1986.
     # Each segment: [year_start, year_end, epoch, coefficients]
     # ΔT = c₀ + c₁·t + c₂·t² + ... where t = y − epoch
     # Reference: https://eclipsewise.com/help/deltatpoly2014.html
@@ -46,7 +46,7 @@ module IERS
     ].freeze
 
     private_constant :EARLIEST_YEAR,
-      :PRE_1972_MJD,
+      :LATEST_POLYNOMIAL_YEAR,
       :DAYS_PER_JULIAN_YEAR,
       :YEAR_J2000,
       :POLYNOMIALS
@@ -69,24 +69,62 @@ module IERS
         )
       end
 
-      if query_mjd < PRE_1972_MJD
-        Entry.new(
-          delta_t: polynomial_delta_t(y),
-          mjd: query_mjd,
-          source: :estimated
-        )
+      if series_covers?(query_mjd)
+        measured_entry(query_mjd)
+      elsif y <= LATEST_POLYNOMIAL_YEAR
+        estimated_entry(query_mjd, y)
       else
-        tai_utc = LeapSecond.at(mjd: query_mjd)
-        ut1_utc = UT1.at(mjd: query_mjd).ut1_utc
-
-        Entry.new(
-          delta_t: tai_utc + TimeScale::TT_TAI - ut1_utc,
-          mjd: query_mjd,
-          source: :measured
-        )
+        raise_uncovered!(query_mjd)
       end
     end
 
+    # The EOP series is the better source wherever it reaches, so it is asked
+    # first; the polynomial covers whatever is left within its own validity.
+    def series_covers?(mjd)
+      entries = Data.finals_entries
+      return false if entries.empty?
+
+      mjd.between?(entries.first.mjd, entries.last.mjd)
+    end
+
+    def estimated_entry(query_mjd, y)
+      Entry.new(
+        delta_t: polynomial_delta_t(y),
+        mjd: query_mjd,
+        source: :estimated
+      )
+    end
+
+    def raise_uncovered!(query_mjd)
+      entries = Data.finals_entries
+      series =
+        if entries.empty?
+          "is empty"
+        else
+          "covers #{entries.first.mjd}..#{entries.last.mjd}"
+        end
+
+      # No `available_range`: what DeltaT can answer is two disjoint spans, and
+      # naming either one alone is what made the old message misleading.
+      raise OutOfRangeError.new(
+        "No DeltaT available for MJD #{query_mjd}: the polynomial covers " \
+        "#{EARLIEST_YEAR.to_i}–#{LATEST_POLYNOMIAL_YEAR.to_i} and the EOP " \
+        "series #{series}",
+        requested_mjd: query_mjd
+      )
+    end
+
+    def measured_entry(query_mjd)
+      tai_utc = LeapSecond.at(mjd: query_mjd)
+      ut1_utc = UT1.at(mjd: query_mjd).ut1_utc
+
+      Entry.new(
+        delta_t: tai_utc + TimeScale::TT_TAI - ut1_utc,
+        mjd: query_mjd,
+        source: :measured
+      )
+    end
+
     def polynomial_delta_t(y)
       segment = POLYNOMIALS.find { |s| y < s[1] } || POLYNOMIALS.last
       t = y - segment[2]
@@ -97,6 +135,11 @@ module IERS
       YEAR_J2000 + (mjd - TimeScale::MJD_J2000) / DAYS_PER_JULIAN_YEAR
     end
 
-    private_class_method :polynomial_delta_t, :mjd_to_decimal_year
+    private_class_method :series_covers?,
+      :estimated_entry,
+      :raise_uncovered!,
+      :measured_entry,
+      :polynomial_delta_t,
+      :mjd_to_decimal_year
   end
 end

data/lib/iers/time_scale.rb

@@ -28,9 +28,9 @@ module IERS
     # @raise [ArgumentError] if no valid input is provided
     def to_mjd(input = nil, jd: nil, mjd: nil)
       if mjd
-        Float(mjd)
+        to_float(mjd)
       elsif jd
-        Float(jd) - JD_MJD_OFFSET
+        to_float(jd) - JD_MJD_OFFSET
       elsif input.is_a?(Time)
         input.to_datetime.ajd.to_f - JD_MJD_OFFSET
       elsif input.is_a?(Date)
@@ -41,5 +41,31 @@ module IERS
           "got #{input.inspect}"
       end
     end
+
+    # A date as a Float, without writing to the caller's stderr on the way.
+    #
+    # +Kernel#Float+ warns "Integer out of Float range" for a magnitude that
+    # does not fit one, and for a Rational whose numerator or denominator does
+    # not either, so a date far outside the data announced itself before being
+    # refused. An Integer or a Rational is measured first and converted
+    # directly, which is quiet; everything else still goes through
+    # +Kernel#Float+, which is what refuses a String or a nil.
+    #
+    # The value is unchanged: a magnitude past the range of a Float was an
+    # Infinity before and is one now.
+    #
+    # @param value [Numeric, String] the date to read
+    # @return [Float]
+    # @raise [ArgumentError, TypeError] if it is not a number
+    def to_float(value)
+      case value
+      when Float then value
+      when Integer, Rational
+        return value.to_f unless value.abs > Float::MAX
+
+        value.negative? ? -Float::INFINITY : Float::INFINITY
+      else Float(value)
+      end
+    end
   end
 end

data/lib/iers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IERS
-  VERSION = "0.2.0"
+  VERSION = "0.3.1"
 end

data/lib/iers.rb

@@ -40,11 +40,17 @@ module IERS
       yield configuration
     end
 
+    # @api private
+    # @param candidate [Configuration]
+    # @return [Boolean] whether the gem reads its data through this object
+    def active_configuration?(candidate)
+      @configuration.equal?(candidate)
+    end
+
     # @return [void]
     def reset_configuration!
       @configuration = nil
       Data.clear_loaded!
-      LeapSecond.clear_cached!
     end
 
     # @return [void]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iers
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Rémy Hannequin