nanoc3 3.2.4 → 3.3.0

data/lib/nanoc3/cli/error_handler.rb

@@ -1,193 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::CLI
-
-  # Catches errors and prints nice diagnostic messages, then exits.
-  #
-  # @api private
-  class ErrorHandler
-
-    # @option params [Nanoc3::CLI::Command, nil] command The command that is
-    #   currently being executed, or nil if there is none
-    def initialize(params={})
-      @command = params[:command]
-    end
-
-    # Enables error handling in the given block.
-    #
-    # @option params [Nanoc3::CLI::Command, nil] command The command that is
-    #   currently being executed, or nil if there is none
-    #
-    # @return [void]
-    def self.handle_while(params={}, &block)
-      self.new(params).handle_while(&block)
-    end
-
-    # Enables error handling in the given block. This method should not be
-    # called directly; use {Nanoc3::CLI::ErrorHandler.handle_while} instead.
-    #
-    # @return [void]
-    #
-    # @api private
-    def handle_while(&block)
-      # Set exit handler
-      [ 'INT', 'TERM' ].each do |signal|
-        Signal.trap(signal) do
-          puts
-          exit!(0)
-        end
-      end
-
-      # Run
-      yield
-    rescue Interrupt => e
-      exit(1)
-    rescue StandardError, ScriptError => e
-      self.print_error(e)
-      exit(1)
-    end
-
-    # Prints the given error to stderr. Includes message, possible resolution
-    # (see {#resolution_for}), compilation stack, backtrace, etc.
-    #
-    # @param [Error] error The error that should be described
-    #
-    # @return [void]
-    def self.print_error(error)
-      self.new.print_error(error)
-    end
-
-    # Prints the given error to stderr. Includes message, possible resolution
-    # (see {#resolution_for}), compilation stack, backtrace, etc.
-    #
-    # @param [Error] error The error that should be described
-    #
-    # @return [void]
-    def print_error(error)
-      # Header
-      $stderr.puts
-      $stderr.puts "Captain! We’ve been hit!"
-
-      # Exception and resolution (if any)
-      $stderr.puts
-      $stderr.puts '=== MESSAGE:'
-      $stderr.puts
-      $stderr.puts "#{error.class}: #{error.message}"
-      resolution = self.resolution_for(error)
-      $stderr.puts "#{resolution}" if resolution
-
-      # Compilation stack
-      $stderr.puts
-      $stderr.puts '=== COMPILATION STACK:'
-      $stderr.puts
-      if self.stack.empty?
-        $stderr.puts "  (empty)"
-      else
-        self.stack.reverse.each do |obj|
-          if obj.is_a?(Nanoc3::ItemRep)
-            $stderr.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
-          else # layout
-            $stderr.puts "  - [layout] #{obj.identifier}"
-          end
-        end
-      end
-
-      # Backtrace
-      $stderr.puts
-      $stderr.puts '=== BACKTRACE:'
-      $stderr.puts
-      $stderr.puts error.backtrace.to_enum(:each_with_index).map { |item, index| "  #{index}. #{item}" }.join("\n")
-
-      # Issue link
-      $stderr.puts
-      $stderr.puts "If you believe this is a bug in nanoc, please do report it at"
-      $stderr.puts "<https://github.com/ddfreyne/nanoc/issues/new>--thanks!"
-    end
-
-  protected
-
-    # @return [Boolean] true if debug output is enabled, false if not
-    #
-    # @see Nanoc3::CLI.debug?
-    def debug?
-      Nanoc3::CLI.debug?
-    end
-
-    # @return [Nanoc3::Site] The site that is currently being processed
-    def site
-      @command && @command.site
-    end
-
-    # @return [Nanoc3::Compiler] The compiler for the current site
-    def compiler
-      site && site.compiler
-    end
-
-    # @return [Array] The current compilation stack
-    def stack
-      (compiler && compiler.stack) || []
-    end
-
-    # A hash that contains the name of the gem for a given required file. If a
-    # `#require` fails, the gem name is looked up in this hash.
-    GEM_NAMES = {
-      'adsf'           => 'adsf',
-      'bluecloth'      => 'bluecloth',
-      'builder'        => 'builder',
-      'coderay'        => 'coderay',
-      'cri'            => 'cri',
-      'erubis'         => 'erubis',
-      'escape'         => 'escape',
-      'fssm'           => 'fssm',
-      'haml'           => 'haml',
-      'json'           => 'json',
-      'kramdown'       => 'kramdown',
-      'less'           => 'less',
-      'markaby'        => 'markaby',
-      'maruku'         => 'maruku',
-      'mime/types'     => 'mime-types',
-      'nokogiri'       => 'nokogiri',
-      'rack'           => 'rack',
-      'rack/cache'     => 'rack-cache',
-      'rainpress'      => 'rainpress',
-      'rdiscount'      => 'rdiscount',
-      'redcarpet'      => 'redcarpet',
-      'redcloth'       => 'redcloth',
-      'rubypants'      => 'rubypants',
-      'sass'           => 'sass',
-      'systemu'        => 'systemu',
-      'w3c_validators' => 'w3c_validators'
-    }
-
-    # Attempts to find a resolution for the given error, or nil if no
-    # resolution can be automatically obtained.
-    #
-    # @param [Error] error The error to find a resolution for
-    #
-    # @return [String] The resolution for the given error
-    def resolution_for(error)
-      case error
-      when LoadError
-        # Get gem name
-        matches = error.message.match(/(no such file to load|cannot load such file) -- ([^\s]+)/)
-        return nil if matches.nil?
-        gem_name = GEM_NAMES[matches[2]]
-
-        # Build message
-        if gem_name
-          "Try installing the '#{gem_name}' gem (`gem install #{gem_name}`) and then re-running the command."
-        end
-      when RuntimeError
-        if error.message =~ /^can't modify frozen/
-          "You attempted to modify immutable data. Some data, such as " \
-          "item/layout attributes and raw item/layout content, can not " \
-          "be modified once compilation has started. (This was " \
-          "unintentionally possible in 3.1.x and before, but has been " \
-          "disabled in 3.2.x in order to allow compiler optimisations.)"
-        end
-      end
-    end
-
-  end
-
-end

data/lib/nanoc3/cli/logger.rb

@@ -1,91 +0,0 @@
-# encoding: utf-8
-
-require 'singleton'
-
-module Nanoc3::CLI
-
-  # Nanoc3::CLI::Logger is a singleton class responsible for generating
-  # feedback in the terminal.
-  class Logger
-
-    # Maps actions (`:create`, `:update`, `:identical` and `:skip`) onto their
-    # ANSI color codes.
-    ACTION_COLORS = {
-      :create         => "\e[1m" + "\e[32m", # bold + green
-      :update         => "\e[1m" + "\e[33m", # bold + yellow
-      :identical      => "\e[1m",            # bold
-      :skip           => "\e[1m"             # bold
-    }
-
-    include Singleton
-
-    # Returns the log level, which can be :high, :low or :off (which will log
-    # all messages, only high-priority messages, or no messages at all,
-    # respectively).
-    #
-    # @return [Symbol] The log level
-    attr_accessor :level
-
-    # @return [Boolean] True if color should be used, false otherwise
-    attr_writer :color
-
-    def initialize
-      @level = :high
-    end
-
-    # @return [Boolean] true if colors are enabled, false otherwise
-    def color?
-      if @color.nil?
-        @color = true
-        begin
-          require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /mswin|mingw/
-        rescue LoadError
-          @color = false
-        end
-      end
-
-      @color
-    end
-
-    # Logs a file-related action.
-    #
-    # @param [:high, :low] level The importance of this action
-    #
-    # @param [:create, :update, :identical] action The kind of file action
-    #
-    # @param [String] name The name of the file the action was performed on
-    #
-    # @return [void]
-    def file(level, action, identifier, duration=nil)
-      log(
-        level,
-        '%s%12s%s  %s%s' % [
-          color? ? ACTION_COLORS[action.to_sym] : '',
-          action,
-          color? ? "\e[0m" : '',
-          duration.nil? ? '' : "[%2.2fs]  " % [ duration ],
-          identifier
-        ]
-      )
-    end
-
-    # Logs a message.
-    #
-    # @param [:high, :low] level The importance of this message
-    #
-    # @param [String] message The message to be logged
-    #
-    # @param [#puts] io The stream to which the message should be written
-    #
-    # @return [void]
-    def log(level, message, io=$stdout)
-      # Don't log when logging is disabled
-      return if @level == :off
-
-      # Log when level permits it
-      io.puts(message) if (@level == :low or @level == level)
-    end
-
-  end
-
-end

data/lib/nanoc3/data_sources.rb

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::DataSources
-
-  autoload 'Filesystem',         'nanoc3/data_sources/filesystem'
-  autoload 'FilesystemUnified',  'nanoc3/data_sources/filesystem_unified'
-  autoload 'FilesystemVerbose',  'nanoc3/data_sources/filesystem_verbose'
-
-  Nanoc3::DataSource.register '::Nanoc3::DataSources::FilesystemVerbose',  :filesystem_verbose
-  Nanoc3::DataSource.register '::Nanoc3::DataSources::FilesystemUnified',  :filesystem_unified
-
-  # Deprecated; fetch data from online data sources manually instead
-  # TODO [in nanoc 4.0] remove me
-  autoload 'Delicious', 'nanoc3/data_sources/deprecated/delicious'
-  autoload 'LastFM',    'nanoc3/data_sources/deprecated/last_fm'
-  autoload 'Twitter',   'nanoc3/data_sources/deprecated/twitter'
-  Nanoc3::DataSource.register '::Nanoc3::DataSources::Delicious',          :delicious
-  Nanoc3::DataSource.register '::Nanoc3::DataSources::LastFM',             :last_fm
-  Nanoc3::DataSource.register '::Nanoc3::DataSources::Twitter',            :twitter
-
-  # Deprecated; use `filesystem_verbose` or `filesystem_unified` instead
-  # TODO [in nanoc 4.0] remove me
-  Nanoc3::DataSource.register '::Nanoc3::DataSources::FilesystemVerbose',  :filesystem
-  Nanoc3::DataSource.register '::Nanoc3::DataSources::FilesystemUnified',  :filesystem_combined
-  Nanoc3::DataSource.register '::Nanoc3::DataSources::FilesystemUnified',  :filesystem_compact
-  FilesystemCombined = FilesystemUnified
-  FilesystemCompact  = FilesystemUnified
-
-end

data/lib/nanoc3/data_sources/deprecated/delicious.rb

@@ -1,42 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::DataSources
-
-  # @deprecated Fetch data from online data sources manually instead
-  class Delicious < Nanoc3::DataSource
-
-    def items
-      @items ||= begin
-        require 'json'
-
-        # Get data
-        @http_client ||= Nanoc3::Extra::CHiCk::Client.new
-        status, headers, data = *@http_client.get("http://feeds.delicious.com/v2/json/#{self.config[:username]}")
-
-        # Parse as JSON
-        raw_items = JSON.parse(data)
-
-        # Convert to items
-        raw_items.enum_with_index.map do |raw_item, i|
-          # Get data
-          content = raw_item['n']
-          attributes = {
-            :url         => raw_item['u'],
-            :description => raw_item['d'],
-            :tags        => raw_item['t'],
-            :date        => Time.parse(raw_item['dt']),
-            :note        => raw_item['n'],
-            :author      => raw_item['a']
-          }
-          identifier = "/#{i}/"
-          mtime = nil
-
-          # Build item
-          Nanoc3::Item.new(content, attributes, identifier, mtime)
-        end
-      end
-    end
-
-  end
-
-end

data/lib/nanoc3/data_sources/deprecated/last_fm.rb

@@ -1,87 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::DataSources
-
-  # @deprecated Fetch data from online data sources manually instead
-  class LastFM < Nanoc3::DataSource
-
-    def items
-      @items ||= begin
-        require 'json'
-        require 'uri'
-
-        # Check configuration
-        if self.config[:username].nil?
-          raise RuntimeError, "LastFM data source requires a username in the configuration"
-        end
-        if self.config[:api_key].nil?
-          raise RuntimeError, "LastFM data source requires an API key in the configuration"
-        end
-
-        # Get data
-        @http_client ||= Nanoc3::Extra::CHiCk::Client.new
-        status, headers, data = *@http_client.get(
-          'http://ws.audioscrobbler.com/2.0/' +
-            '?method=user.getRecentTracks' +
-            '&format=json' +
-            '&user=' + URI.escape(self.config[:username]) +
-            '&api_key=' + URI.escape(self.config[:api_key])
-        )
-
-        # Parse as JSON
-        parsed_data = JSON.parse(data)
-        raw_items = parsed_data['recenttracks']['track']
-
-        # Convert to items
-        raw_items.enum_with_index.map do |raw_item, i|
-          # Get artist data
-          artist_status, artist_headers, artist_data = *@http_client.get(
-            'http://ws.audioscrobbler.com/2.0/' +
-              '?method=artist.getInfo' +
-              '&format=json' +
-              (
-                raw_item['artist']['mbid'].empty? ?
-                '&artist=' + URI.escape(raw_item['artist']['#text']) :
-                '&mbid=' + URI.escape(raw_item['artist']['mbid'])
-              ) +
-              '&api_key=' + URI.escape(self.config[:api_key])
-          )
-
-          # Parse as JSON
-          parsed_artist_data = JSON.parse(artist_data)
-          raw_artist_info = parsed_artist_data['artist']
-
-          # Build data
-          content = ''
-
-          # Handle track dates
-          if raw_item['@attr'] && raw_item['@attr']['nowplaying'] == 'true'
-            track_played_at = Time.now
-            now_playing = true
-          else
-            played_at = Time.parse(raw_item['date']['#text'])
-            now_playing = false
-          end
-          
-          attributes = {
-            :name      => raw_item['name'],
-            :artist    => {
-              :name      => raw_artist_info['name'],
-              :url       => raw_artist_info['url']
-            },
-            :url       => raw_item['url'],
-            :played_at => track_played_at,
-            :now_playing => now_playing
-          }
-          identifier = "/#{i}/"
-          mtime = nil
-
-          # Build item
-          Nanoc3::Item.new(content, attributes, identifier, mtime)
-        end
-      end
-    end
-
-  end
-
-end

data/lib/nanoc3/data_sources/deprecated/twitter.rb

@@ -1,38 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::DataSources
-
-  # @deprecated Fetch data from online data sources manually instead
-  class Twitter < Nanoc3::DataSource
-
-    def items
-      @item ||= begin
-        require 'json'
-
-        # Get data
-        @http_client ||= Nanoc3::Extra::CHiCk::Client.new
-        status, headers, data = *@http_client.get("http://twitter.com/statuses/user_timeline/#{self.config[:username]}.json")
-
-        # Parse as JSON
-        raw_items = JSON.parse(data)
-
-        # Convert to items
-        raw_items.enum_with_index.map do |raw_item, i|
-          # Get data
-          content = raw_item['text']
-          attributes = {
-            :created_at  => raw_item['created_at'],
-            :source      => raw_item['source']
-          }
-          identifier = "/#{raw_item['id']}/"
-          mtime = Time.parse(raw_item['created_at'])
-
-          # Build item
-          Nanoc3::Item.new(content, attributes, identifier, mtime)
-        end
-      end
-    end
-
-  end
-
-end