action_controller_tweaks 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aeeb3006ab00803aac920b909546dbfcb1853544
+  data.tar.gz: ed85182325fced848b6d19bc30f18c996197d583
+SHA512:
+  metadata.gz: 43e666c777d955b2da529f99afa44054ea51e2915ad4c6d61c30df1524cd41881179817170cb541b19d47787bda3b22b4f4ce7679757326102be9f4f1b29f30d
+  data.tar.gz: 4b68f979cc6074dbbe199cd11b857bc6f3c01ccfe1a9c82cf9d800468140bced99a692e611feb82f36704ef5b7cc60fedf08a108c7a4845cde3df04726ca21e8

data/.gitignore

@@ -0,0 +1,2 @@
+gemfiles/*.gemfile.lock
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+script: "bundle exec rspec"
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - gemfiles/rails3_2.gemfile
+  - gemfiles/rails4_0.gemfile
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      gemfile: gemfiles/rails4_0.gemfile
+

data/Appraisals

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### Changelog
+
+
+- **0.1**
+  - Initial Release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 PikachuEXE
+
+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,51 @@
+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](https://travis-ci.org/PikachuEXE/action_controller_tweaks.png?branch=master)](https://travis-ci.org/PikachuEXE/action_controller_tweaks)
+[![Gem Version](https://badge.fury.io/rb/action_controller_tweaks.png)](http://badge.fury.io/rb/action_controller_tweaks)
+[![Dependency Status](https://gemnasium.com/PikachuEXE/action_controller_tweaks.png)](https://gemnasium.com/PikachuEXE/action_controller_tweaks)
+[![Coverage Status](https://coveralls.io/repos/PikachuEXE/action_controller_tweaks/badge.png)](https://coveralls.io/r/PikachuEXE/action_controller_tweaks)
+[![Code Climate](https://codeclimate.com/github/PikachuEXE/action_controller_tweaks.png)](https://codeclimate.com/github/PikachuEXE/action_controller_tweaks)
+
+Install
+=======
+
+```ruby
+gem 'action_controller_tweaks'
+```
+
+Usage
+=====
+
+Either include it in specific controller or just `ApplicationController`
+```ruby
+class SomeController
+  include ActionControllerTweaks
+end 
+```
+
+### `#set_no_cache`
+I got the code from [This Stack Overflow Answer](http://stackoverflow.com/questions/711418/how-to-prevent-browser-page-caching-in-rails)  
+`#expires_now` is not good enough when I test a mobile version page with Chrome on iOS  
+Usage:
+```ruby
+  # Just like using #expires_now
+  set_no_cache
+```
+
+### `#set_session`
+I write this on my own, it's ok to blame me if it's buggy :P  
+This method let's you set session, with expiry time!  
+Example:
+```ruby
+set_session(:key, 'value', expire_in: 1.day)
+```
+Note: Please don't use the session key `session_keys_to_expire`, it's reserved for internal processing

data/Rakefile

@@ -0,0 +1,11 @@
+require 'appraisal'
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default do
+  sh "rake appraisal:install && rake appraisal spec"
+end
+
+RSpec::Core::RakeTask.new(:spec)

data/action_controller_tweaks.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+author_name = 'PikachuEXE'
+gem_name = 'action_controller_tweaks'
+
+require "#{gem_name}/version"
+
+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.license       = 'MIT'
+
+  s.authors       = [author_name]
+  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'
+end

data/gemfiles/rails3_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "3.2.14"
+gem "actionpack", "3.2.14"
+
+gemspec :path=>"../"

data/gemfiles/rails4_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "4.0.0"
+gem "actionpack", "4.0.0"
+
+gemspec :path=>"../"

data/lib/action_controller_tweaks.rb

@@ -0,0 +1,14 @@
+require 'active_support/concern'
+
+require 'action_controller_tweaks/version'
+require 'action_controller_tweaks/caching'
+require 'action_controller_tweaks/session'
+
+module ActionControllerTweaks
+  extend ActiveSupport::Concern
+
+  included do
+    include Caching
+    include Session
+  end
+end

data/lib/action_controller_tweaks/caching.rb

@@ -0,0 +1,24 @@
+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
+      "no-cache" => "no-cache", # HTTP 1.0
+      "Expires" => "Fri, 01 Jan 1990 00:00:00 GMT", # Proxies
+    }.freeze
+
+    included do
+      private
+
+      # Should be more powerful than #expire_now
+      def set_no_cache
+        HEADERS.each do |key, value|
+          response.headers[key] = value
+        end
+      end
+    end
+  end
+end

data/lib/action_controller_tweaks/session.rb

@@ -0,0 +1,57 @@
+require 'active_support/concern'
+require 'active_support/time'
+
+module ActionControllerTweaks
+  module Session
+    extend ActiveSupport::Concern
+
+    SPECIAL_KEYS = %w( session_keys_to_expire )
+
+    included do
+      before_filter :delete_expired_session_keys
+
+      private
+
+      def set_session(key, value, options = {})
+        key = key.to_sym
+
+        if SPECIAL_KEYS.include?(key.to_s)
+          return
+        end
+
+        session[key] = value
+
+        # 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
+        end
+
+        session[:session_keys_to_expire] = new_session_keys_to_expire
+      end
+
+      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 ArgumentError 
+            # Parse error
+            # Let's expire it to be safe
+            session.delete(key)
+            session_keys_to_expire.delete(key)
+          end
+        end
+      end
+
+      def session_keys_to_expire
+        session[:session_keys_to_expire] || {}
+      end
+    end
+  end
+end

data/lib/action_controller_tweaks/version.rb

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

data/spec/action_controller_tweaks_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe PostsController, type: :controller do
+  describe 'included modules' do
+    it do
+      described_class.ancestors.should include(ActionControllerTweaks)
+    end
+  end
+
+  describe '::Caching' do
+    describe '#set_no_cache' do
+      before do
+        get :index, no_cache: true
+      end
+
+      it 'includes the pre defined headeres' do
+       controller.headers.deep_include?(ActionControllerTweaks::Caching::HEADERS).should be_true
+     end
+    end
+  end
+
+  describe '::Session' do
+    describe '#set_session' 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) }
+
+      context 'when calling it without option' do
+        before do
+          controller.send(:set_session, session_key, session_value)
+        end
+
+        it 'set the session' do
+          session[session_key].should eq session_value
+        end
+
+        context 'with a special key' do
+          let(:session_key) { ActionControllerTweaks::Session::SPECIAL_KEYS.first }
+
+          it 'does not set the session' do
+            session[session_key].should be_nil
+          end
+        end
+      end
+
+      context 'when calling it with option expire_in' do
+        before do
+          Timecop.freeze(time_now)
+          controller.send(:set_session, session_key, session_value, expire_in: expire_in)
+        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
+    end
+  end
+end

data/spec/fixtures/application.rb

@@ -0,0 +1,21 @@
+require 'active_support/all'
+require 'action_controller'
+require 'action_dispatch'
+
+module Rails
+  class App
+    def env_config; {} end
+    def routes
+      return @routes if defined?(@routes)
+      @routes = ActionDispatch::Routing::RouteSet.new
+      @routes.draw do
+        resources :posts # Replace with your own needs
+      end
+      @routes
+    end
+  end
+
+  def self.application
+    @app ||= App.new
+  end
+end

data/spec/fixtures/controllers.rb

@@ -0,0 +1,16 @@
+class TestController < ActionController::Base
+  include Rails.application.routes.url_helpers
+
+  def render(*attributes); end
+end
+
+class PostsController < TestController
+  include ActionControllerTweaks
+
+  def index
+    if params[:no_cache]
+      set_no_cache
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'coveralls'
+Coveralls.wear!('rails')
+
+require 'action_controller_tweaks'
+
+require 'fixtures/application'
+require 'fixtures/controllers'
+require 'rspec/rails'
+
+require 'timecop'
+require 'logger'
+
+
+# For comparison
+class Hash
+  def deep_include?(sub_hash)
+    sub_hash.keys.all? do |key|
+      self.has_key?(key) && if sub_hash[key].is_a?(Hash)
+        self[key].is_a?(Hash) && self[key].deep_include?(sub_hash[key])
+      else
+        self[key] == sub_hash[key]
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: action_controller_tweaks
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- PikachuEXE
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.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: appraisal
+  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: rspec
+  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: rspec-rails
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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: coveralls
+  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: ActionController is great, but could be better. Here are some tweaks
+  for it.
+email:
+- pikachuexe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- action_controller_tweaks.gemspec
+- gemfiles/rails3_2.gemfile
+- gemfiles/rails4_0.gemfile
+- lib/action_controller_tweaks.rb
+- lib/action_controller_tweaks/caching.rb
+- lib/action_controller_tweaks/session.rb
+- lib/action_controller_tweaks/version.rb
+- spec/action_controller_tweaks_spec.rb
+- spec/fixtures/application.rb
+- spec/fixtures/controllers.rb
+- spec/spec_helper.rb
+homepage: http://github.com/PikachuEXE/action_controller_tweaks
+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.0.7
+signing_key: 
+specification_version: 4
+summary: Some Tweaks for ActionController
+test_files:
+- spec/action_controller_tweaks_spec.rb
+- spec/fixtures/application.rb
+- spec/fixtures/controllers.rb
+- spec/spec_helper.rb