criterion 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ade5ee002558a00db5f98d1a9e51b05064b62d44
+  data.tar.gz: 3bc4315dc5e20579e89949d5093ac199f41e5abd
+SHA512:
+  metadata.gz: 8b9275a695341df769badc8d29a2ac91c54e3bd776a366c143412854efebee09713ffdd9867dedb287f931aed53ce692800a1dcd64e609d2902a1a577656bdf3
+  data.tar.gz: 3470d335585769075043a947ed574f7e456d4b68a6b301c8401106db1fdd1f086590ba2f6f23279877c578439af4eaa02536ade239c543f4d84af4a40d491d37

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'pry'
+
+# Specify your gem's dependencies in criterion.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,51 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # 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)
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Matthew Solt
+
+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,187 @@
+# Criterion
+
+Criterion is a small, simple library for searching Ruby arrays and collections with a chainable, Active Record style query interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'criterion'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install criterion
+
+## Usage
+
+Consider the following example: 
+
+````ruby 
+require 'hashie'
+require 'criterion'
+
+matt = Hashie::Mash.new(name: 'Matt', age: 30) 
+mark = Hashie::Mash.new(name: 'Mark', age: 45) 
+john = Hashie::Mash.new(name: 'John', age: 50) 
+
+collection = [ matt, mark, john ].extend(Criterion)
+````
+
+By extending the collection with the Criterion module, you can perform chainable queries with #where, #not, #order, #limit, #offset/#skip, and calculations with #sum, #maximum, #minimum, #average.
+
+### Where 
+
+Where is the primary method for searching a Criterion collection. All query values must match in order for a result to be returned. 
+
+Calling any query method without a value will return a Criterion::Criteria: 
+
+````ruby 
+collection.where
+#=> #<Criterion::Criteria...
+````
+
+Searching by exact value: 
+
+````ruby 
+collection.where(name: 'Matt').first
+#=> {"name"=>"Matt", "age"=>30}
+````
+
+Searching by regular expression: 
+
+````ruby 
+collection.where(name: /J/).first
+#=> {"name"=>"John", "age"=>50}
+````
+
+Searching by proc: 
+
+````ruby 
+collection.where(age: ->(age){ age.odd? }).first
+#=> {"name"=>"Mark", "age"=>45}
+````
+
+Searching by class:
+
+````ruby 
+collection.where(age: Integer).all
+#=> [{"name"=>"Matt", "age"=>30}, {"name"=>"Mark", "age"=>45}, {"name"=>"John", "age"=>50}]
+````
+
+Searching by range: 
+
+````ruby 
+collection.where(age: 42..48).all
+#=> [{"name"=>"Mark", "age"=>45}]
+````
+
+Searching with multiple arguments or #where calls:
+
+````ruby 
+collection.where(name: 'Matt', age: 28...32)
+# is equivalent to 
+collection.where(name: 'Matt').where(age: 28...32)
+````
+
+All criteria must match to return a result: 
+
+````ruby 
+collection.where(name: 'Matt', age: 40).empty?
+#=> true
+````
+
+### Not 
+
+The #not method negates the query, returning matches that do not match all of the specified values. Like #where, #not can search by exact value, regular expression, class, proc, and range. 
+
+````ruby 
+collection.not(name: 'Matt').all 
+#=> [{"name"=>"Mark", "age"=>45}, {"name"=>"John", "age"=>50}]
+````
+
+All values must match for result to be excluded:
+
+````ruby 
+collection.not(name: 'Matt', age: 40).empty?
+#=> true 
+````
+
+### Limit
+
+Limit the number of results returned: 
+
+````ruby 
+collection.where(age: 0..100).limit(2).count
+#=> 2 
+````
+
+### Offset 
+
+Skip the specified number of records before returning a result: 
+
+````ruby 
+collection.where(age: 0..100).offset(1).first
+#=> {"name"=>"Mark", "age"=>45}
+````
+
+### Order 
+
+Specify the field or fields with which to order the results: 
+
+````ruby 
+collection.order(:name).first
+#=> {"name"=>"John", "age"=>50}
+````
+
+Ascending order is assumed by default, but descending can be specified:
+
+````ruby 
+collection.order(age: :desc).first
+#=> {"name"=>"John", "age"=>50}
+````
+
+### Calculations 
+
+A calculation method can be called end of the criteria chain to perform on operation on one of the collection's attributes. 
+
+````ruby 
+# Sum / total for a field: 
+collection.where(age: 35..55).sum(:age)
+#=> 95
+
+# Maximum value for a field: 
+collection.maximum(:age)
+#=> 50 
+
+# Minimum value for a field:
+collection.minimum(:age)
+#=> 30 
+
+# Average value for a field:
+collection.average(:age)
+#=> 41.666666666666664
+
+# When there are no values in the collection, nil is returned:
+collection.where(age: 0..1).average(:age)
+#=> nil 
+````
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/criterion/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "criterion"
+
+# 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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/criterion.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'criterion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "criterion"
+  spec.version       = Criterion::VERSION
+  spec.authors       = ["Matthew Solt"]
+  spec.email         = ["mattsolt@gmail.com"]
+
+  spec.summary       = %q{Criterion is a small, simple library for searching Ruby arrays and collections with a chainable, Active Record style query interface.}
+  spec.description   = %q{Criterion is a small, simple library for searching Ruby arrays and collections with a chainable, Active Record style query interface.}
+  spec.homepage      = "https://github.com/activefx/criterion"
+  spec.license       = "MIT"
+
+  spec.required_ruby_version = '>= 2.2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "hashie"
+end

data/lib/criterion.rb

@@ -0,0 +1,121 @@
+require "criterion/version"
+require "forwardable"
+
+module Criterion
+  extend Forwardable
+
+  def_delegators :criteria,
+    :where, :not, :order, :limit, :offset, :skip,
+    :sum, :maximum, :minimum, :average
+
+  def criteria
+    Criteria.new(self)
+  end
+
+  class Criteria
+    extend Forwardable
+    include Enumerable
+
+    MULTI_VALUE_METHODS   = [ :where, :not, :order ]
+    SINGLE_VALUE_METHODS  = [ :limit, :offset ]
+
+    attr_accessor \
+      :where_values, :not_values, :order_values,
+      :limit_value, :offset_value
+
+    def_delegators :to_a,
+      :[], :at, :count, :empty?, :fetch, :first, :include?, :index,
+      :last, :length, :reverse, :rindex, :sample, :size, :sort,
+      :sort_by, :take, :take_while, :values_at
+
+    def initialize(records)
+      @records = records
+      MULTI_VALUE_METHODS.each { |v| instance_variable_set(:"@#{v}_values", {}) }
+      SINGLE_VALUE_METHODS.each { |v| instance_variable_set(:"@#{v}_value", nil) }
+    end
+
+    def where(query = {})
+      clone.tap do |r|
+        r.where_values.merge!(query) unless query.empty?
+      end
+    end
+
+    def not(query = {})
+      clone.tap do |r|
+        r.not_values.merge!(query) unless query.empty?
+      end
+    end
+
+    def order(*args)
+      sort = {}
+      args.collect do |arg|
+        sort.merge!(arg.is_a?(Hash) ? arg : { arg => :asc })
+      end
+      clone.tap do |r|
+        r.order_values.merge!(sort) unless sort.empty?
+      end
+    end
+
+    def limit(value = true)
+      clone.tap { |r| r.limit_value = value }
+    end
+
+    def offset(value = true)
+      clone.tap { |r| r.offset_value = value }
+    end
+    alias_method :skip, :offset
+
+    def average(field)
+      total = count
+      return nil if total.zero?
+      sum(field) / total.to_f
+    end
+
+    def sum(field)
+      to_a.inject(0) { |sum, obj| sum + obj.send(field) }
+    end
+
+    def minimum(field)
+      to_a.collect { |x| x.send(field) }.min
+    end
+
+    def maximum(field)
+      to_a.collect { |x| x.send(field) }.max
+    end
+
+    def to_a
+      results = @records.select do |record|
+        keep = where_values.empty? ? true : where_values.all? do |method, value|
+          value === record.send(method)
+        end
+        exclude = not_values.empty? ? false : not_values.all? do |method, value|
+          value === record.send(method)
+        end
+        keep && !exclude
+      end
+      results = results.sort_by(&ordering_args) unless order_values.empty?
+      results = results.drop(offset_value) if offset_value.is_a?(Integer)
+      results = results.take(limit_value) if limit_value.is_a?(Integer)
+      results
+    end
+    alias_method :all, :to_a
+    alias_method :to_ary, :to_a
+
+    def each(&block)
+      to_a.each(&block)
+    end
+
+    private
+
+    def ordering_args
+      Proc.new do |item|
+        order_values.map do |sort|
+          next unless [ :asc, :desc ].include?(sort.last)
+          sort.last == :desc ? -item.send(sort.first) : item.send(sort.first)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/criterion/version.rb

@@ -0,0 +1,3 @@
+module Criterion
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: criterion
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Matthew Solt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: 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'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: Criterion is a small, simple library for searching Ruby arrays and collections
+  with a chainable, Active Record style query interface.
+email:
+- mattsolt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- criterion.gemspec
+- lib/criterion.rb
+- lib/criterion/version.rb
+homepage: https://github.com/activefx/criterion
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Criterion is a small, simple library for searching Ruby arrays and collections
+  with a chainable, Active Record style query interface.
+test_files: []