nanoc3 3.0.9 → 3.1.0a1

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

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module Nanoc3::Extra::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::Extra::EnumerableExtensions::GroupBy
+  end
+end

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

@@ -2,12 +2,12 @@
 
 module Nanoc3::Extra::TimeExtensions
 
-  # Returns a string with the time in an ISO-8601 date format.
+  # @return [String] The time in an ISO-8601 date format.
   def to_iso8601_date
     self.strftime("%Y-%m-%d")
   end
 
-  # Returns a string with the time in an ISO-8601 time format.
+  # @return [String] The time in an ISO-8601 time format.
   def to_iso8601_time
     self.gmtime.strftime("%Y-%m-%dT%H:%M:%SZ")
   end

data/lib/nanoc3/extra/core_ext.rb

@@ -1,3 +1,4 @@
 # encoding: utf-8
 
+require 'nanoc3/extra/core_ext/enumerable'
 require 'nanoc3/extra/core_ext/time'

data/lib/nanoc3/extra/deployers/rsync.rb

@@ -5,8 +5,54 @@ module Nanoc3::Extra::Deployers
   # Nanoc3::Extra::Deployers::Rsync is a deployer that deploys a site using rsync.
   class Rsync
 
-    # Creates a new deployment task that uses rsync. The deployment
-    # configuration will be taken from the site's configuration file.
+    DEFAULT_OPTIONS = [
+      '-glpPrtvz',
+      '--exclude=".hg"',
+      '--exclude=".svn"',
+      '--exclude=".git"'
+    ]
+
+    # Creates a new deployer that uses rsync. The deployment configurations
+    # will be read from the configuration file of the site (which is assumed
+    # to be the current working directory).
+    #
+    # The deployment configurations are stored like this in the site's
+    # configuration file:
+    #
+    #     deploy:
+    #       NAME:
+    #         options: [ OPTIONS ]
+    #         dst:     "DST"
+    #
+    # +NAME+ is a unique name for the deployment configuration. By default,
+    # the deployer will use the deployment configuration named "default".
+    #
+    # +OPTIONS+ is an array containing options to pass to the rsync
+    # executable. This is not required; by default, +-glpPrtvz+ and
+    # +--exclude+s for +.svn+, +.hg+ and +.git+ are used.
+    #
+    # +DST+ is a string containing the destination to where rsync should
+    # upload its data. It will likely be in +host:path+ format. For example,
+    # "example.com:/var/www/sites/mysite/html". It should not end with a
+    # trailing slash.
+    #
+    # Example: This deployment configuration defines a "default" and a
+    # "staging" deployment configuration. The default options are used.
+    #
+    #     deploy:
+    #       default:
+    #         dst: "ectype:sites/stoneship/public"
+    #       staging:
+    #         dst: "ectype:sites/stoneship-staging/public"
+    #         options: [ "-glpPrtvz" ]
+    #
+    # When running the deployer with the "default" resp. "staging"
+    # configurations, the following rsync commands will be executed:
+    #
+    #     rsync -glpPrtvz --exclude=".hg" --exclude=".svn"
+    #       --exclude=".git" output ectype:sites/stoneship/public
+    #
+    #     rsync -glpPrtvz output ectype:sites/stoneship-staging/public
     def initialize
       # Get site
       error 'No site configuration found' unless File.file?('config.yaml')
@@ -32,7 +78,7 @@ module Nanoc3::Extra::Deployers
       # Set arguments
       src = File.expand_path(@site.config[:output_dir]) + '/'
       dst = @site.config[:deploy][config_name][:dst]
-      options = @site.config[:deploy][config_name][:options] || []
+      options = @site.config[:deploy][config_name][:options] || DEFAULT_OPTIONS
 
       # Validate arguments
       error 'No dst found in deployment configuration' if dst.nil?

data/lib/nanoc3/extra/file_proxy.rb

@@ -12,6 +12,8 @@ module Nanoc3::Extra
 
     instance_methods.each { |m| undef_method m unless m =~ /^__/ || m.to_s == 'object_id' }
 
+    @@deprecation_warning_shown = false
+
     # Creates a new file proxy for the given path. This is similar to
     # creating a File object with the same path, except that the File object
     # will not be created until it is accessed.
@@ -29,6 +31,11 @@ module Nanoc3::Extra
     # be created right before the method call takes place and destroyed
     # right after.
     def method_missing(sym, *args, &block)
+      if !@@deprecation_warning_shown
+        $stderr.puts 'WARNING: The :file attribute is deprecated and will be removed in a future version of nanoc. Instead of using this :file attribute, consider manually creating a File object when it’s needed, using the :content_filename or :meta_filename attributes (for filesystem_verbose and filesystem_compact) or :filename (for filesystem_combined).'
+        @@deprecation_warning_shown = true
+      end
+
       File.open(@path, 'r') { |io| io.__send__(sym, *args, &block) }
     end
 

data/lib/nanoc3/extra/vcs.rb

@@ -2,33 +2,24 @@
 
 module Nanoc3::Extra
 
-  # Nanoc3::Extra::VCS is a very simple representation of a version control
-  # system that abstracts the add, remove and move operations. It does not
-  # commit. This class is primarily used by data sources that store data as
-  # flat files on the disk.
+  # A very simple representation of a version control system (VCS) that
+  # abstracts the add, remove and move operations. It does not commit. This
+  # class is primarily used by data sources that store data as flat files on
+  # the disk.
   #
-  # This is the abstract superclass for all VCSes. Subclasses should implement
-  # the indicated methods. 
-  class VCS < Nanoc3::Plugin
+  # @abstract Subclass and override {#add}, {#remove} and {#move} to implement
+  #   a custom VCS.
+  class VCS
 
-    # Sets the identifiers for this VCS.
-    def self.identifiers(*identifiers)
-      Nanoc3::Extra::VCS.register(self, *identifiers)
-    end
-
-    # Sets the identifier for this VCS.
-    def self.identifier(identifier)
-      Nanoc3::Extra::VCS.register(self, identifier)
-    end
-
-    # Registers the given class as a VCS with the given identifier.
-    def self.register(class_or_name, *identifiers)
-      Nanoc3::Plugin.register(Nanoc3::Extra::VCS, class_or_name, *identifiers)
-    end
+    extend Nanoc3::PluginRegistry::PluginMethods
 
     # Adds the file with the given filename to the working copy.
     #
-    # Subclasses must implement this method.
+    # @param [String] filename The name of the file to add
+    #
+    # @return [void]
+    #
+    # @abstract
     def add(filename)
       not_implemented('add')
     end
@@ -37,7 +28,11 @@ module Nanoc3::Extra
     # this method is executed, the file should no longer be present on the
     # disk.
     #
-    # Subclasses must implement this method.
+    # @param [String] filename The name of the file to remove
+    #
+    # @return [void]
+    #
+    # @abstract
     def remove(filename)
       not_implemented('remove')
     end
@@ -46,7 +41,13 @@ module Nanoc3::Extra
     # method is executed, the original file should no longer be present on the
     # disk.
     #
-    # Subclasses must implement this method.
+    # @param [String] src The old filename
+    #
+    # @param [String] dst The new filename
+    #
+    # @return [void]
+    #
+    # @abstract
     def move(src, dst)
       not_implemented('move')
     end

data/lib/nanoc3/extra/vcses/bazaar.rb

@@ -2,16 +2,20 @@
 
 module Nanoc3::Extra::VCSes
 
+  # @see Nanoc3::Extra::VCS
   class Bazaar < Nanoc3::Extra::VCS
 
+    # @see Nanoc3::Extra::VCS#add
     def add(filename)
       system('bzr', 'add', filename)
     end
 
+    # @see Nanoc3::Extra::VCS#remove
     def remove(filename)
       system('bzr', 'rm', filename)
     end
 
+    # @see Nanoc3::Extra::VCS#move
     def move(src, dst)
       system('bzr', 'mv', src, dst)
     end

data/lib/nanoc3/extra/vcses/dummy.rb

@@ -2,15 +2,19 @@
 
 module Nanoc3::Extra::VCSes
 
+  # @see Nanoc3::Extra::VCS
   class Dummy < Nanoc3::Extra::VCS
 
+    # @see Nanoc3::Extra::VCS#add
     def add(filename)
     end
 
+    # @see Nanoc3::Extra::VCS#remove
     def remove(filename)
       FileUtils.rm_rf(filename)
     end
 
+    # @see Nanoc3::Extra::VCS#move
     def move(src, dst)
       FileUtils.move(src, dst)
     end

data/lib/nanoc3/extra/vcses/git.rb

@@ -2,16 +2,20 @@
 
 module Nanoc3::Extra::VCSes
 
+  # @see Nanoc3::Extra::VCS
   class Git < Nanoc3::Extra::VCS
 
+    # @see Nanoc3::Extra::VCS#add
     def add(filename)
       system('git', 'add', filename)
     end
 
+    # @see Nanoc3::Extra::VCS#remove
     def remove(filename)
       system('git', 'rm', filename)
     end
 
+    # @see Nanoc3::Extra::VCS#move
     def move(src, dst)
       system('git', 'mv', src, dst)
     end

data/lib/nanoc3/extra/vcses/mercurial.rb

@@ -2,16 +2,20 @@
 
 module Nanoc3::Extra::VCSes
 
+  # @see Nanoc3::Extra::VCS
   class Mercurial < Nanoc3::Extra::VCS
 
+    # @see Nanoc3::Extra::VCS#add
     def add(filename)
       system('hg', 'add', filename)
     end
 
+    # @see Nanoc3::Extra::VCS#remove
     def remove(filename)
       system('hg', 'rm', filename)
     end
 
+    # @see Nanoc3::Extra::VCS#move
     def move(src, dst)
       system('hg', 'mv', src, dst)
     end

data/lib/nanoc3/extra/vcses/subversion.rb

@@ -2,16 +2,20 @@
 
 module Nanoc3::Extra::VCSes
 
+  # @see Nanoc3::Extra::VCS
   class Subversion < Nanoc3::Extra::VCS
 
+    # @see Nanoc3::Extra::VCS#add
     def add(filename)
       system('svn', 'add', filename)
     end
 
+    # @see Nanoc3::Extra::VCS#remove
     def remove(filename)
       system('svn', 'rm', filename)
     end
 
+    # @see Nanoc3::Extra::VCS#move
     def move(src, dst)
       system('svn', 'mv', src, dst)
     end

data/lib/nanoc3/extra.rb

@@ -4,11 +4,14 @@ module Nanoc3::Extra
 
   autoload 'AutoCompiler',      'nanoc3/extra/auto_compiler'
   autoload 'CHiCk',             'nanoc3/extra/chick'
-  autoload 'Context',           'nanoc3/extra/context'
   autoload 'Deployers',         'nanoc3/extra/deployers'
   autoload 'FileProxy',         'nanoc3/extra/file_proxy'
   autoload 'Validators',        'nanoc3/extra/validators'
 
+  # Deprecated; use {Nanoc3::Context} instead
+  # TODO [in nanoc 4.0] remove me
+  Context = ::Nanoc3::Context
+
 end
 
 require 'nanoc3/extra/core_ext'

data/lib/nanoc3/filters/erb.rb

@@ -7,7 +7,7 @@ module Nanoc3::Filters
       require 'erb'
 
       # Create context
-      context = ::Nanoc3::Extra::Context.new(assigns)
+      context = ::Nanoc3::Context.new(assigns)
 
       # Get result
       erb = ::ERB.new(content)

data/lib/nanoc3/filters/erubis.rb

@@ -7,7 +7,7 @@ module Nanoc3::Filters
       require 'erubis'
 
       # Create context
-      context = ::Nanoc3::Extra::Context.new(assigns)
+      context = ::Nanoc3::Context.new(assigns)
 
       # Get result
       ::Erubis::Eruby.new(content, :filename => filename).result(context.get_binding { assigns[:content] })

data/lib/nanoc3/filters/haml.rb

@@ -10,7 +10,7 @@ module Nanoc3::Filters
       options = params.merge(:filename => filename)
 
       # Create context
-      context = ::Nanoc3::Extra::Context.new(assigns)
+      context = ::Nanoc3::Context.new(assigns)
 
       # Get result
       ::Haml::Engine.new(content, options).render(context, assigns) { assigns[:content] }

data/lib/nanoc3/filters/kramdown.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class Kramdown < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'kramdown'
+
+      # Get result
+      ::Kramdown::Document.new(content, params).to_html
+    end
+
+  end
+end

data/lib/nanoc3/filters/maruku.rb

@@ -7,7 +7,7 @@ module Nanoc3::Filters
       require 'maruku'
 
       # Get result
-      ::Maruku.new(content).to_html
+      ::Maruku.new(content, params).to_html
     end
 
   end

data/lib/nanoc3/filters/rainpress.rb

@@ -6,7 +6,7 @@ module Nanoc3::Filters
     def run(content, params={})
       require 'rainpress'
 
-      ::Rainpress.compress(content)
+      ::Rainpress.compress(content, params)
     end
 
   end

data/lib/nanoc3/filters/rdiscount.rb

@@ -6,7 +6,9 @@ module Nanoc3::Filters
     def run(content, params={})
       require 'rdiscount'
 
-      ::RDiscount.new(content).to_html
+      extensions = params[:extensions] || []
+
+      ::RDiscount.new(content, *extensions).to_html
     end
 
   end

data/lib/nanoc3/filters.rb

@@ -7,6 +7,7 @@ module Nanoc3::Filters
   autoload 'ERB',             'nanoc3/filters/erb'
   autoload 'Erubis',          'nanoc3/filters/erubis'
   autoload 'Haml',            'nanoc3/filters/haml'
+  autoload 'Kramdown',        'nanoc3/filters/kramdown'
   autoload 'Less',            'nanoc3/filters/less'
   autoload 'Markaby',         'nanoc3/filters/markaby'
   autoload 'Maruku',          'nanoc3/filters/maruku'
@@ -23,6 +24,7 @@ module Nanoc3::Filters
   Nanoc3::Filter.register '::Nanoc3::Filters::ERB',             :erb
   Nanoc3::Filter.register '::Nanoc3::Filters::Erubis',          :erubis
   Nanoc3::Filter.register '::Nanoc3::Filters::Haml',            :haml
+  Nanoc3::Filter.register '::Nanoc3::Filters::Kramdown',        :kramdown
   Nanoc3::Filter.register '::Nanoc3::Filters::Less',            :less
   Nanoc3::Filter.register '::Nanoc3::Filters::Markaby',         :markaby
   Nanoc3::Filter.register '::Nanoc3::Filters::Maruku',          :maruku