sequel-tstzrange-fields 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35ed468cd261b95f2381b6f90c5e1b8afa2318aa406ce06fbec30e8fdb85b89e
+  data.tar.gz: f501a551e2decbcc47ea133a0527921c182049a48248692ae0d0dea205b04471
+SHA512:
+  metadata.gz: 9d8fe7ed1837254fa1cc6a183f780d29af01e27367dbbe56e2a7380446ff7aa36808ead45bbf65e562a5e8aff849d8e04f9019a2db40f79f75d709495c1da160
+  data.tar.gz: 0b94430bb0c3cc0eec9e37309493f08c76fceda6277d71d9918ff12d0ee1b0aaafd5cae364c2eb6530ac72f1f245f1f2ce9c3f698544f0a58dc3c445c604459b

data/lib/sequel/plugins/tstzrange_fields.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'sequel'
+require 'sequel/model'
+require 'yajl'
+
+# 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 = '0.1.1'
+
+      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.nil? ? nil : r.end # &.end is invalid syntax
+        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/spec/sequel/plugins/tstzrange_fields_spec.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/integer/time'
+require 'sequel'
+require 'sequel/model'
+require 'sequel/extensions/pg_range'
+require 'sequel/plugins/tstzrange_fields'
+
+RSpec.describe Sequel::Plugins::TstzrangeFields do
+  before(:each) do
+    @db = Sequel.connect('postgres://sequel_tstzrange:sequel_tstzrange@localhost:18101/sequel_tstzrange_test')
+    @db.extension(:pg_range)
+  end
+  after(:each) do
+    @db.disconnect
+  end
+
+  it 'errors if the db does not have pg_range registered' do
+    db = Sequel.connect('postgres://sequel_tstzrange:sequel_tstzrange@localhost:18101/sequel_tstzrange_test')
+    db.create_table(:tstzrange_fields_test, temp: true) do
+      primary_key :id
+    end
+    expect do
+      mc = Class.new(Sequel::Model(db[:tstzrange_fields_test]))
+      mc.plugin(:tstzrange_fields)
+    end.to raise_error(/tstzrange_fields plugin requires/)
+  end
+
+  context 'with no fields given' do
+    let(:model_class) do
+      @db.create_table(:tstzrange_fields_test, temp: true) do
+        primary_key :id
+        tstzrange :period
+      end
+      mc = Class.new(Sequel::Model(@db[:tstzrange_fields_test]))
+      mc.class_eval do
+        def initialize(*)
+          super
+          self[:period] ||= self.class.new_tstzrange(nil, nil)
+        end
+      end
+      mc.plugin(:tstzrange_fields)
+      mc
+    end
+
+    let(:model_object) { model_class.new }
+
+    it 'uses :period as the high-level accessor' do
+      expect(model_object).to respond_to(:period, :period=, :period_begin, :period_begin=, :period_end, :period_end=)
+    end
+
+    it 'sets a default empty range' do
+      expect(model_object.period).to be_empty
+    end
+  end
+
+  context 'for the given field' do
+    let(:model_class) do
+      @db.create_table(:tstzrange_fields_test, temp: true) do
+        primary_key :id
+        tstzrange :range
+      end
+      mc = Class.new(Sequel::Model(@db[:tstzrange_fields_test]))
+      mc.plugin(:tstzrange_fields, :range)
+      mc.class_eval do
+        def initialize(*)
+          super
+          self[:range] ||= self.class.new_tstzrange(nil, nil)
+        end
+      end
+      mc
+    end
+
+    let(:model_object) { model_class.new }
+
+    let(:t) { Time.at(3.years.ago.to_i) }
+    let(:ts) { t.to_s }
+
+    it 'sets a default empty range' do
+      expect(model_object.range).to be_empty
+    end
+
+    it 'can set an infinite range by assigning the field to Float::INFINITY' do
+      expect(model_object.range).to be_empty
+
+      model_object.range = Float::INFINITY
+      expect(model_object.range_begin).to be_nil
+      expect(model_object.range_end).to be_nil
+      expect(model_object.range).not_to be_empty
+      model_object.save_changes
+      expect(model_class.where(Sequel.function(:lower_inf, :range)).count).to eq(1)
+      expect(model_class.where(Sequel.function(:upper_inf, :range)).count).to eq(1)
+    end
+
+    it 'can set an empty range by assigning the field to the string "empty"' do
+      model_object.range_begin = t
+      model_object.range_end = t + 1.day
+      expect(model_object.range).not_to be_empty
+
+      model_object.range = 'empty'
+      expect(model_object.range).to be_empty
+      expect(model_object.range_begin).to be_nil
+      expect(model_object.range_end).to be_nil
+      model_object.save_changes
+      expect(model_class.where(Sequel.function(:lower_inf, :range)).count).to eq(0)
+      expect(model_class.where(Sequel.function(:upper_inf, :range)).count).to eq(0)
+    end
+
+    it 'can get/set the start' do
+      model_object.range_begin = t
+      expect(model_object.range_begin).to eq(t)
+      expect(model_object.save_changes.refresh.range_begin).to eq(t)
+
+      model_object.range_begin = ts
+      expect(model_object.range_begin).to eq(t)
+      expect(model_object.save_changes.refresh.range_begin).to eq(t)
+
+      model_object.range_begin = nil
+      expect(model_object.range_begin).to be_nil
+      expect(model_object.save_changes.refresh.range_begin).to be_nil
+    end
+
+    it 'can get/set the end' do
+      model_object.range_end = t
+      expect(model_object.range_end).to eq(t)
+      expect(model_object.save_changes.refresh.range_end).to eq(t)
+
+      model_object.range_end = ts
+      expect(model_object.range_end).to eq(t)
+      expect(model_object.save_changes.refresh.range_end).to eq(t)
+
+      model_object.range_end = nil
+      expect(model_object.range_end).to be_nil
+      expect(model_object.save_changes.refresh.range_end).to be_nil
+    end
+
+    it 'can initialize an instance using accessors' do
+      o = model_class.create(range_begin: nil, range_end: nil)
+      expect(o.range).to be_empty
+
+      o = model_class.create(range_begin: Time.now, range_end: 1.hour.from_now)
+      expect(o.range).not_to be_cover(30.minutes.ago)
+      expect(o.range).to be_cover(30.minutes.from_now)
+      expect(o.range).not_to be_cover(90.minutes.from_now)
+
+      o = model_class.create(range_begin: nil, range_end: Time.now)
+      expect(o.range).to be_cover(30.minutes.ago)
+      expect(o.range).not_to be_cover(30.minutes.from_now)
+
+      o = model_class.create(range_begin: Time.now, range_end: nil)
+      expect(o.range).not_to be_cover(30.minutes.ago)
+      expect(o.range).to be_cover(30.minutes.from_now)
+    end
+
+    it 'can be assigned to directly with an object with begin/end methods or keys' do
+      early = 1.day.ago
+      late = 2.days.from_now
+
+      forms = [
+        early...late,
+        OpenStruct.new(begin: early, end: late),
+        { begin: early, end: late },
+        { 'begin' => early, 'end' => late }
+      ]
+
+      forms.each do |value|
+        model_object.range = value
+        model_object.save_changes.refresh
+        expect(model_object.range_begin).to be_within(1).of(early)
+        expect(model_object.range_end).to be_within(1).of(late)
+      end
+
+      model_object.range = {}
+      expect(model_object.range).to be_empty
+
+      expect { model_object.range = 1 }.to raise_error(TypeError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'sequel/plugins/tstzrange_fields'
+
+RSpec.configure do |config|
+  # config.full_backtrace = true
+
+  # RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 600
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+  config.default_formatter = 'doc' if config.files_to_run.one?
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: sequel-tstzrange-fields
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Lithic Tech
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- hello@lithic.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sequel/plugins/tstzrange_fields.rb
+- spec/sequel/plugins/tstzrange_fields_spec.rb
+- spec/spec_helper.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Gem for enabling time ranges when working with postgres
+test_files: []