action_controller_tweaks 0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aeeb3006ab00803aac920b909546dbfcb1853544
-  data.tar.gz: ed85182325fced848b6d19bc30f18c996197d583
+  metadata.gz: 9549506d76d4ea2032b34467b985b9ae3bc173d2
+  data.tar.gz: cf82467af5dc365d2a9638cdc2ee282854a69640
 SHA512:
-  metadata.gz: 43e666c777d955b2da529f99afa44054ea51e2915ad4c6d61c30df1524cd41881179817170cb541b19d47787bda3b22b4f4ce7679757326102be9f4f1b29f30d
-  data.tar.gz: 4b68f979cc6074dbbe199cd11b857bc6f3c01ccfe1a9c82cf9d800468140bced99a692e611feb82f36704ef5b7cc60fedf08a108c7a4845cde3df04726ca21e8
+  metadata.gz: ceba069ed9da41fd92bf3ab52c1e578929ef38fc059b041d6bd4ee6fd1fee0ac7a1e5fd8db718a2303e6a8335314dca388c2b654d7ecea6a7bd73264c0fbbd1d
+  data.tar.gz: b10c3a0d6a0feb7cf2c30e48ab479856d7dc8052617d5c2959486cfc5119b8aedd4eb08d25250671f91119ab961debe2bf322e50675a5fbe55fcfb93ea47452f

data/.travis.yml

@@ -1,8 +1,11 @@
-script: "bundle exec rspec"
+before_install:
+- gem install bundler -v=1.5.2
+- bundle --version
 rvm:
   - 1.9.2
   - 1.9.3
   - 2.0.0
+  - 2.1.0
 gemfile:
   - gemfiles/rails3_2.gemfile
   - gemfiles/rails4_0.gemfile

data/Appraisals

@@ -1,12 +1,12 @@
 
 appraise "rails3-2" do
-  version = "3.2.14"
+  version = "3.2.16"
   gem 'activesupport', version
   gem 'actionpack', version
 end
 
 appraise "rails4-0" do
-  version = "4.0.0"
+  version = "4.0.2"
   gem 'activesupport', version
   gem 'actionpack', version
 end

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Changelog
 
 
+- **0.2.0**
+  - Add option `expire_at` to #set_session
+  - Use semantic versioning
+
 - **0.1**
-  - Initial Release
+  - Initial Release

data/Rakefile

@@ -1,11 +1,15 @@
-require 'appraisal'
-require 'rubygems'
-require 'bundler/setup'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "appraisal"
+require "bundler"
+require "rspec/core/rake_task"
 
-task :default do
-  sh "rake appraisal:install && rake appraisal spec"
-end
+Bundler::GemHelper.install_tasks
 
 RSpec::Core::RakeTask.new(:spec)
+
+if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
+  task :default do
+    sh "rake appraisal:install && rake appraisal spec"
+  end
+else
+  task :default => :spec
+end

data/action_controller_tweaks.gemspec

@@ -1,8 +1,8 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 
-author_name = 'PikachuEXE'
-gem_name = 'action_controller_tweaks'
+author_name = "PikachuEXE"
+gem_name = "action_controller_tweaks"
 
 require "#{gem_name}/version"
 
@@ -10,28 +10,35 @@ Gem::Specification.new do |s|
   s.platform      = Gem::Platform::RUBY
   s.name          = gem_name
   s.version       = ActionControllerTweaks::VERSION
-  s.summary       = 'Some Tweaks for ActionController'
-  s.description   = 'ActionController is great, but could be better. Here are some tweaks for it.'
+  s.summary       = "Some Tweaks for ActionController"
+  s.description   = "ActionController is great, but could be better. Here are some tweaks for it."
 
-  s.license       = 'MIT'
+  s.license       = "MIT"
 
   s.authors       = [author_name]
-  s.email         = ['pikachuexe@gmail.com']
+  s.email         = ["pikachuexe@gmail.com"]
   s.homepage      = "http://github.com/#{author_name}/#{gem_name}"
 
   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.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_development_dependency 'rake'
-  s.add_development_dependency 'appraisal'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'rspec-rails'
-  s.add_development_dependency 'activerecord', '>= 3.2.0', '< 5.0.0' # rspec-rails needs activerecord...
-  s.add_development_dependency 'timecop'
-  s.add_development_dependency 'coveralls'
+  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_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 "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"
+
+  s.required_rubygems_version = ">= 1.4.0"
 end

data/gemfiles/rails3_2.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "activesupport", "3.2.14"
-gem "actionpack", "3.2.14"
+gem "activesupport", "3.2.16"
+gem "actionpack", "3.2.16"
 
 gemspec :path=>"../"

data/gemfiles/rails4_0.gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-gem "activesupport", "4.0.0"
-gem "actionpack", "4.0.0"
+gem "activesupport", "4.0.2"
+gem "actionpack", "4.0.2"
 
 gemspec :path=>"../"

data/lib/action_controller_tweaks/session.rb

@@ -7,12 +7,21 @@ module ActionControllerTweaks
 
     SPECIAL_KEYS = %w( session_keys_to_expire )
 
+    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}, " +
+          "but got <#{options_value.inspect}> (#{options_value.class})")
+      end
+    end
+
     included do
       before_filter :delete_expired_session_keys
 
       private
 
       def set_session(key, value, options = {})
+        options.symbolize_keys!
+
         key = key.to_sym
 
         if SPECIAL_KEYS.include?(key.to_s)
@@ -24,9 +33,19 @@ module ActionControllerTweaks
         # Set special session
         new_session_keys_to_expire = session_keys_to_expire
 
-        expire_in = options.delete(:expire_in)
-        if expire_in && expire_in.is_a?(Integer) # Time period
-          new_session_keys_to_expire[key] = expire_in.from_now
+        expire_in, expire_at = options.delete(:expire_in), options.delete(:expire_at)
+
+        if expire_at && expire_at.respond_to?(:to_time)
+          expire_at = expire_at.to_time
+        end
+
+        raise InvalidOptionValue.new(:expire_in, expire_in, Numeric) if expire_in && !expire_in.is_a?(Numeric)
+        raise InvalidOptionValue.new(:expire_at, expire_at, Time) if expire_at && !expire_at.is_a?(Time)
+
+        new_session_keys_to_expire[key] = if expire_in
+          expire_in.from_now
+        elsif expire_at
+          expire_at
         end
 
         session[:session_keys_to_expire] = new_session_keys_to_expire
@@ -40,7 +59,7 @@ module ActionControllerTweaks
               session.delete(key)
               session_keys_to_expire.delete(key)
             end
-          rescue ArgumentError 
+          rescue
             # Parse error
             # Let's expire it to be safe
             session.delete(key)
@@ -50,7 +69,12 @@ module ActionControllerTweaks
       end
 
       def session_keys_to_expire
-        session[:session_keys_to_expire] || {}
+        # Check whether session key is a hash to prevent exception
+        unless session[:session_keys_to_expire].is_a?(Hash)
+          session[:session_keys_to_expire] = {}
+        end
+
+        session[:session_keys_to_expire]
       end
     end
   end

data/lib/action_controller_tweaks/version.rb

@@ -1,3 +1,3 @@
 module ActionControllerTweaks
-  VERSION = '0.1'.freeze
+  VERSION = '0.2.0'
 end

data/spec/action_controller_tweaks_spec.rb

@@ -24,9 +24,8 @@ describe PostsController, type: :controller do
       let(:session_key) { :key }
       let(:session_value) { 'value' }
       let(:expire_in) { 60 * 60 } # 1 hour
-      let!(:time_now) { Time.new(2013, 1, 1) }
-      let!(:time_before_expire) { time_now + (expire_in / 2) }
-      let!(:time_after_expire) { time_now + (expire_in * 2) }
+      let(:expire_at) { Time.new(2014, 1, 1).in_time_zone }
+      let(:time_now) { Time.new(2013, 1, 1).in_time_zone }
 
       context 'when calling it without option' do
         before do
@@ -47,11 +46,59 @@ describe PostsController, type: :controller do
       end
 
       context 'when calling it with option expire_in' do
+        let!(:time_before_expire) { time_now + (expire_in / 2) }
+        let!(:time_after_expire) { time_now + (expire_in * 2) }
+
         before do
           Timecop.freeze(time_now)
           controller.send(:set_session, session_key, session_value, expire_in: expire_in)
         end
 
+        after do
+          Timecop.return
+        end
+
+        it 'set the session' do
+          session[session_key].should eq session_value
+        end
+
+        context 'before expire time' do
+          before do
+            Timecop.travel(time_before_expire)
+            # Runs before_filter
+            get :index
+          end
+
+          it 'keeps the session key' do
+            session[session_key].should eq session_value
+          end
+        end
+        context 'after expire time' do
+          before do
+            Timecop.travel(time_after_expire)
+            # Runs before_filter
+            get :index
+          end
+
+          it 'keeps the session key' do
+            session.key?(session_key).should be_false
+          end
+        end
+      end
+
+      context 'when calling it with option expire_at' do
+        let!(:time_before_expire) { expire_at - 1 }
+        let!(:time_after_expire) { expire_at + 1 }
+
+        before do
+          Timecop.freeze(time_now)
+          controller.send(:set_session, session_key, session_value, expire_at: expire_at)
+        end
+
+        after do
+          Timecop.return
+        end
+
         it 'set the session' do
           session[session_key].should eq session_value
         end
@@ -79,6 +126,80 @@ describe PostsController, type: :controller do
           end
         end
       end
+
+      context 'when option value with different types is passed into options' do
+        let(:method_call) do
+          controller.send(:set_session, session_key, session_value, options)
+        end
+        context 'for expire_in' do
+          let(:options) { {expire_in: expire_in.to_s} }
+
+          specify { expect{ method_call }.to raise_error(ActionControllerTweaks::Session::InvalidOptionValue) }
+        end
+        context 'for expire_at' do
+          context 'with a Hash' do
+            # String#to_time would be nil if format invalid
+            let(:options) { {expire_at: {}} }
+
+            specify { expect{ method_call }.to raise_error(ActionControllerTweaks::Session::InvalidOptionValue) }
+          end
+          context 'with a blank String' do
+            # String#to_time would be nil if format invalid
+            let(:options) { {expire_at: ''} }
+
+            specify { expect{ method_call }.to_not raise_error }
+          end
+          context 'with a time String' do
+            let(:options) { {expire_at: expire_at.to_s} }
+
+            specify { expect{ method_call }.to_not raise_error }
+          end
+          context 'with a Time' do
+            let(:options) { {expire_at: expire_at.to_time} }
+
+            specify { expect{ method_call }.to_not raise_error }
+          end
+          context 'with a Date' do
+            let(:options) { {expire_at: expire_at.to_date} }
+
+            specify { expect{ method_call }.to_not raise_error }
+          end
+          context 'with a DateTime' do
+            let(:options) { {expire_at: expire_at.in_time_zone} }
+
+            specify { expect{ method_call }.to_not raise_error }
+          end
+        end
+      end
+
+      context 'when someone screw up the special session key' do
+        before do
+          session[session_key] = session_value
+        end
+
+        context 'when someone set non time string in expire_at_str' do
+          before do
+            session['session_keys_to_expire'] = {session_key => ''}
+
+            # Runs before_filter
+            get :index
+          end
+
+          it 'destroys the session key' do
+            session.key?(session_key).should be_false
+          end
+        end
+
+        context 'when someone set non has to session_keys_to_expire' do
+          before do
+            session['session_keys_to_expire'] = []
+          end
+
+          it 'does not destroy the session key' do
+            session.key?(session_key).should be_true
+          end
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
-require 'coveralls'
-Coveralls.wear!('rails')
+if ENV["TRAVIS"]
+  require 'coveralls'
+  Coveralls.wear!('rails')
+end
 
 require 'action_controller_tweaks'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_controller_tweaks
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.2.0
 platform: ruby
 authors:
 - PikachuEXE
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2014-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -51,61 +51,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -126,34 +126,76 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 description: ActionController is great, but could be better. Here are some tweaks
   for it.
 email:
@@ -199,10 +241,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.4.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Some Tweaks for ActionController
@@ -211,3 +253,4 @@ test_files:
 - spec/fixtures/application.rb
 - spec/fixtures/controllers.rb
 - spec/spec_helper.rb
+has_rdoc: