et-orbi 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bff6c08f6ece712b2058c0e91120b4bc4fff8925a377fdd8079ec4bbe151a44
-  data.tar.gz: 01ff0b2c74e2a62bb7b895fc83a2a993b2a5a2e1e6088fc4301848076b83a2f0
+  metadata.gz: 1fc097e4fc84ec60bd0c5576e2d20e44c8e1f93a25ca54d18705c8a15ac46d15
+  data.tar.gz: aaf8974a36588b4a339f97fb4ab18ac124d86d189874bb951489788000e4a66e
 SHA512:
-  metadata.gz: 1d6da83141821bb9f8afe331b8a24caeb88ef8723ea1b34e8c3ce34c8028e0f50a6b254e16fb4501d1cee092cec716e82cac970d1fdef130206fbcc38004d2a5
-  data.tar.gz: aa234212a99fb2c4991ee1cf081a34247f73bd01170d4cd3db2769c6c5d1d003543db0d08a887e4c544310e0da01f593d77d86f71c5b73e59cf029c5210fc075
+  metadata.gz: 7bbe86df96ee13a4884f680629d80b3965721d5f78aac42a712aadb18fa7c89160be8679aa3bcc74405cab8bf964e68b67d94efd2a87baf75cdfbe604e4c52c5
+  data.tar.gz: ba98fd3c1557f4a6c5aa741763c03d82ccf2e0254d751616939406b033392d0b7d34551ed54388e03bcd10df5273203345d75090ee98289c8e3c9c318a1a9490

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 # CHANGELOG.md
 
 
+## et-orbi 1.4.0  released 2025-09-28
+
+- Rework EoTime #rweek and #rday
+- Introduce EtOrbi.rweek_ref= (:sunday, :monday, :iso, :us, ...)
+
+
 ## et-orbi 1.3.0  released 2025-08-08
 
 - Use probatio for testing

data/CREDITS.md

@@ -1,6 +1,7 @@
 
 # et-orbi credits
 
+* Hugh Kelsey https://github.com/hughkelsey fugit gh-94 rweek/rday rework
 * Keenan Brock https://github.com/kbrock version parsing and ostruct dep
 * Benjami Darcet https://github.com/bdarcet https://github.com/floraison/fugit/issues/67 gh-38
 * https://github.com/franckduche https://github.com/floraison/fugit/issues/67 gh-38

data/README.md

@@ -69,6 +69,77 @@ EtOrbi.platform_info
     # astz: ActiveSupport provided Time.zone
 ```
 
+
+### #rweek and #rday (clarification et-orbi 1.4.0)
+
+`EoTime#rweek` and `#rday` are mostly used in [fugit](https://github.com/floraison/fugit) for its [modulo extension](https://github.com/floraison/fugit?tab=readme-ov-file#the-modulo-extension).
+
+By default (since et-orbi 1.4.0), the "reference week" for et-orbi
+starts on Monday 2018-12-31, its `#rweek` 0 and `#rday` 0
+
+```ruby
+class EtOrbi::EoTime;
+  def rr; [ strftime('%A'), rweek, rday ]; end
+end
+
+EtOrbi.rweek_ref # => '2018-12-31'
+
+                               #                  rw  rd
+EtOrbi.parse('2018-12-29').rr  # => [ "Saturday", -1, -2 ]
+EtOrbi.parse('2018-12-30').rr  # => [ "Sunday",   -1, -1 ]
+EtOrbi.parse('2018-12-31').rr  # => [ "Monday",    0,  0 ]
+```
+
+Users living in the US, in Canada, or in the Philippines where the week start on Sunday can tune their et-orbi:
+```ruby
+class EtOrbi::EoTime;
+  def rr; [ strftime('%A'), rweek, rday ]; end
+end
+
+EtOrbi.rweek_ref = :sunday
+EtOrbi.rweek_ref # => '2018-12-30'
+
+                               #                  rw  rd
+EtOrbi.parse('2018-12-29').rr  # => [ "Saturday", -1, -1 ]
+EtOrbi.parse('2018-12-30').rr  # => [ "Sunday",    0,  0 ]
+EtOrbi.parse('2018-12-31').rr  # => [ "Monday",    0,  1 ]
+```
+
+You can set the `rweek_ref` to `:sunday`, `:saturday`, `:monday`, or `:iso`, `:us`, or `:default`.
+
+`:sunday` and `:us` are equivalent. `:monday`, `:iso`, and `:default` are equivalent.
+
+If you feel like it, you can choose your own reference:
+
+```ruby
+class EtOrbi::EoTime;
+  def rr; [ strftime('%A'), rweek, rday ]; end
+end
+
+EtOrbi.rweek_ref = '2025-09-28'
+
+                               #                    rw     rd
+EtOrbi.parse('2018-12-29').rr  # => [ "Saturday", -353, -2465 ]
+EtOrbi.parse('2018-12-30').rr  # => [ "Sunday",   -352, -2464 ]
+EtOrbi.parse('2018-12-31').rr  # => [ "Monday",   -352, -2463 ]
+```
+
+Before et-orbi 1.4.0, the computation was a bit different, yielding:
+```ruby
+class EtOrbi::EoTime;
+  def rr; [ strftime('%A'), rweek, rday ]; end
+end
+
+                               #                 rw  rd
+EtOrbi.parse('2018-12-29').rr  # => [ "Saturday", 0, -2 ]
+EtOrbi.parse('2018-12-30').rr  # => [ "Sunday",   0, -1 ]
+EtOrbi.parse('2018-12-31').rr  # => [ "Monday",   0,  0 ]
+EtOrbi.parse('2019-01-01').rr  # => [ "Tuesday",  1,  1 ]
+```
+
+This change was motivated by [fugit gh-114](https://github.com/floraison/fugit/issues/114).
+
+
 ### Chronic integration
 
 By default, et-orbi relies on [Chronic](https://github.com/mojombo/chronic) to parse strings like "tomorrow" or "friday 1pm", if `Chronic` is present.

data/lib/et-orbi/time.rb

@@ -91,13 +91,12 @@ module EtOrbi
       touch
     end
 
-    # Nullify the "caches" used by #to_time, #rweek, and others
+    # Nullify the "caches" used by #to_time, #rday, and others
     #
     def touch
 
       @time = nil
       @rday = nil
-      @rweek = nil
     end
 
     def seconds=(f)
@@ -358,30 +357,27 @@ module EtOrbi
         - count_weeks(EtOrbi.make_time(strftime('%F 12:00:00 %/Z')) , 1) ]
     end
 
-    # "reference week", used in fugit for cron modulo notation
+    # "reference day", used in fugit for cron modulo notation
     #
-    def rweek
+    def rday
 
-      @rweek ||=
-        begin
-          ref = EtOrbi.make_time('2019-01-01 12:00:00', @zone)
-          noon = EtOrbi.make_time(strftime('%F 12:00:00'), @zone)
-          ((noon - ref) / WEEK_S).floor + 1
-        end
+      @rday ||= (
+        (EtOrbi.make_time(strftime('%F 12:00:00'), @zone) - rref) / DAY_S
+          ).floor
     end
 
     # "reference week", used in fugit for cron modulo notation
     #
-    def rday
+    def rweek
 
-      @rday ||=
-        begin
-          ref = EtOrbi.make_time('2019-01-01 12:00:00', @zone)
-          noon = EtOrbi.make_time(strftime('%F 12:00:00'), @zone)
-          ((noon - ref) / DAY_S).floor + 1
-        end
+      rday / 7
     end
 
+    # A debug method, seen in its first iteration in
+    # https://github.com/floraison/et-orbi?tab=readme-ov-file#rweek-and-rday-clarification-et-orbi-140
+    #
+    def rr; [ strftime('%F %a'), rweek, rday ]; end
+
     def reach(points)
 
       t = EoTime.new(self.to_f, @zone)
@@ -478,6 +474,40 @@ module EtOrbi
 
       o.to_f
     end
+
+    # Gives back the Eotime instance pointing to the reference day
+    # used to compute #rweek and #rday
+    #
+    def rref
+
+      EtOrbi.make_time("#{::EtOrbi.rweek_ref} 12:00:00", @zone)
+    end
+  end
+end
+
+module EtOrbi
+
+  #RWEEK_REF_DEFAULT = '2019-01-01'.freeze
+  RWEEK_REF_DEFAULT = '2018-12-31'.freeze # monday / ISO 8601
+
+  class << self
+
+    def rweek_ref=(x)
+
+      @rweek_ref =
+        case x
+        when /^[21]\d{3}-(1[012]|0?\d)-(3[01]|[21]\d|0?\d)$/ then x
+        when :saturday                then '2019-01-05'
+        when :sunday, :us             then '2018-12-30'
+        when :monday, :default, :iso  then RWEEK_REF_DEFAULT
+        else fail(ArgumentError.new("not a valid rweek_ref #{x.inspect}"))
+        end
+    end
+
+    def rweek_ref
+
+      @rweek_ref || RWEEK_REF_DEFAULT
+    end
   end
 end
 

data/lib/et-orbi/version.rb

@@ -1,6 +1,6 @@
 
 module EtOrbi
 
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: et-orbi
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - John Mettraux
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-08 00:00:00.000000000 Z
+date: 2025-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzinfo