hx 0.16.0 → 0.17.0

data/README.rdoc

@@ -4,7 +4,22 @@ A miniature web site generator; a spiritual successor to Hobix.
 
 == History
 
-== The Concept
+== Concepts
+
+=== Filters
+
+=== Require and Autoload
+
+Hx supports a very limited sort of autoload; when a filter class name
+is provided in a configuration file, and that class doesn't already
+exist, Hx will try to require a corresponding library.  The name of that
+library will be derived from the class name; for example, if
+Hx::Backend::RawFiles is missing, Hx will try to require
+<code>hx/backend/rawfiles</code>.
+
+Beyond this, you can also manually require additional libraries
+at load time by listing them in the <code>require</code> section in
+the configuration file.
 
 == Tutorial
 
@@ -17,6 +32,92 @@ A miniature web site generator; a spiritual successor to Hobix.
      options:
        entry_dir: static
 
+=== A Site With Entries and Indexes
+
+ options:
+   output_dir: site
+ sources:
+   entries:
+     - filter: Hx::Backend::Hobix
+       options:
+         entry_dir: entries
+     - sort_by: updated
+   indices:
+     input: entries
+     filter: Hx::Listing::RecursiveIndex
+ output:
+   - input: indices
+     filter: Hx::Output::LiquidTemplate
+     options:
+       extension: html
+       template: section
+   - input: entries
+     filter: Hx::Output::LiquidTemplate
+     options:
+       extension: html
+       template: entry
+   - filter: Hx::Backend::RawFiles
+     options:
+       entry_dir: static
+
+=== A Site with Date-Based Archives and an Atom Feed
+
+ options:
+   output_dir: site
+   template_dir: templates
+ sources:
+   entries:
+     - filter: Hx::Backend::Hobix
+       options:
+         entry_dir: entries
+     - sort_by: updated
+   indices:
+     input: entries
+     filter: Hx::Listing::RecursiveIndex
+   archives:
+     input: entries
+     filter: Hx::Listing::DateArchive
+     sort_by: id
+ output:
+   - input: indices
+     only: index
+     filter: Hx::Output::LiquidTemplate
+     options:
+       extension: html
+       template: front
+   - input: indices
+     except: index
+     filter: Hx::Output::LiquidTemplate
+     options:
+       extension: html
+       template: section
+   - input: entries
+     filter: Hx::Output::LiquidTemplate
+     options:
+       extension: html
+       template: entry
+   - input: archives
+     only: */index
+     filter: Hx::Output::LiquidTemplate
+     options:
+       extension: html
+       template: year 
+   - input: archives 
+     only: */*/index
+     filter: Hx::Output::LiquidTemplate
+     options:
+       extension: html
+       template: month
+   - input: indices
+     only: index
+     filter: Hx::Output::LiquidTemplate
+     options:
+       extension: atom
+       template: feed
+   - filter: Hx::Backend::RawFiles
+     options:
+       entry_dir: static
+
 == Copyright
 
 Copyright (c) 2009-2011 MenTaLguY. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.16.0
+0.17.0

data/lib/hx.rb

@@ -1,6 +1,6 @@
 # hx - A very small website generator.
 #
-# Copyright (c) 2009-2010 MenTaLguY <mental@rydia.net>
+# Copyright (c) 2009-2011 MenTaLguY <mental@rydia.net>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -332,6 +332,42 @@ class Sort
   end
 end
 
+class IncludeFragments
+  include Hx::Filter
+
+  def initialize(input, options)
+    @input = input
+    @fragments = options[:fragments] || {}
+    @fragment_paths = Set.new(@fragments.values)
+  end
+
+  def edit_entry(path, prototype)
+    raise EditingNotSupported, path if @fragment_paths.include? path
+    @input.edit_entry(path, prototype) { |text| yield text }
+    self
+  end
+
+  def each_entry_path(selector)
+    @input.each_entry_path(selector) do |path|
+      yield path unless @fragment_paths.include? path
+    end
+    self
+  end
+
+  def get_entry(path)
+    raise NoSuchEntryError, path if @fragment_paths.include? path
+    entry = @input.get_entry(path)
+    entry = entry.dup
+    for field, fragment_path in @fragments
+      begin
+        entry[field] = @input.get_entry(path)
+      rescue NoSuchEntryError
+      end
+    end
+    entry
+  end
+end
+
 Chain = Object.new
 def Chain.new(input, options)
   filters = options[:chain] || []
@@ -437,6 +473,11 @@ def self.build_source(options, default_input, sources, raw_source)
     source = Overlay.new(*input_sources)
   end
 
+  if raw_source.has_key? 'fragments'
+    source = IncludeFragments.new(source,
+                                  :fragments => raw_source['fragments'])
+  end
+
   if raw_source.has_key? 'filter'
     if raw_source.has_key? 'options'
       filter_options = options.dup

data/lib/hx/listing.rb

@@ -0,0 +1,41 @@
+# hx/listing - Common listing utilities
+#
+# Copyright (c) 2009-2010 MenTaLguY <mental@rydia.net>
+# 
+# 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.
+
+require 'hx/listing/limit'
+require 'hx/listing/paginate'
+
+module Hx
+module Listing
+
+def self.apply_options(listing, options)
+  if options.has_key? :limit
+    listing = Limit.new(listing, :limit => options[:limit])
+  end
+  if options.has_key? :page_size
+    listing = Paginate.new(listing, :page_size => options[:page_size])
+  end
+  listing
+end
+
+end
+end

data/lib/hx/listing/datearchive.rb

@@ -0,0 +1,71 @@
+# hx/listing/datearchive - Date-based archive generator
+#
+# Copyright (c) 2011 MenTaLguY <mental@rydia.net>
+# 
+# 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.
+
+require 'hx'
+require 'hx/listing'
+
+module Hx
+module Listing
+
+class DateArchive
+  include Hx::Filter
+
+  def self.new(input, options)
+    listing = super(input, options)
+    Listing.apply_options(listing, options)
+  end
+
+  def initialize(input, options)
+    @input = input
+    @date_fields = Array(options[:date_fields] || %w(created updated))
+    @index_name = options[:index_name] || "index"
+  end
+
+  def each_entry(selector)
+    indices = {}
+    @input.each_entry_path(Path::ALL) do |path, entry|
+      date = @date_fields.map { |field| entry[field] }.compact.first
+      next unless date
+      month_path = "%04d/%02d/#{@index_name}" % [date.year, date.month]
+      year_path = "%04d/#{@index_name}" % [date.year]
+      for index_path in [month_path, year_path]
+        next unless selector.accept_path? index_path
+        index_entry = indices[index_path]
+        unless index_entry
+          index_entry = {"items" => [], "year" => date.year, "updated" => date}
+          index_entry["month"] = date.month if index_path == month_path
+          indices[index_path] = index_entry
+        end
+        index_entry["updated"] = date if date > index_entry["updated"]
+        index_entry["items"] << {"path" => path, "entry" => entry}
+      end
+    end
+    indices.each do |index_path, index_entry|
+      yield index_path, index_entry
+    end
+    self
+  end
+end
+
+end
+end

data/lib/hx/listing/flatindex.rb

@@ -0,0 +1,62 @@
+# hx/listing/flatindex - Flat index generator
+#
+# Copyright (c) 2009-2011 MenTaLguY <mental@rydia.net>
+# 
+# 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.
+
+require 'hx'
+require 'hx/listing'
+require 'set'
+
+module Hx
+module Listing
+
+class FlatIndex
+  include Hx::Filter
+
+  def self.new(input, options)
+    listing = super(input, options)
+    Listing.apply_options(listing, options)
+  end
+
+  def initialize(input, options)
+    @input = input
+    @index_name = options[:index_name] || "index"
+  end
+
+  def each_entry_path(selector)
+    yield @index_name if selector.accept_path? @index_name
+    self
+  end
+
+  def get_entry(path)
+    raise NoSuchEntryError, path unless path == @index_name
+    index = {'items' => []}
+    @input.each_entry(Path::ALL) do |path, entry|
+      index['items'] << {'path' => path, 'entry' => entry}
+      updated = [entry['updated'], index['updated']].compact.max
+      index['updated'] = updated if updated
+    end
+    index
+  end
+end
+
+end
+end

data/lib/hx/listing/recursiveindex.rb

@@ -1,6 +1,6 @@
 # hx/listing/recursiveindex - Recursive index generator
 #
-# Copyright (c) 2009-2010 MenTaLguY <mental@rydia.net>
+# Copyright (c) 2009-2011 MenTaLguY <mental@rydia.net>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -22,8 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'hx'
-require 'hx/listing/limit'
-require 'hx/listing/paginate'
+require 'hx/listing'
 require 'set'
 
 module Hx
@@ -34,32 +33,22 @@ class RecursiveIndex
 
   def self.new(input, options)
     listing = super(input, options)
-    if options.has_key? :limit
-      listing = Limit.new(listing, :limit => options[:limit])
-    end
-    if options.has_key? :page_size
-      listing = Paginate.new(listing, :page_size => options[:page_size])
-    end
-    listing
+    Listing.apply_options(listing, options)
   end
 
   def initialize(input, options)
     @input = input
+    @index_name = options[:index_name] || "index"
+    @index_re = %r!^((?:.*/)?)#{Regexp.quote(@index_name)}$!
   end
 
-  def merge_updated(index, entry)
-    updated = [entry, index].map { |e| e['updated'] }.compact.max
-    index['updated'] = updated if updated
-  end
-  private :merge_updated
-
   def each_entry_path(selector)
     emitted = Set.new
-    @input.each_entry_path(Path::ALL) do |path, entry|
+    @input.each_entry_path(Path::ALL) do |path|
       components = path.split("/")
       until components.empty?
         components.pop
-        index_path = (components + ["index"]).join("/")
+        index_path = (components + [@index_name]).join("/")
         break if emitted.include? index_path
         yield index_path if selector.accept_path? index_path
         emitted.add index_path
@@ -69,9 +58,8 @@ class RecursiveIndex
   end
 
   def get_entry(path)
-    raise NoSuchEntryError, path unless path =~ %r!^((?:.*/)?)index$!
-    prefix = $1
-    selector = Path.parse_pattern("#{prefix}**")
+    raise NoSuchEntryError, path unless path =~ @index_re
+    selector = Path.parse_pattern("#{$1}**")
     index = {'items' => []}
     @input.each_entry(selector) do |child_path, entry|
       if child_path == path
@@ -79,7 +67,8 @@ class RecursiveIndex
       else
         index['items'] << {'path' => child_path, 'entry' => entry}
       end
-      merge_updated(index, entry)
+      updated = [entry['updated'], index['updated']].compact.max
+      index['updated'] = updated if updated
     end
     raise NoSuchEntryError, path if index['items'].empty?
     index

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hx
 version: !ruby/object:Gem::Version 
-  hash: 95
+  hash: 91
   prerelease: false
   segments: 
   - 0
-  - 16
+  - 17
   - 0
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors: 
 - MenTaLguY
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-06 00:00:00 -08:00
+date: 2011-03-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,6 +59,9 @@ files:
 - lib/hx/backend/hobix.rb
 - lib/hx/backend/rawfiles.rb
 - lib/hx/cli.rb
+- lib/hx/listing.rb
+- lib/hx/listing/datearchive.rb
+- lib/hx/listing/flatindex.rb
 - lib/hx/listing/limit.rb
 - lib/hx/listing/paginate.rb
 - lib/hx/listing/recursiveindex.rb