object_cache 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in object_cache.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tom Caspy
+
+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/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tom Caspy
+
+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,43 @@
+# ObjectCache
+
+Simple object caching for ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'object_cache'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install object_cache
+
+## Usage
+
+in an initializer define ObjectCache.source "path_to_yml_file"
+and optional ObjectCache.ttl 5.minutes (or anything else)
+
+From that moment on you can use ObjectCache.key to access the object you defined as "key".
+
+The yml file looks like this:
+
+    key:
+      name: ClassName
+      id: 4
+    another_key:
+      name: ClassName
+      id: 5
+
+it assumes ClassName has a method find which can be used by ClassName.find([4,5]) and returns the correct objects. (usually ActiveRecord, but can be used for mongoid objects, etc.)
+
+## 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/README.rdoc

@@ -0,0 +1,19 @@
+= object_cache
+
+Description goes here.
+
+== Contributing to object_cache
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Tom Caspy. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/object_cache.rb

@@ -0,0 +1,63 @@
+require "object_reader"
+
+class ObjectCache
+  @@cache ||= {}
+  @@ttl ||= 60
+  @@file_or_hash ||= nil
+  @@reader ||= nil
+  @@expires_at ||= nil
+
+
+  def self.source(file_or_hash)
+    @@file_or_hash = file_or_hash
+  end
+
+  def self.expire_after(ttl)
+    @@ttl = ttl
+  end
+
+  def self.refresh_the_cache
+    @@reader ||= Reader.new(@@file_or_hash)
+    @@cache ||= {}
+
+    groups = @@reader.grouped_objects
+    groups.each do |klass, ids|
+      #we need both ids and items to be in the same order for this to work
+      ids.sort!{|a,b| b.first <=> a.first}
+      items = constantize(klass).find(ids.collect(&:last))
+      items.sort!{|a,b| b.id <=> a.id}
+
+      items.each do |item|
+        i ||= 0
+        @@cache[ids[i][0].to_s] = item
+        i+=1
+      end
+      
+    end
+    @@expires_at = Time.now + (@@ttl || 5.minutes)
+  end
+
+  def self.constantize(camel_cased_word)
+    names = camel_cased_word.split('::')
+    names.shift if names.empty? || names.first.empty?
+
+    constant = Object
+    names.each do |name|
+      constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+    end
+    constant
+  end
+
+  def self.hash
+    @@hash
+  end
+
+  def self.method_missing(method_name)
+    if @@cache.empty? || @@expires_at < Time.now
+      refresh_the_cache
+    end
+
+    @@cache[method_name.to_s]
+  end
+
+end

data/lib/object_cache/version.rb

@@ -0,0 +1,3 @@
+module ObjectCache
+  VERSION = "0.0.1"
+end

data/lib/object_reader.rb

@@ -0,0 +1,31 @@
+require 'yaml'
+
+class ObjectCache
+  class Reader
+    attr_accessor :hash
+
+    def initialize(source)
+
+      case source
+      when nil
+        raise Errno::ENOENT, "No file specified as ObjectCache source"
+      when Hash
+        self.hash = source
+      else
+        self.hash = YAML.load(ERB.new(open(source).read).result).to_hash
+      end
+
+    end
+
+    #creates a hashed key-value by the class names
+    def grouped_objects
+      product = {}
+      hash.each do |key,value|
+        product[value[:name]] ||= []
+        product[value[:name]] << [key, value[:id]]
+      end
+      product
+    end
+
+  end
+end

data/object_cache.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/object_cache/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tom Caspy"]
+  gem.email         = ["tcaspy@gmail.com"]
+  gem.description   = %q{simple object cache for ruby}
+  gem.summary       = %q{hash table for object cache with defined TTL}
+  gem.homepage      = "https://github.com/KensoDev/object_cache"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "object_cache"
+  gem.require_paths = ["lib"]
+  gem.version       = ObjectCache::VERSION
+
+  gem.add_development_dependency(%q<rspec>, [">= 0"])
+  gem.add_development_dependency(%q<rake>, ["~> 0.9.2"])
+end

data/spec/fixtures/foo.yml

@@ -0,0 +1,3 @@
+foo:
+  name: "User"
+  id: 1

data/spec/object_cache_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe ObjectCache do
+
+  describe "reading the yml file" do
+    it "should read yml to a hash" do
+      o=ObjectCache::Reader.new(File.dirname(__FILE__)+"/fixtures/foo.yml")
+      o.hash.class.should == Hash
+    end
+  end
+
+  describe "caching" do
+    before :all do
+      @hash = {
+        foo: {
+          name: "User",
+          id: 1
+        },
+        bar: {
+          name: "User",
+          id: 2
+        },
+        baz: {
+          name: "Blah",
+          id: 4
+        }
+      }
+
+      ObjectCache.source @hash
+
+      class User
+      end
+
+      class Blah
+      end
+    end
+
+    it "should cache all of the objects in the hash" do
+      u1 = double(User)
+      u2 = double(User)
+      u1.stub!(:id).and_return(1)
+      u2.stub!(:id).and_return(2)
+      b = double(Blah)
+      b.stub!(:id).and_return(10)
+      User.should_receive(:find).with([1,2]).and_return([u1,u2])
+      Blah.should_receive(:find).with([4]).and_return([b])
+
+      ObjectCache.foo.should == u1
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "object_cache"
+  RSpec.configure do |config|
+    # config.mock_with :mocha
+    # config.mock_with :flexmock
+    # config.mock_with :rr
+    config.mock_with :rspec
+  end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: object_cache
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tom Caspy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70360307204680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70360307204680
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70360307884400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70360307884400
+description: simple object cache for ruby
+email:
+- tcaspy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- lib/object_cache.rb
+- lib/object_cache/version.rb
+- lib/object_reader.rb
+- object_cache.gemspec
+- spec/fixtures/foo.yml
+- spec/object_cache_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/KensoDev/object_cache
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: hash table for object cache with defined TTL
+test_files:
+- spec/fixtures/foo.yml
+- spec/object_cache_spec.rb
+- spec/spec_helper.rb