qor_cache 0.0.2 → 0.0.3

data/Gemfile

@@ -1,7 +1,8 @@
 source 'https://rubygems.org'
 
 gem 'qor_dsl'
-gem 'qor_test'
 gem 'factory_girl_rails'
+gem 'pry'
+gem "timecop"
 
 gemspec

data/README.md

@@ -29,6 +29,11 @@ Qor Cache
       cache_field :product_code, :from => [:product, :code]
     end
 
+    cache_includes "filename", :no_cache => true, :expires_in => 5.minutes do |app|
+      ...
+    end
+    cache_includes "filename", "cache_key..."
+
 
     # app/models/color_variation.rb
     def heavy_method_related_to_products
@@ -56,6 +61,15 @@ Qor Cache
       xxxxx
     end
 
+    qor_cache_includes "filename"
+
+## TODO
+
+    Support render :file, :url for render_qor_cache_includes
+      :partial => "filename"
+      :filename => "filename"
+      :url => "http://xxx" -> SSI ? Rewrite ?
+
 ## Contributing
 
 1. Fork it
@@ -63,3 +77,8 @@ Qor Cache
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Author ##
+Jinzhu <http://github.com/jinzhu>
+
+* A Product From ThePlant <http://theplant.jp>

data/app/controllers/qor/cache_controller.rb

@@ -0,0 +1,9 @@
+module Qor
+  class CacheController < ActionController::Base
+    include Qor::CacheHelper
+
+    def includes
+      render :text => render_qor_cache_includes(params[:path], request.fullpath)
+    end
+  end
+end

data/app/helpers/qor/cache_helper.rb

@@ -0,0 +1,34 @@
+module Qor
+  module CacheHelper
+    def qor_cache_includes(filename, &blk)
+      env = respond_to?(:request) && request.respond_to?(:env) ? request.env : {}
+      path = URI.parse(filename).path rescue filename
+      node = Qor::Cache::Configuration.deep_find(:cache_includes, path)[0]
+
+      cache_key = node.nil? ? "" : qor_cache_key(*node.data.select {|x| x.is_a? String }, &node.block)
+      cache_key += qor_cache_key(&blk) if block_given?
+      key = "/qor_cache_includes/#{filename}?#{cache_key}"
+
+      if env['QOR_CACHE_SSI_ENABLED']
+        %Q[<!--# include virtual="#{key}" -->]
+      elsif env['QOR_CACHE_ESI_ENABLED']
+        %Q[<esi:include src="#{key}"/>]
+      else
+        render_qor_cache_includes(path, key)
+      end.html_safe
+    end
+
+    def render_qor_cache_includes(path, cache_key)
+      options = Qor::Cache::Configuration.first(:cache_includes, path).try(:options) || {}
+
+      format = params["format"] || "html" rescue "html"
+      file = Dir[File.join(Rails.root, "app/views/qor_cache_includes", "#{path}.#{format}*")][0]
+
+      if options.delete(:no_cache) == true
+        Erubis::Eruby.new(File.read(file)).result(binding)
+      else
+        Rails.cache.fetch(cache_key, options) { Erubis::Eruby.new(File.read(file)).result(binding) }
+      end
+    end
+  end
+end

data/config/qor/cache.rb

@@ -29,3 +29,10 @@ scope :color_variation do
 
   cache_field :product_code, :from => [:product, :code]
 end
+
+cache_includes "nocache_time", :no_cache => true
+cache_includes "expires_in_time", :expires_in => 2.days
+cache_includes "products_time", "product", "color_variation"
+cache_includes "helper_time" do
+  current_user
+end

data/config/qor/test.rb

@@ -1,25 +1,17 @@
 source 'https://rubygems.org'
 gemspec
 
-# Run your tests with nokogiri's 1.4 branch and master branch
-gem  'nokogiri', :git => "git://github.com/sparklemotion/nokogiri.git", :branch => "1.4"
-gem  'nokogiri', :git => "git://github.com/sparklemotion/nokogiri.git", :branch => "master"
+gem 'rails', [3.1, 3.2]
 
-# You can also write above code in one line like this
-gem  'nokogiri', [{:git => "git://github.com/sparklemotion/nokogiri.git"}, {:git => "git://github.com/sparklemotion/nokogiri.git", :branch => "1.4"}]
+env '2.0' do
+  ruby '2.0'
+end
 
-# Default mode, your tests will run with rails 3.1, 3.2 and 4.0
-# So with above config, your tests will run 6 times
-# [nokogiri(1.4), rails(3.1)], [nokogiri(master), rails(3.1)]
-# [nokogiri(1.4), rails(3.2)], [nokogiri(master), rails(3.2)]
-# [nokogiri(1.4), rails(4.0)], [nokogiri(master), rails(4.0)]
-env 'default' do
+env '1.9.3' do
   ruby '1.9.3'
-  gem  'rails', ['3.1', '3.2', '4.0']
 end
 
-# Using `qor_test -e old_ruby -c 'rake test'` to run your tests in old_ruby mode
-env 'old_ruby' do
-  ruby 'ree'
-  gem  'rails', ['3.1', '3.2']
+env '1.8.7' do
+  ruby '1.8.7'
+  gem 'factory_girl_rails', '1.3.0'
 end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  match "/qor_cache_includes/*path" => "Qor::Cache#includes"
+end

data/lib/qor_cache/configuration.rb

@@ -1,3 +1,5 @@
+require 'qor_dsl'
+
 module Qor
   module Cache
     class Configuration
@@ -5,7 +7,9 @@ module Qor
 
       default_configs ["config/qor/cache.rb"]
 
+      node :cache_includes
       node :cache_key
+
       node :scope do
         node :cache_class_method
         node :cache_method

data/lib/qor_cache/{railtie.rb → engine.rb}

@@ -1,6 +1,6 @@
 module Qor
   module Cache
-    class Railtie < Rails::Railtie
+    class Railtie < Rails::Engine
 
       initializer "insert_active_record_methods_for_qor_cache" do
         ActiveSupport.on_load(:active_record) do

data/lib/qor_cache/kernel.rb

@@ -1,12 +1,13 @@
 require "digest/md5"
+require 'uri'
 
 module Kernel
   def qor_cache_key(*names, &blk)
     objs = names.map { |name| Qor::Cache::Configuration.first(:cache_key, name).block.call }
-    objs << blk.call if block_given?
+    objs << instance_eval(&blk) if block_given?
 
-    results = objs.map do |obj|
-      Array(obj).map {|x| x.respond_to?(:cache_key) ? x.cache_key : x.inspect }.join("-")
+    results = objs.flatten.map do |obj|
+      obj.respond_to?(:cache_key) ? obj.cache_key : obj.inspect
     end
 
     Digest::MD5.hexdigest(results.join("-"))

data/lib/qor_cache/version.rb

@@ -1,5 +1,5 @@
 module Qor
   module Cache
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/lib/qor_cache.rb

@@ -1,6 +1,6 @@
 require "qor_cache/configuration"
 require "qor_cache/active_record"
-require "qor_cache/railtie"
+require "qor_cache/engine"
 require "qor_cache/kernel"
 require "digest/md5"
 

data/test/dummy/app/controllers/application_controller.rb

@@ -1,3 +1,27 @@
 class ApplicationController < ActionController::Base
   protect_from_forgery
+
+  def index
+    render :index
+  end
+
+  def nocache
+    render :nocache
+  end
+
+  def expires_in
+    render :expires_in
+  end
+
+  def products
+    render :products
+  end
+
+  def helpers
+    render :helpers
+  end
+
+  def with_block
+    render :with_block
+  end
 end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,5 @@
 module ApplicationHelper
+  def current_user
+    request.env["CURRENT_USER_ID"]
+  end
 end

data/test/dummy/app/models/color_variation.rb

@@ -1,5 +1,4 @@
 class ColorVariation < ActiveRecord::Base
-  attr_accessible :code, :name, :product_code
   belongs_to :product
 
   def slow_method

data/test/dummy/app/views/application/expires_in.html.erb

@@ -0,0 +1,3 @@
+Hello World!
+
+<%= qor_cache_includes "expires_in_time" %>

data/test/dummy/app/views/application/helpers.html.erb

@@ -0,0 +1,3 @@
+Hello World!
+
+<%= qor_cache_includes "helper_time" %>

data/test/dummy/app/views/application/index.html.erb

@@ -0,0 +1,3 @@
+Hello World!
+
+<%= qor_cache_includes "time" %>

data/test/dummy/app/views/application/nocache.html.erb

@@ -0,0 +1,3 @@
+Hello World!
+
+<%= qor_cache_includes "nocache_time" %>

data/test/dummy/app/views/application/products.html.erb

@@ -0,0 +1,3 @@
+Hello World!
+
+<%= qor_cache_includes "products_time" %>

data/test/dummy/app/views/application/with_block.html.erb

@@ -0,0 +1,9 @@
+Hello World!
+
+<%=
+  @current_user = current_user
+  qor_cache_includes "time" do
+    @current_user
+  end
+%>
+

data/test/dummy/app/views/qor_cache_includes/expires_in_time.html.erb

@@ -0,0 +1,2 @@
+<%= Time.now.strftime("%Y-%m-%d") %>
+

data/test/dummy/app/views/qor_cache_includes/helper_time.html.erb

@@ -0,0 +1 @@
+<%= Time.now.strftime("%Y-%m-%d") %>

data/test/dummy/app/views/qor_cache_includes/nocache_time.html.erb

@@ -0,0 +1 @@
+<%= Time.now.strftime("%Y-%m-%d") %>

data/test/dummy/app/views/qor_cache_includes/products_time.html.erb

@@ -0,0 +1 @@
+<%= Time.now.strftime("%Y-%m-%d") %>

data/test/dummy/app/views/qor_cache_includes/time.html.erb

@@ -0,0 +1 @@
+<%= Time.now.strftime("%Y-%m-%d") %>

data/test/dummy/config/application.rb

@@ -47,13 +47,13 @@ module Dummy
     # This will create an empty whitelist of attributes available for mass-assignment for all models
     # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
     # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
+    # config.active_record.whitelist_attributes = true
 
     # Enable the asset pipeline
-    config.assets.enabled = true
+    # config.assets.enabled = true
 
     # Version of your assets, change this if you want to expire all your assets
-    config.assets.version = '1.0'
+    # config.assets.version = '1.0'
   end
 end
 

data/test/dummy/config/environments/development.rb

@@ -23,7 +23,7 @@ Dummy::Application.configure do
   config.action_dispatch.best_standards_support = :builtin
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # config.active_record.mass_assignment_sanitizer = :strict
 
   # Log the query plan for queries taking more than this (works
   # with SQLite, MySQL, and PostgreSQL)

data/test/dummy/config/environments/test.rb

@@ -30,7 +30,7 @@ Dummy::Application.configure do
   config.action_mailer.delivery_method = :test
 
   # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # config.active_record.mass_assignment_sanitizer = :strict
 
   # Print deprecation notices to the stderr
   config.active_support.deprecation = :stderr

data/test/dummy/config/initializers/session_store.rb

@@ -1,6 +1,6 @@
 # Be sure to restart your server when you modify this file.
 
-Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
 
 # Use the database for sessions instead of the cookie-based default,
 # which shouldn't be used to store highly confidential information

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -4,11 +4,11 @@
 # is enabled by default.
 
 # Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
-ActiveSupport.on_load(:action_controller) do
-  wrap_parameters format: [:json]
-end
+# ActiveSupport.on_load(:action_controller) do
+#   wrap_parameters :format => [:json]
+# end
 
 # Disable root element in JSON by default.
-ActiveSupport.on_load(:active_record) do
-  self.include_root_in_json = false
-end
+# ActiveSupport.on_load(:active_record) do
+#   self.include_root_in_json = false
+# end

data/test/dummy/config/qor/cache.rb

@@ -1,11 +1,33 @@
+cache_key :product do
+  Product
+end
+
+cache_key :color_variation do
+  [ColorVariation]
+end
+
+cache_key :product_and_color_variation do
+  [Product, ColorVariation]
+end
+
 scope :product do
   cache_method :slow_method
-  cache_method :slow_method1
+  cache_method :slow_method_with_args
 
   cache_class_method :slow_class_method
-  cache_class_method :slow_class_method1
+  cache_class_method :slow_class_method_with_args
 end
 
-scope :product do
+scope :color_variation do
+  cache_method :slow_method, 'product'
+
+  cache_method :slow_method_with_product do |s|
+    s.product
+  end
+
+  cache_class_method :slow_class_method, 'product'
+
   cache_field :product_code, :from => [:product, :code]
 end
+
+cache_includes "nocache_time", :no_cache => true

data/test/dummy/config/routes.rb

@@ -1,58 +1,8 @@
 Dummy::Application.routes.draw do
-  # The priority is based upon order of creation:
-  # first created -> highest priority.
-
-  # Sample of regular route:
-  #   match 'products/:id' => 'catalog#view'
-  # Keep in mind you can assign values other than :controller and :action
-
-  # Sample of named route:
-  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
-  # This route can be invoked with purchase_url(:id => product.id)
-
-  # Sample resource route (maps HTTP verbs to controller actions automatically):
-  #   resources :products
-
-  # Sample resource route with options:
-  #   resources :products do
-  #     member do
-  #       get 'short'
-  #       post 'toggle'
-  #     end
-  #
-  #     collection do
-  #       get 'sold'
-  #     end
-  #   end
-
-  # Sample resource route with sub-resources:
-  #   resources :products do
-  #     resources :comments, :sales
-  #     resource :seller
-  #   end
-
-  # Sample resource route with more complex sub-resources
-  #   resources :products do
-  #     resources :comments
-  #     resources :sales do
-  #       get 'recent', :on => :collection
-  #     end
-  #   end
-
-  # Sample resource route within a namespace:
-  #   namespace :admin do
-  #     # Directs /admin/products/* to Admin::ProductsController
-  #     # (app/controllers/admin/products_controller.rb)
-  #     resources :products
-  #   end
-
-  # You can have the root of your site routed with "root"
-  # just remember to delete public/index.html.
-  # root :to => 'welcome#index'
-
-  # See how all your routes lay out with "rake routes"
-
-  # This is a legacy wild controller route that's not recommended for RESTful applications.
-  # Note: This route will make all actions in every controller accessible via GET requests.
-  # match ':controller(/:action(/:id))(.:format)'
+  match "/" => "application#index"
+  match "/nocache" => "application#nocache"
+  match "/expires_in" => "application#expires_in"
+  match "/products" => "application#products"
+  match "/helpers" => "application#helpers"
+  match "/with_block" => "application#with_block"
 end

data/test/integration_test.rb

@@ -0,0 +1,135 @@
+require File.expand_path("../test_helper",  __FILE__)
+
+class IntegrationTest < ActionDispatch::IntegrationTest
+  def setup
+    Rails.cache.clear
+    Timecop.freeze("2012-10-10")
+  end
+
+  test "Normal mode" do
+    get "/"
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    Timecop.freeze("2012-10-11")
+    get "/"
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+  end
+
+  test "SSI mode" do
+    get "/", {}, {"QOR_CACHE_SSI_ENABLED" => 1}
+    assert_response 200
+    assert response.body.include?(%Q[<!--# include virtual="/qor_cache_includes/time])
+  end
+
+  test "ESI mode" do
+    get "/", {}, {"QOR_CACHE_ESI_ENABLED" => 1}
+    assert_response 200
+    assert response.body.include?(%Q[<esi:include src="/qor_cache_includes/time])
+  end
+
+  test "request qor_cache_includes partial" do
+    get "/qor_cache_includes/time"
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    Timecop.freeze("2012-10-11")
+    get "/qor_cache_includes/time"
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    get "/qor_cache_includes/time?hello"
+    assert_response 200
+    assert response.body.include?('2012-10-11')
+  end
+
+  test "qor_cache_includes no_cache option" do
+    get "/nocache"
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    Timecop.freeze("2012-10-11")
+    get "/nocache"
+    assert_response 200
+    assert response.body.include?('2012-10-11')
+  end
+
+  test "qor_cache_includes expires_in option" do
+    get "/expires_in"
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    Timecop.freeze("2012-10-11")
+    get "/expires_in"
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    Timecop.freeze("2012-10-13")
+    get "/expires_in"
+    assert_response 200
+    assert response.body.include?('2012-10-13')
+  end
+
+  test "qor_cache_includes with qor_cache_key" do
+    get "/products"
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    Timecop.freeze("2012-10-11")
+    get "/products"
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    FactoryGirl.create(:product)
+    get "/products"
+    assert_response 200
+    assert response.body.include?('2012-10-11')
+
+    Timecop.freeze("2012-10-12")
+    get "/products"
+    assert_response 200
+    assert response.body.include?('2012-10-11')
+
+    FactoryGirl.create(:color_variation)
+    get "/products"
+    assert_response 200
+    assert response.body.include?('2012-10-12')
+
+    Timecop.freeze("2012-10-13")
+    get "/products"
+    assert_response 200
+    assert response.body.include?('2012-10-12')
+  end
+
+  test "qor_cache_includes with helpers current_user" do
+    get "/helpers", {}, {"CURRENT_USER_ID" => 1}
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    Timecop.freeze("2012-10-11")
+    get "/helpers", {}, {"CURRENT_USER_ID" => 1}
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    get "/helpers", {}, {"CURRENT_USER_ID" => 2}
+    assert_response 200
+    assert response.body.include?('2012-10-11')
+  end
+
+  test "qor_cache_includes with block" do
+    FactoryGirl.create(:product)
+    get "/with_block", {}, {"CURRENT_USER_ID" => 1}
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    Timecop.freeze("2012-10-11")
+    get "/with_block", {}, {"CURRENT_USER_ID" => 1}
+    assert_response 200
+    assert response.body.include?('2012-10-10')
+
+    get "/with_block", {}, {"CURRENT_USER_ID" => 2}
+    assert_response 200
+    assert response.body.include?('2012-10-11')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qor_cache
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2013-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: qor_test
@@ -87,13 +87,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/controllers/qor/cache_controller.rb
+- app/helpers/qor/cache_helper.rb
 - config/qor/cache.rb
 - config/qor/test.rb
+- config/routes.rb
 - lib/qor_cache.rb
 - lib/qor_cache/active_record.rb
 - lib/qor_cache/configuration.rb
+- lib/qor_cache/engine.rb
 - lib/qor_cache/kernel.rb
-- lib/qor_cache/railtie.rb
 - lib/qor_cache/version.rb
 - qor_cache.gemspec
 - test/dummy/.gitignore
@@ -107,7 +110,17 @@ files:
 - test/dummy/app/models/.gitkeep
 - test/dummy/app/models/color_variation.rb
 - test/dummy/app/models/product.rb
-- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/application/expires_in.html.erb
+- test/dummy/app/views/application/helpers.html.erb
+- test/dummy/app/views/application/index.html.erb
+- test/dummy/app/views/application/nocache.html.erb
+- test/dummy/app/views/application/products.html.erb
+- test/dummy/app/views/application/with_block.html.erb
+- test/dummy/app/views/qor_cache_includes/expires_in_time.html.erb
+- test/dummy/app/views/qor_cache_includes/helper_time.html.erb
+- test/dummy/app/views/qor_cache_includes/nocache_time.html.erb
+- test/dummy/app/views/qor_cache_includes/products_time.html.erb
+- test/dummy/app/views/qor_cache_includes/time.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
@@ -138,7 +151,9 @@ files:
 - test/dummy/test/fixtures/products.yml
 - test/dummy/test/unit/color_variation_test.rb
 - test/dummy/test/unit/product_test.rb
+- test/dummy/tmp/cache/.gitkeep
 - test/factories.rb
+- test/integration_test.rb
 - test/qor_cache_fields_test.rb
 - test/qor_cache_key_test.rb
 - test/qor_cache_methods_test.rb
@@ -179,7 +194,17 @@ test_files:
 - test/dummy/app/models/.gitkeep
 - test/dummy/app/models/color_variation.rb
 - test/dummy/app/models/product.rb
-- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/application/expires_in.html.erb
+- test/dummy/app/views/application/helpers.html.erb
+- test/dummy/app/views/application/index.html.erb
+- test/dummy/app/views/application/nocache.html.erb
+- test/dummy/app/views/application/products.html.erb
+- test/dummy/app/views/application/with_block.html.erb
+- test/dummy/app/views/qor_cache_includes/expires_in_time.html.erb
+- test/dummy/app/views/qor_cache_includes/helper_time.html.erb
+- test/dummy/app/views/qor_cache_includes/nocache_time.html.erb
+- test/dummy/app/views/qor_cache_includes/products_time.html.erb
+- test/dummy/app/views/qor_cache_includes/time.html.erb
 - test/dummy/config.ru
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
@@ -210,8 +235,11 @@ test_files:
 - test/dummy/test/fixtures/products.yml
 - test/dummy/test/unit/color_variation_test.rb
 - test/dummy/test/unit/product_test.rb
+- test/dummy/tmp/cache/.gitkeep
 - test/factories.rb
+- test/integration_test.rb
 - test/qor_cache_fields_test.rb
 - test/qor_cache_key_test.rb
 - test/qor_cache_methods_test.rb
 - test/test_helper.rb
+has_rdoc: 

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    "application", :media => "all" %>
-  <%= javascript_include_tag "application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>