chewie 0.2.1

data/.ruby-version

@@ -0,0 +1 @@
+2.6.4

data/.travis.yml

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

data/.vscode/settings.json

@@ -0,0 +1 @@
+{}

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 nate@mrjones.io. 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,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in es_builder.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    chewie (0.2.0)
+      activesupport (>= 5.1.6)
+      pry
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    method_source (0.9.2)
+    minitest (5.13.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.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.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    yard (0.9.20)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  chewie!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  yard
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 mrjonesbot
+
+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,394 @@
+# Chewie
+
+A declarative interface for building Elasticsearch queries.
+
+Building valid Elasticsearch queries by hand is difficult, especially as search criteria and logic become more complex.
+
+Chewie aims to reduce the cognitive complexity of building queries, so you can focus on the search experience instead of grappling Elasticsearch syntax.
+
+NOTE: Chewie currently supports Elasticsearch 7.x.
+
+## Contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Filtering by Associations](#filtering-by-associations)
+   * [Format](#format)
+   * [Combine](#combine)
+* [Supported Queries (Documentation)](#supported-queries)
+* [Development](#development)
+* [Contributing](#contributing)
+* [License](#license)
+* [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chewie'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chewie
+
+## Usage
+
+Define a `Chewie` class:
+
+```ruby
+# app/chewies/school_chewie.rb
+
+class SchoolChewie
+	extend Chewie
+	
+	term :name
+	range :age
+	match :description
+	
+	filter_by :governances, with: :terms 
+end
+```
+
+Pass filter parameters to the `#build` method:
+
+```ruby
+# app/**/*.rb
+
+params = {
+	query: "Park School"
+	filters: {
+		age: { 'gte': 20, 'lte': 10 },
+		governances: ['Charter', 'Alop']
+	}
+}
+
+query = params[:query]
+filters = params[:filters]
+
+query = SchoolChewie.build(query: query, filters: filters)
+
+puts query
+# =>
+# {
+# 	query: {
+# 		term: { 
+# 			name: { value: 'Park School' }
+# 		},
+# 		range: { 
+# 			age: { 'gte': 20, 'lte': 10 }
+# 		},
+# 		match: {
+# 			message: { query: 'Park School' }
+# 		},
+# 		bool: {
+# 			filter: {
+# 				terms: {
+# 					governances: [ 'Charter', 'Alop' ]
+# 				}
+# 			}
+# 		}
+# 	}
+# }
+```
+
+Chewie expects incoming parameter attributes to match the attributes defined in your Chewie class, in order to pull the correct value and build the query
+
+```ruby
+# definition
+filter_by :governances, with: :terms
+
+# parameters
+{ governances: ['ALOP'] }
+
+# output
+{ filter: { terms: { governances: ['ALOP'] } }
+```
+
+Some queries simply take a string value, which is pulled from `:query`.
+
+`:query` is typically a user search value (search bar).
+
+```ruby
+# definition
+term :name
+
+# parameters
+{ query: 'A search value' }
+
+# output
+{ query: { term: { name: { value: 'A search value' } } } }
+```
+
+## Filtering by Associations
+
+Depending on how you build your index, some fields might store values from multiple attributes.
+
+A simple case is if you'd like to filter records through an association.
+
+```ruby
+class School
+	has_many :school_disciplines
+	has_many :disciplines, through: :school_disciplines
+end
+
+class Discipline
+	has_many :school_disciplines
+	has_many :schools, through: :school_disciplines
+end
+
+class SchoolDiscipline
+	belongs_to :school
+	belongs_to :discipline
+end
+```
+
+We might imagine a search engine that helps users find schools in their area and allow them to filter schools by various criteria. Some schools might offer discipline specific programs, therefore a school will have many disciplines. Disciplines is a standard collection that schools can associate with in our application.
+
+In our search UI, we might provide a `disciplines` filter and allow users to filter by disciplines via dropdown.
+
+We provide the search UI with `ids` of disciplines we'd like to filter by.
+
+```json
+{
+	filters: {
+		disciplines: [1, 2, 3, 4]
+	}
+}
+```
+
+Our idex consists of school records, therefore we won't have access to every discipline each school is associated to by default.
+
+Instead, we need to define custom index attributes for our school records to capture those relationships.
+
+We can do that by defining model methods on `School` that collects associated id values and returns a collection of strings to be indexed.
+
+```ruby
+class School
+	def disciplines_index
+		discipline_ids = disciplines.pluck(:id)
+		discipline_ids.map do |discipline_id|
+			"discipline_#{discipline_id}"
+		end
+	end
+
+	# Method Elasticsearch can use to populate the index
+	def search_data
+		{
+			name: name,
+			disciplines: disciplines_index
+		}
+	end
+end
+```
+
+When Elasticsearch indexes `School` records, each record will now have knowledge of which disciplines it is associated to.
+
+```json
+	{ 
+		name: 'Park School',
+		disciplines: [
+			"discipline_1",
+			"discipline_2",
+			"discipline_3"
+		]
+	}
+```
+
+### Format
+At this point, our index is ready to return associated `School` records when given a collection of `Discipline` ids. 
+
+The caveat is the stored values of `:disciplines` is in a format that contains both the `School` and `Discipline` id.
+
+We'll need to do a little extra work at search time to ensure our `id` filter values are transformed into the appropriate string format.
+
+To address this, `bool` query methods have a `:format` option that takes a lambda and exposes attribute values given.
+
+```ruby
+class SchoolChewie
+	disciplines_format = lambda do |id|
+		"discipline_#{id}"
+	end
+
+	filter_by :disciplines, with: :terms, format: disciplines_format
+end
+
+params = {
+	query: '',
+	filters: {
+		disciplines: [1, 4]
+	}
+}
+
+result = SchoolChewie.build(query: params[:query], filters: params[:filters])
+
+puts result
+# =>
+# {
+# 	query: { 
+# 		bool: { 
+# 			filter: { 
+# 				terms: { 
+# 					disciplines: [
+# 						"discipline_1",
+# 						"discipline_4",
+# 					]
+# 				}
+# 			}
+# 		}
+# 	}
+# }
+```
+
+Now that our query output for `disciplines` matches values stored in the index, Elasticsearch will find `School` records where `disciplines` match to either `"discipline_1"` or `"discipline_4"`; allowing us to find schools by their associated disciplines.
+
+### Combine
+
+Sometimes there are additional criteria we'd like to leverage when filtering against associated records.
+
+Continuing with the previous example, let's say we want to filter schools by disciplines where the discipline programs are `"active"`.
+
+`"active"` might be a boolean attribute found on `SchoolDiscipline`.
+
+We can re-write our `discipline_index` method to pull the discipline `id` and `active` attributes from `SchoolDiscipline` join records.
+
+```ruby
+class School
+	def disciplines_index
+		school_disciplines.map do |school_discipline|
+			discipline_id = school_discipline.id
+			active = school_discipline.active
+
+			"discipline_#{discipline_id}_active_#{active}"
+		end
+	end
+
+	# Method Elasticsearch can use to populate the index
+	def search_data
+		{
+			name: name,
+			disciplines: disciplines_index
+		}
+	end
+end
+```
+
+Which changes our index to:
+
+```json
+	{ 
+		name: 'Park School',
+		disciplines: [
+			"discipline_1_active_true",
+			"discipline_2_active_false",
+			"discipline_3_active_false"
+		]
+	}
+```
+
+We can now imagine there is a `active` toggle in the search UI, which expands our filter parameters.
+
+```ruby
+params = {
+	query: '',
+	filters: {
+		disciplines: [1, 4],
+		active: true
+	}
+}
+```
+
+Now, at search time we not only need to format with the `disciplines` collection, but combine those values with the `active` attribute.
+
+Let's update our Chewie to take this new criteria into account.
+
+```ruby
+class SchoolChewie
+	disciplines_format = lambda do |id, combine|
+		"discipline_#{id}_active_#{combine.first}"
+	end
+
+	filter_by :disciplines, with: :terms, combine: [:active], format: disciplines_format
+end
+```
+
+`:combine` takes a collection of attribute symbols, which Chewie uses to access and pass parameter values to the format lambda at search time; the value collection is exposed as the second argument in the lambda block.
+
+The order of the values matches the order defined in the method call.
+
+```ruby
+combine: [:active, :governances, :age]
+
+lambda do |id, combine|
+	combine[0] #=> :active value
+	combine[1] #=> :governances value
+	combine[2] #=> :age value
+end
+```
+
+The output becomes:
+
+```ruby
+result = SchoolChewie.build(query: params[:query], filters: params[:filters])
+
+puts result
+# =>
+# {
+# 	query: { 
+# 		bool: { 
+# 			filter: { 
+# 				terms: { 
+# 					disciplines: [
+# 						"discipline_1_active_true",
+# 						"discipline_4_active_true",
+# 					]
+# 				}
+# 			}
+# 		}
+# 	}
+# }
+```
+
+## Supported Queries
+### [Compound Queries](https://www.elastic.co/guide/en/elasticsearch/reference/current/full-text-queries.html)
+#### [Bool](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html)
+
+* filter (#filter_by)
+* should (#should_include)
+* must (#must_include)
+* must_not (#must_not_include)
+
+### [Term Level Queries](https://www.elastic.co/guide/en/elasticsearch/reference/current/term-level-queries.html)
+
+* term (#term)
+* terms (#terms)
+* range (#range)
+* fuzzy (#fuzzy)
+
+### [Full Text Queries](https://www.elastic.co/guide/en/elasticsearch/reference/current/full-text-queries.html)
+
+* match (#match)
+* multi-match (#multimatch)
+
+## 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]/chewie. 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 Chewie project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chewie/blob/master/CODE_OF_CONDUCT.md).