cache_tree 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "rcov", ">= 0"
+end
+
+gem 'isna'
+gem 'tree_node'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 kazuyoshi tlacaelel
+
+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.rdoc

@@ -0,0 +1,28 @@
+= cache_tree
+
+Btree based cache
+
+== Contributing to cache_tree
+
+    require 'rubygems'
+    require 'cache_tree'
+
+    class Record
+      def id
+        1
+      end
+    end
+
+    CacheTree::Node.directory = 'cache_tree'
+    record = CacheTree::Node.new(Record.new)
+    CacheTree::Manager.instance.use(record)
+    unless CacheTree::Manager.instance.exists?
+      CacheTree::Manager.instance.save('data')
+    end
+    puts CacheTree::Manager.instance.read
+
+== Copyright
+
+Copyright (c) 2012 kazuyoshi tlacaelel. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "cache_tree"
+  gem.homepage = "http://github.com/ktlacaelel/cache_tree"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple cache tree}
+  gem.description = %Q{Cache based on btrees, for large ammounts of cache.}
+  gem.email = "kazu.dev@gmail.com"
+  gem.authors = ["kazuyoshi tlacaelel"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cache_tree #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/cache_tree.rb

@@ -0,0 +1,155 @@
+require 'md5'
+require 'singleton'
+require 'fileutils'
+require 'isna'
+require 'tree_node'
+
+module CacheTree
+
+  class Manager
+
+    include Singleton
+
+    def initialize
+      @current_link   = nil
+      @configuration  = { :perform_caching => true }
+    end
+
+    def configure(options)
+      @configuration.merge(options)
+    end
+
+    def use(cache_link)
+      @current_link = cache_link
+    end
+
+    def exists?
+      return false unless @configuration[:perform_caching]
+      btree_key_files = @current_link.map(:up) { |node| node.btree_key }
+      return false unless btree_key_files.all? { |btree_key| File.exists?(btree_key) }
+      @current_link.map(:up) { |node| node.load_btree_key }
+      File.exists?(@current_link.cache_file)
+    end
+
+    def expire!
+      @current_link.expire
+    end
+
+    def read
+      @current_link.map(:up) { |node| node.load_btree_key }
+      File.read(@current_link.cache_file)
+    end
+
+    def save(data)
+      @current_link.map(:up) { |node| node.save }
+      FileUtils.mkdir_p(File.dirname(@current_link.cache_file))
+      File.open(@current_link.cache_file, 'w+') { |file| file.write data }
+    end
+
+  end
+
+  class Node
+
+    class << self
+      attr_accessor :directory
+    end
+
+    SEPARATOR = '/'
+
+    attr_accessor :name, :value, :stamp
+
+    include Tree::Node
+
+    def initialize(target)
+      @name  = target.class.name.gsub(/([A-Z])/) { "_#{$1}" }.gsub(/^./, '').downcase
+      @value = target.id
+      @stamp = generate_stamp
+    end
+
+    def directory
+      self.class.directory
+    end
+
+    def generate_stamp
+      (Time.now.to_f * 1.0).to_s + '-' + Kernel.rand(1000000).to_s
+    end
+
+    # Path of the cache node
+    def path
+      "#{name}#{SEPARATOR}#{value}#{SEPARATOR}"
+    end
+
+    # Resolves final name for btree_key file.
+    def btree_key
+      directory + SEPARATOR + (map(:up) { |node| node.path } * '') + 'btree.key'
+    end
+
+    # Updates current node stamp from btree_key
+    def load_btree_key
+      @stamp = eval(File.read(btree_key))
+    end
+
+    # Sums up all stamps and generates a checksum.
+    def checksum
+      MD5.hexdigest(map(:up) { |node| node.stamp } * '')
+    end
+
+    # Resolves final name for cache file.
+    def cache_file
+      directory + SEPARATOR + (map(:up) { |node| node.path } * '') + checksum + '.cache'
+    end
+
+    # Writes node stamp from to btree_key file
+    def save
+      FileUtils.mkdir_p File.dirname(btree_key)
+      File.open(btree_key, 'w+') { |file| file.write stamp.inspect }
+    end
+
+    # Quickly expire a whole cache-tree or a single node.
+    # Expiring a node in the middle will automatically expire all
+    # children nodes. no need to expire each one individually.
+    def expire
+      @stamp = generate_stamp
+      save
+    end
+
+    # Cleans up expired cache files for a specific node.
+    #
+    # You need to be specific the engine will not walk down the tree
+    # for you to prevent iterating through large trees.
+    #
+    # @return [Array] of items that were deleted.
+    def clean
+      diagnose[:dead].each { |file| FileUtils.rm file }
+    end
+
+    # Runs an analysis on a given node and returns its status.
+    #
+    # @return [Hash] with detailed diagnosis of curret status for that
+    # node's cache
+    def diagnose
+      file_alive             = cache_file
+      base                   = File.basename(file_alive)
+      dir                    = File.dirname(file_alive)
+      diagnostic             = {}
+      diagnostic[:btree_key] = btree_key
+      diagnostic[:alive]     = file_alive
+      diagnostic[:dead]      = []
+      Dir["#{dir}/*.cache"].each do |cached_file|
+        next if File.basename(cached_file) == base
+        diagnostic[:dead] << cached_file
+      end
+      diagnostic
+    end
+
+    # Prints out active cache in green, and expired files in red.
+    def debug
+      puts cache_file.to_ansi.green
+      diagnose[:dead].each { |file| puts file.to_ansi.red }
+      nil
+    end
+
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cache_tree'
+
+class Test::Unit::TestCase
+end

data/test/test_cache_tree.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestCacheTree < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification 
+name: cache_tree
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- kazuyoshi tlacaelel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-01 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: isna
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: tree_node
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rdoc
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 1
+        - 8
+        - 3
+        version: 1.8.3
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id007
+description: Cache based on btrees, for large ammounts of cache.
+email: kazu.dev@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/cache_tree.rb
+- test/helper.rb
+- test/test_cache_tree.rb
+has_rdoc: true
+homepage: http://github.com/ktlacaelel/cache_tree
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple cache tree
+test_files: []
+