hayrick 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ef3c9beccbac53e53f7d7caa82a0f57f910a136
+  data.tar.gz: d7abc784998d895d1b129832ffee9bfc41af02b1
+SHA512:
+  metadata.gz: ec9a96146f0b460e96e35716e524ed04dabf2d6a6971f22456ac09f2c7057eb479111835da8cc2c00c20141fcf178025343d55fe9b6d088b87915082170b2b94
+  data.tar.gz: f926a8560d89f4890f0f8a154bd71740f0bfbaaed99868b3bb1731097794f89c3089e4476bd8958468fdfa938156ccf2e49214e768fb41c3964480c1a8c38c26

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Pedro Lambert
+
+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,72 @@
+## Hayrick
+*Query Objects without a hitch.*
+
+---
+[![Build Status](https://travis-ci.org/p-lambert/hayrick.svg?branch=master)](https://travis-ci.org/p-lambert/hayrick)
+
+`Hayrick` lets you easily create
+[Query Objects](http://martinfowler.com/eaaCatalog/queryObject.html), decoupling
+your data models from querying concerns. It is extremely lightweight, having
+less than `100` lines of code and no external dependencies. `Hayrick` currently
+supports
+[Active Record](https://github.com/rails/rails/tree/master/activerecord) and
+[Sequel](https://github.com/jeremyevans/sequel).
+
+### Usage
+
+First, add this line to your application's `Gemfile`:
+
+```ruby
+gem 'hayrick'
+```
+
+Then you have just to include the `Hayrick` module and implement a `#base_scope` method:
+
+```ruby
+class AlbumCollection
+  include Hayrick
+
+  def base_scope
+    Album.all # or Album.unscoped depending on your Rails version
+  end
+end
+```
+
+And that's it! You're now able to perform queries by calling
+`AlbumCollection#search`.
+
+```ruby
+AlbumCollection.new.search(artist: 'Morphine')
+=> #<ActiveRecord::Relation [#<Album id: 1, name: "Good", artist: "Morphine", release_date: "1992-09-08">, #<Album id: 2, name: "Cure for Pain", artist: "Morphine", release_date: "1993-09-14">...]>
+```
+
+That seems fine, but we usually want to carry out queries using parameters other
+than our model fields, right? `Hayrick` provides a simple DSL for adding such
+filters:
+
+```ruby
+class AlbumCollection
+  include Hayrick
+
+  filter :year do |search_relation, year|
+    search_relation.where('extract(year from released_at) = ?', year)
+  end
+
+  def base_scope
+    Album.all
+  end
+end
+```
+
+Notice the `.filter` method receives two parameters:
+
+* a filter name (in this case, `:year`)
+* a filter definition which can be either a `Proc` or a block. This callable
+  object must receive two arguments: the first is the search relation and the
+  second is the argument for the filter itself. Make sure to always return the
+  search relation to prevent the filter chain from breaking.
+
+```ruby
+AlbumCollection.new.search(artist: 'Morphine', year: 1993)
+=> #<ActiveRecord::Relation [#<Album id: 2, name: "Cure for Pain", artist: "Morphine", release_date: "1993-09-14">]>
+```

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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'hayrick'
+require 'irb'
+
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/hayrick.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hayrick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hayrick'
+  spec.version       = Hayrick::VERSION
+  spec.authors       = ['Pedro Lambert']
+  spec.email         = ['pedrolambert@gmail.com']
+
+  spec.summary       = %q{Create Query Objects without a hitch.}
+  spec.description   = %q{Create Query Objects without a hitch.}
+  spec.homepage      = 'https://github.com/p-lambert/hayrick'
+  spec.license       = 'MIT'
+  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.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sequel', '~> 4.0'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'pry'
+end

data/lib/hayrick.rb

@@ -0,0 +1,43 @@
+require 'hayrick/version'
+require 'hayrick/default_filter_generator'
+require 'hayrick/filter_repository'
+
+module Hayrick
+  def self.included(base)
+    base.send(:extend, ClassMethods)
+  end
+
+  def search(params, seed = base_scope)
+    params.reduce(seed, &apply_filter)
+  end
+
+  def base_scope
+    fail(NotImplementedError)
+  end
+
+  private
+
+  def apply_filter
+    lambda do |accumulated_search, (keyword, term)|
+      lookup_filter(keyword).call(accumulated_search, term)
+    end
+  end
+
+  def lookup_filter(name)
+    self.class.search_filters[name]
+  end
+
+  module ClassMethods
+    def filter(keyword, callable = nil, &block)
+      (!!callable ^ !!block) || fail(ArgumentError)
+
+      captured_callable = callable || block
+
+      search_filters.add(keyword, captured_callable)
+    end
+
+    def search_filters
+      @search_filters ||= FilterRepository.new
+    end
+  end
+end

data/lib/hayrick/default_filter_generator.rb

@@ -0,0 +1,7 @@
+module Hayrick
+  class DefaultFilterGenerator
+    def call(name)
+      -> (rel, value) { rel.where(name => value) }
+    end
+  end
+end

data/lib/hayrick/filter_repository.rb

@@ -0,0 +1,24 @@
+require 'forwardable'
+
+module Hayrick
+  class FilterRepository
+    extend Forwardable
+    def_delegators :all, :[], :merge!
+
+    attr_reader :default_filter
+
+    def initialize(default_filter = DefaultFilterGenerator.new)
+      @default_filter = default_filter
+    end
+
+    def add(name, callable)
+      merge!(name.to_sym => callable)
+    end
+
+    def all
+      @filters ||= Hash.new do |_, keyword|
+        default_filter.call(keyword)
+      end
+    end
+  end
+end

data/lib/hayrick/version.rb

@@ -0,0 +1,3 @@
+module Hayrick
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: hayrick
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Lambert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: database_cleaner
+  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: pry
+  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: Create Query Objects without a hitch.
+email:
+- pedrolambert@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hayrick.gemspec
+- lib/hayrick.rb
+- lib/hayrick/default_filter_generator.rb
+- lib/hayrick/filter_repository.rb
+- lib/hayrick/version.rb
+homepage: https://github.com/p-lambert/hayrick
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Create Query Objects without a hitch.
+test_files: []