nanoc 4.6.3 → 4.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2be981505c54e8c257e032a6bd08d7be8be95135
-  data.tar.gz: db527143c17a425809740641b4344b225c35fc43
+  metadata.gz: 45e73cb6f9f73af2a760146464d15b5537744e16
+  data.tar.gz: e5c219a107840118bb1fa45ba1396d302dbc5049
 SHA512:
-  metadata.gz: f1b3ed7df2c66ed6eab2b67081b1b828942fa5ce474e85d2c088dc6b439ccffbf36a1cedad89fef84334b2e5033ce561a98e1bc48b5f94f176358a9b913d1426
-  data.tar.gz: ad5c1d8f749f3b10f8167f4faa45a41cbcc18ba64ca2ad73220a4afc49f606399349de87d05599d462d4eebf819f5ead745e3c9c42883ba3b71bf2c2038b54e0
+  metadata.gz: 88453d81285519f1ee03821c835f9744096623f07a887f012dc66404bd68342429b211202cc9ec686b430da2d56ffbe2e6c23ec166fded484674512ab1c4c611
+  data.tar.gz: 39bb9372f9c71984af7726da2a1a2290dc85a89af3c7006073265d19620a4fb58f66616badd98ed97651a5006c71be82b0c9a00822727b91c94855cf368e3342

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/bbatsov/rubocop.git
-  revision: c52c7ea94d1d99f2d384f562b36dbed0f546f628
+  revision: 70f6d9191e2cc1d9726d4a4107f5efc5a797e310
   specs:
     rubocop (0.47.1)
       parser (>= 2.3.3.1, < 3.0)
@@ -27,7 +27,7 @@ GIT
 PATH
   remote: .
   specs:
-    nanoc (4.6.3)
+    nanoc (4.6.4)
       cri (~> 2.3)
       ddplugin (~> 1.0)
       hamster (~> 3.0)
@@ -246,7 +246,7 @@ GEM
     kramdown (1.13.2)
     less (2.6.0)
       commonjs (~> 0.2.7)
-    libv8 (3.16.14.17)
+    libv8 (3.16.14.19)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -342,7 +342,7 @@ GEM
     trollop (2.1.2)
     typogruby (1.0.18)
       rubypants
-    uglifier (3.1.3)
+    uglifier (3.1.5)
       execjs (>= 0.3.0, < 3)
     unicode-display_width (1.1.3)
     vcr (3.0.3)
@@ -425,4 +425,4 @@ DEPENDENCIES
   yuicompressor
 
 BUNDLED WITH
-   1.14.5
+   1.14.6

data/NEWS.md

@@ -1,5 +1,11 @@
 # Nanoc news
 
+## 4.6.4 (2017-03-10)
+
+Fixes:
+
+* Fixed issue where `compile --verbose` would show misleading timing information (#1113)
+
 ## 4.6.3 (2017-03-05)
 
 Fixes:

data/lib/nanoc.rb

@@ -45,6 +45,7 @@ require 'English'
 # Load Nanoc
 require 'nanoc/version'
 require 'nanoc/base'
+require 'nanoc/telemetry'
 require 'nanoc/checking'
 require 'nanoc/deploying'
 require 'nanoc/extra'

data/lib/nanoc/cli/commands/compile.rb

@@ -151,55 +151,36 @@ module Nanoc::CLI::Commands
 
       # @param [Enumerable<Nanoc::Int::ItemRep>] reps
       def initialize(reps:)
-        # rep ->
-        #   filter_name ->
-        #     accum -> 0.0
-        #     last_start -> nil
-        @times_per_rep = {}
-
         @reps = reps
       end
 
       # @see Listener#start
       def start
-        Nanoc::Int::NotificationCenter.on(:filtering_started) do |rep, filter_name|
-          @times_per_rep[rep] ||= {}
-          @times_per_rep[rep][filter_name] ||= {}
+        @telemetry = Nanoc::Telemetry.new
+
+        stopwatches = {}
 
-          @times_per_rep[rep][filter_name][:last_start] = Time.now
-          @times_per_rep[rep][filter_name][:accum] ||= []
-          @times_per_rep[rep][filter_name][:suspended] = false
+        Nanoc::Int::NotificationCenter.on(:filtering_started) do |rep, _filter_name|
+          stopwatch_stack = stopwatches.fetch(rep) { stopwatches[rep] = [] }
+          stopwatch_stack << Nanoc::Telemetry::Stopwatch.new
+          stopwatch_stack.last.start
         end
 
         Nanoc::Int::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
-          times = @times_per_rep[rep][filter_name]
-          last_start = @times_per_rep[rep][filter_name][:last_start]
+          stopwatch = stopwatches.fetch(rep).pop
+          stopwatch.stop
 
-          times[:accum] << (Time.now - last_start)
-          @times_per_rep[rep][filter_name].delete(:last_start)
+          @telemetry.summary(:filter_total).observe(stopwatch.duration, filter_name: filter_name)
         end
 
         Nanoc::Int::NotificationCenter.on(:compilation_suspended) do |rep, _exception|
-          @times_per_rep.fetch(rep, {}).each do |_filter_name, times|
-            if times[:last_start]
-              times[:accum] << (Time.now - times[:last_start])
-              times.delete(:last_start)
-              times[:suspended] = true
-
-              break
-            end
-          end
+          stopwatch = stopwatches.fetch(rep).last
+          stopwatch.stop if stopwatch && stopwatch.running?
         end
 
         Nanoc::Int::NotificationCenter.on(:compilation_started) do |rep|
-          @times_per_rep.fetch(rep, {}).each do |filter_name, times|
-            if times[:suspended]
-              @times_per_rep[rep][filter_name][:last_start] = Time.now
-              times[:suspended] = false
-
-              break
-            end
-          end
+          stopwatch = stopwatches.fetch(rep, []).last
+          stopwatch.start if stopwatch
         end
       end
 
@@ -214,25 +195,26 @@ module Nanoc::CLI::Commands
       def profiling_table
         headers = ['', 'count', 'min', 'avg', 'max', 'tot']
 
-        rows = durations_per_filter.to_a.sort_by { |r| r[1] }.map do |row|
-          filter_name, samples = *row
-          count = samples.size
-          min   = samples.min
-          tot   = samples.reduce(0, &:+)
-          avg   = tot / count
-          max   = samples.max
+        metric_set = @telemetry.summary(:filter_total)
+        rows = metric_set.labels.map do |label|
+          metric = metric_set.get(label)
+          filter_name = label[:filter_name].to_s
 
-          [filter_name.to_s, count.to_s] + [min, avg, max, tot].map { |r| "#{format('%4.2f', r)}s" }
+          count = metric.count
+          min   = metric.min
+          avg   = metric.avg
+          tot   = metric.sum
+          max   = metric.max
+
+          [filter_name, count.to_s] + [min, avg, max, tot].map { |r| "#{format('%4.2f', r)}s" }
         end
 
         [headers] + rows
       end
 
       def print_profiling_feedback
-        # Get max filter length
-        return if durations_per_filter.empty?
+        return if @telemetry.summary(:filter_total).labels.empty?
 
-        # Print warning if necessary
         if @reps.any? { |r| !r.compiled? }
           $stderr.puts
           $stderr.puts 'Warning: profiling information may not be accurate because ' \
@@ -248,7 +230,7 @@ module Nanoc::CLI::Commands
 
         print_row(table[0], lengths)
 
-        puts "#{'-' * lengths[0]}-+-#{lengths[1..-1].map { |length| '-' * length }.join('---')}"
+        puts "#{'─' * lengths[0]}─┼─#{lengths[1..-1].map { |length| '─' * length }.join('───')}"
 
         table[1..-1].each { |row| print_row(row, lengths) }
       end
@@ -256,22 +238,7 @@ module Nanoc::CLI::Commands
       def print_row(row, lengths)
         values = row.zip(lengths).map { |text, length| text.rjust length }
 
-        puts values[0] + ' | ' + values[1..-1].join('   ')
-      end
-
-      def durations_per_filter
-        @_durations_per_filter ||= begin
-          result = {}
-
-          @times_per_rep.each do |_rep, times_per_filter|
-            times_per_filter.each do |filter_name, data|
-              result[filter_name] ||= []
-              result[filter_name].concat(data[:accum])
-            end
-          end
-
-          result
-        end
+        puts values[0] + ' │ ' + values[1..-1].join('   ')
       end
     end
 

data/lib/nanoc/cli/stream_cleaners/utf8.rb

@@ -6,7 +6,7 @@ module Nanoc::CLI::StreamCleaners
     # @see Nanoc::CLI::StreamCleaners::Abstract#clean
     def clean(s)
       # FIXME: this decomposition is not generally usable
-      s.gsub(/“|”/, '"').gsub(/‘|’/, '\'').gsub('…', '...').gsub('©', '(c)')
+      s.tr('─┼“”‘’', '-+""\'\'').gsub('…', '...').gsub('©', '(c)')
     end
   end
 end

data/lib/nanoc/spec.rb

@@ -32,7 +32,7 @@ module Nanoc
       def create_item(content, attributes, identifier)
         item = Nanoc::Int::Item.new(content, attributes, identifier)
         @items = @items.add(item)
-        Nanoc::ItemWithRepsView.new(item, view_context)
+        self
       end
 
       # Creates a new layout and adds it to the site’s collection of layouts.
@@ -47,7 +47,7 @@ module Nanoc
       def create_layout(content, attributes, identifier)
         layout = Nanoc::Int::Layout.new(content, attributes, identifier)
         @layouts = @layouts.add(layout)
-        Nanoc::LayoutView.new(layout, view_context)
+        self
       end
 
       # Creates a new representation for the given item.
@@ -60,7 +60,7 @@ module Nanoc
         rep = Nanoc::Int::ItemRep.new(item.unwrap, rep)
         rep.paths[:last] = [path]
         @reps << rep
-        Nanoc::ItemRepView.new(rep, view_context)
+        self
       end
 
       # @return [Object] An object that includes the helper functions

data/lib/nanoc/telemetry.rb

@@ -0,0 +1,17 @@
+module Nanoc
+  # @api private
+  module Telemetry
+    def self.new
+      Registry.new
+    end
+  end
+end
+
+require_relative 'telemetry/counter'
+require_relative 'telemetry/summary'
+
+require_relative 'telemetry/labelled_counter'
+require_relative 'telemetry/labelled_summary'
+
+require_relative 'telemetry/registry'
+require_relative 'telemetry/stopwatch'

data/lib/nanoc/telemetry/counter.rb

@@ -0,0 +1,13 @@
+module Nanoc::Telemetry
+  class Counter
+    attr_reader :value
+
+    def initialize
+      @value = 0
+    end
+
+    def increment
+      @value += 1
+    end
+  end
+end

data/lib/nanoc/telemetry/labelled_counter.rb

@@ -0,0 +1,27 @@
+module Nanoc::Telemetry
+  class LabelledCounter
+    def initialize
+      @counters = {}
+    end
+
+    def increment(labels)
+      get(labels).increment
+    end
+
+    def get(labels)
+      @counters.fetch(labels) { @counters[labels] = Counter.new }
+    end
+
+    # TODO: add #labels
+
+    def value(labels)
+      get(labels).value
+    end
+
+    def values
+      @counters.each_with_object({}) do |(labels, counter), res|
+        res[labels] = counter.value
+      end
+    end
+  end
+end

data/lib/nanoc/telemetry/labelled_summary.rb

@@ -0,0 +1,31 @@
+module Nanoc::Telemetry
+  class LabelledSummary
+    def initialize
+      @summaries = {}
+    end
+
+    def observe(value, labels)
+      get(labels).observe(value)
+    end
+
+    def get(labels)
+      @summaries.fetch(labels) { @summaries[labels] = Summary.new }
+    end
+
+    def labels
+      @summaries.keys
+    end
+
+    def quantile(fraction, labels)
+      get(labels).quantile(fraction)
+    end
+
+    # TODO: add quantiles(fraction)
+    # TODO: add min(labels)
+    # TODO: add mins
+    # TODO: add max(labels)
+    # TODO: add maxs
+    # TODO: add sum(labels)
+    # TODO: add sums
+  end
+end

data/lib/nanoc/telemetry/registry.rb

@@ -0,0 +1,16 @@
+module Nanoc::Telemetry
+  class Registry
+    def initialize
+      @counters = {}
+      @summaries = {}
+    end
+
+    def counter(name)
+      @counters.fetch(name) { @counters[name] = LabelledCounter.new }
+    end
+
+    def summary(name)
+      @summaries.fetch(name) { @summaries[name] = LabelledSummary.new }
+    end
+  end
+end

data/lib/nanoc/telemetry/stopwatch.rb

@@ -0,0 +1,41 @@
+module Nanoc::Telemetry
+  class Stopwatch
+    attr_reader :duration
+
+    class AlreadyRunningError < StandardError
+      def message
+        'Cannot start, because stopwatch is already running'
+      end
+    end
+
+    class NotRunningError < StandardError
+      def message
+        'Cannot stop, because stopwatch is not running'
+      end
+    end
+
+    def initialize
+      @duration = 0.0
+      @last_start = nil
+    end
+
+    def start
+      raise AlreadyRunningError if running?
+      @last_start = Time.now
+    end
+
+    def stop
+      raise NotRunningError unless running?
+      @duration += (Time.now - @last_start)
+      @last_start = nil
+    end
+
+    def running?
+      !@last_start.nil?
+    end
+
+    def stopped?
+      !running?
+    end
+  end
+end

data/lib/nanoc/telemetry/summary.rb

@@ -0,0 +1,53 @@
+module Nanoc::Telemetry
+  class Summary
+    class EmptySummaryError < StandardError
+      def message
+        'Cannot calculate quantile for empty summary'
+      end
+    end
+
+    def initialize
+      @values = []
+    end
+
+    def observe(value)
+      @values << value
+      @sorted_values = nil
+    end
+
+    def count
+      @values.size
+    end
+
+    def sum
+      raise EmptySummaryError if @values.empty?
+      @values.reduce(:+)
+    end
+
+    def avg
+      sum / count
+    end
+
+    def min
+      quantile(0.0)
+    end
+
+    def max
+      quantile(1.0)
+    end
+
+    def quantile(fraction)
+      raise EmptySummaryError if @values.empty?
+
+      target = (@values.size - 1) * fraction.to_f
+      interp = target % 1.0
+      sorted_values[target.floor] * (1.0 - interp) + sorted_values[target.ceil] * interp
+    end
+
+    private
+
+    def sorted_values
+      @sorted_values ||= @values.sort
+    end
+  end
+end