dokkit 0.4.1 → 0.4.2

data/Manifest.txt

@@ -17,6 +17,7 @@ lib/dokkit/factory/factory.rb
 lib/dokkit/filters.rb
 lib/dokkit/filters/deplate.rb
 lib/dokkit/filters/erb.rb
+lib/dokkit/filters/haml.rb
 lib/dokkit/filters/maruku.rb
 lib/dokkit/filters/nil.rb
 lib/dokkit/filters/tidy.rb
@@ -45,65 +46,6 @@ lib/dokkit/resource/filenamehelper.rb
 lib/dokkit/tasklib.rb
 lib/dokkit/tasklib/clean.rb
 lib/dokkit/tasklib/render.rb
-spec/dokkit/application_spec.rb
-spec/dokkit/cache/cache_spec.rb
-spec/dokkit/dokkit_spec.rb
-spec/dokkit/environment/basic_spec.rb
-spec/dokkit/environment/helpers/extmap_spec.rb
-spec/dokkit/environment/helpers/fileselection_spec.rb
-spec/dokkit/environment/helpers/test_data/doc/pages/document_1.ext_1
-spec/dokkit/environment/helpers/test_data/doc/pages/document_2
-spec/dokkit/environment/helpers/test_data/doc/pages/document_3.ext_3
-spec/dokkit/environment/test_data/doc/data/data
-spec/dokkit/environment/test_data/doc/pages/document_1
-spec/dokkit/environment/test_data/doc/pages/document_1.yaml
-spec/dokkit/environment/test_data/doc/pages/document_2
-spec/dokkit/environment/test_data/doc/pages/subdir/document_1
-spec/dokkit/factory/factory_spec.rb
-spec/dokkit/filters/deplate_spec.rb
-spec/dokkit/filters/erb_spec.rb
-spec/dokkit/filters/maruku_spec.rb
-spec/dokkit/filters/nil_spec.rb
-spec/dokkit/filters/tidy_spec.rb
-spec/dokkit/hash_spec.rb
-spec/dokkit/logging/logger_spec.rb
-spec/dokkit/logging/observers/console_spec.rb
-spec/dokkit/resource/data_spec.rb
-spec/dokkit/resource/document_spec.rb
-spec/dokkit/resource/extensions/html_spec.rb
-spec/dokkit/resource/extensions/url_spec.rb
-spec/dokkit/resource/filenamehelper_spec.rb
-spec/dokkit/resource/test_data/doc/configs/config_1.yaml
-spec/dokkit/resource/test_data/doc/configs/config_2.yaml
-spec/dokkit/resource/test_data/doc/configs/required.yaml
-spec/dokkit/resource/test_data/doc/configs/subdir/document.yaml
-spec/dokkit/resource/test_data/doc/layouts/container.html
-spec/dokkit/resource/test_data/doc/layouts/layout.html
-spec/dokkit/resource/test_data/doc/layouts/layout.latex
-spec/dokkit/resource/test_data/doc/layouts/nested/nested.html
-spec/dokkit/resource/test_data/doc/layouts/subdir/document.html
-spec/dokkit/resource/test_data/doc/layouts/subdir/document.latex
-spec/dokkit/resource/test_data/doc/pages/COMMON.yaml
-spec/dokkit/resource/test_data/doc/pages/document_with_many_config.ext
-spec/dokkit/resource/test_data/doc/pages/document_with_many_errors.ext
-spec/dokkit/resource/test_data/doc/pages/document_with_many_targets.ext
-spec/dokkit/resource/test_data/doc/pages/document_with_nested_layout.ext
-spec/dokkit/resource/test_data/doc/pages/document_with_nil_target.ext
-spec/dokkit/resource/test_data/doc/pages/document_with_not_defined_target.ext
-spec/dokkit/resource/test_data/doc/pages/document_with_one_target.ext
-spec/dokkit/resource/test_data/doc/pages/document_with_postfilter.ext
-spec/dokkit/resource/test_data/doc/pages/subdir/COMMON.yaml
-spec/dokkit/resource/test_data/doc/pages/subdir/document.ext
-spec/dokkit/resource/test_data/doc/pages/subdir/document.yaml
-spec/dokkit/tasklib/clean_spec.rb
-spec/dokkit/tasklib/render_spec.rb
-spec/dokkit/tasklib/test_data/doc/data/data_1
-spec/dokkit/tasklib/test_data/doc/pages/document_1
-spec/dokkit/tasklib/test_data/doc/pages/document_2
-spec/dokkit/test_data/dokkit/models/model1/doc/pages/model1
-spec/dokkit/test_data/dokkit/models/model2/doc/pages/model2
-spec/spec.opts
-spec/spec_helper.rb
 tasks/annotations.rake
 tasks/doc.rake
 tasks/gem.rake

data/lib/dokkit.rb

@@ -51,5 +51,5 @@ rescue LoadError
 end  
 
 module Dokkit
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end 

data/lib/dokkit/environment/basic.rb

@@ -48,6 +48,18 @@ module Dokkit
         @cache ||= Cache.new
       end
 
+      def default_filter_chain
+        { 
+          'deplate' => { 'html' => ['erb', 'deplate-html'], 'latex' => ['erb', 'deplate-latex'], 'text' => ['erb', 'deplate-text']},
+          'maruku' => { 'html' => ['erb', 'maruku-html'], 'latex' => ['erb', 'maruku-latex'], 'text' => ['erb', 'maruku-text']},
+          'haml' => { 'html' => ['haml'] },
+        }  
+      end
+      
+      def default_postfilter_chain
+        { 'html' => ['erb'], 'latex' => ['erb'], 'text' => ['erb'] }  
+      end
+      
       # Return an OpenStruct object to setup documentation
       # directories. Instantiate the object only once.
       #
@@ -59,16 +71,17 @@ module Dokkit
       # configuration.cache_dir :: set/get cache folder.
       #
       def configuration
-        @configuration ||= OpenStruct.new({ 
-          :document_dir => 'doc/pages',
-          :config_dir => 'doc/configs',
-          :layout_dir => 'doc/layouts',
-          :data_dir => 'doc/data',
-          :output_dir => 'output',
-          :cache_dir => '.cache'
-        })
+        @configuration ||= OpenStruct.new({ :document_dir => 'doc/pages',
+                                            :config_dir => 'doc/configs',
+                                            :layout_dir => 'doc/layouts',
+                                            :data_dir => 'doc/data',
+                                            :output_dir => 'output',
+                                            :cache_dir => '.cache',
+                                            :default_filter_chain => default_filter_chain,
+                                            :default_postfilter_chain => default_postfilter_chain })
       end
 
+
       # Return a Dokkit::Environment::Helper::FileSelection object
       # with the list of documents in configuration.document_dir
       # folder and its subdir. The object is instantiated only
@@ -97,12 +110,14 @@ module Dokkit
       # Construct a filter factory and register filters.
       def filter_factory
         @filter_factory ||= Dokkit::Factory.new do |factory|
+          factory.add('nil' => lambda { Dokkit::Filter::Nil.new } )
           factory.add('erb' => lambda { |binding| Dokkit::Filter::ERB.new(binding) } )
           factory.add('tidy' => lambda { Dokkit::Filter::Tidy.new } )
           factory.add('maruku-html' => lambda { Dokkit::Filter::MarukuHTML.new } )
           factory.add('deplate-latex' => lambda { Dokkit::Filter::DeplateLatex.new } )
           factory.add('deplate-html' => lambda { Dokkit::Filter::DeplateHTML.new } )
           factory.add('deplate-text' => lambda { Dokkit::Filter::DeplateText.new } )
+          factory.add('haml' => lambda { |document| Dokkit::Filter::Haml.new(document) } )
         end
       end
 

data/lib/dokkit/filters.rb

@@ -11,3 +11,4 @@ require 'dokkit/filters/erb'
 require 'dokkit/filters/deplate'
 require 'dokkit/filters/maruku'
 require 'dokkit/filters/tidy'
+require 'dokkit/filters/haml'

data/lib/dokkit/filters/erb.rb

@@ -13,12 +13,12 @@ module Dokkit
 
     class ERB
       
-      def initialize(binding)
-        @binding = binding
+      def initialize(document)
+        @document = document
       end
       
       def filter(text)
-        ::ERB.new(text).result(@binding)
+        ::ERB.new(text).result(@document.get_binding)
       end
       
     end

data/lib/dokkit/filters/haml.rb

@@ -0,0 +1,31 @@
+#                                                                          
+# File 'haml.rb' created on 04 ago 2008 at 17:05:24.                    
+#
+# See 'dokkit.rb' or +LICENSE+ for licence information.                      
+#                                                                          
+# (C)2006-2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors). 
+#                                                                          
+
+require 'haml'
+
+module Dokkit
+  module Filter
+
+    class Haml
+
+      def initialize(document)
+        @document = document
+      end
+
+      def filter(text)
+        ::Haml::Engine.new(text).to_html(@document.get_binding)
+      end      
+
+    end    
+
+
+  end
+end
+
+
+

data/lib/dokkit/models/simple/doc/layouts/simple.html

@@ -1,7 +1,7 @@
 <html>
 <link href="<%= relative('/html/css/style.css') %>" rel="stylesheet" type="text/css" media="screen" />
 <head>
-  <title><%= @configuration['title'] %></title>
+  <title><%= title %></title>
 </head>
 <body>
   <%= @content_for_layout %>

data/lib/dokkit/resource/document.rb

@@ -23,24 +23,12 @@ module Dokkit
       # Includes the builtin extensions to be used by Document objects.
       include Extension::Builtin
       
-      # Set the default filters chain for commonly used output format.
-      DEFAULT_FILTERS_CHAIN = {
-        'html' => ['erb', 'deplate-html'],
-        'latex' => ['erb', 'deplate-latex'],
-        'text' => ['erb', 'deplate-text']
-      }
-      DEFAULT_POST_FILTERS_CHAIN = {
-        'html' => ['erb'],
-        'latex' => ['erb'],
-        'text' => ['erb']
-      }     
-      attr_reader :configuration
       attr_reader :source_fn
       attr_reader :basename, :name_noext, :dirname, :relativename
       attr_reader :config_fns, :layout_fns, :target_fns
       attr_reader :targets, :layouts, :deps
-      attr_reader :default_config_ext, :default_format
-      attr_accessor :default_configuration_value
+      attr_reader :default_config_ext, :default_format, :default_formatter
+      attr_accessor :configuration, :default_configuration_value
       
       # Initialize a Document instance.
       # +source_fn+:: is the file name of the document source file.
@@ -66,23 +54,44 @@ module Dokkit
         # Get name relative to configuration.document_dir
         @relativename = filename_helper(@name_noext, configuration[:document_dir], '')
 
-        # Set defaults
+        # Set default configuration file extension
         @default_config_ext = '.yaml'
+        # Set default output format
         @default_format = 'html'
+        # Set default input formatter format
+        @default_formatter = 'deplate'
 
+        @default_configuration_value = 'not defined'
+        
         # yield self to an optional configuration block
         yield self if block_given?
         
         # Setup hashes
         setup_header_configuration
-        setup_configuration_hash(configuration.recursive_merge('layout' => @relativename))
+        @configuration = configuration.recursive_merge('layout' => @relativename)
         setup_targets(@default_format)
         
         # Configure the document
         configure
+        
+        @formatter = @configuration['formatter'] || @default_formatter
+
         collect_all
       end
       
+      def method_missing(meth)
+        if @configuration.has_key?(meth.to_s)
+          @configuration[meth.to_s]
+        else
+          @logger.warn("Configuration key '#{meth.to_s}' is not defined for #{source_fn}.")
+          @default_configuration_value
+        end
+      end
+
+      def get_binding
+        binding
+      end
+      
       # Read the configuration file +fn+ and return:
       # * the resulting configuration hash
       # * an array containing the names of the read config files
@@ -111,33 +120,33 @@ module Dokkit
         end
       end
 
-      # Return the filters chain associated with the given format.
-      def filters_for(format)
-        if @targets.has_key?(format)
-          if @targets[format].has_key?('filter')
-            @targets[format]['filter']
-          elsif DEFAULT_FILTERS_CHAIN.has_key?(format)
-            DEFAULT_FILTERS_CHAIN[format]
-          end
-        elsif DEFAULT_FILTERS_CHAIN.has_key?(format)
-          DEFAULT_FILTERS_CHAIN[format]
+      def default_filter_chain_for(formatter, format)
+        @configuration[:default_filter_chain][formatter][format]
+      end
+
+      def default_postfilter_chain_for(format)
+        @configuration[:default_postfilter_chain][format]
+      end
+
+      def has_format?(format)
+        @targets.has_key?(format)
+      end
+      
+      # Return the filters chain associated with the given formatter and output format.
+      def filters_for(formatter, format)
+        if has_format?(format)
+          process_filter_key('filter', format, default_filter_chain_for(formatter, format))
         else
-          @logger.error("No defined filters chain for format '#{format}'!")
+          default_filter_chain_for(formatter, format)
         end
       end
 
       # Return the post filters chain associated with the given format.
       def post_filters_for(format)
-        if @targets.has_key?(format)
-          if @targets[format].has_key?('postfilter')
-            @targets[format]['postfilter']
-          elsif DEFAULT_POST_FILTERS_CHAIN.has_key?(format)
-            DEFAULT_POST_FILTERS_CHAIN[format]
-          end
-        elsif DEFAULT_POST_FILTERS_CHAIN.has_key?(format)
-          DEFAULT_POST_FILTERS_CHAIN[format]
+        if has_format?(format)
+          process_filter_key('postfilter', format, default_postfilter_chain_for(format))
         else
-          @logger.error("No defined post filters chain for format '#{format}'!")
+          default_postfilter_chain_for(format)
         end
       end
 
@@ -152,14 +161,7 @@ module Dokkit
       def current_format
         @current_format || @default_format
       end
-      
-      def include(fn)
-        @cache.add_dependency(source_fn, current_format, fn)
-        erb = ERB.new(File.read(fn))
-        erb.filename = fn
-        erb.result
-      end
-      
+            
       # Render the document in the specified format.
       def render(args = { })
         @current_format = args[:format]
@@ -169,7 +171,7 @@ module Dokkit
           @cache.add_dependency(source_fn, args[:format], document.source_fn)
           document.render(:format => args[:format])
         else
-          do_render!(args[:format])
+          do_render!(@formatter, args[:format])
         end
       end
       
@@ -180,6 +182,10 @@ module Dokkit
             
       private
 
+      def process_filter_key(key, format, default_filter_chain)
+        @targets[format].has_key?(key) ? @targets[format][key] : default_filter_chain
+      end
+
       # Read the content of the source document file from disk.
       def read_source
         File.read(source_fn)
@@ -201,16 +207,6 @@ module Dokkit
         @config_fns << fn
         process_config_configuration_key if @configuration.has_key?('config')
       end
-
-      # Setup configuration hash with initial value.
-      def setup_configuration_hash(configuration)
-        @default_configuration_value = "not defined"
-        @configuration = Hash.new do |h, k|
-          @logger.warn("Configuration key '#{k}' is not defined for #{source_fn}.")
-          h[k] = @default_configuration_value
-        end
-        @configuration.merge! configuration
-      end
       
       def setup_header_configuration
         @header_configuration = extract_configuration_from_source!
@@ -222,9 +218,9 @@ module Dokkit
       end
       
       # Render document in the given format.
-      def do_render!(format)
+      def do_render!(formatter, format)
         if @targets[format]
-          render_source!(format)
+          render_source!(formatter, format)
           render_all_layouts!(format)
         else
           @logger.error("Don't know how to render '#{source_fn}': format '#{format}' is unknown.")
@@ -233,8 +229,8 @@ module Dokkit
       end
       
       # Produce output from source.
-      def render_source!(format)
-        @content_for_layout = apply_filters(@source, filters_for(format), format) unless @source.nil?
+      def render_source!(formatter, format)
+        @content_for_layout = apply_filters(@source, filters_for(formatter, format), format) unless @source.nil?
       end
       
       def render_layout!(layout_fn, format)
@@ -272,7 +268,7 @@ module Dokkit
           @layouts[format] = []
           
           process_layout_configuration_key(format)
-          
+
           @layouts[format].uniq!
           @layouts[format].compact!
         end
@@ -302,8 +298,8 @@ module Dokkit
         opts = format.values.first
         if opts
           ext = (opts['ext'] if opts.has_key?('ext')) || format_key
-          filters =  (opts['filter'] if opts.has_key?('filter')) || DEFAULT_FILTERS_CHAIN['html']
-          post_filters = (opts['postfilter'] if opts.has_key?('postfilter')) || DEFAULT_POST_FILTERS_CHAIN['html']
+          filters =  (opts['filter'] if opts.has_key?('filter')) || default_filter_chain_for(@formatter, 'html')
+          post_filters = (opts['postfilter'] if opts.has_key?('postfilter')) || default_postfilter_chain_for('html')
           { :target_fn => target_fn(ext.to_sym), 'filter' => filters, 'postfilter' => post_filters }
         else
           @logger.error("You must define format '#{format}'!")
@@ -379,7 +375,7 @@ module Dokkit
       
       # Apply filters on text to produce the given format.
       def apply_filters(text, filters_chain, format)
-        filters_chain.collect { |filter| @filter_factory.get(filter, binding) }.inject(text) { |s, f| f.filter(s) }
+        filters_chain.collect { |filter| @filter_factory.get(filter, self) }.inject(text) { |s, f| f.filter(s) }
       end
       
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dokkit
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors: 
 - Andrea Fazzi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-27 00:00:00 +00:00
+date: 2008-08-05 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -69,6 +69,7 @@ files:
 - lib/dokkit/filters.rb
 - lib/dokkit/filters/deplate.rb
 - lib/dokkit/filters/erb.rb
+- lib/dokkit/filters/haml.rb
 - lib/dokkit/filters/maruku.rb
 - lib/dokkit/filters/nil.rb
 - lib/dokkit/filters/tidy.rb
@@ -97,65 +98,6 @@ files:
 - lib/dokkit/tasklib.rb
 - lib/dokkit/tasklib/clean.rb
 - lib/dokkit/tasklib/render.rb
-- spec/dokkit/application_spec.rb
-- spec/dokkit/cache/cache_spec.rb
-- spec/dokkit/dokkit_spec.rb
-- spec/dokkit/environment/basic_spec.rb
-- spec/dokkit/environment/helpers/extmap_spec.rb
-- spec/dokkit/environment/helpers/fileselection_spec.rb
-- spec/dokkit/environment/helpers/test_data/doc/pages/document_1.ext_1
-- spec/dokkit/environment/helpers/test_data/doc/pages/document_2
-- spec/dokkit/environment/helpers/test_data/doc/pages/document_3.ext_3
-- spec/dokkit/environment/test_data/doc/data/data
-- spec/dokkit/environment/test_data/doc/pages/document_1
-- spec/dokkit/environment/test_data/doc/pages/document_1.yaml
-- spec/dokkit/environment/test_data/doc/pages/document_2
-- spec/dokkit/environment/test_data/doc/pages/subdir/document_1
-- spec/dokkit/factory/factory_spec.rb
-- spec/dokkit/filters/deplate_spec.rb
-- spec/dokkit/filters/erb_spec.rb
-- spec/dokkit/filters/maruku_spec.rb
-- spec/dokkit/filters/nil_spec.rb
-- spec/dokkit/filters/tidy_spec.rb
-- spec/dokkit/hash_spec.rb
-- spec/dokkit/logging/logger_spec.rb
-- spec/dokkit/logging/observers/console_spec.rb
-- spec/dokkit/resource/data_spec.rb
-- spec/dokkit/resource/document_spec.rb
-- spec/dokkit/resource/extensions/html_spec.rb
-- spec/dokkit/resource/extensions/url_spec.rb
-- spec/dokkit/resource/filenamehelper_spec.rb
-- spec/dokkit/resource/test_data/doc/configs/config_1.yaml
-- spec/dokkit/resource/test_data/doc/configs/config_2.yaml
-- spec/dokkit/resource/test_data/doc/configs/required.yaml
-- spec/dokkit/resource/test_data/doc/configs/subdir/document.yaml
-- spec/dokkit/resource/test_data/doc/layouts/container.html
-- spec/dokkit/resource/test_data/doc/layouts/layout.html
-- spec/dokkit/resource/test_data/doc/layouts/layout.latex
-- spec/dokkit/resource/test_data/doc/layouts/nested/nested.html
-- spec/dokkit/resource/test_data/doc/layouts/subdir/document.html
-- spec/dokkit/resource/test_data/doc/layouts/subdir/document.latex
-- spec/dokkit/resource/test_data/doc/pages/COMMON.yaml
-- spec/dokkit/resource/test_data/doc/pages/document_with_many_config.ext
-- spec/dokkit/resource/test_data/doc/pages/document_with_many_errors.ext
-- spec/dokkit/resource/test_data/doc/pages/document_with_many_targets.ext
-- spec/dokkit/resource/test_data/doc/pages/document_with_nested_layout.ext
-- spec/dokkit/resource/test_data/doc/pages/document_with_nil_target.ext
-- spec/dokkit/resource/test_data/doc/pages/document_with_not_defined_target.ext
-- spec/dokkit/resource/test_data/doc/pages/document_with_one_target.ext
-- spec/dokkit/resource/test_data/doc/pages/document_with_postfilter.ext
-- spec/dokkit/resource/test_data/doc/pages/subdir/COMMON.yaml
-- spec/dokkit/resource/test_data/doc/pages/subdir/document.ext
-- spec/dokkit/resource/test_data/doc/pages/subdir/document.yaml
-- spec/dokkit/tasklib/clean_spec.rb
-- spec/dokkit/tasklib/render_spec.rb
-- spec/dokkit/tasklib/test_data/doc/data/data_1
-- spec/dokkit/tasklib/test_data/doc/pages/document_1
-- spec/dokkit/tasklib/test_data/doc/pages/document_2
-- spec/dokkit/test_data/dokkit/models/model1/doc/pages/model1
-- spec/dokkit/test_data/dokkit/models/model2/doc/pages/model2
-- spec/spec.opts
-- spec/spec_helper.rb
 - tasks/annotations.rake
 - tasks/doc.rake
 - tasks/gem.rake