query_relation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 632b61d4ce3da388ed9f41a5d15e7a342e231d8a
-  data.tar.gz: c51f0796dfd50d5ad6b885d49ca5c2a68c83c789
+SHA256:
+  metadata.gz: 1e8615131100966dea784b0fb003b5ef481b2ccf078c5fc7fa58f476f3bfb00b
+  data.tar.gz: cf5ecd6368a52f13868f3fa9f96fbb803609a56cd9b388df5fae8c10b565aebe
 SHA512:
-  metadata.gz: b34c6259edb7a188d7af432ea3f42deda29e0e99b272dfdbb87058ea39a0b7803f6369576ce2dcafeaf9b1d63983e152120038299704702f53cb862e577b4aee
-  data.tar.gz: 7c8c3c4df2595c1b6e7bc4f5a938a1e73f3bb34f070bcda549e0eebd9cd3b7254910ee9dd22ad84b5257e91901bcc1df467e9e6d63d0f21e88bee2169dbaeca1
+  metadata.gz: a27749c6b342aa7f7a103e88474cc5fc74bae35ab45b2da1c73aaf8e40e328e570305fc138a17b11e8549c299351955f99abe35e4bb9c7881e2e1ea0777ce3d9
+  data.tar.gz: a392e0251959c7573342e10fc277b2c3720c580ae61f615e3b65768f75ed59ad83e22673aab8a99787d46758715dc4142aeccb9b1314616390cef838a72cbad4

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+prepare:
+  fetch:
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_base.yml
+    path: ".rubocop_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/.rubocop_cc_base.yml
+    path: ".rubocop_cc_base.yml"
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/base.yml
+    path: styles/base.yml
+  - url: https://raw.githubusercontent.com/ManageIQ/manageiq-style/master/styles/cc_base.yml
+    path: styles/cc_base.yml
+plugins:
+  rubocop:
+    enabled: true
+    config: ".rubocop_cc.yml"
+    channel: rubocop-1-56-3
+version: '2'

data/.github/workflows/ci.yaml

@@ -0,0 +1,37 @@
+---
+name: CI
+on:
+  push:
+  pull_request:
+  schedule:
+  - cron: 0 0 * * 0
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version:
+        - '2.5'
+        - '2.6'
+        - '2.7'
+        - '3.0'
+        - '3.1'
+        - '3.2'
+        - '3.3'
+        - '3.4'
+    env:
+      CC_TEST_REPORTER_ID: "${{ secrets.CC_TEST_REPORTER_ID }}"
+    steps:
+    - uses: actions/checkout@v5
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: "${{ matrix.ruby-version }}"
+        bundler-cache: true
+      timeout-minutes: 30
+    - name: Run tests
+      run: bundle exec rake
+    - name: Report code coverage
+      if: ${{ github.ref == 'refs/heads/master' && matrix.ruby-version == '3.4' }}
+      continue-on-error: true
+      uses: paambaati/codeclimate-action@v9

data/.rspec

@@ -1,3 +1,3 @@
 --require spec_helper
---format documentation
 --color
+--order random

data/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_gem:
+  manageiq-style: ".rubocop_base.yml"
+inherit_from:
+- ".rubocop_local.yml"

data/.rubocop_cc.yml

@@ -0,0 +1,4 @@
+inherit_from:
+- ".rubocop_base.yml"
+- ".rubocop_cc_base.yml"
+- ".rubocop_local.yml"

data/.whitesource

@@ -0,0 +1,3 @@
+{
+  "settingsInheritedFrom": "ManageIQ/whitesource-config@master"
+}

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+## [0.2.0] - 2025-10-07
+### Fixed
+- `Model#pluck` now passes `:select` [#34](https://github.com/ManageIQ/query_relation/pull/34)
+
+### Added
+- Added support for Ruby 2.5-3.4 [#44](https://github.com/ManageIQ/query_relation/pull/44) and others
+- Support for `Model.to_a` [#34](https://github.com/ManageIQ/query_relation/pull/34)
+- Backwards compatibility between references/includes and eager_load/preload [#43](https://github.com/ManageIQ/query_relation/pull/43)
+
+### Changed
+- Dropped dependencies: more_core_extensions and active_support. [#31](https://github.com/ManageIQ/query_relation/pull/31)
+
+## [0.1.1] - 2016-11-17
+### Added
+- Add CHANGELOG.md
+- Update README with usage instructions.
+
+[Unreleased]: https://github.com/ManageIQ/query_relation/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/ManageIQ/query_relation/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/ManageIQ/query_relation/compare/v0.1.0...v0.1.1

data/README.md

@@ -2,6 +2,13 @@
 
 Provides an ActiveRecord::Relation-like DSL to non-SQL backends
 
+[![Gem Version](https://badge.fury.io/rb/query_relation.svg)](http://badge.fury.io/rb/query_relation)
+[![CI](https://github.com/ManageIQ/query_relation/actions/workflows/ci.yaml/badge.svg)](https://github.com/ManageIQ/query_relation/actions/workflows/ci.yaml)
+[![Code Climate](https://codeclimate.com/github/ManageIQ/query_relation.svg)](https://codeclimate.com/github/ManageIQ/query_relation)
+[![Test Coverage](https://codeclimate.com/github/ManageIQ/query_relation/badges/coverage.svg)](https://codeclimate.com/github/ManageIQ/query_relation/coverage)
+
+[![Chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ManageIQ/query_relation?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,6 +25,69 @@ Or install it yourself as:
 
     $ gem install query_relation
 
+## Usage
+
+The `QueryRelation` class is provided to encapsulate building a relation.  It is
+a chainable interface, upon which query methods can be called, and final
+execution is delayed until the last possible moment.  It can be instantiated
+directly, but the more common way to get access to one is to mixin the
+`QueryRelation::Queryable` module into your collection.
+
+`QueryRelation::Queryable` expects a method named `search` to be implemented by
+the mixee.  `search` should be written to take two parameters
+
+- `mode`: one of `first`, `last`, or `all`
+- `options`: a Hash containing the choices that were made by the caller.  It
+  will contain the keys `:where`, `:select`, `:limit`, `:offset`, `:order`,
+  `group`, `:includes`, and/or `:references`
+
+The `search` method should be written to process this set of options and return
+an Array of the selection.  It can use the options and mode in any way it sees
+fit to optimally return the requested values.
+
+### Example
+
+Here's a simple example that supports limit and offset over a simple collection
+to give an idea of how one might write a `search` method.
+
+```ruby
+class MyCollection
+  include QueryRelation::Queryable
+
+  private
+
+  THE_COLLECTION = [1, 2, 3, 4].freeze
+
+  def search(mode, options)
+    collection = filter_collection_by_options(options)
+
+    case mode
+    when :first then collection.first
+    when :last  then collection.last
+    when :all   then collection
+    end
+  end
+
+  def filter_collection_by_options(options)
+    collection = THE_COLLECTION
+    collection = collection.drop(options[:offset]) if options[:offset]
+    collection = collection.take(options[:limit]) if options[:limit]
+    collection
+  end
+end
+
+MyCollection.new.all.to_a
+# => [1, 2, 3, 4]
+MyCollection.new.limit(2).to_a
+# => [1, 2]
+MyCollection.new.limit(1).offset(2).to_a
+# => [3]
+MyCollection.new.first
+# => 1
+MyCollection.new.last
+# => 4
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/query_relation/queryable.rb

@@ -22,6 +22,8 @@ class QueryRelation
                    :first,
                    :last,
                    :take,
+                   :to_a,
+                   :pluck,
                    :count
   end
 end

data/lib/query_relation/version.rb

@@ -1,3 +1,3 @@
 class QueryRelation
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/query_relation.rb

@@ -1,12 +1,6 @@
 require 'query_relation/version'
 require 'query_relation/queryable'
 
-require 'active_support/core_ext/array/wrap'
-require 'active_support/core_ext/enumerable'
-require 'active_support/core_ext/object/blank'
-
-require 'more_core_extensions/core_ext/hash/deletes'
-
 require 'forwardable'
 
 class QueryRelation
@@ -18,20 +12,22 @@ class QueryRelation
   # - [ ] bind
   # - [ ] create_with
   # - [ ] distinct
-  # - [ ] eager_load
+  # - [X] eager_load (partial - leveraging references)
   # - [X] except ? - is this not defined in the interface?
   # - [ ] extending
   # - [ ] from
   # - [X] group
   # - [ ] ~~having~~ - NO
   # - [X] includes (partial)
-  # - [ ] joins
+  # - [X] joins (partial - references includes)
+  # - [ ] left_joins
+  # - [ ] left_outer_joins
   # - [X] limit
   # - [ ] lock
   # - [.] none
   # - [X] offset
   # - [X] order (partial)
-  # - [ ] preload
+  # - [X] preload (partial - leveraging includes)
   # - [ ] readonly
   # - [X] references (partial)
   # - [X] reorder
@@ -53,14 +49,15 @@ class QueryRelation
     val = val.first if val.size == 1 && val.first.kind_of?(Hash)
     dup.tap do |r|
       old_where = r.options[:where]
-      if val.blank?
+      if val.nil? || val.empty?
         # nop
-      elsif old_where.blank?
+      elsif old_where.nil? || old_where.empty?
         r.options[:where] = val
       elsif old_where.kind_of?(Hash) && val.kind_of?(Hash)
+        old_where = r.options[:where] = r.options[:where].dup
         val.each_pair do |key, value|
           old_where[key] = if old_where[key]
-                             Array.wrap(old_where[key]) + Array.wrap(value)
+                             Array(old_where[key]) + Array(value)
                            else
                              value
                            end
@@ -72,14 +69,32 @@ class QueryRelation
     end
   end
 
+  def where_values
+    options[:where]
+  end
+
   def includes(*args)
     append_hash_array_arg :includes, {}, *args
   end
 
+  def includes_values
+    options[:includes] || []
+  end
+
+  alias preload includes
+  alias preload_values includes_values
+
   def references(*args)
     append_hash_array_arg :references, {}, *args
   end
 
+  def references_values
+    options[:references] || []
+  end
+
+  alias joins references
+
+  # @param val [Integer] maximum number of rows to bring back
   def limit(val)
     assign_arg :limit, val
   end
@@ -88,29 +103,35 @@ class QueryRelation
     options[:limit]
   end
 
-  def order(*args)
-    append_hash_array_arg :order, "ASC", *args
+  # @param columns [Array<Symbol>, Symbol] columns for order
+  def order(*columns)
+    append_hash_array_arg :order, "ASC", *columns
   end
 
   def order_values
     options[:order] || []
   end
 
-  def group(*args)
-    append_hash_arg :group, *args
+  # @param columns [Array<Symbol>, Symbol] columns for order, replacing original
+  def group(*columns)
+    append_hash_arg :group, *columns
   end
 
-  def reorder(*val)
-    val = val.flatten.compact
-    if val.first.kind_of?(Hash)
-      raise ArgumentError, "Need to support #{__callee__}(#{val.class.name})"
+  # @param columns [Array<Symbol>, Symbol] columns for order, replacing original
+  def reorder(*columns)
+    columns = columns.flatten.compact
+    if columns.first.kind_of?(Hash)
+      raise ArgumentError, "Need to support #{__callee__}(#{columns.class.name})"
     end
 
-    dup.tap do |r|
-      r.options[:order] = val
-    end
+    assign_arg(:order, columns)
   end
 
+  # similar to references, except takes typical hash and doesn't require includes entry
+  alias eager_load references
+  alias eager_load_values references_values
+
+  # @param val [Array<Symbol>, Symbol] attributes to remove from the query
   def except(*val)
     dup.tap do |r|
       val.flatten.compact.each do |key|
@@ -119,6 +140,7 @@ class QueryRelation
     end
   end
 
+  # @param val [Array<Symbol>, Symbol] attributes to remove from the query
   # similar to except. difference being this persists across merges
   def unscope(*val)
     dup.tap do |r|
@@ -128,6 +150,7 @@ class QueryRelation
     end
   end
 
+  # @param val [Integer] offset
   def offset(val)
     assign_arg :offset, val
   end
@@ -136,9 +159,23 @@ class QueryRelation
     options[:offset]
   end
 
-  # @param val [Array<Sting,Symbol>,String, Symbol]
-  def select(*args)
-    append_hash_arg :select, *args
+  # @param columns [Array<Sting, Symbol>, String, Symbol] columns to bring back
+  def select(*columns)
+    append_hash_arg :select, *columns
+  end
+
+  # @param columns [Array<Sting,Symbol>,String, Symbol] columns to bring back
+  def pluck(*columns)
+    columns = columns.flatten.compact
+
+    val = assign_arg(:select, columns).to_a
+
+    if columns.size == 1
+      column = columns.first
+      val.map { |row| row[column] }
+    else
+      val.map { |row| columns.map { |col| row[col] } }
+    end
   end
 
   def to_a
@@ -155,7 +192,19 @@ class QueryRelation
     to_a.size
   end
 
-  def_delegators :to_a, :size, :length, :take, :each, :empty?, :presence
+  def_delegators :to_a, :size, :length, :take, :each, :empty?
+
+  def presence
+    to_a if present?
+  end
+
+  def blank?
+    to_a.nil? || to_a.empty?
+  end
+
+  def present?
+    !blank?
+  end
 
   # TODO: support arguments
   def first
@@ -178,7 +227,7 @@ class QueryRelation
   end
 
   def call_query_method(mode)
-    @target.call(mode, options.delete_blanks)
+    @target.call(mode, options.delete_if { |_n, v| v.nil? || (v.respond_to?(:empty?) && v.empty?) })
   end
 
   def append_hash_arg(symbol, *val)
@@ -203,9 +252,9 @@ class QueryRelation
   # @param b [Array, Hash]
   # @param default default value for conversion to a hash. e.g.: {} or "ASC"
   def merge_hash_or_array(a, b, default = {})
-    if a.blank?
+    if a.nil? || a.empty?
       b
-    elsif b.blank?
+    elsif b.nil? || b.empty?
       a
     elsif a.kind_of?(Array) && b.kind_of?(Array)
       a + b

data/query_relation.gemspec

@@ -19,10 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-
-  spec.add_dependency "activesupport"
-  spec.add_dependency "more_core_extensions"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "manageiq-style"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec",         "~> 3.0"
+  spec.add_development_dependency "simplecov",     ">= 0.21.2"
 end

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "inheritConfig": true,
+  "inheritConfigRepoName": "manageiq/renovate-config"
+}

metadata

@@ -1,86 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: query_relation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Keenan Brock
 - Jason Frey
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-14 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: manageiq-style
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: more_core_extensions
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: 0.21.2
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.21.2
 description: Provides an ActiveRecord::Relation-like DSL to non-SQL backends
 email:
 - kbrock@redhat.com
@@ -89,9 +88,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
+- ".github/workflows/ci.yaml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_cc.yml"
+- ".rubocop_local.yml"
+- ".whitesource"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -103,11 +108,11 @@ files:
 - lib/query_relation/queryable.rb
 - lib/query_relation/version.rb
 - query_relation.gemspec
+- renovate.json
 homepage: https://github.com/ManageIQ/query_relation
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -122,9 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Provides an ActiveRecord::Relation-like DSL to non-SQL backends
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.3.1
-before_install: gem install bundler -v 1.12.5