sinatra-redirect-with-flash 0.1.1

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2009 Vasily Polovnyov
+
+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,44 @@
+#Sinatra Extension: redirect with flash
+
+Shortly: sinatra-redirect-with-flash provides `redirect` helper that can set proper flash (rack-flash) before the
+  redirection
+
+In fact, every time you set a flash parameter the very next step is often to perform your redirect:
+
+    post '/posts/?' do
+      @post = Post.new(params)
+      flash[:notice] = 'The post was successfully created'
+      redirect "/posts/#{@post.id}"
+    end
+
+With sinatra-redirect-with-flash you can do one-line redirects. For instance, to rewrite the above example:
+
+    post '/posts/?' do
+      @post = Post.new(params)
+      redirect "/posts/#{@post.id}", :notice => 'The post was successfully created'
+    end
+
+##Example
+    require 'rubygems'
+    require 'sinatra'
+    require 'rack-flash'
+    gem 'sinatra-redirect-with-flash'
+    require 'sinatra/redirect_with_flash'
+
+    use Rack::Flash
+    enable :sessions
+
+    post '/sessions/new' do
+      redirect '/secret', :notice => 'Logged in' #predefined keys are: :notice, :error, :warning, :alert, :info      
+    end
+
+    get '/foo' do
+      redirect '/bar', 301, :notice => 'redirect with 301 code'
+    end
+
+    get '/archive' do
+      redirect '/posts/', :flash => {:my_msg => 'Moving on!'}      
+    end
+
+##Requirements
+  * [rack-flash](http://nakajima.github.com/rack-flash/)

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake/testtask'
+require 'rake/gempackagetask'
+
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "sinatra-redirect-with-flash"
+    gemspec.version = "0.1.1"
+    gemspec.summary = gemspec.description = "redirect with flash helper for Sinatra"
+    gemspec.email = "vasily@polovnyov.ru"
+    gemspec.homepage = "http://github.com/vast/sinatra-redirect-with-flash"
+    gemspec.authors = ["Vasily Polovnyov"]
+
+    gemspec.add_dependency 'sinatra', '>=0.9.1'
+    gemspec.add_dependency 'rack', '>=0.9.1'
+    gemspec.add_dependency 'rack-flash', '>=0.1.1'
+
+    gemspec.add_development_dependency 'rack-test', '>=0.3.0'
+
+    gemspec.test_files = Dir.glob('test/*')
+    gemspec.files = ["LICENSE", "README.md", "Rakefile"] + Dir.glob('lib/**/*') + gemspec.test_files
+
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/lib/sinatra/redirect_with_flash.rb

@@ -0,0 +1,28 @@
+require 'sinatra/base'
+
+module Sinatra
+  module RedirectWithFlash
+    COMMON_FLASH_NAMES = [:notice, :alert, :warning, :error, :info]
+    
+    def redirect(uri, *args)
+      flash_opts = args.last
+      
+      if flash_opts && flash_opts.is_a?(Hash)
+        COMMON_FLASH_NAMES.each do |name|
+          if val = flash_opts.delete(name)
+            flash[name] = val
+          end
+        end
+        
+        if other_flashes = flash_opts.delete(:flash)
+          other_flashes.each {|k, v| flash[k] = v}
+        end
+      end
+
+      super(uri, *args)
+    end
+
+  end
+
+  helpers RedirectWithFlash
+end

data/test/sinatra_app.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'sinatra'
+require 'rack-flash'
+require 'lib/sinatra/redirect_with_flash'
+
+use Rack::Flash
+
+get '/' do
+  redirect '/fff', :flash => {:info => 'sample info'}
+end
+
+[:notice, :error, :warning, :alert].each do |k|
+  get "/#{k.to_s}" do
+    redirect '/fff', k => "sample #{k.to_s}"
+  end
+end
+
+get '/notice-with-code' do
+  redirect '/fff', 301, :notice => '301 and notice'
+end
+
+get '/old-school-redirect' do
+  redirect '/aaa'
+end
+
+get '/old-school-redirect-with-code' do
+  redirect '/aaa', 301
+end

data/test/sinatra_redirect_with_flash_test.rb

@@ -0,0 +1,57 @@
+require 'sinatra_app'
+require 'test/unit'
+require 'rack/test'
+require 'rack/flash/test'
+
+set :environment, :test
+
+class SinatraRedirectWithFlashTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+
+  def flash
+    last_request.env['x-rack.flash']
+  end
+
+  def test_redirect_with_custom_flash_opts
+    get '/'
+    assert_not_nil flash
+    assert_equal "sample info", flash[:info]
+  end
+
+  def test_common_flash_names
+    [:notice, :error, :warning, :alert].each do |k|
+      get "/#{k.to_s}"
+      assert_not_nil flash
+      assert_equal "sample #{k.to_s}", flash[k]
+    end
+  end
+
+  def test_redirect_with_code_and_flash
+    get '/notice-with-code'
+    assert_not_nil flash
+    assert_equal flash[:notice], '301 and notice'
+
+    assert_equal last_response.status, 301
+    assert_equal last_response.body, ''
+    assert_equal last_response.headers['Location'], '/fff'
+  end
+
+  def test_old_school_redirect
+    get '/old-school-redirect'
+    assert_equal last_response.status, 302
+    assert_equal last_response.body, ''
+    assert_equal last_response.headers['Location'], '/aaa'
+  end
+
+  def test_old_school_redirect_with_code
+    get '/old-school-redirect-with-code'
+    assert_equal last_response.status, 301
+    assert_equal last_response.body, ''
+    assert_equal last_response.headers['Location'], '/aaa'
+  end
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-redirect-with-flash
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Vasily Polovnyov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-28 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-flash
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+description: redirect with flash helper for Sinatra
+email: vasily@polovnyov.ru
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/redirect_with_flash.rb
+- test/sinatra_app.rb
+- test/sinatra_redirect_with_flash_test.rb
+has_rdoc: true
+homepage: http://github.com/vast/sinatra-redirect-with-flash
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: redirect with flash helper for Sinatra
+test_files: 
+- test/sinatra_redirect_with_flash_test.rb
+- test/sinatra_app.rb