json_cache 0.1.0

data/.document

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,18 @@
+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 "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem 'rr'
+end
+
+gem 'bson_ext'
+gem 'mharris_ext'
+gem 'mongoid'

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.3)
+    bson (1.2.0)
+    bson_ext (1.2.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    facets (2.9.0)
+    fattr (2.2.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    mharris_ext (1.5.0)
+      facets
+      fattr
+    mongo (1.2.0)
+      bson (>= 1.2.0)
+    mongoid (2.0.0.rc.7)
+      activemodel (~> 3.0)
+      mongo (~> 1.2)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rr (1.0.2)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    tzinfo (0.3.24)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  x86-mingw32
+
+DEPENDENCIES
+  bson_ext
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  mharris_ext
+  mongoid
+  rcov
+  rr
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 mharris717
+
+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,19 @@
+= json_cache
+
+Description goes here.
+
+== Contributing to json_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) 2011 mharris717. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+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 = "json_cache"
+  gem.homepage = "http://github.com/mharris717/json_cache"
+  gem.license = "MIT"
+  gem.summary = %Q{json_cache}
+  gem.description = %Q{json_cache}
+  gem.email = "mharris717@gmail.com"
+  gem.authors = ["mharris717"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "json_cache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/json_cache.gemspec

@@ -0,0 +1,79 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{json_cache}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["mharris717"]
+  s.date = %q{2011-02-25}
+  s.description = %q{json_cache}
+  s.email = %q{mharris717@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "json_cache.gemspec",
+    "lib/json_cache.rb",
+    "lib/json_cache/cache_manager.rb",
+    "lib/json_cache/call_result.rb",
+    "lib/json_cache/method_cache.rb",
+    "spec/json_cache_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mharris717/json_cache}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{json_cache}
+  s.test_files = [
+    "spec/json_cache_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<bson_ext>, [">= 0"])
+      s.add_runtime_dependency(%q<mharris_ext>, [">= 0"])
+      s.add_runtime_dependency(%q<mongoid>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rr>, [">= 0"])
+    else
+      s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<mharris_ext>, [">= 0"])
+      s.add_dependency(%q<mongoid>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rr>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<mharris_ext>, [">= 0"])
+    s.add_dependency(%q<mongoid>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rr>, [">= 0"])
+  end
+end
+

data/lib/json_cache/cache_manager.rb

@@ -0,0 +1,21 @@
+module JsonCache
+  class CacheManager
+    include FromHash
+    fattr(:caches) { {} }
+    def reg(name,ops={})
+      res = self.caches[name.to_sym] = JsonCache::MethodCache.new(ops.merge(:name => name))
+      yield(res) if block_given?
+    end 
+    def reg_simple(name,&b)
+      reg(name) do |c|
+        c.call_blk = b
+      end
+    end
+    def get_cache(name)
+      caches[name.to_sym] || (raise "no cache #{name}")
+    end
+    def method_missing(sym,*args,&b)
+      get_cache(sym).send(:get,*args,&b)
+    end
+  end
+end

data/lib/json_cache/call_result.rb

@@ -0,0 +1,8 @@
+module JsonCache
+  class CallResult
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    field "_query_params", :type => Hash
+    field "_query_name"
+  end
+end

data/lib/json_cache/method_cache.rb

@@ -0,0 +1,74 @@
+module JsonCache
+  class MethodCache
+    include FromHash
+    attr_accessor :name, :call_blk, :class_name, :class_blk
+    def call_blk(&b)
+      if block_given?
+        @call_blk = b
+      else
+        @call_blk
+      end
+    end
+    def class_blk(&b)
+      if block_given?
+        @class_blk = b
+      else
+        @class_blk
+      end
+    end
+    def ensure_class_exists
+      eval class_name
+    rescue
+      return make_class
+    end
+    def make_class
+      b = class_blk || lambda { |x| }
+      cls = Class.new(JsonCache::CallResult,&b)
+      Object.const_set(class_name,cls)
+      cls
+    end
+    fattr(:type_class) do
+      if class_name
+        ensure_class_exists
+      else
+        JsonCache::CallResult
+      end
+    end
+    def get_existing(ops)
+      a = type_class.where('_query_params' => ops)
+      f = a.first
+      if !f
+        nil
+      elsif f['_from_array']
+        a.to_a
+      else
+        f
+      end
+    end
+    def need?(ops)
+      !get_existing(ops)
+    end
+    def create_from_raw(raw,ops,from_array)
+      cr_hash = raw.merge('_query_params' => ops, '_query_name' => name, '_from_array' => from_array)
+      type_class.create!(cr_hash)
+    end
+    def get_fresh(ops)
+      res = call_blk[ops]
+      if res.kind_of?(Array)
+        res.map { |x| create_from_raw(x,ops,true) }
+      else
+        create_from_raw(res,ops,false)
+      end
+    end
+    def get(ops)
+      if need?(ops)
+        get_fresh(ops)
+      else
+        get_existing(ops)
+      end
+    end
+    def all
+      JsonCache::CallResult.where('_query_name' => name)
+    end
+  end
+end

data/lib/json_cache.rb

@@ -0,0 +1,12 @@
+require 'mharris_ext'
+require 'mongoid'
+
+Mongoid.configure do |config|
+  name = "json_cache_dev"
+  host = "mydesk"
+  config.master = Mongo::Connection.new(host).db(name)
+end
+
+%w(call_result method_cache cache_manager).each do |f|
+  require File.dirname(__FILE__) + "/json_cache/#{f}"
+end

data/spec/json_cache_spec.rb

@@ -0,0 +1,164 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+if false
+  class Thing < JsonCache::CallResult
+  end
+  
+  class Kernel::Thing < JsonCache::CallResult
+  end
+  JsonCache::CallResult.all.each { |x| x.destroy }
+  raise 'foo'
+end
+
+describe "JsonCache" do
+  describe 'method cache' do
+    def mc; @mc; end
+    def mc2; @mc2; end
+    before do
+      JsonCache::CallResult.delete_all
+      @blk = lambda do |num|
+        {'num' => num*2}
+      end
+      @mc = JsonCache::MethodCache.new(:name => 'test', :call_blk => @blk)
+    end
+    after do
+      JsonCache::CallResult.delete_all
+    end
+    it 'get first' do
+      mc.get(2)['num'].should == 4
+    end
+    it 'should need' do
+      mc.should be_need(2)
+    end
+    it 'initial get should return call result' do
+      mc.get(2).should be_kind_of(JsonCache::CallResult)
+    end
+    
+    describe 'already got' do
+      before do
+        mc.get(2)
+      end
+      it 'should save a call result' do
+        JsonCache::CallResult.where('_query_params' => 2).count.should == 1
+      end
+      it 'call result should have results' do
+        JsonCache::CallResult.where('_query_params' => 2).first.num.should == 4
+      end
+      it 'should not need' do
+        mc.should_not be_need(2)
+      end
+      it 'should need different query' do
+        mc.should be_need(3)
+      end
+      it 'should get result for diff query' do
+        mc.get(3)['num'].should == 6
+      end
+      it 'get again' do
+        dont_allow(mc).get_fresh(anything)
+        mc.get(2)
+      end
+    end
+    
+    describe 'call blk returns array' do
+      before do
+        mc.call_blk = lambda do |num|
+          [num,num*2].map { |x| {'num' => x} }
+        end
+      end
+      it 'should return 2 CallResults' do
+        mc.get(2).map { |x| x.class }.should == [JsonCache::CallResult,JsonCache::CallResult]
+      end
+      it '2nd get should result 2 CallResults' do
+        mc.get(2)
+        mc.get(2).should be_kind_of(Array)
+      end
+    end
+    
+    describe 'class block' do
+      before do
+        mc.class_name = 'Thing'
+        mc.class_blk = lambda do |x|
+          def num_plus(n)
+            num + n
+          end
+        end
+      end
+      
+      it 'smoke' do
+        mc.get(2).num.should == 4
+      end
+      it 'type_class' do
+        mc.type_class.should == Thing
+      end
+      it 'call blk method' do
+        mc.get(2).num_plus(3).should == 7
+      end
+      it 'obj class' do
+        mc.get(2).should be_kind_of(Thing)
+      end
+    end
+    
+    describe 'multiple caches, one with own class' do
+      before do
+        @mc2 = JsonCache::MethodCache.new(:name => 'test2', :call_blk => @blk)
+        mc2.class_name = 'Thing'
+        mc2.class_blk = lambda do |x|
+          def num_plus(n)
+            num + n
+          end
+        end
+      end
+      
+      describe 'each has been called' do
+        before do
+          mc.get(2)
+          mc2.get(3)
+        end
+        it 'should be 1 thing' do
+          Thing.count.should == 1
+          mc2.all.count.should == 1
+        end
+        it 'should be 2 call results' do
+          JsonCache::CallResult.count.should == 2
+          mc.all.count.should == 1
+        end
+      end
+    end
+
+  
+    it 'manager ugly test all' do
+      m = JsonCache::CacheManager.new
+      m.reg :nums, :class_name => 'Num' do |c|
+        c.call_blk do |num|
+          {'num' => num * 2}
+        end
+        c.class_blk do |unused|
+          def num_plus(n)
+            num + n
+          end
+        end
+      end
+      m.nums(2).num.should == 4
+      m.nums(2).num_plus(3).should == 7
+      m.get_cache(:nums).all.count.should == 1
+    end
+    
+    it 'manager ugly test all simple' do
+      m = JsonCache::CacheManager.new
+      m.reg_simple :nums do |num|
+        {'num' => num * 2}
+      end
+      
+      m.get_cache(:nums).type_class.should == JsonCache::CallResult
+      m.nums(2).num.should == 4
+      
+      m.nums(2).class.should == JsonCache::CallResult
+      m.nums(2).should_not be_respond_to(:num_plus)
+      lambda { m.nums(2).num_plus(3) }.should raise_error
+      
+      m.get_cache(:nums).all.count.should == 1
+    end
+  
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'json_cache'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rr
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification 
+name: json_cache
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- mharris717
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mharris_ext
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rr
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+description: json_cache
+email: mharris717@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- json_cache.gemspec
+- lib/json_cache.rb
+- lib/json_cache/cache_manager.rb
+- lib/json_cache/call_result.rb
+- lib/json_cache/method_cache.rb
+- spec/json_cache_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mharris717/json_cache
+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.5.2
+signing_key: 
+specification_version: 3
+summary: json_cache
+test_files: 
+- spec/json_cache_spec.rb
+- spec/spec_helper.rb