nanoc 4.4.7 → 4.5.0

data/lib/nanoc/deploying/deployers/git.rb

@@ -0,0 +1,118 @@
+module Nanoc::Deploying::Deployers
+  # A deployer that deploys a site using [Git](http://git-scm.com).
+  #
+  # @example A deployment configuration for GitHub Pages:
+  #
+  #   deploy:
+  #     default:
+  #       kind:       git
+  #       remote:     git@github.com:myself/myproject.git
+  #       branch:     gh-pages
+  #       forced:     true
+  #
+  class Git < ::Nanoc::Deploying::Deployer
+    identifier :git
+
+    module Errors
+      class Generic < ::Nanoc::Error
+      end
+
+      class OutputDirDoesNotExist < Generic
+        def initialize(path)
+          super("The directory to deploy, #{path}, does not exist.")
+        end
+      end
+
+      class OutputDirIsNotAGitRepo < Generic
+        def initialize(path)
+          super("The directory to deploy, #{path}, is not a Git repository.")
+        end
+      end
+
+      class RemoteDoesNotExist < Generic
+        def initialize(remote)
+          super("The remote to deploy to, #{remote}, does not exist.")
+        end
+      end
+
+      class BranchDoesNotExist < Generic
+        def initialize(branch)
+          super("The branch to deploy, #{branch}, does not exist.")
+        end
+      end
+    end
+
+    def run
+      unless File.exist?(source_path)
+        raise Errors::OutputDirDoesNotExist.new(source_path)
+      end
+
+      remote = config.fetch(:remote, 'origin')
+      branch = config.fetch(:branch, 'master')
+      forced = config.fetch(:forced, false)
+
+      puts "Deploying via Git to branch “#{branch}” on remote “#{remote}”…"
+
+      Dir.chdir(source_path) do
+        unless File.exist?('.git')
+          raise Errors::OutputDirIsNotAGitRepo.new(source_path)
+        end
+
+        # Verify existence of remote, if remote is not a URL
+        if remote_is_name?(remote)
+          begin
+            run_cmd(%W(git config --get remote.#{remote}.url))
+          rescue Nanoc::Extra::Piper::Error
+            raise Errors::RemoteDoesNotExist.new(remote)
+          end
+        end
+
+        # If the branch exists then switch to it, otherwise prompt the user to create one.
+        begin
+          run_cmd_unless_dry(%W(git checkout #{branch}))
+        rescue Nanoc::Extra::Piper::Error
+          raise Errors::BranchDoesNotExist.new(branch)
+        end
+
+        return if clean_repo?
+
+        msg = "Automated commit at #{Time.now.utc} by Nanoc #{Nanoc::VERSION}"
+        author = 'Nanoc <>'
+        run_cmd_unless_dry(%w(git add -A))
+        run_cmd_unless_dry(%W(git commit -a --author #{author} -m #{msg}))
+
+        if forced
+          run_cmd_unless_dry(%W(git push -f #{remote} #{branch}))
+        else
+          run_cmd_unless_dry(%W(git push #{remote} #{branch}))
+        end
+      end
+    end
+
+    private
+
+    def remote_is_name?(remote)
+      remote !~ /:\/\/|@.+:/
+    end
+
+    def run_cmd(cmd)
+      piper = Nanoc::Extra::Piper.new(stdout: $stdout, stderr: $stderr)
+      piper.run(cmd, nil)
+    end
+
+    def run_cmd_unless_dry(cmd)
+      if dry_run
+        puts cmd.join(' ')
+      else
+        run_cmd(cmd)
+      end
+    end
+
+    def clean_repo?
+      stdout = StringIO.new
+      piper = Nanoc::Extra::Piper.new(stdout: stdout, stderr: $stderr)
+      piper.run(%w(git status --porcelain), nil)
+      stdout.string.empty?
+    end
+  end
+end

data/lib/nanoc/deploying/deployers/rsync.rb

@@ -19,6 +19,8 @@ module Nanoc::Deploying::Deployers
   #
   # @api private
   class Rsync < ::Nanoc::Deploying::Deployer
+    identifier :rsync
+
     # Default rsync options
     DEFAULT_OPTIONS = [
       '--group',

data/lib/nanoc/extra.rb

@@ -3,10 +3,6 @@ require 'nanoc/deploying'
 
 # @api private
 module Nanoc::Extra
-  autoload 'LinkCollector',       'nanoc/extra/link_collector.rb'
-  autoload 'Piper',               'nanoc/extra/piper'
-  autoload 'JRubyNokogiriWarner', 'nanoc/extra/jruby_nokogiri_warner'
-
   # @deprecated
   Checking = Nanoc::Checking
 
@@ -17,5 +13,8 @@ module Nanoc::Extra
   Pruner = Nanoc::Pruner
 end
 
-require 'nanoc/extra/core_ext'
-require 'nanoc/extra/parallel_collection'
+require_relative 'extra/link_collector.rb'
+require_relative 'extra/piper'
+require_relative 'extra/jruby_nokogiri_warner'
+require_relative 'extra/core_ext'
+require_relative 'extra/parallel_collection'

data/lib/nanoc/filters.rb

@@ -1,58 +1,31 @@
 # @api private
 module Nanoc::Filters
-  autoload 'AsciiDoc',        'nanoc/filters/asciidoc'
-  autoload 'BlueCloth',       'nanoc/filters/bluecloth'
-  autoload 'ColorizeSyntax',  'nanoc/filters/colorize_syntax'
-  autoload 'CoffeeScript',    'nanoc/filters/coffeescript'
-  autoload 'ERB',             'nanoc/filters/erb'
-  autoload 'Erubis',          'nanoc/filters/erubis'
-  autoload 'Haml',            'nanoc/filters/haml'
-  autoload 'Handlebars',      'nanoc/filters/handlebars'
-  autoload 'Kramdown',        'nanoc/filters/kramdown'
-  autoload 'Less',            'nanoc/filters/less'
-  autoload 'Markaby',         'nanoc/filters/markaby'
-  autoload 'Maruku',          'nanoc/filters/maruku'
-  autoload 'Mustache',        'nanoc/filters/mustache'
-  autoload 'Pandoc',          'nanoc/filters/pandoc'
-  autoload 'Rainpress',       'nanoc/filters/rainpress'
-  autoload 'RDiscount',       'nanoc/filters/rdiscount'
-  autoload 'RDoc',            'nanoc/filters/rdoc'
-  autoload 'Redcarpet',       'nanoc/filters/redcarpet'
-  autoload 'RedCloth',        'nanoc/filters/redcloth'
-  autoload 'RelativizePaths', 'nanoc/filters/relativize_paths'
-  autoload 'RubyPants',       'nanoc/filters/rubypants'
-  autoload 'Sass',            'nanoc/filters/sass'
-  autoload 'Slim',            'nanoc/filters/slim'
-  autoload 'Typogruby',       'nanoc/filters/typogruby'
-  autoload 'UglifyJS',        'nanoc/filters/uglify_js'
-  autoload 'XSL',             'nanoc/filters/xsl'
-  autoload 'YUICompressor',   'nanoc/filters/yui_compressor'
-
-  Nanoc::Filter.register '::Nanoc::Filters::AsciiDoc',        :asciidoc
-  Nanoc::Filter.register '::Nanoc::Filters::BlueCloth',       :bluecloth
-  Nanoc::Filter.register '::Nanoc::Filters::ColorizeSyntax',  :colorize_syntax
-  Nanoc::Filter.register '::Nanoc::Filters::CoffeeScript',    :coffeescript
-  Nanoc::Filter.register '::Nanoc::Filters::ERB',             :erb
-  Nanoc::Filter.register '::Nanoc::Filters::Erubis',          :erubis
-  Nanoc::Filter.register '::Nanoc::Filters::Haml',            :haml
-  Nanoc::Filter.register '::Nanoc::Filters::Handlebars',      :handlebars
-  Nanoc::Filter.register '::Nanoc::Filters::Kramdown',        :kramdown
-  Nanoc::Filter.register '::Nanoc::Filters::Less',            :less
-  Nanoc::Filter.register '::Nanoc::Filters::Markaby',         :markaby
-  Nanoc::Filter.register '::Nanoc::Filters::Maruku',          :maruku
-  Nanoc::Filter.register '::Nanoc::Filters::Mustache',        :mustache
-  Nanoc::Filter.register '::Nanoc::Filters::Pandoc',          :pandoc
-  Nanoc::Filter.register '::Nanoc::Filters::Rainpress',       :rainpress
-  Nanoc::Filter.register '::Nanoc::Filters::RDiscount',       :rdiscount
-  Nanoc::Filter.register '::Nanoc::Filters::RDoc',            :rdoc
-  Nanoc::Filter.register '::Nanoc::Filters::Redcarpet',       :redcarpet
-  Nanoc::Filter.register '::Nanoc::Filters::RedCloth',        :redcloth
-  Nanoc::Filter.register '::Nanoc::Filters::RelativizePaths', :relativize_paths
-  Nanoc::Filter.register '::Nanoc::Filters::RubyPants',       :rubypants
-  Nanoc::Filter.register '::Nanoc::Filters::Sass',            :sass
-  Nanoc::Filter.register '::Nanoc::Filters::Slim',            :slim
-  Nanoc::Filter.register '::Nanoc::Filters::Typogruby',       :typogruby
-  Nanoc::Filter.register '::Nanoc::Filters::UglifyJS',        :uglify_js
-  Nanoc::Filter.register '::Nanoc::Filters::XSL',             :xsl
-  Nanoc::Filter.register '::Nanoc::Filters::YUICompressor',   :yui_compressor
 end
+
+require_relative 'filters/asciidoc'
+require_relative 'filters/bluecloth'
+require_relative 'filters/colorize_syntax'
+require_relative 'filters/coffeescript'
+require_relative 'filters/erb'
+require_relative 'filters/erubis'
+require_relative 'filters/haml'
+require_relative 'filters/handlebars'
+require_relative 'filters/kramdown'
+require_relative 'filters/less'
+require_relative 'filters/markaby'
+require_relative 'filters/maruku'
+require_relative 'filters/mustache'
+require_relative 'filters/pandoc'
+require_relative 'filters/rainpress'
+require_relative 'filters/rdiscount'
+require_relative 'filters/rdoc'
+require_relative 'filters/redcarpet'
+require_relative 'filters/redcloth'
+require_relative 'filters/relativize_paths'
+require_relative 'filters/rubypants'
+require_relative 'filters/sass'
+require_relative 'filters/slim'
+require_relative 'filters/typogruby'
+require_relative 'filters/uglify_js'
+require_relative 'filters/xsl'
+require_relative 'filters/yui_compressor'

data/lib/nanoc/filters/asciidoc.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class AsciiDoc < Nanoc::Filter
+    identifier :asciidoc
+
     # Runs the content through [AsciiDoc](http://www.methods.co.nz/asciidoc/).
     # This method takes no options.
     #

data/lib/nanoc/filters/bluecloth.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class BlueCloth < Nanoc::Filter
+    identifier :bluecloth
+
     requires 'bluecloth'
 
     # Runs the content through [BlueCloth](http://deveiate.org/projects/BlueCloth).

data/lib/nanoc/filters/coffeescript.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class CoffeeScript < Nanoc::Filter
+    identifier :coffeescript
+
     requires 'coffee-script'
 
     # Runs the content through [CoffeeScript](http://coffeescript.org/).

data/lib/nanoc/filters/colorize_syntax.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class ColorizeSyntax < Nanoc::Filter
+    identifier :colorize_syntax
+
     requires 'nokogiri', 'stringio', 'open3'
 
     # The default colorizer to use for a language if the colorizer for that

data/lib/nanoc/filters/erb.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class ERB < Nanoc::Filter
+    identifier :erb
+
     requires 'erb'
 
     # Runs the content through [ERB](http://ruby-doc.org/stdlib/libdoc/erb/rdoc/classes/ERB.html).

data/lib/nanoc/filters/erubis.rb

@@ -1,14 +1,9 @@
 module Nanoc::Filters
   # @api private
   class Erubis < Nanoc::Filter
-    requires 'erubis'
+    identifier :erubis
 
-    # The same as `::Erubis::Eruby` but adds `_erbout` as an alias for the
-    # `_buf` variable, making it compatible with Nanoc’s helpers that rely
-    # on `_erbout`, such as {Nanoc::Helpers::Capturing}.
-    class ErubisWithErbout < ::Erubis::Eruby
-      include ::Erubis::ErboutEnhancer
-    end
+    requires 'erubis'
 
     # Runs the content through [Erubis](http://www.kuwata-lab.com/erubis/).
     # This method takes no options.
@@ -25,7 +20,13 @@ module Nanoc::Filters
       assigns_binding = context.get_binding(&proc)
 
       # Get result
-      ErubisWithErbout.new(content, filename: filename).result(assigns_binding)
+      erubis_with_erbout.new(content, filename: filename).result(assigns_binding)
+    end
+
+    private
+
+    def erubis_with_erbout
+      @_erubis_with_erbout ||= Class.new(::Erubis::Eruby) { include ::Erubis::ErboutEnhancer }
     end
   end
 end

data/lib/nanoc/filters/haml.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Haml < Nanoc::Filter
+    identifier :haml
+
     requires 'haml'
 
     # Runs the content through [Haml](http://haml-lang.com/).

data/lib/nanoc/filters/handlebars.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Handlebars < Nanoc::Filter
+    identifier :handlebars
+
     requires 'handlebars'
 
     # Runs the content through

data/lib/nanoc/filters/kramdown.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Kramdown < Nanoc::Filter
+    identifier :kramdown
+
     requires 'kramdown'
 
     # Runs the content through [Kramdown](http://kramdown.gettalong.org/).

data/lib/nanoc/filters/less.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Less < Nanoc::Filter
+    identifier :less
+
     requires 'less'
 
     # Runs the content through [LESS](http://lesscss.org/).

data/lib/nanoc/filters/markaby.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Markaby < Nanoc::Filter
+    identifier :markaby
+
     requires 'markaby'
 
     # Runs the content through [Markaby](http://markaby.github.io/).

data/lib/nanoc/filters/maruku.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Maruku < Nanoc::Filter
+    identifier :maruku
+
     requires 'maruku'
 
     # Runs the content through [Maruku](https://github.com/bhollis/maruku/).

data/lib/nanoc/filters/mustache.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Mustache < Nanoc::Filter
+    identifier :mustache
+
     requires 'mustache'
 
     # Runs the content through

data/lib/nanoc/filters/pandoc.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Pandoc < Nanoc::Filter
+    identifier :pandoc
+
     requires 'pandoc-ruby'
 
     # Runs the content through [Pandoc](http://johnmacfarlane.net/pandoc/)

data/lib/nanoc/filters/rainpress.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Rainpress < Nanoc::Filter
+    identifier :rainpress
+
     requires 'rainpress'
 
     # Runs the content through [Rainpress](http://code.google.com/p/rainpress/).

data/lib/nanoc/filters/rdiscount.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class RDiscount < Nanoc::Filter
+    identifier :rdiscount
+
     requires 'rdiscount'
 
     # Runs the content through [RDiscount](http://github.com/rtomayko/rdiscount).

data/lib/nanoc/filters/rdoc.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class RDoc < Nanoc::Filter
+    identifier :rdoc
+
     requires 'rdoc'
 
     # Runs the content through [RDoc::Markup](http://docs.seattlerb.org/rdoc/RDoc/Markup.html).

data/lib/nanoc/filters/redcarpet.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Redcarpet < Nanoc::Filter
+    identifier :redcarpet
+
     requires 'redcarpet'
 
     # Runs the content through [Redcarpet](https://github.com/vmg/redcarpet).

data/lib/nanoc/filters/redcloth.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class RedCloth < Nanoc::Filter
+    identifier :redcloth
+
     requires 'redcloth'
 
     # Runs the content through [RedCloth](http://redcloth.org/). This method