super_cache 0.0.1

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in super_cache.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ShiningRay
+
+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,42 @@
+# SuperCache
+
+SuperCache for rails is a caching middleware inspired by the "SuperCache" plugin
+for WordPress.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'super_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install super_cache
+
+## Usage
+
+Just call `super_caches_page` inside your controller with the action names to be cached.
+
+```ruby
+class MyController < ApplicationController
+  super_caches_page :index
+  def index
+    # action to be 
+  edn
+end
+```
+
+Super_cache will store the response body into `Rails.cache`. The next time requesting
+that action will get the same result.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/super_cache/version.rb

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

data/lib/super_cache.rb

@@ -0,0 +1,78 @@
+require "super_cache/version"
+require 'uri'
+require 'fileutils'
+# for static-caching the generated html pages
+
+module SuperCache
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def super_caches_page(*pages)
+      return unless perform_caching
+      options = pages.extract_options!
+      options[:only] = (Array(options[:only]) + pages).flatten
+      before_filter :check_weird_cache, options
+      after_filter :weird_cache, options
+    end
+
+    def skip_super_caches_page(*pages)
+      options = pages.extract_options!
+      options[:only] = (Array(options[:only]) + pages).flatten
+      skip_before_filter :check_weird_cache, options
+      skip_after_filter :weird_cache, options
+    end
+  end
+
+  def check_weird_cache
+    return unless perform_caching
+    @cache_path ||= weird_cache_path
+    
+    if content = Rails.cache.read(@cache_path, :raw => true)
+      return if content.size <= 1
+      logger.info "Hit #{@cache_path}"
+
+      headers['Content-Length'] ||= content.size.to_s
+      headers['Content-Type'] ||= request.format.to_s.strip unless  request.format == :all
+      render :text => content, :content_type => 'text/html'
+      return false
+    end
+  rescue ArgumentError => e
+    @no_cache = true
+    logger.info e.to_s
+    logger.debug {e.backtrace}
+  end
+
+  def weird_cache
+    return if @no_cache
+    return unless perform_caching
+    return if request.format.to_sym == :mobile
+    @cache_path ||= weird_cache_path
+    @expires_in ||= 600
+    return if response.body.size <= 1
+    return if response.respond_to?(:status) and response.status.to_i != 200
+    #benchmark "Super Cached page: #{@cache_path}" do
+    #  @cache_subject = Array(@cache_subject)
+    #  @cache_subject.compact.flatten.select{|s|s.respond_to?(:append_cached_key)}.each do |subject|
+    #    subject.append_cached_key @cache_path
+    #  end
+    Rails.cache.write(@cache_path, response.body, :raw => true, :expires_in => @expires_in.to_i)
+    #end
+  end
+
+  protected :check_weird_cache
+  protected :weird_cache
+  private
+    def weird_cache_path
+      path = File.join request.host, request.path
+      q = request.query_string
+      request.format ||= :html
+      format = request.format.to_sym
+      path = "#{path}.#{format}" if format != :html and format != :all and params[:format].blank?
+      path = "#{path}?#{q}" #if !q.empty? && q =~ /=/
+      path
+    end
+end
+
+ActionController::Base.__send__ :include, SuperCache

data/super_cache.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'super_cache/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "super_cache"
+  gem.version       = SuperCache::VERSION
+  gem.authors       = ["ShiningRay"]
+  gem.email         = ["tsowly@hotmail.com"]
+  gem.description   = %q{A simple caching middleware for rails}
+  gem.summary       = %q{A simple caching middleware for rails}
+  gem.homepage      = "https://github.com/shiningray/super_cache"
+
+  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

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: super_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ShiningRay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-02 00:00:00.000000000 Z
+dependencies: []
+description: A simple caching middleware for rails
+email:
+- tsowly@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/super_cache.rb
+- lib/super_cache/version.rb
+- super_cache.gemspec
+homepage: https://github.com/shiningray/super_cache
+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.24
+signing_key: 
+specification_version: 3
+summary: A simple caching middleware for rails
+test_files: []