supercache 0.7 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0709e293782e7c60aa3b64e3f6dc40e9039c2238
-  data.tar.gz: 829304d977ef6c1fe389727dcd4754a6e1e9ad6b
+  metadata.gz: bff91563a08d2c564330e05fe3274bd48fa20fbf
+  data.tar.gz: 26b33642dc3e44083e00cd35e9f55bcfc4437c58
 SHA512:
-  metadata.gz: 1028380ce77e06528257f5e28c0aaa262e928116bcbb8210ba2c1dafdeb395dcfee8893679e34d001d6c284e31ab470787bb11ec737c2b5d73ebec1a5a6eadbd
-  data.tar.gz: f2d5abe2f224b7110ad34ec48e59c9b3ff124deca40996a306f2ab171cfcbceb34fd21f79aad025505ac26ead2a37ff4ad7b4d46cddfa36a6e016649f6bd2cb3
+  metadata.gz: 4d88fabef842e4ad59b53b2634a224f9e18c420c2f5f8c97c0ba588a213ec0d6869c6218b4c732b4689049df126efe04773c5de8c415beecdc03e125284f60c4
+  data.tar.gz: 8c88c8e349af7f7f2e2cf846c29fbfdb7475da4308b8d7b3d63878eabe8e2a2dca2b62e0a099fa2349aece80c259acd1439e1e5db4d0a8d30b08ff93cbc97acd

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.2.5
   - 2.3.1
+  - 2.4.1
 
 before_install: gem install bundler
 
@@ -21,9 +21,9 @@ gemfile:
 
 matrix:
   exclude:
-  - rvm: 1.9.3
+  - rvm: 2.4.1
+    gemfile: gemfiles/rails_4.0.gemfile
+  - rvm: 2.4.1
     gemfile: gemfiles/rails_4.1.gemfile
-  - rvm: 1.9.3
-    gemfile: gemfiles/rails_4.2.gemfile
-  - rvm: 1.9.3
-    gemfile: gemfiles/rails_5.0.gemfile
+  - rvm: 2.4.1
+    gemfile: gemfiles/rails_4.2.gemfile

data/README.md

@@ -17,9 +17,33 @@ gem 'supercache', group: :development
 And mount the dashboard in your `config/routes.rb`:
 
 ```ruby
-mount Supercache::Engine, at: "supercache"
+mount Supercache::Engine, at: "supercache" if Rails.env.development?
 ```
 
+## Customize Supercache
+
+Once you've included supercache in your devleopment environment, customizing it will be as simple as heading to loclahost:3000/supercache.
+
+![Screenshot](wiki/screenshot.png)
+
+You will see two types of caching by default. Activerecord query caching and HTTP Caching. 
+
+## How it works
+
+Please note supercache is to speed up development environment and I strongly recommend against using it in any other environment like a staging or production. It is vital that you understand the pros and cons of caching across requests. 
+
+By default rails caches duplicate queries that are fired within the same request. In instances where you are focused mainly only UI related issues and that you have to refresh your page many times, you will have to painfully wait for the queries to get completed. During these times, Supercache will be a true bliss. All you have to do is turn it ON and your queries are cached across all requests.
+
+Ensure that you turn it off, otherwise you may end up observing your query results are stale. 
+
+## HTTP Caching
+
+Initially I had only ActiveRecord in mind, however while developing I saw a bunch of redundant HTTP requests going from my server to outside world which often are stale themselves. So why not cache it? And thus came the super http cache. This could be typically used if your server is using external requests and that you don't care if they are not fresh.
+
+## Supercache is Super-unobtrusive
+
+While developing supercache, I had wanted to keep it as unobtrusive as possible. Supercache does not bother what type of caching is implemented in your development environment. It could be file cache, Redis, Memcache, In-memory caching, supercache will simply work well with any of them!
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -40,7 +64,6 @@ available tasks.
 The RSpec test suite can be run with `rake`, or
 `rake appraisal:rails4.0` to include Rails-specific specs.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/controllers/supercache/dashboard_controller.rb

@@ -1,8 +1,9 @@
 module Supercache
   class DashboardController < ActionController::Base
+    protect_from_forgery
     layout 'supercache/application'
 
-    before_filter :load_cache, only: :flip
+    before_action :load_cache, only: :flip
 
     def index
       @ar_cache = cache.read(:ar_supercache)

data/app/views/layouts/supercache/application.html.erb

@@ -13,8 +13,7 @@
       <%= yield %>
     </div>
   </main>
-  <!-<script src='https://cdnjs.cloudflare.com/ajax/libs/turbolinks/5.0.0/turbolinks.min.js'></script> -->
   <script src='https://code.jquery.com/jquery-2.1.1.min.js'></script>   
   <script src='https://cdnjs.cloudflare.com/ajax/libs/materialize/0.97.7/js/materialize.min.js'></script>
 </body>
-</html>
+</html>

data/lib/supercache/super_http_cache.rb

@@ -1,17 +1,13 @@
-module Net
-  class HTTP
-    def request_with_superhttpcache(*args, &block)
-      if Rails.cache.read(:http_supercache)
-        Rails.cache.fetch(Digest::SHA1.hexdigest(args[0].path.to_s + args[0].body.to_s)) do
-          request_without_superhttpcache(*args, &block)
-        end
-      else
-        request_without_superhttpcache(*args, &block)
+require 'net/http'
+module SuperHttpCache
+  def request(*args, &block)
+    if Rails.cache.read(:http_supercache)
+      Rails.cache.fetch(Digest::SHA1.hexdigest(args[0].path.to_s + args[0].body.to_s)) do
+        super(*args, &block)
       end
+    else
+      super(*args, &block)
     end
-
-    alias_method :request_without_superhttpcache, :request
-    alias_method :request, :request_with_superhttpcache
-
   end
-end
+end
+::Net::HTTP.prepend(SuperHttpCache)

data/lib/supercache/super_query_cache.rb

@@ -1,37 +1,14 @@
-if RUBY_VERSION < "2.0"
-  module ActiveRecord
-    module ConnectionAdapters # :nodoc:
-      module QueryCache
-        def cache_sql_with_superquerycache(*args, &block)
-          if Rails.cache.read(:ar_supercache)
-            sub_key = args[1].collect{|a| "#{a.try(:name)} #{a.try(:value)}"}
-            Rails.cache.fetch(Digest::SHA1.hexdigest("supercache_#{args[0]}_#{sub_key}")) do
-              request_without_superquerycache(*args, &block)
-            end
-          else
-            request_without_superquerycache(*args, &block)
-          end
-        end
-
-        alias_method :request_without_superquerycache, :cache_sql
-        alias_method :cache_sql, :cache_sql_with_superquerycache
-
-      end
-    end
-  end
-else
-  module SuperQueryCache
-    def cache_sql(*args, &block)
-      if Rails.cache.read(:ar_supercache)
-        sub_key = args[1].collect{|a| "#{a.try(:name)} #{a.try(:value)}"}
-        Rails.cache.fetch(Digest::SHA1.hexdigest("supercache_#{args[0]}_#{sub_key}")) do
-          super(*args, &block)
-        end
-      else
+module SuperQueryCache
+  def cache_sql(*args, &block)
+    if Rails.cache.read(:ar_supercache)
+      sub_key = args[1].collect{|a| "#{a.try(:name)} #{a.try(:value)}"}
+      Rails.cache.fetch(Digest::SHA1.hexdigest("supercache_#{args[0]}_#{sub_key}")) do
         super(*args, &block)
       end
+    else
+      super(*args, &block)
     end
   end
+end
 
-  ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(SuperQueryCache)
-end
+ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(SuperQueryCache)

data/lib/supercache/version.rb

@@ -1,3 +1,3 @@
 module Supercache
-  VERSION = "0.7"
+  VERSION = "0.7.1"
 end

data/lib/supercache.rb

@@ -4,5 +4,4 @@ require "supercache/super_query_cache"
 require "supercache/super_http_cache"
 
 module Supercache
-  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: supercache
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: 0.7.1
 platform: ruby
 authors:
 - Bragadeesh J
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-24 00:00:00.000000000 Z
+date: 2017-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,6 +101,7 @@ files:
 - lib/supercache/super_query_cache.rb
 - lib/supercache/version.rb
 - supercache.gemspec
+- wiki/screenshot.png
 homepage: https://github.com/bragboy/supercache
 licenses:
 - MIT
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Speed up Development time