dokkit 0.2.0 → 0.3.0

data/spec/fileselection_spec.rb

@@ -0,0 +1,101 @@
+#                                                                          
+# File 'fileselect_spec.rb' created on 07 feb 2008 at 15:46:04.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/fileselect_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/fileselection'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::FileSelection, ' when initialized' do
+  include SpecPathHelper
+  before(:all) do
+    @initial_dir = Dir.pwd
+    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))        
+  end  
+  it 'should set the current dir as default base path' do
+    fs = Dokkit::FileSelection.new
+    fs.base_dir.should == '.'
+  end
+  it 'should set the given directory as the base path for all operations' do
+    fs = Dokkit::FileSelection.new(document_path)
+    fs.base_dir.should == document_path
+  end
+  
+  after(:all) do
+    Dir.chdir(@initial_dir)
+  end  
+end
+
+describe Dokkit::FileSelection, ' when extended with ExtMapping' do
+  include SpecPathHelper
+  before(:all) do
+    @initial_dir = Dir.pwd
+    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))
+    @fs = Dokkit::FileSelection.new(document_path) do |fs|
+      fs.include('*')
+    end
+    @fs.extend Dokkit::ExtMapping
+  end  
+  it 'should map an extension for document_1' do
+    @fs.extend(/document_1$/) { "extended" }    
+    @fs.extmapping.should have(1).items
+    @fs.extmapping[document_path('document_1')].call.should == "extended"
+  end
+  it 'should map an extension for all documents' do
+    @fs.extend { "extended" }
+    @fs.extmapping.should have(18).items    
+  end
+  after(:all) do
+    Dir.chdir(@initial_dir)
+  end  
+end
+
+describe Dokkit::FileSelection, '#files' do
+  include SpecPathHelper
+  before(:all) do
+    @initial_dir = Dir.pwd
+    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))            
+  end  
+  it 'should return an array with the list of the included files in the given directory' do
+    Dokkit::FileSelection.new(document_path) do |fs|
+      fs.include('*')
+    end.files.should have(18).items
+  end
+  it 'should not include files that was explicity excluded' do
+    Dokkit::FileSelection.new(document_path) do |fs| 
+      fs.exclude('*.exclude') 
+    end.files.should_not include(document_path('document_5.exclude'))
+  end
+  it 'should include only the files that was explicity included' do
+    Dokkit::FileSelection.new(document_path) do |fs|
+      fs.include('*.yaml')
+    end.files.should include(document_path('COMMON.yaml'))
+  end
+  it 'should not include the same files' do
+    Dokkit::FileSelection.new(document_path) do |fs|
+      fs.include('*')
+      fs.include('*')
+    end.files.should have(18).items
+  end
+  it 'should not include directory' do
+    Dokkit::FileSelection.new(document_path) do |fs|
+      fs.include('**/*')
+    end.files.should_not include(document_path('subdir'))
+  end
+  after(:all) do
+    Dir.chdir(@initial_dir)
+  end    
+end
+

data/spec/filter_base_spec.rb

@@ -0,0 +1,29 @@
+#                                                                          
+# File 'filter_base_spec.rb' created on 18 feb 2008 at 14:48:04.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/filter_base_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/filters/base'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::Filters::Base do
+  before do
+    @filter = Dokkit::Filters::Base.new
+  end
+  it 'should define an instance method to transform the given text' do
+    @result = @filter.filter('text to transform').should be_nil
+  end
+end
+

data/spec/filter_deplate_spec.rb

@@ -0,0 +1,48 @@
+#                                                                          
+# File 'filter_deplate_spec.rb' created on 18 feb 2008 at 15:22:35.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/filter_deplate_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/filters/deplate'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::Filters::DeplateHTML do
+  before do
+    @deplate = Dokkit::Filters::DeplateHTML.new
+  end
+  it 'should transform deplate wiki text in html' do
+    @deplate.filter('* Header').should =~ /\<h1.*\>1&nbsp;Header\<\/h1\>/
+  end
+end
+
+describe Dokkit::Filters::DeplateLatex do
+  before do
+    @deplate = Dokkit::Filters::DeplateLatex.new
+  end
+  it 'should transform deplate wiki text in tex' do
+    @deplate.filter('* Header').should =~ /\\section\{Header\}/
+  end
+end
+
+describe Dokkit::Filters::DeplateText do
+  before do
+    @deplate = Dokkit::Filters::DeplateText.new
+  end
+  it 'should transform deplate wiki text in plain text' do
+    @deplate.filter('* Header').should =~ /\n1 Header\n=+$/
+  end
+end
+
+

data/spec/filter_maruku_spec.rb

@@ -0,0 +1,29 @@
+#                                                                          
+# File 'filter_maruku_spec.rb' created on 15 feb 2008 at 22:52:14.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/filter_maruku_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/filters/maruku'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::Filters::MarukuHTML do
+  before do
+    @maruku = Dokkit::Filters::MarukuHTML.new
+  end
+  it 'should transform markdown text in html' do
+    @result = @maruku.filter('# Header').should =~ /\<h1.*\>Header\<\/h1\>/
+  end
+end
+

data/spec/filter_nil_spec.rb

@@ -0,0 +1,30 @@
+#                                                                          
+# File 'filter_nil_spec.rb' created on 18 mar 2008 at 12:39:00.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/filter_nil_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/filters/nil'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::Filters::Nil do
+  before do
+    @nil = Dokkit::Filters::Nil.new
+  end
+  it 'should not transform source file' do
+    @result = @nil.filter('Do *not* transform this text.').should == 'Do *not* transform this text.'
+  end
+end
+
+

data/spec/filters_spec.rb

@@ -0,0 +1,37 @@
+#                                                                          
+# File 'filter_spec.rb' created on 15 feb 2008 at 22:25:12.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/filter_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/filters'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::Filters do
+  it 'should register new filters' do
+    Filter = mock('Filter')
+    @filter = mock('filter')
+    Filter.should_receive(:new).and_return(@filter)    
+    @filter.should_receive(:class).and_return('Filter')    
+    Dokkit::Filters.register('filter') do
+      Filter.new
+    end
+    Dokkit::Filters['filter'].class.should == 'Filter'
+  end
+  it 'should raise an error if a non existent filter is called' do
+    lambda { 
+      Dokkit::Filters['notexists']
+    }.should raise_error(RuntimeError, /Filter '.*' is not defined!/)
+  end
+end

data/spec/logger_spec.rb

@@ -0,0 +1,150 @@
+#                                                                          
+# File 'logger_spec.rb' created on 23 feb 2008 at 15:47:50.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/logger_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/logger'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::Log::Logger do
+  before do
+    @logger = Dokkit::Log::Logger.logger
+    @observer = mock('observer')
+  end
+  after do
+    Dokkit::Log::Logger.clear
+  end
+  it 'should be singleton' do
+    @logger.object_id.should == Dokkit::Log::Logger.logger.object_id
+  end
+  it 'should be set with INFO log level by default' do
+    @logger.level.should == Dokkit::Log::INFO
+  end
+  it 'should correct log level out of range' do
+    @logger.level = 5
+    @logger.level.should == Dokkit::Log::DEBUG
+    @logger.level = -1
+    @logger.level.should == Dokkit::Log::ERROR  
+  end
+  it 'should add observer to the observers list' do
+    @logger.attach(@observer).should == @observer
+    @logger.observers.should == [@observer]
+  end
+  it 'should remove the given observer from observers list' do
+    @logger.attach(@observer)
+    @logger.detach(@observer).should == @observer
+    @logger.observers.should be_empty
+  end
+  it 'should send updated messages to the observers' do
+    @observer.should_receive(:update)
+    @logger.attach(@observer)
+    @logger.notify
+  end
+end
+
+describe Dokkit::Log::Logger, ' when log level changes' do
+  before do
+    @logger = Dokkit::Log::Logger.logger
+  end
+  after do
+    Dokkit::Log::Logger.clear
+  end
+  describe ' to ERROR' do
+    before do
+      @logger.level = Dokkit::Log::ERROR
+    end
+    it 'should send error messages only' do
+      @logger.error('This is an error message.').should == { 
+        :text => 'This is an error message.', 
+        :level => Dokkit::Log::ERROR 
+      }
+      @logger.warn('This is a warning message').should be_nil
+      @logger.info('This is an info message').should be_nil
+      @logger.debug('This is a debug message').should be_nil
+    end
+  end
+  describe ' to WARNING' do
+    before do
+      @logger.level = Dokkit::Log::WARNING
+    end
+    it 'should send error and warning messages only' do
+      @logger.error('This is an error message.').should == { 
+        :text => 'This is an error message.', 
+        :level => Dokkit::Log::ERROR 
+      }
+      @logger.warn('This is a warning message.').should == { 
+        :text => 'This is a warning message.', 
+        :level => Dokkit::Log::WARNING 
+      }
+      @logger.info('This is an info message').should be_nil
+      @logger.debug('This is a debug message').should be_nil        
+    end  
+  end
+  describe ' to INFO' do
+    before do
+      @logger.level = Dokkit::Log::INFO
+    end
+    it 'should send error, warning and info messages only' do
+      @logger.error('This is an error message.').should == { 
+        :text => 'This is an error message.', 
+        :level => Dokkit::Log::ERROR 
+      }
+      @logger.warn('This is a warning message.').should == { 
+        :text => 'This is a warning message.', 
+        :level => Dokkit::Log::WARNING 
+      }
+      @logger.info('This is an info message.').should == { 
+        :text => 'This is an info message.', 
+        :level => Dokkit::Log::INFO 
+      }      
+      @logger.debug('This is a debug message').should be_nil        
+    end  
+  end    
+  describe ' to DEBUG' do
+    before do
+      @logger.level = Dokkit::Log::DEBUG
+    end
+    it 'should send all messages' do
+      @logger.error('This is an error message.').should == { 
+        :text => 'This is an error message.', 
+        :level => Dokkit::Log::ERROR 
+      }
+      @logger.warn('This is a warning message.').should == { 
+        :text => 'This is a warning message.', 
+        :level => Dokkit::Log::WARNING 
+      }
+      @logger.info('This is an info message.').should == { 
+        :text => 'This is an info message.', 
+        :level => Dokkit::Log::INFO 
+      }      
+      @logger.debug('This is a debug message.').should == { 
+        :text => 'This is a debug message.', 
+        :level => Dokkit::Log::DEBUG 
+      }      
+    end  
+  end      
+end
+
+describe Dokkit::Log::LogMessage do
+  before do
+    @message = Dokkit::Log::LogMessage.new('This is a message', Dokkit::Log::INFO)
+  end
+  it 'should be initialized with a message string' do
+    @message.text.should == 'This is a message'
+  end
+  it 'should be initialized with a log level' do
+    @message.level.should == Dokkit::Log::INFO
+  end
+end

data/spec/model_spec.rb

@@ -0,0 +1,45 @@
+#                                                                          
+# File 'model_spec.rb' created on 10 mar 2008 at 13:36:29.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/model_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit' 
+require 'dokkit/model'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::Model, ' when initialized' do
+  include SpecPathHelper
+  before(:all) do
+    @initial_dir = Dir.pwd
+    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))    
+  end  
+  before do
+    @model = Dokkit::Model.init do |model|
+      model.config.cache_dir = cache_path
+    end
+  end
+  after(:all) do
+    Dir.chdir(@initial_dir)
+  end  
+  it 'should be instantiated only once' do
+    Dokkit::Model.init.object_id.should == @model.object_id
+  end
+  it 'should be initialized with a name' do
+    Dokkit::Model.init('simpledocument').name == 'simpledocument'
+  end
+  it 'should instantiate a TaskConfig object' do
+    @model.config.class.should == Dokkit::TaskConfig
+  end
+end
+

data/spec/pathhelper_spec.rb

@@ -0,0 +1,62 @@
+#                                                                          
+# File 'pathhelper_spec.rb' created on 15 feb 2008 at 16:36:50.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/pathhelper_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/pathhelper'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::PathHelper do
+  include SpecPathHelper
+  before do
+    @config = mock('config')
+  end
+  it 'should define a method to transform source file path and extension' do
+    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'document')
+    filename_helper(source_fn, SpecPathHelper::DOCUMENT_PATH, 'newdir', '.newext').should == 'newdir/document.newext'
+    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'subdir/document')
+    filename_helper(source_fn, SpecPathHelper::DOCUMENT_PATH, 'newdir', '.newext').should == 'newdir/subdir/document.newext'
+  end
+  it 'should return a configuration filename given a source filename' do
+    @config.should_receive(:document_dir).and_return(SpecPathHelper::DOCUMENT_PATH)
+    @config.should_receive(:config_dir).and_return(SpecPathHelper::CONFIG_PATH)
+    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'document')
+    config_fn_helper(source_fn, @config).should == 'doc/configs/document.yaml'
+  end
+  it 'should return a layout filename given a source filename' do
+    @config.should_receive(:document_dir).twice.and_return(SpecPathHelper::DOCUMENT_PATH)
+    @config.should_receive(:layout_dir).twice.and_return(SpecPathHelper::LAYOUT_PATH)
+    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'document')
+    layout_fn_helper(source_fn, '.html', @config).should == 'doc/layouts/document.html'
+    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'subdir/document')
+    layout_fn_helper(source_fn, '.html', @config).should == 'doc/layouts/subdir/document.html'    
+  end
+  it 'should return a target filename given a source filename' do
+    @config.should_receive(:document_dir).and_return(SpecPathHelper::DOCUMENT_PATH)
+    @config.should_receive(:output_dir).and_return(SpecPathHelper::OUTPUT_PATH)
+    source_fn = File.join(SpecPathHelper::DOCUMENT_PATH, 'document')
+    output_fn_helper(source_fn, '.html', @config).should == 'output/document.html'
+  end  
+  it 'should return a target data filename given a source data filename' do
+    @config.should_receive(:data_dir).and_return(SpecPathHelper::DATA_PATH)
+    @config.should_receive(:output_dir).and_return(SpecPathHelper::OUTPUT_PATH)
+    source_fn = File.join(SpecPathHelper::DATA_PATH, 'resource')
+    data_fn_helper(source_fn, @config).should == 'output/resource'
+  end
+  it 'should define a method to strip extension from file' do
+    strip_ext('test.ext').should == 'test'
+    strip_ext('.test.ext.ext').should == '.test.ext'
+  end
+end

data/spec/recursivemerge_spec.rb

@@ -0,0 +1,91 @@
+#                                                                          
+# File 'recursivemerge_spec.rb' created on 09 feb 2008 at 19:08:20.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/recursivemerge_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/recursivemerge'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Hash do
+  describe 'when two hash with depth 0 are merged' do
+    before do
+      @h1 = { :a => "a", :b => "b" }
+      @h2 = { :c => "c" }
+    end
+    it 'should return a new hash with :a, :b, :c keys' do
+      @h1.recursive_merge(@h2).should == { :a => "a", :b => "b", :c => "c"}
+    end
+  end
+  describe 'when two hash with depth 1 are merged' do
+    before do
+      @h1 = { :depth1 => { :a => "a", :b => "b" }, :b => "b" }
+      @h2 = { :depth1 => { :a => "a'", :c => "c" }, :b => "b'" }
+    end
+    it 'should return a new hash merging depth 1 values,' do
+      @h1.recursive_merge(@h2).should == { :depth1 => { :a => "a'", :b => "b", :c => "c"}, :b => "b'" }
+    end
+  end
+  describe Hash, 'when two hash with depth 2 and depth 1 are merged' do
+    before do
+      @h1 = { :depth1 => { :depth2 => { :a => "a", :b => "b" } }, :b => "b" }
+      @h2 = { :depth1 => { :a => "a'", :b => "b'", :c => "c"}, :b => "b" }
+    end
+    it 'should return a new hash merging the depth 1 values adding the depth 2 key' do
+      @h1.recursive_merge(@h2).should == { :depth1 => {:depth2 => { :a => "a", :b => "b" }, :a => "a'", :b => "b'", :c => "c"}, :b => "b" }
+    end
+  end
+  describe Hash, ' when a block is passed to recursive_merge' do
+    it 'should use the block to store values' do
+      { :a => 'a' }.recursive_merge({ :a => ['b', 'c'] }) do |key, value, other_value|
+        if(value.class == String && other_value.class == Array)
+          value.to_a.concat(other_value)
+        else
+         store(key, other_value)
+        end
+      end.should == { :a => ['a', 'b', 'c'] }
+    end
+  end
+end
+
+describe ConfigHash do
+  describe 'when a string and an array are merged' do
+    before do
+      @h1 = { :a => 'a' }.extend ConfigHash
+      @h2 = { :a => ['b', 'c'] }.extend ConfigHash
+    end
+    it 'should concatenate the string and the array' do
+      @h1.recursive_merge(@h2).should == { :a => ['a', 'b', 'c'] }
+      @h2.recursive_merge(@h1).should == { :a => ['b', 'c', 'a'] }      
+    end
+  end
+  describe 'when two array are merged' do
+    before do
+      @h1 = { :a => { :b => ['a', 'b'] } }.extend ConfigHash
+      @h2 = { :a => { :b => ['c', 'd'] } }.extend ConfigHash
+    end
+    it 'should concatenate the arrays' do
+      @h1.recursive_merge(@h2).should == { :a => { :b => ['a', 'b', 'c', 'd'] } }
+    end
+  end  
+  describe 'when layout and config keys are merged' do
+    before do
+      @h1 = { :layout => ['layout_1', 'layout_2'], :config => 'config' }.extend ConfigHash
+      @h2 = { :layout => ['layout_3', 'layout_4'], :config => ['config_1', 'config_2'] }.extend ConfigHash
+    end
+    it 'should store the rvalue' do
+      @h1.recursive_merge(@h2).should == { :layout => ['layout_3', 'layout_4'], :config => ['config_1', 'config_2'] }
+    end
+  end    
+end