timed_fragment_cache 0.0.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/.rspec

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeroen Jacobs
+
+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,17 @@
+= timed_fragment_cache
+
+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) 2010 Jeroen Jacobs. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "timed_fragment_cache"
+    gem.summary = "Timed fragment caching"
+    gem.description = "You'll be able to automatically invalidate a cache on a specified time."
+    gem.email = "jj@redstorm.be"
+    gem.homepage = "http://github.com/jeroenj/timed_fragment_cache"
+    gem.authors = ["Jeroen Jacobs"]
+    gem.add_development_dependency "rspec", ">= 2.0.0.beta.15"
+    # 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 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "timed_fragment_cache #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1 @@
+require "#{File.dirname(__FILE__)}/rails/init"

data/lib/timed_fragment_cache.rb

@@ -0,0 +1,45 @@
+module ActionController
+  module Caching
+    module TimedFragment
+      def when_fragment_expired(name, expiry=nil)
+        if fragment_exist?(name)
+          if fragment_expired?(name)
+            expire_timed_fragment(name)
+            write_meta_fragment(name, expiry)
+            write_fragment(name, yield)
+          else
+            read_fragment(name)
+          end
+        else
+          write_meta_fragment(name, expiry)
+          write_fragment(name, yield)
+        end
+      end
+
+      def expire_timed_fragment(name)
+        expire_meta_fragment(name)
+        expire_fragment(name)
+      end
+
+      private
+      def fragment_expired?(name)
+        expiry = read_meta_fragment(name)
+        expiry && expiry < Time.zone.now
+      end
+
+      def write_meta_fragment(name, content)
+        write_fragment("#{name}_meta", content)
+      end
+
+      def read_meta_fragment(name)
+        read_fragment("#{name}_meta")
+      end
+
+      def expire_meta_fragment(name)
+        expire_fragment("#{name}_meta")
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, ActionController::Caching::TimedFragment

data/rails/init.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'timed_fragment_cache'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/timed_fragment_cache_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "TimedFragmentCache" do
+  it "is not covered yet, shame on me!" do
+    pending "It's about time that you cover this code, don't you think?"
+  end
+end

data/timed_fragment_cache.gemspec

@@ -0,0 +1,57 @@
+# 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{timed_fragment_cache}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeroen Jacobs"]
+  s.date = %q{2010-07-01}
+  s.description = %q{You'll be able to automatically invalidate a cache on a specified time.}
+  s.email = %q{jj@redstorm.be}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/timed_fragment_cache.rb",
+     "rails/init.rb",
+     "spec/spec_helper.rb",
+     "spec/timed_fragment_cache_spec.rb",
+     "timed_fragment_cache.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jeroenj/timed_fragment_cache}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Timed fragment caching}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/timed_fragment_cache_spec.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<rspec>, [">= 2.0.0.beta.15"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0.beta.15"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0.beta.15"])
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: timed_fragment_cache
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeroen Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-01 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 15
+        version: 2.0.0.beta.15
+  type: :development
+  version_requirements: *id001
+description: You'll be able to automatically invalidate a cache on a specified time.
+email: jj@redstorm.be
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .rspec
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/timed_fragment_cache.rb
+- rails/init.rb
+- spec/spec_helper.rb
+- spec/timed_fragment_cache_spec.rb
+- timed_fragment_cache.gemspec
+has_rdoc: true
+homepage: http://github.com/jeroenj/timed_fragment_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Timed fragment caching
+test_files: 
+- spec/spec_helper.rb
+- spec/timed_fragment_cache_spec.rb