webgen 1.0.0.beta3 → 1.0.0

data/lib/webgen/version.rb

@@ -3,6 +3,6 @@
 module Webgen
 
   # The version of webgen.
-  VERSION = '1.0.0.beta3'
+  VERSION = '1.0.0'
 
 end

data/lib/webgen/website.rb

@@ -109,8 +109,8 @@ module Webgen
       @ext = OpenStruct.new
 
       @init_block.call(self, true) if @init_block && @init_block.arity == 2
-      load_bundles
-      load_configuration
+      loader = load_bundles
+      load_configuration(loader)
       if @init_block
         @init_block.arity == 1 ? @init_block.call(self) : @init_block.call(self, false)
       end
@@ -132,6 +132,7 @@ module Webgen
       ext_loader.load_autoload_bundles
       Dir[File.join(ext_dir, '**/init.rb')].sort.each {|file| ext_loader.load(file[ext_dir.length..-1])}
       ext_loader.load('init.rb') if File.file?(File.join(ext_dir, 'init.rb'))
+      ext_loader
     end
     private :load_bundles
 
@@ -139,17 +140,16 @@ module Webgen
     CONFIG_FILENAME = 'webgen.config'
 
     # Load the configuration file into the Configuration object.
-    def load_configuration
+    #
+    # If it is a Ruby configuration file, the given bundle loader is used to load it.
+    def load_configuration(bundle_loader)
       config_file = File.join(@directory, CONFIG_FILENAME)
       return unless File.exist?(config_file)
 
       first_line = File.open(config_file, 'r') {|f| f.gets}
-      if first_line =~ /^\s*#.*\bruby\b/
-        o = Object.new
-        o.instance_variable_set(:@website, self)
-        def o.website; @website; end
+      if first_line =~ /^\s*#.*\bruby\b/i
         begin
-          o.instance_eval(File.read(config_file), config_file)
+          bundle_loader.load!(config_file)
         rescue Exception => e
           raise Webgen::Error.new("Couldn't load webgen configuration file (using Ruby syntax):\n#{e.message}")
         end
@@ -166,7 +166,7 @@ module Webgen
     # Restore the cache using the +website.cache+ configuration option.
     def restore_cache
       @cache = Cache.new
-      data = if config['website.cache'].first == :file
+      data = if config['website.cache'].first == 'file'
                File.binread(cache_file) if File.file?(cache_file)
              else
                config['website.cache'].last
@@ -180,7 +180,7 @@ module Webgen
     def save_cache
       return if config['website.dry_run']
       cache_data = [@cache.dump, Webgen::VERSION]
-      if config['website.cache'].first == :file
+      if config['website.cache'].first == 'file'
         File.open(cache_file(true), 'wb') {|f| Marshal.dump(cache_data, f)}
       else
         config['website.cache'][1] = Marshal.dump(cache_data)

data/man/man1/webgen.1

@@ -1,4 +1,4 @@
-.TH "WEBGEN" 1 "July 2008"
+.TH "WEBGEN" 1 "September 2013"
 .SH NAME
 webgen \- a fast, powerful and extensible static website generator
 .SH SYNOPSIS
@@ -18,6 +18,21 @@ automatically be generated.
 .B \-d, \-\-directory DIR
 Set the website directectory. if none specified, the current directory is used.
 .TP
+.B \-s, \-\-search-dirs
+Search the parent directories for a directory with a webgen configuration file and use this as
+website directory.
+.TP
+.B \-c, \-\-color
+Use ANSI colors for the output.
+.TP
+.B \-n, \-\-dry-run
+Simulate the website generation. Does everything as it would be done without the option but nothing
+gets written to the destination directory.
+.TP
+.B \-o, \-\-option CONFIG_OPTION
+Specify a simple configuration option. The argument must be of the form KEY=VALUE where the VALUE is
+a valid YAML type.
+.TP
 .B \-v, \-\-verbose
 Show more output by default.
 .TP
@@ -25,40 +40,55 @@ Show more output by default.
 Show less output by default. If this option is specified, then no output is shown during rendering
 of a website.
 .TP
-.B \-l, \-\-log-level LEVEL
-Set the logging level to LEVEL which can be a number between 0 (debug output) and 3 (only error
-output).
+.B \-\-debug
+Enable debugging (shows much more output).
 .TP
 .B \-h, \-\-help
 Show generic help.
 .TP
-.B \-\-version
+.B \-V, \-\-version
 Show the version of the program and exit.
 .SH COMMANDS
+Commands are used to execute different actions (e.g. creating a website directory, generating the
+website, showing help, ...). The command names can be shortened as long as the used name is
+unambiguous. For example, the command "show deps" can also be executed by specifying "s d".
+.TP
+\fBcreate bundle\fR
+Creates a new extension bundle either as a standalone extension or inside the website extension directory.
 .TP
-\fBapply\fR
-Applies a website bundle to an existing website. The \fIbundle\fR argument may either be the name of
-a bundle shipped with webgen or an URL to a (gzipped) tar archive bundle.
+\fBcreate website\fR
+Creates the basic directories and files for webgen. This includes the source and destination
+directories as well as the extension directory. Takes the \fIdirectory\fR in which to create the
+webgen structure as an argument.
 .TP
-\fBcreate\fR
-Creates the basic directories and files for webgen.  This includes the source and
-output directories as well as an empty extensions directory.  Also, a basic template plus a CSS and
-an index file are created.  Takes the \fIdirectory\fR to create the webgen structure in as an
-argument.
+\fBgenerate\fR
+Generates the website. This command will be executed if no command is explicitly specified.
 .TP
 \fBhelp\fR
-Provides help for the individual commands.
+Provides help for individual commands.
+.TP
+\fBinstall\fR
+Installs an extension bundle. The name of the extension bundle is needed as argument.
+.TP
+\fBshow bundles\fR
+Shows all available bundles and additional information them.
+.TP
+\fBshow config\fR
+Shows all available configuration options. Command options can be used to additionally show default
+values and/or current values.
+.TP
+\fBshow deps\fR
+Shows dependencies of nodes. After webgen generates the website (see generate) information about the
+generated website is stored in cache files and this command reads this information to show the
+dependencies of nodes.
 .TP
-\fBrender\fR
-Runs webgen which will result in the generation of the HTML data in the output
-directory from the files in the source directory.  This command is used as the default command when
-no command was issued.
+\fBshow extensions\fR
+Shows all available extensions.
 .TP
-\fBversion\fR
-Shows the version of the program and exit.
+\fBshow tree\fR
+Shows the node tree. Command options can be used to customize the output.
 .TP
-\fBwebgui\fR
-Starts the webgen webgui, a browser based graphical user interface for manging webgen websites.
+\fBversion\fR Shows the version of the program and exit.
 .SH ENVIRONMENT VARIABLES
 webgen's behaviour is affected by the following environment variables:
 .TP
@@ -66,12 +96,13 @@ webgen's behaviour is affected by the following environment variables:
 If no website is specified via the \-d option and this variable is set, webgen assumes that its
 content is the webgen website directory that should be used.
 .SH SEE ALSO
-The webgen website, http://webgen.rubyforge.org/ for more information.
+The webgen website, http://webgen.rubyforge.org/ for detailed information.
 .SH AUTHOR
 webgen was written by Thomas Leitner <t_leitner@gmx.at>
 .PP
 This manual page was written by Paul van Tilburg <paulvt@debian.org> for the Debian project (but may
 be used by others).  This manual page was update to reflect webgen 0.4 change by Arnaud Cornet
 <arnaud.cornet@gmail.com>.  This manual page was updated to reflect webgen 0.5.x changes by Thomas
+Leitner <t_leitner@gmx.at>.  This manual page was updated to reflect webgen 1.x changes by Thomas
 Leitner <t_leitner@gmx.at>.
 

data/test/test_documentation.rb

@@ -6,11 +6,11 @@ require 'tmpdir'
 require 'yaml'
 require 'set'
 
-class TestExtensionDocumentation < MiniTest::Unit::TestCase
+class TestExtensionDocumentation < Minitest::Test
 
   def test_all_extensions_documented
     ws = Webgen::Website.new(File.join(Dir.tmpdir, '/abcdefgh'))
-    documentation = YAML::load(File.read(ws.ext.bundles['built-in']))['extensions']
+    documentation = ws.ext.bundle_infos.extensions.dup
     author = "Thomas Leitner <t_leitner@gmx.at>"
     docu_keys = Set.new(documentation.keys)
     ext_keys = Set.new(ws.ext.instance_eval { @table.keys })
@@ -24,12 +24,16 @@ class TestExtensionDocumentation < MiniTest::Unit::TestCase
 
     ext_keys.each do |key|
       check_docu.call(key.to_s)
+      if ws.ext.send(key).kind_of?(OpenStruct)
+        ws.ext.send(key).instance_eval {@table.keys}.each do |s_key|
+          check_docu.call("#{key}.#{s_key}")
+        end
+      end
 
       if ws.ext.send(key).respond_to?(:registered_extensions)
         ws.ext.send(key).registered_extensions.keys.each do |skey|
           skey = "#{key}.#{skey}"
-          skey = "tag.meta_info" if skey == "tag.default"
-          next if %w[tag.r].include?(skey)
+          next if %w[tag.r tag.default].include?(skey)
 
           check_docu.call(skey)
         end
@@ -40,4 +44,23 @@ class TestExtensionDocumentation < MiniTest::Unit::TestCase
     assert(documentation.empty?, "Superfluous documentation keys: #{documentation.keys.join(", ")}")
   end
 
+  def test_all_config_options_documented
+    ws = Webgen::Website.new(File.join(Dir.tmpdir, '/abcdefgh'))
+    documentation = ws.ext.bundle_infos.options.dup
+    docu_keys = Set.new(documentation.keys)
+
+    check_docu = lambda do |key|
+      data = documentation.delete(key.to_s)
+      assert(data, "Missing options documentation for '#{key}'")
+      assert(!data['summary'].to_s.empty?, "Missing summary for option '#{key}'")
+      assert(!data['syntax'].to_s.empty?, "Missing syntax for option '#{key}'")
+      assert(data['example'].kind_of?(Hash) && data['example'].length > 0, "Missing example for option '#{key}'")
+    end
+
+    ws.config.options.each do |key, value|
+      check_docu.call(key.to_s)
+    end
+    assert(documentation.empty?, "Superfluous option documentation keys: #{documentation.keys.join(", ")}")
+  end
+
 end

data/test/webgen/cli/test_logger.rb

@@ -3,7 +3,7 @@
 require 'minitest/autorun'
 require 'webgen/cli/logger'
 
-class TestLogger < MiniTest::Unit::TestCase
+class TestLogger < Minitest::Test
 
   def test_initialize
     l = Webgen::CLI::Logger.new

data/test/webgen/content_processor/test_blocks.rb

@@ -4,7 +4,7 @@ require 'webgen/test_helper'
 require 'webgen/content_processor/blocks'
 require 'webgen/context'
 
-class TestBlocks < MiniTest::Unit::TestCase
+class TestBlocks < Minitest::Test
 
   include Webgen::TestHelper
 

data/test/webgen/content_processor/test_builder.rb

@@ -1,13 +1,14 @@
 # -*- encoding: utf-8 -*-
 
 require 'webgen/test_helper'
-require 'webgen/content_processor/builder'
 
-class TestBuilder < MiniTest::Unit::TestCase
+class TestBuilder < Minitest::Test
 
   include Webgen::TestHelper
 
   def test_static_call
+    require 'webgen/content_processor/builder' rescue skip('Library builder not installed')
+
     setup_context
     cp = Webgen::ContentProcessor::Builder
 

data/test/webgen/content_processor/test_erb.rb

@@ -3,7 +3,7 @@
 require 'webgen/test_helper'
 require 'webgen/content_processor/erb'
 
-class TestErb < MiniTest::Unit::TestCase
+class TestErb < Minitest::Test
 
   include Webgen::TestHelper
 

data/test/webgen/content_processor/test_erubis.rb

@@ -1,13 +1,13 @@
 # -*- encoding: utf-8 -*-
 
 require 'webgen/test_helper'
-require 'webgen/content_processor/erubis'
 
-class TestErubis < MiniTest::Unit::TestCase
+class TestErubis < Minitest::Test
 
   include Webgen::TestHelper
 
   def test_static_call
+    require 'webgen/content_processor/erubis' rescue skip('Library erubis not installed')
     setup_context
     @website.config.merge!('content_processor.erubis.options' => {}, 'content_processor.erubis.use_pi' => false)
     cp = Webgen::ContentProcessor::Erubis

data/test/webgen/content_processor/test_fragments.rb

@@ -4,7 +4,7 @@ require 'webgen/test_helper'
 require 'webgen/content_processor/fragments'
 require 'yaml'
 
-class TestContentProcessorFragments < MiniTest::Unit::TestCase
+class TestContentProcessorFragments < Minitest::Test
 
   include Webgen::TestHelper
 

data/test/webgen/content_processor/test_haml.rb

@@ -1,13 +1,13 @@
 # -*- encoding: utf-8 -*-
 
 require 'webgen/test_helper'
-require 'webgen/content_processor/haml'
 
-class TestHaml < MiniTest::Unit::TestCase
+class TestHaml < Minitest::Test
 
   include Webgen::TestHelper
 
   def test_static_call
+    require 'webgen/content_processor/haml' rescue skip('Library haml not installed')
     setup_context
     cp = Webgen::ContentProcessor::Haml
 

data/test/webgen/content_processor/test_html_head.rb

@@ -3,7 +3,7 @@
 require 'webgen/test_helper'
 require 'webgen/content_processor/html_head'
 
-class TestHtmlHead < MiniTest::Unit::TestCase
+class TestHtmlHead < Minitest::Test
 
   include Webgen::TestHelper
 
@@ -42,6 +42,10 @@ class TestHtmlHead < MiniTest::Unit::TestCase
                  "\n<style type=\"text/css\">/*<![CDATA[/*/\nanotherstyle\n/*]]>*/</style>" +
                  "\n<meta name=\"lucky\" content=\"me&lt;&quot;\" />" +
                  "\n<meta name=\"other\" content=\"me\" />", @obj.tags_from_context_data(context))
+
+    context.persistent[:cp_html_head] = nil
+    assert_equal("\n<meta name=\"other\" content=\"me\" />", @obj.tags_from_context_data(context))
+
   end
 
   def test_links_to_translations

data/test/webgen/content_processor/test_kramdown.rb

@@ -1,13 +1,13 @@
 # -*- encoding: utf-8 -*-
 
 require 'webgen/test_helper'
-require 'webgen/content_processor/kramdown'
 
-class TestContentProcessorKramdown < MiniTest::Unit::TestCase
+class TestContentProcessorKramdown < Minitest::Test
 
   include Webgen::TestHelper
 
   def test_static_call
+    require 'webgen/content_processor/kramdown' rescue skip('Library kramdown not installed')
     setup_context
     cp = Webgen::ContentProcessor::Kramdown
     root = Webgen::Node.new(@website.tree.dummy_root, '/', '/')

data/test/webgen/content_processor/test_maruku.rb

@@ -1,13 +1,13 @@
 # -*- encoding: utf-8 -*-
 
 require 'webgen/test_helper'
-require 'webgen/content_processor/maruku'
 
-class TestMaruku < MiniTest::Unit::TestCase
+class TestMaruku < Minitest::Test
 
   include Webgen::TestHelper
 
   def setup
+    require 'webgen/content_processor/maruku' rescue skip('Library maruku not installed')
     setup_context
     @cp = Webgen::ContentProcessor::Maruku
   end

data/test/webgen/content_processor/test_r_discount.rb

@@ -1,13 +1,13 @@
 # -*- encoding: utf-8 -*-
 
 require 'webgen/test_helper'
-require 'webgen/content_processor/r_discount'
 
-class TestRDiscount < MiniTest::Unit::TestCase
+class TestRDiscount < Minitest::Test
 
   include Webgen::TestHelper
 
   def test_static_call
+    require 'webgen/content_processor/r_discount' rescue skip('Library rdiscount not installed')
     setup_context
     cp = Webgen::ContentProcessor::RDiscount
 

data/test/webgen/content_processor/test_r_doc.rb

@@ -3,7 +3,7 @@
 require 'webgen/test_helper'
 require 'webgen/content_processor/r_doc'
 
-class TestRDoc < MiniTest::Unit::TestCase
+class TestRDoc < Minitest::Test
 
   include Webgen::TestHelper
 

data/test/webgen/content_processor/test_rainpress.rb

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+require 'webgen/test_helper'
+require 'webgen/content_processor/rainpress'
+
+class TestContentProcessorRainpress < Minitest::Test
+
+  include Webgen::TestHelper
+
+  def test_static_call
+    setup_context
+    @website.config['content_processor.rainpress.options'] = {}
+    cp = Webgen::ContentProcessor::Rainpress
+
+    @context.content = "a   \n{    border: 1px   solid   bold\n}"
+    assert_equal("a{border:1px solid bold}", cp.call(@context).content)
+  end
+
+end

data/test/webgen/content_processor/test_red_cloth.rb

@@ -1,13 +1,13 @@
 # -*- encoding: utf-8 -*-
 
 require 'webgen/test_helper'
-require 'webgen/content_processor/red_cloth'
 
-class TestRedCloth < MiniTest::Unit::TestCase
+class TestRedCloth < Minitest::Test
 
   include Webgen::TestHelper
 
   def test_static_call
+    require 'webgen/content_processor/red_cloth' rescue skip('Library RedCloth not installed')
     setup_context
     @website.config['content_processor.redcloth.hard_breaks'] = false
     cp = Webgen::ContentProcessor::RedCloth