webgen 0.5.17 → 1.0.0.beta1

data/README.md

@@ -0,0 +1,71 @@
+# webgen - static website generation made easy
+
+webgen is used for generating static websites from templates and content
+files (which can be written in any markup language). It can generate
+dynamic content like menus on the fly and comes with many powerful
+extensions.
+
+
+## Contact & Help
+
+The author of webgen is Thomas Leitner -- he is reachable at <mailto:t_leitner@gmx.at>.
+
+You can discuss webgen or find help on the [webgen-users] mailing list
+which is mirrored to the [webgen-users Google group].
+
+Or you can join the IRC channel [#webgen] on Freenode.
+
+[webgen-users]: http://rubyforge.org/pipermail/webgen-users/
+[webgen-users Google group]: https://groups.google.com/forum/?fromgroups#!forum/webgen-users
+[#webgen]: irc://chat.freenode.net/#webgen
+
+
+## Description
+
+webgen is a free (GPL-licensed) command line application for generating
+static websites. It combines content with template files to generate
+HTML files. This allows one to separate the content from the layout and
+reuse the layout for many content files.
+
+Apart from this basic functionality, webgen offers many features that
+makes authoring websites easier:
+
+* Multiple markup languages to choose from for writing HTML and CSS
+  files (Markdown, Textile, RDoc, Haml, Sass ...)
+
+* Automatic generation of menus, breadcrumb trails, ... and more!
+
+* Partial website regeneration (only modified items get re-generated)
+  which reduces website generation time enormously
+
+* Self-contained website (all generated links are relative, so one can
+  view the website *without a web server*)
+
+* Easily extendable (all major components can be extended with new
+  functionality)
+
+* No need to know the Ruby language for basic websites
+
+The main documentation lives at <http://webgen.rubyforge.org/documentation/>.
+
+
+## Installation
+
+webgen is written in Ruby, so you need the Ruby interpreter on your
+system. You can get it from http://ruby-lang.org/. See
+<http://webgen.rubyforge.org/installation.html> for more information.
+
+You can install webgen via Rubygems:
+
+    $ gem install webgen
+
+Or via the `setup.rb` method if you have downloaded a tarball or zip file:
+
+    $ ruby setup.rb config
+    $ ruby setup.rb setup
+    $ ruby setup.rb install
+
+
+## License
+
+GPLv3 - see the **COPYING** file.

data/Rakefile

@@ -1,12 +1,7 @@
-# -*- ruby -*-
+# -*- encoding: utf-8 -*- -*- ruby -*-
 
 # load all optional developer libraries
-begin
-  require 'rubygems'
-  require 'rake/gempackagetask'
-rescue LoadError
-end
-
+require 'rubygems/package_task'
 require 'rdoc/task'
 require 'rdoc/rdoc'
 
@@ -15,22 +10,17 @@ begin
 rescue LoadError
 end
 
-begin
-  require 'rcov/rcovtask'
-rescue LoadError
-end
-
 require 'fileutils'
 require 'rake/clean'
 require 'rake/testtask'
 require 'rake/packagetask'
 
 $:.unshift('lib')
-require 'webgen/webgentask'
+require 'webgen/rake_task'
 require 'webgen/version'
 require 'webgen/page'
 
-# End user tasks ################################################################
+# End user tasks ###############################################################
 
 task :default => :test
 
@@ -49,7 +39,7 @@ desc "Build the whole user documentation"
 task :doc => [:rdoc, :htmldoc]
 
 desc "Generate the HTML documentation"
-Webgen::WebgenTask.new('htmldoc') do |site|
+Webgen::RakeTask.new('htmldoc') do |site|
   site.clobber_outdir = true
   site.config_block = lambda do |config|
     config['sources'] = [['/', "Webgen::Source::FileSystem", 'doc'],
@@ -60,25 +50,25 @@ Webgen::WebgenTask.new('htmldoc') do |site|
     prefix = "webgen-website-bundle-"
     config['resources'].select {|name, data| name =~ /^#{prefix}style/}.each do |name, data|
       config['sources'] <<
-        ["/website_styles/#{name.sub(prefix, '')}/", "Webgen::Source::FileSystem", 'misc', 'style.page']
+        ["/references/website_styles/#{name.sub(prefix, '')}/", "Webgen::Source::FileSystem", 'misc', 'style.page']
       config['sources'] <<
-        ["/website_styles/#{name.sub(prefix, '')}/", 'Webgen::Source::Resource', name, '/src/**', '/src/']
+        ["/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
 
-rd = RDoc::Task.new do |rdoc|
+RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'htmldoc/rdoc'
   rdoc.title = 'webgen'
-  rdoc.main = 'lib/webgen/website.rb'
+  rdoc.main = 'API.rdoc'
   rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('lib')
+  rdoc.rdoc_files.include('lib', 'API.rdoc')
 end
 
-tt = Rake::TestTask.new do |test|
-  test.libs << 'test'
+Rake::TestTask.new do |test|
+  test.test_files = FileList['test/webgen/**/test_*.rb']
 end
 
 # Release tasks and development tasks ############################################
@@ -108,16 +98,15 @@ EOF
                             'THANKS',
                             'COPYING',
                             'GPL',
+                            'API.rdoc',
+                            'README.md',
                             'bin/webgen',
                             'data/**/*',
-                            'doc/**/*',
                             'lib/**/*.rb',
                             'man/man1/webgen.1',
-                            'misc/**/*',
-                            'test/test_*.rb',
-                            'test/helper.rb',
+                            'test/**/*',
                            ]) do |fl|
-    fl.exclude('data/**/.gitignore')
+    fl.exclude('**/.gitignore')
   end
 
   CLOBBER << "VERSION"
@@ -138,69 +127,69 @@ EOF
     pkg.package_files = PKG_FILES
   end
 
-  if defined? Gem
-    spec = Gem::Specification.new do |s|
+  spec = Gem::Specification.new do |s|
 
-      #### Basic information
-      s.name = 'webgen'
-      s.version = Webgen::VERSION
-      s.summary = SUMMARY
-      s.description = DESCRIPTION
-      s.post_install_message = <<EOF
+    #### Basic information
+    s.name = 'webgen'
+    s.version = Webgen::VERSION
+    s.summary = SUMMARY
+    s.description = DESCRIPTION
+    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 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/news/index.html> for a list of changes!
+Have a look at <http://webgen.rubyforge.org/> for a list of changes!
 
 Have fun!
 
 EOF
 
-      #### Dependencies, requirements and files
-
-      s.files = PKG_FILES.to_a
-      s.add_dependency('cmdparse', '>= 2.0.2')
-      s.add_dependency('kramdown', '>= 0.12.0')
-      s.add_development_dependency('maruku', '>= 0.6.0')
-      s.add_development_dependency('rake', '>= 0.8.3')
-      s.add_development_dependency('ramaze', '>= 2009.04')
-      s.add_development_dependency('launchy', '>= 0.3.2')
-      s.add_development_dependency('rcov', '>= 0.8.1.2.0')
-      s.add_development_dependency('rubyforge', '>= 2.0.2')
-      s.add_development_dependency('RedCloth', '>= 4.1.9')
-      s.add_development_dependency('haml', '>= 3.0.12')
-      s.add_development_dependency('builder', '>= 2.1.0')
-      s.add_development_dependency('rdoc', '>= 2.4.3')
-      s.add_development_dependency('coderay', '>= 0.8.312')
-      s.add_development_dependency('erubis', '>= 2.6.5')
-      s.add_development_dependency('rdiscount', '>= 1.3.5')
-      s.add_development_dependency('archive-tar-minitar', '>= 0.5.2')
-
-      s.require_path = 'lib'
-
-      s.executables = ['webgen']
-      s.default_executable = 'webgen'
-
-      #### Documentation
-
-      s.has_rdoc = true
-      s.rdoc_options = ['--line-numbers', '--main', 'lib/webgen/website.rb']
-
-      #### Author and project details
-
-      s.author = 'Thomas Leitner'
-      s.email = 't_leitner@gmx.at'
-      s.homepage = "http://webgen.rubyforge.org"
-      s.rubyforge_project = 'webgen'
-    end
-
-    Rake::GemPackageTask.new(spec) do |pkg|
-      pkg.need_zip = true
-      pkg.need_tar = true
-    end
+    #### Dependencies, requirements and files
+
+    s.required_ruby_version = '>= 1.9.2'
+
+    s.add_dependency('cmdparse', '>= 2.0.5')
+    s.add_dependency('systemu', '>= 2.5.0')
+    s.add_dependency('kramdown', '>= 0.14.0')
+    s.add_development_dependency('rake', '>= 0.8.3')
+    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')
+    s.add_development_dependency('RedCloth', '>= 4.1.9')
+    s.add_development_dependency('haml', '>= 3.1.0')
+    s.add_development_dependency('sass', '>= 3.2.0')
+    s.add_development_dependency('builder', '>= 2.1.0')
+    s.add_development_dependency('rdoc', '>= 3.0')
+    s.add_development_dependency('coderay', '>= 1.0.0')
+    s.add_development_dependency('erubis', '>= 2.6.5')
+    s.add_development_dependency('rdiscount', '>= 1.3.5')
+    s.add_development_dependency('archive-tar-minitar', '>= 0.5.2')
+
+    s.files = PKG_FILES.to_a
+    s.require_path = 'lib'
+    s.executables = ['webgen']
+    s.default_executable = 'webgen'
+
+    #### Documentation
+
+    s.has_rdoc = true
+    s.rdoc_options = ['--line-numbers', '--main', 'API.rdoc']
+    s.extra_rdoc_files = ['API.rdoc']
+
+    #### Author and project details
+
+    s.author = 'Thomas Leitner'
+    s.email = 't_leitner@gmx.at'
+    s.homepage = "http://webgen.rubyforge.org"
+    s.rubyforge_project = 'webgen'
+  end
 
+  Gem::PackageTask.new(spec) do |pkg|
+    pkg.need_zip = true
+    pkg.need_tar = true
   end
 
   desc 'Release webgen version ' + Webgen::VERSION
@@ -248,20 +237,20 @@ EOF
   end
 
   desc 'Generates the webgen website'
-  Webgen::WebgenTask.new(:website) do |site|
+  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.css'],
+                            ['/', "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/website_styles/#{name.sub(prefix, '')}/", "Webgen::Source::FileSystem", '../misc', 'style.page']
+          ["/documentation/references/website_styles/#{name.sub(prefix, '')}/", "Webgen::Source::FileSystem", '../misc', 'style.page']
         config['sources'] <<
-          ["/documentation/website_styles/#{name.sub(prefix, '')}/", 'Webgen::Source::Resource', name, '/src/**', '/src/']
+          ["/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
@@ -276,31 +265,29 @@ EOF
 
   desc "Run the tests one by one to check for missing deps"
   task :test_isolated do
-    files = Dir['test/test_*']
+    files = Dir['test/webgen/**/test_*']
     puts "Checking #{files.length} tests"
     failed = files.select do |file|
-      okay = system("ruby -Ilib:test #{file} -vs &> /dev/null")
+      okay = system("ruby -Ilib #{file} 2>&1 >/dev/null")
       print(okay ? '.' : 'E')
       !okay
     end
     puts
-    failed.each {|file| puts "Problem with" + file.rjust(40) }
+    failed.each {|file| puts "Problem with" + file.rjust(60) }
   end
 
-  if defined? Rcov
-    Rcov::RcovTask.new do |rcov|
-      rcov.libs << 'test'
-    end
-  end
-
-  EXCLUDED_FOR_TESTS=FileList.new(['lib/webgen/cli{*,**/*}', 'lib/webgen/version.rb',
-                                   'lib/webgen/output.rb', 'lib/webgen/source.rb',
-                                   'lib/webgen/tag.rb', 'lib/webgen/default_config.rb',
-                                   'lib/webgen/common.rb'
+  EXCLUDED_FOR_TESTS=FileList.new(['lib/webgen/bundle/**/*',
+                                   'lib/webgen/context/*',
+                                   'lib/webgen/cli/*',
+                                   'lib/webgen/test_helper',
+                                   'lib/webgen/path_handler/directory.rb',
+                                   'lib/webgen/version.rb',
                                   ])
 
-  EXCLUDED_FOR_DOCU=FileList.new(['lib/webgen/cli{*,**/*}', 'lib/webgen/contentprocessor/context.rb',
-                                  'lib/webgen/*/base.rb', 'lib/webgen/sourcehandler/fragment.rb',
+  EXCLUDED_FOR_DOCU=FileList.new(['lib/webgen/cli{*,**/*}',
+                                  'lib/webgen/*/base.rb',
+                                  'lib/webgen/context/*',
+                                  'lib/webgen/context.rb'
                                  ])
 
   desc "Checks for missing test/docu"
@@ -308,10 +295,10 @@ EOF
     puts 'Files for which no test exists:'
     Dir['lib/webgen/**/*'].each do |path|
       next if File.directory?(path) || EXCLUDED_FOR_TESTS.include?(path)
-      test_path = 'test/test_' + path.gsub(/lib\/webgen\//, "").tr('/', '_')
+      test_path = 'test/' + path.gsub(/lib\/(.*)\/(.*).rb/, '\1/test_\2.rb')
       puts ' '*4 + path unless File.exists?(test_path)
     end
-
+=begin
     puts
     puts 'Files for which no docu exists:'
     Dir['lib/webgen/*/*'].each do |path|
@@ -319,6 +306,7 @@ EOF
       docu_path = 'doc/' + path.gsub(/lib\/webgen\//, "").gsub(/\.rb$/, '.page')
       puts ' '*4 + path unless File.exists?(docu_path)
     end
+=end
   end
 
 end

data/VERSION

@@ -1 +1 @@
-0.5.17
+1.0.0.beta1

data/bin/webgen

@@ -2,10 +2,4 @@
 # -*- encoding: utf-8 -*-
 
 require 'webgen/cli'
-begin
-  Webgen::CLI::CommandParser.new.parse
-rescue
-  puts "An error has occurred:\n  " + $!.message
-  puts $!.backtrace if $DEBUG
-  exit(-1)
-end
+Webgen::CLI::CommandParser.new.parse

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

@@ -0,0 +1,15 @@
+# = webgen extensions directory
+#
+# All init.rb files anywhere under this directory are automatically
+# loaded. This allows you to add your own extensions to webgen or to
+# modify webgen's core.
+#
+# If you don't need this feature you can savely delete this file and the
+# 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.
+#
+# * 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

@@ -0,0 +1,18 @@
+#####
+# This is a webgen configuration file which uses YAML as its syntax.
+#
+# The general syntax is:
+#
+#   configuration.option.name: value
+#
+# Have a look at the documentation of the individual configuration options to see the allowed format
+# of the values. Since this is a YAML file, you can easily set configuration options as strings,
+# integers, dates, arrays, hashes and more.
+#
+# The available configuration options can be found on the homepage in the Configuration Option
+# Reference at
+#
+#     http://webgen.rubyforge.org/documentation/references/configuration.html
+#
+# More info about YAML itself can be found at http://www.yaml.org/
+#####

data/data/webgen/bundle_template_files/README.md.erb

@@ -0,0 +1,24 @@
+# webgen extension bundle <%= bundle_name %>
+
+TODO: describe the bundle here
+
+
+# Installation
+
+The easiest way to install this extension bundle is by installing the
+corresponding Rubygem:
+
+    gem install webgen-<%= bundle_name %>-bundle
+
+If you don't use Rubygems, copy the folder
+`lib/webgen/bundle/<%= bundle_name %>` into your `ext` directory.
+
+After that you just need to tell webgen to use this extension bundle by
+adding the following line to your `ext/init.rb` file:
+
+    load("<%= bundle_name %>")
+
+
+# Copyright and license
+
+TODO: state copyright and used license here