activerecord-multirange 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f84a86677dd7f4427b636524b7dc09ea1c5eb049db16ebc727e86b8801847245
-  data.tar.gz: e7d313979f6e205f7cc07685b6fad56d6e483e99ae8cf985eb04c5fd0c2a3acb
+  metadata.gz: 0b09cdb0717d19e40572d66ecb2e7774494057658fb3409fefdf04a67db06345
+  data.tar.gz: aa643ce5bf82da7e69b042478ee884668fd1970da0861b91e43e7a5c2e4ae3e4
 SHA512:
-  metadata.gz: 80c306db18783b1f27457706731efa67594c06ac8a7efd7fbcf5e368befbe2166ba136a676026fa6bab076fe191de1563b36cdaab3690a3b01bf9ca0d97007a3
-  data.tar.gz: 6eb784fa47af4ad1fb395d0e5f4dc56bb9e2a8f2a48b85d24bf036e5bcebc93ed128d9a9f24d75144eb05f285089d8b47e27820571e6b4cece2b43ca33f9af41
+  metadata.gz: 31209bbe807b481f93275650fae69c2c23fa76518fc987890daec2c619f595571467cb55fdd8cc526e8bc4e007af68eb9f239e68d810854dc3e6977c4631d248
+  data.tar.gz: 87c60c9246d43e7b148c02798171df9747b7aa2fb5c21b40969ed77b8461064440d4f9f73840f2b5d8aa11cd47d33017d48fbfb9a9c9ad28da7ce952e713fa26

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## [Unreleased]
 
-## [1.1.0] - 2024-12-19
+## [1.1.1] - 2025-06-11
+
+- Added automatic registration of multirange types in `NATIVE_DATABASE_TYPES` for Rails 8 compatibility
+- Fixed `rails db:schema:dump` support without requiring manual type registration
+- Centralized multirange type definitions in `MULTIRANGE_TYPES` constant
+
+## [1.1.0] - 2024-06-01
 
 - Minor version bump with improvements and updates
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-multirange (1.1.0)
+    activerecord-multirange (1.1.1)
       pg (>= 1)
       rails (>= 6)
 

data/README.md

@@ -1,5 +1,5 @@
-# Activercord Multirange 
- 
+# Activercord Multirange
+
 This gem adds full suppport of [Postgress Multiranges](https://www.postgresql.org/docs/14/rangetypes.html#RANGETYPES-BUILTIN) types.
 
 [![Gem Version](https://badge.fury.io/rb/activerecord-multirange.svg)](https://badge.fury.io/rb/activerecord-multirange)
@@ -12,30 +12,233 @@ Install the gem and add to the application's Gemfile by executing:
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install activerecord-multirange 
+    $ gem install activerecord-multirange
 
 ## Usage
 
 ### Initialize it
 
-```
-# config/initializers/activerecord_multirange
+```ruby
+# config/initializers/activerecord_multirange.rb
 
 Activerecord::Multirange.add_multirange_column_type
 ```
 
 ### Migrations
 
-All multirange types are available on the migrations
+All multirange types are available in migrations. Here are examples for different multirange types:
+
+```ruby
+class CreateSchedules < ActiveRecord::Migration[7.0]
+  def change
+    create_table :schedules do |t|
+      t.string :name
+      t.tsmultirange :available_times # Timestamp multirange
+      t.tstzmultirange :available_times_tz # Timestamp with timezone multirange
+      t.datemultirange :available_dates # Date multirange
+      t.nummultirange :price_ranges # Numeric multirange
+      t.int8multirange :id_ranges # Bigint multirange
+      t.int4multirange :quantity_ranges # Integer multirange
+
+      t.timestamps
+    end
+  end
+end
+```
+
+```ruby
+class CreateBookings < ActiveRecord::Migration[7.0]
+  def change
+    create_table :bookings do |t|
+      t.string :title
+      t.tstzmultirange :booked_periods
+      t.datemultirange :blackout_dates
+
+      t.timestamps
+    end
+  end
+end
+```
+
+### Models
+
+Define your models to work with multirange columns:
+
+```ruby
+class Schedule < ApplicationRecord
+  # Multirange columns are automatically handled by ActiveRecord
+  # No special configuration needed
+end
+
+class Booking < ApplicationRecord
+  validates :title, presence: true
+
+  scope :overlapping_with, ->(time_range) { where('booked_periods && ?', time_range) }
+end
+```
+
+### Creating and Working with Multirange Data
+
+#### Creating Records with Multirange Values
+
+```ruby
+# Using timestamp multiranges for scheduling
+schedule =
+  Schedule.create!(
+    name: 'Conference Room A',
+    available_times: [
+      Time.parse('2024-01-15 09:00')..Time.parse('2024-01-15 12:00'),
+      Time.parse('2024-01-15 14:00')..Time.parse('2024-01-15 17:00')
+    ]
+  )
+
+# Using date multiranges for availability periods
+booking =
+  Booking.create!(
+    title: 'Annual Maintenance',
+    booked_periods: [
+      Time.zone.parse('2024-03-01 00:00')..Time.zone.parse('2024-03-03 23:59'),
+      Time.zone.parse('2024-06-15 00:00')..Time.zone.parse('2024-06-17 23:59')
+    ],
+    blackout_dates: [
+      Date.parse('2024-12-24')..Date.parse('2024-12-26'),
+      Date.parse('2024-12-31')..Date.parse('2024-01-01')
+    ]
+  )
+
+# Using numeric multiranges for pricing tiers
+product = Product.create!(name: 'Premium Service', price_ranges: [10.0..50.0, 100.0..500.0, 1000.0..5000.0])
+```
+
+#### Reading and Manipulating Multirange Data
+
+```ruby
+schedule = Schedule.find(1)
+
+# Access multirange values
+puts schedule.available_times
+# => [2024-01-15 09:00:00 UTC..2024-01-15 12:00:00 UTC, 2024-01-15 14:00:00 UTC..2024-01-15 17:00:00 UTC]
+
+# Check if multirange contains a specific value
+morning_slot = Time.parse('2024-01-15 10:30')
+puts schedule.available_times.any? { |range| range.cover?(morning_slot) }
+# => true
+
+# Add new time ranges
+schedule.available_times += [Time.parse('2024-01-15 18:00')..Time.parse('2024-01-15 20:00')]
+schedule.save!
 
+# Working with individual ranges
+schedule.available_times.each { |time_range| puts "Available from #{time_range.begin} to #{time_range.end}" }
+```
+
+### Querying Multirange Columns
+
+#### Overlap Queries
+
+```ruby
+# Find schedules that overlap with a specific time range
+search_range = Time.parse('2024-01-15 10:00')..Time.parse('2024-01-15 11:00')
+overlapping_schedules = Schedule.where('available_times && ?', search_range)
+
+# Find bookings that don't overlap with a date range
+available_dates = Date.parse('2024-03-01')..Date.parse('2024-03-05')
+non_conflicting_bookings = Booking.where('NOT (blackout_dates && ?)', available_dates)
+```
+
+#### Contains Queries
+
+```ruby
+# Find schedules that contain a specific timestamp
+specific_time = Time.parse('2024-01-15 10:30')
+containing_schedules = Schedule.where('available_times @> ?', specific_time)
+
+# Find products within a specific price range
+price_point = 75.0
+products_in_range = Product.where('price_ranges @> ?', price_point)
+```
+
+#### Other Useful Queries
+
+```ruby
+# Check if multirange is contained within another range
+broad_range = Time.parse('2024-01-15 08:00')..Time.parse('2024-01-15 18:00')
+fully_contained = Schedule.where('available_times <@ ?', broad_range)
+
+# Find records where multiranges are strictly left of a range
+cutoff_time = Time.parse('2024-01-15 12:00')..Time.parse('2024-01-15 24:00')
+morning_only = Schedule.where('available_times << ?', cutoff_time)
 
+# Find records where multiranges are strictly right of a range
+start_time = Time.parse('2024-01-15 00:00')..Time.parse('2024-01-15 12:00')
+afternoon_only = Schedule.where('available_times >> ?', start_time)
 ```
-  t.tsmultirange :column
-  t.tstzmultirange :column_tz
-  t.datemultirange :column_date
-  t.nummultirange :column_num
-  t.int8multirange :column_int8
-  t.int4multirange :column_int4
+
+### Practical Examples
+
+#### Availability Scheduling System
+
+```ruby
+class Room < ApplicationRecord
+  def available_during?(time_range)
+    available_times.any? { |range| range.cover?(time_range) }
+  end
+
+  def book_time!(time_range)
+    # Remove the booked time from available times
+    new_availability = []
+    available_times.each do |available_range|
+      if available_range.overlaps?(time_range)
+        # Split the range if needed
+        if available_range.begin < time_range.begin
+          new_availability << (available_range.begin...time_range.begin)
+        end
+        if time_range.end < available_range.end
+          new_availability << (time_range.end...available_range.end)
+        end
+      else
+        new_availability << available_range
+      end
+    end
+
+    update!(available_times: new_availability)
+  end
+end
+
+# Usage
+room = Room.find(1)
+booking_time = Time.parse('2024-01-15 10:00')..Time.parse('2024-01-15 11:00')
+
+if room.available_during?(booking_time)
+  room.book_time!(booking_time)
+  puts 'Room booked successfully!'
+else
+  puts 'Room not available during requested time'
+end
+```
+
+#### Price Range Management
+
+```ruby
+class Product < ApplicationRecord
+  def price_tier_for(quantity)
+    price_ranges.each_with_index do |range, index|
+      if range.cover?(quantity)
+        return index + 1
+      end
+    end
+    nil
+  end
+
+  def applies_to_quantity?(quantity)
+    quantity_ranges.any? { |range| range.cover?(quantity) }
+  end
+end
+
+# Usage
+product = Product.find(1)
+puts "Quantity 25 is in tier: #{product.price_tier_for(25)}"
+puts "Product applies to quantity 150: #{product.applies_to_quantity?(150)}"
 ```
 
 ## Development

data/lib/activerecord-multirange/adapter.rb

@@ -9,28 +9,7 @@ module Activerecord
       end
 
       def self.native_database_types
-        super.merge(
-          {
-            datemultirange: {
-              name: 'datemultirange'
-            },
-            nummultirange: {
-              name: 'nummultirange'
-            },
-            tsmultirange: {
-              name: 'tsmultirange'
-            },
-            tstzmultirange: {
-              name: 'tstzmultirange'
-            },
-            int4multirange: {
-              name: 'int4multirange'
-            },
-            int8multirange: {
-              name: 'int8multirange'
-            }
-          }
-        )
+        super.merge(Activerecord::Multirange::MULTIRANGE_TYPES)
       end
 
       def load_multirange_types

data/lib/activerecord-multirange/schema_statements.rb

@@ -4,14 +4,7 @@ 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" }
-                    })
+        super.merge(Activerecord::Multirange::MULTIRANGE_TYPES)
       end
     end
   end

data/lib/activerecord-multirange/version.rb

@@ -2,6 +2,6 @@
 
 module Activerecord
   module Multirange
-    VERSION = "1.1.0"
+    VERSION = '1.1.1'
   end
 end

data/lib/activerecord-multirange.rb

@@ -13,8 +13,21 @@ module Activerecord
     class Error < StandardError
     end
 
+    # Multirange types that need to be registered
+    MULTIRANGE_TYPES = {
+      tsmultirange: { name: "tsmultirange" },
+      datemultirange: { name: "datemultirange" },
+      tstzmultirange: { name: "tstzmultirange" },
+      nummultirange: { name: "nummultirange" },
+      int8multirange: { name: "int8multirange" },
+      int4multirange: { name: "int4multirange" }
+    }.freeze
+
     def self.add_multirange_column_type
       ActiveSupport.on_load(:active_record) do
+        # Register multirange types in NATIVE_DATABASE_TYPES for Rails 8 compatibility
+        Activerecord::Multirange.register_native_database_types
+
         ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(Adapter)
         ActiveRecord::ConnectionAdapters::PostgreSQL::OID::TypeMapInitializer
           .prepend(TypeMap)
@@ -27,5 +40,27 @@ module Activerecord
         )
       end
     end
+
+    def self.register_native_database_types
+      # Ensure the PostgreSQL adapter is loaded
+      return unless defined?(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+
+      adapter_class = ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
+
+      # Check if NATIVE_DATABASE_TYPES is already defined and modifiable
+      if adapter_class.const_defined?(:NATIVE_DATABASE_TYPES)
+        current_types = adapter_class::NATIVE_DATABASE_TYPES
+        
+        # Only modify if our types aren't already registered
+        unless current_types.key?(:tsmultirange)
+          # Create a new hash with existing types plus our multirange types
+          new_types = current_types.merge(MULTIRANGE_TYPES)
+          
+          # Replace the constant with the updated hash
+          adapter_class.send(:remove_const, :NATIVE_DATABASE_TYPES)
+          adapter_class.const_set(:NATIVE_DATABASE_TYPES, new_types.freeze)
+        end
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-multirange
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Gustavo Warmling Teixeira
 bindir: exe
 cert_chain: []
-date: 2025-06-03 00:00:00.000000000 Z
+date: 2025-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg