test_session_manager 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13e1784c029e1b5e47f9ebcb37f2e3256834583f
+  data.tar.gz: 4fd59a7702e8b2ca7ed26d77dc32c9e6c5e3add3
+SHA512:
+  metadata.gz: 8da626a35382af89bed41b55e2f2826b1f812cda59155fa6e0ab987593337ad0c8828607cd9afce0fb929718d8e0d9abe791ed2c7b07b20986ca6e56f592e397
+  data.tar.gz: 8794464d99956b7e3a0a7941ed973c893d8aa0f11cd1b59b1a1ea0a9453e115e99a2065ccf653fe2841e76f8cf4e475755bf465521b6ec9c624ca0f40fd80a92

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,128 @@
+PATH
+  remote: .
+  specs:
+    test_session_manager (1.0.0)
+      rails (>= 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.1)
+      actionpack (= 5.2.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.1)
+      actionview (= 5.2.1)
+      activesupport (= 5.2.1)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.1)
+      activesupport (= 5.2.1)
+      globalid (>= 0.3.6)
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activerecord (5.2.1)
+      activemodel (= 5.2.1)
+      activesupport (= 5.2.1)
+      arel (>= 9.0)
+    activestorage (5.2.1)
+      actionpack (= 5.2.1)
+      activerecord (= 5.2.1)
+      marcel (~> 0.3.1)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    erubi (1.7.1)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.2)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.0)
+    mimemagic (0.3.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.5)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.1)
+      actioncable (= 5.2.1)
+      actionmailer (= 5.2.1)
+      actionpack (= 5.2.1)
+      actionview (= 5.2.1)
+      activejob (= 5.2.1)
+      activemodel (= 5.2.1)
+      activerecord (= 5.2.1)
+      activestorage (= 5.2.1)
+      activesupport (= 5.2.1)
+      bundler (>= 1.3.0)
+      railties (= 5.2.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.1)
+      actionpack (= 5.2.1)
+      activesupport (= 5.2.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.1)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest
+  rack-test
+  rake
+  test_session_manager!
+
+BUNDLED WITH
+   1.16.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Jamis Buck
+
+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,61 @@
+# Test Session Manager
+
+Have you ever wanted to inject session information into a request in your Rails tests? Sure, best practices recommend you do so by first making a request to a resource that sets the desired session information for you, but sometimes...well, sometimes you just want a shortcut.
+
+That's what the Test Session Manager gem does for you: lets your tests specify the contents of the session explicitly before making a request.
+
+
+## Installation, Configuration, and Usage
+
+Add the "test_session_manager" gem to your Gemfile:
+
+```ruby
+group :test
+  gem 'test_session_manager'
+end
+```
+
+Add the Test Session Manager middleware to `config/application.rb`:
+
+```ruby
+if Rails.env.test?
+  # initialize the manager that your tests will use
+  manager = TestSessionManager.new
+
+  # set it in your application's config, so your tests can find it
+  config.test_session_manager = manager
+
+  # install the middleware
+  config.middleware.use TestSessionManager::Middleware, manager
+end
+```
+
+Add a minimal helper to your tests:
+
+```ruby
+class ActiveSupport::TestCase
+  # ...
+
+  def next_request
+    Rails.application.config.test_session_manager
+  end
+end
+```
+
+Then, use the `next_request` helper to set session and flash values in your tests!
+
+```ruby
+  test 'show that session and flash can be set in tests' do
+    next_request.flash[:error] = "Something died!"
+    next_request.session[:favorite_color] = "green"
+
+    get '/path/to/test'
+    assert_select '.alert-error', 'Something died!'
+    assert_select '.favorite-color', 'green'
+  end
+```
+
+## License
+
+BulkInsert is released under the MIT license (see MIT-LICENSE) by
+Jamis Buck (jamis@jamisbuck.org).

data/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+task default: :test

data/lib/test_session_manager.rb

@@ -0,0 +1,14 @@
+require 'test_session_manager/middleware'
+
+class TestSessionManager
+  attr_reader :flash, :session
+
+  def initialize
+    reset!
+  end
+
+  def reset!
+    @flash = {}
+    @session = {}
+  end
+end

data/lib/test_session_manager/middleware.rb

@@ -0,0 +1,36 @@
+require 'action_dispatch/middleware/flash'
+
+class TestSessionManager
+  class Middleware
+    def initialize(app, manager)
+      @app = app
+      @manager = manager
+    end
+
+    def call(env)
+      session = env['rack.session']
+
+      if @manager.flash.any?
+        flash = flash_from_session(session['flash'])
+        flash.update(@manager.flash)
+        session['flash'] = flash.to_session_value
+      end
+
+      @manager.session.each do |key, value|
+        session[key] = value
+      end
+
+      @manager.reset!
+
+      @app.call(env)
+    end
+
+    def flash_from_session(value)
+      if value.is_a?(Hash)
+        ActionDispatch::Flash::FlashHash.new(value['flashes'], value['discard'] || [])
+      else
+        ActionDispatch::Flash::FlashHash.new
+      end
+    end
+  end
+end

data/lib/test_session_manager/version.rb

@@ -0,0 +1,5 @@
+class TestSessionManager
+  module Version
+    STRING = "1.0.0"
+  end
+end

data/test/middleware_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+class MiddlewareTest < ActiveSupport::TestCase
+  setup do
+    @app = ->(env) { :done }
+    @session = {}
+    @env = { 'rack.session' => @session }
+
+    @manager = TestSessionManager.new
+    @middleware = TestSessionManager::Middleware.new(@app, @manager)
+  end
+
+  test 'middleware with no manager data added' do
+    assert @manager.flash.empty?
+    assert @manager.session.empty?
+
+    assert @session['flash'].blank?
+    assert @session['session'].blank?
+
+    @middleware.call(@env)
+
+    assert @session['flash'].blank?
+    assert @session['session'].blank?
+  end
+
+  test 'middleware adds session values' do
+    @manager.session['first'] = '1st'
+    @manager.session['second'] = '2nd'
+
+    @middleware.call(@env)
+
+    assert_equal '1st', @session['first']
+    assert_equal '2nd', @session['second']
+  end
+
+  test 'middleware adds flash values' do
+    @manager.flash['first'] = '1st'
+    @manager.flash['second'] = '2nd'
+
+    @middleware.call(@env)
+
+    assert_equal({ 'flashes' => { 'first' => '1st', 'second' => '2nd' }, 'discard' => [] }, @session['flash'])
+  end
+
+  test 'middleware preserves existing flash values' do
+    @session['flash'] = { 'flashes' => { 'original' => 'keep', 'old' => 'lose' }, 'discard' => [ 'old' ] }
+
+    @manager.flash['first'] = '1st'
+    @manager.flash['second'] = '2nd'
+
+    @middleware.call(@env)
+
+    assert_equal({ 'flashes' => { 'original' => 'keep', 'first' => '1st', 'second' => '2nd' }, 'discard' => [] }, @session['flash'])
+  end
+
+  test 'middleware resets manager on each request' do
+    @manager.session['a'] = 'b'
+    @manager.flash['b'] = 'a'
+
+    @middleware.call(@env)
+
+    assert @manager.session.blank?
+    assert @manager.flash.blank?
+  end
+end

data/test/session_manager_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class SessionManagerTest < ActiveSupport::TestCase
+  setup do
+    @manager = TestSessionManager.new
+  end
+
+  test 'test session manager starts with empty hashes' do
+    assert @manager.flash.empty?
+    assert @manager.session.empty?
+  end
+
+  test 'reset! removes all values from hashes' do
+    @manager.flash[:a] = "something"
+    @manager.session[:b] = "something"
+
+    refute @manager.flash.empty?
+    refute @manager.session.empty?
+
+    @manager.reset!
+
+    assert @manager.flash.empty?
+    assert @manager.session.empty?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'active_support'
+require 'rack/test'
+
+require 'test_session_manager'

data/test_session_manager.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "test_session_manager/version"
+
+Gem::Specification.new do |gem|
+  gem.version     = TestSessionManager::Version::STRING
+  gem.name        = "test_session_manager"
+  gem.authors     = ["Jamis Buck"]
+  gem.email       = ["jamis@jamisbuck.org"]
+  gem.homepage    = "http://github.com/jamis/test-session-manager"
+  gem.summary     = "Inject session data into test requests"
+  gem.description = "Allow tests for Rails applications to inject session data (including flash) into test requests"
+  gem.license     = 'MIT'
+
+  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/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rails", ">= 4.0"
+
+  ##
+  # Development dependencies
+  #
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "rack-test"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: test_session_manager
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jamis Buck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.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: 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'
+description: Allow tests for Rails applications to inject session data (including
+  flash) into test requests
+email:
+- jamis@jamisbuck.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/test_session_manager.rb
+- lib/test_session_manager/middleware.rb
+- lib/test_session_manager/version.rb
+- test/middleware_test.rb
+- test/session_manager_test.rb
+- test/test_helper.rb
+- test_session_manager.gemspec
+homepage: http://github.com/jamis/test-session-manager
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Inject session data into test requests
+test_files:
+- test/middleware_test.rb
+- test/session_manager_test.rb
+- test/test_helper.rb