quo 1.0.0.beta2 → 2.0.0

data/sig/generated/quo/preloadable.rbs

@@ -1,6 +1,7 @@
 # Generated from lib/quo/preloadable.rb with RBS::Inline
 
 module Quo
+  # Mixin for adding preload/includes support to collection-backed queries
   module Preloadable
     def self.included: (untyped base) -> untyped
 

data/sig/generated/quo/query.rbs

@@ -1,16 +1,21 @@
 # Generated from lib/quo/query.rb with RBS::Inline
 
 module Quo
+  # Base class for query objects with pagination and composition support
   class Query < Literal::Struct
     include Literal::Types
 
-    def self.inspect: () -> untyped
+    # @rbs override
+    def self.inspect: ...
 
-    def self.to_s: () -> untyped
+    # @rbs override
+    def self.to_s: ...
 
-    def inspect: () -> untyped
+    # @rbs override
+    def inspect: ...
 
-    def to_s: () -> untyped
+    # @rbs override
+    def to_s: ...
 
     # TODO: put this in a module with the composer and merge_instances methods
     # Compose is aliased as `+`. Can optionally take `joins` parameters to add joins on merged relation.
@@ -19,6 +24,12 @@ module Quo
     # @rbs return: Quo::Query & Quo::ComposedQuery
     def self.compose: (Quo::Query | ActiveRecord::Relation | Object & Enumerable[untyped] right, ?joins: Symbol | Hash[Symbol, untyped] | Array[Symbol | Hash[Symbol, untyped]]) -> (Quo::Query & Quo::ComposedQuery)
 
+    # Helper method to define properties on a dynamically created class
+    # @rbs klass: Class
+    # @rbs props: Hash[Symbol, untyped]
+    # @rbs return: void
+    def self.define_props_on_class: (Class klass, Hash[Symbol, untyped] props) -> void
+
     COERCE_TO_INT: untyped
 
     attr_accessor page(): Integer?

data/sig/generated/quo/relation_backed_query.rbs

@@ -1,12 +1,17 @@
 # Generated from lib/quo/relation_backed_query.rb with RBS::Inline
 
 module Quo
+  # Query object backed by ActiveRecord relations
   class RelationBackedQuery < Query
-    # @rbs query: ActiveRecord::Relation | Quo::Query
+    # @rbs query: ActiveRecord::Relation | Quo::RelationBackedQuery
     # @rbs props: Hash[Symbol, untyped]
-    # @rbs &block: () -> ActiveRecord::Relation | Quo::Query | Object & Enumerable[untyped]
+    # @rbs &block: ? () -> (ActiveRecord::Relation | Quo::Query)
     # @rbs return: Quo::RelationBackedQuery
-    def self.wrap: (?ActiveRecord::Relation | Quo::Query query, ?props: Hash[Symbol, untyped]) ?{ (?) -> untyped } -> Quo::RelationBackedQuery
+    def self.wrap: (?ActiveRecord::Relation | Quo::RelationBackedQuery query, ?props: Hash[Symbol, untyped]) ?{ () -> (ActiveRecord::Relation | Quo::Query) } -> Quo::RelationBackedQuery
+
+    # @rbs relation: ActiveRecord::Relation
+    # @rbs return: Quo::WrappedRelationBackedQuery
+    def self.from: (ActiveRecord::Relation relation) -> Quo::WrappedRelationBackedQuery
 
     # @rbs conditions: untyped?
     # @rbs return: String
@@ -32,13 +37,18 @@ module Quo
     # @rbs return: Quo::Query
     def with: (?Hash[Symbol, untyped] options) -> Quo::Query
 
+    def model: () -> (untyped | nil)
+
+    def klass: () -> (untyped | nil)
+
+    # @rbs total_count: Integer?
     # @rbs return: Quo::CollectionBackedQuery
-    def to_collection: (?total_count: untyped) -> Quo::CollectionBackedQuery
+    def to_collection: (?total_count: Integer?) -> Quo::CollectionBackedQuery
 
     def results: () -> Quo::Results
 
     # Return the SQL string for this query if its a relation type query object
-    def to_sql: () -> String
+    def to_sql: () -> String?
 
     # Implements a fluent API for query methods
     # This allows methods to be chained like query.where(...).order(...).limit(...)

data/sig/generated/quo/relation_backed_query_specification.rbs

@@ -13,82 +13,90 @@ module Quo
     def initialize: (?Hash[Symbol, untyped] options) -> untyped
 
     # Creates a new specification with merged options
-    # @rbs new_options: Hash[Symbol, untyped]
-    # @rbs return: Quo::QuerySpecification
-    def merge: (Hash[Symbol, untyped] new_options) -> Quo::QuerySpecification
+    # @rbs new_options: Hash[Symbol, untyped] | RelationBackedQuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def merge: (Hash[Symbol, untyped] | RelationBackedQuerySpecification new_options) -> Quo::RelationBackedQuerySpecification
 
     # Apply all the specification options to the given ActiveRecord relation
     # @rbs relation: ActiveRecord::Relation
     # @rbs return: ActiveRecord::Relation
     def apply_to: (ActiveRecord::Relation relation) -> ActiveRecord::Relation
 
+    # @rbs key: Symbol
+    # @rbs return: bool
+    def has?: (Symbol key) -> bool
+
+    # @rbs key: Symbol
+    # @rbs return: untyped
+    def []: (Symbol key) -> untyped
+
     # @rbs *fields: untyped
-    # @rbs return: Quo::QuerySpecification
-    def select: (*untyped fields) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def select: (*untyped fields) -> Quo::RelationBackedQuerySpecification
 
     # @rbs conditions: untyped
-    # @rbs return: Quo::QuerySpecification
-    def where: (untyped conditions) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def where: (untyped conditions) -> Quo::RelationBackedQuerySpecification
 
     # @rbs order_clause: untyped
-    # @rbs return: Quo::QuerySpecification
-    def order: (untyped order_clause) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def order: (untyped order_clause) -> Quo::RelationBackedQuerySpecification
 
     # @rbs *columns: untyped
-    # @rbs return: Quo::QuerySpecification
-    def group: (*untyped columns) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def group: (*untyped columns) -> Quo::RelationBackedQuerySpecification
 
     # @rbs value: Integer
-    # @rbs return: Quo::QuerySpecification
-    def limit: (Integer value) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def limit: (Integer value) -> Quo::RelationBackedQuerySpecification
 
     # @rbs value: Integer
-    # @rbs return: Quo::QuerySpecification
-    def offset: (Integer value) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def offset: (Integer value) -> Quo::RelationBackedQuerySpecification
 
-    # @rbs tables: untyped
-    # @rbs return: Quo::QuerySpecification
-    def joins: (untyped tables) -> Quo::QuerySpecification
+    # @rbs *tables: untyped
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def joins: (*untyped tables) -> Quo::RelationBackedQuerySpecification
 
-    # @rbs tables: untyped
-    # @rbs return: Quo::QuerySpecification
-    def left_outer_joins: (untyped tables) -> Quo::QuerySpecification
+    # @rbs *tables: untyped
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def left_outer_joins: (*untyped tables) -> Quo::RelationBackedQuerySpecification
 
     # @rbs *associations: untyped
-    # @rbs return: Quo::QuerySpecification
-    def includes: (*untyped associations) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def includes: (*untyped associations) -> Quo::RelationBackedQuerySpecification
 
     # @rbs *associations: untyped
-    # @rbs return: Quo::QuerySpecification
-    def preload: (*untyped associations) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def preload: (*untyped associations) -> Quo::RelationBackedQuerySpecification
 
     # @rbs *associations: untyped
-    # @rbs return: Quo::QuerySpecification
-    def eager_load: (*untyped associations) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def eager_load: (*untyped associations) -> Quo::RelationBackedQuerySpecification
 
     # @rbs enabled: bool
-    # @rbs return: Quo::QuerySpecification
-    def distinct: (?bool enabled) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def distinct: (?bool enabled) -> Quo::RelationBackedQuerySpecification
 
     # @rbs order_clause: untyped
-    # @rbs return: Quo::QuerySpecification
-    def reorder: (untyped order_clause) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def reorder: (untyped order_clause) -> Quo::RelationBackedQuerySpecification
 
     # @rbs *modules: untyped
-    # @rbs return: Quo::QuerySpecification
-    def extending: (*untyped modules) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def extending: (*untyped modules) -> Quo::RelationBackedQuerySpecification
 
     # @rbs *args: untyped
-    # @rbs return: Quo::QuerySpecification
-    def unscope: (*untyped args) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def unscope: (*untyped args) -> Quo::RelationBackedQuerySpecification
 
     # Builds a new specification from a hash of options
     # @rbs options: Hash[Symbol, untyped]
-    # @rbs return: Quo::QuerySpecification
-    def self.build: (?Hash[Symbol, untyped] options) -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def self.build: (?Hash[Symbol, untyped] options) -> Quo::RelationBackedQuerySpecification
 
     # Returns a blank specification
-    # @rbs return: Quo::QuerySpecification
-    def self.blank: () -> Quo::QuerySpecification
+    # @rbs return: Quo::RelationBackedQuerySpecification
+    def self.blank: () -> Quo::RelationBackedQuerySpecification
   end
 end

data/sig/generated/quo/relation_results.rbs

@@ -1,6 +1,7 @@
 # Generated from lib/quo/relation_results.rb with RBS::Inline
 
 module Quo
+  # Results wrapper for relation-backed queries providing pagination and counting
   class RelationResults < Results
     # @rbs query: Quo::Query
     # @rbs transformer: (^(untyped, ?Integer) -> untyped)?

data/sig/generated/quo/results.rbs

@@ -1,6 +1,7 @@
 # Generated from lib/quo/results.rb with RBS::Inline
 
 module Quo
+  # Base results wrapper providing enumeration with optional transformation
   class Results
     def empty?: () -> bool
 
@@ -13,6 +14,12 @@ module Quo
     # Alias for page_count
     def page_size: () -> Integer
 
+    FILTER_METHODS: untyped
+
+    PAIR_FILTER_METHODS: untyped
+
+    PASSTHROUGH_METHODS: untyped
+
     # @rbs &block: (untyped, *untyped) -> untyped
     # @rbs return: Hash[untyped, Array[untyped]]
     def group_by: () { (untyped, *untyped) -> untyped } -> Hash[untyped, Array[untyped]]
@@ -35,5 +42,9 @@ module Quo
     # @rbs results: untyped
     # @rbs return: untyped
     def transform_results: (untyped results) -> untyped
+
+    # @rbs pair: untyped
+    # @rbs return: untyped
+    def transform_pair: (untyped pair) -> untyped
   end
 end

data/sig/generated/quo/rspec/helpers.rbs

@@ -0,0 +1,12 @@
+# Generated from lib/quo/rspec/helpers.rb with RBS::Inline
+
+module Quo
+  module Rspec
+    # Test helpers for stubbing query objects in RSpec
+    module Helpers
+      include Quo::Testing::FakeHelpers
+
+      def fake_query: (untyped query_class, ?with: untyped, ?results: untyped, ?total_count: untyped, ?page_count: untyped) ?{ (?) -> untyped } -> untyped
+    end
+  end
+end

data/sig/generated/quo/testing/collection_backed_fake.rbs

@@ -2,6 +2,7 @@
 
 module Quo
   module Testing
+    # Test helper for creating fake collection-backed queries with predefined results
     class CollectionBackedFake
       def collection: () -> untyped
 

data/sig/generated/quo/testing/fake_helpers.rbs

@@ -0,0 +1,14 @@
+# Generated from lib/quo/testing/fake_helpers.rb with RBS::Inline
+
+module Quo
+  module Testing
+    # Shared helpers for creating fake query objects in tests
+    module FakeHelpers
+      private
+
+      # @rbs query_class: Class
+      # @rbs return: Class
+      def build_fake_class: (Class query_class) -> Class
+    end
+  end
+end

data/sig/generated/quo/testing/relation_backed_fake.rbs

@@ -2,6 +2,7 @@
 
 module Quo
   module Testing
+    # Test helper for creating fake relation-backed queries with predefined results
     class RelationBackedFake
       def query: () -> untyped
 

data/sig/generated/quo/wrapped_collection_backed_query.rbs

@@ -0,0 +1,13 @@
+# Generated from lib/quo/wrapped_collection_backed_query.rb with RBS::Inline
+
+module Quo
+  class WrappedCollectionBackedQuery
+    @wrapped: Enumerable[untyped]
+
+    # @rbs override
+    def collection: ...
+
+    # @rbs override
+    def inspect: ...
+  end
+end

data/sig/generated/quo/wrapped_relation_backed_query.rbs

@@ -0,0 +1,13 @@
+# Generated from lib/quo/wrapped_relation_backed_query.rb with RBS::Inline
+
+module Quo
+  class WrappedRelationBackedQuery
+    @wrapped: ActiveRecord::Relation
+
+    # @rbs override
+    def query: ...
+
+    # @rbs override
+    def inspect: ...
+  end
+end

data/sig/generated/quo.rbs

@@ -1,5 +1,6 @@
 # Generated from lib/quo.rb with RBS::Inline
 
+# Query object library for ActiveRecord with composable queries and pagination
 module Quo
   extend ActiveSupport::Autoload
 

data/website/.gitignore

@@ -0,0 +1,6 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor
+Gemfile.lock

data/website/404.html

@@ -0,0 +1,26 @@
+---
+permalink: /404.html
+layout: default
+title: Page not found
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

data/website/Gemfile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.4"
+gem "jekyll-vitepress-theme", "~> 1.4"
+
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1", platforms: [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", platforms: [:jruby]

data/website/_config.yml

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+title: Quo
+email: stevegeek@gmail.com
+description: >-
+  Quo is a query object gem for Ruby on Rails. Query objects are composable, testable, and reusable.
+  Build complex database queries and collection transformations with a clean, fluent API.
+baseurl: ""
+url: ""
+github_username: stevegeek
+github_repo: quo
+
+theme: jekyll-vitepress-theme
+plugins:
+  - jekyll-feed
+  - jekyll-vitepress-theme
+
+collections:
+  docs:
+    output: true
+    permalink: /:path/
+
+defaults:
+  - scope:
+      path: ""
+      type: docs
+    values:
+      layout: default
+
+jekyll_vitepress:
+  branding:
+    site_title: Quo
+    logo:
+      default: /assets/quo.png
+      alt: Quo
+      width: 28
+      height: 28
+  syntax:
+    light_theme: github
+    dark_theme: github.dark
+  github_star:
+    repository: stevegeek/quo
+    text: Star
+    show_count: true
+  footer:
+    enabled: true
+    show_on_docs: true
+    copyright: >-
+      Quo | Copyright © 2025. Licensed under the
+      <a href="https://github.com/stevegeek/quo/blob/main/LICENSE.txt">MIT License</a>.

data/website/_data/navigation.yml

@@ -0,0 +1,8 @@
+- title: Guide
+  url: /get-started/
+  collections: [docs]
+- title: API
+  url: /api/
+  collections: [docs]
+- title: GitHub
+  url: https://github.com/stevegeek/quo

data/website/_data/sidebar.yml

@@ -0,0 +1,2 @@
+- title: Documentation
+  collection: docs

data/website/_data/social_links.yml

@@ -0,0 +1,3 @@
+- icon: github
+  label: Quo on GitHub
+  url: https://github.com/stevegeek/quo