redvex-ar_cache 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+0.1.0 - Initial release

data/Manifest

@@ -0,0 +1,7 @@
+ar_cache.gemspec
+CHANGELOG
+init.rb
+lib/ar_cache.rb
+Manifest
+Rakefile
+README.rdoc

data/README.rdoc

@@ -0,0 +1,59 @@
+Performe ActiveRecord cache in File System for heavy and repetitive query.
+
+==Licence
+
+Copyright 2009 Redvex. Distributes under the same terms as Ruby
+
+If you use this software, please make a donation[https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=7415509]
+
+==Features
+
+* Perform any ActiveRecord Query
+* Set time of expire in database configuration
+* Obtain an Hash as u obtain from active record
+* Support for ActiveRecord shortcuts through (cache_find_first, cache_find_last, cache_find_all)
+
+=Usage
+
+==Installation
+* gem sources -a http://gems.github.com
+* gem install ar_cache
+
+==Use ActiveRecord Cache
+
+If you want to perform a standard call using cache u can try
+
+* Object.cache_find(id, params)
+
+EX.
+* Object.cache_find(10)
+or
+* Object.cache_find(:all, :conditions => ['field>?',5])
+
+If you want to use an active record shortcuts you can:
+
+* Object.cache_find_first(params)
+* Object.cache_find_last(params)
+* Object.cache_find_all(params)
+
+EX.
+
+* Object.cache_find_first
+* Object.cache_find_last
+* Object.cache_find_all(:conditions => ['filed>?', 5])
+
+==Cache reset
+If you want to reset cache after predetermined amount of time you can specify time in database.yml config file through cache_expire directive:
+
+* cache_expire: 30.seconds
+* cache_expire: 2.hours
+* cache_expire: 1.day
+* cache_expire: 1.month
+
+If you want to force the expire the cache manually you can call the method
+
+* cache_reset!(id, params=nil)
+or shortcuts
+* cache_reset_first!(params=nil)
+* cache_reset_last!(params=nil)
+* cache_reset_all!(params=nil)

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('ar_cache', '0.1.0') do |p|
+  p.description    = "Performe ActiveRecord cache in File System for heavy and repetitive query."
+  p.url            = "http://github.com/redvex/ar_cache"
+  p.author         = "Gianni Mazza"
+  p.email          = "redvex@me.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.runtime_dependencies = ['json']
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/ar_cache.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar_cache}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Gianni Mazza"]
+  s.date = %q{2009-08-11}
+  s.description = %q{Performe ActiveRecord cache in File System for heavy and repetitive query.}
+  s.email = %q{redvex@me.com}
+  s.extra_rdoc_files = ["CHANGELOG", "lib/ar_cache.rb", "README.rdoc"]
+  s.files = ["ar_cache.gemspec", "CHANGELOG", "init.rb", "lib/ar_cache.rb", "Manifest", "Rakefile", "README.rdoc"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/redvex/ar_cache}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Ar_cache", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ar_cache}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Performe ActiveRecord cache in File System for heavy and repetitive query.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'ar_cache'

data/lib/ar_cache.rb

@@ -0,0 +1,121 @@
+# AR_Cache o ActiveRecord Cache Performe ActiveRecord 
+# cache in File System for heavy and repetitive query.
+#
+# Author::    Gianni Mazza  (mailto:redvex@me.com)
+# Copyright:: Copyright (c) Redvex
+# License::   Distributes under the same terms as Ruby
+
+module ArCache
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  def ensure_unique(name)
+    begin
+      self[name] = yield
+    end while self.class.exists?(name => self[name])
+  end
+  
+  module ClassMethods
+    # Perform a query on dabatase and store result in FileSystem.
+    #
+    # To uniquify the file name the library calculate MD5 hash for classname, id and params,
+    # if result for query exist and isn't expired it return the cached result otherwise DB
+    # is queried and the results is stored in FileSystem.
+    # TODO: Support for Eeager-loading
+    def cache_find(id, params=nil)
+      class_name = self.class.name
+      
+      if (params.nil?)
+        params = Array.new
+      end
+      
+      filename   = calculate_file_name(id, params)
+      if cache_reset?(filename)
+        cache_reset!(id, params)
+      end
+      
+      if File.exist?(filename)
+        content = File.read(filename)
+        toReturn = JSON.parse(content)
+      else
+        toReturn = self.find(id, params)
+        File.open(filename, 'w') do |f|
+          f.write toReturn.to_json
+          f.close
+        end
+        toReturn = JSON.parse(toReturn.to_json)
+      end
+      if toReturn.count > 1
+        out = Array.new
+        toReturn.each do |obj|
+          out << hash_to_obj(obj.values.first)
+        end
+      else
+        toReturn = toReturn.first
+        out = hash_to_obj(toReturn.values.first)
+      end
+      return out
+    end
+    
+    def cache_find_first(params=nil)
+      return cache_find(:first, params)
+    end
+    
+    def cache_find_last(params=nil)
+      return cache_find(:last, params)
+    end
+    
+    def cache_find_all(params=nil)
+      return cache_find(:all, params)
+    end
+    
+    def cache_reset_first!(params=nil)
+      return cache_reset(:first, params)
+    end
+    
+    def cache_reset_last!(params=nil)
+      return cache_reset(:last, params)
+    end
+    
+    def cache_reset_all!(params=nil)
+      return cache_reset(:all, params)
+    end
+    
+    def cache_reset!(id, params=nil)
+      filename   = calculate_file_name(id, params)
+      File.delete(filename)
+    end
+    
+  private
+    def hash_to_obj(hash)
+      tmp = self.new
+      hash.each do |k,v|
+        unless v.nil? or v.is_a?(Numeric)
+          v = v.gsub('"',"'")
+        end
+        eval(sprintf('tmp.%s = "%s"',k,v))
+      end
+      return tmp
+    end
+    
+    def cache_reset?(file)
+      filename   = File.join(RAILS_ROOT, "config", "database.yml")
+      dbconf = YAML.load_file(filename)[RAILS_ENV]
+      if dbconf["cache_expire"].nil?
+        return false
+      else
+        return File.open(file).ctime + dbconf["cache_expire"] > Time.now
+      end
+    end
+    
+    def calculate_file_name(id, params)
+      File.join(RAILS_ROOT, "tmp", "cache", 
+                            Digest::MD5.hexdigest(class_name + "--" + id.to_s + "--"+ params.values.join("--"))+".query")
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include ArCache
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: redvex-ar_cache
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Gianni Mazza
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-11 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Performe ActiveRecord cache in File System for heavy and repetitive query.
+email: redvex@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- lib/ar_cache.rb
+- README.rdoc
+files: 
+- ar_cache.gemspec
+- CHANGELOG
+- init.rb
+- lib/ar_cache.rb
+- Manifest
+- Rakefile
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/redvex/ar_cache
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Ar_cache
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: ar_cache
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 2
+summary: Performe ActiveRecord cache in File System for heavy and repetitive query.
+test_files: []
+