webgen 1.0.0.beta1 → 1.0.0.beta2

data/API.rdoc

@@ -62,18 +62,18 @@ Following are links and descriptions on how to develop specific types of extensi
 Here is a list of modules/classes that are used throughout webgen and provide useful methods for
 developing extensions:
 
-* Webgen::Node
-* Webgen::Tree
-* Webgen::Path
-* Webgen::Page
-* Webgen::Cache
-* Webgen::Utils
+* Webgen::Path (represens a source path that will get converted into a Webgen::Node)
+* Webgen::Node (the internal representation of destination paths)
+* Webgen::Tree (the tree structure holding all Webgen::Node objects)
+* Webgen::Page (provides methods for working with files in Webgen Page Format)
+* Webgen::Cache (provides caching functionality for other objects)
+* Webgen::Utils (a collection of useful utilities)
 
 == List of all blackboard messages
 
-The Blackboard (accessible via Webgen::Website#blackboard) provides an easy-to-use facility to be
-notified of certain messages. All registered listeners for a message are notified when the message
-gets dispatched.
+The blackboard (a Webgen::Blackboard object, accessible via Webgen::Website#blackboard) provides an
+easy-to-use facility to be notified of certain messages. All registered listeners for a message are
+notified when the message gets dispatched.
 
 Following is the list of all messages that are dispatched by the webgen core classes and built-in
 extensions:
@@ -86,6 +86,13 @@ extensions:
 
     No parameters are given.
 
+[:apply_meta_info_to_path]
+
+    This message is dispatched before a node from a path is created and can be used to add
+    additional meta information to the path.
+
+    The path in question is given as parameter.
+
 [:before_node_created]
 
     This message is dispatched after the meta information from the configuration option
@@ -95,12 +102,33 @@ extensions:
 
     The path in question is given as parameter.
 
+[:reused_existing_node]
+
+    This message is dispatched when a node that should be created already exists and is therefore
+    not created again (which would lead to an error). An example would be fragment nodes that are
+    created during the rendering.
+
+    The node is given as parameter.
+
 [:after_node_created]
 
-    As the name says this message is dispatched after a node has been created.
+    This message is dispatched after a node has been created.
 
     The node is given as parameter.
 
+[:before_secondary_nodes_created]
+
+    This message is dispatched before secondary nodes are created from a Webgen::Path object.
+
+    The path in question and the node alcn which led to the creation of the path (may be +nil+ if
+    the secondary nodes are not created during rendering) are given as parameters.
+
+[:after_secondary_nodes_created]
+
+    This message is dispatched after secondary nodes have been created from a Webgen::Path object.
+
+    The path in question and the created nodes are given as parameters.
+
 [:after_tree_populated]
 
     This message is dispatched after all initial nodes have been created and the tree has been
@@ -109,6 +137,25 @@ extensions:
 
     No parameters are given.
 
+[:before_all_nodes_written]
+
+    This message is dispatched before any node is written to its destination in a generation pass.
+    Since webgen may need multiple passes to correctly write all nodes, this message may also be
+    dispatched multiple times.
+
+    No parameters are given.
+
+[:before_node_written]
+
+    This message is dispatched after webgen determined that the content of a node has changed but
+    before it is written to its destination. Note that this message is also dispatched for those
+    nodes whose 'no_output' meta information key is set to +true+.
+
+    Also note that this message be may dispatched multiple times for the same node if, after all
+    nodes have been written, it is determined that it has changed again.
+
+    The node in question is given as parameter.
+
 [:after_node_written]
 
     This message is dispatched after a node has been written to its destination. Note that if the
@@ -119,7 +166,7 @@ extensions:
     Also note that this message be may dispatched multiple times for the same node if, after all
     nodes have been written, it is determined that it has changed again.
 
-    The node is given as parameter.
+    The node and its (possibly) rendered content are given as parameters.
 
 [:after_all_nodes_written]
 
@@ -141,3 +188,9 @@ extensions:
     is dispatched, all child nodes have already been deleted.
 
     The node is given as parameter.
+
+[:website_generated]
+
+    This message is dispatched after the website is completely generated.
+
+    No parameters are given.

data/ChangeLog

@@ -1,3 +1,394 @@
+commit 37c15f8afe970bc2f48b987c060e708b08db9900
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Dec 7 21:30:16 2012 +0100
+
+    Updated version number
+
+lib/webgen/version.rb
+
+commit 60172c72359dca3348155e1c98f1f1fed45741bf
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Dec 7 21:30:09 2012 +0100
+
+    Updated Rakefile
+    
+    * Removed unneeded files from packages
+    * Add devel dep diff-lcs
+    * Updated kramdown dep to 0.14.0
+    * Some other some fixes
+
+Rakefile
+
+commit 9a866c1e8d3bf2e4194485141c5f71c9e046df4b
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Thu Dec 6 21:38:54 2012 +0100
+
+    Removed Node#method_missing and refactored dependent code
+    
+    This was more like a hack than a good solution as it allowed
+    invoking arbitrary path handler methods, even things like
+    
+    If a path handler now needs to provide special methods on a
+    created node, it has to create a suitable sub class and
+    provide this sub class as second parameter to
+    PathHandler::Base#create_node.
+
+lib/webgen/bundle/built-in/init.rb
+lib/webgen/node.rb
+lib/webgen/path_handler/base.rb
+lib/webgen/path_handler/feed.rb
+lib/webgen/path_handler/page.rb
+lib/webgen/path_handler/page_utils.rb
+lib/webgen/path_handler/sitemap.rb
+lib/webgen/path_handler/template.rb
+lib/webgen/test_helper.rb
+test/webgen/path_handler/test_base.rb
+test/webgen/path_handler/test_page.rb
+test/webgen/path_handler/test_page_utils.rb
+test/webgen/path_handler/test_template.rb
+test/webgen/test_node.rb
+
+commit cd96ed9c375b6605252bdc023fa3efa27d00c0d7
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Thu Dec 6 17:57:22 2012 +0100
+
+    Sped up ItemTracker cache updating from O(n^2) to O(2n)
+
+lib/webgen/item_tracker.rb
+
+commit 178de203c7298b04b08479ac024c2020d9710ade
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Wed Dec 5 19:44:47 2012 +0100
+
+    Using the PageUtils#blocks method now directly instead of going through Node#method_missing
+
+lib/webgen/path_handler/page_utils.rb
+test/webgen/path_handler/test_page_utils.rb
+
+commit 8a7b0b4ed1679b79598f5533878890ae2a5ee527
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Wed Dec 5 19:41:55 2012 +0100
+
+    Fixed API doc typo
+
+lib/webgen/path_handler/base.rb
+
+commit c95dc3ec82a1b21f8f85304763821d2beb3b93ed
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Dec 3 22:11:28 2012 +0100
+
+    Made BundleLoader more robust against YAML errors
+
+lib/webgen/bundle_loader.rb
+
+commit b8707c9cf4532811eaa615265002f3c4b1fab808
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Dec 3 22:04:16 2012 +0100
+
+    More useful YAML error messages for path handler virtual
+
+lib/webgen/path_handler/virtual.rb
+test/webgen/path_handler/test_virtual.rb
+
+commit 0a195f9f32ccd932827f9bfc453ccb1537533b7d
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Dec 3 20:39:25 2012 +0100
+
+    Added CLI command 'show tree' for showing the node tree
+    
+    This is useful for showing what destination paths would be
+    created and to review the meta information for a node in
+    case something one doesn't get the expected output.
+
+lib/webgen/cli/show_command.rb
+lib/webgen/cli/show_tree_command.rb
+
+commit ca6012104ea8d3278f4ce10cc2274985d84db5b6
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Dec 3 20:03:36 2012 +0100
+
+    Removed unused instance variable
+
+lib/webgen/cli/show_config_command.rb
+
+commit 17b3ac8dd84b3d6a70473a29e047ae988a918fba
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Dec 3 20:03:23 2012 +0100
+
+    Refactored code from the 'show deps' command
+    
+    * Each item tracker extension is now responsible for returning
+      a human readable representation of its items
+    * ItemTracker#cached_items can now be used to get the information
+      about the cached items for each node
+
+lib/webgen/cli/show_dependencies_command.rb
+lib/webgen/item_tracker.rb
+lib/webgen/item_tracker/file.rb
+lib/webgen/item_tracker/missing_node.rb
+lib/webgen/item_tracker/node_content.rb
+lib/webgen/item_tracker/node_meta_info.rb
+lib/webgen/item_tracker/nodes.rb
+
+commit a474102f023d96a2c12f3c43f201bf5b008b3de6
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Mon Dec 3 19:58:32 2012 +0100
+
+    Optimized ItemTracker#node_referenced?
+    
+    Getting all referenced nodes is now done only once per generation
+    pass which shortens the overall time needed for this operation.
+    
+    This also meant changing the #node_referenced? method on item
+    tracker extensions to #referenced_nodes.
+
+lib/webgen/item_tracker.rb
+lib/webgen/item_tracker/file.rb
+lib/webgen/item_tracker/missing_node.rb
+lib/webgen/item_tracker/node_content.rb
+lib/webgen/item_tracker/node_meta_info.rb
+lib/webgen/item_tracker/nodes.rb
+test/webgen/item_tracker/test_file.rb
+test/webgen/item_tracker/test_missing_node.rb
+test/webgen/item_tracker/test_node_content.rb
+test/webgen/item_tracker/test_node_meta_info.rb
+test/webgen/item_tracker/test_nodes.rb
+test/webgen/test_item_tracker.rb
+
+commit a6a283e78abe8eef827dcae5a793d6ebcea931d8
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 2 19:30:36 2012 +0100
+
+    Renamed #changed? to #item_changed? for item tracker extension classes
+
+lib/webgen/item_tracker.rb
+lib/webgen/item_tracker/file.rb
+lib/webgen/item_tracker/missing_node.rb
+lib/webgen/item_tracker/node_content.rb
+lib/webgen/item_tracker/node_meta_info.rb
+lib/webgen/item_tracker/nodes.rb
+test/webgen/item_tracker/test_file.rb
+test/webgen/item_tracker/test_missing_node.rb
+test/webgen/item_tracker/test_node_content.rb
+test/webgen/item_tracker/test_node_meta_info.rb
+test/webgen/item_tracker/test_nodes.rb
+test/webgen/test_item_tracker.rb
+
+commit f37cc3eb345589ee6ad4a4d998edc887c08b53ef
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Dec 2 10:56:37 2012 +0100
+
+    Changed node finder filter :levels to :absolute_levels, introduced new :levels option
+    
+    * :absolute_levels does what :levels did before
+    * :levels can now be used to specify which levels of the returned
+      node hierarchy should be used
+
+lib/webgen/node_finder.rb
+test/webgen/test_node_finder.rb
+
+commit 80fcb9926673f5a374a19900c91f5a5dcec184ed
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sat Dec 1 12:56:58 2012 +0100
+
+    Changed tag name of tag.execute_command and tag.meta_info
+    
+    * tag.execute_command: execute_cmd → execute_command
+    * tag.meta_info: additional name meta_info
+
+lib/webgen/bundle/built-in/info.yaml
+lib/webgen/bundle/built-in/init.rb
+
+commit 0d012e6f13263b4aaf79dfb072177d90c9d11074
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sat Dec 1 12:55:44 2012 +0100
+
+    Meta info 'sort_info' and 'lang' are now only set on Path if needed
+
+lib/webgen/path.rb
+
+commit e3c38c0252dc58aac5395fbf05b75ce52eded61c
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sat Dec 1 12:54:18 2012 +0100
+
+    Added Context::HtmlHead#meta for setting meta tags
+    
+    This information is used in turn by content processor html_head
+    to actually create the meta tags.
+
+lib/webgen/context/html_head.rb
+test/webgen/test_context.rb
+
+commit 7c630cca8fc07dd940bb1061270842fa6ae8a62a
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sat Dec 1 08:47:12 2012 +0100
+
+    Changed :link_text to 'link_text' because symbols don't work nicely together with YAML
+
+data/webgen/passive_sources/templates/tag.template
+lib/webgen/node.rb
+test/webgen/test_node.rb
+
+commit 68daf9ead8ddd99e271a88f5094230742e88b0e4
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Tue Nov 27 19:01:23 2012 +0100
+
+    Changed parameter :config_base to :config_prefix for tag extensions
+
+lib/webgen/tag.rb
+test/webgen/test_tag.rb
+
+commit afb5ae559f8bbbd2cc26cfb47c0a1dd6db9f45bc
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 25 10:14:34 2012 +0100
+
+    Updated content processor tikz
+    
+    * The LaTeX template can now be customized using a new option
+      on a per-file basis.
+    * Better temp file naming
+    * Better error handling
+
+data/webgen/passive_sources/templates/tikz.template
+lib/webgen/bundle/built-in/init.rb
+lib/webgen/content_processor/tikz.rb
+test/webgen/content_processor/test_tikz.rb
+
+commit 3ac9435813b30ba160671557c7509b63762b8d0a
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 25 09:40:24 2012 +0100
+
+    Fixed problem with modified meta info hash
+    
+    The hash needs to be dupped so that checking if a path would
+    create an already existing node works correctly.
+
+lib/webgen/path_handler/base.rb
+
+commit 44c4642826c0151d6d7d5d8ed7c610f3200b24fc
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 25 09:39:07 2012 +0100
+
+    Fixed invocation of PathHandler#create_secondary_nodes after changing its parameter list
+
+lib/webgen/tag/tikz.rb
+test/webgen/tag/test_tikz.rb
+
+commit 927ec3c14ae33da0d3be5c65756ad05c0f5bd62f
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 25 09:37:20 2012 +0100
+
+    Link attributes in Node#link_to are now taken from the proxy node instead of the original one
+
+lib/webgen/node.rb
+test/webgen/tag/test_link.rb
+test/webgen/test_node.rb
+
+commit 6f257a69d1f9c795b60cc58b4cccb9e3f3332f99
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 25 09:10:18 2012 +0100
+
+    ERB::Util methods are now available when using content processor ruby
+
+lib/webgen/content_processor/ruby.rb
+
+commit ee0dc8aa7a7d958528b30095809685344ac384da
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 25 09:09:23 2012 +0100
+
+    Added new option content_processor.erb.trim_mode
+
+lib/webgen/bundle/built-in/init.rb
+lib/webgen/content_processor/erb.rb
+test/webgen/content_processor/test_erb.rb
+
+commit 2e52e6ea268b0872a0be9624ec713abe51103e8c
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 25 09:06:14 2012 +0100
+
+    Fixed summary field of content processor blocks
+
+lib/webgen/bundle/built-in/info.yaml
+
+commit a8a09de364b4979cbfc9eef16750d3bc7b36ee1f
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 25 09:05:39 2012 +0100
+
+    Fixed configuration option summaries so that only single quotation marks are used everywhere
+
+lib/webgen/bundle/built-in/init.rb
+
+commit 4feacaafaf356c8e1dbb7d061453334d8b8072f4
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 25 09:04:18 2012 +0100
+
+    Better error message
+
+lib/webgen/tag.rb
+
+commit 2d64bd13dbc5b837f28eefe8287cae719ccd1ffd
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 25 09:02:24 2012 +0100
+
+    Fixed file names of rdoc and redcloth content processor so that auto loading works
+
+lib/webgen/content_processor/r_doc.rb
+lib/webgen/content_processor/rdoc.rb
+lib/webgen/content_processor/red_cloth.rb
+lib/webgen/content_processor/redcloth.rb
+test/webgen/content_processor/test_r_doc.rb
+test/webgen/content_processor/test_rdoc.rb
+test/webgen/content_processor/test_red_cloth.rb
+test/webgen/content_processor/test_redcloth.rb
+
+commit 773a93adb937bf53deb70edc7a8b2bc203e59d76
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sun Nov 18 11:55:49 2012 +0100
+
+    Fixed relocatable() Sass function
+    
+    * The return value was not correct (it was wrapped with url() and
+      quotes). Now only the path itself is returned and properly marked
+      as Sass string (not Sass literal).
+    
+    * Fixed nil error that occurs when options[:filename] points to a
+      non-existing node.
+
+lib/webgen/content_processor/sass.rb
+test/webgen/content_processor/test_sass.rb
+
+commit 3950509d6346b18be546947d81e65af05f8e3634
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sat Nov 17 09:52:40 2012 +0100
+
+    Small doc fixes
+
+README.md
+
+commit a3bd00871305cfed8bb447c429efaf414eea0412
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Sat Nov 17 09:47:01 2012 +0100
+
+    Updated central API doc page
+    
+    * Added documentation for missing blackboard messages
+    * Some other small enhancements
+
+API.rdoc
+
+commit 97231bec462093b8d4d8d0d50b6bd8bc720f818b
+Author: Thomas Leitner <t_leitner@gmx.at>
+Date:   Fri Nov 16 23:18:12 2012 +0100
+
+    Fixed problem with :missing_node item tracker
+    
+    Due to the changes in the generation algorithm the missing node
+    tracker was broken (because nodes get reused now instead of
+    deleted and recreated)
+
+lib/webgen/item_tracker/missing_node.rb
+lib/webgen/path_handler/base.rb
+
 commit e1db7d82f175692dc5a2210f9df20bd077118526
 Author: Thomas Leitner <t_leitner@gmx.at>
 Date:   Sun Nov 11 09:24:16 2012 +0100