querii 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 446635ffc0f477018660c9586b56705a49e3b899
+  data.tar.gz: 5fb91f4beedc05e8d1e31f357548ce22a6f73a62
+SHA512:
+  metadata.gz: 6c0b430fb59333ddff6abc66cb01fc48be087b66db5f97151851bab6750053ba60d3d3a58113e110ba23fe7171685b502ff2768f79abc4512519aecc5f9d92a8
+  data.tar.gz: 49a835f5f301a63c8db269e5f8f80bccad9b783c14b10be88f89b0662333fa8d11b680c6c2a37d16e292137613ccec268f668541d13bfd5aea6e9de7d418154e

data/README.md

@@ -0,0 +1,44 @@
+# Querii Object Gem
+
+![Searching records](http://i.imgur.com/pa0oxih.jpg)
+
+Querii makes it easy to create query objects that return active record relations
+
+## Why?
+
+Querii allows you to extract complicated query collection logic out of a ActiveRecord model to prevent littering the base model and encourage breaking up your query logic into multiple methods, constants, etc, while still returning a standard activerecord collection (now extended by your additional querii methods) that can be further acted upon.
+
+## Basic Usage
+
+```ruby
+module Accounts
+  module FancySubset
+    include Querii::QueryObject
+
+    module Scopes
+      def applied(*args, **key_args)
+        where(cool: 'things', many: key_args.fetch(:hats, 2))
+      end
+    end
+  end
+end
+
+# basic call
+Accounts::FancySubset.call # or .all
+
+# or more advanced chain
+Accounts::FancySubset.call(hats: 4).where(typical: 'filtered')
+# ...Account::ActiveRecord_Relation < ActiveRecord::Relation
+```
+
+Querii infers the base collection from the top level query object namespace of `Accounts` -> `Account.all`, you can override this by setting `self.default_relation = 'ClassName'` within your module. Querii defines a default `Scopes` module that will just return all but to do anything useful by default you will need to define your own `Scopes` module. During a query this module is extended onto the base `ActiveRecord::Relation` and the `applied` method is executed returning an active record collection that can further be queried by both any additional methods defined within your Querii object `Scopes` and scopes or conditions on the standard AR class.
+
+## More
+
+### Default scope
+
+The `applied` method is entirely optional and designed for query objects that only contain a single base scope always intended to be called so you can simply do `MyQueryObj.call` or equivalently `MyQueryObj.all`. Additionally the applied method can accept and use any number of args or keyword args.
+
+### Passing an already filtered relation
+
+`Account::FancySubset.call(relation: Account.joins(:whatever).such_scope)` will work out just fine.

data/lib/querii/query_object.rb

@@ -0,0 +1,40 @@
+module Querii
+  module QueryObject
+    def self.included(base)
+      base.extend ClassMethods
+
+      base.class_eval do
+        # dynamically defines a base Scopes module
+        self.const_set(
+          :Scopes,
+          Module.new do
+            def applied(*args, **key_args)
+              all
+            end
+          end
+        )
+      end
+    end
+
+    module ClassMethods
+      def call(*args, relation: default_relation_all, **key_args)
+        relation.extending(self::Scopes).applied(args, key_args)
+      end
+
+      def default_relation_all
+        # .all returns current scope || all
+        relation_base.all
+      end
+
+      # queries are namespaced by plural model name
+      # from which we can infer query base model
+      def relation_base
+        default_relation.to_s.constantize || self.to_s.split('::').first.singularize.constantize
+      end
+
+      alias_method :all, :call
+
+      attr_accessor :default_relation
+    end
+  end
+end

data/lib/querii.rb

@@ -0,0 +1,4 @@
+require 'querii/query_object'
+
+module Querii
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: querii
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Justin
+- Doody
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easily extract complicated query objects into simple query object services.
+email:
+- justin@20dots.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/querii.rb
+- lib/querii/query_object.rb
+homepage: https://github.com/justindoody/querii
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.7
+signing_key: 
+specification_version: 4
+summary: AR Query objects patterns
+test_files: []