qo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9388601df794f4debc0449dad3374eb90247f92
+  data.tar.gz: 3ecd58e702bad3521796dbc945fbd9900997a2c1
+SHA512:
+  metadata.gz: 95e58e25e8ff762010714537a6be43a545ac2d98887a669d4cf5ee665996a0d08ff982d57894a9e3f1d9dda05bec4046a6e16b949d5a8d642f9db574e14c205e
+  data.tar.gz: f74cebc9d05612b384080aea19e84e1d3713ed2162734dcb6b875078d57d0058e16a280e5fa35d4a9f1e4ba67438cde13093eae5064d03c9da45e39d92c56b72

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.4

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 keystonelemur@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,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Guardfile

@@ -0,0 +1,14 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Brandon Weaver
+
+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,136 @@
+# Qo
+
+Short for Query Object, my play at Ruby pattern matching and fluent querying
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qo
+
+## How does it work?
+
+Triple equals black magic, mostly.
+
+Want to understand more of how that works? Check out this post: https://medium.com/rubyinside/triple-equals-black-magic-d934936a6379
+
+The original inspiration was from a chat I'd had with a few other Rubyists about pattern matching, which led to this experiment: https://gist.github.com/baweaver/611389c41c9005d025fb8e55448bf5f5
+
+Fast forward a few months and I kind of wanted to make it real, so here it is. Introducing Qo!
+
+## Usage
+
+Qo supports three main types of queries: `and`, `or`, and `not`.
+
+Most examples are written in terms of `and` and its alias `[]`. `[]` is mostly used for portable syntax:
+
+```ruby
+Qo[/Rob/, 22]
+
+# ...is functionally the same as:
+Qo.and(/Rob/, 22)
+```
+
+### Qo'isms
+
+Qo has a few Qo'isms, mainly based around triple equals in Ruby. See the above articles for tutorials on that count.
+
+It also has a wildcard, `:*`, which will match any value:
+
+```ruby
+Qo[/Rob/, :*] === ['Robert', 22] # true
+```
+
+As it responds to triple equals, that also means it can be used with `case` statements in a play at pattern matching:
+
+```ruby
+case ['Robert', 22]
+when Qo[:*, 10..19] then 'teenager'
+when Qo[:*. 20..99] then 'adult'
+else 'who knows'
+end
+```
+
+Though chances are you don't have tuple-like code, you have objects. How about we play with those:
+
+```ruby
+# Person has a name and an age attr
+
+case robert
+when Qo[age: 10..19] then 'teenager'
+when Qo[age: 20..99] then 'adult'
+else 'objection!'
+end
+```
+
+### Arrays
+
+As Qo returns an Object that responds to `to_proc` it can be used with several Enumerable methods:
+
+```ruby
+people = [
+  ['Robert', 22],
+  ['Roberta', 22],
+  ['Foo', 42],
+  ['Bar', 18]
+]
+
+people.select(&Qo[:*, 15..25]) # => [["Robert", 22], ["Roberta", 22], ["Bar", 18]]
+```
+
+### Hashes and Objects
+
+If you have a lot of JSON or Objects, good news! Qo has tricks:
+
+```ruby
+people = [
+  Person.new('Robert', 22),
+  Person.new('Roberta', 22),
+  Person.new('Foo', 42),
+  Person.new('Bar', 17),
+]
+
+people.select(&Qo[name: /Rob/]) # => [Person('Robert', 22), Person('Roberta', 22)]
+```
+
+Qo tries to be clever though, it assumes Symbol keys first and then String keys:
+
+```ruby
+require 'json'
+require 'net/http'
+posts = JSON.parse(
+  Net::HTTP.get(URI("https://jsonplaceholder.typicode.com/posts")),symbolize_names: true
+)
+
+posts.select(&Qo[userId: 1])
+```
+
+Nifty!
+
+## 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/baweaver/qo. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Qo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/baweaver/qo/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 "qo"
+
+# 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/qo.rb

@@ -0,0 +1,22 @@
+require "qo/version"
+require 'qo/matcher'
+
+module Qo
+  WILDCARD_MATCH = :*
+
+  def self.and(*array_matchers, **keyword_matchers)
+    Qo::Matcher.new('and', *array_matchers, **keyword_matchers)
+  end
+
+  def self.[](*array_matchers, **keyword_matchers)
+    Qo::Matcher.new('and', *array_matchers, **keyword_matchers)
+  end
+
+  def self.or(*array_matchers, **keyword_matchers)
+    Qo::Matcher.new('or', *array_matchers, **keyword_matchers)
+  end
+
+  def self.not(*array_matchers, **keyword_matchers)
+    Qo::Matcher.new('not', *array_matchers, **keyword_matchers)
+  end
+end

data/lib/qo/matcher.rb

@@ -0,0 +1,73 @@
+module Qo
+  class Matcher
+    def initialize(type, *array_matchers, **keyword_matchers)
+      @match_method     = get_match_method(type)
+      @array_matchers   = array_matchers
+      @keyword_matchers = keyword_matchers
+    end
+
+    def to_proc
+      @array_matchers.empty? ?
+        match_against_hash(@keyword_matchers) :
+        match_against_array(@array_matchers)
+    end
+
+    def call(other)
+      self.to_proc.call(other)
+    end
+
+    alias_method :===, :call
+    alias_method :[],  :call
+
+    private def match_against_array(matchers)
+      -> other_object {
+        other_object.is_a?(::Array) ?
+          matchers.each_with_index.public_send(@match_method, &array_matches_array_fn(other_object)) :
+          matchers.public_send(@match_method, &array_matches_object_fn(other_object))
+      }
+    end
+
+    private def match_against_hash(matchers)
+      -> other_object {
+        other_object.is_a?(::Hash) ?
+          matchers.public_send(@match_method, &hash_matches_hash_fn(other_object)) :
+          matchers.public_send(@match_method, &hash_matches_object_fn(other_object))
+      }
+    end
+
+    private def get_match_method(name)
+      case name
+      when 'and' then :all?
+      when 'or'  then :any?
+      when 'not' then :none?
+      else :all?
+      end
+    end
+
+    private def array_matches_array_fn(other_object)
+      -> matcher, i {
+        matcher == WILDCARD_MATCH || matcher === other_object[i]
+      }
+    end
+
+    private def array_matches_object_fn(other_object)
+      -> matcher {
+        matcher == WILDCARD_MATCH || other_object.public_send(matcher)
+      }
+    end
+
+    private def hash_matches_hash_fn(other_object)
+      -> match_key, match_value {
+        match_value == WILDCARD_MATCH ||
+        match_value === other_object[match_key] ||
+        match_value === other_object[match_key.to_s]
+      }
+    end
+
+    private def hash_matches_object_fn(other_object)
+      -> match_key, match_value {
+        match_value == WILDCARD_MATCH || match_value === other_object.public_send(match_key)
+      }
+    end
+  end
+end

data/lib/qo/version.rb

@@ -0,0 +1,3 @@
+module Qo
+  VERSION = "0.1.0"
+end

data/qo.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "qo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "qo"
+  spec.version       = Qo::VERSION
+  spec.authors       = ["Brandon Weaver"]
+  spec.email         = ["keystonelemur@gmail.com"]
+
+  spec.summary       = %q{Qo is a querying library for Ruby pattern matching}
+  spec.homepage      = "https://www.github.com/baweaver/q"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: qo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Weaver
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  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: 
+email:
+- keystonelemur@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/qo.rb
+- lib/qo/matcher.rb
+- lib/qo/version.rb
+- qo.gemspec
+homepage: https://www.github.com/baweaver/q
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Qo is a querying library for Ruby pattern matching
+test_files: []