gauze 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 960130145b856193b59bbaf1009e3e2767231b37
+  data.tar.gz: 9ac939b5b580dc0f639dba1af90712a307d6da60
+SHA512:
+  metadata.gz: 91b76a3d08c03012d0a54e8c7703cf18f18de4aa7eeec7b869d9e904bc1d7a0d235cd7de2dbc057fdc21fbd02a566413bce479b2194202ee4371e03419838a5a
+  data.tar.gz: 588faba6a77e9e1bf7243a80b5c17a828a9f1a21ec913dea9e2e5fcc77e4d3ca1a84be9f2477e1f8e40dc7786bd5c61a7d5c8f25b0b38c39869c3d2bfa0605cb

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris Ostrowski
+
+MIT License
+
+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,65 @@
+# Gauze
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gauze'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gauze
+
+## Usage
+
+Create a class that your controller can find.
+Define filters using the Gauze DSL.
+
+The filter method accepts 4 arguments.
+`filter :param_key, :column_name, :arel_method, :preprocessor`
+
+* `:param_key` - The key to look for when params are passed in.
+* `:column_name` - The name of the column that exists on `ActiveRecord::Base.arel_table`
+* `:arel_method` - The AREL method to use in the `where` stanza.
+* `:preprocessor` - (Optional) Takes a block to make an changes to the value before its passed into the AREL method. 
+
+```ruby
+  class EventFilters < Gauze::Base
+    filter :start_range, :created_at, :gteq, -> val {Chronic.parse(val)}
+    filter :end_range, :created_at, :lteq, -> val {Chronic.parse(val)}
+  end
+```
+
+Then in your controller:
+```ruby
+  class EventsController < ActionController::Base
+    def index
+      @events = EventFilters.build(Event, params)
+      render json: @events
+    end
+  end
+```
+
+Because *Gauze* uses AREL to construct queries, you can use `.build` just like any other scope. You can pass relational objects & chain more relations as you need.
+```
+def index
+  @events = EventFilters.build(current_user.events, params).order(created_at: :desc).where(name: "Football Game")
+  render json: @events
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/TheKidCoder/gauze/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/gauze.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gauze/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gauze"
+  spec.version       = Gauze::VERSION
+  spec.authors       = ["Chris Ostrowski"]
+  spec.email         = ["chris@madebyfunction.com"]
+  spec.summary       = %q{A thin filtering library leveraging AREL & ActionController.}
+  spec.description   = %q{Using scopes on a model that only need to accessed in a controller seems like a leakage of SRP. This gem will allow you to write simple filtering logic that translates your params to AREL queries.}
+  spec.homepage      = "https://github.com/TheKidCoder/Gauze"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/gauze/base.rb

@@ -0,0 +1,43 @@
+module Gauze
+  class Base
+    def self.filter(param_key, column_name, arel_method, preprocessor = nil)
+      @@filters ||= []
+      @@filters.push param_key: param_key, column: column_name, method: arel_method, preprocessor: preprocessor
+    end
+
+    def self.build(resource, params = {})
+      new(resource, params).build_nodes
+    end
+
+    def initialize(resource, params = {})
+      @resource = resource
+      @params = params.symbolize_keys
+    end
+
+    def build_nodes
+      wheres = applied_filters.map {|obj| build_arel_filter(obj)}
+      _query = @resource
+      wheres.each {|node| _query = _query.where(node)}
+      return _query
+    end
+
+    def build_arel_filter(filter_hash)
+      filter_val = @params[filter_hash[:param_key]]
+      filter_val = filter_hash[:preprocessor].call(filter_val) if filter_hash[:preprocessor]
+
+      @resource.arel_table[filter_hash[:column]].method(filter_hash[:method]).call(filter_val)
+    end
+
+    private
+    def applied_filters
+      _filters = []
+      @params.each do |k,v|
+        next unless v.present?
+        next unless filter = @@filters.find {|obj| obj[:param_key] == k}
+        _filters.push filter
+      end
+
+      _filters
+    end
+  end
+end

data/lib/gauze/version.rb

@@ -0,0 +1,3 @@
+module Gauze
+  VERSION = "0.0.1"
+end

data/lib/gauze.rb

@@ -0,0 +1,5 @@
+require "gauze/version"
+
+module Gauze
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: gauze
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Ostrowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Using scopes on a model that only need to accessed in a controller seems
+  like a leakage of SRP. This gem will allow you to write simple filtering logic that
+  translates your params to AREL queries.
+email:
+- chris@madebyfunction.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gauze.gemspec
+- lib/gauze.rb
+- lib/gauze/base.rb
+- lib/gauze/version.rb
+homepage: https://github.com/TheKidCoder/Gauze
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A thin filtering library leveraging AREL & ActionController.
+test_files: []