scopable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a92105be0449f880038bc7d58e0af2d2a1873531
+  data.tar.gz: 2718a557dda1ec4d724ea0f9ab231fe0ffd45a43
+SHA512:
+  metadata.gz: 7c0cadb182a7e2171f6e4d97db016bcad90e6d6a2abc7d9f5146827643699bc21190e5a3ac92c7f977ed5ae3b103e3eb9228d2aca4fb89bfb2f259501a988971
+  data.tar.gz: dbcb6bffaeea5d1101b0385ccc9537604552506e73fa97a3c3a3c607618aabd57ff85b384b5908d79bad23bf651112d68c5b411dd3793390ec0f7d9a03ff5eaa

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'activesupport', '~> 4.2.0'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Arthur Corenzan
+
+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,54 @@
+# Scopable
+
+> Apply scopes to your query based on available parameters
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scopable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install scopable
+
+## Usage
+
+Configure scopes in your controller:
+
+```ruby
+class PostsController < ApplicationController
+  include Scopable
+
+  scope :search, :param => :q
+
+  # ...
+end
+```
+
+Then apply it to your model:
+
+```ruby
+def index
+  @posts = scoped(Post, params)
+end
+```
+
+Now, whenever the parameter `q` is present at `params`, it will call `#search` on your model passing its value as argument.
+
+TODO: Add more examples.
+TODO: Layout `scope` options.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/scopable/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/lib/scopable.rb

@@ -0,0 +1,60 @@
+require "scopable/version"
+
+module Scopable
+  extend ActiveSupport::Concern
+
+  included do
+    cattr_reader :scopes do
+      Hash.new
+    end
+
+    helper_method :active_scopes
+  end
+
+  def active_scopes
+    scopes.map do |name, scope|
+      name if scope[:active]
+    end.compact
+  end
+
+  def scoped(resource, params)
+    scopes.reduce(resource) do |resource, scope|
+      name, scope = *scope
+
+      param, force, default, except, only, fn = scope.values_at(:param, :force, :default, :except, :only, :fn)
+
+      force = self.instance_exec(&force) if force.respond_to?(:call)
+
+      param = param || name
+      value = force || params[param] || default
+
+      value = nil if except.present? && Array.wrap(except).map(&:to_s).include?(action_name)
+      value = nil unless only.nil? || Array.wrap(only).map(&:to_s).include?(action_name)
+
+      if value.nil? || value.to_s =~ /\A(false|no|off)\z/
+        scope.update(:active => false)
+        resource
+      else
+        scope.update(:active => true)
+
+        value = nil if value == 'nil'
+
+        if fn
+          self.instance_exec(resource, value, &fn)
+        else
+          if value.to_s =~ /\A(true|yes|on)\z/
+            resource.send(name)
+          else
+            resource.send(name, value)
+          end
+        end
+      end
+    end
+  end
+
+  module ClassMethods
+    def scope(name, opts = {}, &fn)
+      scopes.store name, opts.merge(:fn => fn)
+    end
+  end
+end

data/lib/scopable/version.rb

@@ -0,0 +1,3 @@
+module Scopable
+  VERSION = "1.0.0"
+end

data/scopable.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scopable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scopable"
+  spec.version       = Scopable::VERSION
+  spec.authors       = ["Arthur Corenzan"]
+  spec.email         = ["arthur@corenzan.com"]
+  spec.summary       = %q{Apply scopes to your query based on available parameters}
+  # spec.description   = %q{}
+  spec.homepage      = "https://github.com/haggen/scopable"
+  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_runtime_dependency "activesupport", ">= 3.2", "< 5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: scopable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Arthur Corenzan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: 
+email:
+- arthur@corenzan.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scopable.rb
+- lib/scopable/version.rb
+- scopable.gemspec
+homepage: https://github.com/haggen/scopable
+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: Apply scopes to your query based on available parameters
+test_files: []