concord_cacher 0.0.2 → 0.0.3

data/Rakefile

@@ -6,7 +6,7 @@ require 'spec/rake/spectask'
 require './lib/concord_cacher.rb'
 
 require 'echoe'
-Echoe.new('concord_cacher', '0.0.2') do |p|
+Echoe.new('concord_cacher', '0.0.3') do |p|
   p.description    = "concord_cacher provides support for locally caching a resource and all referenced resources in multiple different ways. It is intended for using with other Concord Consortium projects and not necessarily for outside projects."
   p.summary        = "Support for locally caching a resource and all referenced resources in multiple different ways"
   p.url            = "http://github.com/psndcsrv/concord_cacher"

data/concord_cacher.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{concord_cacher}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Unger"]
   s.cert_chain = ["/Users/aunger/gem-public_cert.pem"]
-  s.date = %q{2010-03-25}
+  s.date = %q{2010-03-26}
   s.description = %q{concord_cacher provides support for locally caching a resource and all referenced resources in multiple different ways. It is intended for using with other Concord Consortium projects and not necessarily for outside projects.}
   s.email = %q{aunger @nospam@ concord.org}
   s.extra_rdoc_files = ["README.textile", "lib/concord_cacher.rb", "lib/concord/cacher.rb", "lib/concord/diy_local_cacher.rb", "lib/concord/java_proxy_cacher.rb"]

data/lib/concord/diy_local_cacher.rb

@@ -1,6 +1,7 @@
 class ::Concord::DiyLocalCacher < ::Concord::Cacher
   require 'uri'
   require 'digest/sha1'
+  require 'fileutils'
   
   def initialize(opts = {})
     raise InvalidArgumentError, "Must include :activity in the options hash." unless opts[:activity]
@@ -21,11 +22,14 @@ class ::Concord::DiyLocalCacher < ::Concord::Cacher
   
   def generate_filename(opts = {})
     raise InvalidArgumentError, "Must include :url key in opts" unless opts[:url]
-    url = opts[:url]
-    if url.kind_of?(::URI) && url.scheme == 'file'
-      url = url.path
-    end
-    url = url.to_s
-    return ::Digest::SHA1.hexdigest(url)
+    raise InvalidArgumentError, ":url value must be an instance of URI" unless opts[:url].kind_of?(::URI)
+    uri = opts[:url]
+    uri_path = uri.path.split('/')
+    uri_path = ["","index.html"] if uri_path.size == 0
+    uri_path.unshift("") if uri_path.size == 1
+    file_dir = File.join("#{uri.scheme}","#{uri.host}","#{uri.port}",uri_path[0..-2])
+    file = uri_path[-1]
+    mkdir_p(File.join(@cache_dir,file_dir))
+    return File.join(file_dir,file)
   end
 end

data/spec/diy_local_cacher_spec.rb

@@ -30,12 +30,31 @@ describe 'DIY Local Cacher' do
     @cache += '/'
   end
   
+  after(:each) do
+    rm_rf(@cache)
+  end
+  
   def mockup(file)
     return mock('activity',{:uuid => 'hash', :url => file})
   end
   
-  after(:each) do
-    rm_rf(@cache)
+  def filename_for(url, parent=nil)
+    uri = nil
+    if parent
+      parent_uri = URI.parse(parent)
+      parent_uri = URI.parse("file:///").merge(parent_uri) if parent_uri.relative?
+        
+      uri = parent_uri.merge(url)
+    else
+      uri = URI.parse(url)
+    end
+
+    uri_path = uri.path.split('/')
+    uri_path = ["","index.html"] if uri_path.size == 0
+    uri_path.unshift("") if uri_path.size == 1
+    file_dir = File.join("#{uri.scheme}","#{uri.host}","#{uri.port}",uri_path[0..-2])
+    file = uri_path[-1]
+    return File.join(file_dir,file)
   end
   
   describe 'empty otml' do
@@ -62,8 +81,8 @@ describe 'DIY Local Cacher' do
     it 'should cache 2 referenced files' do
       expected_files = []
       expected_files << 'hash.otml' # standard_uri.otml
-      expected_files << ::Digest::SHA1.hexdigest('http://portal.concord.org/images/icons/delete.png')
-      expected_files << ::Digest::SHA1.hexdigest('https://mail.google.com/mail/images/2/5/mountains/base/gmail_solid_white.png')
+      expected_files << filename_for('http://portal.concord.org/images/icons/delete.png')
+      expected_files << filename_for('https://mail.google.com/mail/images/2/5/mountains/base/gmail_solid_white.png')
 
       cache('standard_uri.otml', :activity => mockup('standard_uri.otml'))
       
@@ -81,8 +100,8 @@ describe 'DIY Local Cacher' do
       file_content = File.read(File.join(@cache,'hash.otml'))
       
       file_content.should_not match(/http:/)
-      file_content.should match(::Digest::SHA1.hexdigest('http://portal.concord.org/images/icons/delete.png'))
-      file_content.should match(::Digest::SHA1.hexdigest('https://mail.google.com/mail/images/2/5/mountains/base/gmail_solid_white.png'))
+      file_content.should match(filename_for('http://portal.concord.org/images/icons/delete.png'))
+      file_content.should match(filename_for('https://mail.google.com/mail/images/2/5/mountains/base/gmail_solid_white.png'))
     end
   end
   
@@ -90,12 +109,12 @@ describe 'DIY Local Cacher' do
     it 'should cache 6 referenced files' do
       expected_files = []
       expected_files << 'hash.otml' # element_reference.otml
-      expected_files << ::Digest::SHA1.hexdigest('http://loops.diy.concord.org/')
-      expected_files << ::Digest::SHA1.hexdigest('http://portal.concord.org/images/icons/chart_bar.png')
-      expected_files << ::Digest::SHA1.hexdigest('http://portal.concord.org/images/icons/chart_pie.png')
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','text.txt'))
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','delete.png'))
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','chart_line.png'))
+      expected_files << filename_for('http://loops.diy.concord.org/')
+      expected_files << filename_for('http://portal.concord.org/images/icons/chart_bar.png')
+      expected_files << filename_for('http://portal.concord.org/images/icons/chart_pie.png')
+      expected_files << filename_for('resources/text.txt', File.join(SPEC_ROOT,'data','element_reference.otml'))
+      expected_files << filename_for('resources/delete.png', File.join(SPEC_ROOT,'data','element_reference.otml'))
+      expected_files << filename_for('resources/chart_line.png', File.join(SPEC_ROOT,'data','element_reference.otml'))
       
       cache('element_reference.otml', :activity => mockup('element_reference.otml'))
       
@@ -117,9 +136,9 @@ describe 'DIY Local Cacher' do
       
       unexpected_urls.each do |url|
         if url =~ /^http/
-          expected_urls << ::Digest::SHA1.hexdigest(url)
+          expected_urls << filename_for(url)
         else
-          expected_urls << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data',url))
+          expected_urls << filename_for(url, File.join(SPEC_ROOT,'data','element_reference.otml'))
         end
       end
       
@@ -128,7 +147,7 @@ describe 'DIY Local Cacher' do
       file_content = File.read(File.join(@cache,'hash.otml'))
       
       unexpected_urls.each do |url|
-        file_content.should_not match(Regexp.new(url))
+        file_content.should_not match(Regexp.new('"'+url))
       end
       
       expected_urls.each do |url|
@@ -141,10 +160,10 @@ describe 'DIY Local Cacher' do
     it 'should cache 4 referenced files in otml files' do
       expected_files = []
       expected_files << 'hash.otml' # recursion.otml
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','recurse1.otml'))
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','delete.png'))
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','recurse2.otml'))
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','chart_line.png'))
+      expected_files << filename_for('resources/recurse1.otml', File.join(SPEC_ROOT,'data','recursion.otml'))
+      expected_files << filename_for('resources/delete.png', File.join(SPEC_ROOT,'data','recursion.otml'))
+      expected_files << filename_for('resources/recurse2.otml', File.join(SPEC_ROOT,'data','recursion.otml'))
+      expected_files << filename_for('resources/chart_line.png', File.join(SPEC_ROOT,'data','recursion.otml'))
       
       cache('recursion.otml', :activity => mockup('recursion.otml'))
       
@@ -155,7 +174,7 @@ describe 'DIY Local Cacher' do
     end
     
     it 'should rewrite urls in first level recursion otml' do
-      recurse_otml = ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','recurse1.otml'))
+      recurse_otml = filename_for('resources/recurse1.otml', File.join(SPEC_ROOT,'data','recursion.otml'))
       
       expected_urls = []
       unexpected_urls = []
@@ -164,7 +183,7 @@ describe 'DIY Local Cacher' do
       unexpected_urls << File.join('resources','delete.png')
       
       unexpected_urls.each do |url|
-        expected_urls << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data',url))
+        expected_urls << filename_for(url, File.join(SPEC_ROOT,'data','recursion.otml'))
       end
       
       cache('recursion.otml', :activity => mockup('recursion.otml'))
@@ -172,7 +191,7 @@ describe 'DIY Local Cacher' do
       file_content = File.read(File.join(@cache,recurse_otml))
       
       unexpected_urls.each do |url|
-        file_content.should_not match(Regexp.new(url))
+        file_content.should_not match(Regexp.new('"'+url))
       end
       
       expected_urls.each do |url|
@@ -181,7 +200,7 @@ describe 'DIY Local Cacher' do
     end
     
     it 'should rewrite urls in second level recursion otml' do
-      recurse_otml = ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','recurse2.otml'))
+      recurse_otml = recurse_otml = filename_for('resources/recurse2.otml', File.join(SPEC_ROOT,'data','recursion.otml'))
       
       expected_urls = []
       unexpected_urls = []
@@ -189,7 +208,7 @@ describe 'DIY Local Cacher' do
       unexpected_urls << File.join('resources','chart_line.png')
       
       unexpected_urls.each do |url|
-        expected_urls << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data',url))
+        expected_urls << filename_for(url, File.join(SPEC_ROOT,'data','recursion.otml'))
       end
       
       cache('recursion.otml', :activity => mockup('recursion.otml'))
@@ -197,7 +216,7 @@ describe 'DIY Local Cacher' do
       file_content = File.read(File.join(@cache,recurse_otml))
       
       unexpected_urls.each do |url|
-        file_content.should_not match(Regexp.new(url))
+        file_content.should_not match(Regexp.new('"'+url))
       end
       
       expected_urls.each do |url|
@@ -208,10 +227,10 @@ describe 'DIY Local Cacher' do
     it 'should not get stuck when handling circular loops' do
       expected_files = []
       expected_files << 'hash.otml' # recursion.otml
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','loop1.otml'))
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','delete.png'))
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','loop2.otml'))
-      expected_files << ::Digest::SHA1.hexdigest(File.join(SPEC_ROOT,'data','resources','chart_line.png'))
+      expected_files << filename_for('resources/loop1.otml', File.join(SPEC_ROOT,'data','recursive_loop.otml'))
+      expected_files << filename_for('resources/delete.png', File.join(SPEC_ROOT,'data','recursive_loop.otml'))
+      expected_files << filename_for('resources/loop2.otml', File.join(SPEC_ROOT,'data','recursive_loop.otml'))
+      expected_files << filename_for('resources/chart_line.png', File.join(SPEC_ROOT,'data','recursive_loop.otml'))
       
       lambda {
         cache('recursive_loop.otml', :activity => mockup('recursive_loop.otml'))

data/spec/helpers/cache_helper.rb

@@ -8,6 +8,7 @@ module CacheHelper
   def exists?(file)
     f = File.join(@cache,file)
     File.should be_exists(f)
+    File.should be_file(f)
   end
   
   def does_not_exist?(file)
@@ -16,6 +17,6 @@ module CacheHelper
   end
 
   def cache_size
-    Dir.glob(@cache + "/*").size
+    Dir.glob(@cache + "/**/*").select{|f| File.file?(f) }.size
   end
 end

data/spec/java_proxy_cacher_spec.rb

@@ -38,6 +38,7 @@ describe 'Java Proxy Cacher' do
   describe 'empty otml' do
     it 'should create a url map xml file' do
       cache('empty.otml')
+      cache_size.should == 3
       exists?('url_map.xml')
     end
   
@@ -45,6 +46,7 @@ describe 'Java Proxy Cacher' do
       url = File.join(SPEC_ROOT,'data','empty.otml')
       expected_filename = ::Digest::SHA1.hexdigest(File.read(url))
       cache('empty.otml')
+      cache_size.should == 3
       exists?(expected_filename)
     end
   
@@ -52,10 +54,48 @@ describe 'Java Proxy Cacher' do
       url = File.join(SPEC_ROOT,'data','empty.otml')
       expected_filename = ::Digest::SHA1.hexdigest(File.read(url))
       cache('empty.otml')
+      cache_size.should == 3
       exists?("#{expected_filename}.hdrs")
     end
   end
   
+  describe 'error handling' do
+    it 'should handle a bad url gracefully' do
+      url = File.join(SPEC_ROOT,'data','bad_url.otml')
+      expected_filename = ::Digest::SHA1.hexdigest(File.read(url))
+      
+      lambda {
+        cache('bad_url.otml')
+      }.should_not raise_error
+      
+      cache_size.should == 3
+      
+      exists?(expected_filename)
+      does_not_exist?('8f0ebcb45d7ba71a541d4781329f4a6900c7ee65') # http://portal.concord.org/images/icons/delete.png
+    end
+    
+    it 'should handle an empty url gracefully' do
+      url = File.join(SPEC_ROOT,'data','empty_url.otml')
+      expected_filename = ::Digest::SHA1.hexdigest(File.read(url))
+      
+      lambda {
+        cache('empty_url.otml')
+      }.should_not raise_error
+      
+      cache_size.should == 3
+      
+      exists?(expected_filename)
+    end
+    
+    it 'should handle an empty root url gracefully' do
+      lambda {
+        cache('')
+      }.should_not raise_error
+      
+      cache_size.should == 1
+    end
+  end
+  
   describe 'standard uri syntax' do
     it 'should cache 2 referenced files' do
       expected_files = []

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Aaron Unger
@@ -35,7 +35,7 @@ cert_chain:
   8kT2T2VF
   -----END CERTIFICATE-----
 
-date: 2010-03-25 00:00:00 -04:00
+date: 2010-03-26 00:00:00 -04:00
 default_executable: 
 dependencies: []