nanoc3 3.1.0a1 → 3.1.0a2

data/NEWS.md

@@ -14,6 +14,7 @@ New:
 * A plugin-loading system
 * A diff between the previously compiled content and the last compiled content
   is now written to `output.diff`
+* Assigns, such as `@items`, `@layouts`, `@item`, … are accessible without `@`
 
 Changed:
 

data/README.md

@@ -2,54 +2,50 @@
 
 nanoc is a simple but very flexible static site generator written in Ruby.
 It operates on local files, and therefore does not run on the server. nanoc
-"compiles" the local source files into HTML (usually), by evaluating eRuby,
+“compiles” the local source files into HTML (usually), by evaluating eRuby,
 Markdown, etc.
 
-## Documentation
+## Resources
 
-The [nanoc3 web site](http://nanoc.stoneship.org) contains a few useful
+The [nanoc web site](http://nanoc.stoneship.org) contains a few useful
 resources to help you get started with nanoc:
 
 * The [tutorial](http://nanoc.stoneship.org/tutorial)
 * The [manual](http://nanoc.stoneship.org/manual)
 * The [migration guide](http://nanoc.stoneship.org/migrating)
 
-It is probably also worth checking out and perhaps subscribing to the
-discussion groups:
+If you need assistance, the following places will help you out:
 
-* The [discussion group in English](http://groups.google.com/group/nanoc)
-* The [discussion group in Spanish](http://groups.google.com/group/nanoc-es)
+* The [discussion group](http://groups.google.com/group/nanoc)
+* The [IRC channel](irc://chat.freenode.net/#nanoc)
 
-### Source Code Documentation
+## Source Code Documentation
 
-The source code is structured in a few directories:
+The source code is located in `lib/nanoc3` and is structured in a few
+directories:
 
-* `bin` contains the commandline tool aptly named `nanoc3`
-* `lib`
-  * `nanoc3`
-    * `base` contains the bare essentials necessary for nanoc to function
-    * `cli` contains the commandline interface
-    * `data_sources` contains the standard data sources (Nanoc3::DataSource
-      subclasses), such as the filesystem data source
-    * `helpers` contains helpers, which provide functionality some sites
-      may find useful, such as the blogging and tagging helpers
-    * `extra` contains stuff that is not needed by nanoc itself, but which may
-      be used by helpers, data sources, filters or VCSes.
-    * `filters` contains the standard filters (Nanoc3::Filter subclasses) such
-      as ERB, Markdown, Haml, ...
-* `test` contains testing code, structured in the same way as lib/nanoc
+* `base` contains the bare essentials necessary for nanoc to function
+* `cli` contains the commandline interface
+* `data_sources` contains the standard data sources ({Nanoc3::DataSource}
+  subclasses), such as the filesystem data source
+* `helpers` contains helpers, which provide functionality some sites
+  may find useful, such as the blogging and tagging helpers
+* `extra` contains stuff that is not needed by nanoc itself, but which may
+  be used by helpers, data sources, filters or VCSes.
+* `filters` contains the standard filters ({Nanoc3::Filter} subclasses)
+  such as ERB, Markdown, Haml, ...
 
 The namespaces (modules) are organised like this:
 
-* `Nanoc3` is the namespace for everything nanoc-related (obviously). The
+* {Nanoc3} is the namespace for everything nanoc-related (obviously). The
   classes in `lib/nanoc3/base` are part of this module (not `Nanoc3::Base`)
-  * `CLI` containing everything related to the commandline tool.
-  * `DataSources` contains the data sources
-  * `Helpers` contains the helpers
-  * `Extra` contains useful stuff not needed by nanoc itself
-  * `Filters` contains the (textual) filters
+* {Nanoc3::CLI} containing everything related to the commandline tool.
+* {Nanoc3::DataSources} contains the data sources
+* {Nanoc3::Helpers} contains the helpers
+* {Nanoc3::Extra} contains useful stuff not needed by nanoc itself
+* {Nanoc3::Filters} contains the (textual) filters
 
-The central class in nanoc is `Nanoc3::Site`, so you should start there if
+The central class in nanoc is {Nanoc3::Site}, so you should start there if
 you want to explore nanoc from a technical perspective.
 
 ## Dependencies
@@ -74,7 +70,7 @@ components, however, do have dependencies:
 * Nicky Peeters
 * Christian Plessl
 * Šime Ramov
-* "Soryu"
+* “Soryu”
 * Eric Sunshine
 * Dennis Sutch
 

data/lib/nanoc3/base/core_ext/array.rb

@@ -2,7 +2,9 @@
 
 module Nanoc3::ArrayExtensions
 
-  # Returns a new array where all items' keys are recursively converted to symbols by calling #symbolize_keys.
+  # Returns a new array where all items' keys are recursively converted to
+  # symbols by calling {Nanoc3::ArrayExtensions#symbolize_keys} or
+  # {Nanoc3::HashExtensions#symbolize_keys}.
   #
   # @return [Array] The converted array
   def symbolize_keys
@@ -11,7 +13,9 @@ module Nanoc3::ArrayExtensions
     end
   end
 
-  # Returns a new array where all items' keys are recursively converted to strings by calling #stringify_keys.
+  # Returns a new array where all items' keys are recursively converted to
+  # strings by calling {Nanoc3::ArrayExtensions#stringify_keys} or
+  # {Nanoc3::HashExtensions#stringify_keys}.
   #
   # @return [Array] The converted array
   def stringify_keys

data/lib/nanoc3/base/core_ext/enumerable.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+module Nanoc3::EnumerableExtensions
+
+  module GroupBy
+
+    # Returns a hash, which keys are evaluated result from the block, and
+    # values are arrays of elements in enum corresponding to the key. This
+    # method is provided for backward compatibility with Ruby 1.8.6 and lower,
+    # since {#group_by} is only available in 1.8.7 and higher.
+    #
+    # @yieldparam [Object] obj The object to classify
+    #
+    # @return [Hash]
+    #
+    # @example Grouping integers by rest by division through 3
+    #
+    #   (1..6).group_by { |i| i % 3 }
+    #   # => { 0 => [3, 6], 1 => [1, 4], 2 => [2, 5] }
+    def group_by
+      groups = {}
+      each do |item|
+        key = yield(item)
+
+        groups[key] ||= []
+        groups[key] << item
+      end
+      groups
+    end
+
+  end
+
+end
+
+module Enumerable
+
+  if !Enumerable.instance_methods.include?('group_by')
+    include Nanoc3::EnumerableExtensions::GroupBy
+  end
+
+end

data/lib/nanoc3/base/core_ext/hash.rb

@@ -2,7 +2,9 @@
 
 module Nanoc3::HashExtensions
 
-  # Returns a new hash where all keys are recursively converted to symbols.
+  # Returns a new hash where all keys are recursively converted to symbols by
+  # calling {Nanoc3::ArrayExtensions#symbolize_keys} or
+  # {Nanoc3::HashExtensions#symbolize_keys}.
   #
   # @return [Hash] The converted hash
   def symbolize_keys
@@ -11,7 +13,9 @@ module Nanoc3::HashExtensions
     end
   end
 
-  # Returns a new hash where all keys are recursively converted to strings.
+  # Returns a new hash where all keys are recursively converted to strings by
+  # calling {Nanoc3::ArrayExtensions#stringify_keys} or
+  # {Nanoc3::HashExtensions#stringify_keys}.
   #
   # @return [Hash] The converted hash
   def stringify_keys

data/lib/nanoc3/base/plugin_registry.rb

@@ -11,6 +11,7 @@ module Nanoc3
     # for setting identifiers, registering plugins and finding plugins. Plugin
     # classes should extend this module.
     module PluginMethods
+
       # Sets the identifiers for this plugin.
       #
       # @param [Array<Symbol>] identifier A list of identifiers to assign to
@@ -40,7 +41,13 @@ module Nanoc3
       #
       # @return [void]
       def register(class_or_name, *identifiers)
-        Nanoc3::Plugin.register(self, class_or_name, *identifiers)
+        # Find plugin class
+        klass = self
+        klass = klass.superclass while klass.superclass.respond_to?(:register)
+
+        # Register
+        registry = Nanoc3::PluginRegistry.instance
+        registry.register(klass, class_or_name, *identifiers)
       end
 
       # Returns the plugin with the given name (identifier)

data/lib/nanoc3/extra/core_ext/enumerable.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 
-module Nanoc3::Extra::EnumerableExtensions
+module Enumerable
 
-  module GroupBy
+  if !Enumerable.instance_methods.include?('group_by')
 
     # Returns a hash, which keys are evaluated result from the block, and
     # values are arrays of elements in enum corresponding to the key. This
@@ -31,9 +31,3 @@ module Nanoc3::Extra::EnumerableExtensions
   end
 
 end
-
-module Enumerable
-  if !Enumerable.instance_methods.include?('group_by')
-    include Nanoc3::Extra::EnumerableExtensions::GroupBy
-  end
-end

data/lib/nanoc3/filters/colorize_syntax.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class ColorizeSyntax < Nanoc3::Filter
+
+    DEFAULT_COLORIZER = :coderay
+
+    def run(content, params={})
+      require 'nokogiri'
+
+      # Take colorizers from parameters
+      @colorizers = Hash.new(DEFAULT_COLORIZER)
+      (params[:colorizers] || {}).each_pair do |language, colorizer|
+        @colorizers[language] = colorizer
+      end
+
+      # Colorize
+      doc = Nokogiri::HTML.fragment(content)
+      doc.css('pre > code[class^="lang"]').each do |element|
+        language = element['class'][/lang-([^ ]+)/].sub(/^lang-/, '')
+        element.parent.replace(
+          Nokogiri.make(highlight(element.inner_text, language, params))
+        )
+      end
+
+      doc.to_s
+    end
+
+  private
+
+    KNOWN_COLORIZERS = [ :coderay, :dummy, :pygmentize ]
+
+    def highlight(code, language, params={})
+      colorizer = @colorizers[language]
+      if KNOWN_COLORIZERS.include?(colorizer)
+        send(colorizer, code, language, params[colorizer])
+      else
+        raise RuntimeError, "I don’t know how to highlight code using the “#{colorizer}” colorizer"
+      end
+    end
+
+    def coderay(code, language, params={})
+      require 'coderay'
+
+      CodeRay.scan(code, language).div(params)
+    end
+
+    def dummy(code, language, params={})
+      code
+    end
+
+    def pygmentize(code, language, params={})
+      IO.popen("pygmentize -l #{language} -f html", "r+") do |io|
+        io.write(code)
+        io.close_write
+        return io.read
+      end
+    end
+
+  end
+end

data/lib/nanoc3/filters.rb

@@ -4,6 +4,7 @@ module Nanoc3::Filters
 
   autoload 'BlueCloth',       'nanoc3/filters/bluecloth'
   autoload 'CodeRay',         'nanoc3/filters/coderay'
+  autoload 'ColorizeSyntax',  'nanoc3/filters/colorize_syntax'
   autoload 'ERB',             'nanoc3/filters/erb'
   autoload 'Erubis',          'nanoc3/filters/erubis'
   autoload 'Haml',            'nanoc3/filters/haml'
@@ -21,6 +22,7 @@ module Nanoc3::Filters
 
   Nanoc3::Filter.register '::Nanoc3::Filters::BlueCloth',       :bluecloth
   Nanoc3::Filter.register '::Nanoc3::Filters::CodeRay',         :coderay
+  Nanoc3::Filter.register '::Nanoc3::Filters::ColorizeSyntax',  :colorize_syntax
   Nanoc3::Filter.register '::Nanoc3::Filters::ERB',             :erb
   Nanoc3::Filter.register '::Nanoc3::Filters::Erubis',          :erubis
   Nanoc3::Filter.register '::Nanoc3::Filters::Haml',            :haml

data/lib/nanoc3.rb

@@ -3,7 +3,7 @@
 module Nanoc3
 
   # The current nanoc version.
-  VERSION = '3.1.0a1'
+  VERSION = '3.1.0a2'
 
   # Loads all nanoc3 plugins, i.e. requires all ruby gems whose name start
   # with `nanoc3-`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nanoc3
 version: !ruby/object:Gem::Version 
-  version: 3.1.0a1
+  version: 3.1.0a2
 platform: ruby
 authors: 
 - Denis Defreyne
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-15 00:00:00 +01:00
+date: 2010-02-20 00:00:00 +01:00
 default_executable: nanoc3
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,7 @@ files:
 - lib/nanoc3/base/compiler_dsl.rb
 - lib/nanoc3/base/context.rb
 - lib/nanoc3/base/core_ext/array.rb
+- lib/nanoc3/base/core_ext/enumerable.rb
 - lib/nanoc3/base/core_ext/hash.rb
 - lib/nanoc3/base/core_ext/string.rb
 - lib/nanoc3/base/core_ext.rb
@@ -104,6 +105,7 @@ files:
 - lib/nanoc3/extra.rb
 - lib/nanoc3/filters/bluecloth.rb
 - lib/nanoc3/filters/coderay.rb
+- lib/nanoc3/filters/colorize_syntax.rb
 - lib/nanoc3/filters/erb.rb
 - lib/nanoc3/filters/erubis.rb
 - lib/nanoc3/filters/haml.rb