qo 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: e9388601df794f4debc0449dad3374eb90247f92
4
+ data.tar.gz: 3ecd58e702bad3521796dbc945fbd9900997a2c1
5
+ SHA512:
6
+ metadata.gz: 95e58e25e8ff762010714537a6be43a545ac2d98887a669d4cf5ee665996a0d08ff982d57894a9e3f1d9dda05bec4046a6e16b949d5a8d642f9db574e14c205e
7
+ data.tar.gz: f74cebc9d05612b384080aea19e84e1d3713ed2162734dcb6b875078d57d0058e16a280e5fa35d4a9f1e4ba67438cde13093eae5064d03c9da45e39d92c56b72
@@ -0,0 +1,12 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+
11
+ # rspec failure tracking
12
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.3
5
+ before_install: gem install bundler -v 1.15.4
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at keystonelemur@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [http://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: http://contributor-covenant.org
74
+ [version]: http://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,5 @@
1
+ source "https://rubygems.org"
2
+
3
+ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
4
+
5
+ gemspec
@@ -0,0 +1,14 @@
1
+ guard :rspec, cmd: "bundle exec rspec" do
2
+ require "guard/rspec/dsl"
3
+ dsl = Guard::RSpec::Dsl.new(self)
4
+
5
+ # RSpec files
6
+ rspec = dsl.rspec
7
+ watch(rspec.spec_helper) { rspec.spec_dir }
8
+ watch(rspec.spec_support) { rspec.spec_dir }
9
+ watch(rspec.spec_files)
10
+
11
+ # Ruby files
12
+ ruby = dsl.ruby
13
+ dsl.watch_spec_files_for(ruby.lib_files)
14
+ end
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Brandon Weaver
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,136 @@
1
+ # Qo
2
+
3
+ Short for Query Object, my play at Ruby pattern matching and fluent querying
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'qo'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ $ bundle
16
+
17
+ Or install it yourself as:
18
+
19
+ $ gem install qo
20
+
21
+ ## How does it work?
22
+
23
+ Triple equals black magic, mostly.
24
+
25
+ Want to understand more of how that works? Check out this post: https://medium.com/rubyinside/triple-equals-black-magic-d934936a6379
26
+
27
+ 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
28
+
29
+ Fast forward a few months and I kind of wanted to make it real, so here it is. Introducing Qo!
30
+
31
+ ## Usage
32
+
33
+ Qo supports three main types of queries: `and`, `or`, and `not`.
34
+
35
+ Most examples are written in terms of `and` and its alias `[]`. `[]` is mostly used for portable syntax:
36
+
37
+ ```ruby
38
+ Qo[/Rob/, 22]
39
+
40
+ # ...is functionally the same as:
41
+ Qo.and(/Rob/, 22)
42
+ ```
43
+
44
+ ### Qo'isms
45
+
46
+ Qo has a few Qo'isms, mainly based around triple equals in Ruby. See the above articles for tutorials on that count.
47
+
48
+ It also has a wildcard, `:*`, which will match any value:
49
+
50
+ ```ruby
51
+ Qo[/Rob/, :*] === ['Robert', 22] # true
52
+ ```
53
+
54
+ As it responds to triple equals, that also means it can be used with `case` statements in a play at pattern matching:
55
+
56
+ ```ruby
57
+ case ['Robert', 22]
58
+ when Qo[:*, 10..19] then 'teenager'
59
+ when Qo[:*. 20..99] then 'adult'
60
+ else 'who knows'
61
+ end
62
+ ```
63
+
64
+ Though chances are you don't have tuple-like code, you have objects. How about we play with those:
65
+
66
+ ```ruby
67
+ # Person has a name and an age attr
68
+
69
+ case robert
70
+ when Qo[age: 10..19] then 'teenager'
71
+ when Qo[age: 20..99] then 'adult'
72
+ else 'objection!'
73
+ end
74
+ ```
75
+
76
+ ### Arrays
77
+
78
+ As Qo returns an Object that responds to `to_proc` it can be used with several Enumerable methods:
79
+
80
+ ```ruby
81
+ people = [
82
+ ['Robert', 22],
83
+ ['Roberta', 22],
84
+ ['Foo', 42],
85
+ ['Bar', 18]
86
+ ]
87
+
88
+ people.select(&Qo[:*, 15..25]) # => [["Robert", 22], ["Roberta", 22], ["Bar", 18]]
89
+ ```
90
+
91
+ ### Hashes and Objects
92
+
93
+ If you have a lot of JSON or Objects, good news! Qo has tricks:
94
+
95
+ ```ruby
96
+ people = [
97
+ Person.new('Robert', 22),
98
+ Person.new('Roberta', 22),
99
+ Person.new('Foo', 42),
100
+ Person.new('Bar', 17),
101
+ ]
102
+
103
+ people.select(&Qo[name: /Rob/]) # => [Person('Robert', 22), Person('Roberta', 22)]
104
+ ```
105
+
106
+ Qo tries to be clever though, it assumes Symbol keys first and then String keys:
107
+
108
+ ```ruby
109
+ require 'json'
110
+ require 'net/http'
111
+ posts = JSON.parse(
112
+ Net::HTTP.get(URI("https://jsonplaceholder.typicode.com/posts")),symbolize_names: true
113
+ )
114
+
115
+ posts.select(&Qo[userId: 1])
116
+ ```
117
+
118
+ Nifty!
119
+
120
+ ## Development
121
+
122
+ 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.
123
+
124
+ 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).
125
+
126
+ ## Contributing
127
+
128
+ 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.
129
+
130
+ ## License
131
+
132
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
133
+
134
+ ## Code of Conduct
135
+
136
+ 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).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "qo"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,22 @@
1
+ require "qo/version"
2
+ require 'qo/matcher'
3
+
4
+ module Qo
5
+ WILDCARD_MATCH = :*
6
+
7
+ def self.and(*array_matchers, **keyword_matchers)
8
+ Qo::Matcher.new('and', *array_matchers, **keyword_matchers)
9
+ end
10
+
11
+ def self.[](*array_matchers, **keyword_matchers)
12
+ Qo::Matcher.new('and', *array_matchers, **keyword_matchers)
13
+ end
14
+
15
+ def self.or(*array_matchers, **keyword_matchers)
16
+ Qo::Matcher.new('or', *array_matchers, **keyword_matchers)
17
+ end
18
+
19
+ def self.not(*array_matchers, **keyword_matchers)
20
+ Qo::Matcher.new('not', *array_matchers, **keyword_matchers)
21
+ end
22
+ end
@@ -0,0 +1,73 @@
1
+ module Qo
2
+ class Matcher
3
+ def initialize(type, *array_matchers, **keyword_matchers)
4
+ @match_method = get_match_method(type)
5
+ @array_matchers = array_matchers
6
+ @keyword_matchers = keyword_matchers
7
+ end
8
+
9
+ def to_proc
10
+ @array_matchers.empty? ?
11
+ match_against_hash(@keyword_matchers) :
12
+ match_against_array(@array_matchers)
13
+ end
14
+
15
+ def call(other)
16
+ self.to_proc.call(other)
17
+ end
18
+
19
+ alias_method :===, :call
20
+ alias_method :[], :call
21
+
22
+ private def match_against_array(matchers)
23
+ -> other_object {
24
+ other_object.is_a?(::Array) ?
25
+ matchers.each_with_index.public_send(@match_method, &array_matches_array_fn(other_object)) :
26
+ matchers.public_send(@match_method, &array_matches_object_fn(other_object))
27
+ }
28
+ end
29
+
30
+ private def match_against_hash(matchers)
31
+ -> other_object {
32
+ other_object.is_a?(::Hash) ?
33
+ matchers.public_send(@match_method, &hash_matches_hash_fn(other_object)) :
34
+ matchers.public_send(@match_method, &hash_matches_object_fn(other_object))
35
+ }
36
+ end
37
+
38
+ private def get_match_method(name)
39
+ case name
40
+ when 'and' then :all?
41
+ when 'or' then :any?
42
+ when 'not' then :none?
43
+ else :all?
44
+ end
45
+ end
46
+
47
+ private def array_matches_array_fn(other_object)
48
+ -> matcher, i {
49
+ matcher == WILDCARD_MATCH || matcher === other_object[i]
50
+ }
51
+ end
52
+
53
+ private def array_matches_object_fn(other_object)
54
+ -> matcher {
55
+ matcher == WILDCARD_MATCH || other_object.public_send(matcher)
56
+ }
57
+ end
58
+
59
+ private def hash_matches_hash_fn(other_object)
60
+ -> match_key, match_value {
61
+ match_value == WILDCARD_MATCH ||
62
+ match_value === other_object[match_key] ||
63
+ match_value === other_object[match_key.to_s]
64
+ }
65
+ end
66
+
67
+ private def hash_matches_object_fn(other_object)
68
+ -> match_key, match_value {
69
+ match_value == WILDCARD_MATCH || match_value === other_object.public_send(match_key)
70
+ }
71
+ end
72
+ end
73
+ end
@@ -0,0 +1,3 @@
1
+ module Qo
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,28 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path("../lib", __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require "qo/version"
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "qo"
8
+ spec.version = Qo::VERSION
9
+ spec.authors = ["Brandon Weaver"]
10
+ spec.email = ["keystonelemur@gmail.com"]
11
+
12
+ spec.summary = %q{Qo is a querying library for Ruby pattern matching}
13
+ spec.homepage = "https://www.github.com/baweaver/q"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject do |f|
17
+ f.match(%r{^(test|spec|features)/})
18
+ end
19
+ spec.bindir = "exe"
20
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
21
+ spec.require_paths = ["lib"]
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.15"
24
+ spec.add_development_dependency "rake", "~> 10.0"
25
+ spec.add_development_dependency "rspec", "~> 3.0"
26
+ spec.add_development_dependency "guard"
27
+ spec.add_development_dependency "guard-rspec"
28
+ end
metadata ADDED
@@ -0,0 +1,129 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: qo
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Brandon Weaver
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-04-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.15'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.15'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: guard
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :development
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: guard-rspec
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :development
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ description:
84
+ email:
85
+ - keystonelemur@gmail.com
86
+ executables: []
87
+ extensions: []
88
+ extra_rdoc_files: []
89
+ files:
90
+ - ".gitignore"
91
+ - ".rspec"
92
+ - ".travis.yml"
93
+ - CODE_OF_CONDUCT.md
94
+ - Gemfile
95
+ - Guardfile
96
+ - LICENSE.txt
97
+ - README.md
98
+ - Rakefile
99
+ - bin/console
100
+ - bin/setup
101
+ - lib/qo.rb
102
+ - lib/qo/matcher.rb
103
+ - lib/qo/version.rb
104
+ - qo.gemspec
105
+ homepage: https://www.github.com/baweaver/q
106
+ licenses:
107
+ - MIT
108
+ metadata: {}
109
+ post_install_message:
110
+ rdoc_options: []
111
+ require_paths:
112
+ - lib
113
+ required_ruby_version: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - ">="
116
+ - !ruby/object:Gem::Version
117
+ version: '0'
118
+ required_rubygems_version: !ruby/object:Gem::Requirement
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: '0'
123
+ requirements: []
124
+ rubyforge_project:
125
+ rubygems_version: 2.5.2
126
+ signing_key:
127
+ specification_version: 4
128
+ summary: Qo is a querying library for Ruby pattern matching
129
+ test_files: []