tiny-rack-flash 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGNiNmE4NjQ3MmY3YTFmYjljN2U5OTFjOTY3ZWY2N2VkMTI2OGIxYg==
+  data.tar.gz: !binary |-
+    OGZlYTkzOWZiMmE0N2U0MjM5MjVmODFjOWRjM2QyMzVkY2Q4ZGY5MA==
+SHA512:
+  metadata.gz: !binary |-
+    ODBkNzZmZjYwODliZWUwMTY1YjY3YWUzZDU2ZDUxOThmODgyZTA5ODAwMGNi
+    NWZhNWU0ZDFiZmRkOTRkOGNmOGMwNmJjMjdmOWJkNTJhYTNlMzZlM2ZhMTFi
+    ZDZjY2UwM2Q0NDI1MWQ4NDMzNjU5OGUxYWIxMmQwMmFkY2Q4ZjM=
+  data.tar.gz: !binary |-
+    ZGU1Y2U3ZmVhNTc0MTYwMjE3NDYyYTA0MWI2NmI0YzgzMmQzNmI0YmRjNGNm
+    ZDFhOWQyOGM4N2QzYzNhZjRhMGE0MGJmZGEyNTA3NTg1OTM3MTNhYjhlYWMz
+    NDM4YzcwZWI5NTZjYTZhMDU5ZDAwZTllNzIyMzM2ZTQwYzk3NjQ=

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jacob Brown
+
+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,42 @@
+# TinyRackFlash
+
+A very small flash implementation for Rack apps
+
+Works well with Cuba, Sinatra, and others--
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tiny-rack-flash'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tiny-rack-flash
+
+## Usage
+
+Inside your main Rack class (e.g., `Sinatra::Base` or `Cuba`), simply add a
+
+    require 'tiny_rack_flash'
+    include TinyRackFlash
+
+The `include` will hook up some Rack middleware for rotating the flash and provide a `flash` method for use in your route handlers.
+
+See `tests.rb` for examples.
+
+## Notes
+
+This gem's `FlashHash` implementation is taken from Stephen Eley's `FlashHash` implementation at https://github.com/SFEley/sinatra-flash.
+
+## 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,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = ['tests.rb']
+  t.verbose = true
+end

data/lib/tiny_rack_flash.rb

@@ -0,0 +1,72 @@
+require 'delegate'
+
+module TinyRackFlash
+  
+  FlashKey   = 'tiny.rack.flash'.freeze
+  SessionKey = 'rack.session'.freeze
+  
+  # This FlashHash implmentation is taken from Stephen Eley's work
+  # at https://github.com/SFEley/sinatra-flash/blob/master/lib/sinatra/flash/hash.rb
+  # which in turn is heavily inspired by ActionDispatch::Flash::FlashHash
+  # at https://github.com/rails/rails/blob/master/actionpack/lib/action_dispatch/middleware/flash.rb
+
+  class FlashHash < DelegateClass(Hash)
+    attr_reader :now, :next
+    def initialize(session)
+      @now = session || Hash.new
+      @next = Hash.new
+      super(@now)
+    end
+
+    def []=(key, value)
+      self.next[key] = value
+    end
+
+    def sweep
+      @now.replace(@next)
+      @next = Hash.new
+      @now
+    end
+
+    def keep(key=nil)
+      if key
+        @next[key] = @now[key]
+      else
+        @next.merge!(@now)
+      end
+    end
+    
+    def discard(key=nil)
+      if key
+        @next.delete(key)
+      else
+        @next = Hash.new
+      end
+    end
+  end
+
+  def flash
+    env[FlashKey] ||= begin
+      session = env[SessionKey]
+      FlashHash.new((session ? session[FlashKey] : {}))
+    end
+  end
+
+  class Middleware
+  
+    def initialize(app, opts={})
+      @app, @opts = app, opts
+    end
+    
+    def call(env)
+      res = @app.call(env)
+      env[SessionKey][FlashKey] = env[FlashKey].next if env[FlashKey]
+      res
+    end
+    
+  end
+
+  def self.included(app); app.use Middleware; end
+
+
+end

data/tests.rb

@@ -0,0 +1,86 @@
+require 'minitest'
+require 'minitest/autorun'
+
+require 'tiny_rack_flash'
+require 'rack'
+require 'rack/test'
+
+require 'sinatra/base'
+require "cuba"
+
+class SinatraApp < Sinatra::Base
+  
+  include TinyRackFlash
+  set :sessions, true
+
+  get '/' do
+    flash[:success] = 'success'
+    redirect '/redirect'
+  end
+
+  get '/redirect' do
+    flash[:success]
+  end
+
+  get '/show_now' do
+    flash.now[:success] = 'ready'
+    flash[:success]
+  end
+end
+
+class CubaApp < Cuba
+
+  use Rack::Session::Cookie, secret: "__a_very_long_string__"
+  include TinyRackFlash
+
+  define do
+    on root do
+      flash[:success] = 'success'
+      res.redirect '/redirect'
+    end
+
+    on 'redirect' do
+      res.write flash[:success]
+    end
+
+    on 'show_now' do
+      flash.now[:success] = 'ready'
+      res.write flash[:success]
+    end
+  end
+
+end
+
+class TinyRackFlashTest < Minitest::Test
+  
+  include Rack::Test::Methods
+
+  module Common
+    def test_shows_flash_when_appropriate
+      get '/'
+      follow_redirect!
+      assert_equal('success', last_response.body)
+    end
+
+    def test_not_shows_flash_when_appropriate
+      get '/redirect'
+      assert_equal('', last_response.body)
+    end
+
+    def test_shows_flash_now_when_appropriate
+      get '/show_now'
+      assert_equal('ready', last_response.body)
+    end
+  end
+
+  class SinatraAppTest < self
+    def app; SinatraApp; end
+    include Common
+  end
+
+  class CubaAppTest < self
+    def app; CubaApp; end
+    include Common
+  end
+
+end

data/tiny-rack-flash.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "tiny-rack-flash"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Jacob Brown"]
+  spec.email         = ["j.h.brown@tcu.edu"]
+  spec.description   = %q{ A tiny flash implementation for Rack apps }
+  spec.summary       = spec.description
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = []
+  spec.test_files    = ['tests.rb']
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rack"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "cuba"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: tiny-rack-flash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jacob Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cuba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! ' A tiny flash implementation for Rack apps '
+email:
+- j.h.brown@tcu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tiny_rack_flash.rb
+- tests.rb
+- tiny-rack-flash.gemspec
+homepage: ''
+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.1
+signing_key: 
+specification_version: 4
+summary: A tiny flash implementation for Rack apps
+test_files:
+- tests.rb