sequel-tstzrange-fields 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aa09554035af74a589ddd776eff11bf70fa33431c841bb20de3eef9674b4051
-  data.tar.gz: 824c97bbb6ea48333980f88aa42f6b5b009f3b1d61fefb13646f54d6511eb378
+  metadata.gz: 602f1c9282af7052d0c4b5131a2f9872a383a51783f8f43bfd601066c5121136
+  data.tar.gz: 9d3594a668a50adb1ab8f88a33db59d4fc779d4012f281f01791f98ae74c302d
 SHA512:
-  metadata.gz: c2f59a89cb58c004224b1931a3359bacc70c296c322d108f84082488fb225f1866168d3adfc2669cdbe45cb52819bfe42f3b9b8a9801ee3740ab4ec6a21264c6
-  data.tar.gz: ec010f2605963f1cd27d03a1945854ed2f675b1fd77c9435f640673145cc636f64118ff24babd086689c2940a4656c799163d15c7c7df2466189784cb72076f9
+  metadata.gz: 327f56f8a6e62c01fd7c86620859a375fa3243f2019ce20e466f9e0651277803070618f4573f3272571c23b1defbee1a599826d2406507358e50e7c1d58c47b0
+  data.tar.gz: 18b71bc1c26e4913d4fb9f81f88ca2368c12f5bc9ff38ae483f8482566d67a9a080f7109abd4d8e36863897132a02c9cc5e7a28af09d6a690c20e205e0aa2a00

data/lib/sequel/plugins/tstzrange_fields.rb

@@ -0,0 +1,120 @@
+# 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 range:
+#
+#   class ACME::Lease < Sequel::Model(:leases)
+#       plugin :tstzrange_fields, :active_during
+#
+# And in the schema:
+#
+#   create_table(:leases) do
+#       primary_key :id
+#       tstzrange :active_during
+#   end
+#
+# You can use it as follows:
+#
+#   lease = ACME::Lease.new
+#   lease.active_during_begin = Time.now
+#   lease.active_during_end = 1.year.from_now
+#   lease.active_during = 1.year.ago..1.year.from_now
+#   lease.active_during_end = nil # Unbounded end set
+#   lease.active_during = nil # Empty set
+#
+module Sequel
+  module Plugins
+    module TstzrangeFields
+      VERSION = SequelTstzrangeFields::VERSION
+
+      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
+        args << :period if args.empty?
+        args = args.flatten
+
+        setup_model(model)
+
+        args.flatten.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
+      end
+
+      def self.create_accessors(model, column)
+        get_column_method = column.to_sym
+        set_column_method = "#{column}=".to_sym
+        get_begin_method = "#{column}_begin".to_sym
+        set_begin_method = "#{column}_begin=".to_sym
+        get_end_method = "#{column}_end".to_sym
+        set_end_method = "#{column}_end=".to_sym
+
+        model.define_method(get_column_method) do
+          self[column]
+        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"
+              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
+        end
+
+        model.define_method(get_begin_method) do
+          send(get_column_method).begin
+        end
+
+        model.define_method(set_begin_method) do |new_time|
+          new_range = self.class.new_tstzrange(new_time, send(get_end_method))
+          send(set_column_method, new_range)
+        end
+
+        model.define_method(get_end_method) do
+          r = send(get_column_method)
+          return r&.end
+        end
+
+        model.define_method(set_end_method) do |new_time|
+          new_range = self.class.new_tstzrange(send(get_begin_method), new_time)
+          send(set_column_method, new_range)
+        end
+      end
+    end
+  end
+end

data/lib/sequel_tstzrange_fields/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sequel-tstzrange-fields
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Lithic Tech
@@ -94,14 +94,18 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 'Gem for enabling time ranges when working with postgres
+
+  '
 email:
 - hello@lithic.tech
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage:
+files:
+- lib/sequel/plugins/tstzrange_fields.rb
+- lib/sequel_tstzrange_fields/version.rb
+homepage: https://github.com/lithictech/sequel-tstzrange-fields
 licenses:
 - MIT
 metadata: