activerecord-multirange 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8d7ad768c556f1c8d5ce716eb67367c6b6ace7de0ad656b9f7adf217e5ffa6c
+  data.tar.gz: fa4427fb5cded6f543bb918bc8f672245c71c0e7ab006cfd929c3a5765f6582d
+SHA512:
+  metadata.gz: a8bda0778850f79cbaf2dfba6afd671f1f2b28379b735e4374c45008206afd6e30389da13ed570d53410c1a6322bf26d0f93ea1fc826274bdd813a029120d2a2
+  data.tar.gz: fa87bef90a08f6c88ceba3fa08d945ace2e3b5734bc498b955030bcc99136161e9b7cfedfab7d17ccf86dddb0cf408a4ed90b1c23f6be84c9a8e1ecb981dba1e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-29
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in psql_multi_ranges.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "pry"

data/Gemfile.lock

@@ -0,0 +1,203 @@
+PATH
+  remote: .
+  specs:
+    activerecord-multirange (0.1.0)
+      pg (>= 1)
+      rails (>= 6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (7.0.7)
+      actionpack (= 7.0.7)
+      activesupport (= 7.0.7)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.7)
+      actionpack (= 7.0.7)
+      activejob (= 7.0.7)
+      activerecord (= 7.0.7)
+      activestorage (= 7.0.7)
+      activesupport (= 7.0.7)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.7)
+      actionpack (= 7.0.7)
+      actionview (= 7.0.7)
+      activejob (= 7.0.7)
+      activesupport (= 7.0.7)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
+    actionpack (7.0.7)
+      actionview (= 7.0.7)
+      activesupport (= 7.0.7)
+      rack (~> 2.0, >= 2.2.4)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.7)
+      actionpack (= 7.0.7)
+      activerecord (= 7.0.7)
+      activestorage (= 7.0.7)
+      activesupport (= 7.0.7)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.0.7)
+      activesupport (= 7.0.7)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (7.0.7)
+      activesupport (= 7.0.7)
+      globalid (>= 0.3.6)
+    activemodel (7.0.7)
+      activesupport (= 7.0.7)
+    activerecord (7.0.7)
+      activemodel (= 7.0.7)
+      activesupport (= 7.0.7)
+    activestorage (7.0.7)
+      actionpack (= 7.0.7)
+      activejob (= 7.0.7)
+      activerecord (= 7.0.7)
+      activesupport (= 7.0.7)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crass (1.0.6)
+    date (3.3.3)
+    diff-lcs (1.5.0)
+    erubi (1.12.0)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    loofah (2.21.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.5)
+    minitest (5.19.0)
+    net-imap (0.3.7)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.4-x86_64-darwin)
+      racc (~> 1.4)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pg (1.5.3)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.7.1)
+    rack (2.2.8)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.7)
+      actioncable (= 7.0.7)
+      actionmailbox (= 7.0.7)
+      actionmailer (= 7.0.7)
+      actionpack (= 7.0.7)
+      actiontext (= 7.0.7)
+      actionview (= 7.0.7)
+      activejob (= 7.0.7)
+      activemodel (= 7.0.7)
+      activerecord (= 7.0.7)
+      activestorage (= 7.0.7)
+      activesupport (= 7.0.7)
+      bundler (>= 1.15.0)
+      railties (= 7.0.7)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.7)
+      actionpack (= 7.0.7)
+      activesupport (= 7.0.7)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    thor (1.2.2)
+    timeout (0.4.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.11)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  activerecord-multirange!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Gustavo Warmling Teixeira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# Activercord Multirange 
+ 
+This gem adds full suppport of [Postgress Multiranges](https://www.postgresql.org/docs/14/rangetypes.html#RANGETYPES-BUILTIN) types.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add activerecord-multirange
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install activerecord-multirange 
+
+## Usage
+
+### Initialize it
+
+```
+# config/initializers/activerecord_multirange
+
+Activerecord::Multirange.add_multirange_column_type
+```
+
+### Migrations
+
+All multirange types are available on the migrations
+
+
+```
+  t.tsmultirange :column
+  t.tstzmultirange :column_tz
+  t.datemultirange :column_date
+  t.nummultirange :column_num
+  t.int8multirange :column_int8
+  t.int4multirange :column_int4
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gustavowt/activerecord-multirange.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/activerecord-multirange/adapter.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Activerecord
+  module Multirange
+    module Adapter
+      def initialize_type_map(*params)
+        super
+        load_multirange_types
+      end
+
+      def load_multirange_types
+        initializer = ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::TypeMapInitializer.new(type_map)
+        query = <<-QUERY
+            SELECT t.oid, t.typname, t.typelem, t.typdelim, t.typinput, r.rngsubtype, t.typtype, t.typbasetype
+            FROM pg_type as t
+            JOIN pg_range as r ON oid = "rngmultitypid";
+        QUERY
+
+        execute_and_clear(query, "SCHEMA", []) do |records|
+          initializer.register_multirange_type(records)
+        end
+      end
+    end
+  end
+end

data/lib/activerecord-multirange/oid/multi_range.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Activerecord
+  module Multirange
+    module OID # :nodoc:
+      class MultiRange < ::ActiveModel::Type::Value # :nodoc:
+        Data = Struct.new(:ranges)
+
+        attr_reader :subtype, :type
+
+        def initialize(subtype, type = :multirange)
+          @subtype = subtype
+          @type = type
+        end
+
+        def deserialize(value)
+          case value
+          when ::String
+            cast_value(value)
+          when Data
+            type_cast_ranges(value.ranges, :deserialize)
+          end
+        end
+
+        def serialize(value)
+          if value.is_a?(::Array)
+            Data.new(type_cast_ranges(value, :serialize))
+          else
+            super
+          end
+        end
+
+        def cast_value(value)
+          return nil if value.blank?
+          return value unless value.is_a?(::String)
+
+          ranges = scan_ranges(value)
+
+          ranges.map { |r| build_range(r) }
+        end
+
+        def ==(other)
+          other.is_a?(MultiRange) &&
+            other.subtype == subtype &&
+            other.type == type
+        end
+
+        def force_equality?(value)
+          value.is_a?(::Array)
+        end
+
+        private
+
+        def type_cast_ranges(ranges, method)
+          ranges.map do |range|
+            ::Range.new(
+              @subtype.public_send(method, range.begin),
+              @subtype.public_send(method, range.end),
+              range.exclude_end?
+            )
+          end
+        end
+
+        def scan_ranges(value)
+          value.scan(/\{*(\[|\()(.*?)?,(.*?)?(\]|\))/)
+        end
+
+        # When formatting the bound values of range types, PostgreSQL quotes
+        # the bound value using double-quotes in certain conditions. Within
+        # a double-quoted string, literal " and \ characters are themselves
+        # escaped. In input, PostgreSQL accepts multiple escape styles for "
+        # (either \" or "") but in output always uses "".
+        # See:
+        # * https://www.postgresql.org/docs/current/rangetypes.html#RANGETYPES-IO
+        # * https://www.postgresql.org/docs/current/rowtypes.html#ROWTYPES-IO-SYNTAX
+        def unquote(value)
+          if value.start_with?('"') && value.end_with?('"')
+            unquoted_value = value[1..-2]
+            unquoted_value.gsub!('""', '"')
+            unquoted_value.gsub!("\\\\", "\\")
+            unquoted_value
+          else
+            value
+          end
+        end
+
+        def parse_lower(value)
+          return infinity_value(value, negative: true) if ["", "-infinity"].include?(value)
+
+          @subtype.deserialize(unquote(value))
+        end
+
+        def parse_upper(value)
+          return infinity_value(value) if ["", "infinity"].include?(value)
+
+          @subtype.deserialize(unquote(value))
+        end
+
+        def extract_range_data(value)
+          from = parse_lower(value[1])
+          to = parse_upper(value[2])
+
+          {
+            exclude_start: value[0] == "(",
+            from: from,
+            to: to,
+            exclude_end: value[3] == ")"
+          }
+        end
+
+        def build_range(value)
+          extracted = extract_range_data(value)
+
+          if !infinity?(extracted[:from]) && extracted[:exclude_start]
+            raise ArgumentError,
+                  "The Ruby Range object does not support excluding the beginning of a Range. (unsupported value: '#{value}')"
+          end
+
+          ::Range.new(extracted[:from], extracted[:to], extracted[:exclude_end])
+        end
+
+        def infinity_value(_value, negative: false)
+          if @subtype.respond_to?(:infinity)
+            @subtype.infinity(negative: negative)
+          elsif negative
+            -::Float::INFINITY
+          else
+            ::Float::INFINITY
+          end
+        end
+
+        def infinity?(value)
+          value.respond_to?(:infinite?) && value.infinite?
+        end
+      end
+    end
+  end
+end

data/lib/activerecord-multirange/quoting.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Activerecord
+  module Multirange
+    module Quoting
+      def quote(value)
+        return quote(encode_multirange(value)) if value.is_a?(::Activerecord::Multirange::OID::MultiRange::Data)
+
+        super
+      end
+
+      def type_cast(value)
+        return encode_multirange(value) if value.is_a?(::Activerecord::Multirange::OID::MultiRange::Data)
+
+        super
+      end
+
+      def encode_multirange(range_data)
+        collection = range_data.ranges.map { |r| encode_range(r) }.join(",")
+
+        "{#{collection}}"
+      end
+    end
+  end
+end

data/lib/activerecord-multirange/schema_statements.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Activerecord
+  module Multirange
+      module SchemaStatements
+        def native_database_types
+          super.merge({
+                        tsmultirange: { name: "tsmultirange" },
+                        datemultirange: { name: "datemultirange" },
+                        tstzmultirange: { name: "tstzmultirange" },
+                        nummultirange: { name: "nummultirange" },
+                        int8multirange: { name: "int8multirange" },
+                        int4multirange: { name: "int4multirange" }
+                      })
+        end
+      end
+    end
+end

data/lib/activerecord-multirange/table_definition.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Activerecord
+  module Multirange
+    module TableDefinition
+      def tsmultirange(*args, **options)
+        args.each do |name|
+          column(name, :tsmultirange, **options)
+        end
+      end
+
+      def tstzmultirange(*args, **options)
+        args.each do |name|
+          column(name, :tstzmultirange, **options)
+        end
+      end
+
+      def datemultirange(*args, **options)
+        args.each do |name|
+          column(name, :datemultirange, **options)
+        end
+      end
+
+      def nummultirange(*args, **options)
+        args.each do |name|
+          column(name, :nummultirange, **options)
+        end
+      end
+
+      def int8multirange(*args, **options)
+        args.each do |name|
+          column(name, :int8multirange, **options)
+        end
+      end
+
+      def int4multirange(*args, **options)
+        args.each do |name|
+          column(name, :int4multirange, **options)
+        end
+      end
+    end
+  end
+end

data/lib/activerecord-multirange/type_map.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "activerecord-multirange/oid/multi_range"
+
+module Activerecord
+  module Multirange
+    module TypeMap
+      def register_multirange_type(records)
+        records.each do |row|
+          register_with_subtype(row["oid"], row["rngsubtype"].to_i) do |subtype|
+            Activerecord::Multirange::OID::MultiRange.new(subtype, row["typname"].to_sym)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord-multirange/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Activerecord
+  module Multirange
+    VERSION = "0.1.0"
+  end
+end

data/lib/activerecord-multirange.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "activerecord-multirange/version"
+require "activerecord-multirange/adapter"
+require "activerecord-multirange/quoting"
+require "activerecord-multirange/schema_statements"
+require "activerecord-multirange/table_definition"
+require "activerecord-multirange/type_map"
+require "active_record"
+
+module Activerecord
+  module Multirange
+    class Error < StandardError; end
+
+    def self.add_multirange_column_type
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(Adapter)
+        ActiveRecord::ConnectionAdapters::PostgreSQL::OID::TypeMapInitializer.prepend(TypeMap)
+        ActiveRecord::ConnectionAdapters::PostgreSQL::Quoting.prepend(Quoting)
+        ActiveRecord::ConnectionAdapters::PostgreSQL::SchemaStatements.prepend(SchemaStatements)
+        ActiveRecord::ConnectionAdapters::PostgreSQL::TableDefinition.prepend(TableDefinition)
+      end
+    end
+  end
+end

data/sig/activerecord-multirange.rbs

@@ -0,0 +1,6 @@
+module Activerecord
+  module Multirange
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-multirange
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gustavo Warmling Teixeira
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+description: Add PostgreSQL multiranges support
+email:
+- gustavowt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/activerecord-multirange.rb
+- lib/activerecord-multirange/adapter.rb
+- lib/activerecord-multirange/oid/multi_range.rb
+- lib/activerecord-multirange/quoting.rb
+- lib/activerecord-multirange/schema_statements.rb
+- lib/activerecord-multirange/table_definition.rb
+- lib/activerecord-multirange/type_map.rb
+- lib/activerecord-multirange/version.rb
+- sig/activerecord-multirange.rbs
+homepage: https://github.com/gustavowt/activerecord-multirange
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gustavowt/activerecord-multirange
+  source_code_uri: https://github.com/gustavowt/activerecord-multirange
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: PostgreSQL multiranges support
+test_files: []