webgen 1.0.0.beta3 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc28598716d6dbfc5755161abde547978815a8fb
+  data.tar.gz: 9fcab153b65bfcb25fe189174e292591153944fb
+SHA512:
+  metadata.gz: a8819bc56874a30b1d5c0b63bb7f65a7fe8a104c8c8ed7c2b659db128d600a9ffd66d3e821e476b4c29775596678f83aafaf3025dee52ec715a966184cfbad50
+  data.tar.gz: e0a3b69860bdcf22c5b654f0c37529543acc7137ba5a6d5841c10fc56b10da308160451d38b4b397d22e82710b28da39deec537c7e5109db4207f2045bc33eeb

data/COPYING

@@ -15,9 +15,31 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 
-The webgen distribution contains some data files that have a different
+The webgen distribution contains some files that have a different
 license. These files/directories are listed here:
 
+lib/webgen/vendor/rainpress.rb:
+  Copyright (c) 2007-2008 Uwe L. Korn
+
+  Permission is hereby granted, free of charge, to any person obtaining
+  a copy of this software and associated documentation files (the
+  "Software"), to deal in the Software without restriction, including
+  without limitation the rights to use, copy, modify, merge, publish,
+  distribute, sublicense, and/or sell copies of the Software, and to
+  permit persons to whom the Software is furnished to do so, subject to
+  the following conditions:
+
+  The above copyright notice and this permission notice shall be
+  included in all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 data/webgen/passive_sources/stylesheets/coderay-default.css:
   This file has been generated with the coderay_stylesheet binary and
   falls under the LGPL.

data/Rakefile

@@ -16,9 +16,7 @@ require 'rake/testtask'
 require 'rake/packagetask'
 
 $:.unshift('lib')
-require 'webgen/rake_task'
 require 'webgen/version'
-require 'webgen/page'
 
 # End user tasks ###############################################################
 
@@ -35,32 +33,8 @@ task :clobber do
   ruby "setup.rb clean"
 end
 
-desc "Build the whole user documentation"
-task :doc => [:rdoc, :htmldoc]
-
-desc "Generate the HTML documentation"
-Webgen::RakeTask.new('htmldoc') do |site|
-  site.clobber_outdir = true
-  site.config_block = lambda do |config|
-    config['sources'] = [['/', "Webgen::Source::FileSystem", 'doc'],
-                         ['/', "Webgen::Source::FileSystem", 'misc', 'default.*'],
-                         ['/', "Webgen::Source::FileSystem", 'misc', 'htmldoc.metainfo'],
-                         ['/', "Webgen::Source::FileSystem", 'misc', 'htmldoc.virtual'],
-                         ['/', "Webgen::Source::FileSystem", 'misc', 'images/**/*']]
-    prefix = "webgen-website-bundle-"
-    config['resources'].select {|name, data| name =~ /^#{prefix}style/}.each do |name, data|
-      config['sources'] <<
-        ["/references/website_styles/#{name.sub(prefix, '')}/", "Webgen::Source::FileSystem", 'misc', 'style.page']
-      config['sources'] <<
-        ["/references/website_styles/#{name.sub(prefix, '')}/", 'Webgen::Source::Resource', name, '/src/**', '/src/']
-    end
-    config['output'] = ['Webgen::Output::FileSystem', 'htmldoc']
-    config.default_processing_pipeline('Page' => 'erb,tags,kramdown,blocks,fragments')
-  end
-end
-
 RDoc::Task.new do |rdoc|
-  rdoc.rdoc_dir = 'htmldoc/rdoc'
+  rdoc.rdoc_dir = 'rdoc'
   rdoc.title = 'webgen'
   rdoc.main = 'API.rdoc'
   rdoc.options << '--line-numbers'
@@ -68,7 +42,7 @@ RDoc::Task.new do |rdoc|
 end
 
 Rake::TestTask.new do |test|
-  test.test_files = FileList['test/webgen/**/test_*.rb']
+  test.test_files = FileList['test/**/test_*.rb']
 end
 
 # Release tasks and development tasks ############################################
@@ -83,12 +57,6 @@ dynamic content like menus on the fly and comes with many powerful
 extensions.
 EOF
 
-  begin
-    REL_PAGE = Webgen::Page.from_data(File.read('website/src/news/release_' + Webgen::VERSION.split('.').join('_') + '.page'))
-  rescue
-    puts 'NO RELEASE NOTES/CHANGES FILE'
-  end
-
   PKG_FILES = FileList.new([
                             'Rakefile',
                             'setup.rb',
@@ -101,12 +69,11 @@ EOF
                             'README.md',
                             'bin/webgen',
                             'data/**/*',
-                            'lib/**/*.rb',
+                            'data/**/.gitignore',
+                            'lib/**/*',
                             'man/man1/webgen.1',
                             'test/**/*',
-                           ]) do |fl|
-    fl.exclude('**/.gitignore')
-  end
+                           ])
 
   CLOBBER << "VERSION"
   file 'VERSION' do
@@ -127,14 +94,15 @@ EOF
     s.version = Webgen::VERSION
     s.summary = SUMMARY
     s.description = DESCRIPTION
+    s.license = 'GPL'
     s.post_install_message = <<EOF
 
 Thanks for choosing webgen! Here are some places to get you started:
-* The webgen User Documentation at <http://webgen.rubyforge.org/documentation/index.html>
+* The webgen User Documentation at <http://webgen.rubyforge.org/documentation/>
 * The mailing list archive at <http://rubyforge.org/pipermail/webgen-users/>
 * The webgen Wiki at <http://github.com/gettalong/webgen/wiki>
 
-Have a look at <http://webgen.rubyforge.org/> for a list of changes!
+Have a look at <http://webgen.rubyforge.org/news.html> for a list of changes!
 
 Have fun!
 
@@ -142,12 +110,13 @@ EOF
 
     #### Dependencies, requirements and files
 
-    s.required_ruby_version = '>= 1.9.2'
+    s.required_ruby_version = '>= 1.9.3'
 
     s.add_dependency('cmdparse', '>= 2.0.5')
     s.add_dependency('systemu', '>= 2.5.0')
-    s.add_dependency('kramdown', '>= 0.14.0')
+    s.add_dependency('kramdown', '~> 1.0')
     s.add_development_dependency('rake', '>= 0.8.3')
+    s.add_development_dependency('minitest', '>= 5.0.0')
     s.add_development_dependency('diff-lcs', '>= 1.1.0')
     s.add_development_dependency('rubyforge', '>= 2.0.2')
     s.add_development_dependency('maruku', '>= 0.6.0')
@@ -186,12 +155,7 @@ EOF
   end
 
   desc 'Release webgen version ' + Webgen::VERSION
-  task :release => [:clobber, :package, :publish_files, :publish_doc, :website, :publish_website, :post_news]
-
-  desc "Upload webgen documentation to Rubyforge homepage"
-  task :publish_doc => [:doc] do
-    sh "rsync -avc --delete htmldoc/ gettalong@rubyforge.org:/var/www/gforge-projects/webgen/documentation/#{(Webgen::VERSION.split('.')[0..-2] + ['x']).join('.')}"
-  end
+  task :release => [:clobber, :package, :publish_files, :post_news]
 
   if defined? RubyForge
     desc "Upload the release to Rubyforge"
@@ -203,8 +167,8 @@ EOF
       rf.configure
       rf.login
 
-      rf.userconfig["release_notes"] = REL_PAGE.blocks['notes'].content
-      rf.userconfig["release_changes"] = REL_PAGE.blocks['changes'].content
+      rf.userconfig["release_notes"] = ""
+      rf.userconfig["release_changes"] = ""
       rf.userconfig["preformatted"] = false
 
       files = %w[.gem .tgz .zip].collect {|ext| "pkg/webgen-#{Webgen::VERSION}" + ext}
@@ -224,37 +188,12 @@ EOF
       rf.configure
       rf.login
 
-      rf.post_news('webgen', "webgen #{Webgen::VERSION} released", REL_PAGE.blocks['notes'].content)
+      text = "Have a look at http://webgen.rubyforge.org/news.html for the release details!"
+      rf.post_news('webgen', "webgen #{Webgen::VERSION} released", text)
       puts "done"
     end
   end
 
-  desc 'Generates the webgen website'
-  Webgen::RakeTask.new(:website) do |site|
-    site.directory = 'website'
-    site.clobber_outdir = true
-    site.config_block = lambda do |config|
-      config['sources'] += [['/documentation/', 'Webgen::Source::FileSystem', '../doc'],
-                            ['/', "Webgen::Source::FileSystem", '../misc', 'default.less.css'],
-                            ['/documentation/', "Webgen::Source::FileSystem", '../misc', 'htmldoc.virtual'],
-                            ['/', "Webgen::Source::FileSystem", '../misc', 'images/**/*']]
-      prefix = "webgen-website-bundle-"
-      config['resources'].select {|name, data| name =~ /^#{prefix}style/}.each do |name, data|
-        config['sources'] <<
-          ["/documentation/references/website_styles/#{name.sub(prefix, '')}/", "Webgen::Source::FileSystem", '../misc', 'style.page']
-        config['sources'] <<
-          ["/documentation/references/website_styles/#{name.sub(prefix, '')}/", 'Webgen::Source::Resource', name, '/src/**', '/src/']
-      end
-      config.default_processing_pipeline('Page' => 'erb,tags,kramdown,blocks,fragments')
-    end
-  end
-
-  desc "Upload the webgen website to Rubyforge"
-  task :publish_website => ['rdoc', :website] do
-    sh "rsync -avc --delete --exclude documentation/rdoc --exclude 'documentation/0.5.x' --exclude 'documentation/0.4.x' --exclude 'wiki' --exclude 'robots.txt'  website/out/ gettalong@rubyforge.org:/var/www/gforge-projects/webgen/"
-    sh "rsync -avc --delete htmldoc/rdoc/ gettalong@rubyforge.org:/var/www/gforge-projects/webgen/documentation/rdoc"
-  end
-
 
   desc "Run the tests one by one to check for missing deps"
   task :test_isolated do

data/VERSION

@@ -1 +1 @@
-1.0.0.beta2
+1.0.0

data/data/webgen/basic_website_template/ext/init.rb

@@ -8,7 +8,9 @@
 # directory in which it is!
 #
 # * For information on how to write extensions, have a look at the API
-#   documentation of webgen at http://webgen.rubyforge.org/docs/api.
+#   documentation of webgen at
+#
+#     http://webgen.rubyforge.org/documentation/reference/api/
 #
 # * Have a look at the API documentation of Webgen::BundlerLoader to see
 #   what methods are available in init.rb files.

data/data/webgen/basic_website_template/webgen.config

@@ -12,7 +12,7 @@
 # The available configuration options can be found on the homepage in the Configuration Option
 # Reference at
 #
-#     http://webgen.rubyforge.org/documentation/references/configuration.html
+#     http://webgen.rubyforge.org/documentation/reference/configuration_options.html
 #
 # More info about YAML itself can be found at http://www.yaml.org/
 #####

data/data/webgen/bundle_template_files/info.yaml.erb

@@ -5,8 +5,8 @@ version:
 license: 
 homepage: 
 
-# If extensions are defined, document them here like in the following
-# example (at least the summary key should be set):
+# If extensions or configuration options are defined, document them here
+# like in the following example (at least the summary key should be set):
 #
 # extensions:
 #   content_processor.my_processor:
@@ -14,3 +14,15 @@ homepage:
 #   super_duper:
 #     summary: Provides some very super-duper things!!
 #     author: Some One Else
+#
+# options:
+#   tag.my_processor.option:
+#     summary: Some description of the option here
+#     syntax: Syntax description of this option
+#     example:
+#       config: |
+#         tag.my_processor.option: some_value
+#       tag: |
+#         {my_tag: {option: some_value}}
+#
+# The options:*:example:tag key should only be used for tags!

data/data/webgen/passive_sources/default.metainfo

@@ -35,3 +35,13 @@
 
 [/**/*.sass, /**/*.scss, /**/*.haml, /**/*.rdoc, /**/*.textile, /**/*.tikz]:
   handler: copy
+
+/**/_*.sass:
+  handler: copy
+  pipeline: sass
+  no_output: true
+
+/**/_*.scss:
+  handler: copy
+  pipeline: scss
+  no_output: true

data/data/webgen/passive_sources/templates/api.template

@@ -1,5 +1,19 @@
---- name:content pipeline:erb
-<% klass = context.node.node_info[:api_class_object] %>
+--- name:content pipeline:ruby
+rdoc_object = context.node.node_info[:rdoc_object]
+if rdoc_object.kind_of?(::RDoc::ClassModule)
+  context.content = context.render_block(:name => 'klass', :node => 'current')
+else
+  context.content = context.render_block(:name => 'page', :node => 'current')
+end
+--- name:page pipeline:erb
+<% page = context.node.node_info[:rdoc_object] %>
+<div class="api-documentation api-page">
+  <div class="description">
+    <%= page.description %>
+  </div>
+</div>
+--- name:klass pipeline:erb
+<% klass = context.node.node_info[:rdoc_object] %>
 <div class="api-documentation api-<%= klass.type %>">
   <h1 class="<%= klass.type %>"><%= klass.type %> <%= klass.full_name %></h1>
 

data/data/webgen/passive_sources/templates/feed.template

@@ -9,7 +9,7 @@
   </author>
 
   <link href="<%= context.node.feed_link %>" rel="alternate" />
-  <link href="<%= Webgen::Path.url(File.join(context.node['site_url'], context.node.dest_path), false) %>" rel="self" />
+  <link href="<%= context.node.url %>" rel="self" />
   <generator uri="http://webgen.rubyforge.org/" version="<%= Webgen::VERSION %>">
     webgen - Webgen::PathHandler::Feed
   </generator>
@@ -25,8 +25,8 @@
       <uri><%= h(entry['author_url']) %></uri>
     </author>
     <% end %>
-    <link href="<%= Webgen::Path.url(File.join(context.node['site_url'], entry.dest_path), false) %>" rel="alternate" />
-    <id><%= Webgen::Path.url(File.join(context.node['site_url'], entry.dest_path), false) %></id>
+    <link href="<%= entry.url %>" rel="alternate" />
+    <id><%= entry.url %></id>
     <updated><%= entry['modified_at'].xmlschema %></updated>
     <% if entry['created_at'].kind_of?(Time) %>
     <published><%= entry['created_at'].xmlschema %></published>
@@ -55,10 +55,10 @@
     <% context.node.feed_entries.flatten.each do |entry| %>
     <item>
       <title><%= h(entry['title']) %></title>
-      <link><%= Webgen::Path.url(File.join(context.node['site_url'], entry.dest_path), false) %></link>
+      <link><%= entry.url %></link>
       <description><%= h(context.node.entry_content(entry)) %></description>
       <pubDate><%= entry['modified_at'].rfc822 %></pubDate>
-      <guid isPermaLink="true"><%= Webgen::Path.url(File.join(context.node['site_url'], entry.dest_path), false) %></guid>
+      <guid isPermaLink="true"><%= entry.url %></guid>
     </item>
     <% end %>
 

data/data/webgen/passive_sources/templates/sitemap.template

@@ -5,7 +5,7 @@
 context.node.sitemap_entries.each do |item|
 %>
   <url>
-    <loc><%= URI.escape(File.join(context.node['site_url'], item.dest_path)) %></loc>
+    <loc><%= URI.escape(item.url) %></loc>
     <lastmod><%= item['modified_at'].iso8601 %></lastmod>
     <changefreq><%= item['change_freq'] || context.node['default_change_freq'] %></changefreq>
     <% if priority = item['priority'] || context.node['default_priority'] %>

data/data/webgen/passive_sources/templates/tag.template

@@ -13,11 +13,15 @@ end.join(context[:config]['tag.breadcrumb_trail.separator'])
 
 
 --- name:tag.menu pipeline:ruby --------------------------------------------------------------------
+start_tag = "<ul"
+start_tag << " class=\"#{context[:config]['tag.menu.css_class']}\"" if context[:config]['tag.menu.css_class']
+start_tag << ">"
+
 nested_list = lambda do |nodes, level|
-  out = "<ul>"
+  out = (level == 1 ? start_tag.dup : "<ul>")
   nodes.each do |node, children|
     menu = (children ? nested_list.call(children, level + 1) : '')
-    style, link = Webgen::Tag::Menu.menu_item_details(context.dest_node, node, context.content_node.lang, level, !children.nil?)
+    style, link = Webgen::Tag::Menu.menu_item_details(context.dest_node, node, context.content_node.lang, level, !children.nil?, context[:config])
     out << "<li #{style}>#{link}"
     out << menu
     out << "</li>"
@@ -28,10 +32,10 @@ end
 
 flat_list = lambda do |nodes, level|
   submenu = ''
-  out = "<ul>"
+  out = (level == 1 ? start_tag.dup : "<ul>")
   nodes.each do |node, children|
     submenu << (children ? flat_list.call(children, level + 1) : '')
-    style, link = Webgen::Tag::Menu.menu_item_details(context.dest_node, node, context.content_node.lang, level, !children.nil?)
+    style, link = Webgen::Tag::Menu.menu_item_details(context.dest_node, node, context.content_node.lang, level, !children.nil?, context[:config])
     out << "<li #{style}>#{link}</li>"
   end
   out << "</ul>" << submenu

data/lib/webgen/blackboard.rb

@@ -13,16 +13,32 @@ module Webgen
       @listener = {}
     end
 
-    # Add the given block as listener for the messages +msg_names+ (one message name or an array of
-    # message names). If you want to be able to remove the block from being called by the blackboard
-    # later, you have to provide a unique ID object!
-    def add_listener(msg_names = nil, id = nil, &block)
+    # Add the given block as listener for the message +msg_name+.
+    #
+    # The +id+ parameter can be used to specify a string which uniquely identifies the listener.
+    #
+    # The +position+ parameter can be used to specify where the listener should be added. The keys
+    # :before and :after are recognized and must contain a valid listener ID. If no key is or an
+    # unknown ID is specified, the listener is added as last entry in the listener array.
+    def add_listener(msg_name, id = nil, position = {}, &block)
+      position = if position[:before]
+                   (@listener[msg_name] || []).index {|id, obj| id == position[:before]}
+                 elsif position[:after]
+                   (pos = (@listener[msg_name] || []).index {|id, obj| id == position[:after]}) && pos + 1
+                 end
+      insert_listener_at_position(msg_name, id, position || -1, &block)
+    end
+
+    # Insert the block as listener for +msg_name+ with the given +id+ at the +position+ in the
+    # listener array.
+    def insert_listener_at_position(msg_name, id, position, &block)
       if !block.nil?
-        [msg_names].flatten.compact.each {|name| (@listener[name] ||= []) << [id, block]}
+        (@listener[msg_name] ||= []).insert(position, [id, block])
       else
         raise ArgumentError, "You have to provide a block"
       end
     end
+    private :insert_listener_at_position
 
     # Remove the blocks associated with the given ID from the dispatcher queues of the given message
     # names.

data/lib/webgen/bundle/built-in-show-changes/info.yaml

@@ -0,0 +1,17 @@
+author: &author Thomas Leitner <t_leitner@gmx.at>
+summary: Built-in webgen extension for showing destination path changes
+description: |
+  This is an extension bundle that comes with webgen. It provides a means for
+  showing the changes that would be written to a destination path.
+
+options:
+  destination.show_changes:
+    summary: |
+      Specifies whether changes to the content of destination paths should be shown in a diff-like
+      manner. This option combined with the website.dry_run configuration option allows one to
+      preview the changes that the invocation of webgen would do.
+    syntax: |
+      `true` or `false`
+    example:
+      config: |
+        destination.show_changes: true

data/lib/webgen/bundle/built-in-show-changes/init.rb

@@ -2,15 +2,14 @@
 #
 # This file initializes the show-changes built-in extension.
 
-option('destination.show_changes', false,
-       'Show changes to destination paths') do |val|
+option('destination.show_changes', false) do |val|
   raise "The value has to be 'true' or 'false'" unless val == true || val == false
   val
 end
 
 data = nil
 
-website.blackboard.add_listener(:before_node_written) do |node|
+website.blackboard.add_listener(:before_node_written, 'destination.show_changes') do |node|
   next unless website.config['destination.show_changes'] && node.is_file? && !node['no_output']
   webgen_require('diff/lcs', 'diff-lcs')
   webgen_require('diff/lcs/hunk', 'diff-lcs')
@@ -21,13 +20,13 @@ website.blackboard.add_listener(:before_node_written) do |node|
   end
 end
 
-website.blackboard.add_listener(:after_node_written) do |node, content|
+website.blackboard.add_listener(:after_node_written, 'destination.show_changes') do |node, content|
   next unless website.config['destination.show_changes'] && node.is_file? && !node['no_output']
   if data.nil?
     website.logger.info { "New destination path <#{node.dest_path}>" }
     next
   end
-  new_data = (content.kind_of?(String) ? content : content.data)
+  new_data = (content.kind_of?(String) ? content : content.data).force_encoding('ASCII-8BIT')
 
   binary = data[0...4096]["\0"] || new_data[0..4096]["\0"]
   if binary