nanoc 4.6.4 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45e73cb6f9f73af2a760146464d15b5537744e16
-  data.tar.gz: e5c219a107840118bb1fa45ba1396d302dbc5049
+  metadata.gz: a139ed28840cdd9e8d815959a6ce67a2a3d64629
+  data.tar.gz: 443fad3be7c31740a6b0378e37b358355f4cf451
 SHA512:
-  metadata.gz: 88453d81285519f1ee03821c835f9744096623f07a887f012dc66404bd68342429b211202cc9ec686b430da2d56ffbe2e6c23ec166fded484674512ab1c4c611
-  data.tar.gz: 39bb9372f9c71984af7726da2a1a2290dc85a89af3c7006073265d19620a4fb58f66616badd98ed97651a5006c71be82b0c9a00822727b91c94855cf368e3342
+  metadata.gz: 54e42408687a77e4775218127f65e92780702969c3f18e8d4dbd723b7428d6f0a8eec603545ab092f69de699af67af0861ae690b142b5e9314ac4c893ef8830b
+  data.tar.gz: 66dc4eb54985f21f9a6614b366fbcd4b0dc4b8e3dc3cd4fe0e7b6f5c3497432f91e0221e3868cf8c2a2bb60df04dd18d8a0909508e3ef6aad2a15e45ef2cf8f2

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :devel do
+  gem 'codecov', require: false
   gem 'contracts', '~> 0.14'
   gem 'coveralls', require: false
   gem 'fuubar'
@@ -34,6 +35,7 @@ group :plugins do
   gem 'coderay'
   gem 'coffee-script'
   gem 'compass'
+  gem 'erubi'
   gem 'erubis'
   gem 'fog'
   gem 'haml'

data/Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/bbatsov/rubocop.git
-  revision: 70f6d9191e2cc1d9726d4a4107f5efc5a797e310
+  revision: 7623afc89d97b6149067428e1cb8d69a1786d0b3
   specs:
     rubocop (0.47.1)
       parser (>= 2.3.3.1, < 3.0)
@@ -27,7 +27,7 @@ GIT
 PATH
   remote: .
   specs:
-    nanoc (4.6.4)
+    nanoc (4.7.0)
       cri (~> 2.3)
       ddplugin (~> 1.0)
       hamster (~> 3.0)
@@ -50,6 +50,10 @@ GEM
     bluecloth (2.2.0)
     builder (3.2.3)
     chunky_png (1.3.8)
+    codecov (0.1.10)
+      json
+      simplecov
+      url
     coderay (1.1.1)
     coffee-script (2.4.1)
       coffee-script-source
@@ -84,6 +88,7 @@ GEM
     ddplugin (1.0.1)
     diff-lcs (1.3)
     docile (1.1.5)
+    erubi (1.6.0)
     erubis (2.7.0)
     excon (0.55.0)
     execjs (2.7.0)
@@ -291,7 +296,7 @@ GEM
     rb-fsevent (0.9.8)
     rb-inotify (0.9.8)
       ffi (>= 0.5.0)
-    rbvmomi (1.9.5)
+    rbvmomi (1.10.0)
       builder (~> 3.0)
       json (>= 1.8)
       nokogiri (~> 1.5)
@@ -342,9 +347,10 @@ GEM
     trollop (2.1.2)
     typogruby (1.0.18)
       rubypants
-    uglifier (3.1.5)
+    uglifier (3.1.7)
       execjs (>= 0.3.0, < 3)
     unicode-display_width (1.1.3)
+    url (0.3.2)
     vcr (3.0.3)
     w3c_validators (1.3.2)
       json (>= 1.8)
@@ -370,11 +376,13 @@ DEPENDENCIES
   bluecloth
   builder
   bundler (>= 1.7.10, < 2.0)
+  codecov
   coderay
   coffee-script
   compass
   contracts (~> 0.14)
   coveralls
+  erubi
   erubis
   fog
   fuubar

data/NEWS.md

@@ -1,5 +1,12 @@
 # Nanoc news
 
+## 4.7 (2017-03-15)
+
+Features:
+
+* Added `:erubi` filter (#1103)
+* Added `write ext: 'something'` shortcut (#1079)
+
 ## 4.6.4 (2017-03-10)
 
 Fixes:

data/README.md

@@ -1,7 +1,7 @@
 [![Gem version](http://img.shields.io/gem/v/nanoc.svg)](http://rubygems.org/gems/nanoc)
 [![Build status](http://img.shields.io/travis/nanoc/nanoc.svg)](https://travis-ci.org/nanoc/nanoc)
 [![Code Climate](http://img.shields.io/codeclimate/github/nanoc/nanoc.svg)](https://codeclimate.com/github/nanoc/nanoc)
-[![Code Coverage](http://img.shields.io/coveralls/nanoc/nanoc.svg)](https://coveralls.io/r/nanoc/nanoc)
+[![Code Coverage](https://img.shields.io/codecov/c/github/nanoc/nanoc.svg)](https://codecov.io/gh/nanoc/nanoc)
 
 ![Nanoc logo](https://avatars1.githubusercontent.com/u/3260163?s=140)
 

data/lib/nanoc/base/feature.rb

@@ -89,4 +89,4 @@ module Nanoc
   end
 end
 
-Nanoc::Feature.define('profiler', version: '4.6')
+Nanoc::Feature.define('profiler', version: '4.7')

data/lib/nanoc/base/services/compiler.rb

@@ -121,18 +121,18 @@ module Nanoc::Int
     end
 
     def run_all
-      preprocess_stage.run
-      build_reps
-      prune_stage.run
-      load_stores
-      determine_outdatedness
-      forget_dependencies_if_needed
-      store
-      compile_reps_stage.run
-      store_output_state
-      @action_provider.postprocess(@site, @reps)
+      time_stage(:preprocess) { preprocess_stage.run }
+      time_stage(:build_reps) { build_reps }
+      time_stage(:prune) { prune_stage.run }
+      time_stage(:load_stores) { load_stores }
+      time_stage(:determine_outdatedness) { determine_outdatedness }
+      time_stage(:forget_dependencies_if_needed) { forget_dependencies_if_needed }
+      time_stage(:store) { store }
+      time_stage(:compile_reps) { compile_reps_stage.run }
+      time_stage(:store_output_state) { store_output_state }
+      time_stage(:postprocess) { @action_provider.postprocess(@site, @reps) }
     ensure
-      cleanup_stage.run
+      time_stage(:cleanup) { cleanup_stage.run }
     end
 
     def load_stores
@@ -179,6 +179,13 @@ module Nanoc::Int
 
     private
 
+    def time_stage(name)
+      Nanoc::Int::NotificationCenter.post(:stage_started, name)
+      yield
+    ensure
+      Nanoc::Int::NotificationCenter.post(:stage_ended, name)
+    end
+
     def preprocess_stage
       @_preprocess_stage ||= Stages::Preprocess.new(
         action_provider: action_provider,

data/lib/nanoc/base/services/compiler/phases.rb

@@ -1,6 +1,8 @@
 module Nanoc::Int::Compiler::Phases
 end
 
+require_relative 'phases/abstract'
+
 require_relative 'phases/recalculate'
 require_relative 'phases/cache'
 require_relative 'phases/resume'

data/lib/nanoc/base/services/compiler/phases/abstract.rb

@@ -0,0 +1,34 @@
+module Nanoc::Int::Compiler::Phases
+  class Abstract
+    include Nanoc::Int::ContractsSupport
+
+    def initialize(wrapped:, name:)
+      @name = name
+      @wrapped = wrapped
+    end
+
+    def call(rep, is_outdated:)
+      notify(:phase_started, rep)
+      run(rep, is_outdated: is_outdated) do
+        notify(:phase_yielded, rep)
+        @wrapped.call(rep, is_outdated: is_outdated)
+        notify(:phase_resumed, rep)
+      end
+      notify(:phase_ended, rep)
+    rescue
+      notify(:phase_aborted, rep)
+      raise
+    end
+
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool], C::Func[C::None => C::Any] => C::Any
+    def run(_rep, is_outdated:) # rubocop:disable Lint/UnusedMethodArgument
+      raise NotImplementedError
+    end
+
+    private
+
+    def notify(sym, rep)
+      Nanoc::Int::NotificationCenter.post(sym, @name, rep)
+    end
+  end
+end

data/lib/nanoc/base/services/compiler/phases/cache.rb

@@ -1,23 +1,26 @@
 module Nanoc::Int::Compiler::Phases
   # Provides functionality for (re)calculating the content of an item rep, with caching or
   # outdatedness checking. Delegates to s::Recalculate if outdated or no cache available.
-  class Cache
+  class Cache < Abstract
     include Nanoc::Int::ContractsSupport
 
-    def initialize(compiled_content_cache:, snapshot_repo:, wrapped:)
+    NAME = 'cache'.freeze
+
+    def initialize(wrapped:, compiled_content_cache:, snapshot_repo:)
+      super(wrapped: wrapped, name: NAME)
+
       @compiled_content_cache = compiled_content_cache
       @snapshot_repo = snapshot_repo
-      @wrapped = wrapped
     end
 
-    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Any
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool], C::Func[C::None => C::Any] => C::Any
     def run(rep, is_outdated:)
       if can_reuse_content_for_rep?(rep, is_outdated: is_outdated)
         Nanoc::Int::NotificationCenter.post(:cached_content_used, rep)
 
         @snapshot_repo.set_all(rep, @compiled_content_cache[rep])
       else
-        @wrapped.run(rep, is_outdated: is_outdated)
+        yield
       end
 
       rep.compiled = true

data/lib/nanoc/base/services/compiler/phases/mark_done.rb

@@ -1,15 +1,18 @@
 module Nanoc::Int::Compiler::Phases
-  class MarkDone
+  class MarkDone < Abstract
     include Nanoc::Int::ContractsSupport
 
+    NAME = 'mark_done'.freeze
+
     def initialize(wrapped:, outdatedness_store:)
-      @wrapped = wrapped
+      super(wrapped: wrapped, name: NAME)
+
       @outdatedness_store = outdatedness_store
     end
 
-    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Any
-    def run(rep, is_outdated:)
-      @wrapped.run(rep, is_outdated: is_outdated)
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool], C::Func[C::None => C::Any] => C::Any
+    def run(rep, is_outdated:) # rubocop:disable Lint/UnusedMethodArgument
+      yield
       @outdatedness_store.remove(rep)
     end
   end

data/lib/nanoc/base/services/compiler/phases/recalculate.rb

@@ -1,16 +1,20 @@
 module Nanoc::Int::Compiler::Phases
   # Provides functionality for (re)calculating the content of an item rep, without caching or
   # outdatedness checking.
-  class Recalculate
+  class Recalculate < Abstract
     include Nanoc::Int::ContractsSupport
 
+    NAME = 'recalculate'.freeze
+
     def initialize(action_provider:, dependency_store:, compilation_context:)
+      super(wrapped: nil, name: NAME)
+
       @action_provider = action_provider
       @dependency_store = dependency_store
       @compilation_context = compilation_context
     end
 
-    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Any
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool], C::Func[C::None => C::Any] => C::Any
     def run(rep, is_outdated:) # rubocop:disable Lint/UnusedMethodArgument
       dependency_tracker = Nanoc::Int::DependencyTracker.new(@dependency_store)
       dependency_tracker.enter(rep.item)

data/lib/nanoc/base/services/compiler/phases/resume.rb

@@ -1,15 +1,17 @@
 module Nanoc::Int::Compiler::Phases
   # Provides functionality for suspending and resuming item rep compilation (using fibers).
-  class Resume
+  class Resume < Abstract
     include Nanoc::Int::ContractsSupport
 
+    NAME = 'resume'.freeze
+
     def initialize(wrapped:)
-      @wrapped = wrapped
+      super(wrapped: wrapped, name: NAME)
     end
 
-    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Any
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool], C::Func[C::None => C::Any] => C::Any
     def run(rep, is_outdated:)
-      fiber = fiber_for(rep, is_outdated: is_outdated)
+      fiber = fiber_for(rep, is_outdated: is_outdated) { yield }
       while fiber.alive?
         Nanoc::Int::NotificationCenter.post(:compilation_started, rep)
         res = fiber.resume
@@ -30,13 +32,13 @@ module Nanoc::Int::Compiler::Phases
 
     private
 
-    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => Fiber
-    def fiber_for(rep, is_outdated:)
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool], C::Func[C::None => C::Any] => Fiber
+    def fiber_for(rep, is_outdated:) # rubocop:disable Lint/UnusedMethodArgument
       @fibers ||= {}
 
       @fibers[rep] ||=
         Fiber.new do
-          @wrapped.run(rep, is_outdated: is_outdated)
+          yield
           @fibers.delete(rep)
         end
 

data/lib/nanoc/base/services/compiler/phases/write.rb

@@ -1,15 +1,18 @@
 module Nanoc::Int::Compiler::Phases
-  class Write
+  class Write < Abstract
     include Nanoc::Int::ContractsSupport
 
+    NAME = 'write'.freeze
+
     def initialize(snapshot_repo:, wrapped:)
+      super(wrapped: wrapped, name: NAME)
+
       @snapshot_repo = snapshot_repo
-      @wrapped = wrapped
     end
 
-    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool] => C::Any
-    def run(rep, is_outdated:)
-      @wrapped.run(rep, is_outdated: is_outdated)
+    contract Nanoc::Int::ItemRep, C::KeywordArgs[is_outdated: C::Bool], C::Func[C::None => C::Any] => C::Any
+    def run(rep, is_outdated:) # rubocop:disable Lint/UnusedMethodArgument
+      yield
 
       Nanoc::Int::ItemRepWriter.new.write_all(rep, @snapshot_repo)
     end

data/lib/nanoc/base/services/compiler/stages/compile_reps.rb

@@ -27,7 +27,7 @@ module Nanoc::Int::Compiler::Stages
     end
 
     def compile_rep(rep, is_outdated:)
-      item_rep_compiler.run(rep, is_outdated: is_outdated)
+      item_rep_compiler.call(rep, is_outdated: is_outdated)
     end
 
     def item_rep_compiler

data/lib/nanoc/cli.rb

@@ -34,6 +34,14 @@ module Nanoc::CLI
     @debug = boolean
   end
 
+  def self.verbosity
+    @verbosity || 0
+  end
+
+  def self.verbosity=(val)
+    @verbosity = val
+  end
+
   # Invokes the Nanoc command-line tool with the given arguments.
   #
   # @param [Array<String>] args An array of command-line arguments

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

@@ -158,29 +158,70 @@ module Nanoc::CLI::Commands
       def start
         @telemetry = Nanoc::Telemetry.new
 
-        stopwatches = {}
+        stage_stopwatch = Nanoc::Telemetry::Stopwatch.new
+
+        Nanoc::Int::NotificationCenter.on(:stage_started) do |_stage_name|
+          stage_stopwatch.start
+        end
+
+        Nanoc::Int::NotificationCenter.on(:stage_ended) do |stage_name|
+          stage_stopwatch.stop
+          @telemetry.summary(:stages).observe(stage_stopwatch.duration, stage_name.to_s)
+          stage_stopwatch = Nanoc::Telemetry::Stopwatch.new
+        end
+
+        filter_stopwatches = {}
 
         Nanoc::Int::NotificationCenter.on(:filtering_started) do |rep, _filter_name|
-          stopwatch_stack = stopwatches.fetch(rep) { stopwatches[rep] = [] }
+          stopwatch_stack = filter_stopwatches.fetch(rep) { filter_stopwatches[rep] = [] }
           stopwatch_stack << Nanoc::Telemetry::Stopwatch.new
           stopwatch_stack.last.start
         end
 
         Nanoc::Int::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
-          stopwatch = stopwatches.fetch(rep).pop
+          stopwatch = filter_stopwatches.fetch(rep).pop
           stopwatch.stop
 
-          @telemetry.summary(:filter_total).observe(stopwatch.duration, filter_name: filter_name)
+          @telemetry.summary(:filters).observe(stopwatch.duration, filter_name.to_s)
         end
 
         Nanoc::Int::NotificationCenter.on(:compilation_suspended) do |rep, _exception|
-          stopwatch = stopwatches.fetch(rep).last
-          stopwatch.stop if stopwatch && stopwatch.running?
+          filter_stopwatches.fetch(rep).each(&:stop)
         end
 
         Nanoc::Int::NotificationCenter.on(:compilation_started) do |rep|
-          stopwatch = stopwatches.fetch(rep, []).last
-          stopwatch.start if stopwatch
+          filter_stopwatches.fetch(rep, []).each(&:start)
+        end
+
+        phase_stopwatches = {}
+
+        Nanoc::Int::NotificationCenter.on(:phase_started) do |phase_name, rep|
+          stopwatches = phase_stopwatches.fetch(rep) { phase_stopwatches[rep] = {} }
+          stopwatches[phase_name] = Nanoc::Telemetry::Stopwatch.new.tap(&:start)
+        end
+
+        Nanoc::Int::NotificationCenter.on(:phase_ended) do |phase_name, rep|
+          stopwatch = phase_stopwatches.fetch(rep).fetch(phase_name)
+          stopwatch.stop
+
+          @telemetry.summary(:phases).observe(stopwatch.duration, phase_name)
+        end
+
+        Nanoc::Int::NotificationCenter.on(:phase_yielded) do |phase_name, rep|
+          stopwatch = phase_stopwatches.fetch(rep).fetch(phase_name)
+          stopwatch.stop
+        end
+
+        Nanoc::Int::NotificationCenter.on(:phase_resumed) do |phase_name, rep|
+          stopwatch = phase_stopwatches.fetch(rep).fetch(phase_name)
+          stopwatch.start if stopwatch.stopped?
+        end
+
+        Nanoc::Int::NotificationCenter.on(:phase_aborted) do |phase_name, rep|
+          stopwatch = phase_stopwatches.fetch(rep).fetch(phase_name)
+          stopwatch.stop if stopwatch.running?
+
+          @telemetry.summary(:phases).observe(stopwatch.duration, phase_name)
         end
       end
 
@@ -192,19 +233,15 @@ module Nanoc::CLI::Commands
 
       protected
 
-      def profiling_table
-        headers = ['', 'count', 'min', 'avg', 'max', 'tot']
-
-        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
+      def table_for_summary(name)
+        headers = [name.to_s, 'count', 'min', 'avg', 'max', 'tot']
 
-          count = metric.count
-          min   = metric.min
-          avg   = metric.avg
-          tot   = metric.sum
-          max   = metric.max
+        rows = @telemetry.summary(name).map do |filter_name, summary|
+          count = summary.count
+          min   = summary.min
+          avg   = summary.avg
+          tot   = summary.sum
+          max   = summary.max
 
           [filter_name, count.to_s] + [min, avg, max, tot].map { |r| "#{format('%4.2f', r)}s" }
         end
@@ -212,17 +249,34 @@ module Nanoc::CLI::Commands
         [headers] + rows
       end
 
-      def print_profiling_feedback
-        return if @telemetry.summary(:filter_total).labels.empty?
+      def table_for_summary_durations(name)
+        headers = [name.to_s, 'tot']
 
-        if @reps.any? { |r| !r.compiled? }
-          $stderr.puts
-          $stderr.puts 'Warning: profiling information may not be accurate because ' \
-                       'some items were not compiled.'
+        rows = @telemetry.summary(:stages).map do |stage_name, summary|
+          [stage_name, "#{format('%4.2f', summary.sum)}s"]
         end
 
+        [headers] + rows
+      end
+
+      def print_profiling_feedback
+        print_table_for_summary(:filters)
+        print_table_for_summary(:phases) if Nanoc::CLI.verbosity >= 2
+        print_table_for_summary_duration(:stages) if Nanoc::CLI.verbosity >= 2
+      end
+
+      def print_table_for_summary(name)
+        return if @telemetry.summary(name).empty?
+
+        puts
+        print_table(table_for_summary(name))
+      end
+
+      def print_table_for_summary_duration(name)
+        return if @telemetry.summary(name).empty?
+
         puts
-        print_table profiling_table
+        print_table(table_for_summary_durations(name))
       end
 
       def print_table(table)