sinatra-default_parameters 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+
+# whitelist
+branches:
+  only:
+    - master
+    - develop

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem "sinatra"
+  gem "wirble"
+  gem "yard"
+  gem "redcarpet"
+end
+
+group :test do
+  gem "rake"
+  gem "rack-test"
+  gem "rspec"
+  gem "simplecov"
+end

data/LICENCE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Iain Barnett
+
+MIT Licence
+
+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, sublicence, 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,48 @@
+# Sinatra Default Parameters #
+
+## Build status ##
+
+Master branch:
+[![Build Status](https://travis-ci.org/yb66/sinatra-default_parameters.png?branch=master)](https://travis-ci.org/yb66/sinatra-default_parameters)
+
+Develop branch:
+[![Build Status](https://travis-ci.org/yb66/sinatra-default_parameters.png?branch=develop)](https://travis-ci.org/yb66/sinatra-default_parameters)
+
+## What? ##
+
+A quick and simple way to set defaults for the params helper on a per route basis.
+
+## Why? ##
+
+I was inspired to make this into a gem after [answering this question on StackOverflow](http://stackoverflow.com/a/14885171/335847). I liked the look of it and thought I'll use this again, hence a gem.
+
+## How? ##
+
+It's quite simple.
+
+    require 'sinatra/default_parameters'
+    
+    helpers Sinatra::DefaultParameters # This too if you're using modular style apps.
+    
+    get "/" do
+      set_defaults a: 1, b: 2, c: 3
+      params.inspect
+    end
+    
+    # GET "/"
+    # => {"a"=>1, "b"=>2, "c"=>3}
+    # GET "/?a=7&b=4"
+    # => {"a"=>"7", "b"=>"4", "c"=>3}
+    # GET "/?d=4"
+    # => {"a"=>1, "b"=>2, "c"=>3, "d"=>"4"}
+    # GET "/?a=7&b=4&d=4"
+    # => {"a"=>"7", "b"=>"4", "c"=>3, "d"=>"4"}
+
+Simples, innit.
+
+***Note:*** As you can see from the examples it doesn't do any type casting or other checks, it just does this one very small thing, the rest is up to you.
+
+
+## Licence ##
+
+See the LICENCE file.

data/Rakefile

@@ -0,0 +1,32 @@
+require "bundler/gem_tasks"
+
+desc "(Re-) generate documentation and place it in the docs/ dir."
+task :docs => :"docs:yard"  
+namespace :docs do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['-odocs/', '--no-private']
+  end
+
+  desc "Docs including private methods."
+  YARD::Rake::YardocTask.new(:all) do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['-odocs/']
+  end
+    
+  desc "How to use the docs."
+  task :usage do
+    puts "Open the index.html file in the docs directory to read them. Does not include methods marked private unless you ran the 'all' version (you'll only need these if you plan to hack on the library itself)."
+  end
+end
+
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb"
+end
+
+desc 'Default: run specs.'
+task :default => :spec

data/examples/app.rb

@@ -0,0 +1,16 @@
+require 'sinatra/base'
+require 'sinatra/default_parameters'
+
+# modular app
+class Example < Sinatra::Base
+  helpers Sinatra::DefaultParameters
+
+  get "/" do
+    set_defaults start: 10, finish: 20
+    # This will force the order
+    # It's easier to compare/test the output then
+    Hash[ params.sort ].inspect
+  end
+
+end
+

data/examples/config.ru

@@ -0,0 +1,12 @@
+# encoding: UTF-8
+
+require 'rubygems'
+require 'bundler'
+Bundler.require
+
+root = File.expand_path File.dirname(__FILE__)
+require File.join( root , "./app.rb" )
+
+# everything was moved into a separate module/file to make it easier to set up tests
+
+run Example

data/lib/sinatra/default_parameters.rb

@@ -0,0 +1,36 @@
+# encoding: UTF-8
+
+require 'sinatra/base'
+
+module Sinatra
+
+  # Extends the request context with a helper to give a quick and simple way to set defaults for the params helper on a per route basis.
+  # @author Iain Barnett
+  module DefaultParameters
+
+    # A helper to set default keys/values on the params helper hash.
+    # @note As you can see from the examples it doesn't do any type casting or other checks, it just does this one very small thing, the rest is up to you.
+    # @params [Hash] defaults A list of the defaults.
+    # @example
+    #   get "/comments/?" do
+    #     set_defaults start: 10, finish: 20
+    #     params.inspect
+    #   end
+    #   # GET http://localhost:9292/comments
+    #   # => {"start"=>10, "finish"=>20}
+    #   # GET http://localhost:9292/comments?start=5&units=seconds
+    #   # => {"start"=>"5", "units"=>"seconds", "finish"=>20}
+    # @return [Hash] It returns the params hash, but since you've got access to that helper in the request scope it doesn't matter.
+    def set_defaults( defaults={} )
+      # stringify the keys!
+      h = defaults.each_with_object({}) do |(k,v),h|
+        h[k.to_s] = defaults[k]
+      end
+      # `merge` into `h` first to preserve the `params` already set.
+      # Then `merge!` that into params to set it.
+      params.merge!( h.merge params )
+    end
+
+  end
+  helpers DefaultParameters
+end

data/lib/sinatra/default_parameters/version.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+module Sinatra
+  module DefaultParameters
+    VERSION = "0.0.1"
+  end
+end

data/sinatra-default_parameters.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sinatra/default_parameters/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Iain Barnett"]
+  gem.email         = ["iainspeed@gmail.com"]
+  gem.description   = %q{A quick and simple way to set defaults for the params helper on a per route basis.}
+  gem.summary       = %q{Extends the request context with a helper to give a quick and simple way to set defaults for the params helper on a per route basis.}
+  gem.homepage      = "https://github.com/yb66/sinatra-default_parameters"
+
+  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.name          = "sinatra-default_parameters"
+  gem.require_paths = ["lib"]
+  gem.version       = Sinatra::DefaultParameters::VERSION
+  gem.add_dependency("sinatra", "~>1.3")
+end

data/spec/default_parameters_spec.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+
+require "spec_helper"
+
+require_relative "../lib/sinatra/default_parameters.rb"
+
+
+describe "DefaultParameters" do
+
+  before do
+    get '/'
+  end
+
+  # check the app works ok
+  include_context "All pages"
+  it_should_behave_like "Any route"
+
+  describe "The output" do
+    subject { last_response.body }
+    context "Given no parameters via the request" do
+      let(:expected) { %q!{"finish"=>20, "start"=>10}! }
+      it { should == expected }
+    end
+    context "Given extra parameters via the request" do
+      before do
+        get '/?unit=seconds&type=race'
+      end
+      let(:expected) { 
+        %q!{"finish"=>20, "start"=>10, "type"=>"race", "unit"=>"seconds"}!
+      }
+      it { should == expected }
+    end
+    
+    context "Given parameters that have keys the same as the defaults" do
+      before do
+        get '/?start=5'
+      end
+      let(:expected) { %q!{"finish"=>20, "start"=>"5"}! }
+      it { should == expected }
+      context "Given extra parameters too" do
+        before do
+          get '/?unit=seconds&type=race&start=5'
+        end
+        let(:expected) { 
+          %q!{"finish"=>20, "start"=>"5", "type"=>"race", "unit"=>"seconds"}!
+        }
+        it { should == expected }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+require 'rspec'
+require "rack/test"
+
+# code coverage
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/vendor/"
+  add_filter "/bin/"
+end
+
+ENV['RACK_ENV'] ||= 'test'
+ENV["EXPECT_WITH"] ||= "racktest"
+
+
+Spec_dir = File.expand_path( File.dirname __FILE__ )
+
+
+Dir[ File.join( Spec_dir, "/support/**/*.rb")].each do |f|
+  require f
+end
+
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true  
+end

data/spec/support/shared/all_routes.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+require 'sinatra/base'
+require_relative "../../../lib/sinatra/default_parameters.rb"
+# require_relative "./helpers.rb"
+
+require_relative "../../../examples/app.rb"
+
+shared_context "All pages" do
+  include Rack::Test::Methods
+  let(:app){ Example }
+  #include MODULE::RSpec::Helpers
+end
+
+shared_examples_for "Any route" do
+  subject { last_response }
+  it { should be_ok }
+end

data/spec/support/shared/helpers.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+module MODULE
+  module RSpec
+    module Helpers
+    
+#       def blah( ... )
+#         
+#       end
+      
+    end # Helpers
+  end # RSpec
+end # Midas

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-default_parameters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Iain Barnett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: A quick and simple way to set defaults for the params helper on a per
+  route basis.
+email:
+- iainspeed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENCE
+- README.md
+- Rakefile
+- examples/app.rb
+- examples/config.ru
+- lib/sinatra/default_parameters.rb
+- lib/sinatra/default_parameters/version.rb
+- sinatra-default_parameters.gemspec
+- spec/default_parameters_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared/all_routes.rb
+- spec/support/shared/helpers.rb
+homepage: https://github.com/yb66/sinatra-default_parameters
+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.25
+signing_key: 
+specification_version: 3
+summary: Extends the request context with a helper to give a quick and simple way
+  to set defaults for the params helper on a per route basis.
+test_files:
+- spec/default_parameters_spec.rb
+- spec/spec_helper.rb
+- spec/support/shared/all_routes.rb
+- spec/support/shared/helpers.rb