power-hours 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce07496dcd6c713558c0f2aff72ba0d84f7ed5ccd56dedd561d18a055c968660
-  data.tar.gz: ac50321b8fc3644d8061d81364bc6eafafd31206f0eeee0111310b3e91e55e64
+  metadata.gz: a05edfaea3aaf3667bfc1c6281827524f34cea6c924bb3bbaefe5c1cff53dd3d
+  data.tar.gz: c0d73bd22938295b7cdc86134d4e55ce1e52566f500e5e1320d4f5daec6371fc
 SHA512:
-  metadata.gz: fd0e0588cd49d93043077f1cb195c6a63e575623a58b998c50a577f859614dbe2bf1f3fe689164f6e326182dcbdb1d5fc3dca9bf50d9e4434ac4815c876d72d7
-  data.tar.gz: 850ebcaa28862ad8e05d98cb860b9642d0dd6b6fe675a18da8b18d2fd1b1c2cd1f872de72896a27ce51cd0c3ab364ba221cbf706aaea49d8f16bcf7f0faa5989
+  metadata.gz: a93d5ffd74e36026ea4e72702181655751aa6d42aa9319ce922f1809f2be06f756db8dadaaef251983aa4e3cc563b818bf9805ea8e7967e6db4280fe4f003f1c
+  data.tar.gz: 3494d1052057bf5ecabb2bb70f0d15ef38c52132c5acb18cf9865af943c3eedcaf6ad2dfb1306db8a93a744bbc6572798c1cae56cb0ad349fe8c79469c6f26de

data/README.md

@@ -5,6 +5,7 @@ Power Hours provides a small, explicit DSL for weekly opening-hours schedules.
 It supports:
 - multiple windows per day
 - overnight windows (for example `22:00-02:00`)
+- stable ordering of windows within each day
 - serialization to/from hashes
 - optional model mixin helpers via `OpeningHours::Model`
 
@@ -39,12 +40,14 @@ schedule.open?(at: Time.new(2024, 1, 6, 1, 0, 0))  # => true (Saturday, from Fri
 ### Construct directly from hash data
 
 ```ruby
-schedule = OpeningHours::Schedule.from_hash(
+schedule = OpeningHours::Schedule.build(
   "mon" => ["09:00-17:00"],
   "fri" => ["22:00-02:00"]
 )
 ```
 
+If both a hash and a block are passed to `Schedule.build`, the block definition is used.
+
 ### Serialize for persistence
 
 ```ruby
@@ -68,6 +71,23 @@ schedule.as_json
 schedule.as_json(include_empty: true) # include empty weekdays too
 ```
 
+### Simple string output
+
+```ruby
+schedule.to_s
+# MON: 09:00-17:00
+# FRI: 22:00-02:00
+
+schedule.to_s(true) # include empty weekdays too
+# SUN:
+# MON: 09:00-17:00
+# TUE:
+# WED:
+# THU:
+# FRI: 22:00-02:00
+# SAT:
+```
+
 ### Optional mixin for app models
 
 `OpeningHours::Model` is a Rails integration mixin (uses typed attributes).

data/lib/opening_hours/schedule.rb

@@ -3,16 +3,14 @@
 module OpeningHours
   class Schedule < Data.define(:sun, :mon, :tue, :wed, :thu, :fri, :sat)
     class << self
-      def build(&block)
-        return new unless block_given?
-
-        builder = Builder.new
-        builder.instance_eval(&block)
-        builder.schedule
-      end
-
-      def from_hash(hash)
-        new(**hash.to_h.transform_keys(&:to_sym))
+      def build(hash = {}, &block)
+        if block_given?
+          builder = Builder.new
+          builder.instance_eval(&block)
+          builder.schedule
+        else
+          new(**hash.to_h.transform_keys(&:to_sym))
+        end
       end
     end
 
@@ -30,7 +28,7 @@ module OpeningHours
 
     def open?(at: Time.now)
       current_time = at.strftime("%H:%M")
-      windows_to_check(at).any? { |window| window.cover?(current_time) }
+      windows_to_check(at).any? { it.cover?(current_time) }
     end
 
     def to_h
@@ -42,10 +40,16 @@ module OpeningHours
       include_empty ? to_h : to_h.reject { |_day, windows| windows.empty? }
     end
 
+    def to_s(include_empty = false)
+      as_json(include_empty: include_empty).map do |day, windows|
+        "#{day.upcase}: #{windows.join(', ')}"
+      end.join("\n")
+    end
+
     private
 
     def normalize_day(values)
-      Array(values).map { TimeWindow[it] }.freeze
+      Array(values).map { TimeWindow[it] }.sort.freeze
     end
 
     # Check current day windows + previous day's overnight leftovers

data/lib/opening_hours/time_window.rb

@@ -2,6 +2,8 @@
 
 module OpeningHours
   class TimeWindow < Data.define(:opens, :closes)
+    include Comparable
+
     def self.[](input)
       case input
       in TimeWindow => tw
@@ -39,5 +41,9 @@ module OpeningHours
         time >= opens && time <= closes
       end
     end
+
+    def <=>(other)
+      opens <=> TimeWindow[other].opens
+    end
   end
 end

data/lib/opening_hours/type.rb

@@ -29,9 +29,9 @@ module OpeningHours
       in OpeningHours::Schedule => schedule
         schedule
       in Hash => hash
-        OpeningHours::Schedule.from_hash(hash)
+        OpeningHours::Schedule.build(hash)
       in candidate if (hash = hash_from(candidate))
-        OpeningHours::Schedule.from_hash(hash)
+        OpeningHours::Schedule.build(hash)
       else
         raise ArgumentError, "Cannot cast #{value.inspect} to OpeningHours::Schedule"
       end

data/lib/opening_hours/version.rb

@@ -1,3 +1,3 @@
 module OpeningHours
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/sig/power/hours.rbs

@@ -23,12 +23,15 @@ module OpeningHours
   end
 
   class TimeWindow
+    include Comparable[time_window_input]
+
     attr_reader opens: OpeningHours::TimeOfDay
     attr_reader closes: OpeningHours::TimeOfDay
 
     def self.[]: (time_window_input input) -> OpeningHours::TimeWindow
     def initialize: (opens: time_input, closes: time_input) -> void
 
+    def <=>: (time_window_input other) -> Integer?
     def to_a: () -> [OpeningHours::TimeOfDay, OpeningHours::TimeOfDay]
     def to_s: () -> String
     def overnight?: () -> bool
@@ -44,9 +47,8 @@ module OpeningHours
     attr_reader fri: Array[OpeningHours::TimeWindow]
     attr_reader sat: Array[OpeningHours::TimeWindow]
 
-    def self.build: () -> OpeningHours::Schedule
-                | () { () -> untyped } -> OpeningHours::Schedule
-    def self.from_hash: (Hash[Symbol | String, untyped] hash) -> OpeningHours::Schedule
+    def self.build: (?Hash[Symbol | String, untyped] hash) -> OpeningHours::Schedule
+                | (?Hash[Symbol | String, untyped] hash) { () -> untyped } -> OpeningHours::Schedule
     def initialize: (
       ?mon: day_windows_input,
       ?tue: day_windows_input,
@@ -60,6 +62,7 @@ module OpeningHours
     def open?: (?at: untyped) -> bool
     def to_h: () -> serialized_schedule
     def as_json: (?Hash[Symbol, untyped] options) -> serialized_schedule
+    def to_s: (?bool include_empty) -> String
   end
 
   class Builder

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power-hours
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kevin Melchert