dokkit 0.2.0 → 0.3.0

data/lib/dokkit/taskconfig.rb

@@ -0,0 +1,39 @@
+#                                                                          
+# File 'taskconfig.rb' created on 29 feb 2008 at 07:50:50.                    
+#
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+
+require 'ostruct'
+
+module Dokkit
+  class TaskConfig < OpenStruct
+    STRIP_SLASHES = /^\/?(.*?)\/*$/
+    attr_reader :config, :directories
+    def initialize(hash = nil)
+      super(hash)
+      @directories = { }
+      
+      yield self if block_given?
+      
+      strip_slashes_from_dir
+    end
+    def directories
+      methods.each do |meth|
+        @directories[meth.to_sym] = send(meth.to_sym) if (meth =~ /\_dir$/)
+      end
+      @directories
+    end
+    
+    private
+    
+    def strip_slashes_from_dir
+      directories.each do |meth, dir|
+        stripped_dir = send(meth)[STRIP_SLASHES, 1]
+        send((meth.to_s + '=').to_sym, stripped_dir)
+      end
+    end
+  end
+end

data/lib/dokkit/templatetask.rb

@@ -0,0 +1,37 @@
+#                                                                          
+# File 'templatetask.rb' created on 03 mar 2008 at 13:16:03.                    
+#
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+
+require 'dokkit/dokkitlib'
+
+module Dokkit
+  class TemplateTask < DokkitLib
+    def initialize(model, namespace = 'template')
+      super(model, namespace, { :check_dir => true })
+    end
+    
+    private
+    
+    def pre_block_configuration
+      @config.template_dir ||= Dokkit::DEFAULT_TEMPLATE_DIR
+    end
+    def define_dokkit_create_template
+      desc "Copy the template to the given directory."
+      dokkit_task 'create', :template do |t, args|
+        template_fn = File.join(@config.template_dir, args.template)
+        @logger.error("Template '#{args.template}' doesn't exist") unless File.exists?(template_fn)
+        if ARGV.size == 2
+          dest_fn = t.application.top_level_tasks.pop
+        else
+          dest_fn = File.join('doc', args.template)          
+        end
+        @logger.info("Copy template '#{File.basename(template_fn)}' to '#{dest_fn}'")
+        cp(template_fn, dest_fn, :preserve => true, :verbose => false)
+      end
+    end
+  end
+end

data/lib/dokkit.rb

@@ -40,11 +40,6 @@
 # If Dokkit has been loaded through Gems, this will automatically
 # come from the right lib directory...
 
-require 'rote/rotetasks'
-require 'dokkit/dokkittasks'
-require 'rote/page'
-require 'dokkit/page'
-
 # Everything else should come first from Gems, if installed.
 begin
   require 'rubygems'
@@ -53,9 +48,8 @@ rescue LoadError
 end  
 
 require 'rake'
-
-# Master Dokkit version. Manage this from the Rake release support.
-DOKKITVERSION = '0.2.0'
+require 'dokkit/app'
+require 'dokkit/defaults'
 
 module Dokkit
 

data/spec/app_spec.rb

@@ -0,0 +1,55 @@
+#                                                                          
+# File 'app_spec.rb' created on 20 feb 2008 at 20:15:42.                    
+# 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/app_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/app'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::Application, ' when initialized' do
+  before do
+    @app = Dokkit.application
+  end
+  after(:all) do
+    Dokkit.release
+  end
+  it 'should instantiate a ModelTask object to manage built-in tasks' do
+    @app.builtintask.should_not be_nil
+  end
+end
+
+describe Dokkit::Application, ' running' do
+  include CaptureStdout, SpecPathHelper
+  before(:all) do
+    @initial_dir = Dir.pwd
+    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_DEST_DIR))
+  end  
+  before do
+    @app = Dokkit.application
+  end
+  after do
+    Dokkit.release
+    rm_rf 'spec/data/simpledocument'
+  end
+  after(:all) do
+    Dir.chdir(@initial_dir)
+  end      
+  it 'should output the list of built-in tasks' do
+    capture_stdout do
+      @app.do_option('--tasks', nil)
+      @app.run
+    end.should match(/new documentation/)
+  end
+end

data/spec/builtintask_spec.rb

@@ -0,0 +1,114 @@
+#                                                                          
+# File 'modeltask_spec.rb' created on 23 feb 2008 at 20:33:52.                    
+# 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/modeltask_spec.rb                                                  
+#                                                                          
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/builtintask'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::BuiltinTask, ' when initialized' do
+  before do
+    Rake.application = nil    
+    application = mock('application')
+    application.stub!(:logger)
+    @builtintask = Dokkit::BuiltinTask.new(application)
+  end
+  it 'should know the full path of dokkit installation directory' do
+    File.exists?(@builtintask.dokkit_dir).should be_true
+  end  
+  it 'should know the full path of the built-in models dir' do
+    File.exists?(@builtintask.builtin_model_dir).should be_true    
+  end
+  it 'should set a default project model' do
+    Dokkit::DEFAULT_MODEL.should == 'simpledocument'
+  end    
+  it 'should store the list of the installed models' do
+    File.exists?(File.join(@builtintask.models['simpledocument'], 'model')).should be_true    
+  end
+end
+
+describe Dokkit::BuiltinTask, ' when list task is invoked' do
+  include CaptureStdout
+  before do
+    Rake.application = nil    
+    application = mock('application')
+    application.stub!(:logger).and_return(Dokkit::Log::ConsoleLog.consolelog)        
+    @builtintask = Dokkit::BuiltinTask.new(application)
+  end
+  it 'should list the models installed on the system' do
+    capture_stdout do
+      task('list').invoke
+    end.should match(/Found model 'simpledocument'/)
+  end  
+end
+
+describe Dokkit::BuiltinTask, ' when create task is invoked' do
+  include CaptureStdout
+  before do
+    Rake.application = nil
+    ARGV.clear
+    application = mock('application')
+    application.stub!(:logger).and_return(Dokkit::Log::ConsoleLog.consolelog)
+    @builtintask = Dokkit::BuiltinTask.new(application)
+  end  
+  after do
+    rm_rf 'spec/data/simpledocument'
+  end
+  it 'should create a new documentation directory using the given model' do
+    ARGV.push('model:create[simpledocument]')    
+    ARGV.push('spec/data/simpledocument')
+    Rake.application.collect_tasks
+    task('create').invoke('simpledocument')
+    File.exists?('spec/data/simpledocument').should be_true        
+  end
+  it 'should create a new documentation directory using simpledocument as default model' do
+    ARGV.push('create')    
+    ARGV.push('spec/data/simpledocument')
+    Rake.application.collect_tasks
+    task('create').invoke
+    File.exists?('spec/data/simpledocument').should be_true    
+  end
+  it 'should inform that a new documentation directory has been created' do
+    ARGV.push('create')    
+    ARGV.push('spec/data/simpledocument')
+    Rake.application.collect_tasks
+    capture_stdout do
+      task('create').invoke    
+    end.should match(/Create '.*' based on '.*' model/)
+  end
+  it 'should raise an error if model not found' do
+    ARGV.push('create[notexists]')    
+    ARGV.push('spec/data/simpledocument')
+    Rake.application.collect_tasks    
+    lambda { 
+      task('create').invoke('spec/data/simpledocument') 
+    }.should raise_error(RuntimeError, /Model '.*' not found/)
+  end
+  it 'should raise an error if target directory exists' do
+    ARGV.push('create')    
+    ARGV.push('spec/data/test_build')
+    Rake.application.collect_tasks        
+    lambda { 
+      task('create').invoke
+    }.should raise_error(RuntimeError, /Directory '.*' exists./)
+  end
+  it 'should copy model.yaml in the target directory' do
+    ARGV.push('create')    
+    ARGV.push('spec/data/simpledocument')
+    Rake.application.collect_tasks
+    task('create').invoke    
+    File.exists?('spec/data/simpledocument/doc/configs/model.yaml').should be_true
+  end
+end
+

data/spec/cachemanager_spec.rb

@@ -0,0 +1,107 @@
+#                                                                          
+# 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/cachemanager'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::CacheManager do
+  include SpecPathHelper
+
+  describe '#init' do
+    before do
+      mkdir base_path('.cache_test') unless File.exists?(base_path('.cache_test'))
+      File.open(base_path('.cache_test/deps.rake'), 'w') do |file|
+        file.write YAML::dump({ output_path('document_1.out') => [document_path('document_1.dep')] })
+      end
+      @cache = Dokkit::CacheManager.instance
+      @cache.init('deps.rake', base_path('.cache_test'))
+    end
+    it 'should import the cache file (if exists)' do
+      task(output_path('document_1.out')).prerequisites.should include(document_path('document_1.dep'))
+    end
+    it 'should update @deps to reflect imported tasks and dependencies' do
+      @cache.deps[output_path('document_1.out')].should == [document_path('document_1.dep')]
+    end
+    after do
+      @cache.instance_eval { @deps.clear }
+      rm_rf base_path('.cache_test')
+      @cache = nil
+    end
+  end
+  describe '#add_dependency' do
+    before do
+      @cache = Dokkit::CacheManager.instance
+      @cache.init('deps.rake', base_path('.cache_test'))
+    end  
+    it 'should add dependecies to the given task' do
+      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_1.dep')
+      @cache.deps.should == {output_path('document_1.out') => ['doc/pages/document_1.dep']}
+      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_2.dep')
+      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_3.dep')
+      @cache.deps.should == {output_path('document_1.out') => [
+          'doc/pages/document_1.dep',
+          'doc/pages/document_2.dep',
+          'doc/pages/document_3.dep'
+        ]}
+    end
+    it 'should not add an existing dependency to the given task' do
+      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_1.dep')
+      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_1.dep')
+      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_2.dep')
+      @cache.deps.should == {output_path('document_1.out') => ['doc/pages/document_1.dep', 'doc/pages/document_2.dep']}      
+    end
+    after do
+      @cache.instance_eval { @deps.clear }
+      rm_rf base_path('.cache_test')
+      @cache = nil
+    end      
+  end
+  describe '#clean' do
+    before do
+      @cache = Dokkit::CacheManager.instance
+      @cache.init('deps.rake', base_path('.cache_test'))
+      @cache.add_dependency(output_path('document_1.out'), 'doc/pages/document_1.dep')
+      @cache.save
+    end
+    it 'should remove cache directory from base path' do
+      @cache.clean
+      @cache.instance_eval { @deps }.should be_empty
+      File.exists?(base_path('.cache_test')).should be_false
+    end
+    after do
+      @cache.clean
+      @cache = nil
+    end      
+  end
+  describe '#save' do
+    before do
+      @cache = Dokkit::CacheManager.instance
+      @cache.init('deps.rake', base_path('.cache_test'))
+      @cache.add_dependency('output/document_1.out', 'doc/pages/document_1.dep')
+      @cache.add_dependency('output/document_1.out', 'doc/pages/document_2.dep')
+      @cache.add_dependency('output/document_1.out', '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
+      @cache = nil
+    end  
+  end
+end

data/spec/cleantask_spec.rb

@@ -0,0 +1,72 @@
+#                                                                          
+# File 'clean_spec.rb' created on 19 feb 2008 at 19:30:45.                    
+# 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/clean_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require 'dokkit/rendertask'
+require 'dokkit/cleantask'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe Dokkit::CleanTask do
+  include SpecPathHelper
+  before(:all) do
+    @initial_dir = Dir.pwd
+    Dir.chdir(File.join(File.dirname(__FILE__), SpecPathHelper::DATA_TEST_DIR))    
+  end  
+  before do
+    Rake.application.clear
+    model = mock('model')
+    model.should_receive(:config).and_return(Dokkit::TaskConfig.new)        
+    @cleantask = Dokkit::CleanTask.new(model, 'clean') do |task|
+      task.config.output_dir = output_path
+    end
+    mkdir_p output_path
+    mkdir_p cache_path
+  end
+  after do
+    rmdir output_path if File.exists?(output_path)
+    rmdir cache_path if File.exists?(cache_path)    
+  end
+  after(:all) do
+    Dir.chdir(@initial_dir)
+  end
+  it 'should be initialized with the output directory' do
+    @cleantask.config.output_dir.should == output_path
+  end
+  describe ' when clean:output is invoked' do
+    it 'should remove output directory' do
+      task('clean:output').invoke
+      File.exists?(@cleantask.config.output_dir).should be_false
+    end
+  end
+  describe ' when clean:cache is invoked' do
+    before do
+      Rake.application.clear
+      model = mock('model')
+      cache = mock('cache')
+      cache.should_receive(:cache_dir).and_return(cache_path)         
+      cache.should_receive(:clean)            
+      model.should_receive(:config).and_return(Dokkit::TaskConfig.new)        
+      model.should_receive(:cache).twice.and_return(cache)            
+      @cleantask = Dokkit::CleanTask.new(model, 'clean') do |task|
+        task.config.output_dir = output_path
+      end
+    end    
+    it 'should call CacheManager#clean method to remove cache' do
+      task('clean:cache').invoke
+    end
+  end
+end
+

data/spec/consolelog_spec.rb

@@ -0,0 +1,69 @@
+#                                                                          
+# File 'consolelog_spec.rb' created on 23 feb 2008 at 16:40:31.                    
+# 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/consolelog_spec.rb                                                  
+#                                                                          
+
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__),'../lib')))
+
+require 'rubygems'
+require 'spec'
+require 'dokkit'
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+require 'dokkit/consolelog'
+
+describe Dokkit::Log::ConsoleLog, ' when initialized' do
+  it 'should reference to a logger instance and attach to it' do
+    @logger = mock('logger')
+    @logger.should_receive(:attach)
+    @consolelog = Dokkit::Log::ConsoleLog.new(@logger)    
+    @consolelog.logger.should_not be_nil
+  end
+end
+
+describe Dokkit::Log::ConsoleLog, ' when logger notifies' do
+  include CaptureStdout
+  before do
+    @logger = mock('logger')
+    @logger.should_receive(:attach)
+    @consolelog = Dokkit::Log::ConsoleLog.new(@logger)
+  end
+  describe ' an error message' do
+    it 'should send the error message to the console' do
+      @logger.should_receive(:last_message).and_return({ :text => 'error message', :level => Dokkit::Log::ERROR })
+      lambda { @consolelog.update }.should raise_error(RuntimeError, /\[ERROR\] error message/)
+    end
+  end
+  describe ' a warning message' do
+    it 'should send the warning message to the console' do
+      @logger.should_receive(:last_message).and_return({ :text => 'warning message', :level => Dokkit::Log::WARNING })
+      capture_stderr do
+        @consolelog.update
+      end.should match(/\[WARNING\] warning message/)
+    end
+  end
+  describe ' an info message' do
+    it 'should send the info message to the console' do
+      @logger.should_receive(:last_message).and_return({ :text => 'info message', :level => Dokkit::Log::INFO })
+      capture_stdout do
+        @consolelog.update
+      end.should match(/\[INFO\] info message/)
+    end
+  end  
+  describe ' a debug message' do
+    it 'should send the debug message the console' do
+      @logger.should_receive(:last_message).and_return({ :text => 'debug message', :level => Dokkit::Log::DEBUG })
+      capture_stdout do
+        @consolelog.update
+      end.should match(/\[DEBUG\] debug message/)
+    end
+  end  
+end
+

data/{tests/data/projects/simple-document → spec/data/test_build}/Rakefile

@@ -5,18 +5,18 @@
 #                                                                          
 # (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
 #                                                                          
-# Rakefile for simpledocument project model
+# Rakefile for website project model
+
+require 'tasks/all'
+
+task :clobber => 'clean:all'
+task :default => 'render:all'
+
+
 
-require 'dokkit'
-require 'dokkit/app'
-require 'dokkit/render_task_factory'
 
 
-factory = Dokkit::RenderTaskFactory.instance
 
-factory.create_render_html
-factory.create_render_tex
 
-task :default => [:render_html]
 
 

data/spec/data/test_build/doc/configs/document_1.yaml

@@ -0,0 +1,3 @@
+---
+test_config_merge: This is to test the correct merge of document configuration keys.
+

data/spec/data/test_build/doc/configs/required.yaml

@@ -0,0 +1,3 @@
+---
+required_key: required value for document_1
+  

data/spec/data/test_build/doc/configs/subdir/document_4.yaml

@@ -0,0 +1,3 @@
+---
+document:
+  test_config: This is to test configuration rendering.

data/spec/data/test_build/doc/layouts/document_1.html

@@ -0,0 +1,9 @@
+<html>
+<head>
+  <title>A changed title</title>
+</head>
+<body>
+  <%= render_partial('partials/partial') %>
+  <%= @content_for_layout %>
+</body>
+</html>

data/spec/data/test_build/doc/layouts/document_1.latex

@@ -0,0 +1,8 @@
+\documentclass[a4paper,12pt]{article}
+\usepackage[utf8]{inputenc}
+
+\begin{document}
+
+<%= @content_for_layout %>
+
+\end{document}

data/spec/data/test_build/doc/layouts/document_with_partials.html

@@ -0,0 +1,9 @@
+<html>
+<head>
+  <title>A changed title</title>
+</head>
+<body>
+  <%= render_partial('partials/circular_partial') %>
+  <%= @content_for_layout %>
+</body>
+</html>

data/spec/data/test_build/doc/layouts/layout.html

@@ -0,0 +1,8 @@
+<html>
+<head>
+  <title>A title</title>
+</head>
+<body>
+  <%= @content_for_layout %>
+</body>
+</html>

data/spec/data/test_build/doc/layouts/layout.html.backup

@@ -0,0 +1,8 @@
+<html>
+<head>
+  <title>A title</title>
+</head>
+<body>
+  <%= @content_for_layout %>
+</body>
+</html>

data/spec/data/test_build/doc/layouts/nested.html

@@ -0,0 +1,3 @@
+<div class="nested">
+  <%= @content_for_layout %>
+</div>

data/spec/data/test_build/doc/layouts/partials/partial.html

@@ -0,0 +1,4 @@
+<div class="partial">
+<%= @content_for_layout %>
+</div>
+

data/spec/data/test_build/doc/pages/COMMON.yaml

@@ -0,0 +1,6 @@
+---
+layout: document_1
+test_common_key: common value for all the documents in the current directory
+
+
+      

data/spec/data/test_build/doc/pages/document_1

@@ -0,0 +1,20 @@
+* Title for document_1
+Body of document_1
+
+ * item 1
+ * item 2
+ * item 3
+
+<%= configuration['test_config'] %>
+
+<%= configuration['notexists'] %>
+
+<%= configuration['test_config_merge'] %>
+
+<%= "Current rendering format is: #{@format}" %>
+
+* Section
+
+<%= "This is to test embedded " + "e"+"r"+"b" + " in document_1 source file." %>
+
+

data/spec/data/test_build/doc/pages/document_1.dep

@@ -0,0 +1,4 @@
+CHANGED!!!
+
+
+

data/spec/data/test_build/doc/pages/document_1.yaml

@@ -0,0 +1,11 @@
+---
+test_config: This is to test configuration rendering.
+config:
+- required
+render_in:
+- html
+- tex:
+    filters:
+    - deplate-latex
+    ext: .latex
+    output: latex