nanoc3 3.0.0

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

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+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.
+    def initialize
+      # Get site
+      error 'No site configuration found' unless File.file?('config.yaml')
+      @site = Nanoc3::Site.new('.')
+    end
+
+    # Runs the task. Possible params:
+    #
+    # +:dry_run+:: Set to true when the action itself should not be executed,
+    #              but still printed. Useful for debugging.
+    #
+    # +:config_name+:: The name of the deployment configuration to use.
+    #                  Defaults to +:default+ (surprise!).
+    def run(params={})
+      # Extract params
+      config_name = params.has_key?(:config_name) ? params[:config_name].to_sym : :default
+      dry_run     = params.has_key?(:dry_run)     ? params[:dry_run]            : false
+
+      # Validate config
+      error 'No deploy configuration found'                    if @site.config[:deploy].nil?
+      error "No deploy configuration found for #{config_name}" if @site.config[:deploy][config_name].nil?
+
+      # Set arguments
+      src = File.expand_path(@site.config[:output_dir]) + '/'
+      dst = @site.config[:deploy][config_name][:dst]
+      options = @site.config[:deploy][config_name][:options] || []
+
+      # Validate arguments
+      error 'No dst found in deployment configuration' if dst.nil?
+      error 'dst requires no trailing slash' if dst[-1,1] == '/'
+
+      # Run
+      if dry_run
+        warn 'Performing a dry-run; no actions will actually be performed'
+        run_shell_cmd([ 'echo', 'rsync', options, src, dst ].flatten)
+      else
+        run_shell_cmd([ 'rsync', options, src, dst ].flatten)
+      end
+    end
+
+  private
+
+    # Prints the given message on stderr and exits.
+    def error(msg)
+      raise RuntimeError.new(msg)
+    end
+
+    # Runs the given shell command. This is a simple wrapper around Kernel#system.
+    def run_shell_cmd(args)
+      system(*args)
+    end
+
+  end
+
+end

data/lib/nanoc3/extra/deployers.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Nanoc3::Extra
+
+  # Nanoc3::Extra::Deployers is the name for all deployers.
+  module Deployers
+
+    autoload 'Rsync', 'nanoc3/extra/deployers/rsync'
+
+  end
+
+end

data/lib/nanoc3/extra/file_proxy.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+module Nanoc3::Extra
+
+  # A FileProxy is a proxy for a File object. It is used to prevent a File
+  # object from being created until it is actually necessary.
+  #
+  # For example, a site with a few thousand items would fail to compile
+  # because the massive amount of file descriptors necessary, but the file
+  # proxy will make sure the File object is not created until it is used.
+  class FileProxy
+
+    instance_methods.each { |m| undef_method m unless m =~ /^__/ || m.to_s == 'object_id' }
+
+    # 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.
+    def initialize(path)
+      @path = path
+    end
+
+    # Makes sure all method calls are relayed to a File object, which will
+    # be created right before the method call takes place and destroyed
+    # right after.
+    def method_missing(sym, *args, &block)
+      File.new(@path).__send__(sym, *args, &block)
+    end
+
+  end
+
+end

data/lib/nanoc3/extra/validators/w3c.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+module Nanoc3::Extra::Validators
+
+  # Nanoc3::Extra::Validators::W3C is a validator that uses the W3C web
+  # service to validate HTML and CSS files.
+  class W3C
+
+    def initialize(site, type)
+      @site = site
+      @type = type
+    end
+
+    def run
+      # Load validator
+      require 'w3c_validators'
+
+      # Make sure config is loaded
+      @site.load_data
+
+      # Find all files
+      files = extensions.map { |extension| Dir["#{@site.config[:output_dir]}/**/*.#{extension}"] }.flatten
+
+      # Validate each file
+      files.each do |file|
+        validation_started(file)
+        results = validator.validate_file(file)
+        validation_ended(file, results.errors)
+      end
+    end
+
+  private
+
+    def extensions
+      case @type
+      when :html
+        [ 'html', 'htm' ]
+      when :css
+        [ 'css' ]
+      end
+    end
+
+    def validator_class
+      case @type
+      when :html
+        ::W3CValidators::MarkupValidator
+      when :css
+        ::W3CValidators::CSSValidator
+      end
+    end
+
+    def validator
+      @validator ||= validator_class.new
+    end
+
+    def validation_started(file)
+      $stdout.print "Validating #{file}... "
+      $stdout.flush
+    end
+
+    def validation_ended(file, errors)
+      $stdout.puts(errors.empty? ? "valid" : "INVALID")
+
+      errors.each do |err|
+        puts "    #{err}"
+      end
+    end
+
+  end
+
+end

data/lib/nanoc3/extra/validators.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Nanoc3::Extra
+
+  # Nanoc3::Extra::Validators is the name for all validators.
+  module Validators
+
+    autoload 'W3C', 'nanoc3/extra/validators/w3c'
+
+  end
+
+end

data/lib/nanoc3/extra/vcs.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+
+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.
+  #
+  # This is the abstract superclass for all VCSes. Subclasses should implement
+  # the indicated methods. 
+  class VCS < Nanoc3::Plugin
+
+    # 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
+
+    # Adds the file with the given filename to the working copy.
+    #
+    # Subclasses must implement this method.
+    def add(filename)
+      not_implemented('add')
+    end
+
+    # Removes the file with the given filename from the working copy. When
+    # this method is executed, the file should no longer be present on the
+    # disk.
+    #
+    # Subclasses must implement this method.
+    def remove(filename)
+      not_implemented('remove')
+    end
+
+    # Moves the file with the given filename to a new location. When this
+    # method is executed, the original file should no longer be present on the
+    # disk.
+    #
+    # Subclasses must implement this method.
+    def move(src, dst)
+      not_implemented('move')
+    end
+
+  private
+
+    def not_implemented(name)
+      raise NotImplementedError.new(
+        "#{self.class} does not override ##{name}, which is required for " +
+        "this data source to be used."
+      )
+    end
+
+  end
+
+end

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

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Nanoc3::Extra::VCSes
+
+  class Bazaar < Nanoc3::Extra::VCS
+
+    def add(filename)
+      system('bzr', 'add', filename)
+    end
+
+    def remove(filename)
+      system('bzr', 'rm', filename)
+    end
+
+    def move(src, dst)
+      system('bzr', 'mv', src, dst)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Nanoc3::Extra::VCSes
+
+  class Dummy < Nanoc3::Extra::VCS
+
+    def add(filename)
+    end
+
+    def remove(filename)
+      FileUtils.rm_rf(filename)
+    end
+
+    def move(src, dst)
+      FileUtils.move(src, dst)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Nanoc3::Extra::VCSes
+
+  class Git < Nanoc3::Extra::VCS
+
+    def add(filename)
+      system('git', 'add', filename)
+    end
+
+    def remove(filename)
+      system('git', 'rm', filename)
+    end
+
+    def move(src, dst)
+      system('git', 'mv', src, dst)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Nanoc3::Extra::VCSes
+
+  class Mercurial < Nanoc3::Extra::VCS
+
+    def add(filename)
+      system('hg', 'add', filename)
+    end
+
+    def remove(filename)
+      system('hg', 'rm', filename)
+    end
+
+    def move(src, dst)
+      system('hg', 'mv', src, dst)
+    end
+
+  end
+
+end

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

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+module Nanoc3::Extra::VCSes
+
+  class Subversion < Nanoc3::Extra::VCS
+
+    def add(filename)
+      system('svn', 'add', filename)
+    end
+
+    def remove(filename)
+      system('svn', 'rm', filename)
+    end
+
+    def move(src, dst)
+      system('svn', 'mv', src, dst)
+    end
+
+  end
+
+end

data/lib/nanoc3/extra/vcses.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Nanoc3::Extra::VCSes
+
+  autoload 'Bazaar',     'nanoc3/extra/vcses/bazaar'
+  autoload 'Dummy',      'nanoc3/extra/vcses/dummy'
+  autoload 'Git',        'nanoc3/extra/vcses/git'
+  autoload 'Mercurial',  'nanoc3/extra/vcses/mercurial'
+  autoload 'Subversion', 'nanoc3/extra/vcses/subversion'
+
+  Nanoc3::Extra::VCS.register '::Nanoc3::Extra::VCSes::Bazaar',     :bazaar, :bzr
+  Nanoc3::Extra::VCS.register '::Nanoc3::Extra::VCSes::Dummy',      :dummy
+  Nanoc3::Extra::VCS.register '::Nanoc3::Extra::VCSes::Git',        :git
+  Nanoc3::Extra::VCS.register '::Nanoc3::Extra::VCSes::Mercurial',  :mercurial, :hg
+  Nanoc3::Extra::VCS.register '::Nanoc3::Extra::VCSes::Subversion', :subversion, :svn
+
+end

data/lib/nanoc3/extra.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+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'
+
+end
+
+require 'nanoc3/extra/core_ext'
+require 'nanoc3/extra/vcs'
+require 'nanoc3/extra/vcses'

data/lib/nanoc3/filters/bluecloth.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class BlueCloth < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'bluecloth'
+
+      ::BlueCloth.new(content).to_html
+    end
+
+  end
+end

data/lib/nanoc3/filters/coderay.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class CodeRay < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'coderay'
+
+      # Check params
+      raise ArgumentError, "CodeRay filter requires a :language argument which is missing" if params[:language].nil?
+
+      # Get result
+      ::CodeRay.scan(content, params[:language]).html
+    end
+
+  end
+end

data/lib/nanoc3/filters/erb.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class ERB < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'erb'
+
+      # Create context
+      context = ::Nanoc3::Extra::Context.new(assigns)
+
+      # Get result
+      erb = ::ERB.new(content)
+      erb.filename = filename
+      erb.result(context.get_binding { assigns[:content] })
+    end
+
+  end
+end

data/lib/nanoc3/filters/erubis.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class Erubis < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'erubis'
+
+      # Create context
+      context = ::Nanoc3::Extra::Context.new(assigns)
+
+      # Get result
+      ::Erubis::Eruby.new(content, :filename => filename).result(context.get_binding { assigns[:content] })
+    end
+
+  end
+end

data/lib/nanoc3/filters/haml.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class Haml < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'haml'
+
+      # Get options
+      options = params.merge(:filename => filename)
+
+      # Create context
+      context = ::Nanoc3::Extra::Context.new(assigns)
+
+      # Get result
+      ::Haml::Engine.new(content, options).render(context, assigns) { assigns[:content] }
+    end
+
+  end
+end

data/lib/nanoc3/filters/less.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class Less < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'less'
+
+      ::Less::Engine.new(content).to_css
+    end
+
+  end
+end

data/lib/nanoc3/filters/markaby.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class Markaby < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'markaby'
+
+      # Get result
+      ::Markaby::Builder.new(assigns).instance_eval(content).to_s
+    end
+
+  end
+end

data/lib/nanoc3/filters/maruku.rb

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

data/lib/nanoc3/filters/rainpress.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class Rainpress < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'rainpress'
+
+      ::Rainpress.compress(content)
+    end
+
+  end
+end

data/lib/nanoc3/filters/rdiscount.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class RDiscount < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'rdiscount'
+
+      ::RDiscount.new(content).to_html
+    end
+
+  end
+end

data/lib/nanoc3/filters/rdoc.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class RDoc < Nanoc3::Filter
+
+    def run(content, params={})
+      begin
+        # new RDoc
+        require 'rdoc/markup'
+        require 'rdoc/markup/to_html'
+        
+        ::RDoc::Markup.new.convert(content, ::RDoc::Markup::ToHtml.new)
+      rescue LoadError
+        # old RDoc
+        require 'rdoc/markup/simple_markup'
+        require 'rdoc/markup/simple_markup/to_html'
+
+        ::SM::SimpleMarkup.new.convert(content, ::SM::ToHtml.new)
+      end
+    end
+
+  end
+end

data/lib/nanoc3/filters/redcloth.rb

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

data/lib/nanoc3/filters/relativize_paths.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class RelativizePaths < Nanoc3::Filter
+
+    require 'nanoc3/helpers/link_to'
+    include Nanoc3::Helpers::LinkTo
+
+    def run(content, params={})
+      # Set assigns so helper function can be used
+      @item_rep = assigns[:item_rep] if @item_rep.nil?
+
+      # Filter
+      case params[:type]
+      when :html
+        content.gsub(/(src|href)=(['"]?)(\/.+?)\2([ >])/) do
+          $1 + '=' + $2 + relative_path_to($3) + $2 + $4
+        end
+      when :css
+        content.gsub(/url\((['"]?)(\/.+?)\1\)/) do
+          'url(' + $1 + relative_path_to($2) + $1 + ')'
+        end
+      else
+        raise RuntimeError.new(
+          "The relativize_paths needs to know the type of content to " +
+          "process. Pass :type => :html for HTML or :type => :css for CSS."
+        )
+      end
+    end
+
+  end
+end

data/lib/nanoc3/filters/rubypants.rb

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

data/lib/nanoc3/filters/sass.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+module Nanoc3::Filters
+  class Sass < Nanoc3::Filter
+
+    def run(content, params={})
+      require 'sass'
+
+      # Get options
+      options = params.merge(:filename => filename)
+
+      # Get result
+      ::Sass::Engine.new(content, options).render
+    end
+
+  end
+end