sequel-tstzrange-fields 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ce882832d62ea1342d7daaea5e30958d2bda7f52f02d6279d0f03b38b4b0a10
-  data.tar.gz: 99d7b2e90fe4b6d050f9e4f856d709bab47a97cf658ecf12c57131705006a89e
+  metadata.gz: 1e716d56781dee5b6570b4d933c58789e787668c0c6d395b46e2b84baad71767
+  data.tar.gz: f3f3adc71237ae2c3f077ad8bdaf7a8b144051e8a6f17b2b9643e7341c7ef258
 SHA512:
-  metadata.gz: '0389be6b6156008e52eb8db931bd1b710aa444ec877a1971c7255cca008c9650e46d14ea107525ddae52447cbdc41dcb901425b1ebcf168a870ee2741272fca0'
-  data.tar.gz: cd145bb21d5a9b24c260bcbf342bcc214dc7a1eac5adbb05f8ab64ed47b148921b7545866f1750dedc41d83f76113760457a882457f73517998968847223f9b4
+  metadata.gz: 9b293cd1d78b344123eded05c1120997ae1d40eb82de9c30aa550084b80b8e10568235845fd9b2b7b179cebb0f2171ae69643028e9e0ce392b37dae85fd63400
+  data.tar.gz: cd286d73033e03a7a0392381019856cdc89b43f3361a938b3ead0c0d456c26e04d4bcd165efbfba7c4cbeff7b6409e8907170b87368d93fc697ef7fc413aae6f

data/lib/sequel/plugins/tstzmultirange_fields.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "sequel"
+require "sequel/model"
+
+require_relative "../../sequel_tstzrange_fields/version"
+
+# Plugin for adding methods for working with time ranges.
+#
+# == Example
+#
+# Defining a model class with a timestamptz multirange:
+#
+#   class Reminder < Sequel::Model(:reminders)
+#       plugin :tstzmultirange_fields, :active_during
+#
+# And in the schema:
+#
+#   create_table(:reminders) do
+#       primary_key :id
+#       tstzmultirange :active_during
+#   end
+#
+# You can use it as follows:
+#
+#   r = Reminder.new
+#   reminder.active_during = [{begin: Time.now, end: 1.year.from_now}]
+#   reminder.active_during = [1.year.ago..1.year.from_now]
+#   reminder.active_during = [Time.now..]
+#   reminder.active_during = []
+#
+module Sequel
+  module Plugins
+    module TstzmultirangeFields
+      VERSION = SequelTstzrangeFields::VERSION
+
+      def self.apply(_model, _opts={})
+        Sequel.extension :pg_range_ops
+      end
+
+      def self.configure(model, *args)
+        SequelTstzrangeFields::Helpers.check_schema_type_available(model.db, :tstzmultirange, :pg_multirange)
+        args << :periods if args.empty?
+        args = args.flatten
+
+        setup_model(model)
+        model.tstzrange_columns = args
+        model.tstzrange_columns.each do |column|
+          create_accessors(model, column)
+        end
+      end
+
+      def self.setup_model(model)
+        model.extend(SequelTstzrangeFields::Helpers::ClassMethods)
+      end
+
+      def self.create_accessors(model, column)
+        get_column_method = column.to_sym
+        set_column_method = :"#{column}="
+
+        model.define_method(get_column_method) do
+          self[column]
+        end
+
+        model.define_method(set_column_method) do |values|
+          values = [values] unless values.respond_to?(:to_ary)
+          ranges = values.map { |v| self.class.value_to_tstzrange(v) }
+          multirange = Sequel.pg_multirange(ranges, :tstzmultirange)
+          self[column] = multirange
+        end
+      end
+
+      module ClassMethods
+        # The Array of fields which are tstzrange columns.
+        attr_accessor :tstzrange_columns
+      end
+
+      module DatasetMethods
+        # Limit the dataset to the rows where the tstzrange column contains the given value.
+        # val is cast into a timestamptz.
+        # column is the default/first tstzrange column if not given.
+        def tstzrange_contains(val, column: nil)
+          column ||= self.model.tstzrange_columns.first
+          self.where(Sequel.pg_range(column).contains(Sequel.cast(val, :timestamptz)))
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/tstzrange_fields.rb

@@ -4,6 +4,7 @@ require "sequel"
 require "sequel/model"
 
 require_relative "../../sequel_tstzrange_fields/version"
+require_relative "../../sequel_tstzrange_fields/helpers"
 
 # Plugin for adding methods for working with time ranges.
 #
@@ -40,36 +41,19 @@ module Sequel
       end
 
       def self.configure(model, *args)
-        unless model.db.schema_type_class(:tstzrange)
-          msg = "tstzrange_fields plugin requires pg_range db extension to be installed. " \
-                "Use db.extension(:pg_range) after the db = Sequel.connect call."
-          raise msg
-        end
+        SequelTstzrangeFields::Helpers.check_schema_type_available(model.db, :tstzrange, :pg_range)
         args << :period if args.empty?
         args = args.flatten
 
         setup_model(model)
-        model.tstzrange_columns = args.flatten
+        model.tstzrange_columns = args
         model.tstzrange_columns.each do |column|
           create_accessors(model, column)
         end
       end
 
       def self.setup_model(model)
-        model.class.define_method(:new_tstzrange) do |b, e|
-          b = value_to_time(b)
-          e = value_to_time(e)
-          return Sequel::Postgres::PGRange.empty(:tstzrange) if b.nil? && e.nil?
-
-          return Sequel::Postgres::PGRange.new(b&.to_time, e&.to_time, db_type: :tstzrange, exclude_end: true)
-        end
-
-        model.class.define_method(:value_to_time) do |v|
-          return v if v.nil?
-          return v if v.respond_to?(:to_time)
-
-          return Time.parse(v)
-        end
+        model.extend(SequelTstzrangeFields::Helpers::ClassMethods)
       end
 
       def self.create_accessors(model, column)
@@ -85,19 +69,7 @@ module Sequel
         end
 
         model.define_method(set_column_method) do |value|
-          case value
-            when Sequel::Postgres::PGRange
-              self[column] = value
-            when Float::INFINITY
-              range = Sequel::Postgres::PGRange.new(nil, nil, empty: false, db_type: :tstzrange)
-              self[column] = range
-            when "empty", nil
-              self[column] = Sequel::Postgres::PGRange.empty(:tstzrange)
-          else
-              beg = value.respond_to?(:begin) ? value.begin : (value[:begin] || value["begin"])
-              en = value.respond_to?(:end) ? value.end : (value[:end] || value["end"])
-              self[column] = self.class.new_tstzrange(beg, en)
-          end
+          self[column] = self.class.value_to_tstzrange(value)
         end
 
         model.define_method(get_begin_method) do
@@ -127,13 +99,7 @@ module Sequel
       end
 
       module DatasetMethods
-        # Limit the dataset to the rows where the tstzrange column contains the given value.
-        # val is cast into a timestamptz.
-        # column is the default/first tstzrange column if not given.
-        def tstzrange_contains(val, column: nil)
-          column ||= self.model.tstzrange_columns.first
-          self.where(Sequel.pg_range(column).contains(Sequel.cast(val, :timestamptz)))
-        end
+        include SequelTstzrangeFields::Helpers::DatasetMethods
       end
     end
   end

data/lib/sequel_tstzrange_fields/helpers.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module SequelTstzrangeFields::Helpers
+  module ClassMethods
+    def new_tstzrange(b, e)
+      b = value_to_time(b)
+      e = value_to_time(e)
+      return Sequel::Postgres::PGRange.empty(:tstzrange) if b.nil? && e.nil?
+      return Sequel::Postgres::PGRange.new(b&.to_time, e&.to_time, db_type: :tstzrange, exclude_end: true)
+    end
+
+    def value_to_time(v)
+      return v if v.nil?
+      return v if v.respond_to?(:to_time)
+      return Time.parse(v)
+    end
+
+    # Convert a range-like value into a PGRange.
+    # Note that we accept 'start' in addition to 'begin' since this is also very common,
+    # and trying to coerce the keys of objects in an array during input
+    # can be very annoying.
+    def value_to_tstzrange(value)
+      case value
+        when Sequel::Postgres::PGRange
+          return value
+        when Float::INFINITY
+          range = Sequel::Postgres::PGRange.new(nil, nil, empty: false, db_type: :tstzrange)
+          return range
+        when "empty", nil
+          return Sequel::Postgres::PGRange.empty(:tstzrange)
+        else
+          beg = if value.respond_to?(:begin)
+                  value.begin
+            elsif value.respond_to?(:start)
+              value.start
+          else
+            value[:begin] || value["begin"] || value[:start] || value["start"]
+            end
+          en = value.respond_to?(:end) ? value.end : (value[:end] || value["end"])
+          return self.new_tstzrange(beg, en)
+      end
+    end
+  end
+
+  module DatasetMethods
+    # Limit the dataset to the rows where the tstzrange column contains the given value.
+    # val is cast into a timestamptz.
+    # column is the default/first tstzrange column if not given.
+    def tstzrange_contains(val, column: nil)
+      column ||= self.model.tstzrange_columns.first
+      self.where(Sequel.pg_range(column).contains(Sequel.cast(val, :timestamptz)))
+    end
+  end
+
+  def self.check_schema_type_available(db, dbtype, ext)
+    return if db.schema_type_class(dbtype)
+    msg = "plugin requires #{ext} db extension to be installed. " \
+          "Use db.extension(:#{ext}) after the db = Sequel.connect call."
+    raise TypeError, msg
+  end
+end

data/lib/sequel_tstzrange_fields/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-tstzrange-fields
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Lithic Tech
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-15 00:00:00.000000000 Z
+date: 2026-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg
@@ -103,7 +103,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/sequel/plugins/tstzmultirange_fields.rb
 - lib/sequel/plugins/tstzrange_fields.rb
+- lib/sequel_tstzrange_fields/helpers.rb
 - lib/sequel_tstzrange_fields/version.rb
 homepage: https://github.com/lithictech/sequel-tstzrange-fields
 licenses: