query_helper 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9748c7b95202e187a62f4e889db450dbd6a406aac6f342d6fb0ae5f532e77f98
+  data.tar.gz: bc3f05f3093a0730758d05d7fab7485960b4d0dfbd489982e3dbbe996f51fb15
+SHA512:
+  metadata.gz: 833e99acbbac34e55b2c99c03977c707792c1e1ed1b86d65a347d2184c01f96894cc5e41c40dab0e81f4b7463511ab63cd1ade1d9f7b36a6b689a9bfcece5df7
+  data.tar.gz: 73ccb427fc984585951c099fd311ebe5f83ff20d927f6e196b69e0d5f899b7e55e42a027de87424c3e986b94e767aa3faceab106f8aacd07cae1341f6b78c79e

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

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 eamigo13@gmail.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_helper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,112 @@
+PATH
+  remote: .
+  specs:
+    query_helper (0.0.0)
+      activerecord (~> 5.0)
+      activesupport (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    faker (1.9.3)
+      i18n (>= 0.7)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  activesupport
+  bundler (~> 1.16)
+  byebug
+  faker (~> 1.9.3)
+  query_helper!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rails
+  sqlite3 (~> 1.3.6)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Evan McDaniel
+
+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,381 @@
+# QueryHelper
+[![TravisCI](https://travis-ci.org/iserve-products/query_helper.svg?branch=master)](https://travis-ci.org/iserve-products/query_helper)
+[![Gem Version](https://badge.fury.io/rb/query_helper.svg)](https://badge.fury.io/rb/query_helper)
+
+Ruby Gem developed and used at Pattern to paginate, sort, filter, and include associations on sql and active record queries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'query_helper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install query_helper
+
+## Use
+
+### SQL Queries
+
+#### Initialize
+
+To create a new sql query object run
+
+```ruby
+QueryHelper::Sql.new(
+  model:,             # required
+  query:,             # required
+  query_params: ,     # optional
+  column_mappings: ,  # optional
+  filters: ,          # optional
+  sorts: ,            # optional
+  page: ,             # optional
+  per_page: ,         # optional
+  single_record: ,    # optional, default: false
+  associations: ,     # optional
+  as_json_options: ,  # optional
+  run:                # optional, default: true
+)
+```
+
+The following arguments are accepted when creating a new objects
+
+<table>
+<tr>
+<th>Argument</th>
+<th>Description</th>
+<th>Example</th>
+</tr>
+<tr>
+<td>model</td>
+<td>the model to run the query against</td>
+<td>
+<pre lang="ruby">
+Parent
+</pre>
+</td>
+</tr>
+<tr>
+<td>query</td>
+<td>the custom sql string to be executed</td>
+<td>
+<pre lang="ruby">
+'select * from parents'
+</pre>
+</td>
+</tr>
+<tr>
+<td>query_params</td>
+<td>a hash of bind variables to be embedded into the sql query</td>
+<td>
+<pre lang="ruby">
+{
+  age: 20,
+  name: 'John'
+}
+</pre>
+</td>
+</tr>
+<tr>
+<td>column_mappings</td>
+<td>A hash that translates aliases to sql expressions</td>
+<td>
+<pre lang="ruby">
+{
+  "age" => "parents.age"
+  "children_count" => {
+    sql_expression: "count(children.id)",
+    aggregate: true
+  }
+}
+</pre>
+</td>
+</tr>
+<tr>
+<td>filters</td>
+<td>a list of filters in the form of `{"comparate_alias"=>{"operator_code"=>"value"}}`</td>
+<td>
+<pre lang="ruby">
+{
+  "age" => { "lt" => 100 },
+  "children_count" => { "gt" => 0 }
+}
+</pre>
+</td>
+</tr>
+<tr>
+<td>sorts</td>
+<td>a comma separated string with a list of sort values</td>
+<td>
+<pre lang="ruby">
+"age:desc,name:asc:lowercase"
+</pre>
+</td>
+</tr>
+<tr>
+<td>page</td>
+<td>the page you want returned</td>
+<td>
+<pre lang="ruby">
+5
+</pre>
+</td>
+</tr>
+<tr>
+<td>per_page</td>
+<td>the number of results per page</td>
+<td>
+<pre lang="ruby">
+20
+</pre>
+</td>
+</tr>
+<tr>
+<td>single_record</td>
+<td>whether or not you expect the record to return a single result, if toggled, only the first result will be returned</td>
+<td>
+<pre lang="ruby">
+false
+</pre>
+</td>
+</tr>
+<tr>
+<td>associations</td>
+<td>a list of activerecord associations you'd like included in the payload </td>
+<td>
+<pre lang="ruby">
+
+</pre>
+</td>
+</tr>
+<tr>
+<td>as_json_options</td>
+<td>a list of as_json options you'd like run before returning the payload</td>
+<td>
+<pre lang="ruby">
+
+</pre>
+</td>
+</tr>
+<tr>
+<td>run</td>
+<td>whether or not you'd like to run the query on initilization</td>
+<td>
+<pre lang="ruby">
+false
+</pre>
+</td>
+</tr>
+</table>
+
+### Active Record Queries
+
+To run an active record query execute
+```ruby
+QueryHelper.run_active_record_query(active_record_call, query_helpers, valid_columns, single_record)
+```
+active_record_call: Valid active record syntax (i.e. ```Object.where(state: 'Active')```)
+query_helpers: See docs below
+valid_columns: Default is [].  Pass in an array of columns you want to allow sorting and filtering on.
+single_record: Default is false.  Pass in true to format payload as a single object instead of a list of objects
+
+
+model: A valid ActiveRecord model
+query: A string containing your custom SQL query
+query_params: a symbolized hash of binds to be included in your SQL query
+query_helpers: See docs below
+valid_columns: Default is [].  Pass in an array of columns you want to allow sorting and filtering on.
+single_record: Default is false.  Pass in true to format payload as a single object instead of a list of objects
+
+## Query Helpers
+query_helpers is a symbolized hash passed in with information about pagination, associations, filtering and sorting.
+
+### Pagination
+There are two pagination keys you can pass in as part of the query_helpers objects
+
+```ruby
+{
+  page: 1,
+  per_page: 20
+}
+```
+
+If at least one of these keys is present, paginated results will be returned.
+
+### Sorting
+Sorting is controlled by the `sort` key in the query_helpers object
+
+```ruby
+{
+    sort: "column_name:sort_direction"
+}
+```
+Sort direction can be either asc or desc.  If you wish to lowercase string before sorting include the following:
+```ruby
+{
+    sort: "name:desc:lowercase"
+}
+```
+
+### Filtering
+Filtering is controlled by the `filter` object in the query_helpers hash
+
+```ruby
+{
+  filter: {
+    "column_1" => {
+      "gte" => 20,
+      "lt" => 40
+    },
+    "column_2" => {
+      "eql" => "my_string"
+    },
+    "column_3" => {
+      "like" => "my_string%"
+    },
+    "column_4" => {
+      "in" => "item1,item2,item3"
+    }
+}
+```
+
+The following operator codes are valid
+
+```
+“gte”: >=
+“lte”: <=
+“gt”: >
+“lt”: <
+“eql”: =
+“noteql”: !=
+"like": like
+“in”: in
+“notin” not in
+“null”: “is null” or “is not null” (pass in true or false as the value)
+```
+
+### Associations
+
+To include associated objects in the payload, pass in the following as part of the query_helpers hash:
+
+```ruby
+{
+  include: ['associated_object_1', 'associated_object_2']
+}
+```
+
+### Example
+
+The following is an example of a query_helpers object that can be passed into the sql and active record methods
+
+```ruby
+query_helpers = {
+  page: 1,
+  per_page: 20,
+  sort: "name:desc"
+  include: ["child"]
+  filter: {
+    "id" => {
+      "gte" => 20,
+      "lt" => 40
+    }
+}
+```
+
+## Payload Formats
+
+The QueryHelper gem will return results in one of three formats
+
+### Paginated List Payload
+```json
+{
+  "pagination": {
+    "count": 18,
+    "current_page": 1,
+    "next_page": 2,
+    "previous_page": null,
+    "total_pages": 6,
+    "per_page": 3,
+    "first_page": true,
+    "last_page": false,
+    "out_of_range": false
+  },
+  "data": [
+    {
+      "id": 1,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+    {
+      "id": 2,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+    {
+      "id": 3,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+  ]
+}
+```
+
+### List Payload
+```json
+{
+  "data": [
+    {
+      "id": 1,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+    {
+      "id": 2,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+    {
+      "id": 3,
+      "attribute_1": "string_attribute",
+      "attribute_2": 12345,
+      "attribute_3": 0.3423212
+    },
+  ]
+}
+```
+
+### Single Record Payload
+```json
+{
+  "data": {
+    "id": 1,
+    "attribute_1": "string_attribute",
+    "attribute_2": 12345,
+    "attribute_3": 0.3423212
+  }
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/query_helper. 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 QueryHelper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/query_helper/blob/master/CODE_OF_CONDUCT.md).