nanoc3 3.2.4 → 3.3.0

data/lib/nanoc3/extra.rb

@@ -1,22 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::Extra
-
-  autoload 'AutoCompiler',      'nanoc3/extra/auto_compiler'
-  autoload 'CHiCk',             'nanoc3/extra/chick'
-  autoload 'Deployers',         'nanoc3/extra/deployers'
-  autoload 'Validators',        'nanoc3/extra/validators'
-
-  # Deprecated; use {Nanoc3::Context} instead
-  # TODO [in nanoc 4.0] remove me
-  Context = ::Nanoc3::Context
-
-  # Deprecated
-  # TODO [in nanoc 4.0] remove me
-  autoload 'FileProxy',         'nanoc3/extra/file_proxy'
-
-end
-
-require 'nanoc3/extra/core_ext'
-require 'nanoc3/extra/vcs'
-require 'nanoc3/extra/vcses'

data/lib/nanoc3/extra/auto_compiler.rb

@@ -1,103 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::Extra
-
-  # A web server that will automatically compile items as they are requested.
-  # It also serves static files such as stylesheets and images.
-  class AutoCompiler
-
-    # @return [Nanoc3::Site] The site this autocompiler belongs to
-    attr_reader :site
-
-    # Creates a new autocompiler for the given site.
-    #
-    # @param [String] site_path The path to the site to autocompile
-    def initialize(site_path)
-      require 'rack'
-      require 'mime/types'
-
-      # Set site
-      @site_path = site_path
-
-      # Create mutex to prevent parallel requests
-      require 'thread'
-      @mutex = Mutex.new
-    end
-
-    # Calls the autocompiler. The behaviour of this method is defined by the
-    # [Rack specification](http://rack.rubyforge.org/doc/files/SPEC.html).
-    #
-    # @param [Hash] env The environment, as defined by the Rack specification
-    #
-    # @return [Array] An array containing the status, the headers, and the
-    #   body, as defined by the Rack specification
-    def call(env)
-      @mutex.synchronize do
-        # Start with a new site
-        build_site
-
-        # Find rep
-        path = Rack::Utils::unescape(env['PATH_INFO'])
-        reps = site.items.map { |i| i.reps }.flatten
-        rep = reps.find do |r|
-          r.path == path ||
-            r.raw_path == site.config[:output_dir] + path
-        end
-
-        # Recompile
-        site.compile if rep
-
-        # Get paths by appending index filenames
-        if path =~ /\/$/
-          possible_paths = site.config[:index_filenames].map { |f| path + f }
-        else
-          possible_paths = [ path ]
-        end
-
-        # Find matching file
-        modified_path = possible_paths.find { |f| File.file?(site.config[:output_dir] + f) }
-        modified_path ||= path
-
-        # Serve using Rack::File
-        puts "*** serving file #{modified_path}"
-        res = file_server.call(env.merge('PATH_INFO' => modified_path))
-        puts "*** done serving file #{modified_path}"
-        res
-      end
-    rescue StandardError, ScriptError => e
-      # Add compilation stack to env
-      env['nanoc.stack'] = []
-      stack.reverse.each do |obj|
-        if obj.is_a?(Nanoc3::ItemRep) # item rep
-          env['nanoc.stack'] << "[item] #{obj.item.identifier} (rep #{obj.name})"
-        else # layout
-          env['nanoc.stack'] << "[layout] #{obj.identifier}"
-        end
-      end
-
-      # Re-raise error
-      raise e
-    end
-
-  private
-
-    def build_site
-      @site = Nanoc3::Site.new(@site_path)
-    end
-
-    def mime_type_of(path, fallback)
-      mime_type = MIME::Types.of(path).first
-      mime_type = mime_type.nil? ? fallback : mime_type.simplified
-    end
-
-    def file_server
-      @file_server ||= ::Rack::File.new(site.config[:output_dir])
-    end
-
-    def stack
-      site.compiler.stack
-    end
-
-  end
-
-end

data/lib/nanoc3/extra/chick.rb

@@ -1,125 +0,0 @@
-require 'net/http'
-require 'rack'
-require 'rack/cache'
-
-module Nanoc3::Extra
-
-  # @deprecated Use a HTTP library such as
-  #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
-  #   [Curb](http://curb.rubyforge.org/) instead.
-  module CHiCk
-
-    # @deprecated Use a HTTP library such as
-    #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
-    #   [Curb](http://curb.rubyforge.org/) instead.
-    class Client
-
-      DEFAULT_OPTIONS = {
-        :cache => {
-          :metastore   => 'file:tmp/rack/cache.meta', 
-          :entitystore => 'file:tmp/rack/cache.body'
-        },
-        :cache_controller => {
-          :max_age => 60
-        }
-      }
-
-      def initialize(options={})
-        # Get options
-        @options = DEFAULT_OPTIONS.merge(options)
-        @options[:cache] = DEFAULT_OPTIONS[:cache].merge(@options[:cache])
-        @options[:cache_controller] = DEFAULT_OPTIONS[:cache_controller].merge(@options[:cache_controller])
-      end
-
-      def get(url)
-        # Build app
-        options = @options
-        @app ||= Rack::Builder.new {
-          use Rack::Cache, options[:cache].merge(:verbose => true)
-          use Nanoc3::Extra::CHiCk::CacheController, options[:cache_controller]
-          run Nanoc3::Extra::CHiCk::RackClient
-        }
-
-        # Build environment for request
-        env = Rack::MockRequest.env_for(url, :method => 'GET')
-
-        # Fetch
-        puts "[CHiCk] Fetching #{url}..." if $DEBUG
-        status, headers, body_parts = @app.call(env)
-        puts "[CHiCk] #{url}: #{headers['X-Rack-Cache']}" if $DEBUG
-
-        # Join body
-        body = ''
-        body_parts.each { |part| body << part }
-
-        # Done
-        [ status, headers, body ]
-      end
-
-    end
-
-    # @deprecated Use a HTTP library such as
-    #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
-    #   [Curb](http://curb.rubyforge.org/) instead.
-    class CacheController
-
-      def initialize(app, options={})
-        @app = app
-        @options = options
-      end
-
-      def call(env)
-        res = @app.call(env)
-        unless res[1].has_key?('Cache-Control') || res[1].has_key?('Expires')
-          res[1]['Cache-Control'] = "max-age=#{@options[:max_age]}"
-        end
-        res
-      end
-
-    end
-
-    # @deprecated Use a HTTP library such as
-    #   [Net::HTTP](http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/) or
-    #   [Curb](http://curb.rubyforge.org/) instead.
-    class RackClient
-
-      METHOD_TO_CLASS_MAPPING = {
-        'DELETE'  => Net::HTTP::Delete,
-        'GET'     => Net::HTTP::Get,
-        'HEAD'    => Net::HTTP::Head,
-        'POST'    => Net::HTTP::Post,
-        'PUT'     => Net::HTTP::Put
-      }
-
-      def self.call(env)
-        # Build request
-        request = Rack::Request.new(env)
-
-        # Build headers and strip HTTP_
-        request_headers = env.inject({}) do |m,(k,v)|
-          k =~ /^HTTP_(.*)$/ && v ? m.merge($1.gsub(/_/, '-') => v) : m
-        end
-
-        # Build Net::HTTP request
-        http = Net::HTTP.new(request.host, request.port)
-        net_http_request_class = METHOD_TO_CLASS_MAPPING[request.request_method]
-        raise ArgumentError, "Unsupported method: #{request.request_method}" if net_http_request_class.nil?
-        net_http_request = net_http_request_class.new(request.fullpath, request_headers)
-        net_http_request.body = env['rack.input'].read if [ 'POST', 'PUT' ].include?(request.request_method)
-
-        # Perform request
-        http.request(net_http_request) do |response|
-          # Build Rack response triplet
-          return [
-            response.code.to_i,
-            response.to_hash.inject({}) { |m,(k,v)| m.merge(k => v[0]) },
-            [ response.body ]
-          ]
-        end
-      end
-
-    end
-
-  end
-
-end

data/lib/nanoc3/extra/core_ext.rb

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

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

@@ -1,33 +0,0 @@
-# encoding: utf-8
-
-module Enumerable
-
-  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
-    # 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

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

@@ -1,19 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::Extra::TimeExtensions
-
-  # @return [String] The time in an ISO-8601 date format.
-  def to_iso8601_date
-    self.strftime("%Y-%m-%d")
-  end
-
-  # @return [String] The time in an ISO-8601 time format.
-  def to_iso8601_time
-    self.getutc.strftime("%Y-%m-%dT%H:%M:%SZ")
-  end
-
-end
-
-class Time
-  include Nanoc3::Extra::TimeExtensions
-end

data/lib/nanoc3/extra/deployers.rb

@@ -1,11 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::Extra
-
-  module Deployers
-
-    autoload 'Rsync', 'nanoc3/extra/deployers/rsync'
-
-  end
-
-end

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

@@ -1,114 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::Extra::Deployers
-
-  # A deployer that deploys a site using rsync.
-  class Rsync
-
-    # Default rsync options
-    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, {DEFAULT_OPTIONS} options
-    # will be 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')
-      @site = Nanoc3::Site.new('.')
-    end
-
-    # Runs the task. Possible params:
-    #
-    # @option params [Boolean] :dry_run (false) True if the action itself
-    #   should not be executed, but still printed; false otherwise.
-    #
-    # @option params [String] :config_name (:default) The name of the
-    #   deployment configuration to use.
-    #
-    # @return [void]
-    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] || DEFAULT_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)
-      raise "command exited with a nonzero status code #{$?.exitstatus} (command: #{args.join(' ')})" if !$?.success?
-    end
-
-  end
-
-end

data/lib/nanoc3/extra/file_proxy.rb

@@ -1,40 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::Extra
-
-  # @deprecated Create a File instance directly and use that instead.
-  class FileProxy
-
-    instance_methods.each { |m| undef_method m unless m =~ /^__/ || m.to_s == 'object_id' }
-
-    @@deprecation_warning_shown = false
-
-    def initialize(path)
-      @path = path
-    end
-
-    def freeze
-    end
-
-    def respond_to?(meth)
-      file_instance_methods.include?(meth.to_sym)
-    end
-
-    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, :meta_filename or :filename attributes.'
-        @@deprecation_warning_shown = true
-      end
-
-      File.open(@path, 'r') { |io| io.__send__(sym, *args, &block) }
-    end
-
-  private
-
-    def file_instance_methods
-      @@file_instance_methods ||= Set.new(File.instance_methods.map { |m| m.to_sym })
-    end
-
-  end
-
-end