sinatra-muster 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--fail-fast
+--format progress

data/.yardopts

@@ -0,0 +1 @@
+--protected

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Christopher H. Laco
+
+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,45 @@
+# Sinatra::Muster
+
+Sinatra helpers for working with Muster query string parsing strategies
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-muster'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-muster
+
+## Usage
+
+    require 'sinatra/base'
+    require 'sinatra/muster'
+    
+    class MyApp < Sinatra::Base
+      register Sinatra::Muster
+    
+      use Muster::Rack, Muster::Strategies::Hash
+    
+      #  GET /?select=id,name,password
+      get '/' do
+        query_filter :select, :only => ['id', 'name', 'email']
+    
+        selected = query[:select]  #=> ['id', 'name']
+    
+        Users.all(:fields => selected)
+      end
+    end
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+
+YARD::Rake::YardocTask.new(:yard)

data/lib/sinatra/muster.rb

@@ -0,0 +1,96 @@
+require 'muster'
+require 'sinatra/base'
+
+module Sinatra
+  module Muster
+
+    # Sinatra helpers for working with Muster query string parsing strategies
+    #
+    # @example
+    #
+    #   require 'sinatra/base'
+    #   require 'sinatra/muster'
+    #
+    #   class MyApp < Sinatra::Base
+    #     register Sinatra::Muster
+    #
+    #     use Muster::Rack, Muster::Strategies::Hash
+    #
+    #     #  GET /?select=id,name,password
+    #     get '/' do
+    #       query_filter :select, :only => ['id', 'name', 'email']
+    #       
+    #       selected = query[:select]  #=> ['id', 'name']
+    #
+    #       Users.all(:fields => selected)
+    #     end
+    #   end
+    module Helpers
+
+      # Add a filter to be applied to the data in {#query} results
+      #
+      # @param key [String,Symbol] the key of the values in {#query} to filter
+      # @param [optional, Hash] options the options available for this filter
+      # @option options [optional] :only when specified, only return the matching values
+      #   If you specify a single value, a single value will be returned
+      #   If you specify an Array of values, an Array will be returned, even if only one value matches
+      # @option options [optional] :except return all values except the ones given here
+      #   If the raw data value is a single value, a single value will be returned
+      #   If the raw data value is an Array, and array will be returned, even if all values are excluded
+      #   If nothing was excluded, the raw value is returned as-is
+      #
+      # If you pass a scalar value instead of a Hash into options, it will be treated as the default, just like
+      # Hash#fetch does.
+      #
+      # If you pass nothing into the options argument, it will return all values if the key exists or raise
+      # a KeyError like Hash#fetch.
+      #
+      # @return [void]
+      #
+      # @example
+      #
+      #   results.add_filter(:select, :only => [:id, :name])
+      #   results.add_filter(:select, :except => [:id])
+      #   results.add_filter(:page, 1)
+      def query_filter( key, *options )
+        muster_query.add_filter( key, *options )
+      end
+
+      # Returns the parsed and filtered query options from Muster::Rack
+      #
+      # @return [Muster::Results]
+      #
+      # @example
+      #
+      #     #  GET /?select=id,name,password
+      #     get '/' do
+      #       query_filter :select, :only => ['id', 'name', 'email']
+      #       
+      #       selected = query[:select]  #=> ['id', 'name']
+      #
+      #       Users.all(:fields => selected)
+      #     end
+      def query
+        muster_query.filtered
+      end
+
+      private 
+
+      def muster_query
+        request.env['muster.query']
+      end
+
+    end
+
+    # Registers the helpers with the current Sinatra application
+    #
+    # @param app [Sinatra::Base] The Sinatra application instance
+    #
+    # @return [void]
+    def self.registered(app)
+      app.helpers Sinatra::Muster::Helpers
+    end
+  end
+
+  helpers Sinatra::Muster::Helpers
+end

data/lib/sinatra/muster/version.rb

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

data/sinatra-muster.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/muster/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sinatra-muster"
+  gem.version       = Sinatra::Muster::VERSION
+  gem.authors       = ["Christopher H. Laco"]
+  gem.email         = ["claco@chrislaco.com"]
+  gem.description   = %q{Extension and Helpers for using Muster in Sinatra applications.}
+  gem.summary       = %q{Sinatra Muster Exception}
+  gem.homepage      = "https://github.com/claco/sinatra-muster"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'muster', '>= 0.0.4'
+  gem.add_dependency 'sinatra'
+
+  gem.add_development_dependency 'rspec',     '~> 2.11.0'
+  gem.add_development_dependency 'redcarpet', '~> 2.1'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'yard',      '~> 0.8.2'  
+  gem.add_development_dependency 'rack-test'
+end

data/spec/sinatra/muster/helpers_spec.rb

@@ -0,0 +1,155 @@
+require 'spec_helper'
+
+describe Sinatra::Muster::Helpers do
+  include Rack::Test::Methods
+
+  subject(:app) do
+    modular_app(&action)
+  end
+
+  context 'with no filters' do
+    let(:action) do
+      lambda do 
+        query.inspect
+      end
+    end
+
+    it 'returns all parsed values' do
+      get '/?select=id,name,password'
+
+      last_response.body.should == '{"select"=>["id", "name", "password"]}'
+    end
+  end
+
+  context 'with :only filtering' do
+    context 'with no matching values' do
+      context 'and a scalar filter' do
+        let(:action) do
+          lambda do
+            query_filter :select, :only => 'name'
+            query.inspect
+          end
+        end
+
+        it 'returns a nil' do
+          get '/?select=id,password'
+
+          last_response.body.should == '{"select"=>nil}'
+        end
+      end
+
+      context 'and an Array filter' do
+        let(:action) do
+          lambda do
+            query_filter :select, :only => ['name']
+            query.inspect
+          end
+        end
+
+        it 'returns an empty Array' do
+          get '/?select=id,password'
+
+          last_response.body.should == '{"select"=>[]}'
+        end
+      end
+    end
+
+    context 'with a matching value' do
+      context 'with a scalar filter' do
+        let(:action) do
+          lambda do
+            query_filter :select, :only => 'name'
+            query.inspect
+          end
+        end
+
+        it 'returns filtered scalar value' do
+          get '/?select=id,name,password'
+
+          last_response.body.should == '{"select"=>"name"}'
+        end
+      end
+
+      context 'with an Array filter' do
+        let(:action) do
+          lambda do
+            query_filter :select, :only => ['name']
+            query.inspect
+          end
+        end
+
+        it 'returns filtered scalar value' do
+          get '/?select=id,name,password'
+
+          last_response.body.should == '{"select"=>["name"]}'
+        end
+      end
+    end
+  end
+
+  context 'with :except filtering' do
+    context 'with no remaining values' do
+      context 'and a scalar query' do
+        let(:action) do
+          lambda do
+            query_filter :select, :except => 'name'
+            query.inspect
+          end
+        end
+
+        it 'returns a nil' do
+          get '/?select=name'
+
+          last_response.body.should == '{"select"=>nil}'
+        end
+      end
+
+      context 'and an Array query' do
+        let(:action) do
+          lambda do
+            query_filter :select, :except => ['id','name']
+            query.inspect
+          end
+        end
+
+        it 'returns an empty nil' do
+          get '/?select=id,name'
+
+          last_response.body.should == '{"select"=>[]}'
+        end
+      end
+    end
+
+    context 'with remaining values' do
+      context 'with a scalar query value' do
+        let(:action) do
+          lambda do
+            query_filter :select, :except => 'id'
+            query.inspect
+          end
+        end
+
+        it 'returns filtered scalar value' do
+          get '/?select=name'
+
+          last_response.body.should == '{"select"=>"name"}'
+        end
+      end
+
+      context 'with an Array query value' do
+        let(:action) do
+          lambda do
+            query_filter :select, :except => ['password']
+            query.inspect
+          end
+        end
+
+        it 'returns filtered Arrau value' do
+          get '/?select=id,name,password'
+
+          last_response.body.should == '{"select"=>["id", "name"]}'
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'rack/test'
+require 'sinatra/muster'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+end
+
+def mock_app(base=Sinatra::Base, &block)
+  Sinatra.new(base, &block)
+end
+
+def modular_app(&block)
+  mock_app do
+    register Sinatra::Muster
+
+    use Muster::Rack, Muster::Strategies::Hash
+
+    get '/', &block
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-muster
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Christopher H. Laco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: muster
+  requirement: &70190314709080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70190314709080
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70190314708620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70190314708620
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70190314708020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *70190314708020
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70190314707500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: *70190314707500
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70190314707060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70190314707060
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70190314706520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: *70190314706520
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70190314706080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70190314706080
+description: Extension and Helpers for using Muster in Sinatra applications.
+email:
+- claco@chrislaco.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/muster.rb
+- lib/sinatra/muster/version.rb
+- sinatra-muster.gemspec
+- spec/sinatra/muster/helpers_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/claco/sinatra-muster
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Sinatra Muster Exception
+test_files:
+- spec/sinatra/muster/helpers_spec.rb
+- spec/spec_helper.rb
+has_rdoc: