sinatra-has_scope 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in sinatra-has_scope.gemspec
+gemspec

data/README.mdown

@@ -0,0 +1,71 @@
+## Sinatra HasScope
+
+Sinatra HasScope is a Sinatra adaptation of the very useful [HasScope Rails library](https://github.com/plataformatec/has_scope).
+
+Sinatra HasScope allows you to easily create filters based on your resources named scopes.
+Imagine the following model called Graduation:
+
+    class Graduation < ActiveRecord::Base
+      scope :featured, where('featured = ?', true)
+      scope :by_degree, lambda { |degree| { where('degree = ?', degree) } }
+    end
+
+You can use those named scopes as filters by declaring them on your routes:
+
+    class MyApp < Sinatra::Base
+      has_scope :gradutation, :featured, :type => :boolean
+      has_scope :gradutation, :by_degree
+      has_scope :gradutation, :by_period, :using => [:started_at, :ended_at]
+    end
+
+Now, if you want to apply them to an specific resource, you just need to call `apply_scopes`:
+
+    get '/graduations' do
+      @graduations = apply_scopes(:graduation, Graduation, params).all
+    end
+
+Then for each request:
+
+    /graduations
+    #=> acts like a normal request
+    
+    /graduations?featured=true
+    #=> calls the named scope and bring featured graduations
+    
+    /graduations?featured=true&by_degree=phd
+    #=> brings featured graduations with phd degree
+    
+    /graduations?params[by_period][started_at]=20100701&params[by_period][ended_at]=20101013
+    #=> brings graduations in the given period
+
+## Installation
+
+Sinatra HasScope is available as gem on Gemcutter, so just run the following:
+
+    sudo gem install sinatra-has_scope
+
+To install it with bundler, use:
+
+    gem 'sinatra-has_scope', :require => 'sinatra/has_scope'
+
+## Options
+
+HasScope supports several options:
+
+* `:type` - Checks the type of the parameter sent. If set to :boolean it just calls the named scope, without any argument. By default, it does not allow hashes or arrays to be given, except if type :hash or :array are set.
+
+* `:as` - The key in the params hash expected to find the scope. Defaults to the scope name.
+
+* `:using` - The subkeys to be used as args when type is a hash.
+
+* `:if` - Specifies a method, proc or string to call to determine if the scope should apply.
+
+* `:unless` - Specifies a method, proc or string to call to determine if the scope should NOT apply.
+
+* `:default` - Default value for the scope. Whenever supplied the scope is always called.
+
+* `:allow_blank` - Blank values are not sent to scopes by default. Set to true to overwrite.
+
+## Bugs and Feedback
+
+If you discover any bugs or want to drop a line, feel free to create an [issue on GitHub](http://github.com/simonc/sinatra-has_scope/issues).

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/sinatra/has_scope/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module HasScope
+    VERSION = "0.0.1"
+  end
+end

data/lib/sinatra/has_scope.rb

@@ -0,0 +1,141 @@
+require 'sinatra/base'
+
+module Sinatra
+  module HasScope
+    TRUE_VALUES = ["true", true, "1", 1]
+
+    ALLOWED_TYPES = {
+      :array    => [ Array ],
+      :hash     => [ Hash ],
+      :boolean  => [ Object ],
+      :default  => [ String, Numeric ]
+    }
+
+    attr_accessor :scopes_configuration
+
+    # Detects params from url and apply as scopes to your classes.
+    #
+    # == Options
+    #
+    # * <tt>:type</tt> - Checks the type of the parameter sent. If set to :boolean
+    # it just calls the named scope, without any argument. By default,
+    # it does not allow hashes or arrays to be given, except if type
+    # :hash or :array are set.
+    #
+    # * <tt>:as</tt> - The key in the params hash expected to find the scope.
+    # Defaults to the scope name.
+    #
+    # * <tt>:using</tt> - If type is a hash, you can provide :using to convert the hash to
+    # a named scope call with several arguments.
+    #
+    # * <tt>:if</tt> - Specifies a method, proc or string to call to determine
+    # if the scope should apply
+    #
+    # * <tt>:unless</tt> - Specifies a method, proc or string to call to determine
+    # if the scope should NOT apply.
+    #
+    # * <tt>:default</tt> - Default value for the scope. Whenever supplied the scope
+    # is always called.
+    #
+    # * <tt>:allow_blank</tt> - Blank values are not sent to scopes by default. Set to true to overwrite.
+    #
+    def has_scope(scope_group, *scopes)
+      options = scopes.extract_options!
+      options.symbolize_keys!
+      options.assert_valid_keys(:type, :if, :unless, :default, :as, :using, :allow_blank)
+
+      if options.key?(:using)
+        if options.key?(:type) && options[:type] != :hash
+          raise "You cannot use :using with another :type different than :hash"
+        else
+          options[:type] = :hash
+        end
+
+        options[:using] = [*options[:using]]
+      end
+
+      self.scopes_configuration ||= {}
+      self.scopes_configuration[scope_group] ||= {}
+
+      scopes.each do |scope|
+        self.scopes_configuration[scope_group][scope] ||= {
+          :as => scope,
+          :type => :default
+        }
+        self.scopes_configuration[scope_group][scope].merge!(options)
+      end
+    end
+
+    # Receives an object where scopes will be applied to.
+    #
+    # has_scope :graduation, :featured, :type => true
+    # has_scope :graduation, :by_degree
+    #
+    # get '/graduations' do
+    #   @graduations = apply_scopes(:graduation, Graduation, params).all
+    # end
+    #
+    def apply_scopes(scope_group, target, hash)
+      return target unless scopes_configuration
+
+      self.scopes_configuration[scope_group].each do |scope, options|
+        key = options[:as].to_s
+
+        if hash.key?(key)
+          value, call_scope = hash[key], true
+        elsif options.key?(:default)
+          value, call_scope = options[:default], true
+          value = value.call(self) if value.is_a?(Proc)
+        end
+
+        value = parse_value(options[:type], key, value)
+
+        if call_scope && (value.present? || options[:allow_blank])
+          target = call_scope_by_type(options[:type], scope, target, value, options)
+        end
+      end
+
+      target
+    end
+
+    # Set the real value for the current scope if type check.
+    def parse_value(type, key, value) #:nodoc:
+      if type == :boolean
+        TRUE_VALUES.include?(value)
+      elsif value && ALLOWED_TYPES[type].none?{ |klass| value.is_a?(klass) }
+        raise "Expected type :#{type} in params[:#{key}], got #{value.class}"
+      else
+        value
+      end
+    end
+
+    # Call the scope taking into account its type.
+    def call_scope_by_type(type, scope, target, value, options) #:nodoc:
+      if type == :boolean
+        target.send(scope)
+      elsif value && options.key?(:using)
+        value = value.values_at(*options[:using])
+        target.send(scope, *value)
+      else
+        target.send(scope, value)
+      end
+    end
+
+    # Evaluates the scope options :if or :unless. Returns true if the proc
+    # method, or string evals to the expected value.
+    def applicable?(string_proc_or_symbol, expected) #:nodoc:
+      case string_proc_or_symbol
+        when String
+          eval(string_proc_or_symbol) == expected
+        when Proc
+          string_proc_or_symbol.call(self) == expected
+        when Symbol
+          send(string_proc_or_symbol) == expected
+        else
+          true
+      end
+    end
+  end
+
+  register HasScope
+end

data/sinatra-has_scope.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/sinatra/has_scope/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "sinatra-has_scope"
+  s.version     = Sinatra::HasScope::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Simon COURTOIS']
+  s.email       = ['scourtois@cubyx.fr']
+  s.homepage    = "http://rubygems.org/gems/sinatra-has_scope"
+  s.summary     = "HasScope equivalent for Sinatra"
+  s.description = "HasScope readaptation for the Sinatra micro-framework"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "sinatra-has_scope"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-has_scope
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Simon COURTOIS
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-06 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+description: HasScope readaptation for the Sinatra micro-framework
+email: 
+- scourtois@cubyx.fr
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.mdown
+- Rakefile
+- lib/sinatra/has_scope.rb
+- lib/sinatra/has_scope/version.rb
+- sinatra-has_scope.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/sinatra-has_scope
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: sinatra-has_scope
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: HasScope equivalent for Sinatra
+test_files: []
+