laserlemon-cache_flow 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Steve Richert
+
+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,18 @@
+= cache_flow
+
+Description goes here.
+
+== 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) 2009 laserlemon. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |g|
+    g.name = 'cache_flow'
+    g.summary = %(Easily cache ActiveRecord's to_xml and to_json outputs)
+    g.description = %(Easily cache ActiveRecord's to_xml and to_json outputs)
+    g.email = 'steve@laserlemon.com'
+    g.homepage = 'http://github.com/laserlemon/cache_flow'
+    g.authors = %w(laserlemon)
+    g.add_development_dependency 'thoughtbot-shoulda'
+  end
+rescue LoadError
+  puts 'Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com'
+end
+
+Rake::TestTask.new do |t|
+  t.libs = %w(test)
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test
+
+Rake::RDocTask.new do |r|
+  version = File.exist?('VERSION') ? File.read('VERSION') : nil
+  r.rdoc_dir = 'rdoc'
+  r.title = ['cache_flow', version].compact.join(' ')
+  r.rdoc_files.include('README*')
+  r.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/cache_flow.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cache_flow}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["laserlemon"]
+  s.date = %q{2009-08-28}
+  s.description = %q{Easily cache ActiveRecord's to_xml and to_json outputs}
+  s.email = %q{steve@laserlemon.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cache_flow.gemspec",
+     "init.rb",
+     "lib/cache_flow.rb",
+     "test/cache_flow_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/laserlemon/cache_flow}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Easily cache ActiveRecord's to_xml and to_json outputs}
+  s.test_files = [
+    "test/cache_flow_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end

data/init.rb

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

data/lib/cache_flow.rb

@@ -0,0 +1,72 @@
+module LaserLemon
+  module CacheFlow
+    def self.included(base)
+      base.class_eval do
+        class_inheritable_accessor :cache_serialization
+        self.cache_serialization = false
+
+        extend ClassMethods
+        include InstanceMethods
+
+        alias_method_chain :to_xml, :cache_flow
+        alias_method_chain :to_json, :cache_flow
+      end
+    end
+
+    module ClassMethods
+      def cache_flow(value = true)
+        if block_given?
+          old_value = cache_serialization
+          begin
+            self.cache_serialization = value
+            yield
+          ensure
+            self.cache_serialization = old_value
+          end
+        else
+          self.cache_serialization = value
+        end
+      end
+    end
+
+    module InstanceMethods
+      def to_xml_with_cache_flow(options = {})
+        with_cache_flow(:xml, options) do
+          to_xml_without_cache_flow(options)
+        end
+      end
+
+      def to_json_with_cache_flow(options = {})
+        with_cache_flow(:json, options) do
+          to_json_without_cache_flow(options)
+        end
+      end
+
+      private
+
+        def with_cache_flow(extension, options, &block)
+          if options.has_key?(:cache) ? options.delete(:cache) : self.class.cache_serialization
+            options.merge!(:cache => false)
+            key = send("#{extension}_cache_key", options)
+            Rails.cache.fetch(key){ yield }
+          else
+            yield
+          end
+        end
+
+        def xml_cache_key(options)
+          serialized_cache_key(:xml, options.except(:builder))
+        end
+
+        def json_cache_key(options)
+          serialized_cache_key(:json, options)
+        end
+
+        def serialized_cache_key(extension, options)
+          ["#{cache_key}.#{extension}", options.except(:cache).to_query].delete_if(&:blank?).join('?')
+        end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, LaserLemon::CacheFlow)

data/test/cache_flow_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CacheFlowTest < 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

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'cache_flow'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: laserlemon-cache_flow
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- laserlemon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Easily cache ActiveRecord's to_xml and to_json outputs
+email: steve@laserlemon.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- cache_flow.gemspec
+- init.rb
+- lib/cache_flow.rb
+- test/cache_flow_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/laserlemon/cache_flow
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Easily cache ActiveRecord's to_xml and to_json outputs
+test_files: 
+- test/cache_flow_test.rb
+- test/test_helper.rb