redis_page 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f4beebad0af5093a904e8018586f26331fdbf8c
+  data.tar.gz: b187937071618ac5b9a53a073c234de825d89e06
+SHA512:
+  metadata.gz: 06d3caae4fe5ea15b205236db21815d1172122a175a52974a9359e00004cd6a4660f648411a01f4881f869344ef7b4e463d6b89ec2a558b24dab07b554b3648a
+  data.tar.gz: 2e61816f7303f0a0cad3fa1d1b7e435653354b9e2b254e86cb45ea94985bcd88541162f7b047eee806e2eac72e69d163f830aedf6bc9babad62e3332fdb8e12b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 saberma
+
+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,66 @@
+# redis_page
+
+[actionpack-page_caching](https://github.com/rails/actionpack-page_caching) 是将页面缓存到文件中，这样有两个缺点：
+
+1. nginx web 服务器需要访问到 app 服务器生成的文件；
+2. 多台 app 服务器都会生成自己的缓存文件，难以共享，NFS 等又不大稳定；
+
+redis_page 改为将页面缓存至 redis，nginx 安装 redis 插件后即可直接使用。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_page'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### 1. Controller
+
+生成页面缓存
+
+```
+class ProductController < ActionController::Base
+  caches_redis_page :show, :new
+
+  def show
+    @product = Product.find(params[:id])
+    @model_name = Product.table_name
+    @model_id   = @product.id
+  end
+end
+```
+
+### 2. View
+
+记录哪些实体更新时要刷新的 url，例如：iPhone 在首页中显示了，则记录下 iPhone 实体与首页的关联关系
+
+```
+- Product.all.each do |product|
+  = @product.title
+```
+
+修改为：
+
+```
+- Product.all.each do |product|
+  = c(@product).title
+```
+
+c 方法会记录当前页面 url
+
+### 3. Model
+
+更新实体后刷新所有关联的页面缓存
+
+```
+class Product < ActiveRecord::Base
+  include RedisPage::Sweeper
+end
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "actionpack/redis/page/caching"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/action_controller/caching/pages.rb

@@ -0,0 +1,32 @@
+require 'active_support/core_ext/class/attribute_accessors'
+
+module ActionController
+  module Caching
+    module Pages
+      extend ActiveSupport::Concern
+
+      included do
+      end
+
+      module ClassMethods
+        def caches_redis_page(*actions)
+          options = actions.extract_options!
+
+          after_filter({only: actions}.merge(options)) do |c|
+            c.cache_page(response.body, request.path)
+          end
+        end
+      end
+
+      def cache_page(content, path)
+        Rails.logger.info "[page cache]caching: #{path}"
+        $redis.set(path, content)
+
+        if @model_name
+          mark_cache_instance(@model_name, @model_id)
+        end
+      end
+
+    end
+  end
+end

data/lib/action_controller/page_caching.rb

@@ -0,0 +1,14 @@
+require 'action_controller/caching/pages'
+
+module ActionController
+  module Caching
+    eager_autoload do
+      autoload :Pages
+    end
+
+    include Pages
+  end
+end
+
+ActionController::Base.send(:include, ActionController::Caching::Pages)
+ActionController::Base.send(:include, RedisPage::ViewHelpers)

data/lib/redis_page/railtie.rb

@@ -0,0 +1,21 @@
+require 'redis_page/view_helpers'
+
+module RedisPage
+  class Railtie < Rails::Railtie
+    initializer "redis_page" do
+      ActiveSupport.on_load(:action_controller) do
+        require 'action_controller/page_caching'
+      end
+    end
+
+    initializer "redis_page.activerecord" do
+      ActiveSupport.on_load(:active_record) do
+        require 'redis_page/sweeper'
+      end
+    end
+
+    initializer "redis_page.view_helpers" do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/redis_page/sweeper.rb

@@ -0,0 +1,18 @@
+require 'redis_page/sweeper_worker'
+
+module RedisPage
+  module Sweeper
+    extend ActiveSupport::Concern
+
+    included do
+      after_save :invalidate_instance_cache
+
+      def invalidate_instance_cache
+        $redis.smembers("i:#{self.class.table_name}:#{self.id}").each do |url|
+          Rails.logger.info "[page cache]add sweeper job: #{url}"
+          SweeperWorker.perform_async(url)
+        end
+      end
+    end
+  end
+end

data/lib/redis_page/sweeper_worker.rb

@@ -0,0 +1,16 @@
+module RedisPage
+  class SweeperWorker
+    include Sidekiq::Worker
+
+    def perform(url)
+      uri = URI(url)
+      uri.port = 8081
+
+      auth = { username: "cache", password: "ewHN84JZLyRurX" }
+
+      Rails.logger.info "[page cache]sweeper fetching: #{url}"
+      response = HTTParty.get(uri, basic_auth: auth)
+      Rails.logger.debug "[page cache]sweeper response: #{response.body}"
+    end
+  end
+end

data/lib/redis_page/version.rb

@@ -0,0 +1,3 @@
+module RedisPage
+  VERSION = "0.1.0"
+end

data/lib/redis_page/view_helpers.rb

@@ -0,0 +1,27 @@
+module RedisPage
+  module ViewHelpers
+
+    # 记录当前实体相关的页面，方便实体更新时，刷新页面缓存
+    def c(object)
+      mark_cache_instance(object)
+      object
+    end
+
+    # 记录当前实体相关的页面，方便实体更新时，刷新页面缓存
+    # @params
+    # 1. object 直接传递实体对象
+    # 2. name, id 或者传递实体表名及id
+    def mark_cache_instance(*array)
+      name, id = array
+      object   = array.first
+      if id
+        name = name.downcase
+      else
+        name = object.class.table_name.downcase
+        id   = object.id
+      end
+      $redis.sadd("i:#{name}:#{id}", request.url)
+    end
+
+  end
+end

data/lib/redis_page.rb

@@ -0,0 +1 @@
+require 'redis_page/railtie'

data/redis_page.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_page/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_page"
+  spec.version       = RedisPage::VERSION
+  spec.authors       = ["saberma"]
+  spec.email         = ["mahb45@gmail.com"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  end
+
+  spec.summary       = %q{use redis to cache your rails page.}
+  spec.description   = %q{use redis to cache your rails page.}
+  spec.homepage      = "https://github.com/saberma/redis_page"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 4.0.9"
+  spec.add_dependency "actionpack", "~> 4.0.9"
+  spec.add_dependency "sidekiq", "~> 3.5.0"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: redis_page
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- saberma
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.9
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.9
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: use redis to cache your rails page.
+email:
+- mahb45@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/action_controller/caching/pages.rb
+- lib/action_controller/page_caching.rb
+- lib/redis_page.rb
+- lib/redis_page/railtie.rb
+- lib/redis_page/sweeper.rb
+- lib/redis_page/sweeper_worker.rb
+- lib/redis_page/version.rb
+- lib/redis_page/view_helpers.rb
+- redis_page.gemspec
+homepage: https://github.com/saberma/redis_page
+licenses:
+- MIT
+metadata:
+  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'' to prevent pushes to
+    rubygems.org, or delete to allow pushes to any server.'
+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.1.11
+signing_key: 
+specification_version: 4
+summary: use redis to cache your rails page.
+test_files: []