gyroscope 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf459b04ef38e80fc048d485337c197519ff6950
+  data.tar.gz: b4628759f58aa82af0033d578281efa2f5651b16
+SHA512:
+  metadata.gz: a987c3ccf09daae87b46cc9ca50ba28d1b79580f4c8a35c8df663632d084df2efaffcba6b978459e1a6ff7861272b2b91eb45c0f1d97a527ee4b0600e37aa661
+  data.tar.gz: 24c25a95db77984b69b01f900902a251f013e2c2fd2703fbaeab0fd99f81de32a3722d6077e26151af664d682ecfa908aa8f9e61fc04c045bae601227c74899d

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,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Donald Plummer
+
+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,53 @@
+# Gyroscope
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gyroscope'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gyroscope
+
+## Usage
+
+```ruby
+module Search
+  class User < Gyroscope::SearchBase
+    attribute :name, String
+  end
+end
+
+searcher = Search::User.new(name: "Bob Dole")
+
+searcher.search # => user records!
+```
+
+## 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/avvo/gyroscope.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "gyroscope"
+
+# 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,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/gyroscope.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gyroscope/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gyroscope"
+  spec.version       = Gyroscope::VERSION
+  spec.authors       = ["Chris Wilhelm", "Donald Plummer"]
+  spec.email         = ["cwilhelm@avvo.com", "dplummer@avvo.com"]
+
+  spec.summary       = %q{Build ActiveRecord search scopes from params hash}
+  spec.description   = %q{Coerces values in params hash for search scoping}
+  spec.homepage      = "https://github.com/avvo/gyroscope"
+  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_dependency "activemodel"
+  spec.add_dependency "activerecord"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "virtus"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/gyroscope/integer_list.rb

@@ -0,0 +1,16 @@
+module Gyroscope
+  class IntegerList < Virtus::Attribute
+    strict true
+    required false
+
+    def coerce(values)
+      return nil if values.nil?
+
+      attr = Virtus::Attribute.build Integer, strict: true
+      Array(values).
+        map {|value| value.respond_to?(:split) ? value.split(',') : value }.
+        flatten.
+        map { |v| attr.coerce(v) }
+    end
+  end
+end

data/lib/gyroscope/search_base.rb

@@ -0,0 +1,87 @@
+require "virtus"
+require "active_model"
+
+module Gyroscope
+  class SearchBase
+    include Virtus.model strict: true, required: false
+    include ActiveModel::Validations
+
+    attribute :page,     Integer, default: 1
+    attribute :per_page, Integer, default: 30
+    attribute :order,    String
+
+    validate :validate_order
+
+    def initialize(*args)
+      super(*args)
+      normalize_order attributes[:order]
+    end
+
+    def target_model
+      "::#{self.class.name.demodulize}".constantize
+    end
+
+    def search
+      # is there a more generic ActiveModel validation error?
+      unless valid?
+        Rails.logger.debug("the errors: #{errors.inspect}")
+      end
+      fail ActiveModel::ForbiddenAttributesError, "Check your default values for correctness" unless valid?
+
+      build_search_scope
+    end
+
+    def normalize_order(ordering)
+      return unless attributes[:order]
+
+      unless /\./.match ordering
+        self.order = "#{target_model.table_name}.#{ordering}"
+      else
+        self.order = ordering
+      end
+    end
+
+    private
+
+    def base_scope
+      scope = target_model
+
+      if attributes[:page] || attributes[:per_page]
+        scope = pagination_scope(scope)
+      end
+      if attributes[:order]
+        scope = scope.order(attributes[:order])
+      end
+
+      scope
+    end
+
+    def pagination_scope(scope)
+      pagination_scope            = {}
+      pagination_scope[:page]     = attributes[:page] if attributes[:page]
+      pagination_scope[:per_page] = attributes[:per_page] if attributes[:per_page]
+
+      scope.paginate(pagination_scope)
+    end
+
+    def build_search_scope
+      base_scope
+    end
+
+    def validate_order
+      return unless attributes[:order]
+      split_order = attributes[:order].split(' ')
+
+      key, direction = split_order
+
+      errors.add(:order, 'Ordering on disallowed key') unless allowed_order_keys.include? key
+      errors.add(:order, 'Invalid sort direction') unless direction && %w(asc desc).include?(direction.downcase)
+    end
+
+    def allowed_order_keys
+      target_model.new.attributes.keys.map do |key|
+        "#{target_model.table_name}.#{key}"
+      end
+    end
+  end
+end

data/lib/gyroscope/version.rb

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

data/lib/gyroscope.rb

@@ -0,0 +1,6 @@
+require "gyroscope/version"
+
+module Gyroscope
+  autoload :SearchBase, "gyroscope/search_base"
+  autoload :IntegerList, "gyroscope/integer_list"
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: gyroscope
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Wilhelm
+- Donald Plummer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Coerces values in params hash for search scoping
+email:
+- cwilhelm@avvo.com
+- dplummer@avvo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gyroscope.gemspec
+- lib/gyroscope.rb
+- lib/gyroscope/integer_list.rb
+- lib/gyroscope/search_base.rb
+- lib/gyroscope/version.rb
+homepage: https://github.com/avvo/gyroscope
+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.1
+signing_key: 
+specification_version: 4
+summary: Build ActiveRecord search scopes from params hash
+test_files: []