qor_cache 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+schema.rb

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'qor_dsl', :path => '../qor_dsl'
+gem 'qor_test', :path => '../qor_test'
+
+gem 'factory_girl_rails'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jinzhu
+
+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,60 @@
+Qor Cache
+=========
+
+## Usage
+
+    # config/qor/cache.rb
+    cache_key "product" do
+      [Product, Collection]
+    end
+
+    cache_key "current_season" do
+      Season.current
+    end
+
+    scope :color_variation do
+      cache_method :heavy_method_related_to_products, 'product'
+      cache_method :heavy_method_related_to_product do |s|
+        s.product
+      end
+
+      cache_class_method :heavy_class_method
+      cache_class_method :heavy_class_method_related_to_current_season, 'current_season'
+
+      cache_field :product_code, :from => [:product, :code]
+    end
+
+
+    # app/models/color_variation.rb
+    def heavy_method_related_to_products
+      Product.all.map(&:id).sum
+    end
+
+    def heavy_method_related_to_product
+      product.size_variations.map(&:id).sum
+    end
+
+    def self.heavy_class_method
+      self.all.map {|x| x.id}.sum
+    end
+
+    def self.heavy_class_method_related_to_current_season
+      where(:season_id => Season.current.id).map {|x| x.id}.sum
+    end
+
+    # app/views/xxx.html.erb
+    cache qor_cache_key('product', 'current_season') do
+      xxxxx
+    end
+
+    cache qor_cache_key('product') { current_user.role } do
+      xxxxx
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+
+require 'rake'
+require 'rubygems/package_task'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/config/qor/cache.rb

@@ -0,0 +1,31 @@
+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_method_with_args
+
+  cache_class_method :slow_class_method
+  cache_class_method :slow_class_method_with_args
+end
+
+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

data/config/qor/test.rb

@@ -0,0 +1,25 @@
+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"
+
+# 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"}]
+
+# 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
+  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']
+end

data/lib/qor_cache/active_record.rb

@@ -0,0 +1,68 @@
+module Qor
+  module Cache
+    module ActiveRecord
+      def self.included(base)
+        base.extend SingletonMethods
+        base.send :include, InstanceMethods
+        base.after_save :_qor_cache_expire
+        base.after_destroy :_qor_cache_expire
+
+        base.before_create :_qor_cache_sync_cached_fields
+        base.after_save :_qor_cache_sync_qor_cache_fields
+      end
+    end
+
+    module SingletonMethods
+      def _qor_cache_key
+        "#{self.name}-cache_key"
+      end
+
+      def cache_key
+        Qor::Cache::Base.cache_store.fetch(_qor_cache_key) do
+          key = self.name.to_s
+          key << Time.now.to_i.to_s
+          key << rand.to_s
+          Digest::SHA1.hexdigest(key)
+        end
+      end
+
+      def _qor_cache_expire
+        Qor::Cache::Base.cache_store.delete(_qor_cache_key)
+        true
+      end
+    end
+
+    module InstanceMethods
+      def _qor_cache_expire
+        self.class._qor_cache_expire
+      end
+
+      def _qor_cache_sync_cached_fields
+        nodes = Qor::Cache::Configuration.deep_find(:cache_field) do |node|
+          node.parent.is_node?(:scope, self.class.name.demodulize.underscore)
+        end
+
+        nodes.map do |node|
+          obj = node.options[:from].inject(self) { |obj, value| obj.try(value) }
+          self.send("#{node.name}=", obj)
+        end
+      end
+
+      def _qor_cache_sync_qor_cache_fields
+        nodes = Qor::Cache::Configuration.deep_find(:cache_field) do |node|
+          node.options[:from][-2].to_sym == self.class.name.demodulize.underscore.to_sym
+        end
+
+        nodes.map do |node|
+          node_model = node.parent.name.to_s.classify.constantize
+          fk = self.class.reflections.select {|name, ref| ref.klass == node_model}.first.last.foreign_key
+
+          node_method = node.options[:from][-1]
+          updates = {node.name => try(node_method)}
+
+          node_model.update_all(updates, ["#{fk} = ?", self.id]) if updates.present?
+        end
+      end
+    end
+  end
+end

data/lib/qor_cache/configuration.rb

@@ -0,0 +1,16 @@
+module Qor
+  module Cache
+    class Configuration
+      include Qor::Dsl
+
+      default_configs ["config/qor/cache.rb"]
+
+      node :cache_key
+      node :scope do
+        node :cache_class_method
+        node :cache_method
+        node :cache_field
+      end
+    end
+  end
+end

data/lib/qor_cache/kernel.rb

@@ -0,0 +1,17 @@
+require "digest/md5"
+
+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?
+
+    results = objs.map do |obj|
+      Array(obj).map {|x| x.respond_to?(:cache_key) ? x.cache_key : x.inspect }.join("-")
+    end
+
+    Digest::MD5.hexdigest(results.join("-"))
+  rescue
+    puts $!
+    rand()
+  end
+end

data/lib/qor_cache/railtie.rb

@@ -0,0 +1,17 @@
+module Qor
+  module Cache
+    class Railtie < Rails::Railtie
+
+      initializer "insert_active_record_methods_for_qor_cache" do
+        ActiveSupport.on_load(:active_record) do
+          ::ActiveRecord::Base.send :include, ::Qor::Cache::ActiveRecord
+        end
+      end
+
+      initializer "qor_cache_init_cache_method", :after => "insert_active_record_methods_for_qor_cache" do
+        Qor::Cache::Base.init_cache_methods
+        Qor::Cache::Base.init_cache_class_methods
+      end
+    end
+  end
+end

data/lib/qor_cache/version.rb

@@ -0,0 +1,5 @@
+module Qor
+  module Cache
+    VERSION = "0.0.1"
+  end
+end

data/lib/qor_cache.rb

@@ -0,0 +1,73 @@
+require "qor_cache/configuration"
+require "qor_cache/active_record"
+require "qor_cache/railtie"
+require "qor_cache/kernel"
+require "digest/md5"
+
+module Qor
+  module Cache
+    class Base
+      def self.cache_store
+        @cache_store || Rails.cache
+      end
+
+      def self.init_cache_methods
+        Qor::Cache::Configuration.find(:scope).map do |m|
+          model = m.name.to_s.classify.constantize
+
+          m.find(:cache_method).map do |node|
+            method = node.name
+            original_method = "_uncached_#{method}_for_qor_cache".to_sym
+
+            model.class_eval do
+              alias_method original_method, method
+
+              define_method(method) do |*args|
+                _cache_key = Digest::MD5.hexdigest([
+                  method,
+                  node.block ? qor_cache_key { node.block.call(self) } : nil,
+                  node.data.map {|x| qor_cache_key(x) },
+                  cache_key,
+                  args.map(&:inspect).join("-")
+                ].map(&:to_s).join("-"))
+
+                Qor::Cache::Base.cache_store.fetch(_cache_key) do
+                  self.send(original_method, *args)
+                end
+              end
+            end
+          end
+        end
+      end
+
+      def self.init_cache_class_methods
+        Qor::Cache::Configuration.find(:scope).map do |m|
+          model = m.name.to_s.classify.constantize
+          m.find(:cache_class_method).map do |node|
+            method = node.name
+            original_method = "_uncached_#{method}_for_qor_cache".to_sym
+
+            model.instance_eval <<-EOS, __FILE__, __LINE__ + 1
+              class << self
+                alias :#{original_method} :#{method}
+              end
+
+              def self.#{method}(*args)
+                _cache_key = Digest::MD5.hexdigest([
+                  :#{method},
+                  #{node.data}.map {|x| qor_cache_key(x) },
+                  cache_key,
+                  args.map(&:inspect).join("-")
+                ].map(&:to_s).join("-"))
+
+                Qor::Cache::Base.cache_store.fetch(_cache_key) do
+                  self.send(:#{original_method}, *args)
+                end
+              end
+            EOS
+          end
+        end
+      end
+    end
+  end
+end

data/qor_cache.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qor_cache/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "qor_cache"
+  gem.version       = Qor::Cache::VERSION
+  gem.authors       = ["Jinzhu"]
+  gem.email         = ["wosmvp@gmail.com"]
+  gem.description   = %q{Qor Cache}
+  gem.summary       = %q{Qor Cache}
+  gem.homepage      = ""
+
+  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"]
+
+  gem.add_dependency "qor_test"
+  gem.add_dependency "qor_dsl"
+  gem.add_dependency "rails"
+  gem.add_development_dependency "sqlite3"
+end

data/test/dummy/.gitignore

@@ -0,0 +1,2 @@
+*log
+*sqlite3

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks