feedtools_ram_cache 1.0.2 → 1.1

data/CHANGELOG

@@ -1,3 +1,5 @@
+v1.1. Offline mode for easy testing.
+
 v1.0.2. Minor improvements in implementation and documentation.
 
 v1.0.1. Fixed typo in dependency list.

data/README.textile

@@ -43,6 +43,22 @@ clean slate for testing.
 
 bc. FeedTools::RamFeedCache.clear
 
+h3. Offline Testing Mode
+
+One-line summary: use the following in your unit tests.
+
+bc. FeedTools::RamFeedCache.offline_mode = true
+
+The RAM-backed cache can be used for testing as follows. Test data is generated
+by clearing the cache, opening the feed to be tested, and saving the cache's
+state (perhaps by serializing to a YAML file). Testing code sets the cache state
+to the saved state, and opens the feed again.
+
+This strategy has the following issues: the code to be tested may clear the
+cache (my code does), and FeedTools will not use the cached data to see if it's
+stale. While the cache is in offline mode, it ignores clearing requests, and it
+pretends its items are fresh.
+
 h2. Naming Convention
 
 The naming scheme for this gem is confusing, but it is consistent with the

data/feedtools_ram_cache.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{feedtools_ram_cache}
-  s.version = "1.0.2"
+  s.version = "1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Victor Costan"]
-  s.date = %q{2009-09-21}
+  s.date = %q{2009-10-03}
   s.description = %q{RAM-based cache for FeedTools.}
   s.email = %q{victor@zergling.net}
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.textile", "lib/feed_tools_ram_cache.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.textile", "Rakefile", "lib/feed_tools_ram_cache.rb", "test/cache_test.rb", "test/fixtures/unit.yml", "test/integration_test.rb", "feedtools_ram_cache.gemspec"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.textile", "Rakefile", "lib/feed_tools_ram_cache.rb", "test/cache_test.rb", "test/fixtures/unit.yml", "test/integration_test.rb", "feedtools_ram_cache.gemspec", "test/offline_test.rb"]
   s.homepage = %q{http://github.com/costan/feed_tools_ram_cache}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Feedtools_ram_cache", "--main", "README.textile"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{zerglings}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{RAM-based cache for FeedTools.}
-  s.test_files = ["test/cache_test.rb", "test/integration_test.rb"]
+  s.test_files = ["test/cache_test.rb", "test/integration_test.rb", "test/offline_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/feed_tools_ram_cache.rb

@@ -37,8 +37,7 @@ class RamFeedCache
   
   # Removes all the cache items.
   def self.clear
-    @by_id, @by_href = nil, nil
-    initialize_cache    
+    # NOTE: Actual implementation supplied in offline_mode=.
   end
   
   # The number of entries in the cache.
@@ -81,6 +80,46 @@ class RamFeedCache
     @fields[:id].nil? ? true : false
   end
   
+  # Enters or exits offline testing mode.
+  #
+  # In offline testing mode, cache clearing requests are ignored, and items
+  # pretend that they are fresh. Warning: this means items won't pretend like
+  # dumb ActiveRecord objects, and may fail unit tests that treat them as such.
+  def self.offline_mode=(offline)
+    if offline  # Pretend items are live to stay offline.
+      undef :last_retrieved, :time_to_live
+      def last_retrieved
+        Time.now
+      end
+      def time_to_live
+        86400  # A day since last_retrieved was read, should avoid re-fetching.
+      end      
+      
+      class <<self
+        undef :clear
+        def clear
+          initialize_cache
+        end
+      end
+    else  # Going online is OK, don't lie about the cache state.
+      undef :last_retrieved, :time_to_live
+      def last_retrieved
+        @fields[:last_retrieved]
+      end
+      def time_to_live
+        @fields[:time_to_live]
+      end      
+      class <<self
+        undef :clear
+        def clear
+          @by_id, @by_href = nil, nil
+          initialize_cache
+        end
+      end
+    end
+  end
+  self.offline_mode = false
+  
   # Called by FeedTools to initialize the cache.
   def self.initialize_cache
     # NOTE: the FeedTools documentation says this will be called once. In fact,

data/test/offline_test.rb

@@ -0,0 +1,27 @@
+# Author:: Victor Costan
+# Copyright:: Copyright (C) 2009 Zergling.Net
+# License:: MIT
+
+require 'feed_tools_ram_cache'
+require 'test/unit'
+
+
+class OfflineTest < Test::Unit::TestCase
+  def setup
+    FeedTools.configurations[:feed_cache] = FeedTools::RamFeedCache
+    fixtures_path = File.join File.dirname(__FILE__), 'fixtures' 
+    FeedTools::RamFeedCache.state =
+        YAML.load File.read(File.join(fixtures_path, 'expired_cache.yml'))    
+    @url = "http://events.mit.edu/rss/"
+  end
+  
+  def test_offline_and_online
+    FeedTools::RamFeedCache.offline_mode = true
+    feed = FeedTools::Feed.open @url
+    assert !feed.live?, "Offline mode resulted in live feed"
+    
+    FeedTools::RamFeedCache.offline_mode = false
+    feed = FeedTools::Feed.open @url
+    assert feed.live?, "Online mode read expired feed"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: feedtools_ram_cache
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: "1.1"
 platform: ruby
 authors: 
 - Victor Costan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-21 00:00:00 -04:00
+date: 2009-10-03 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,3 +100,4 @@ summary: RAM-based cache for FeedTools.
 test_files: 
 - test/cache_test.rb
 - test/integration_test.rb
+- test/offline_test.rb