duration.rb 0.5.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55bc0f38eb9c213a08b6ca49ea69908c2aeff8679637df50ab7309bc564ad457
-  data.tar.gz: 14032f8850e3499398761abcf3155c1390d22b89e71e1c2be302cfe6b9863f5b
+  metadata.gz: 4b96f8854514150e9a991174eee5ab4dbb5f0e829e3e3c15a093b1846a127f06
+  data.tar.gz: 7333289ca6c7552ac8db51fcfe6ea03a1101adc5f512a5167e2959ff03e544b8
 SHA512:
-  metadata.gz: 41cc6f366ad11f553d299616312fbf325bb7979dfd7f978302a3b0afc4697b2d92dd506b35481deb17718add06377b0037df7d022a1f817010da69396a939cf4
-  data.tar.gz: ef8d3edc58e19d3a2715901904af9be11600e52e1ec6b03cc5a58e920d69c6db1e4e26632169aa887c6d3ddbf99b9d6da928053f505faa4cf5c8890ad4a4229f
+  metadata.gz: 5c763588f6127dd447cdfb7f0ec84230aec91ca79d7b561e76ed8084899e6bdcff073726498bfd079c430cc7e43990fe34b0cd1afa9fb5236ee9c9efa9c66ba7
+  data.tar.gz: cd053efb36ff1ac0f323464464ed879d19c6326af14b99aba93af9f3b12908744a00e6838b355e6a45e879236d4d40773072af965b726261ddcb3ebbe3589b54

data/CHANGELOG

@@ -1,5 +1,27 @@
 # CHANGELOG
 
+## 20260816
+
+0.6.1: Documentation fixes for Months, which said one thing in the README and another in the class comment, and showed a third in the examples.
+
+1. ~ lib/Duration/Months.rb: /Months is slated for removal in 0.5.0/Months is therefore slated for removal/. 0.5.1 dropped the version from README.md, 0.5.0 having been and gone with Months still in place, but left the class comment still naming it, so the two have disagreed since and the comment is now two minor versions stale.
+2. ~ README.md: + 6.months.ago and 6.months.hence to the Time Calculations examples, each with the mean month noted beside it. Every other unit was shown and Months alone omitted, which implies that Months does not answer ago and hence, when 0.4.0 decided that it does and A Note on Months says as much eleven lines below. The examples are what is read first, so the omission was the louder statement of the two.
+3. ~ Duration::VERSION: /0.6.0/0.6.1/
+
+
+## 20260812
+
+0.6.0: The unit classes are now autoloaded so as to avoid circular loading messages when running the tests. It's faster too!
+
+1. + lib/duration.rb: Autoload each unit file, and Common and Relative.
+2. ~ lib/Duration/*.rb: - require_relative './Common', './Relative'
+3. ~ lib/Duration/*.rb: + require_relative '../duration'. Each unit had required both of its neighbours, so that every adjacent pair was a cycle and Ruby warned upon each under -w. The ring was connected besides, so requiring any one unit dragged in eleven files of the thirteen and no part of the gem could be left unread. Requiring one now brings five, and the rest arrive as they are named.
+4. ~ lib/duration.rb: Add a note why VERSION is required and not declared, being the one exception.
+5. ~ README.md: Add a line in the Loading section.
+6. + test/loading_test.rb: that a single unit file required alone still converts, that a unit never named is never read, that one named is, and that the whole loads without warning under -w. Each runs in a process of its own, the test helper having already loaded everything in this one.
+7. ~ Duration::VERSION: /0.5.2/0.6.0/
+
+
 ## 20260812
 
 0.5.2: + gemspec test.

data/README.md

@@ -52,8 +52,12 @@ require 'duration-numeric'  # opt in to the Numeric sugar (5.minutes, etc.),
 ```
 
 The examples below use the `Numeric` sugar, so they assume
-`require 'duration-numeric'`. Without it, construct durations directly with
-`Duration::Minutes.new(5)` and friends.
+`require 'duration-numeric'`. Without it durations are constructed directly with
+`Duration::Minutes.new(5)` and so on.
+
+Either require declares where the unit classes are without reading them. A unit
+file is read when its class is first named, so a program dealing in seconds and
+minutes reads the files for seconds and minutes and leaves the rest unread.
 
 ## Usage
 
@@ -123,12 +127,19 @@ The examples below use the `Numeric` sugar, so they assume
 5.days.ago                      # => #<Time:> (now - 5.days.to_seconds.to_f)
 6.weeks.ago                     # => #<Time:> (now - 6.weeks.to_seconds.to_f)
 
+# Months too, but by the Gregorian mean month rather than a calendar month, so
+# the result is approximate. See A Note on Months below.
+6.months.ago                    # => #<Time:> (now - 6.months.to_seconds.to_f)
+
 # The future
 2.seconds.hence                 # => #<Time:> (now + 2.seconds.to_seconds.to_f)
 3.minutes.hence                 # => #<Time:> (now + 3.minutes.to_seconds.to_f)
 4.hours.hence                   # => #<Time:> (now + 4.hours.to_seconds.to_f)
 5.days.hence                    # => #<Time:> (now + 5.days.to_seconds.to_f)
 6.weeks.hence                   # => #<Time:> (now + 6.weeks.to_seconds.to_f)
+
+# Again by the mean month, and so approximate:
+6.months.hence                  # => #<Time:> (now + 6.months.to_seconds.to_f)
 ```
 
 ### A Note on Months

data/lib/Duration/Days.rb

@@ -1,10 +1,7 @@
 # Duration/Days.rb
 # Duration::Days
 
-require_relative './Common'
-require_relative './Relative'
-require_relative './Hours'
-require_relative './Weeks'
+require_relative '../duration'
 
 module Duration
   class Days

data/lib/Duration/Hours.rb

@@ -1,10 +1,7 @@
 # Duration/Hours.rb
 # Duration::Hours
 
-require_relative './Common'
-require_relative './Relative'
-require_relative './Minutes'
-require_relative './Days'
+require_relative '../duration'
 
 module Duration
   class Hours

data/lib/Duration/Microseconds.rb

@@ -1,10 +1,7 @@
 # Duration/Microseconds.rb
 # Duration::Microseconds
 
-require_relative './Common'
-require_relative './Relative'
-require_relative './Nanoseconds'
-require_relative './Milliseconds'
+require_relative '../duration'
 
 module Duration
   class Microseconds

data/lib/Duration/Milliseconds.rb

@@ -1,10 +1,7 @@
 # Duration/Milliseconds.rb
 # Duration::Milliseconds
 
-require_relative './Common'
-require_relative './Relative'
-require_relative './Microseconds'
-require_relative './Seconds'
+require_relative '../duration'
 
 module Duration
   class Milliseconds

data/lib/Duration/Minutes.rb

@@ -1,10 +1,7 @@
 # Duration/Minutes.rb
 # Duration::Minutes
 
-require_relative './Common'
-require_relative './Relative'
-require_relative './Seconds'
-require_relative './Hours'
+require_relative '../duration'
 
 module Duration
   class Minutes

data/lib/Duration/Months.rb

@@ -1,9 +1,7 @@
 # Duration/Months.rb
 # Duration::Months
 
-require_relative './Common'
-require_relative './Relative'
-require_relative './Weeks'
+require_relative '../duration'
 
 module Duration
   # A month is not a fixed quantity: its length depends on the calendar. The
@@ -13,7 +11,7 @@ module Duration
   #
   # ago and hence (via Relative) inherit the same caveat: they displace by the
   # mean month rather than an actual calendar month, so they are approximate,
-  # not calendar-correct. Months is slated for removal in 0.5.0.
+  # not calendar-correct. Months is therefore slated for removal.
   class Months
     include Common
     include Relative

data/lib/Duration/Nanoseconds.rb

@@ -1,9 +1,7 @@
 # Duration/Nanoseconds.rb
 # Duration::Nanoseconds
 
-require_relative './Common'
-require_relative './Relative'
-require_relative './Microseconds'
+require_relative '../duration'
 
 module Duration
   class Nanoseconds

data/lib/Duration/Seconds.rb

@@ -1,10 +1,7 @@
 # Duration/Seconds.rb
 # Duration::Seconds
 
-require_relative './Common'
-require_relative './Relative'
-require_relative './Milliseconds'
-require_relative './Minutes'
+require_relative '../duration'
 
 module Duration
   class Seconds

data/lib/Duration/VERSION.rb

@@ -1,3 +1,3 @@
 module Duration
-  VERSION = '0.5.2'
+  VERSION = '0.6.1'
 end

data/lib/Duration/Weeks.rb

@@ -1,10 +1,7 @@
 # Duration/Weeks.rb
 # Duration::Weeks
 
-require_relative './Common'
-require_relative './Relative'
-require_relative './Days'
-require_relative './Months'
+require_relative '../duration'
 
 module Duration
   class Weeks

data/lib/duration.rb

@@ -1,15 +1,24 @@
 # Duration.rb
 # Duration
 
-module Duration; end
-
-require_relative 'Duration/Nanoseconds'
-require_relative 'Duration/Microseconds'
-require_relative 'Duration/Milliseconds'
-require_relative 'Duration/Seconds'
-require_relative 'Duration/Minutes'
-require_relative 'Duration/Hours'
-require_relative 'Duration/Days'
-require_relative 'Duration/Weeks'
-require_relative 'Duration/Months'
+# Previously, neighbouring units which are used conversion methods used to be requires at the top of each file, so that every adjacent pair was a cycle and Ruby warned upon each under -w.
+
+# Now, a unit file is read when its class is first named and not before, which is what lets a program dealing in seconds and minutes loads only Seconds and Minutes, so that units are may easily be left unused.
+
+module Duration
+  autoload :Common,       File.expand_path('Duration/Common', __dir__)
+  autoload :Relative,     File.expand_path('Duration/Relative', __dir__)
+  autoload :Nanoseconds,  File.expand_path('Duration/Nanoseconds', __dir__)
+  autoload :Microseconds, File.expand_path('Duration/Microseconds', __dir__)
+  autoload :Milliseconds, File.expand_path('Duration/Milliseconds', __dir__)
+  autoload :Seconds,      File.expand_path('Duration/Seconds', __dir__)
+  autoload :Minutes,      File.expand_path('Duration/Minutes', __dir__)
+  autoload :Hours,        File.expand_path('Duration/Hours', __dir__)
+  autoload :Days,         File.expand_path('Duration/Days', __dir__)
+  autoload :Weeks,        File.expand_path('Duration/Weeks', __dir__)
+  autoload :Months,       File.expand_path('Duration/Months', __dir__)
+end
+
+# VERSION is required rather than autoloaded, and is the one exception, as there nothing which will load it at runtime.
+
 require_relative 'Duration/VERSION'

data/test/loading_test.rb

@@ -0,0 +1,32 @@
+# test/loading_test.rb
+
+require_relative './test_helper'
+
+# Each of these wants a process of its own. Within this one the test helper has already loaded the lot, so nothing here could tell a unit which was declared from a unit which was read.
+
+describe 'loading' do
+  def ruby(source, *flags)
+    lib = File.expand_path('../lib', __dir__)
+    IO.popen(['ruby', *flags, "-I#{lib}", '-e', source], err: [:child, :out]){|io| io.read}.strip
+  end
+
+  it "converts when a single unit file is required alone" do
+    _(ruby('require "Duration/Seconds"; print Duration::Seconds.new(90).to_minutes.to_f')) \
+      .must_equal('1.5')
+  end
+
+  it "does not read a unit which is never named" do
+    _(ruby('require "duration.rb"; Duration::Seconds; print $LOADED_FEATURES.grep(/Months/).size')) \
+      .must_equal('0')
+  end
+
+  it "reads a unit as soon as it is named" do
+    _(ruby('require "duration.rb"; Duration::Months; print $LOADED_FEATURES.grep(/Months/).size')) \
+      .must_equal('1')
+  end
+
+  it "loads without warning under -w, no unit requiring another" do
+    _(ruby('require "duration.rb"; Duration::Months.new(1).to_nanoseconds; print "ok"', '-w')) \
+      .must_equal('ok')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duration.rb
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.1
 platform: ruby
 authors:
 - thoran
@@ -93,6 +93,7 @@ files:
 - test/Duration/VERSION_test.rb
 - test/Duration/Weeks_test.rb
 - test/gemspec_test.rb
+- test/loading_test.rb
 - test/test_helper.rb
 homepage: http://github.com/thoran/duration.rb
 licenses: