frivol 0.1.1

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Marc Heiligers
+
+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 @@
+= Frivol
+
+A really simple Redis-backed temporary storage mechanism.
+
+Also extends Time to allow it to be (de)serialized to JSON.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Marc Heiligers. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "frivol"
+    gem.summary = %Q{Simple Redis backed temporary storage}
+    gem.description = %Q{Simple Redis backed temporary storage intended primarily for use with ActiveRecord models to provide caching}
+    gem.email = "marc@eternal.co.za"
+    gem.homepage = "http://github.com/marcheiligers/frivol"
+    gem.authors = ["Marc Heiligers"]
+    gem.add_development_dependency "shoulda", ">= 2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "frivol #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/frivol.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{frivol}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marc Heiligers"]
+  s.date = %q{2010-08-20}
+  s.description = %q{Simple Redis backed temporary storage intended primarily for use with ActiveRecord models to provide caching}
+  s.email = %q{marc@eternal.co.za}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "frivol.gemspec",
+     "lib/frivol.rb",
+     "test/fake_redis.rb",
+     "test/helper.rb",
+     "test/test_frivol.rb"
+  ]
+  s.homepage = %q{http://github.com/marcheiligers/frivol}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Simple Redis backed temporary storage}
+  s.test_files = [
+    "test/fake_redis.rb",
+     "test/helper.rb",
+     "test/test_frivol.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 2"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 2"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 2"])
+  end
+end
+

data/lib/frivol.rb

@@ -0,0 +1,95 @@
+require "json"
+require "redis"
+
+module Frivol
+  def store(keys_and_values)
+    Frivol::Helpers.retrieve_hash self
+    keys_and_values.each do |key, value|
+      @frivol_hash[key.to_s] = value
+    end
+    Frivol::Helpers.store_hash self
+  end
+  
+  def retrieve(keys_and_defaults)
+    Frivol::Helpers.retrieve_hash self
+    result = keys_and_defaults.map do |key, default|
+      @frivol_hash[key.to_s] || (respond_to?(default) && send(default)) || default
+    end
+    return result.first if result.size == 1
+    result
+  end
+  
+  def expire_storage(time)
+    return if time.nil?
+    Frivol::Config.redis.expire storage_key, time
+  end
+  
+  def storage_key
+    @frivol_key ||= "#{self.class.name}-#{id}"
+  end
+  
+  module Config
+    def self.redis_config=(config)
+      @@redis = Redis.new(config)
+    end
+    
+    def self.redis
+      @@redis
+    end
+    
+    def self.include_in(host_class, storage_expires_in = nil)
+      host_class.send(:include, Frivol)
+      host_class.storage_expires_in storage_expires_in if storage_expires_in
+    end
+  end
+  
+  module Helpers
+    def self.store_hash(instance)
+      hash = instance.instance_variable_get(:@frivol_hash)
+      is_new = instance.instance_variable_get(:@frivol_is_new)
+      key = instance.send(:storage_key)
+      Frivol::Config.redis[key] = hash.to_json
+      if is_new
+        instance.expire_storage instance.class.storage_expiry
+        instance.instance_variable_set :@frivol_is_new, false
+      end
+    end
+
+    def self.retrieve_hash(instance)
+      return instance.instance_variable_get(:@frivol_hash) if instance.instance_variable_defined? :@frivol_hash
+      key = instance.send(:storage_key)
+      json = Frivol::Config.redis[key]
+      instance.instance_variable_set :@frivol_is_new, json.nil?
+      hash = json.nil? ? {} : JSON.parse(json)
+      instance.instance_variable_set :@frivol_hash, hash
+      hash
+    end
+  end
+  
+  module ClassMethods
+    def storage_expires_in(time)
+      @frivol_storage_expiry = time
+    end
+    
+    def storage_expiry
+      @frivol_storage_expiry
+    end
+  end
+  
+  def self.included(host)
+    host.extend(ClassMethods)
+  end
+end
+
+class Time
+  def to_json(*a)
+    {
+      'json_class'   => self.class.name,
+      'data'         => self.to_s
+    }.to_json(*a)
+  end
+
+  def self.json_create(o)
+    Time.parse(*o['data'])
+  end
+end

data/test/fake_redis.rb

@@ -0,0 +1,20 @@
+class Redis
+  def initialize(config)
+    @storage = {}
+  end
+
+  def [](key)
+    # puts "retrieve #{key}"
+    @storage[key]
+  end
+
+  def []=(key, value)
+    # puts "store #{key}"
+    @storage[key] = value
+  end
+
+  def expire(key, time)
+    # Hmm, let's not do anything here
+    # puts "expiring #{key} in #{time}"
+  end
+end

data/test/helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'frivol'
+
+class Test::Unit::TestCase
+  def fake_redis
+    require 'fake_redis'
+  end
+end
+
+class TestClass
+  include Frivol
+  
+  def id
+    1
+  end
+  
+  def save
+    store :value => "value"
+  end
+  
+  def load
+    retrieve :value => "junk"
+  end
+end

data/test/test_frivol.rb

@@ -0,0 +1,113 @@
+require 'helper'
+
+class TestFrivol < Test::Unit::TestCase
+  def setup 
+    fake_redis
+    Frivol::Config.redis_config = {}
+  end
+  
+  should "have a default storage key made up of the class name and id" do
+    t = TestClass.new
+    assert_equal "TestClass-1", t.storage_key
+  end
+  
+  should "store and retrieve data" do
+    t = TestClass.new
+    t.save
+    assert_equal "value", t.load
+  end
+  
+  should "return a default for a value that's not in storage" do
+    t = TestClass.new
+    assert_equal "junk", t.load
+  end
+  
+  should "save and retrieve multiple values" do
+    class MultiTestClass < TestClass
+      def save
+        store :val1 => 1, :val2 => 2
+      end
+      
+      def load
+        retrieve :val1 => nil, :val2 => nil
+      end
+    end
+    
+    t = MultiTestClass.new
+    t.save
+    assert_equal [ 1, 2 ], t.load
+  end
+  
+  should "get defaults from instance methods if defined" do
+    class DefaultsTestClass < TestClass
+      def load
+        retrieve :value => nil, :value2 => :value2_default
+      end
+      
+      def value2_default
+        "value2"
+      end
+    end
+    
+    t = DefaultsTestClass.new
+    t.save
+    assert_equal [ "value", "value2" ], t.load
+  end
+
+  should "be able to override the key method" do
+    class OverrideKeyTestClass < TestClass
+      def storage_key
+        "my_storage"
+      end
+    end
+    
+    t = OverrideKeyTestClass.new
+    t.save
+    assert_equal "value", t.load
+    assert Frivol::Config.redis["my_storage"]
+  end
+  
+  should "retain Times as Times" do
+    class TimeTestClass < TestClass
+      def save
+        store :t => Time.local(2010, 8, 20)
+      end
+      
+      def load
+        retrieve :t => nil
+      end
+    end
+  
+    t = TimeTestClass.new
+    t.save
+    assert_equal Time.local(2010, 8, 20), t.load
+  end
+  
+  should "expire storage the first time it's stored" do
+    class ExpiryTestClass < TestClass
+      storage_expires_in 60
+    end
+    
+    Frivol::Config.redis.expects(:expire).once
+    t = ExpiryTestClass.new
+    t.load
+    t.save
+    t.save
+  end
+  
+  should "be able to include in other classes with storage expiry" do
+    class BlankTestClass
+    end
+    Frivol::Config.include_in(BlankTestClass, 30)
+    t = BlankTestClass.new
+    assert t.respond_to? :store
+    assert_equal 30, BlankTestClass.storage_expiry
+  end
+  
+  should "return the already loaded hash if it's already loaded" do
+    Frivol::Config.redis.expects(:[]).once
+    t = TestClass.new
+    t.load
+    t.load
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: frivol
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Marc Heiligers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        version: "2"
+  type: :development
+  version_requirements: *id001
+description: Simple Redis backed temporary storage intended primarily for use with ActiveRecord models to provide caching
+email: marc@eternal.co.za
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- frivol.gemspec
+- lib/frivol.rb
+- test/fake_redis.rb
+- test/helper.rb
+- test/test_frivol.rb
+has_rdoc: true
+homepage: http://github.com/marcheiligers/frivol
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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 Redis backed temporary storage
+test_files: 
+- test/fake_redis.rb
+- test/helper.rb
+- test/test_frivol.rb