concord_cacher 0.1.0 → 0.1.1

data/Rakefile

@@ -6,7 +6,7 @@ require 'spec/rake/spectask'
 require './lib/concord_cacher.rb'
 
 require 'echoe'
-Echoe.new('concord_cacher', '0.1.0') do |p|
+Echoe.new('concord_cacher', '0.1.1') 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,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{concord_cacher}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Unger"]

data/lib/concord/cacher.rb

@@ -20,28 +20,25 @@ class ::Concord::Cacher
 	end
 	
 	def calculate_main_file_absolute_url
-	  orig_uri = @main_resource.uri
+	  new_uri = @main_resource.uri
 	  codebase = ''
-	  if ((orig_uri.kind_of?(URI::HTTP) || orig_uri.kind_of?(URI::HTTPS)) && orig_uri.absolute?)
-      @main_resource.uri = orig_uri
-    else
-      # this probably references something on the local fs. we need to extract the document's codebase, if there is ony
-      if @main_resource.content =~ /<otrunk[^>]+codebase[ ]?=[ ]?['"]([^'"]+)/
-        codebase = "#{$1}"
-        @main_resource.content.sub!(/codebase[ ]?=[ ]?['"][^'"]+['"]/,"")
-        codebase.sub!(/\/$/,'')
-        codebase = "#{codebase}/#{@main_resource.remote_filename}" unless codebase =~ /otml$/
-        @main_resource.uri = URI.parse(codebase)
-      else
-        @main_resource.uri = orig_uri
-      end
+
+	  if _needs_codebase?(new_uri) && @main_resource.has_codebase?
+	    # this probably references something on the local fs. we need to extract the document's codebase, if there is ony
+      codebase = "#{$1}"
+      @main_resource.remove_codebase
+      codebase.sub!(/\/$/,'')
+      codebase = "#{codebase}/#{@main_resource.remote_filename}" unless codebase =~ /otml$/
+      new_uri = URI.parse(codebase)
     end
     
-    if @main_resource.uri.relative?
+    if new_uri.relative?
       # we need the main URI to be absolute so that we can use it to resolve references
       file_root = URI.parse("file:///")
-      @main_resource.uri = file_root.merge(@main_resource.uri)
+      new_uri = file_root.merge(new_uri)
     end
+    
+    @main_resource.uri = new_uri
   end
 	
 	def cache
@@ -57,12 +54,19 @@ class ::Concord::Cacher
   end
   
   def print_errors
-    puts "\nThere were #{@errors.length} artifacts with errors.\n"
-    ::Concord::Resource.errors.each do |k,v|
-    	puts "In #{k}:"
-    	v.uniq.each do |e|
-        puts "    #{e}"
+    all_errors = ::Concord::Resource.errors
+    puts "\nThere were #{all_errors.length} artifacts with errors.\n"
+    all_errors.each do |url,errors|
+    	puts "In #{url}:"
+    	errors.uniq.each do |error|
+        puts "    #{error}"
       end
     end
   end
+  
+  private
+  
+  def _needs_codebase?(uri)
+    return ! ((uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)) && uri.absolute?)
+  end
 end

data/spec/diy_local_cacher_spec.rb

@@ -10,14 +10,13 @@ require 'fileutils'
 
 include FileUtils
 
-SPEC_ROOT = File.expand_path(File.dirname(__FILE__))
-
 describe 'DIY Local Cacher' do
   include CacheHelper
   
   before(:each) do
     @klass = Concord::DiyLocalCacher
-    @cache = File.join(SPEC_ROOT, '..', 'tmp','diy_local')
+    @spec_root = File.expand_path(File.dirname(__FILE__))
+    @cache = File.join(@spec_root, '..', 'tmp','diy_local')
     mkdir_p(@cache)
     @cache += '/'
   end
@@ -62,7 +61,7 @@ describe 'DIY Local Cacher' do
     end
   
     it 'should not create a cached header of the original url' do
-      url = File.join(SPEC_ROOT,'data','empty.otml')
+      url = File.join(@spec_root,'data','empty.otml')
       expected_filename = 'hash.otml'
       cache('empty.otml', :activity => mockup('empty.otml'))
       does_not_exist?("#{expected_filename}.hdrs")
@@ -111,9 +110,9 @@ describe 'DIY Local Cacher' do
       expected_files << filename_for('http://www.concord.org/~aunger/')
       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'))
+      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'))
       
@@ -137,7 +136,7 @@ describe 'DIY Local Cacher' do
         if url =~ /^http/
           expected_urls << filename_for(url)
         else
-          expected_urls << filename_for(url, File.join(SPEC_ROOT,'data','element_reference.otml'))
+          expected_urls << filename_for(url, File.join(@spec_root,'data','element_reference.otml'))
         end
       end
       
@@ -159,10 +158,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 << 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'))
+      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'))
       
@@ -173,7 +172,7 @@ describe 'DIY Local Cacher' do
     end
     
     it 'should rewrite urls in first level recursion otml' do
-      recurse_otml = filename_for('resources/recurse1.otml', File.join(SPEC_ROOT,'data','recursion.otml'))
+      recurse_otml = filename_for('resources/recurse1.otml', File.join(@spec_root,'data','recursion.otml'))
       
       expected_urls = []
       unexpected_urls = []
@@ -182,7 +181,7 @@ describe 'DIY Local Cacher' do
       unexpected_urls << File.join('resources','delete.png')
       
       unexpected_urls.each do |url|
-        expected_urls << filename_for(url, File.join(SPEC_ROOT,'data','recursion.otml'))
+        expected_urls << filename_for(url, File.join(@spec_root,'data','recursion.otml'))
       end
       
       cache('recursion.otml', :activity => mockup('recursion.otml'))
@@ -199,7 +198,7 @@ describe 'DIY Local Cacher' do
     end
     
     it 'should rewrite urls in second level recursion otml' do
-      recurse_otml = recurse_otml = filename_for('resources/recurse2.otml', File.join(SPEC_ROOT,'data','recursion.otml'))
+      recurse_otml = recurse_otml = filename_for('resources/recurse2.otml', File.join(@spec_root,'data','recursion.otml'))
       
       expected_urls = []
       unexpected_urls = []
@@ -207,7 +206,7 @@ describe 'DIY Local Cacher' do
       unexpected_urls << File.join('resources','chart_line.png')
       
       unexpected_urls.each do |url|
-        expected_urls << filename_for(url, File.join(SPEC_ROOT,'data','recursion.otml'))
+        expected_urls << filename_for(url, File.join(@spec_root,'data','recursion.otml'))
       end
       
       cache('recursion.otml', :activity => mockup('recursion.otml'))
@@ -226,10 +225,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 << 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'))
+      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'))
@@ -256,7 +255,7 @@ describe 'DIY Local Cacher' do
     
     it 'should download relative referenced nlogo files' do
       expected_files = []
-      expected_files << filename_for('resources/nlogo/SpaceRescue.Practice1.nlogo', File.join(SPEC_ROOT,'data','nlogo_relative.otml'))
+      expected_files << filename_for('resources/nlogo/SpaceRescue.Practice1.nlogo', File.join(@spec_root,'data','nlogo_relative.otml'))
       
       cache('nlogo_relative.otml', :activity => mockup('nlogo_relative.otml'))
       
@@ -282,7 +281,7 @@ describe 'DIY Local Cacher' do
     
     it 'should download relative referenced cml files' do
       expected_files = []
-      expected_files << filename_for('resources/statesofmatter/statesOfMatterPage1.cml', File.join(SPEC_ROOT,'data','mw_model_relative.otml'))
+      expected_files << filename_for('resources/statesofmatter/statesOfMatterPage1.cml', File.join(@spec_root,'data','mw_model_relative.otml'))
       
       cache('mw_model_relative.otml', :activity => mockup('mw_model_relative.otml'))
       
@@ -308,7 +307,7 @@ describe 'DIY Local Cacher' do
   
   describe 'never cache' do
     it 'should always skip some references' do
-      url = File.join(SPEC_ROOT,'data','always_skip.otml')
+      url = File.join(@spec_root,'data','always_skip.otml')
       expected_filename = 'hash.otml'
       cache('always_skip.otml', :activity => mockup('always_skip.otml'))
       cache_size.should == 1

data/spec/helpers/cache_helper.rb

@@ -1,6 +1,6 @@
 module CacheHelper
   def cache(file, opts = {})
-    options = {:url => File.join(SPEC_ROOT,'data',file), :cache_dir => @cache}.merge(opts)
+    options = {:url => File.join(@spec_root,'data',file), :cache_dir => @cache}.merge(opts)
     cacher = @klass.new(options)
     cacher.cache
   end

data/spec/java_proxy_cacher_spec.rb

@@ -10,15 +10,13 @@ require 'fileutils'
 
 include FileUtils
 
-SPEC_ROOT = File.expand_path(File.dirname(__FILE__))
-
-
 describe 'Java Proxy Cacher' do
   include CacheHelper
   
   before(:each) do
     @klass = Concord::JavaProxyCacher
-    @cache = File.join(SPEC_ROOT, "..", 'tmp','java_proxy')
+    @spec_root = File.expand_path(File.dirname(__FILE__))
+    @cache = File.join(@spec_root, "..", 'tmp','java_proxy')
     mkdir_p(@cache)
     @cache += '/'
   end
@@ -35,7 +33,7 @@ describe 'Java Proxy Cacher' do
     end
   
     it 'should create a cached file of the original url' do
-      url = File.join(SPEC_ROOT,'data','empty.otml')
+      url = File.join(@spec_root,'data','empty.otml')
       expected_filename = ::Digest::SHA1.hexdigest(File.read(url))
       cache('empty.otml')
       cache_size.should == 3
@@ -43,7 +41,7 @@ describe 'Java Proxy Cacher' do
     end
   
     it 'should create a cached header of the original url' do
-      url = File.join(SPEC_ROOT,'data','empty.otml')
+      url = File.join(@spec_root,'data','empty.otml')
       expected_filename = ::Digest::SHA1.hexdigest(File.read(url))
       cache('empty.otml')
       cache_size.should == 3
@@ -53,7 +51,7 @@ describe 'Java Proxy Cacher' do
   
   describe 'error handling' do
     it 'should handle a bad url gracefully' do
-      url = File.join(SPEC_ROOT,'data','bad_url.otml')
+      url = File.join(@spec_root,'data','bad_url.otml')
       expected_filename = ::Digest::SHA1.hexdigest(File.read(url))
       
       lambda {
@@ -67,7 +65,7 @@ describe 'Java Proxy Cacher' do
     end
     
     it 'should handle a url with trailing spaces gracefully' do
-      url = File.join(SPEC_ROOT,'data','url_with_space.otml')
+      url = File.join(@spec_root,'data','url_with_space.otml')
       expected_filename = ::Digest::SHA1.hexdigest(File.read(url))
       
       lambda {
@@ -81,7 +79,7 @@ describe 'Java Proxy Cacher' do
     end
     
     it 'should handle an empty url gracefully' do
-      url = File.join(SPEC_ROOT,'data','empty_url.otml')
+      url = File.join(@spec_root,'data','empty_url.otml')
       expected_filename = ::Digest::SHA1.hexdigest(File.read(url))
       
       lambda {
@@ -198,7 +196,7 @@ describe 'Java Proxy Cacher' do
   
   describe 'never cache' do
     it 'should always skip some references' do
-      url = File.join(SPEC_ROOT,'data','always_skip.otml')
+      url = File.join(@spec_root,'data','always_skip.otml')
       expected_filename = ::Digest::SHA1.hexdigest(File.read(url))
       cache('always_skip.otml')
       cache_size.should == 3

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Aaron Unger