feedtools_ram_cache 1.0.1 → 1.0.2

data/CHANGELOG

@@ -1,3 +1,5 @@
+v1.0.2. Minor improvements in implementation and documentation.
+
 v1.0.1. Fixed typo in dependency list.
 
 v1.0. Initial release, tested to work with FeedTools 0.2.29.

data/README.textile

@@ -18,8 +18,11 @@ h2. Usage
 The gem does not interfere with the FeedTools API. To enable RAM-based caching,
 require the gem and configure FeedTools to use it:
 
-bc. require 'feed_tools_ram_cache'
-FeedTools.configurations[:feed_cache] = 'RamFeedCache' 
+bc. # Configure FeedTools to use the RAM-backed cache.
+require 'feed_tools_ram_cache'
+FeedTools.configurations[:feed_cache] = FeedTools::RamFeedCache
+
+In Rails, the code above can be placed in an initializer.
 
 h3. Serializing the Cache State
 

data/feedtools_ram_cache.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{feedtools_ram_cache}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   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-20}
+  s.date = %q{2009-09-21}
   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"]

data/lib/feed_tools_ram_cache.rb

@@ -40,6 +40,11 @@ class RamFeedCache
     @by_id, @by_href = nil, nil
     initialize_cache    
   end
+  
+  # The number of entries in the cache.
+  def self.length
+    @by_id.length
+  end
     
   # Fields required by FeedTools.
   #
@@ -71,6 +76,11 @@ class RamFeedCache
     true
   end
   
+  # Called by FeedTools.
+  def new_record?
+    @fields[:id].nil? ? true : false
+  end
+  
   # 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/cache_test.rb

@@ -50,6 +50,11 @@ class CacheTest < Test::Unit::TestCase
     _check_state item
   end
   
+  def test_length
+    assert_equal 4, Cache.length, 'Incorrect number of cache entries'
+  end
+   
+  
   def test_find_by_id
     assert_equal nil, Cache.find_by_id(0), 'ID 0 should not exist'
     assert_equal 'google', Cache.find_by_id(1).href
@@ -80,22 +85,21 @@ class CacheTest < Test::Unit::TestCase
   end
   
   def test_state_storing
-    #File.open('test/fixtures/unit.yml', 'w') do |f|
-    #  YAML.dump Cache.state, f
-    #end
     assert_equal @golden_state, Cache.state
   end
   
   def test_clear
     Cache.clear
-    assert_equal nil, Cache.find_by_id(1), 'Cache not deleted - found ID 1'
+    assert_equal 0, Cache.length, 'Cache not cleared -- found entries'
+    assert_equal nil, Cache.find_by_id(1), 'Cache not cleared - found ID 1'
     assert_equal nil, Cache.find_by_href('google'),
-                 'Cache not deleted - found HREF google'  
+                 'Cache not cleared - found HREF google'
   end
   
   def test_state_loading
     Cache.state = [{:id => 1}]
     
+    assert_equal 1, Cache.length, 'Cache state not reset, too many entries'
     assert_equal nil, Cache.find_by_id(2), 'Cache state not reset - found ID 2'
     assert_equal nil, Cache.find_by_href('google'),
                  'Cache state not reset - found google'
@@ -105,6 +109,7 @@ class CacheTest < Test::Unit::TestCase
     Cache.clear
     Cache.state = @golden_state
     
+    test_length
     test_find_by_id
     test_find_by_href
     test_equality

data/test/integration_test.rb

@@ -11,7 +11,7 @@ require 'open-uri'
 
 class IntegrationTest < Test::Unit::TestCase
   def setup
-    FeedTools.configurations[:feed_cache] = 'RamFeedCache'
+    FeedTools.configurations[:feed_cache] = FeedTools::RamFeedCache
     FeedTools::RamFeedCache.clear
   end
   
@@ -27,13 +27,23 @@ class IntegrationTest < Test::Unit::TestCase
   
   def _test_cache(uri)
     feed, cached_feed = nil, nil
-    time = Benchmark.realtime { feed = FeedTools::Feed.open uri }
+    time = Benchmark.realtime do
+      feed = FeedTools::Feed.open(uri)
+      # NOTE: would like to include item instantiation, but it turns out parsing
+      #       takes forever and dominates the running time
+      # feed.items.each { |item| item.description } 
+    end
     
     # Make sure the cache's state is YAML-serializable
     yaml_state = FeedTools::RamFeedCache.state.to_yaml
     FeedTools::RamFeedCache.state = YAML.load yaml_state
     
-    cached_time = Benchmark.realtime { cached_feed = FeedTools::Feed.open uri }
+    cached_time = Benchmark.realtime do
+      cached_feed = FeedTools::Feed.open uri
+      # NOTE: would like to include item instantiation, but it turns out parsing
+      #       takes forever and dominates the running time
+      # cached_feed.items.each { |item| item.description } 
+    end
 
     assert !cached_feed.live?, 'cached_feed is live?'
     assert_operator cached_time, :< , time / 3,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: feedtools_ram_cache
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Victor Costan
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-20 00:00:00 -04:00
+date: 2009-09-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency