created_id 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be6ec5c9e09c606d38aafaedc55cc820060d1a7eb40461b72be62a820463d482
-  data.tar.gz: 3c8a7be82f5aa0ba954b1f649aa634432c6b97d0f196d29adb09be069e7c68b7
+  metadata.gz: afdabbea09a01fe7c621831292070fdd0138f39ef7efce693745765c5f468fdd
+  data.tar.gz: 6f48cde24728a3f4b92b3c1a003e092f92d4f781e22a68350bb504a210e35f81
 SHA512:
-  metadata.gz: a74a5207fda30568768be24de8b55f1554ebe09f157f5d42f00ceda243e6028e6570da3dbdedba713058b65a7f1416c2438d122f4f5bd84c455fb2d7d6418eba
-  data.tar.gz: 5b02e4a9f71f2bc5306a49ff56de89f011d829a4972b00240592532a0de390d7a097babadfabec861e93ed2d1acee085a3be5020d397b23331c08b8288e1e576
+  metadata.gz: 500a45fdf791907a43d856c4315988343f69ecd571b294cdab0b5f83c347949fafba13e706e0bcfb2951342a96529a2b2d2a62ffc02982269c25f4b88b9c7003
+  data.tar.gz: 5f6ab7875355ffb9f15495c0d0d7ecc83fd01f1a726c734274bc922511a9acdaadcf831b71cc3e0fa3612581a450e4f561d99c0e0b5a87b3b675b99f4087bc69

data/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.1.0
+
+### Changed
+
+- Omit id clause in queries if ids have not been indexed.
+- Update queries to use ranges to better support prepared statements.
+
+### Removed
+
+- Drop support for ActiveRecord 5.
+- Drop support for Ruby 2.5 and 2.6.
+
 ## 1.0.1
 
 ### Changed

data/README.md

@@ -5,7 +5,13 @@
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 [![Gem Version](https://badge.fury.io/rb/created_id.svg)](https://badge.fury.io/rb/created_id)
 
-The gem is designed to optimize queries for ActiveRecord models that filter by the `created_at` timestamp. It can make queries more efficient by pre-calculating the ranges of id's for specific dates.
+**CreatedId** optimizes queries on large ActiveRecord tables by precalculating ID ranges for specific time intervals. This lets you avoid full table scans and makes filtering by `created_at` more efficient, even in complex queries.
+
+### Key Benefits
+
+- **Efficient Range Queries**: Filter by time-based ID ranges instead of relying on a less predictable `created_at` index.
+- **Reduced Indexing Needs**: Avoid adding specific `created_at` indexes, letting primary key indexing handle range queries.
+- **Simple Integration**: Just include the `CreatedId` module in your models and run a periodic task to index ID ranges.
 
 The use case this code is designed to solve is when you have a large table with an auto-populated `created_at` column where you want to run queries that filter on that column. In most cases, simply adding an index on the `created_at` column will work just fine., However, once you start constructing more complex queries or adding joins and your table grows very large, the index can become less effective and not even be used at all.
 
@@ -54,7 +60,7 @@ WHERE tasks.status = 'completed'
   AND tasks.created_at < ?
 ```
 
-The query optimizer will have it's choice of several indexes to use to figure out the best query plan. The most important choice will be the first step of the plan to reduce the number of rows that the query needs to look at. Depending on the shape of your data, the query optimizer may decide to simply filter by `status` or `user_id` and then perform a table scan on all the rows to filter by `created_at`, not using the index on that column at all.
+The query optimizer will have its choice of several indexes to use to figure out the best query plan. The most important choice will be the first step of the plan to reduce the number of rows that the query needs to look at. Depending on the shape of your data, the query optimizer may decide to simply filter by `status` or `user_id` and then perform a table scan on all the rows to filter by `created_at`, not using the index on that column at all.
 
 This gem solves for this case by keeping track of the range ids created in each hour in a separate table. When you query on the `created_at` column, it will then look up the possible id range and add that to the query, so the SQL becomes:
 
@@ -70,16 +76,16 @@ WHERE tasks.status = 'completed'
   AND tasks.id < ?
 ```
 
-Because the `id` column is the primary key, it will always be indexed and the query optimizer will generally make better decisions about how to filter the query rows. You won't even need the index on `created_at` since the primay key would always be preferred.
+Because the `id` column is the primary key, it will always be indexed and the query optimizer will generally make better decisions about how to filter the query rows. You won't even need the index on `created_at` since the primary key would always be preferred.
 
 Another good use case is if you have some periodic tasks to calculate daily stats for some large tables. You will be able to make these queries more efficient without having to add an index on the `created_at` column that's only used on one query per day.
 
 ## Usage
 
-Run the generator to create the database table
+Run the generator to create the database migration. This will create a table to store time indexed id ranges for your models.
 
 ```
-  rails created_id_engine:install:migrations
+rails created_id_engine:install:migrations
 ```
 
 Next, include the `CreatedId` module into your models. Note that any model you wish to include this module in must have a numeric primary key.  If the model is subclassed you will need to include the `CreatedId` module in the parent model.
@@ -95,11 +101,14 @@ end
 Now when you want to query by a range on the `created_at` column, you can use the `created_after`, `created_before`, or `created_between` scopes on the model.
 
 ```ruby
+# Query for tasks completed after a specific time
 Task.where(status: "completed").created_after(24.hours.ago)
 
+# Query for tasks by a specific user created before a specific time
 Task.where(user_id: 1000).created_before(7.days.ago)
 
-Task.created_between(25.hour.ago, 24.hours.ago)
+# Query for tasks within a specific timeframe
+Task.created_between(25.hours.ago, 24.hours.ago)
 ```
 
 You'll then need to set up a periodic task to store the id ranges for your models. For each model that includes `CreatedId`, you need to run the `index_ids_for` once per hour. This task should be run shortly after the top of the hour.
@@ -119,7 +128,7 @@ while time < Time.now
 end
 ```
 
-Don't worry if the id range for a specific hour does not get recorded, the queries will still work and they can be re-calcuated at any time. Queries will just be a bit less efficient if the ranges don't exist because queries will be given a large span of ids to filter on.
+If an ID range is missing for a specific hour, your queries will still function, but with a broader range of IDs. You can recalculate missing ranges at any time to improve efficiency.
 
 There is an additional requirement for using this gem that you do not change the `created_at` value after a row is inserted since this can mess up the assumption about the correlation between ids and `created_at` timestamps. An error will be thrown if you try to change a record's timestamp after the id range has been created. The query logic can handle small variations between id order and timestamp order (i.e. if id 1000 has a timestamp a few seconds after id 1001).
 

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/created_id.gemspec

@@ -4,10 +4,16 @@ Gem::Specification.new do |spec|
   spec.authors = ["Brian Durand"]
   spec.email = ["bbdurand@gmail.com"]
 
-  spec.summary = "Mechanism for optimizing ActiveRecord queries against the created_at column on tables."
+  spec.summary = "Optimize ActiveRecord queries for filtering large tables on the created_at column by pre-computing id ranges."
   spec.homepage = "https://github.com/bdurand/created_id"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   ignore_files = %w[
@@ -26,9 +32,9 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", ">= 5.0"
+  spec.add_dependency "activerecord", ">= 6.0"
 
   spec.add_development_dependency "bundler"
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.7"
 end

data/lib/created_id/id_range.rb

@@ -7,8 +7,8 @@ module CreatedId
     self.table_name = "created_ids"
 
     scope :for_class, ->(klass) { where(class_name: klass.base_class.name) }
-    scope :created_before, ->(time) { where(arel_table[:hour].lteq(time)) }
-    scope :created_after, ->(time) { where(arel_table[:hour].gteq(time)) }
+    scope :created_before, ->(time) { where(hour: nil..time) }
+    scope :created_after, ->(time) { where(hour: time...nil) }
 
     before_validation :set_hour
 
@@ -23,20 +23,30 @@ module CreatedId
       #
       # @param klass [Class] The class to get the minimum id for.
       # @param time [Time] The hour to get the minimum id for.
-      # @return [Integer] The minimum id for the class created in the given hour.
-      def min_id(klass, time)
-        for_class(klass).created_before(time).order(hour: :desc).first&.min_id || 0
+      # @param allow_nil [Boolean] Whether to allow a nil value to be returned. If this is false,
+      #   then the method will return 0 if no value is found.
+      # @return [Integer, nil] The minimum id for the class created in the given hour.
+      def min_id(klass, time, allow_nil: false)
+        return nil if time.nil? && allow_nil
+
+        id = for_class(klass).created_before(time).order(hour: :desc).first&.min_id
+        id ||= 0 unless allow_nil
+        id
       end
 
       # Get the maximum id for a class created in a given hour.
       #
       # @param klass [Class] The class to get the maximum id for.
       # @param time [Time] The hour to get the maximum id for.
-      # @return [Integer] The maximum id for the class created in the given hour.
-      def max_id(klass, time)
+      # @param allow_nil [Boolean] Whether to allow a nil value to be returned. If this is false,
+      #  then the method will return the maximum possible id for the id column.
+      # @return [Integer, nil] The maximum id for the class created in the given hour.
+      def max_id(klass, time, allow_nil: false)
+        return nil if time.nil? && allow_nil
+
         id = for_class(klass).created_after(CreatedId.coerce_hour(time)).order(hour: :asc).first&.max_id
 
-        unless id
+        if id.nil? && !allow_nil
           col_limit = klass.columns.detect { |c| c.name == klass.primary_key }.limit
           id = if col_limit && col_limit > 0
             ((256**col_limit) / 2) - 1

data/lib/created_id.rb

@@ -24,9 +24,8 @@ module CreatedId
       raise ArgmentError, "CreatedId can only be included in ActiveRecord models"
     end
 
-    scope :created_after, ->(time) { where(arel_table[:created_at].gteq(time).and(arel_table[primary_key].gteq(CreatedId::IdRange.min_id(self, time)))) }
-    scope :created_before, ->(time) { where(arel_table[:created_at].lt(time).and(arel_table[primary_key].lteq(CreatedId::IdRange.max_id(self, time)))) }
-    scope :created_between, ->(time_1, time_2) { created_after(time_1).created_before(time_2) }
+    scope :created_after, ->(time) { created_between(time, nil) }
+    scope :created_before, ->(time) { created_between(nil, time) }
 
     before_save :verify_created_at_created_id!, if: :created_at_changed?
   end
@@ -42,6 +41,24 @@ module CreatedId
         CreatedId::IdRange.save_created_id(self, time, min_id, max_id)
       end
     end
+
+    # Get records created in the given time range. The time range is based on the
+    # created_at column and is inclusive of the start time and exclusive of the end time.
+    #
+    # @param start_time [Time, nil] The start of the time range. If nil, the range is open-ended.
+    # @param end_time [Time, nil] The end of the time range. If nil, the range is open-ended.
+    # @return [ActiveRecord::Relation] The records created in the given time range.
+    def created_between(start_time, end_time)
+      finder = where(created_at: start_time...end_time)
+
+      min_id = CreatedId::IdRange.min_id(self, start_time, allow_nil: true)
+      max_id = CreatedId::IdRange.max_id(self, end_time, allow_nil: true)
+      if min_id || max_id
+        finder = finder.where(primary_key => min_id..max_id)
+      end
+
+      finder
+    end
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: created_id
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-03 00:00:00.000000000 Z
+date: 2024-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -58,7 +58,10 @@ files:
 homepage: https://github.com/bdurand/created_id
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/bdurand/created_id
+  source_code_uri: https://github.com/bdurand/created_id
+  changelog_uri: https://github.com/bdurand/created_id/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -67,16 +70,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
-summary: Mechanism for optimizing ActiveRecord queries against the created_at column
-  on tables.
+summary: Optimize ActiveRecord queries for filtering large tables on the created_at
+  column by pre-computing id ranges.
 test_files: []