plain_query 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 61ae47934ae841a4229172526bf21e44e8f038a297596624102035277b7daf0a
+  data.tar.gz: 0f70b4d457dddb4a01f971afa7e229589178c9200ed785bf97258bbbf8f179d4
+SHA512:
+  metadata.gz: c1c425097bdd73f3d10fe3c29ae62cbb6410073fb3263ed9be355fa16459f916ec0b41c50a3bd9e8dbedf9da23c19d85ebd056795e141268b2925d40ab6a5fad
+  data.tar.gz: df14cce0826761f2c136ace6409ade132925b04a641d890359534d7eb89585188e25dd9f3eb97110e496755ee79baf6d7f39ed77bcc4f8012217e8e8da63b11d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.5
+before_install: gem install bundler -v 1.17.3

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 glee812@yandex.ru. 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 plain_query.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Gleb
+
+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,146 @@
+# PlainQuery
+
+PlainQuery is a simple gem that helps you write clear and flexible query objects.
+Main task for this gem is performing complex querying on active record relation, make it intuitive.
+
+It helps in decomposing your fat ActiveRecord models and keeping your code slim and readable by extracting complex SQL queries or scopes into the separated classes that are easy to write, read and use.
+
+PlainQuery is useful when you need to build one or more queries based on incoming parameters in the request. It hides scope building logic inside query class and allows you to structure the building of the scope.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'plain_query'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plain_query
+
+## Usage
+### Setting up a query object
+For setting up a query object you need to inherit your query class from PlainQuery.
+Then you need to describe query steps by using query_step method.
+Query steps perform in writing order.
+
+```rb
+class UsersQuery < PlainQuery
+  model User
+
+  query_step :filter_by_activity, if: { options[:only_active] }
+  query_step :filter_by_phone_presence
+  query_step :order_by_name
+
+  def filter_by_activity
+    relation.where(active: true)
+  end
+
+  def filter_by_phone_presence
+    relation.where.not(phone: nil)
+  end
+
+  def order_by_name
+    relation.order(name: :asc)
+  end
+end
+```
+
+### Query calling
+
+```rb
+users = UsersQuery.call(User.all, only_active: true)
+```
+
+Query object implements `#call` method with two arguments:
+
+`relation` - Base scope which will be mutated inside query object. (`User.all` in example).
+If you dont pass it - will be used default scope from model declaration inside query object.
+
+`options` - Any data which will be used inside query steps or execution conditions. (`only_active: true` in example).
+
+Query object returns scope builded by query steps execution.
+
+### query_step
+`query_step` is a main part of query building.
+
+It declares which query change method will be executed, condition of execution and order of query change methods execution.
+
+It has several arguments:
+
+```rb
+query_step STEP_NAME, CONDITION_OF_EXECUTION
+```
+
+`STEP_NAME` is a name of method which will be executed.
+
+`CONDITION_OF_EXECUTION` is a method which allows or denieds execution of query step.
+Type of condition can be `if:` or `unless:`. Condition definition can be proc (lambda) or some query object method name.
+
+### Using in Active Record model scope.
+First of all you need to set correct model name inside query object.
+
+It uses for correct base scope building without passing relation to query object.
+
+```rb
+model User
+```
+
+```rb
+class User < ActiveRecord::Base
+  scope :active_clients, ActiveClientsQuery
+end
+```
+
+```rb
+class ActiveClientsQuery < PlainQuery
+  model User
+
+  query_step :filter_by_activity
+  query_step :filter_by_role
+
+  def filter_by_activity
+    relation.where(active: true)
+  end
+
+  def filter_by_role
+    relation.where(role: :client)
+  end
+end
+```
+
+And then you can use scope from model:
+
+```rb
+User.active_clients
+```
+
+Also you can pass to Active Record scope some options:
+
+```rb
+class User < ActiveRecord::Base
+  scope :active_clients, -> { ActiveClientsQuery.call(self, option: true) }
+end
+```
+
+## 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.
+
+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/[USERNAME]/plain_query. 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 PlainQuery project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/plain_query/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "plain_query"
+
+# 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/plain_query/logic.rb

@@ -0,0 +1,75 @@
+# Realises methods for scope building by execution of sequence of steps
+# Query class defines query steps:
+# query_step :filter_by_status, if: -> { options[:status].present? }
+# def filter_by_status
+#   relation.where(status: options[:status])
+# end
+class PlainQuery
+  attr_reader :relation, :options
+
+  def initialize(relation, options)
+    @relation = relation
+    @options = options
+    @steps = self.class.steps
+
+    # Validates initial relation format. Allowed only ActiveRecord::Relation, model class.
+    if relation.nil?
+      raise(RelationRequired, 'Queries require a base relation defined')
+    elsif !relation.is_a?(ActiveRecord::Relation)
+      raise(RelationRequired, 'Queries accept only ActiveRecord::Relation as input')
+    end
+  end
+
+  def exec_query
+    @steps.each do |step_name, params|
+      # Handles if condition
+      if (params[:if] && !exec_condition(params[:if]))
+        next
+      end
+
+      # Handles unless condition
+      if (params[:unless] && exec_condition(params[:unless]))
+        next
+      end
+
+      # Executes query mutation and checks that step returns ActiveRecord::Relation
+      mutated_query = send(step_name)
+      if !mutated_query.is_a?(ActiveRecord::Relation)
+        raise(RelationIsIncorrect, 'Scope must be ActiveRecord::Relation')
+      end
+
+      @relation = mutated_query
+    end
+
+    @relation
+  end
+
+  # Executes if and unless conditions, conditions must contain object method name or proc (lambda)
+  def exec_condition(condition)
+    if condition.is_a?(String) || condition.is_a?(Symbol)
+      !!send(condition)
+    elsif condition.is_a?(Proc)
+      !!instance_exec(&condition)
+    else
+      raise(ConditionFormatIsIncorrect, 'Condition must be method name or proc')
+    end
+  end
+
+  class << self
+    def call(relation = @model&.all, options = {})
+      new(relation, options).exec_query
+    end
+
+    def query_step(step_name, params = {})
+      steps << [step_name, params]
+    end
+
+    def steps
+      @steps ||= []
+    end
+
+    def model(model)
+      @model = model
+    end
+  end
+end

data/lib/plain_query/version.rb

@@ -0,0 +1,3 @@
+class PlainQuery
+  VERSION = "0.0.1"
+end

data/lib/plain_query.rb

@@ -0,0 +1,2 @@
+require "plain_query/version"
+require "plain_query/logic"

data/plain_query.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "plain_query/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "plain_query"
+  spec.version       = PlainQuery::VERSION
+  spec.authors       = ["gl-pv"]
+  spec.email         = ["gleeb812812@yandex.ru"]
+
+  spec.summary       = %q{Builds query object by declaration sequence of query building steps}
+  spec.description   = %q{PlainQuery is a simple gem that helps you write clear and flexible query objects}
+  spec.homepage      = "https://github.com/gl-pv/plain_query"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/gl-pv/plain_query"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: plain_query
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- gl-pv
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-09-10 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: PlainQuery is a simple gem that helps you write clear and flexible query
+  objects
+email:
+- gleeb812812@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/plain_query.rb
+- lib/plain_query/logic.rb
+- lib/plain_query/version.rb
+- plain_query.gemspec
+homepage: https://github.com/gl-pv/plain_query
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gl-pv/plain_query
+  source_code_uri: https://github.com/gl-pv/plain_query
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key: 
+specification_version: 4
+summary: Builds query object by declaration sequence of query building steps
+test_files: []