nanoc 4.11.14 → 4.11.15

data/lib/nanoc/checking/checks/internal_links.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Checking::Checks
-  # A check that verifies that all internal links point to a location that exists.
-  #
-  # @api private
-  class InternalLinks < ::Nanoc::Checking::Check
-    identifiers :internal_links, :ilinks
-
-    # Starts the validator. The results will be printed to stdout.
-    #
-    # Internal links that match a regexp pattern in `@config[:checks][:internal_links][:exclude]` will
-    # be skipped.
-    #
-    # @return [void]
-    def run
-      # TODO: de-duplicate this (duplicated in external links check)
-      filenames = output_html_filenames
-      uris = ::Nanoc::Extra::LinkCollector.new(filenames, :internal).filenames_per_href
-
-      uris.each_pair do |href, fns|
-        fns.each do |filename|
-          next if valid?(href, filename)
-
-          add_issue(
-            "broken reference to #{href}",
-            subject: filename,
-          )
-        end
-      end
-    end
-
-    protected
-
-    def valid?(href, origin)
-      # Skip hrefs that point to self
-      # FIXME: this is ugly and won’t always be correct
-      return true if href == '.'
-
-      # Turn file: into output_dir-as-root relative paths
-
-      output_dir = @config.output_dir
-      output_dir += '/' unless output_dir.end_with?('/')
-      base_uri = URI("file://#{output_dir}")
-      path = href.sub(/#{base_uri}/, '').sub(/file:\/{1,3}/, '')
-
-      path = "/#{path}" unless path.start_with?('/')
-
-      # Skip hrefs that are specified in the exclude configuration
-      return true if excluded?(path, origin)
-
-      # Make an absolute path
-      path = ::File.join(output_dir, path[1..path.length])
-
-      # Remove fragment
-      path = path.sub(/#.*$/, '')
-      return true if path.empty?
-
-      # Remove query string
-      path = path.sub(/\?.*$/, '')
-      return true if path.empty?
-
-      # Decode URL (e.g. '%20' -> ' ')
-      path = CGI.unescape(path)
-
-      # Check whether file exists
-      return true if File.file?(path)
-
-      # Check whether directory with index file exists
-      return true if File.directory?(path) && @config[:index_filenames].any? { |fn| File.file?(File.join(path, fn)) }
-
-      # Nope :(
-      false
-    end
-
-    def excluded?(href, origin)
-      config = @config.fetch(:checks, {}).fetch(:internal_links, {})
-      excluded_target?(href, config) || excluded_origin?(origin, config)
-    end
-
-    def excluded_target?(href, config)
-      excludes = config.fetch(:exclude_targets, config.fetch(:exclude, []))
-      excludes.any? { |pattern| Regexp.new(pattern).match(href) }
-    end
-
-    def excluded_origin?(origin, config)
-      # FIXME: do not depend on current working directory
-      origin = File.absolute_path(origin)
-
-      relative_origin = origin[@config.output_dir.size..-1]
-      excludes = config.fetch(:exclude_origins, [])
-      excludes.any? { |pattern| Regexp.new(pattern).match(relative_origin) }
-    end
-  end
-end

data/lib/nanoc/checking/checks/mixed_content.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Checking::Checks
-  # A check that verifies HTML files do not reference external resources with
-  # URLs that would trigger "mixed content" warnings.
-  #
-  # @api private
-  class MixedContent < ::Nanoc::Checking::Check
-    identifier :mixed_content
-
-    PROTOCOL_PATTERN = /^(\w+):\/\//.freeze
-
-    def run
-      filenames = output_html_filenames
-      resource_uris_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames).filenames_per_resource_uri
-
-      resource_uris_with_filenames.each_pair do |uri, fns|
-        next unless guaranteed_insecure?(uri)
-
-        fns.each do |filename|
-          add_issue(
-            "mixed content include: #{uri}",
-            subject: filename,
-          )
-        end
-      end
-    end
-
-    private
-
-    def guaranteed_insecure?(href)
-      protocol = PROTOCOL_PATTERN.match(href)
-
-      protocol && protocol[1].casecmp('http').zero?
-    end
-  end
-end

data/lib/nanoc/checking/checks/stale.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Checking::Checks
-  # @api private
-  class Stale < ::Nanoc::Checking::Check
-    identifier :stale
-
-    def run
-      output_filenames.each do |f|
-        next if pruner.filename_excluded?(f)
-        next if item_rep_paths.include?(f)
-
-        add_issue(
-          'file without matching item',
-          subject: f,
-        )
-      end
-    end
-
-    protected
-
-    def item_rep_paths
-      @item_rep_paths ||=
-        Set.new(
-          @items
-            .flat_map(&:reps)
-            .map(&:_unwrap)
-            .flat_map(&:raw_paths)
-            .flat_map(&:values)
-            .flatten,
-        )
-    end
-
-    def pruner
-      exclude_config = @config.fetch(:prune, {}).fetch(:exclude, [])
-      # FIXME: specifying reps this way is icky
-      reps = Nanoc::Core::ItemRepRepo.new
-      @pruner ||= Nanoc::Core::Pruner.new(@config._unwrap, reps, exclude: exclude_config)
-    end
-  end
-end

data/lib/nanoc/checking/checks/w3c_validator.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module ::Nanoc::Checking::Checks
-  # @api private
-  class W3CValidator < ::Nanoc::Checking::Check
-    def run
-      require 'w3c_validators'
-      require 'resolv-replace'
-
-      Dir[@config.output_dir + '/**/*.' + extension].each do |filename|
-        results = validator_class.new.validate_file(filename)
-        lines = File.readlines(filename)
-        results.errors.each do |e|
-          line_num = e.line.to_i - 1
-          line = lines[line_num]
-          message = e.message.gsub(%r{\s+}, ' ').strip.sub(/\s+:$/, '')
-          desc = "line #{line_num + 1}: #{message}: #{line}"
-          add_issue(desc, subject: filename)
-        end
-      end
-    end
-
-    def extension
-      raise NotImplementedError
-    end
-
-    def validator_class
-      raise NotImplementedError
-    end
-  end
-end

data/lib/nanoc/checking/dsl.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Checking
-  # @api private
-  class DSL
-    def self.from_file(filename, enabled_checks:)
-      dsl = new(enabled_checks: enabled_checks)
-      absolute_filename = File.expand_path(filename)
-      dsl.instance_eval(File.read(filename), absolute_filename)
-      dsl
-    end
-
-    def initialize(enabled_checks:)
-      @enabled_checks = enabled_checks
-    end
-
-    def check(identifier, &block)
-      klass = Class.new(::Nanoc::Checking::Check)
-      klass.send(:define_method, :run, &block)
-      klass.send(:identifier, identifier)
-    end
-
-    def deploy_check(*identifiers)
-      identifiers.each { |i| @enabled_checks << i }
-    end
-  end
-end

data/lib/nanoc/checking/issue.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Checking
-  # @api private
-  class Issue
-    attr_reader :description
-    attr_reader :subject
-    attr_reader :check_class
-
-    def initialize(desc, subject, check_class)
-      @description   = desc
-      @subject       = subject
-      @check_class = check_class
-    end
-  end
-end

data/lib/nanoc/checking/loader.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Checking
-  # @api private
-  class Loader
-    CHECKS_FILENAMES = ['Checks', 'Checks.rb', 'checks', 'checks.rb'].freeze
-
-    def initialize(config:)
-      @config = config
-    end
-
-    def run
-      dsl
-    end
-
-    def enabled_checks
-      (enabled_checks_from_dsl + enabled_checks_from_config).uniq
-    end
-
-    private
-
-    def dsl_present?
-      checks_filename && File.file?(checks_filename)
-    end
-
-    def enabled_checks_from_dsl
-      dsl
-      @enabled_checks_from_dsl
-    end
-
-    def enabled_checks_from_config
-      @config.fetch(:checking, {}).fetch(:enabled_checks, []).map(&:to_sym)
-    end
-
-    def dsl
-      @enabled_checks_from_dsl ||= []
-
-      @dsl ||=
-        if dsl_present?
-          Nanoc::Checking::DSL.from_file(checks_filename, enabled_checks: @enabled_checks_from_dsl)
-        else
-          Nanoc::Checking::DSL.new(enabled_checks: @enabled_checks_from_dsl)
-        end
-    end
-
-    def checks_filename
-      @_checks_filename ||= CHECKS_FILENAMES.find { |f| File.file?(f) }
-    end
-  end
-end

data/lib/nanoc/checking/runner.rb

@@ -1,136 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Checking
-  # Runner is reponsible for running issue checks.
-  #
-  # @api private
-  class Runner
-    # @param [Nanoc::Core::Site] site The Nanoc site this runner is for
-    def initialize(site)
-      @site = site
-    end
-
-    def any_enabled_checks?
-      enabled_checks.any?
-    end
-
-    # Lists all available checks on stdout.
-    #
-    # @return [void]
-    def list_checks
-      load_all
-
-      puts 'Available checks:'
-      puts
-      puts all_check_classes.map { |i| '  ' + i.identifier.to_s }.sort.join("\n")
-    end
-
-    # Runs all checks.
-    #
-    # @return [Boolean] true if successful, false otherwise
-    def run_all
-      load_all
-      run_check_classes(all_check_classes)
-    end
-
-    # Runs the checks marked for deployment.
-    #
-    # @return [Boolean] true if successful, false otherwise
-    def run_for_deploy
-      # TODO: rename to #run_enabled
-      load_all
-      run_check_classes(check_classes_named(enabled_checks))
-    end
-
-    # Runs the checks with the given names.
-    #
-    # @param [Array<Symbol>] check_class_names The names of the checks
-    #
-    # @return [Boolean] true if successful, false otherwise
-    def run_specific(check_class_names)
-      load_all
-      run_check_classes(check_classes_named(check_class_names))
-    end
-
-    private
-
-    def loader
-      @loader ||= Nanoc::Checking::Loader.new(config: @site.config)
-    end
-
-    def load_all
-      loader.run
-    end
-
-    def enabled_checks
-      loader.enabled_checks
-    end
-
-    def run_check_classes(classes)
-      issues = run_checks(classes)
-      print_issues(issues)
-      issues.empty? ? true : false
-    end
-
-    def all_check_classes
-      Nanoc::Checking::Check.all
-    end
-
-    def check_classes_named(names)
-      names.map do |name|
-        name = name.to_s.tr('-', '_').to_sym
-        klass = Nanoc::Checking::Check.named(name)
-        raise Nanoc::Core::TrivialError, "Unknown check: #{name}" if klass.nil?
-
-        klass
-      end
-    end
-
-    def run_checks(classes)
-      return [] if classes.empty?
-
-      # TODO: remove me
-      Nanoc::Core::Compiler.new_for(@site).run_until_reps_built
-
-      checks = []
-      issues = Set.new
-      length = classes.map { |c| c.identifier.to_s.length }.max + 18
-      classes.each do |klass|
-        print format("  %-#{length}s", "Running check #{klass.identifier}… ")
-
-        check = klass.create(@site)
-        check.run
-
-        checks << check
-        issues.merge(check.issues)
-
-        # TODO: report progress
-
-        puts check.issues.empty? ? 'ok'.green : 'error'.red
-      end
-      issues
-    end
-
-    def subject_to_s(str)
-      str || '(global)'
-    end
-
-    def print_issues(issues)
-      require 'colored'
-
-      return if issues.empty?
-
-      puts 'Issues found!'
-      issues.group_by(&:subject).to_a.sort_by { |s| subject_to_s(s.first) }.each do |pair|
-        subject = pair.first
-        issues  = pair.last
-        next if issues.empty?
-
-        puts "  #{subject_to_s(subject)}:"
-        issues.each do |i|
-          puts "    [ #{'ERROR'.red} ] #{i.check_class.identifier} - #{i.description}"
-        end
-      end
-    end
-  end
-end

data/lib/nanoc/deploying.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  # @api private
-  module Deploying
-  end
-end
-
-require 'nanoc/deploying/deployer'
-require 'nanoc/deploying/deployers'