nanoc 4.11.12 → 4.11.13

data/lib/nanoc/cli/commands/compile_listeners/diff_generator.rb

@@ -1,101 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::CLI::Commands::CompileListeners
-  class DiffGenerator < Abstract
-    class Differ
-      def initialize(path, str_a, str_b)
-        @path = path
-        @str_a = str_a
-        @str_b = str_b
-      end
-
-      def call
-        run
-      end
-
-      private
-
-      def run
-        lines_a = @str_a.lines.map(&:chomp)
-        lines_b = @str_b.lines.map(&:chomp)
-
-        diffs = Diff::LCS.diff(lines_a, lines_b)
-
-        output = +''
-        output << "--- #{@path}\n"
-        output << "+++ #{@path}\n"
-
-        prev_hunk = hunk = nil
-        file_length_difference = 0
-        diffs.each do |piece|
-          begin
-            hunk = Diff::LCS::Hunk.new(lines_a, lines_b, piece, 3, file_length_difference)
-            file_length_difference = hunk.file_length_difference
-
-            next unless prev_hunk
-            next if hunk.merge(prev_hunk)
-
-            output << prev_hunk.diff(:unified) << "\n"
-          ensure
-            prev_hunk = hunk
-          end
-        end
-        last = prev_hunk.diff(:unified)
-        output << last << "\n"
-
-        output
-      end
-    end
-
-    # @see Listener#enable_for?
-    def self.enable_for?(command_runner, site)
-      site.config[:enable_output_diff] || command_runner.options[:diff]
-    end
-
-    # @see Listener#start
-    def start
-      setup_diffs
-
-      on(:rep_ready_for_diff) do |raw_path, old_content, new_content|
-        generate_diff_for(raw_path, old_content, new_content)
-      end
-    end
-
-    # @see Listener#stop
-    def stop
-      teardown_diffs
-    end
-
-    protected
-
-    def setup_diffs
-      @diff_lock    = Mutex.new
-      @diff_threads = []
-      FileUtils.rm('output.diff') if File.file?('output.diff')
-    end
-
-    def teardown_diffs
-      @diff_threads.each(&:join)
-    end
-
-    def generate_diff_for(path, old_content, new_content)
-      return if old_content == new_content
-
-      @diff_threads << Thread.new do
-        # Simplify path
-        # FIXME: do not depend on working directory
-        if path.start_with?(Dir.getwd)
-          path = path[(Dir.getwd.size + 1)..path.size]
-        end
-
-        # Generate diff
-        diff = Differ.new(path, old_content, new_content).call
-
-        # Write diff
-        @diff_lock.synchronize do
-          File.open('output.diff', 'a') { |io| io.write(diff) }
-        end
-      end
-    end
-  end
-end

data/lib/nanoc/cli/commands/compile_listeners/file_action_printer.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::CLI::Commands::CompileListeners
-  class FileActionPrinter < Abstract
-    def initialize(reps:)
-      @reps = reps
-
-      @stopwatches = {}
-    end
-
-    # @see Listener#start
-    def start
-      on(:compilation_started) do |rep|
-        @stopwatches[rep] ||= DDMetrics::Stopwatch.new
-        @stopwatches[rep].start
-      end
-
-      on(:compilation_suspended) do |rep|
-        @stopwatches[rep].stop
-      end
-
-      cached_reps = Set.new
-      on(:cached_content_used) do |rep|
-        cached_reps << rep
-      end
-
-      on(:rep_write_enqueued) do |rep|
-        @stopwatches[rep].stop
-      end
-
-      on(:rep_write_started) do |rep, _raw_path|
-        @stopwatches[rep].start
-      end
-
-      on(:rep_write_ended) do |rep, _binary, path, is_created, is_modified|
-        @stopwatches[rep].stop
-        duration = @stopwatches[rep].duration
-
-        action =
-          if is_created then :create
-          elsif is_modified then :update
-          elsif cached_reps.include?(rep) then :cached
-          else :identical
-          end
-        level =
-          if is_created then :high
-          elsif is_modified then :high
-          else :low
-          end
-
-        # FIXME: do not depend on working directory
-        if path.start_with?(Dir.getwd)
-          path = path[(Dir.getwd.size + 1)..path.size]
-        end
-
-        log(level, action, path, duration)
-      end
-    end
-
-    # @see Listener#stop
-    def stop
-      @reps.reject(&:compiled?).each do |rep|
-        raw_paths = rep.raw_paths.values.flatten.uniq
-        raw_paths.each do |raw_path|
-          log(:low, :skip, raw_path, nil)
-        end
-      end
-    end
-
-    private
-
-    def log(level, action, path, duration)
-      Nanoc::CLI::Logger.instance.file(level, action, path, duration)
-    end
-  end
-end

data/lib/nanoc/cli/commands/compile_listeners/timing_recorder.rb

@@ -1,170 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::CLI::Commands::CompileListeners
-  class TimingRecorder < Abstract
-    attr_reader :stages_summary
-    attr_reader :phases_summary
-    attr_reader :outdatedness_rules_summary
-    attr_reader :filters_summary
-
-    # @see Listener#enable_for?
-    def self.enable_for?(_command_runner, _site)
-      Nanoc::CLI.verbosity >= 1
-    end
-
-    # @param [Enumerable<Nanoc::Core::ItemRep>] reps
-    def initialize(reps:)
-      @reps = reps
-
-      @stages_summary = DDMetrics::Summary.new
-      @phases_summary = DDMetrics::Summary.new
-      @outdatedness_rules_summary = DDMetrics::Summary.new
-      @filters_summary = DDMetrics::Summary.new
-      @load_stores_summary = DDMetrics::Summary.new
-    end
-
-    # @see Listener#start
-    def start
-      on(:stage_ran) do |duration, klass|
-        @stages_summary.observe(duration, name: klass.to_s.sub(/.*::/, ''))
-      end
-
-      on(:outdatedness_rule_ran) do |duration, klass|
-        @outdatedness_rules_summary.observe(duration, name: klass.to_s.sub(/.*::/, ''))
-      end
-
-      filter_stopwatches = {}
-
-      on(:filtering_started) do |rep, _filter_name|
-        stopwatch_stack = filter_stopwatches.fetch(rep) { filter_stopwatches[rep] = [] }
-        stopwatch_stack << DDMetrics::Stopwatch.new
-        stopwatch_stack.last.start
-      end
-
-      on(:filtering_ended) do |rep, filter_name|
-        stopwatch = filter_stopwatches.fetch(rep).pop
-        stopwatch.stop
-
-        @filters_summary.observe(stopwatch.duration, name: filter_name.to_s)
-      end
-
-      on(:store_loaded) do |duration, klass|
-        @load_stores_summary.observe(duration, name: klass.to_s)
-      end
-
-      on(:compilation_suspended) do |rep, _target_rep, _snapshot_name|
-        filter_stopwatches.fetch(rep).each(&:stop)
-      end
-
-      on(:compilation_started) do |rep|
-        filter_stopwatches.fetch(rep, []).each(&:start)
-      end
-
-      setup_phase_notifications
-    end
-
-    # @see Listener#stop
-    def stop
-      print_profiling_feedback
-    end
-
-    protected
-
-    def setup_phase_notifications
-      stopwatches = {}
-
-      on(:phase_started) do |phase_name, rep|
-        stopwatch = stopwatches[[phase_name, rep]] = DDMetrics::Stopwatch.new
-        stopwatch.start
-      end
-
-      on(:phase_ended) do |phase_name, rep|
-        stopwatch = stopwatches[[phase_name, rep]]
-        stopwatch.stop
-
-        @phases_summary.observe(stopwatch.duration, name: phase_name)
-      end
-
-      on(:phase_yielded) do |phase_name, rep|
-        stopwatch = stopwatches[[phase_name, rep]]
-        stopwatch.stop
-      end
-
-      on(:phase_resumed) do |phase_name, rep|
-        # It probably looks weird that a phase can be resumed even though it was not suspended earlier. This can happen when compilation is suspended, where you’d get the sequence started -> suspended -> started -> resumed.
-        stopwatch = stopwatches[[phase_name, rep]]
-        stopwatch.start unless stopwatch.running?
-      end
-
-      on(:phase_aborted) do |phase_name, rep|
-        stopwatch = stopwatches[[phase_name, rep]]
-        stopwatch.stop if stopwatch.running?
-
-        @phases_summary.observe(stopwatch.duration, name: phase_name)
-      end
-    end
-
-    def table_for_summary(name, summary)
-      headers = [name.to_s, 'count', 'min', '.50', '.90', '.95', 'max', 'tot']
-
-      rows = summary.map do |label, stats|
-        name = label.fetch(:name)
-
-        count = stats.count
-        min   = stats.min
-        p50   = stats.quantile(0.50)
-        p90   = stats.quantile(0.90)
-        p95   = stats.quantile(0.95)
-        tot   = stats.sum
-        max   = stats.max
-
-        [name, count.to_s] + [min, p50, p90, p95, max, tot].map { |r| "#{format('%4.2f', r)}s" }
-      end
-
-      [headers] + rows
-    end
-
-    def table_for_summary_durations(name, summary)
-      headers = [name.to_s, 'tot']
-
-      rows = summary.map do |label, stats|
-        name = label.fetch(:name)
-        [name, "#{format('%4.2f', stats.sum)}s"]
-      end
-
-      [headers] + rows
-    end
-
-    def print_profiling_feedback
-      print_table_for_summary(:filters, @filters_summary)
-      print_table_for_summary(:phases, @phases_summary) if Nanoc::CLI.verbosity >= 2
-      print_table_for_summary_duration(:stages, @stages_summary) if Nanoc::CLI.verbosity >= 2
-      print_table_for_summary(:outdatedness_rules, @outdatedness_rules_summary) if Nanoc::CLI.verbosity >= 2
-      print_table_for_summary_duration(:load_stores, @load_stores_summary) if Nanoc::CLI.verbosity >= 2
-      print_ddmemoize_metrics if Nanoc::CLI.verbosity >= 2
-    end
-
-    def print_table_for_summary(name, summary)
-      return unless summary.any?
-
-      puts
-      print_table(table_for_summary(name, summary))
-    end
-
-    def print_table_for_summary_duration(name, summary)
-      return unless summary.any?
-
-      puts
-      print_table(table_for_summary_durations(name, summary))
-    end
-
-    def print_ddmemoize_metrics
-      puts
-      DDMemoize.print_metrics
-    end
-
-    def print_table(rows)
-      puts DDMetrics::Table.new(rows).to_s
-    end
-  end
-end

data/lib/nanoc/cli/commands/create-site.rb

@@ -1,257 +0,0 @@
-# frozen_string_literal: true
-
-usage 'create-site [options] path'
-aliases :create_site, :cs
-summary 'create a site'
-description 'Create a new site at the given path. The site will use the `filesystem` data source.'
-flag nil, :force, 'force creation of new site'
-param :path
-
-module Nanoc::CLI::Commands
-  class CreateSite < ::Nanoc::CLI::CommandRunner
-    class << self
-      protected
-
-      # Converts the given array to YAML format
-      def array_to_yaml(array)
-        '[ ' + array.map { |s| "'" + s + "'" }.join(', ') + ' ]'
-      end
-    end
-
-    DEFAULT_CONFIG = <<~EOS unless defined? DEFAULT_CONFIG
-      # A list of file extensions that Nanoc will consider to be textual rather than
-      # binary. If an item with an extension not in this list is found,  the file
-      # will be considered as binary.
-      text_extensions: #{array_to_yaml(Nanoc::Core::Configuration::DEFAULT_CONFIG[:text_extensions])}
-
-      prune:
-        auto_prune: true
-
-      data_sources:
-        - type: filesystem
-          encoding: utf-8
-    EOS
-
-    DEFAULT_RULES = <<~EOS unless defined? DEFAULT_RULES
-      #!/usr/bin/env ruby
-
-      compile '/index.html' do
-        layout '/default.*'
-        write '/index.html'
-      end
-
-      compile '/**/*.html' do
-        layout '/default.*'
-        write item.identifier.without_ext + '/index.html'
-      end
-
-      # This is an example rule that matches Markdown (.md) files, and filters them
-      # using the :kramdown filter. It is commented out by default, because kramdown
-      # is not bundled with Nanoc or Ruby.
-      #
-      #compile '/**/*.md' do
-      #  filter :kramdown
-      #  layout '/default.*'
-      #  write item.identifier.without_ext + '/index.html'
-      #end
-
-      compile '/**/*' do
-        write item.identifier.to_s
-      end
-
-      layout '/**/*', :erb
-    EOS
-
-    DEFAULT_ITEM = <<~EOS unless defined? DEFAULT_ITEM
-      ---
-      title: Home
-      ---
-
-      <h1>A Brand New Nanoc Site</h1>
-
-      <p>You’ve just created a new Nanoc site. The page you are looking at right now is the home page for your site. To get started, consider replacing this default homepage with your own customized homepage. Some pointers on how to do so:</p>
-
-      <ul>
-        <li><p><strong>Change this page’s content</strong> by editing the “index.html” file in the “content” directory. This is the actual page content, and therefore doesn’t include the header, sidebar or style information (those are part of the layout).</p></li>
-        <li><p><strong>Change the layout</strong>, which is the “default.html” file in the “layouts” directory, and create something unique (and hopefully less bland).</p></li>
-      </ul>
-
-      <p>If you need any help with customizing your Nanoc web site, be sure to check out the documentation (see sidebar), and be sure to subscribe to the discussion group (also see sidebar). Enjoy!</p>
-    EOS
-
-    DEFAULT_STYLESHEET = <<~EOS unless defined? DEFAULT_STYLESHEET
-      * {
-        margin: 0;
-        padding: 0;
-
-        font-family: Georgia, Palatino, serif;
-      }
-
-      body {
-        background: #fff;
-      }
-
-      a {
-        text-decoration: none;
-      }
-
-      a:link,
-      a:visited {
-        color: #f30;
-      }
-
-      a:hover {
-        color: #f90;
-      }
-
-      #main {
-        position: absolute;
-
-        top: 40px;
-        left: 280px;
-
-        width: 500px;
-      }
-
-      #main h1 {
-        font-size: 40px;
-        font-weight: normal;
-
-        line-height: 40px;
-
-        letter-spacing: -1px;
-      }
-
-      #main p {
-        margin: 20px 0;
-
-        font-size: 15px;
-
-        line-height: 20px;
-      }
-
-      #main ul, #main ol {
-        margin: 20px;
-      }
-
-      #main li {
-        font-size: 15px;
-
-        line-height: 20px;
-      }
-
-      #main ul li {
-        list-style-type: square;
-      }
-
-      #sidebar {
-        position: absolute;
-
-        top: 40px;
-        left: 20px;
-        width: 200px;
-
-        padding: 20px 20px 0 0;
-
-        border-right: 1px solid #ccc;
-
-        text-align: right;
-      }
-
-      #sidebar h2 {
-        text-transform: uppercase;
-
-        font-size: 13px;
-
-        color: #333;
-
-        letter-spacing: 1px;
-
-        line-height: 20px;
-      }
-
-      #sidebar ul {
-        list-style-type: none;
-
-        margin: 20px 0;
-      }
-
-      #sidebar li {
-        font-size: 14px;
-
-        line-height: 20px;
-      }
-    EOS
-
-    DEFAULT_LAYOUT = <<~EOS unless defined? DEFAULT_LAYOUT
-      <!DOCTYPE HTML>
-      <html lang="en">
-        <head>
-          <meta charset="utf-8">
-          <title>A Brand New Nanoc Site - <%= @item[:title] %></title>
-          <link rel="stylesheet" href="/stylesheet.css">
-
-          <!-- you don't need to keep this, but it's cool for stats! -->
-          <meta name="generator" content="Nanoc <%= Nanoc::VERSION %>">
-        </head>
-        <body>
-          <div id="main">
-            <%= yield %>
-          </div>
-          <div id="sidebar">
-            <h2>Documentation</h2>
-            <ul>
-              <li><a href="https://nanoc.ws/doc/">Documentation</a></li>
-              <li><a href="https://nanoc.ws/doc/tutorial/">Tutorial</a></li>
-            </ul>
-            <h2>Community</h2>
-            <ul>
-              <li><a href="http://groups.google.com/group/nanoc/">Discussion group</a></li>
-              <li><a href="https://gitter.im/nanoc/nanoc">Gitter channel</a></li>
-              <li><a href="https://nanoc.ws/contributing/">Contributing</a></li>
-            </ul>
-          </div>
-        </body>
-      </html>
-    EOS
-
-    def run
-      path = arguments[:path]
-
-      # Check whether site exists
-      if File.exist?(path) && (!File.directory?(path) || !(Dir.entries(path) - %w[. ..]).empty?) && !options[:force]
-        raise(
-          Nanoc::Int::Errors::GenericTrivial,
-          "The site was not created because '#{path}' already exists. " \
-          'Re-run the command using --force to create the site anyway.',
-        )
-      end
-
-      # Build entire site
-      FileUtils.mkdir_p(path)
-      FileUtils.cd(File.join(path)) do
-        FileUtils.mkdir_p('content')
-        FileUtils.mkdir_p('layouts')
-        FileUtils.mkdir_p('lib')
-        FileUtils.mkdir_p('output')
-
-        write('nanoc.yaml', DEFAULT_CONFIG)
-        write('Rules', DEFAULT_RULES)
-        write('content/index.html', DEFAULT_ITEM)
-        write('content/stylesheet.css', DEFAULT_STYLESHEET)
-        write('layouts/default.html', DEFAULT_LAYOUT)
-      end
-
-      puts "Created a blank Nanoc site at '#{path}'. Enjoy!"
-    end
-
-    private
-
-    def write(filename, content)
-      File.write(filename, content)
-      Nanoc::CLI::Logger.instance.file(:high, :create, filename)
-    end
-  end
-end
-
-runner Nanoc::CLI::Commands::CreateSite