action_controller_tweaks 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d18d5ac685043630bc71743acdbdfa01954ca26d
-  data.tar.gz: decb6e92a43ee69c13b753d1fe7ba350011aea9b
+SHA256:
+  metadata.gz: 46ff4fd39c8ca309d9b5b9cfa02a23c8130d76f5d30ab9dbc8ceb33b0cb4c1ad
+  data.tar.gz: 4f2980bd906c8ac50030a65cc7c9b8a11b6750160df4910e2c874be1b15a5b93
 SHA512:
-  metadata.gz: 218dc267dee725e8084a96c09ed05403ea2b6591a9b3ad438349f3584fe5499a635e6d46c204cd5f1731d3e01015bfc95fd639b41c04ce856b7d28acac7e404e
-  data.tar.gz: ffae98b515dd4d3ac1068c87e484e5b32b9cd47e8abbccfb5a780bf28e108879849c37a842ce654592d5ee52416b0fa33a7ec1b8a3140a1fbc6e3fdc87f02c1e
+  metadata.gz: 3d0b5b07c94c3929a4711454b417181fa6f8a7dd390a4a163ca30678e1e0b4f819cc875dcab351220ca6685a0a9ad29c6cbaf050b21ba44fb8bb243e5192275b
+  data.tar.gz: 171bfc5e77948a5a5552357d97ad647ddea9f89c091bf2eb062a9f250427bed1357ab4059a1e1104253f9bf6ebee9f09504b41c7e92004f4e672838bdd20f81c

data/.gitignore

@@ -1,2 +1,8 @@
-gemfiles/*.gemfile.lock
 Gemfile.lock
+# Ignore Coverage Report
+coverage/.last_run.json
+coverage/.resultset.json
+# Ignore Appraisal related files
+gemfiles/*.gemfile.lock
+pkg/*
+.idea/

data/.travis.yml

@@ -1,17 +1,24 @@
+# Send builds to container-based infrastructure
+# http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false
 language: ruby
 cache:
-- bundler
+  - bundler
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1
+  - 2.4
+  - 2.5
+  - 2.6
+  - ruby-head
 gemfile:
-  - gemfiles/rails3_2.gemfile
-  - gemfiles/rails4_0.gemfile
+  - gemfiles/rails_4_2.gemfile
+  - gemfiles/rails_5_0.gemfile
+  - gemfiles/rails_5_1.gemfile
+  - gemfiles/rails_5_2.gemfile
+  - gemfiles/rails_6_0.gemfile
 matrix:
+  fast_finish: true
   exclude:
-    - rvm: 1.9.2
-      gemfile: gemfiles/rails4_0.gemfile
-
+    - rvm: 2.4
+      gemfile: gemfiles/rails_6_0.gemfile
+  allow_failures:
+    - rvm: ruby-head

data/Appraisals

@@ -1,14 +1,42 @@
 
-appraise "rails3-2" do
-  version = "3.2.17"
-  gem 'activesupport', version
-  gem 'actionpack', version
-  gem 'activerecord', version
-end
-
-appraise "rails4-0" do
-  version = "4.0.3"
-  gem 'activesupport', version
-  gem 'actionpack', version
-  gem 'activerecord', version
+appraise "rails_4_2" do
+  version = "~> 4.2.0"
+  gem "activesupport", version
+  gem "actionpack", version
+  gem "activerecord", version
+  gem "railties", version
+  gem "sqlite3", "~> 1.3.6"
+end
+
+appraise "rails_5_0" do
+  version = "~> 5.0.0"
+  gem "activesupport", version
+  gem "actionpack", version
+  gem "activerecord", version
+  gem "railties", version
+  gem "sqlite3", "~> 1.3.6"
+end
+
+appraise "rails_5_1" do
+  version = "~> 5.1.0"
+  gem "activesupport", version
+  gem "actionpack", version
+  gem "activerecord", version
+  gem "railties", version
+end
+
+appraise "rails_5_2" do
+  version = "~> 5.2.0"
+  gem "activesupport", version
+  gem "actionpack", version
+  gem "activerecord", version
+  gem "railties", version
+end
+
+appraise "rails_6_0" do
+  version = "~> 6.0.0"
+  gem "activesupport", version
+  gem "actionpack", version
+  gem "activerecord", version
+  gem "railties", version
 end

data/CHANGELOG.md

@@ -1,15 +1,105 @@
-### Changelog
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
 
 
-- **0.3.0**
-  - Add method `#set_session_with_expiry`
-  - Add option `expires_in` and `expires_at` to #set_session
-  - Fix invalid header when using `#set_no_cache` for HTTP 1.0
-  - Raise error when reserved session key(s) is set through the provided method
+## [Unreleased]
 
-- **0.2.0**
-  - Add option `expire_at` to #set_session
-  - Use semantic versioning
+### Added
+
+- Nothing
+
+### Changed
+
+- Nothing
+
+### Fixed
+
+- Nothing
+
+
+## [0.3.5] - 2020-09-07
+
+### Fixed
+
+- Fix support for Rails 6.x
+
+
+## [0.3.4] - 2019-08-26
+
+### Changed
+
+- Add support for AR 6.x
+- Drop support for Ruby < 2.4
+
+
+## [0.3.3] - 2017-05-11
+
+### Changed
+
+- Add support for AR 5.1.x
+- Drop support for AR 4.0.x
+- Drop support for Ruby < 2.2
+
+
+## [0.3.2] - 2016-12-23
+
+### Changed
+
+- Call `before_action` on included class if exists
+- Add support for AR 5.0.x
+- Drop support for AR 3.x
+- Drop support for Ruby < 2.1
+
+### Fixed
+
+- Raise error if both `before_action` and `before_filter` does not exists
+
+
+## [0.3.1] - 2015-03-03
+
+### Fixed
+
+- Fix session key still gets deleted when no option is set
+- Fix options not passed to `#set_session` when `#set_session_with_expiry` is called
+
+
+## [0.3.0] - 2014-03-14
+
+### Added
+
+- Add method `#set_session_with_expiry`
+- Add option `expires_in` and `expires_at` to #set_session
+
+### Changed
+
+- Raise error when reserved session key(s) is set through the provided method
+
+### Fixed
+
+- Fix invalid header when using `#set_no_cache` for HTTP 1.0
+
+
+## [0.2.0] - 2014-01-17
+
+### Added
+
+- Add option `expire_at` to #set_session
+
+
+## 0.1 - 2013-08-30
+
+### Added
+
+- Initial Release
+
+
+[Unreleased]: https://github.com/PikachuEXE/action_controller_tweaks/compare/v0.3.5...HEAD
+[0.3.4]: https://github.com/PikachuEXE/action_controller_tweaks/compare/v0.3.4...v0.3.5
+[0.3.4]: https://github.com/PikachuEXE/action_controller_tweaks/compare/v0.3.3...v0.3.4
+[0.3.3]: https://github.com/PikachuEXE/action_controller_tweaks/compare/v0.3.2...v0.3.3
+[0.3.2]: https://github.com/PikachuEXE/action_controller_tweaks/compare/v0.3.1...v0.3.2
+[0.3.1]: https://github.com/PikachuEXE/action_controller_tweaks/compare/v0.3.0...v0.3.1
+[0.3.0]: https://github.com/PikachuEXE/action_controller_tweaks/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/PikachuEXE/action_controller_tweaks/compare/v0.1...v0.2.0
 
-- **0.1**
-  - Initial Release

data/Gemfile

@@ -1,2 +1,2 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec

data/README.md

@@ -1,29 +1,25 @@
-Action Controller Tweaks
-===========
+# Action Controller Tweaks
 
 ActionController is great, but could be better. Here are some tweaks for it.
 
-### Support
-===========
-Tested against:
-- Action Controller of version `3.2` and `4.0` (`3.1` and below got problem with buggy `rspec-rails`)
-- Ruby `1.9.2`, `1.9.3`, `2.0.0` (except Rails 4 with `1.9.2`)
 
-[![Build Status](http://img.shields.io/travis/PikachuEXE/action_controller_tweaks.svg)](https://travis-ci.org/PikachuEXE/action_controller_tweaks)
-[![Gem Version](http://img.shields.io/gem/v/action_controller_tweaks.svg)](http://badge.fury.io/rb/action_controller_tweaks)
-[![Dependency Status](http://img.shields.io/gemnasium/PikachuEXE/action_controller_tweaks.svg)](https://gemnasium.com/PikachuEXE/action_controller_tweaks)
-[![Coverage Status](http://img.shields.io/coveralls/PikachuEXE/action_controller_tweaks.svg)](https://coveralls.io/r/PikachuEXE/action_controller_tweaks)
-[![Code Climate](http://img.shields.io/codeclimate/github/PikachuEXE/action_controller_tweaks.svg)](https://codeclimate.com/github/PikachuEXE/action_controller_tweaks)
+## Status
 
-Install
-=======
+[![Build Status](http://img.shields.io/travis/PikachuEXE/action_controller_tweaks.svg?style=flat-square)](https://travis-ci.org/PikachuEXE/action_controller_tweaks)
+[![Gem Version](http://img.shields.io/gem/v/action_controller_tweaks.svg?style=flat-square)](http://badge.fury.io/rb/action_controller_tweaks)
+[![Dependency Status](http://img.shields.io/gemnasium/PikachuEXE/action_controller_tweaks.svg?style=flat-square)](https://gemnasium.com/PikachuEXE/action_controller_tweaks)
+[![Coverage Status](http://img.shields.io/coveralls/PikachuEXE/action_controller_tweaks.svg?style=flat-square)](https://coveralls.io/r/PikachuEXE/action_controller_tweaks)
+[![Code Climate](http://img.shields.io/codeclimate/github/PikachuEXE/action_controller_tweaks.svg?style=flat-square)](https://codeclimate.com/github/PikachuEXE/action_controller_tweaks)
+
+
+## Installation
 
 ```ruby
 gem 'action_controller_tweaks'
 ```
 
-Usage
-=====
+
+## Usage
 
 Either include it in specific controller or just `ApplicationController`
 ```ruby

data/Rakefile

@@ -8,8 +8,8 @@ RSpec::Core::RakeTask.new(:spec)
 
 if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
   task :default do
-    sh "rake appraisal:install && rake appraisal spec"
+    sh "appraisal install && rake appraisal spec"
   end
 else
-  task :default => :spec
+  task default: [:spec]
 end

data/action_controller_tweaks.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
 
 author_name = "PikachuEXE"
 gem_name = "action_controller_tweaks"
@@ -21,24 +21,28 @@ Gem::Specification.new do |s|
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "activesupport", ">= 3.2.0", "< 5.0.0"
-  s.add_dependency "actionpack", ">= 3.2.0", "< 5.0.0"
-
-
+  s.add_dependency "activesupport", ">= 4.1.0", "< 7.0.0"
+  s.add_dependency "actionpack", ">= 4.1.0", "< 7.0.0"
 
   s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "rake", ">= 0.9.2"
-  s.add_development_dependency "appraisal", ">= 0.5.2"
-  s.add_development_dependency "rspec-rails", "~> 2.6"
-  s.add_development_dependency "activerecord", ">= 3.2.0", "< 5.0.0" # rspec-rails needs activerecord...
+  s.add_development_dependency "rake", ">= 10.0", "<= 14.0"
+  s.add_development_dependency "appraisal", "~> 2.0"
+  s.add_development_dependency "rspec-rails", "~> 4.0"
+  s.add_development_dependency "rspec-its", "~> 1.0"
+  # rspec-rails needs activerecord...
+  s.add_development_dependency "activerecord", ">= 4.0.0"
   s.add_development_dependency "sqlite3", ">= 1.3"
   s.add_development_dependency "database_cleaner", ">= 1.0"
   s.add_development_dependency "timecop", ">= 0.6"
   s.add_development_dependency "coveralls", ">= 0.7"
   s.add_development_dependency "gem-release", ">= 0.7"
+  # This is for rails < 4.1 on MRI 2.2 (and other later version I suppose)
+  s.add_development_dependency "test-unit", ">= 3.0.0"
+
+  s.required_ruby_version = ">= 2.4.0"
 
   s.required_rubygems_version = ">= 1.4.0"
 end

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 4.2.0"
+gem "actionpack", "~> 4.2.0"
+gem "activerecord", "~> 4.2.0"
+gem "railties", "~> 4.2.0"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,11 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.0.0"
+gem "actionpack", "~> 5.0.0"
+gem "activerecord", "~> 5.0.0"
+gem "railties", "~> 5.0.0"
+gem "sqlite3", "~> 1.3.6"
+
+gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.1.0"
+gem "actionpack", "~> 5.1.0"
+gem "activerecord", "~> 5.1.0"
+gem "railties", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 5.2.0"
+gem "actionpack", "~> 5.2.0"
+gem "activerecord", "~> 5.2.0"
+gem "railties", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "~> 6.0.0"
+gem "actionpack", "~> 6.0.0"
+gem "activerecord", "~> 6.0.0"
+gem "railties", "~> 6.0.0"
+
+gemspec path: "../"

data/lib/action_controller_tweaks.rb

@@ -1,8 +1,8 @@
-require 'active_support/concern'
+require "active_support/concern"
 
-require 'action_controller_tweaks/version'
-require 'action_controller_tweaks/caching'
-require 'action_controller_tweaks/session'
+require "action_controller_tweaks/version"
+require "action_controller_tweaks/caching"
+require "action_controller_tweaks/session"
 
 module ActionControllerTweaks
   extend ActiveSupport::Concern

data/lib/action_controller_tweaks/caching.rb

@@ -1,13 +1,16 @@
-require 'active_support/concern'
+require "active_support/concern"
 
 module ActionControllerTweaks
   module Caching
     extend ActiveSupport::Concern
 
     HEADERS = {
-      "Cache-Control" => "no-cache, no-store, max-age=0, must-revalidate, pre-check=0, post-check=0", # HTTP 1.1
-      "Pragma" => "no-cache", # HTTP 1.0
-      "Expires" => "Fri, 01 Jan 1990 00:00:00 GMT", # HTTP 1.0
+      # HTTP 1.1
+      "Cache-Control" => "no-cache, no-store, pre-check=0, post-check=0",
+      # HTTP 1.0
+      "Pragma"        => "no-cache",
+      # HTTP 1.0
+      "Expires"       => "Mon, 01 Jan 1990 00:00:00 GMT",
     }.freeze
 
     included do

data/lib/action_controller_tweaks/session.rb

@@ -1,5 +1,5 @@
-require 'active_support/concern'
-require 'active_support/time'
+require "active_support/concern"
+require "active_support/time"
 
 module ActionControllerTweaks
   module Session
@@ -10,6 +10,27 @@ module ActionControllerTweaks
       ReservedSessionKeyConflict = Class.new(ArgumentError)
     end
 
+    module OptionProcessor
+      def self.extract_expires_in(options)
+        expires_in = options.delete(:expires_in) || options.delete(:expire_in)
+        if expires_in && !expires_in.is_a?(Numeric)
+          fail InvalidOptionValue.new(:expires_in, expires_in, Numeric)
+        end
+        expires_in
+      end
+
+      def self.extract_expires_at(options)
+        expires_at = options.delete(:expires_at) || options.delete(:expire_at)
+        if expires_at && expires_at.respond_to?(:to_time)
+          expires_at = expires_at.to_time
+        end
+        if expires_at && !expires_at.is_a?(Time)
+          fail InvalidOptionValue.new(:expires_at, expires_at, Time)
+        end
+        expires_at
+      end
+    end
+
     RESERVED_SESSION_KEYS = %w( session_keys_to_expire )
     VALID_OPTION_KEYS = [
       :expires_in,
@@ -20,51 +41,46 @@ module ActionControllerTweaks
 
     class InvalidOptionValue < ArgumentError
       def self.new(option_key, options_value, expected_types)
-        super("option key `#{option_key}` should contain value with type(s): #{expected_types}, " +
+        super("option key `#{option_key}` should contain value with type(s): #{expected_types}, "\
           "but got <#{options_value.inspect}> (#{options_value.class})")
       end
     end
 
     included do
-      before_filter :delete_expired_session_keys
+      if respond_to?(:before_action)
+        before_action :_delete_expired_session_keys
+      elsif respond_to?(:before_filter)
+        before_filter :_delete_expired_session_keys
+      else
+        fail(
+          NotImplementedError,
+          "There is no `.before_action` nor `.before_filter` in this class",
+        )
+      end
 
       private
 
       # Set session just like `session[key] = value` but accept some options about expiry
       #
-      # @option expires_in [Integer] How long from now should the session value be expired
-      # @option expire_in [Integer] same as `expires_in`
-      # @option expires_at [Integer] What time should the session value be expired (using a time in the past would expire at next request)
-      # @option expire_at [Integer] same as `expires_at`
+      # @option expires_in [Integer]
+      #   How long from now should the session value be expired
+      # @option expire_in [Integer]
+      #   same as `expires_in`
+      # @option expires_at [Integer]
+      #   What time should the session value be expired
+      #   (using a time in the past would expire at next request)
+      # @option expire_at [Integer]
+      #   same as `expires_at`
       def set_session(key, value, options = {})
-        options.symbolize_keys!
-
         if RESERVED_SESSION_KEYS.include?(key.to_s)
-          raise Errors::ReservedSessionKeyConflict.new, "you are trying to set #{value} to #{key}, but reserved by ActionControllerTweaks::Session"
+          fail Errors::ReservedSessionKeyConflict.new,
+            "you are trying to set #{value} to #{key}, "\
+            "but reserved by ActionControllerTweaks::Session"
         end
 
         session[key] = value
 
-        # Set special session
-        new_session_keys_to_expire = session_keys_to_expire
-
-        expires_in = options.delete(:expires_in) || options.delete(:expire_in)
-        expires_at = options.delete(:expires_at) || options.delete(:expire_at)
-
-        if expires_at && expires_at.respond_to?(:to_time)
-          expires_at = expires_at.to_time
-        end
-
-        raise InvalidOptionValue.new(:expires_in, expires_in, Numeric) if expires_in && !expires_in.is_a?(Numeric)
-        raise InvalidOptionValue.new(:expires_at, expires_at, Time) if expires_at && !expires_at.is_a?(Time)
-
-        new_session_keys_to_expire[key] = if expires_in
-          expires_in.from_now
-        elsif expires_at
-          expires_at
-        end
-
-        session[:session_keys_to_expire] = new_session_keys_to_expire
+        session[:session_keys_to_expire] = _new_session_keys_to_expire(key, options)
       end
 
       # set value in session just like `set_session`, but checked option keys
@@ -72,30 +88,34 @@ module ActionControllerTweaks
       # @raise [ActionControllerTweaks::Session::Errors::InvalidOptionKeys]
       def set_session_with_expiry(key, value, options = {})
         option_keys = options.symbolize_keys.keys
-        required_option_key_present = option_keys.any? do |key|
-          VALID_OPTION_KEYS.include?(key)
+        required_option_key_present = option_keys.any? do |k|
+          VALID_OPTION_KEYS.include?(k)
         end
         invalid_option_key_absent = (option_keys - VALID_OPTION_KEYS.dup).empty?
-        (required_option_key_present && invalid_option_key_absent) or raise ActionControllerTweaks::Session::Errors::InvalidOptionKeys
+        unless required_option_key_present && invalid_option_key_absent
+          fail ActionControllerTweaks::Session::Errors::InvalidOptionKeys
+        end
 
-        set_session(key, value, options = {})
+        set_session(key, value, options)
       end
 
-      def delete_expired_session_keys
+      def _delete_expired_session_keys
         # Remove keys that are expired
         session_keys_to_expire.each do |key, expire_at_str|
-          begin
-            if Time.now > Time.parse(expire_at_str.to_s)
-              session.delete(key)
-              session_keys_to_expire.delete(key)
-            end
-          rescue
-            # Parse error
-            # Let's expire it to be safe
-            session.delete(key)
-            session_keys_to_expire.delete(key)
-          end
+          _delete_expired_session_key(key, expire_at_str)
+        end
+      end
+
+      def _delete_expired_session_key(key, expire_at_str)
+        if Time.now > Time.parse(expire_at_str.to_s)
+          session.delete(key)
+          session_keys_to_expire.delete(key)
         end
+      rescue
+        # Parse error
+        # Let"s expire it to be safe
+        session.delete(key)
+        session_keys_to_expire.delete(key)
       end
 
       def session_keys_to_expire
@@ -106,6 +126,20 @@ module ActionControllerTweaks
 
         session[:session_keys_to_expire]
       end
+
+      def _new_session_keys_to_expire(key, options = {})
+        options.symbolize_keys!
+
+        result = session_keys_to_expire
+        expires_in = OptionProcessor.extract_expires_in(options)
+        expires_at = OptionProcessor.extract_expires_at(options)
+
+        if [expires_in, expires_at].any?
+          result[key] = expires_in ? expires_in.seconds.from_now : expires_at
+        end
+
+        result
+      end
     end
   end
 end