inquery 1.0.11 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1196c966133abae58b4ba672eebc7fadf0852f4de0ff879673322bf6bfb4a285
-  data.tar.gz: 534d1e42f4df591e5cdb1e5e5995c8a3479f1afe03d6bb45d03773ad29c0838f
+  metadata.gz: b98dc6fa8124e5d5febb058d644524f392d4ad94a140eebe361811aa92e74d17
+  data.tar.gz: 201d38b5fcaa35608c70ec2800685930272d6e9ca5a68f0c3b3d367e3db61382
 SHA512:
-  metadata.gz: 31c7638d4a5eb7b32df879028bd01ee612254b1c34ffd2851be7851a5bb72488851748eba904ce6c7967e70e98ba4a85729960a00addd093ea622cdf96f3df30
-  data.tar.gz: 0fbe2057d13400d67546ee5722eb85b5e04cc794552c85043d3e939bc89cbd55eff247f8c4b28d681297d2e1305be32da61fc47d1c811868822cf2c36e9759ac
+  metadata.gz: b6941ca16491c5322fd81976842cda78a35418caf272a2c4e1027fa5d6d9a9713c509ea8d482384c60ba287efa269244530a5e28043517bdd0b02a1a9056d310
+  data.tar.gz: 87c4af61b494a8d2e668b81fe884a3ed195fabce4d0b48f8582dcb92889424f96d8154b3bbeb2c03860d33329f177db22d27fc3bf0aaef51774d50ad0094fc00

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,60 @@
 # Change log
 
+## 1.1.1 (2026-06-15)
+
+* Fix `osparams` returning wrong values for keys that collide with `Hash` /
+  `Enumerable` method names (e.g. `group_by`, `count`, `zip`, `select`). Since
+  1.1.0 `MethodAccessibleHash` subclassed `Hash`, so `osparams.group_by` invoked
+  `Enumerable#group_by` (returning an `Enumerator`) instead of the stored value.
+  `MethodAccessibleHash` no longer subclasses `Hash`; it wraps an internal hash
+  and exposes only `[]`, `[]=`, `to_h`, `merge`, `==` and method-based access.
+
+  Note: as a result, the `Hash` / `Enumerable` API that was briefly available
+  in 1.1.0 (e.g. `each`, `keys`, `values`, `dig`, `map`, `**` splat) is no
+  longer exposed -- call `to_h` first if you need it. `merge` now takes a
+  positional hash (or another `MethodAccessibleHash`) instead of keyword
+  arguments.
+
+  Internal reference: `#150355`.
+
+## 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

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.1)
+      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.17.1.2)
+    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 - 2023 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,15 +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
-* 3.2.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
 
@@ -283,8 +289,11 @@ raised if the given params do not match the schema specified. See documentation
 of the Schemacop Gem for more information on how to specify schemas.
 
 Parameters can be accessed using either `params` or `osparams`. The method
-`osparams` automatically wraps `params` in an `OpenStruct` for more convenient
-access.
+`osparams` wraps `params` in a `MethodAccessibleHash`, allowing access to the
+top-level parameters via dot notation (e.g. `osparams.search`) in addition to
+the usual `[]` access. Unlike a plain `Hash`, a `MethodAccessibleHash` does not
+expose the `Hash`/`Enumerable` API, so keys named like Hash methods (e.g.
+`count`, `select`, `zip`) still return their stored value.
 
 ```ruby
 class SomeQueryClass < Inquery::Query
@@ -353,4 +362,4 @@ post](http://craftingruby.com/posts/2015/06/29/query-objects-through-scopes.html
 
 ## Copyright
 
-Copyright © 2016 - 2023 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