querylicious 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21d7d82f6da9eb9541a9901b483ad8b5c193e4805ec6607ef55b26dd571a917b
-  data.tar.gz: 51b2b9f44728fca929305e0faea38be54f26928756d8619188a2e8b8906458a9
+  metadata.gz: bb0604418d4ceb97ecbd6c97c2d5d9efd074648e736af219c04df3d62f4be27e
+  data.tar.gz: 956827085051782969c6c2ff99b357d4f0f1fca54c49278be68ab764a79f1b93
 SHA512:
-  metadata.gz: f46cab1028daefa95fae51fb2a7333a112a5f3a0fb693ce09c2b84e0565239a0ee33f904838606b1a9a5b9042f18b5d179c5e8cd472b3c2f2e1f4ff486dcf0d9
-  data.tar.gz: e9f815b729a9fb3385ea2a5b9db9e1f4ae3c42c49ea949189d519c107e1ec0acea6c46884a90f99ee93f45eaa165c00f36ae4bfb4e4b4098dcbd058799de3a10
+  metadata.gz: '09eb9973b67758a94c829b5f086914478fc5a7e232bf584a503fc94f0976231a6c3c3f8f8c4437e1e1e01df41e915e229fda49d6a7bb3910112ef06877b7742e'
+  data.tar.gz: 41991c97c9576293f9eddd44fa5a394c7355a7ef29507b79e0f605eef1fb50065e7e8386068214ee78323a1edda671dd7e83a3f72aeb798f07c9b1d6c3f62cd2

data/.editorconfig

@@ -0,0 +1,17 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+# Markdown uses trailing whitespace for linebreaks.
+[*.md]
+trim_trailing_whitespace = false

data/.mdlrc

@@ -0,0 +1 @@
+rules "~MD024"

data/.rubocop.yml

@@ -5,6 +5,9 @@ AllCops:
 Style/Alias:
   # Prefer `alias_method :foo, :bar` over `alias foo bar`
   EnforcedStyle: prefer_alias_method
+Style/DateTime:
+  Enabled: false
 Metrics/BlockLength:
   Exclude:
+    - querylicious.gemspec
     - spec/**/*_spec.rb

data/.travis.yml

@@ -0,0 +1,21 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/926fc6501337bfca8303
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: never     # options: [always|never|change] default: always

data/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
@@ -6,34 +7,57 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.3.2] - 2018-04-13
+
+## Changed
+
+- Moved repository to [huyderman/querylicious][github-repo] and added branding
+
+## Fixed
+
+- Ensure `QueryReducer#to_proc` returns a proper proc
+
 ## [0.3.1] - 2018-02-19
 
 ## Changed
+
 - Update allowed versions of `dry-matcher` gem
 
 ## [0.3.0] - 2017-11-28
+
 ### Added
+
 - Add `not_key` reducer alias
 
 ### Changed
+
 - Updated required dependency versions
 
 ## [0.2.0] - 2017-08-15
+
 ### Added
+
 - Add support for lists (arrays)
 
 ### Changed
+
 - Change `type` in the reducer matchers from classes to dry-types
 
 ### Fixed
+
 - Support empty queries
 
 ## [0.1.0] - 2017-08-14
+
 ### Added
+
 - Initial implementation of querylicious, with query-parser and query-reducer
 
-[Unreleased]: https://github.com/Sonans/querylicious/compare/v0.3.1...HEAD
-[0.3.1]: https://github.com/Sonans/querylicious/compare/v0.3.0...v0.3.1
-[0.3.0]: https://github.com/Sonans/querylicious/compare/v0.2.0...v0.3.0
-[0.2.0]: https://github.com/Sonans/querylicious/compare/v0.1.0...v0.2.0
-[0.1.0]: https://github.com/Sonans/querylicious/compare/v0.0.0...v0.1.0
+[github-repo]: https://github.com/huyderman/querylicious
+
+[Unreleased]: https://github.com/huyderman/querylicious/compare/v0.3.2...HEAD
+[0.3.2]: https://github.com/huyderman/querylicious/compare/v0.3.1...v0.3.2
+[0.3.1]: https://github.com/huyderman/querylicious/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/huyderman/querylicious/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/huyderman/querylicious/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/huyderman/querylicious/compare/v0.0.0...v0.1.0

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ 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 jo-herman@sonans.no. All
+reported by contacting the project team at johannes@huyderman.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.

data/README.md

@@ -1,6 +1,13 @@
-# Querylicious
+# ![Querylicious](https://res.cloudinary.com/huyderman/image/upload/c_scale,dpr_2,f_auto,fl_preserve_transparency,q_auto,w_888/v1522834080/querylicious)
 
-Querylicious is an opinionated search query parser.
+[![Gem Version](https://badge.fury.io/rb/querylicious.svg)](https://badge.fury.io/rb/querylicious)
+[![Build Status](https://travis-ci.org/huyderman/querylicious.svg?branch=master)](https://travis-ci.org/huyderman/querylicious)
+[![Maintainability](https://api.codeclimate.com/v1/badges/6eeb81253ec37a703d9f/maintainability)](https://codeclimate.com/github/huyderman/querylicious/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/6eeb81253ec37a703d9f/test_coverage)](https://codeclimate.com/github/huyderman/querylicious/test_coverage)
+[![Join the chat at https://gitter.im/querylicious/Lobby](https://badges.gitter.im/querylicious/Lobby.svg)](https://gitter.im/querylicious/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+> Querylicious is an opinionated and repository agnostic search query parser
+> and reducer.
 
 ## Installation
 
@@ -12,30 +19,143 @@ gem 'querylicious'
 
 And then execute:
 
-    $ bundle
+    bundle
 
-Or install it yourself as:
+Or install it yourself with:
 
-    $ gem install querylicious
+    gem install querylicious
 
 ## Usage
 
-TODO: Write usage instructions here
+Querylicious parses [GitHub-style search queries][github-search-syntax], and
+let's you specify an reducer to generate the result. The reducer is a
+callable object such as an proc. Here is an simple example where the
+repository is an array of strings:
+
+```rb
+repository = %w[Garnet Amethyst Pearl Steven]
+
+reducer = lambda do |array, m|
+  m.phrase do |phrase|
+    array.select { |item| item.upcase.include?(phrase.upcase) }
+  end
+
+  m.not_phrase do |phrase|
+    array.reject { |item| item.upcase.include?(phrase.upcase) }
+  end
+
+  m.default { arr }
+end
+
+query_reducer = Querylicious::QueryReducer.new(reducer)
+
+query_reducer.call(repository, 'am')         #=> ["Amethyst"]
+query_reducer.call(repository, 'NOT Steven') #=> ["Garnet", "Amethyst", "Pearl"]
+```
+
+`phrase` is the basic search type intended for free text search or similar.
+But querylicious also supports defining property search with many possible
+modifiers.
+
+```rb
+# The query "stars:n" searches for when `stars` is the value n
+m.key 'stars' do |array, stars|
+  # ...
+end
+
+# You can use `dry-types` type-definitions if you wish to handle different
+# types differently. The parser can return the following types:
+# `[String, Integer, Date, DateTime, Range]`
+
+# The query "stars:1" searches for when `stars` is an integer `1`
+m.key 'stars', type: Querylicious::Types::Integer do |array, stars|
+  # ...
+end
+
+# The query "stars:1..10" searches for when `stars` is a range `1..10`
+m.key 'stars', type: Querylicious::Types::Range do |array, stars|
+  # ...
+end
+
+# Properties also support operators different from the default equals;
+# possilble operators are: `%i[eql not_eql gt gteq lt lteq]`
+
+# The query "stars:>1" searches for when `stars` is greater than `1`
+m.key 'stars', op: :gt do |array, stars|
+  # ...
+end
+```
+
+You can use any type of backing repository, as long as it's reducable. Here
+is an example using Sequel:
+
+```rb
+class Article < Sequel::Model; end
+
+reducer = lambda do |dataset, m|
+  m.phrase do |phrase|
+    dataset.grep(%i[name body], "%#{phrase}%", case_insensitive: true)
+  end
+
+  m.key :published do |published|
+    dataset.where(published: published)
+  end
+
+  m.default { dataset }
+end
+
+query_reducer = Querylicious::QueryReducer.new(reducer)
+
+articles = query_reducer.call(Article, 'foo published:true').all
+```
+
+You can curry the call to the query reducer to avoid passing the repository
+each time:
+
+```rb
+
+article_search = query_reducer.curry.call(Article)
+
+articles = article_search.call('foo published:true').all
+```
 
 ## 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.
+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 the `VERSION` file, 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in the `VERSION` file,
+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/Sonans/querylicious. 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.
+Bug reports and pull requests are welcome on GitHub at
+[huyderman/querylicious](https://github.com/huyderman/querylicious). This
+project is intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[code of conduct][code-of-conduct].
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Querylicious project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/querylicious/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Querylicious project’s codebases, issue
+trackers, chat rooms and mailing lists is expected to follow the
+[code of conduct][code-of-conduct].
+
+## Credits
+
+Thanks to the talented Alex Daily
+([@Daily@tootplanet.space](https://tootplanet.space/@Daily) or
+[@heyalexdaily@twitter.com](https://twitter.com/heyalexdaily)) for creating
+the awesome logo!
+
+[github-search-syntax]: https://help.github.com/articles/understanding-the-search-syntax/
+[code-of-conduct]: https://github.com/huyderman/querylicious/blob/master/CODE_OF_CONDUCT.md

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/querylicious/parser.rb

@@ -11,7 +11,8 @@ module Querylicious
 
     rule(:phrase) do
       (
-        (str('NOT').as(:symbol).as(:op) >> space).maybe >> (word | quoted_string)
+        (str('NOT').as(:symbol).as(:op) >> space)
+          .maybe >> (word | quoted_string)
       ).as(:phrase)
     end
 
@@ -22,7 +23,10 @@ module Querylicious
 
     rule(:key) { word }
     rule(:value) do
-      list | range | (kv_op.as(:op).maybe >> (datetime | integer | simple_string | quoted_string))
+      list | range | (
+        kv_op.as(:op)
+          .maybe >> (datetime | integer | simple_string | quoted_string)
+      )
     end
 
     rule(:kv_op) { (str('>=') | str('>') | str('<=') | str('<')).as(:symbol) }
@@ -32,7 +36,8 @@ module Querylicious
       match('[[:graph:]&&[^".,]]').repeat(1).as(:string)
     end
     rule(:quoted_string) do
-      str('"') >> (str('\"') | match('[[^"]&&[:print:]]')).repeat(0).as(:string) >> str('"')
+      str('"') >> (str('\"') |
+        match('[[^"]&&[:print:]]')).repeat(0).as(:string) >> str('"')
     end
     rule(:integer) { match('\d').repeat(1).as(:integer) }
 

data/lib/querylicious/query_reducer.rb

@@ -8,7 +8,7 @@ require 'querylicious/matcher'
 require 'dry-initializer'
 
 module Querylicious
-  # Reducer
+  # Query Reducer for processing parsed query
   class QueryReducer
     extend Dry::Initializer
 
@@ -29,7 +29,7 @@ module Querylicious
     end
 
     def to_proc
-      method(:call)
+      public_method(:call).to_proc
     end
 
     private
@@ -43,7 +43,7 @@ module Querylicious
     end
 
     def parse_query(query)
-      Array(transformer.apply(parser.parse(query.to_s.strip)))
+      Array(transformer.apply(parser.parse(query.to_s)))
     end
   end
 end

data/lib/querylicious/transform.rb

@@ -29,7 +29,7 @@ module Querylicious
       end
     end
 
-    rule( list: sequence(:it)) { Types::Form::Array[it] }
+    rule(list: sequence(:it)) { Types::Form::Array[it] }
 
     rule(range: { start: simple(:first), end: simple(:last) }) do
       if first == :* && last == :*
@@ -67,9 +67,9 @@ module Querylicious
     rule(pair: { key: simple(:key), value: sequence(:value) }) do
       KeyValuePair.new(key: key, value: value)
     end
-    rule(pair: { key: simple(:key), value: sequence(:value), op: simple(:op) }) do
-      KeyValuePair.new(key: key, value: value, op: op)
-    end
+    rule(
+      pair: { key: simple(:key), value: sequence(:value), op: simple(:op) }
+    ) { KeyValuePair.new(key: key, value: value, op: op) }
 
     rule(op: simple(:op), string: simple(:it)) do
       { object: Types::Coercible::String[it], op: op }

data/querylicious.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |spec|
   spec.name          = 'querylicious'
   spec.version       = version.split('+').first
   spec.authors       = ['Jo-Herman Haugholt']
-  spec.email         = ['jo-herman@sonans.no']
+  spec.email         = ['johannes@huyderman.com']
 
   spec.summary       = 'An opinionated search query parser'
-  spec.homepage      = 'https://github.com/Sonans/querylicious'
+  spec.homepage      = 'https://github.com/huyderman/querylicious'
   spec.license       = 'MIT'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
@@ -27,11 +27,13 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'parslet', '~> 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'pry', '~> 0.11.0'
+  spec.add_development_dependency 'mutant', '~> 0.8.0'
+  spec.add_development_dependency 'mutant-rspec', '~> 0.8.0'
+  spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'reek', '~> 4.7'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec-parameterized', '~> 0.4.0'
-  spec.add_development_dependency 'rubocop', '~> 0.52.0'
-  spec.add_development_dependency 'simplecov', '~> 0.15.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: querylicious
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Jo-Herman Haugholt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-19 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-initializer
@@ -100,20 +100,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: mutant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: mutant-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -176,38 +204,41 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: '0.52'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: '0.16'
 description: 
 email:
-- jo-herman@sonans.no
+- johannes@huyderman.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
+- ".mdlrc"
 - ".reek"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -225,7 +256,7 @@ files:
 - lib/querylicious/transform.rb
 - lib/querylicious/types.rb
 - querylicious.gemspec
-homepage: https://github.com/Sonans/querylicious
+homepage: https://github.com/huyderman/querylicious
 licenses:
 - MIT
 metadata: {}