inquery 1.0.10 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a42f9f4e3765f6e9026a13c7e623c4a51787589171c40e128375382c44f2cde0
-  data.tar.gz: 4bd9b28a6bc8a837e4efdf8845a13de1bf651382e4f609a855ba85a63bd65ad4
+  metadata.gz: 45b9f4f89d241cb824f7de46f3b84049091ff579853165562df4341765c9e536
+  data.tar.gz: '028f2cd61072b3ffbfd31b2b626380d056805670483fad333f22da17ebe8e5c1'
 SHA512:
-  metadata.gz: 4ca5f8958bc74ebd0f2d67e7cc8a4dada0f981038ac486aa48da713988795390e99cf8ec49cb06df3aed5d18a7cec5c5923113c4a1e94da2184a4a027c5c4a20
-  data.tar.gz: dfcee1dcdb1eaf602d434b45977bf70da0cb0486377079ca0d4c72637abbc6319f9d90c97891f012a8cf67584ef8520ec350d1afbacdd998ad044b6fcb2b45c7
+  metadata.gz: c52b88733d60d5db5c071464bba3e80658c9bb2653e8624df96637c74dcfbde157cd59444e2a34fce8b971ba5267b9c70aaacc12e76c51d0ffabe5869f7c122b
+  data.tar.gz: fee01595c30949c3dc6889d8b9d7c9e931f05ae45857476a7af3ec4bf88dbce19f3faeae666505d1ccb09eee04f6a615ce993f47b2373987f6fa18d3d6ee59b6

data/.github/workflows/rubocop.yml

@@ -11,7 +11,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.0.1
+          ruby-version: 3.3.0
           bundler-cache: true
       - name: Run rubocop
         run: bundle exec rubocop

data/.github/workflows/ruby.yml

@@ -13,20 +13,12 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - rails-version: '5.1'
-            ruby-version: '2.5.1'
-          - rails-version: '5.2'
-            ruby-version: '2.5.1'
           - rails-version: '5.2'
             ruby-version: '2.6.2'
-          - rails-version: '6.0'
-            ruby-version: '2.5.1'
           - rails-version: '6.0'
             ruby-version: '2.6.2'
           - rails-version: '6.0'
             ruby-version: '2.7.1'
-          - rails-version: '6.1'
-            ruby-version: '2.5.1'
           - rails-version: '6.1'
             ruby-version: '2.6.2'
           - rails-version: '6.1'
@@ -39,6 +31,30 @@ jobs:
             ruby-version: '3.0.1'
           - rails-version: '7.0'
             ruby-version: '3.1.0'
+          - rails-version: '7.0'
+            ruby-version: '3.2.0'
+          - rails-version: '7.0'
+            ruby-version: '3.3.0'
+          - rails-version: '7.1'
+            ruby-version: '3.1.0'
+          - rails-version: '7.1'
+            ruby-version: '3.2.0'
+          - rails-version: '7.1'
+            ruby-version: '3.3.0'
+          - rails-version: '7.2'
+            ruby-version: '3.2.0'
+          - rails-version: '7.2'
+            ruby-version: '3.3.0'
+          - rails-version: '7.2'
+            ruby-version: '3.4.1'
+          - rails-version: '8.0'
+            ruby-version: '3.3.0'
+          - rails-version: '8.0'
+            ruby-version: '3.4.1'
+          - rails-version: '8.1'
+            ruby-version: '3.3.0'
+          - rails-version: '8.1'
+            ruby-version: '3.4.1'
     name: Test against Ruby ${{ matrix.ruby-version }} / Rails ${{ matrix.rails-version }}
     env:
       BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/rails_${{ matrix.rails-version }}.gemfile

data/.gitignore

@@ -3,7 +3,6 @@
 .DS_Store
 *.tmproj
 tmtags
-/Gemfile.lock
 *~
 \#*
 .\#*
@@ -14,4 +13,5 @@ tmtags
 /.yardoc
 .idea
 /*.gem
-/gemfiles/*.lock
+/gemfiles/*.lock
+/coverage

data/.rubocop.yml

@@ -5,6 +5,7 @@ AllCops:
     - 'vendor/**/*'
     - 'tmp/**/*'
     - 'inquery.gemspec'
+    - 'gemfiles/**/*'
   SuggestExtensions: false
 
   DisplayCopNames: true
@@ -105,3 +106,6 @@ Style/CaseLikeIf:
 
 Style/OpenStructUse:
   Enabled: false
+
+Style/ArgumentsForwarding:
+  Enabled: false

data/Appraisals

@@ -1,19 +1,39 @@
+appraise 'rails-8.1' do
+  gem 'rails', '~> 8.1.0'
+  gem 'sqlite3', '>= 2.5'
+end
+
+appraise 'rails-8.0' do
+  gem 'rails', '~> 8.0.0'
+  gem 'sqlite3', '>= 2.5'
+end
+
+appraise 'rails-7.2' do
+  gem 'rails', '~> 7.2.0'
+  gem 'sqlite3', '>= 2.5'
+end
+
+appraise 'rails-7.1' do
+  gem 'rails', '~> 7.1.0'
+  gem 'sqlite3', '>= 1.4'
+end
+
 appraise 'rails-7.0' do
   gem 'rails', '~> 7.0.1'
+  gem 'sqlite3', '~> 1.4.0'
 end
 
 appraise 'rails-6.1' do
   gem 'rails', '~> 6.1.4'
+  gem 'sqlite3', '~> 1.4.0'
 end
 
 appraise 'rails-6.0' do
   gem 'rails', '~> 6.0.4'
+  gem 'sqlite3', '~> 1.4.0'
 end
 
 appraise 'rails-5.2' do
   gem 'rails', '~> 5.2.6'
-end
-
-appraise 'rails-5.1' do
-  gem 'rails', '~> 5.1.7'
+  gem 'sqlite3', '~> 1.3.13'
 end

data/CHANGELOG.md

@@ -1,5 +1,51 @@
 # Change log
 
+## 1.1.0 (2026-01-05)
+
+* **Drop support for Ruby 2.5.1 and Rails 5.1**: The minimum supported versions
+  are now Ruby 2.6.2 and Rails 5.2. Ruby 2.5.1 reached end-of-life in March
+  2021 and is no longer available on modern CI infrastructure (Ubuntu 24.04).
+* Fix Ruby 2.6 compatibility in `MethodAccessibleHash` by converting method
+  symbol to string before calling `end_with?` (`Symbol#end_with?` was added
+  in Ruby 2.7)
+* Fix Ruby 2.5/2.6 compatibility by replacing argument forwarding syntax (`...`)
+  with explicit `*args, &block` in schema validation mixin
+* Add inline documentation to Query, Query::Chainable, and RawSqlUtils classes
+* Add MIGRATION.md guide with examples for migrating from raw ActiveRecord
+  queries and upgrading between Inquery versions
+* Refactor argument parsing in `Query::Chainable` for improved readability and
+  maintainability while preserving backward compatibility
+* Increase test coverage from 87.1% to 90.97% by adding tests for error
+  handling, relation validation edge cases, and schema validation
+* Add integration tests for RawSqlUtils mixin (`san` and `exec_query` methods)
+* Move all development dependencies from gemspec to Gemfile for cleaner
+  separation of runtime and development dependencies
+* Remove unused dependencies: `yard`, `haml`, and `redcarpet`
+* Remove YARD documentation files and configuration
+* Update RuboCop from version 1.25 to ~> 1.60 and fix new style violations
+* Replace deprecated `OpenStruct` with `MethodAccessibleHash` to ensure
+  compatibility with Ruby 3.5+
+* Remove debug code from `Query::Chainable#call` method
+* Fix Ruby 3.0+ compatibility by explicitly requiring `logger`
+* Constrain `sqlite3` to version `~> 1.4.0` for Rails 6.1 and 7.0 to avoid
+  version conflicts
+* Update `RUBY_VERSION` to `ruby-3.3.5`
+* Add support for Rails 7.1, 7.2, 8.0, and 8.1
+* Add support for Ruby 3.2, 3.3, and 3.4
+* Update sqlite3 gem requirement to `>= 2.5` for Rails 7.2+ to ensure Ruby
+  3.4 compatibility
+* Add explicit version constraints for runtime dependencies: `activesupport`
+  and `activerecord` now require `>= 5.1`, `schemacop` allows `>= 3.0.8, < 4.0`
+  for better dependency resolution and compatibility
+
+## 1.0.11 (2023-08-24)
+
+* Add configuration option `config.default_schema_version` that allows you to
+  specify the schema version in effect when using the `schema` DSL method. For
+  backwards compatibility, this new setting defaults to `2`.
+
+  Internal reference: `#115859`.
+
 ## 1.0.10 (2022-05-19)
 
 * Update gem-internal ruby version and remove `bundler` from gemspec
@@ -38,7 +84,7 @@
 
 ## 1.0.3 (2020-05-12)
 
-- Overwrite parameter hash with the casted version if using 
+- Overwrite parameter hash with the casted version if using
   casting inside the schemacop `schema` block
 
 ## 1.0.2 (2019-10-09)

data/Gemfile

@@ -1,4 +1,20 @@
 source 'https://rubygems.org'
 
-# Specify gem dependencies in the .gemspec file
+# Specify runtime dependencies in the .gemspec file
 gemspec
+
+# Development dependencies
+group :development do
+  gem 'appraisal'
+  gem 'rake'
+end
+
+group :test do
+  gem 'minitest'
+  gem 'simplecov'
+  gem 'sqlite3'
+end
+
+group :lint do
+  gem 'rubocop', '~> 1.60'
+end

data/Gemfile.lock

@@ -0,0 +1,125 @@
+PATH
+  remote: .
+  specs:
+    inquery (1.1.0)
+      activerecord (>= 5.1)
+      activesupport (>= 5.1)
+      schemacop (>= 3.0.8, < 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (8.1.1)
+      activesupport (= 8.1.1)
+    activerecord (8.1.1)
+      activemodel (= 8.1.1)
+      activesupport (= 8.1.1)
+      timeout (>= 0.4.0)
+    activesupport (8.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    appraisal (2.5.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    ast (2.4.3)
+    base64 (0.3.0)
+    bigdecimal (3.3.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.5)
+    docile (1.4.1)
+    drb (2.2.3)
+    i18n (1.14.7)
+      concurrent-ruby (~> 1.0)
+    json (2.16.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    minitest (5.26.2)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.6.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    regexp_parser (2.11.3)
+    rubocop (1.81.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.48.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    schemacop (3.0.35)
+      activesupport (>= 4.0)
+      ruby2_keywords (>= 0.0.4)
+    securerandom (0.4.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    sqlite3 (2.8.1-aarch64-linux-gnu)
+    sqlite3 (2.8.1-aarch64-linux-musl)
+    sqlite3 (2.8.1-arm-linux-gnu)
+    sqlite3 (2.8.1-arm-linux-musl)
+    sqlite3 (2.8.1-arm64-darwin)
+    sqlite3 (2.8.1-x86-linux-gnu)
+    sqlite3 (2.8.1-x86-linux-musl)
+    sqlite3 (2.8.1-x86_64-darwin)
+    sqlite3 (2.8.1-x86_64-linux-gnu)
+    sqlite3 (2.8.1-x86_64-linux-musl)
+    thor (1.4.0)
+    timeout (0.4.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+    uri (1.1.1)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  appraisal
+  inquery!
+  minitest
+  rake
+  rubocop (~> 1.60)
+  simplecov
+  sqlite3
+
+BUNDLED WITH
+   2.5.18

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright © 2016 - 2022 Sitrox
+Copyright © 2016 - 2026 Sitrox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/MIGRATION.md

@@ -0,0 +1,260 @@
+# Migration Guide
+
+This guide helps you migrate from raw ActiveRecord queries to Inquery query classes, and between different versions of Inquery.
+
+## Migrating from Raw ActiveRecord Queries
+
+### Simple Query
+
+**Before (raw ActiveRecord):**
+```ruby
+# In controller or service
+def active_users
+  User.where(active: true).order(:name)
+end
+```
+
+**After (Inquery):**
+```ruby
+# app/queries/fetch_active_users.rb
+class FetchActiveUsers < Inquery::Query
+  def call
+    User.where(active: true).order(:name)
+  end
+end
+
+# In controller or service
+def active_users
+  FetchActiveUsers.run
+end
+```
+
+**Benefits:**
+- Reusable across controllers, services, and background jobs
+- Testable in isolation
+- Named and documented
+
+### Parameterized Query
+
+**Before (raw ActiveRecord):**
+```ruby
+def users_by_status(status)
+  User.where(status: status).order(:created_at)
+end
+```
+
+**After (Inquery with schema validation):**
+```ruby
+class FetchUsersByStatus < Inquery::Query
+  schema3 do
+    str! :status
+  end
+
+  def call
+    User.where(status: osparams.status).order(:created_at)
+  end
+end
+
+# Usage
+FetchUsersByStatus.run(status: 'active')
+```
+
+**Benefits:**
+- Automatic parameter validation
+- Type checking
+- Clear API documentation through schema
+
+### Complex Query with Post-Processing
+
+**Before:**
+```ruby
+def user_statistics
+  users = User.where(active: true)
+  {
+    total: users.count,
+    premium: users.where(plan: 'premium').count
+  }
+end
+```
+
+**After:**
+```ruby
+class FetchUserStatistics < Inquery::Query
+  def call
+    User.where(active: true)
+  end
+
+  def process(users)
+    {
+      total: users.count,
+      premium: users.where(plan: 'premium').count
+    }
+  end
+end
+```
+
+**Benefits:**
+- Separation of query logic and data transformation
+- Can call with 'call' to get raw results or 'run' for processed results
+
+### Scope to Chainable Query
+
+**Before:**
+```ruby
+class User < ActiveRecord::Base
+  scope :active, -> { where(active: true) }
+  scope :premium, -> { where(plan: 'premium') }
+end
+
+# Usage
+User.active.premium
+```
+
+**After:**
+```ruby
+class FetchActiveUsers < Inquery::Query::Chainable
+  relation class: 'User'
+
+  def call
+    relation.where(active: true)
+  end
+end
+
+class FetchPremiumUsers < Inquery::Query::Chainable
+  relation class: 'User'
+
+  def call
+    relation.where(plan: 'premium')
+  end
+end
+
+# Usage as query classes
+FetchPremiumUsers.run(FetchActiveUsers.run)
+
+# Or register as scopes
+class User < ActiveRecord::Base
+  scope :active, FetchActiveUsers
+  scope :premium, FetchPremiumUsers
+end
+
+User.active.premium
+```
+
+**Benefits:**
+- Full Ruby classes instead of lambdas
+- Can add tests, documentation, and complex logic
+- Chainable and composable
+
+## Schema Validation: Schemacop v2 vs v3
+
+Inquery supports both Schemacop v2 and v3 schemas. The default is v2 for backward compatibility.
+
+### Using Schemacop v2 (default)
+
+```ruby
+class FetchUsers < Inquery::Query
+  schema do
+    req :status, :string
+    opt :limit, :integer
+  end
+
+  def call
+    User.where(status: osparams.status)
+         .limit(osparams.limit || 10)
+  end
+end
+```
+
+### Using Schemacop v3 (recommended)
+
+```ruby
+class FetchUsers < Inquery::Query
+  schema3 do
+    str! :status
+    int? :limit
+  end
+
+  def call
+    User.where(status: osparams.status)
+         .limit(osparams.limit || 10)
+  end
+end
+```
+
+### Configuring Default Schema Version
+
+To use Schemacop v3 by default for all queries:
+
+```ruby
+# config/initializers/inquery.rb
+Inquery.setup do |config|
+  config.default_schema_version = 3
+end
+
+# Now you can use 'schema' instead of 'schema3'
+class FetchUsers < Inquery::Query
+  schema do
+    str! :status
+    int? :limit
+  end
+
+  def call
+    User.where(status: osparams.status)
+  end
+end
+```
+
+## Best Practices
+
+### Query Organization
+
+Organize queries by domain:
+
+```
+app/queries/
+├── user/
+│   ├── fetch_active.rb
+│   ├── fetch_by_email.rb
+│   └── search.rb
+├── order/
+│   ├── fetch_recent.rb
+│   └── fetch_by_status.rb
+└── base_query.rb
+```
+
+### Testing
+
+Test queries in isolation:
+
+```ruby
+# test/queries/fetch_active_users_test.rb
+class FetchActiveUsersTest < ActiveSupport::TestCase
+  test 'returns only active users' do
+    active_user = create(:user, active: true)
+    inactive_user = create(:user, active: false)
+
+    result = FetchActiveUsers.run
+
+    assert_includes result, active_user
+    refute_includes result, inactive_user
+  end
+end
+```
+
+### Naming Conventions
+
+- Use descriptive names: `FetchActiveUsers`, not `Users`
+- Prefix with verb: `Fetch`, `Create`, `Update`, `Delete`
+- Organize in modules: `User::FetchActive`, `Order::FetchRecent`
+
+### When to Use Query vs. Chainable
+
+**Use `Inquery::Query` when:**
+- Query doesn't need to be chained
+- Result needs post-processing
+- Query uses raw SQL
+
+**Use `Inquery::Query::Chainable` when:**
+- Query needs to be chainable
+- Using as ActiveRecord scope
+- Input and output are both relations

data/README.md

@@ -23,14 +23,21 @@ gem 'inquery'
 
 ## Compatibility
 
-Inquery is tested with the following ruby versions:
+Inquery is tested against multiple Ruby and Rails version combinations. The following table shows the compatibility matrix:
 
-* 2.5.1
-* 2.6.2
-* 2.7.1
-* 3.0.1
+| Ruby Version | Rails 5.2 | Rails 6.0 | Rails 6.1 | Rails 7.0 | Rails 7.1 | Rails 7.2 | Rails 8.0 | Rails 8.1 |
+|--------------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|-----------|
+| 2.6.2        | ✓         | ✓         | ✓         | -         | -         | -         | -         | -         |
+| 2.7.1        | -         | ✓         | ✓         | ✓         | -         | -         | -         | -         |
+| 3.0.1        | -         | -         | ✓         | ✓         | -         | -         | -         | -         |
+| 3.1.0        | -         | -         | -         | ✓         | ✓         | -         | -         | -         |
+| 3.2.0        | -         | -         | -         | ✓         | ✓         | ✓         | -         | -         |
+| 3.3.0        | -         | -         | -         | ✓         | ✓         | ✓         | ✓         | ✓         |
+| 3.4.1        | -         | -         | -         | -         | -         | ✓         | ✓         | ✓         |
 
-Other ruby versions might work but are not covered by our automated tests.
+**Minimum supported versions:** Ruby 2.6.2 and Rails 5.2
+
+Other Ruby/Rails version combinations might work but are not covered by our automated tests.
 
 ## Basic usage
 
@@ -297,7 +304,9 @@ end
 ```
 
 Inquery supports both schemacop specification versions 2 and 3 using the methods
-`schema` / `schema2` for version 2 and method `schema3` for version 3.
+`schema2` for version 2 and method `schema3` for version 3. You can also use the
+method `schema`, which defaults to the schema version configured using
+`config.default_schema_version` (see [Configuration](#Configuration)).
 
 ## Rails integration
 
@@ -306,6 +315,18 @@ perfectly integrated into any Rails application. It has proven to be a winning
 concept to extract all complex queries into separate classes that are
 independently executable and testable.
 
+## Configuration
+
+Inquery can be configured globally using an optional initializer:
+
+```ruby
+# config/initializers/inquery.rb
+Inquery.setup do |config|
+  # Specify the default schemacop schema version. Can be one of 2 or 3.
+  # config.default_schema_version = 2
+end
+```
+
 ### Directory structure
 
 While not enforced, it is encouraged to use the following structure for storing
@@ -333,8 +354,9 @@ There are some key benefits to this approach:
 ## Contributors
 
 Thanks to Jeroen Weeink for his insights regarding using query classes as scopes
-in his [blog post](http://craftingruby.com/posts/2015/06/29/query-objects-through-scopes.html).
+in his [blog
+post](http://craftingruby.com/posts/2015/06/29/query-objects-through-scopes.html).
 
 ## Copyright
 
-Copyright © 2016 - 2022 Sitrox. See `LICENSE` for further details.
+Copyright © 2016 - 2026 Sitrox. See `LICENSE` for further details.

data/RUBY_VERSION

@@ -1 +1 @@
-ruby-3.0.1-p64
+ruby-3.3.5