dokkit 0.3.0 → 0.4.0

data/spec/dokkit/dokkit_spec.rb

@@ -0,0 +1,20 @@
+#                                                                          
+# File 'dokkit_spec.rb' created on 08 mag 2008 at 17:03:32.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2006-2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+
+describe Dokkit do
+  it 'should set version number' do
+    VERSION.should match(/\d.\d.\d/)
+  end
+end
+
+

data/spec/dokkit/environment/basic_spec.rb

@@ -0,0 +1,135 @@
+#                                                                          
+# File 'environment_spec.rb' created on 01 mag 2008 at 15:34:55.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c) 2006, 2007, 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/environment_spec.rb                                                  
+#                                                                          
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../../../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit/environment/basic'
+require 'spec/spec_helper.rb'
+
+include Dokkit::Environment::Basic
+
+module Dokkit
+  describe 'A container that includes basic documentation environment' do
+    include SpecHelper::Path
+    before(:all) do
+      @initial_dir = Dir.pwd
+      Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
+    end
+    after(:all) do
+      Dir.chdir(@initial_dir)
+    end
+    before do
+      @rake = Rake.application
+    end
+    before do
+      @container = Container.new  { |c| c.logger.level = Logging::OFF }
+    end
+    after do
+      Rake.application.clear
+    end
+    it 'should add lib folder to $:' do
+      $:.should include('lib')
+    end
+    it 'should initialize a console logger' do
+      @container.logger.is_a?(Logging::Logger).should be_true
+    end
+    it 'should initialize only one instance of Logger' do
+      @container.logger.object_id.should == @container.logger.object_id
+    end
+    it 'should set default directories in configuration struct' do
+      @container.configuration.marshal_dump.should == {
+        :document_dir => 'doc/pages',
+        :config_dir => 'doc/configs',
+        :layout_dir => 'doc/layouts',
+        :data_dir => 'doc/data',
+        :output_dir => 'output',
+        :cache_dir => '.cache'
+      }
+    end
+    it 'should initialize configuration struct only once' do
+      @container.configuration.object_id.should == @container.configuration.object_id
+    end
+    it 'should allow client to change configuration struct' do
+      @container.configuration.document_dir = 'doc/documents'
+      @container.configuration.document_dir.should == 'doc/documents'
+    end
+    it 'should set default document filelist' do
+      @container.documents.files.sort.should == ['doc/pages/document_1', 'doc/pages/document_2', 'doc/pages/subdir/document_1']
+    end
+    it 'should set default data filelist' do
+      @container.data.files.sort.should == ['doc/data/data']
+    end
+    it 'should allow client to change document filelist' do
+      @container.documents.exclude('*')
+      @container.documents.files.should be_empty
+    end
+    it 'should allow client to change data filelist' do
+      @container.data.exclude('*')
+      @container.data.files.should be_empty
+    end
+    it 'should set a block that construct a document instance' do
+      @container.document_factory_block.call(document_path('document_1')).is_a?(Resource::Document).should be_true
+    end
+    it 'should set a block that construct a data instance' do
+      @container.data_factory_block.call(data_path('data')).is_a?(Resource::Data).should be_true
+    end
+    it 'should construct a filter factory' do
+      @container.filter_factory.is_a?(Factory).should be_true
+    end
+    it 'should initialize only one instance of filter factory' do
+      @container.filter_factory.object_id.should == @container.filter_factory.object_id
+    end
+    it 'should construct a resource factory' do
+      @container.resource_factory.is_a?(Factory).should be_true
+    end
+    it 'should initialize only one instance of resource factory' do
+      @container.resource_factory.object_id.should == @container.resource_factory.object_id
+    end
+    it 'should construct a DeplateHTML filter instance through filter factory' do
+      @container.filter_factory.get('deplate-html').is_a?(Filter::DeplateHTML).should be_true
+    end
+     it 'should construct a DeplateText filter instance through filter factory' do
+      @container.filter_factory.get('deplate-text').is_a?(Filter::DeplateText).should be_true
+    end
+     it 'should construct a DeplateLatex filter instance through filter factory' do
+      @container.filter_factory.get('deplate-latex').is_a?(Filter::DeplateLatex).should be_true
+    end
+     it 'should construct a MarukuHTML filter instance through filter factory' do
+      @container.filter_factory.get('maruku-html').is_a?(Filter::MarukuHTML).should be_true
+    end
+    it 'should define render tasklib' do
+      @rake.tasks.should include(task('render:all'))
+      @rake.tasks.should include(task('render:data'))
+    end
+    it 'should define clean tasklib' do
+      @rake.tasks.should include(task('clean:all'))
+      @rake.tasks.should include(task('clean:output'))
+      @rake.tasks.should include(task('clean:cache'))
+    end
+    describe ' when an extension block is provided' do
+      before do
+        module Extension; def foo; end; end
+      end
+      before do
+        @container = Container.new do |c|
+          c.logger.level = Logging::OFF
+          c.extmap.include('document_1*').map { |document| document.extend Extension }
+        end
+       end
+      it 'should map the extension to the corresponding document' do
+        @container.resource_factory.get(:document, 'doc/pages/document_1').respond_to?(:foo).should be_true 
+        @container.resource_factory.get(:document, 'doc/pages/document_2').respond_to?(:foo).should be_false 
+      end
+    end
+  end
+end

data/spec/dokkit/environment/helpers/extmap_spec.rb

@@ -0,0 +1,52 @@
+#                                                                          
+# File 'extmap_spec.rb' created on 14 mag 2008 at 10:51:19.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c)2006-2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../../../../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit/environment/helpers/extmap'
+require 'spec/spec_helper.rb'
+
+
+module Dokkit
+  module Resource
+    module Extension
+      
+    end
+  end
+  module Environment
+    module Helper
+      describe ExtMap do
+        include SpecHelper::Path
+        before(:all) do
+          @initial_dir = Dir.pwd
+          Dir.chdir(File.join(File.dirname(__FILE__), SpecHelper::Path::TEST_DATA))
+        end
+        after(:all) do
+          Dir.chdir(@initial_dir)
+        end
+        before do
+          @extension_block = lambda { |document| document.extend Extension }
+          @extmap = ExtMap.new('doc/pages').include('*.ext*').map(&@extension_block)
+        end
+        it 'should return the correct filelist array' do
+          @extmap.files.sort.should == [document_path('document_1.ext_1'), document_path('document_3.ext_3')]
+        end
+        it 'should map the extension block to document_1.ext_1' do
+          @extmap['doc/pages/document_1.ext_1'].should == @extension_block
+        end
+        it 'should map the extension block to document_1.ext_1' do
+          @extmap['doc/pages/document_3.ext_3'].should == @extension_block
+        end
+      end
+    end
+  end
+end
+
+
+

data/spec/dokkit/environment/helpers/fileselection_spec.rb

@@ -0,0 +1,80 @@
+#
+# File 'fileselect_spec.rb' created on 07 feb 2008 at 15:46:04.
+# See 'dokkit.rb' or +LICENSE+ for licence information.
+#
+# (c) 2006, 2007, 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/environment/helpers/fileselection'
+require 'spec/spec_helper.rb'
+
+module Dokkit
+  module Environment
+    module Helper
+      describe FileSelection, ' when initialized' do
+        include SpecHelper::Path
+        before(:all) do
+          @initial_dir = Dir.pwd
+          Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..', SpecHelper::Path::TEST_DATA)))
+        end
+        after(:all) do
+          Dir.chdir(@initial_dir)
+        end
+        it 'should set the current dir as default base path' do
+          fs = FileSelection.new
+          fs.base_dir.should == '.'
+        end
+        it 'should set the given directory as the base path for all operations' do
+          fs = FileSelection.new(document_path)
+          fs.base_dir.should == document_path
+        end
+      end
+      describe FileSelection, '#files' do
+        include SpecHelper::Path
+        before(:all) do
+          @initial_dir = Dir.pwd
+          Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..', SpecHelper::Path::TEST_DATA)))
+        end
+        after(:all) do
+          Dir.chdir(@initial_dir)
+        end
+        it 'should return an array with the list of the included files in the given directory' do
+          FileSelection.new(document_path) do |fs|
+            fs.include('*')
+          end.files.should have(3).items
+        end
+        it 'should not include files that was explicity excluded' do
+          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
+          FileSelection.new(document_path) do |fs|
+            fs.include('*_1')
+          end.files.should include(document_path('document_1'))
+        end
+        it 'should not include the same files' do
+          FileSelection.new(document_path) do |fs|
+            fs.include('*')
+            fs.include('*')
+          end.files.should have(3).items
+        end
+        it 'should not include directory' do
+          FileSelection.new(document_path) do |fs|
+            fs.include('**/*')
+          end.files.should_not include(document_path('subdir'))
+        end
+      end
+    end
+  end
+end
+

data/spec/dokkit/environment/test_data/doc/pages/document_1.yaml

@@ -0,0 +1,3 @@
+---
+key: value
+---

data/spec/dokkit/factory/factory_spec.rb

@@ -0,0 +1,69 @@
+#                                                                          
+# File 'factory_spec.rb' created on 25 apr 2008 at 19:42:47.                    
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (c) 2006, 2007, 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+# To execute this spec run:                                            
+#                                                                          
+# spec spec/factory_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../../../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit/factory/factory'
+require 'spec/spec_helper.rb'
+
+describe Dokkit::Factory do
+  include SpecHelper::Logger, SpecHelper::Cache, SpecHelper::Configuration, SpecHelper::Resource
+  before do
+    class Foo
+      attr_reader :arg1, :arg2
+      def initialize(arg1, arg2)
+        @arg1, @arg2 = arg1, arg2
+      end
+    end
+    @foo_factory_method = lambda { |arg1, arg2| Foo.new(arg1, arg2) } 
+  end
+  describe ' when adding new factory method' do  
+    before do
+      @factory = Dokkit::Factory.new
+    end
+    it 'should add new factory method for a particular class of objects' do
+      @factory.add(:foo => @foo_factory_method)
+      @factory.methods[:foo].should == @foo_factory_method
+    end
+  end
+  describe ' when client require an object instance' do
+    before do
+      @factory = Dokkit::Factory.new do |factory| 
+        factory.add(:foo => @foo_factory_method)
+      end
+    end
+    it 'should construct an instance for the given class' do
+      instance = @factory.get(:foo, 'arg1', 'arg2')
+      instance.is_a?(Foo).should be_true
+    end
+    it 'should correctly process constructor arguments' do
+      instance = @factory.get(:foo, 'arg1', 'arg2')
+      instance.arg1.should == 'arg1'
+      instance.arg2.should == 'arg2'
+    end
+    it 'should correctly store instances' do
+      instance_1 = @factory.get(:foo, 'arg1', 'arg2')
+      instance_2 = @factory.get(:foo, 'arg3', 'arg4')
+      @factory.instances.should == { [:foo, 'arg1', 'arg2'] => instance_1, [:foo, 'arg3', 'arg4'] => instance_2}
+    end
+    it 'should instantiate only one object for a given class and arguments set' do
+      instance_1 = @factory.get(:foo, 'arg1', 'arg2')    
+      instance_1.object_id.should == @factory.get(:foo, 'arg1', 'arg2').object_id
+      instance_1.object_id.should_not == @factory.get(:foo, 'arg3', 'arg4').object_id
+      instance_1.object_id.should == @factory.get(:foo, 'arg1', 'arg2').object_id
+    end
+  end
+end
+
+

data/spec/{filter_deplate_spec.rb → dokkit/filters/deplate_spec.rb}

@@ -10,35 +10,34 @@
 #                                                                          
 
 
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+$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
+describe Dokkit::Filter::DeplateHTML do
   before do
-    @deplate = Dokkit::Filters::DeplateHTML.new
+    @deplate = Dokkit::Filter::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
+describe Dokkit::Filter::DeplateLatex do
   before do
-    @deplate = Dokkit::Filters::DeplateLatex.new
+    @deplate = Dokkit::Filter::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
+describe Dokkit::Filter::DeplateText do
   before do
-    @deplate = Dokkit::Filters::DeplateText.new
+    @deplate = Dokkit::Filter::DeplateText.new
   end
   it 'should transform deplate wiki text in plain text' do
     @deplate.filter('* Header').should =~ /\n1 Header\n=+$/

data/spec/{filter_maruku_spec.rb → dokkit/filters/maruku_spec.rb}

@@ -10,17 +10,16 @@
 #                                                                          
 
 
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+$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
+describe Dokkit::Filter::MarukuHTML do
   before do
-    @maruku = Dokkit::Filters::MarukuHTML.new
+    @maruku = Dokkit::Filter::MarukuHTML.new
   end
   it 'should transform markdown text in html' do
     @result = @maruku.filter('# Header').should =~ /\<h1.*\>Header\<\/h1\>/

data/spec/{filter_nil_spec.rb → dokkit/filters/nil_spec.rb}

@@ -10,17 +10,16 @@
 #                                                                          
 
 
-$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+$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
+describe Dokkit::Filter::Nil do
   before do
-    @nil = Dokkit::Filters::Nil.new
+    @nil = Dokkit::Filter::Nil.new
   end
   it 'should not transform source file' do
     @result = @nil.filter('Do *not* transform this text.').should == 'Do *not* transform this text.'

data/spec/{recursivemerge_spec.rb → dokkit/hash_spec.rb}

@@ -2,21 +2,14 @@
 # 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). 
+# (c)2006-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')))
+$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'
+require 'dokkit/hash'
 
 describe Hash do
   describe 'when two hash with depth 0 are merged' do
@@ -37,7 +30,7 @@ describe Hash 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
+  describe '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" }
@@ -46,7 +39,7 @@ describe Hash 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
+  describe '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)
@@ -57,13 +50,10 @@ describe Hash do
       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
+      @h1 = { :a => 'a' }
+      @h2 = { :a => ['b', 'c'] }
     end
     it 'should concatenate the string and the array' do
       @h1.recursive_merge(@h2).should == { :a => ['a', 'b', 'c'] }
@@ -72,20 +62,28 @@ describe ConfigHash do
   end
   describe 'when two array are merged' do
     before do
-      @h1 = { :a => { :b => ['a', 'b'] } }.extend ConfigHash
-      @h2 = { :a => { :b => ['c', 'd'] } }.extend ConfigHash
+      @h1 = { :a => { :b => ['a', 'b'] } }
+      @h2 = { :a => { :b => ['c', 'd'] } }
     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
+  describe 'when a :clear key is encountered' do
+    it 'should stop merging string and string' do
+      { :a => 'a', :b => 'b' }.recursive_merge({ :a => 'clear', :c => 'c' }).should == { :a => nil, :b => 'b', :c => 'c' }
+    end
+    it 'should stop merging symbol and string' do
+      { :a => :a, :b => 'b' }.recursive_merge({ :a => 'clear', :c => 'c' }).should == { :a => nil, :b => 'b', :c => 'c' }
+    end
+    it 'should stop merging arrays' do
+      { :a => ['a', 'b'], :b => 'b' }.recursive_merge({ :a => ['a', 'clear'], :c => 'c' }).should == { :a => ['a'], :b => 'b', :c => 'c' }
     end
-    it 'should store the rvalue' do
-      @h1.recursive_merge(@h2).should == { :layout => ['layout_3', 'layout_4'], :config => ['config_1', 'config_2'] }
+    it 'should stop merging array and string' do
+      { :a => ['a', 'b'], :b => 'b' }.recursive_merge({ :a => 'clear', :c => 'c' }).should == { :a => nil, :b => 'b', :c => 'c' }
     end
-  end    
+    it 'should stop merging string and array' do
+      { :a => 'a', :b => 'b' }.recursive_merge({ :a => ['clear', 'b'], :c => 'c' }).should == { :a => ['b'], :b => 'b', :c => 'c' }
+    end
+  end
 end