query_delegator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: de7f682e9257edaad5326f54019aa84357b53820af24b60be2d5f920431431b3
+  data.tar.gz: 74d9add566f0af6e39d7e867c2928d672fff9e4e1c7718ca9b3f0f069eafeedb
+SHA512:
+  metadata.gz: 5d2ef26397dad3c9aadb540cae8b2c5eca5cc57060d0cfa82402d6e83cabe60c53cb2dd12bae41d7d20f1bee8ab88a4c53ba0c5c57cf6e6a9162799de6848928
+  data.tar.gz: 8eca6a5e8da0dd14dc201c2a7c7463faba2a596136d59f8879130c34619075d3da55b1618d4ddb82ec63870d7b19e5d99be45b68eaef6360b6205a2a40100472

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+before_install: gem install bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ritchie@richorelse.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in query_delegator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ritchie Paul Buitre
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,203 @@
+# QueryDelegator
+
+Write composable and table agnostic query objects for Active Record scopes. Move query code from `ActiveRecord` models into query objects, because database query code do not belong in the model.
+
+## Installation
+
+QueryDelegator works with Rails 5.1.7 onwards. Add this line to your application's Gemfile:
+
+```ruby
+gem 'query_delegator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install query_delegator
+
+## Usage
+
+Query objects inherit from `QueryDelegator` class, they typically live under `app/queries` directory.
+Naming convention suggests adding a `Query` suffix to query object class names.
+Alternatively prefixing class names with words like `By` is shorter and reads more naturally.
+
+```ruby
+class ByEmail < QueryDelegator
+  def call(email)
+    at(email).first
+  end
+
+  def at(email)
+    where(email: email.to_s.downcase)
+  end
+
+  def be(email)
+    return all unless email.blank?
+
+    at email
+  end
+end
+```
+
+Wrap scopes outside `ActiveRecord` models, by either passing the scope as an argument when instantiating a query object or
+by passing the query object class as a block argument to the scope's `then` method, also known as `yield_self`.
+
+```ruby
+@user = ByEmail.new(User).("john.doe@example.test")
+@contacts = @user.contacts.then(&ByEmail).be(params[:email])
+```
+
+You may also wrap scopes inside `ActiveRecord` models, like so:
+
+```ruby
+class User < ApplicationRecord
+  has_many :contacts
+  scope :by_email, ByEmail
+end
+
+class Contact < ApplicationRecord
+  belong_to :user
+  scope :by_email, ByEmail
+end
+
+@user = User.by_email.("john.doe@example.test")
+@contacts = @user.contacts.by_email.be(params[:email])
+```
+
+### QueryDelegator::[]
+
+Delegates Active Record scope to a query object method.
+Intended for association and named scopes, it accepts a query object's method name and returns a `Proc`.
+
+```ruby
+class User < ApplicationRecord
+  has_many :contacts, ByCreated[:recently]
+  scope :since, ByCreated[:since]
+end
+
+class ByCreated < QueryDelegator
+  def recently
+    order(created_at: :desc)
+  end
+
+  def since(timestamp)
+    where table[:created_at].gteq(timestamp)
+  end
+end
+
+@users = User.since 1.year.ago
+```
+
+### QueryDelegator::Be
+
+To add the helper method `be`, include this module in your query object class like so:
+
+```ruby
+class ByPublished < QueryDelegator
+  include Be
+
+  def be_draft
+    on nil
+  end
+
+  def be_published
+    where.not(published_on: nil)
+  end
+
+  def on(date)
+    where(published_on: date)
+  end
+end
+```
+
+#### be
+
+Given a name, method `be` invokes another method prefixed with `be_`, otherwise
+returns `none` by default or
+returns `all` given a blank name.
+
+```ruby
+@books = @author.books.then(&ByPublished)
+@books.be(['draft'])  # returns books without publish date
+@books.be(:published) # returns books with publish date
+@books.be('unknown')  # returns none
+@books.be(nil)        # returns all books
+```
+
+### QueryDelegator::MemoryFetching
+
+Provides convenient methods intended to retrieve loaded records from memory,
+instead of running queries from the database.
+Include this module in your query object classes like so:
+
+```ruby
+class ByColor < QueryDelegator
+  include MemoryFetching
+
+  def fetch_by_color(color)
+    fetch -> { |by| by.color == color }
+  end
+end
+
+ByEmail.include QueryDelegator::MemoryFetching
+```
+
+#### fetch
+
+This helper method retrieves the first record that meets the condition, otherwise
+returns either the given block value or the optional default value which is `nil`.
+
+```ruby
+@vehicles = Vehicle.then(&ByColor)
+@vehicles.fetch_by_color 'red'                               # returns a red Vehicle record
+@vehicles.fetch(-> v { v.color == 'gold'}                    # returns nil
+@vehicles.fetch(proc { |v| v.color == 'gold'}, NoVehicle)    # returns NoVehicle
+@vehicles.fetch(proc { |v| v.color == 'gold'}) { NoVehicle } # returns NoVehicle
+@vehicles.fetch(Car)                                         # returns a Car record
+```
+
+#### fetch_or_new
+
+This method also [fetches](#fetch) a record that meets the condition, otherwise loads a new record with `Hash` from the argument condition.
+Given a block, it instead fetches a record that meets the block condition.
+
+```ruby
+class HasEmailOrPhone < SimpleDelegator
+  def ===(contact)
+    contact.email == email || contact.phone == phone
+  end
+
+  def to_h
+    { full_name: full_name, email: email, phone: phone }
+  end
+end
+
+@user_contacts = ByEmail.new(@user.contacts)
+
+# Returns a Contact with the same customer name or email.
+@customer_contact = @user_contacts.fetch_or_new(HasEmailOrPhone[@customer])
+
+# Either fetch primary Contact or load a new Contact with the specified email.
+@primary_contact = @user_contacts.fetch_or_new(email: "john.doe@example.test", &:primary?)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RichOrElse/query_delegator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the QueryDelegator project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/RichOrElse/query_delegator/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "query_delegator"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/query_delegator.rb

@@ -0,0 +1,45 @@
+require "active_support/core_ext/module/delegation"
+require "active_support/core_ext/object"
+require "query_delegator/version"
+require "query_delegator/memory_fetching"
+require "query_delegator/be"
+
+class QueryDelegator
+  delegate_missing_to :@current_scope
+
+  def initialize(relation)
+    @current_scope = relation.all
+  end
+
+  class << self
+    # Returns a Proc which wraps an ActiveRecord scope in a new query object instance.
+    def to_proc
+      delegator = self
+
+      proc do |*args|
+        if equal? delegator
+          new(*args)
+        else
+          delegator.(self, *args)
+        end
+      end
+    end
+
+    # Returns a Proc which delegates an ActiveRecord model scope to query object instance method.
+    def [](delegating)
+      delegator = self
+
+      if public_instance_method(delegating).arity.zero?
+        proc do
+          delegator.new(self).public_send delegating
+        end
+      else
+        proc do |*options|
+          delegator.new(self).public_send delegating, *options
+        end
+      end
+    end
+
+    alias_method :call, :new
+  end
+end

data/lib/query_delegator/be.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require_relative 'respond_or_none'
+
+class QueryDelegator
+  module Be
+    using RespondOrNone
+
+    # Invokes method name prefixed with +be_+, othewise
+    # returns +all+ given a blank name or
+    # returns +none+ when method is unrecognized.
+    def be(name, *args, &blk)
+      return all if name.blank?
+
+      underscored = name.to_s.strip.underscore
+                        .gsub(/[^0-9a-z _]/i, '')
+                        .gsub(/\s+/, '_')
+
+      respond_to("be_#{underscored}", *args, &blk)
+    end
+  end
+end

data/lib/query_delegator/memory_fetching.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class QueryDelegator
+  module MemoryFetching
+    # Returns the first record that meets the +condition+, otherwise
+    # returns the given +block value+ or
+    # returns +nil+ by default unless a second argument is specified.
+    def fetch(condition, default_value = nil)
+      grep(condition) { |found| return found }
+      return yield condition if defined? yield
+
+      default_value
+    end
+
+    # Returns the first record that meets either the +block condition+ if given or the argument +condition+, otherwise
+    # returns a new record with Hash from the argument +condition+.
+    def fetch_or_new(condition, &block_condition)
+      fetch(block_condition || condition) { new(condition.to_h) }
+    end
+  end
+end

data/lib/query_delegator/respond_or_none.rb

@@ -0,0 +1,15 @@
+class QueryDelegator
+  module RespondOrNone
+    # Invokes a public method, otherwise
+    # returns +none+ when method is unrecognized
+    def respond_to(method_name, *args, &blk)
+      return none unless respond_to?(method_name)
+
+      public_send(method_name, *args, &blk)
+    end
+
+    refine ::Object do
+      include RespondOrNone
+    end
+  end
+end

data/lib/query_delegator/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class QueryDelegator
+  VERSION = "1.0.0"
+end

data/query_delegator.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "query_delegator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "query_delegator"
+  spec.version       = QueryDelegator::VERSION
+  spec.authors       = ["Ritchie Paul Buitre"]
+  spec.email         = ["ritchie@richorelse.com"]
+
+  spec.summary       = "Write composable and table agnostic query objects for Active Record scopes."
+  spec.description   = "Move query code from ActiveRecord models into query objects, because database query code do not belong in the model."
+  spec.homepage      = "https://github.com/RichOrElse/query_delegator"
+  spec.license       = "MIT"
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.2.2"
+  spec.add_runtime_dependency "activesupport", ">= 5.1.7"
+
+  spec.add_development_dependency "bundler", ">= 1.17"
+  spec.add_development_dependency "rake", ">= 10.0"
+  spec.add_development_dependency "minitest", "~> 5.1"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: query_delegator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ritchie Paul Buitre
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+description: Move query code from ActiveRecord models into query objects, because
+  database query code do not belong in the model.
+email:
+- ritchie@richorelse.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/query_delegator.rb
+- lib/query_delegator/be.rb
+- lib/query_delegator/memory_fetching.rb
+- lib/query_delegator/respond_or_none.rb
+- lib/query_delegator/version.rb
+- query_delegator.gemspec
+homepage: https://github.com/RichOrElse/query_delegator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Write composable and table agnostic query objects for Active Record scopes.
+test_files: []