dokkit 0.4.1 → 0.4.2

data/spec/dokkit/application_spec.rb

@@ -1,141 +0,0 @@
-#                                                                          
-# File 'application_spec.rb' created on 08 mag 2008 at 17:26:24.                    
-# 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/application'
-require 'spec/spec_helper'
-
-describe Dokkit::Application, ' options behaviour' do
-  include SpecHelper::CaptureOutput, SpecHelper::Logger
-  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
-    @logger = logger
-    @dokkit = Dokkit::Application.new(@logger, { :dokkit_dir => 'dokkit', :model_dir => 'models', :default_model => 'model1' })
-  end
-  after do
-    ARGV.clear
-  end
-  it 'should set default model' do
-    @dokkit.default_model.should == 'model1'
-  end
-  it 'should display version number' do
-    ARGV << '--version'
-    capture_stdout do
-      lambda do
-        @dokkit.run
-      end.should raise_error(SystemExit)
-    end.should match(/dokkit, version \d.\d.\d/)
-  end
-  #FIXME: Code duplication here ...
-  it 'should alias --help option with --usage' do
-    ARGV << '--help'
-    @output = capture_stdout do
-      lambda do
-        @dokkit.run
-      end.should raise_error(SystemExit)
-    end
-    @output.should match(/Usage: dokkit/)
-    @output.should match(/Recognized options/)
-  end
-  it 'should display usage information' do
-    ARGV << '--usage'
-    @output = capture_stdout do
-      lambda do
-        @dokkit.run
-      end.should raise_error(SystemExit)
-    end
-    @output.should match(/Usage: dokkit/)
-    @output.should match(/Recognized options/)
-  end
-  it 'should display the list of available models' do
-    ARGV << '--list'
-    @logger.should_receive(:info).with(/model[1-2]/).twice
-    lambda do 
-      @dokkit.run
-    end.should raise_error(SystemExit)
-  end
-  it 'should fail if the number of commandline argument is less than one' do
-    @output = capture_stdout do
-      lambda do 
-        @dokkit.run
-      end.should raise_error(SystemExit)
-    end
-  end
-end
-
-describe Dokkit::Application, ' creating new documentation environment based on builtin model' do
-  include SpecHelper::CaptureOutput, SpecHelper::Logger
-  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
-    @logger = logger
-    @dokkit = Dokkit::Application.new(@logger)
-  end
-  after do
-    ARGV.clear
-    FileUtils.rm_rf 'project'
-  end
-  it 'should copy builtin model directory structure on destination dir' do
-    ARGV << 'project'
-    @dokkit.run
-    File.exists?('project/doc/pages/simple.deplate').should be_true
-  end
-  it 'should fail if the destination directory exists' do
-    ARGV << 'project'
-    FileUtils.mkdir 'project'
-    @logger.should_receive(:error).with(/already exists/)
-    @dokkit.run
-  end
-end
-
-describe Dokkit::Application, ' creating new documentation environment based on user models' do
-  include SpecHelper::CaptureOutput, SpecHelper::Logger
-  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
-    @logger = logger
-    @dokkit = Dokkit::Application.new(@logger, { :dokkit_dir => 'dokkit', :model_dir => 'models', :default_model => 'model1' })
-  end
-  after do
-    ARGV.clear
-    FileUtils.rm_rf 'project'
-  end
-  it 'should copy model1 directory structure on destination dir' do
-    ARGV << 'project'
-    @dokkit.run
-    File.exists?('project/doc/pages/model1').should be_true
-  end
-  it 'should copy model2 directory structure on destination dir' do
-    ARGV.concat(['--model', 'model2', 'project'])
-    @dokkit.run
-    File.exists?('project/doc/pages/model2').should be_true
-  end
-  it 'should fail if not existent model is specified' do
-    ARGV.concat(['--model', 'notexists', 'project'])
-    @logger.should_receive(:error).with(/not found/)
-    @dokkit.run
-  end
-end

data/spec/dokkit/cache/cache_spec.rb

@@ -1,87 +0,0 @@
-#                                                                          
-# File 'cachemanager_spec.rb' created on 28 gen 2008 at 18:31:31.                    
-# See 'dokkit.rb' or +LICENSE+ for licence information.                      
-#                                                                          
-# (c)2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
-#                                                                          
-# To execute this spec run:                                            
-#                                                                          
-# spec spec/cachemanager_spec.rb                                                  
-#                                                                          
-
-
-$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__),'../../../lib'))
-
-require 'rubygems'
-require 'spec'
-require 'dokkit'
-require 'dokkit/cache'
-require 'spec/spec_helper'
-
-describe Dokkit::Cache 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
-
-  describe ' when initialized' do
-    before do
-      mkdir '.cache_test' unless File.exists?('.cache_test')
-      File.open(base_path('.cache_test/deps.rake'), 'w') do |file|
-        file.write YAML::dump({ document_path('document_1') => { 'html' => [document_path('document_1.dep')] } } )
-      end
-      @cache = Dokkit::Cache.new('deps.rake', '.cache_test')
-    end
-    it 'should import the cache file (if exists)' do
-      @cache.deps.should == { document_path('document_1') => { 'html' => [document_path('document_1.dep')] } }
-    end
-    after do
-      @cache.clean
-      rm_rf base_path('.cache_test')
-    end
-  end
-  
-  describe '#add_dependency' do
-    before do
-      @cache = Dokkit::Cache.new('deps.rake', '.cache_test')
-    end  
-    it 'should add dependecies to the given document' do
-      @cache.add_dependency(document_path('document_1'), 'html', 'doc/pages/document_1.dep')
-      @cache.deps.should == { document_path('document_1') => { 'html' => [document_path('document_1.dep')] } }
-    end
-    it 'should not add an existing dependency to the given document' do
-      @cache.add_dependency(document_path('document_1'), 'html', 'doc/pages/document_1.dep')
-      @cache.add_dependency(document_path('document_1'), 'html', 'doc/pages/document_1.dep')
-      @cache.add_dependency(document_path('document_1'), 'html', 'doc/pages/document_2.dep')
-      @cache.deps.should == { document_path('document_1') => { 'html' => ['doc/pages/document_1.dep', 'doc/pages/document_2.dep'] } }      
-    end
-    after do
-      @cache.clean
-      rm_rf '.cache_test'
-      @cache = nil
-    end      
-  end
-  
-  describe '#save' do
-    before do
-      @cache = Dokkit::Cache.new('deps.rake', '.cache_test')
-      @cache.add_dependency(document_path('document_1'), 'html', 'doc/pages/document_1.dep')
-      @cache.add_dependency(document_path('document_1'), 'html', 'doc/pages/document_2.dep')
-      @cache.add_dependency(document_path('document_1'), 'html', 'doc/pages/document_3.dep')
-    end  
-    it 'should save the dependencies to file' do
-      @cache.save
-      File.exists?(base_path('.cache_test/deps.rake')).should be_true
-    end
-    after do
-      @cache.clean
-      rm_rf '.cache_test'
-    end  
-    
-  end
-end

data/spec/dokkit/dokkit_spec.rb

@@ -1,20 +0,0 @@
-#                                                                          
-# 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

@@ -1,138 +0,0 @@
-#                                                                          
-# 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 ERB filter instance through filter factory' do
-      @container.filter_factory.get('erb', binding).is_a?(Filter::ERB).should be_true
-    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

@@ -1,52 +0,0 @@
-#                                                                          
-# 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

@@ -1,80 +0,0 @@
-#
-# 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
-