rails_4_session_flash_backport 0.0.1

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,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_4_session_flash_backport.gemspec
+gemspec
+
+group :development do
+  gem "rspec"
+  gem "actionpack", ENV["ACTIONPACK_VERSION"] || "3.2.9"
+  gem "pry"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Envato, Lucas Parry, Jack Chen (chendo)
+
+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,49 @@
+# Rails4SessionFlashBackport
+
+Different versions of Rails have stored flash messages in different objects in
+the session, making it a pain to upgrade without nuking everyones session. The
+good ol' `ActionDispatch::Session::SessionRestoreError` making life difficult.
+
+This gem was created because we wanted to be able to keep our users Rails 2
+sessions working on Rails 3, and we figured as long as we're going to be doing
+crazy stuff we might as well go and use the far more sensible practice from
+Rails 4 of storing the flash as basic ruby types.
+
+When using this gem on a Rails 2 or 3 app:
+
+ - Flash messages are stored as basic objects in the Rails 4 style.
+ - Flash messages in the Rails 2 format can be successfully decoded.
+ - Flash messages in the Rails 3 format can be successfully decoded.
+ - Flash messages in the Rails 4 format can be successfully decoded.
+
+Additionally, on Rails 2 we include some patches for the SessionHash and
+CookieStore, in order to make them act more like their
+HashWithIndifferentAccess versions on Rails 3, so that your session_id can
+survive a trip to Rails 3 and back.
+
+This actually makes it possible to bounce requests from a Rails 2 server, to a
+Rails 3 server and back again so long as both servers are using this gem. Very
+helpful when you're doing a big Rails 2 => 3 upgrade and want to run a few
+Rails 3 servers concurrently with your Rails 2 cluster to verify everything is
+fine and performance is acceptable without
+having to do the all-in switch.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_4_session_flash_backport'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_4_session_flash_backport
+
+Copyright
+---------
+
+Copyright (c) 2012 [Envato](http://envato.com), [Lucas Parry](http://github.com/lparry), [chendo](http://github.com/chendo). See LICENSE.txt for further details.
+

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+
+namespace :spec do
+  task :rails3 do
+    system "export ACTIONPACK_VERSION=3.2.9 && bundle check > /dev/null || bundle update"
+    puts "Running Rails 3 specs"
+    system "export ACTIONPACK_VERSION=3.2.9 && bundle exec rspec --color spec/rails3"
+    puts ""
+  end
+
+  task :rails2 do
+    system "export ACTIONPACK_VERSION=2.3.14 && bundle check > /dev/null || bundle update"
+    puts "Running Rails 2 specs"
+    system "export ACTIONPACK_VERSION=2.3.14 && bundle exec rspec --color spec/rails2"
+    puts ""
+  end
+end
+
+task :spec => ["spec:rails2", "spec:rails3"]

data/lib/rails_4_session_flash_backport/rails2/flash_hash.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+require 'action_controller/flash'
+require 'action_controller/test_process'
+# Backport Rails 4 style storing the flash as basic ruby types to Rails 2
+module ActionController #:nodoc:
+  module Flash
+    class FlashHash
+      def self.from_session_value(value)
+        flash = case value
+                when FlashHash # Rails 2.3
+                  value
+                when ::ActionDispatch::Flash::FlashHash # Rails 3.2
+                  flashes = value.instance_variable_get(:@flashes) || {}
+                  used_set = value.instance_variable_get(:@used) || []
+                  used = Hash[flashes.keys.map{|k| [k, used_set.include?(k)] }]
+                  new_from_values(flashes, used)
+                when Hash # Rails 4.0
+                  flashes = value['flashes'] || {}
+                  discard = value['discard']
+                  used = Hash[flashes.keys.map{|k| [k, discard.include?(k)] }]
+
+                  new_from_values(flashes, used)
+                else
+                  new
+                end
+        flash
+      end
+
+      def to_session_value
+        return nil if empty?
+        rails_3_discard_list = @used.map{|k,v| k if v}.compact
+        {'discard' => rails_3_discard_list, 'flashes' => Hash[to_a]}
+      end
+
+      def store(session, key = "flash")
+        session[key] = to_session_value
+      end
+
+      private
+
+      def self.new_from_values(flashes, used)
+        new.tap do |flash_hash|
+          flashes.each do |k, v|
+            flash_hash[k] = v
+          end
+          flash_hash.instance_variable_set("@used", used)
+        end
+      end
+    end
+
+    module InstanceMethods #:nodoc:
+      protected
+      def flash #:doc:
+        if !defined?(@_flash)
+          @_flash = Flash::FlashHash.from_session_value(session["flash"])
+          @_flash.sweep
+        end
+
+        @_flash
+      end
+    end
+  end
+  module TestResponseBehavior #:nodoc:
+    # A shortcut to the flash. Returns an empty hash if no session flash exists.
+    def flash
+      ActionController::Flash::FlashHash.from_session_value(session["flash"]) || {}
+    end
+  end
+end
+
+# This magic here allows us to unmarshal a Rails 3.2 ActionDispatch::Flash::FlashHash
+module ActionDispatch
+  class Flash
+    class FlashHash
+      def self._load(args)
+        {}
+      end
+    end
+  end
+end

data/lib/rails_4_session_flash_backport/rails2/session_with_indifferent_access.rb

@@ -0,0 +1,65 @@
+# The SessionHash is a HashWithIndifferentAccess on Rails 3, which causes
+# problems with the session_id among other things. On Rails 2 the session_id is
+# stored as session[:session_id], if we take that session to Rails 3 it becomes
+# session["session_id"], and if we bring it back to Rails 2 it's still
+# session["session_id"], but Rails checks session[:session_id], finds nothing
+# and generates a new one. This is unacceptable.
+#
+# We've patched the SessionHash to #to_s keys before it stores them, and to
+# fall back from the string key to the symbol if needed.
+module ActionController::Session
+  class AbstractStore
+    class SessionHash < Hash
+        def [](key)
+          load! unless @loaded
+          super(key.to_s) || super(key)
+        end
+
+        def has_key?(key)
+          load! unless @loaded
+          super(key.to_s) || super(key)
+        end
+
+        def []=(key, value)
+          load! unless @loaded
+          super(key.to_s, value)
+        end
+    end
+  end
+end
+
+# We've also had to patch the cookie store, to make it use for the string
+# version of "session_id", again falling back to the symbol if needed.
+module ActionController
+  module Session
+    class CookieStore
+        def load_session(env)
+          data = unpacked_cookie_data(env)
+          data = persistent_session_id!(data)
+          [data["session_id"] || data[:session_id], data]
+        end
+
+        def extract_session_id(env)
+          if data = unpacked_cookie_data(env)
+            persistent_session_id!(data) unless data.empty?
+            data["session_id"] || data[:session_id]
+          else
+            nil
+          end
+        end
+
+        def inject_persistent_session_id(data)
+          requires_session_id?(data) ? { "session_id" => generate_sid } : {}
+        end
+
+        def requires_session_id?(data)
+          if data
+            data.respond_to?(:key?) && !(data.key?("session_id") || data.key?(:session_id))
+          else
+            true
+          end
+        end
+    end
+  end
+end
+

data/lib/rails_4_session_flash_backport/rails3/flash_hash.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+require 'action_dispatch/middleware/flash'
+# Backport Rails 4 style storing the flash as basic ruby types to Rails 3
+module ActionDispatch
+  class Request < Rack::Request
+    def flash
+      @env[Flash::KEY] ||= Flash::FlashHash.from_session_value(session["flash"]).tap(&:sweep)
+    end
+  end
+  class Flash
+    class FlashHash
+
+      def self.from_session_value(value)
+        case value
+        when ::ActionController::Flash::FlashHash # Rails 2.x
+          new(value, value.instance_variable_get(:@used).select{|a,b| b}.keys)
+        when ::ActionDispatch::Flash::FlashHash # Rails 3.1, 3.2
+          new(value.instance_variable_get(:@flashes), value.instance_variable_get(:@used))
+        when Hash # Rails 4.0, we backported to 2.3 too
+          new(value['flashes'], value['discard'])
+        else
+          new
+        end
+      end
+
+      def to_session_value
+        return nil if empty?
+        {'discard' => @used.to_a, 'flashes' => @flashes}
+      end
+
+      def initialize(flashes = {}, discard = []) #:nodoc:
+        @used    = Set.new(discard)
+        @closed  = false
+        @flashes = flashes
+        @now     = nil
+      end
+
+    end
+
+    def call(env)
+      @app.call(env)
+    ensure
+      session    = env['rack.session'] || {}
+      flash_hash = env[KEY]
+
+      if flash_hash
+        if !flash_hash.empty? || session.key?('flash')
+          session["flash"] = flash_hash.to_session_value
+          new_hash = flash_hash.dup
+        else
+          new_hash = flash_hash
+        end
+
+        env[KEY] = new_hash
+      end
+
+      if session.key?('flash') && session['flash'].nil?
+        session.delete('flash')
+      end
+    end
+  end
+end
+
+# This magic here allows us to unmarshal the old Rails 2.x ActionController::Flash::FlashHash
+module ActionController
+  module Flash
+    class FlashHash < Hash
+
+      def self._load(args)
+        {}
+      end
+    end
+  end
+end

data/lib/rails_4_session_flash_backport/version.rb

@@ -0,0 +1,3 @@
+module Rails4SessionFlashBackport
+  VERSION = "0.0.1"
+end

data/lib/rails_4_session_flash_backport.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+require "rails_4_session_flash_backport/version"
+
+case Rails.version.to_i
+when 2
+  require 'rails_4_session_flash_backport/rails2/flash_hash'
+  require 'rails_4_session_flash_backport/rails2/session_with_indifferent_access'
+when 3
+  require 'rails_4_session_flash_backport/rails3/flash_hash'
+when 4
+  Rails.logger.warn "You're on Rails 4 so it's probably safe to remove the rails_4_session_flash_backport gem!"
+else
+  Rails.logger.warn "rails_4_session_flash_backport doesnt yet do anything on Rails #{Rails.version}"
+end

data/rails_4_session_flash_backport.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_4_session_flash_backport/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rails_4_session_flash_backport"
+  gem.version       = Rails4SessionFlashBackport::VERSION
+  gem.authors       = ["Lucas Parry"]
+  gem.email         = ["lparry@gmail.com"]
+  gem.description   = %q{Store flash in the session in Rails 4 style on Rails 2/3}
+  gem.summary       = %q{Backport of the way Rails 4 stores flash messages in the session to Rails 2 & 3, so you can safely take a session betweens Rails versions without things exploding.}
+  gem.homepage      = ""
+
+  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"]
+end

data/spec/rails2/flash_hash_spec.rb

@@ -0,0 +1,45 @@
+require 'action_controller'
+require 'rails_4_session_flash_backport/rails2/flash_hash'
+
+describe ActionController::Flash::FlashHash, "hax" do
+
+  let(:rails_2_marshaled) { "\x04\bIC:'ActionController::Flash::FlashHash{\a:\vnoticeI\"\x11I'm a notice\x06:\x06ET:\nerrorI\"\x11I'm an error\x06;\aT\x06:\n@used{\a;\x06T;\bF" }
+  let(:rails_3_marshaled) { "\x04\bo:%ActionDispatch::Flash::FlashHash\t:\n@usedo:\bSet\x06:\n@hash{\x06:\vnoticeT:\f@closedF:\r@flashes{\a;\tI\"\x11I'm a notice\x06:\x06EF:\nerrorI\"\x11I'm an error\x06;\fF:\t@now0" }
+  let(:rails_2_vanilla)   { Marshal.load(rails_2_marshaled) }
+  let(:rails_3_vanilla)   { Marshal.load(rails_3_marshaled) }
+  let(:rails_4_style)     { {'flashes' => {:notice => "I'm a notice", :error => "I'm an error"}, 'discard' => [:notice]} }
+
+   it "happily unmarshals a Rails 3 session without exploding" do
+     Marshal.load(rails_3_marshaled).should be_a(ActionDispatch::Flash::FlashHash)
+   end
+
+   context "#to_session_value" do
+     it "dumps to basic objects like rails 4" do
+       rails_2_vanilla.to_session_value.should be_a(Hash)
+       rails_2_vanilla.to_session_value.should == rails_4_style
+     end
+   end
+
+  context "#from_session_value" do
+    def this_is_the_flash_hash_were_looking_for(flash_hash)
+      flash_hash.should be_a(described_class)
+      flash_hash[:notice].should == "I'm a notice"
+      flash_hash[:error].should == "I'm an error"
+      flash_hash.sweep
+      flash_hash[:notice].should be_nil
+      flash_hash[:error].should == "I'm an error"
+    end
+
+    it "decodes rails 2 style to an empty FlashHash" do
+      this_is_the_flash_hash_were_looking_for(ActionController::Flash::FlashHash.from_session_value(rails_2_vanilla))
+    end
+
+    it "decodes rails 3 style to a FlashHash" do
+      this_is_the_flash_hash_were_looking_for(ActionController::Flash::FlashHash.from_session_value(rails_3_vanilla))
+    end
+
+    it "decodes rails 4 style to a FlashHash" do
+      this_is_the_flash_hash_were_looking_for(ActionController::Flash::FlashHash.from_session_value(rails_4_style))
+    end
+  end
+end

data/spec/rails3/flash_hash_spec.rb

@@ -0,0 +1,48 @@
+require 'action_dispatch'
+require 'rails_4_session_flash_backport/rails3/flash_hash'
+
+describe ActionDispatch::Flash::FlashHash, "hax" do
+
+  let(:rails_2_marshaled) { "\x04\bIC:'ActionController::Flash::FlashHash{\a:\vnoticeI\"\x11I'm a notice\x06:\x06ET:\nerrorI\"\x11I'm an error\x06;\aT\x06:\n@used{\a;\x06T;\bF" }
+  let(:rails_3_marshaled) { "\x04\bo:%ActionDispatch::Flash::FlashHash\t:\n@usedo:\bSet\x06:\n@hash{\x06:\vnoticeT:\f@closedF:\r@flashes{\a;\tI\"\x11I'm a notice\x06:\x06EF:\nerrorI\"\x11I'm an error\x06;\fF:\t@now0" }
+  let(:rails_2_vanilla)   { Marshal.load(rails_2_marshaled) }
+  let(:rails_3_vanilla)   { Marshal.load(rails_3_marshaled) }
+  let(:rails_4_style)     { {'flashes' => {:notice => "I'm a notice", :error => "I'm an error"}, 'discard' => [:notice]} }
+  let(:rails_2_marshaled) { "\x04\bIC:'ActionController::Flash::FlashHash{\a:\vnoticeI\"\x11I'm a notice\x06:\x06ET:\nerrorI\"\x11I'm an error\x06;\aT\x06:\n@used{\a;\x06T;\bF" }
+  let(:rails_2_vanilla) { Marshal.load(rails_2_marshaled) }
+
+  it "happily unmarshals a Rails 2 session without exploding" do
+    Marshal.load(rails_2_marshaled).should be_a(ActionController::Flash::FlashHash)
+  end
+
+  context "#from_session_value" do
+    def this_is_the_flash_hash_were_looking_for(flash_hash)
+      flash_hash.should be_a(described_class)
+      flash_hash[:notice].should == "I'm a notice"
+      flash_hash[:error].should == "I'm an error"
+      flash_hash.sweep
+      flash_hash[:notice].should be_nil
+      flash_hash[:error].should == "I'm an error"
+    end
+
+    it "decodes rails 2 style to an empty FlashHash" do
+      this_is_the_flash_hash_were_looking_for(ActionDispatch::Flash::FlashHash.from_session_value(rails_2_vanilla))
+    end
+
+    it "decodes rails 3 style to a FlashHash" do
+      this_is_the_flash_hash_were_looking_for(ActionDispatch::Flash::FlashHash.from_session_value(rails_3_vanilla))
+    end
+
+    it "decodes rails 4 style to a FlashHash" do
+      this_is_the_flash_hash_were_looking_for(ActionDispatch::Flash::FlashHash.from_session_value(rails_4_style))
+    end
+  end
+
+  context "#to_session_value" do
+    it "dumps to basic objects like rails 4" do
+      rails_3_vanilla.to_session_value.should be_a(Hash)
+      rails_3_vanilla.to_session_value.should == rails_4_style
+    end
+  end
+
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: rails_4_session_flash_backport
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Lucas Parry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-16 00:00:00.000000000 Z
+dependencies: []
+description: Store flash in the session in Rails 4 style on Rails 2/3
+email:
+- lparry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_4_session_flash_backport.rb
+- lib/rails_4_session_flash_backport/rails2/flash_hash.rb
+- lib/rails_4_session_flash_backport/rails2/session_with_indifferent_access.rb
+- lib/rails_4_session_flash_backport/rails3/flash_hash.rb
+- lib/rails_4_session_flash_backport/version.rb
+- rails_4_session_flash_backport.gemspec
+- spec/rails2/flash_hash_spec.rb
+- spec/rails3/flash_hash_spec.rb
+homepage: ''
+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.23
+signing_key: 
+specification_version: 3
+summary: Backport of the way Rails 4 stores flash messages in the session to Rails
+  2 & 3, so you can safely take a session betweens Rails versions without things exploding.
+test_files:
+- spec/rails2/flash_hash_spec.rb
+- spec/rails3/flash_hash_spec.rb