nanoc 4.8.16 → 4.8.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfa738915a0c601d828aa97183ebbfee9613ee9e2b955ad0f52e6a3dbea6545e
-  data.tar.gz: 6f0989008933306c049073a1b384c9715969116dafb8fc0279390b1b4ec003dd
+  metadata.gz: 2b0135cd287173e9725acef9bb921109f8158d9e6453bd8e7ae194e23cdd25ef
+  data.tar.gz: 115b6b3baf84924b26cacac37925023f0aacbb9530721bd093386a74102fbd10
 SHA512:
-  metadata.gz: 8d7af61ff23c5a1f80e2d1b4e80bdb22f684ddca32391e9f19bb3fc44630a675d4cb29f7fbe9e1764f899e691dff0fad7d252e59e34bca86544edf397a07e0a5
-  data.tar.gz: 58286c12cf1b0037db772e116c456f4d851d53c64d7ede2a151b9c30611f71b4a9e35cd5b5f7f3609b2b1323b2aa2eec82540393b5d4b6ba9c47f97fb709b81e
+  metadata.gz: c8aa8b0d5005dfbaa7664d08baaeee74bc7e5fb15cd2873d18bb0d4847c4c76203539852a258c4ad7c5187cb6503db1396e0a43752926f51fe89ea66b04dce12
+  data.tar.gz: 19fd6556430be0ffda0d733f0e8546a0ac646e7deb8da0e62df17c9caae4e99c166f4cc6bf8aadfc39376d5a1df44f53c542f104fefbf404686b840b4d18ced0

data/NEWS.md

@@ -1,5 +1,11 @@
 # Nanoc news
 
+## 4.8.17 (2017-12-16)
+
+Enhancements:
+
+* Made `LoadError` be printed more nicely (#1273, #1274, #1275)
+
 ## 4.8.16 (2017-12-09)
 
 Fixes:

data/lib/nanoc.rb

@@ -1,5 +1,14 @@
 # frozen_string_literal: true
 
+# Load external dependencies
+require 'addressable'
+require 'ddplugin'
+require 'hamster'
+require 'ref'
+require 'slow_enumerator_tools'
+require 'ddmemoize'
+require 'ddtelemetry'
+
 module Nanoc
   # @return [String] A string containing information about this Nanoc version
   #   and its environment (Ruby engine and version, Rubygems version if any).
@@ -16,15 +25,9 @@ module Nanoc
   def self.on_windows?
     RUBY_PLATFORM =~ /windows|bccwin|cygwin|djgpp|mingw|mswin|wince/i
   end
-end
 
-# Load external dependencies
-require 'addressable'
-require 'ddplugin'
-require 'hamster'
-require 'ref'
-require 'slow_enumerator_tools'
-require 'ddtelemetry'
+  MEMOIZATION_TELEMETRY = DDTelemetry.new
+end
 
 # Load general requirements
 require 'cgi'

data/lib/nanoc/base.rb

@@ -6,7 +6,6 @@ end
 
 require_relative 'base/core_ext'
 require_relative 'base/contracts_support'
-require_relative 'base/memoization'
 require_relative 'base/error'
 require_relative 'base/errors'
 require_relative 'base/changes_stream'

data/lib/nanoc/base/entities/action_sequence.rb

@@ -4,7 +4,7 @@ module Nanoc::Int
   class ActionSequence
     include Nanoc::Int::ContractsSupport
     include Enumerable
-    extend Nanoc::Int::Memoization
+    DDMemoize.activate(self, telemetry: Nanoc::MEMOIZATION_TELEMETRY)
 
     attr_reader :item_rep
     attr_reader :actions

data/lib/nanoc/base/entities/checksum_collection.rb

@@ -3,7 +3,6 @@
 module Nanoc::Int
   class ChecksumCollection
     include Nanoc::Int::ContractsSupport
-    extend Nanoc::Int::Memoization
 
     c_obj = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout, Nanoc::Int::Configuration, Nanoc::Int::CodeSnippet]
 

data/lib/nanoc/base/entities/identifiable_collection.rb

@@ -3,10 +3,11 @@
 module Nanoc::Int
   # @api private
   class IdentifiableCollection
+    DDMemoize.activate(self, telemetry: Nanoc::MEMOIZATION_TELEMETRY)
+
     include Nanoc::Int::ContractsSupport
     include Enumerable
 
-    extend Nanoc::Int::Memoization
     extend Forwardable
 
     def_delegator :@objects, :each

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

@@ -6,7 +6,7 @@ module Nanoc::Int
   # @api private
   class OutdatednessChecker
     class Basic
-      extend Nanoc::Int::Memoization
+      DDMemoize.activate(self, telemetry: Nanoc::MEMOIZATION_TELEMETRY)
 
       include Nanoc::Int::ContractsSupport
 
@@ -97,7 +97,7 @@ module Nanoc::Int
       end
     end
 
-    extend Nanoc::Int::Memoization
+    DDMemoize.activate(self, telemetry: Nanoc::MEMOIZATION_TELEMETRY)
 
     include Nanoc::Int::ContractsSupport
 

data/lib/nanoc/base/services/outdatedness_rules/code_snippets_modified.rb

@@ -2,7 +2,7 @@
 
 module Nanoc::Int::OutdatednessRules
   class CodeSnippetsModified < Nanoc::Int::OutdatednessRule
-    extend Nanoc::Int::Memoization
+    DDMemoize.activate(self, telemetry: Nanoc::MEMOIZATION_TELEMETRY)
 
     include Nanoc::Int::ContractsSupport
 

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

@@ -100,14 +100,6 @@ module Nanoc::CLI::Commands::CompileListeners
 
         @telemetry.summary(:phases).observe(stopwatch.duration, phase_name)
       end
-
-      on(:memoization_miss) do |label|
-        @telemetry.counter(:memoization).increment([label, :miss])
-      end
-
-      on(:memoization_hit) do |label|
-        @telemetry.counter(:memoization).increment([label, :hit])
-      end
     end
 
     # @see Listener#stop
@@ -146,32 +138,12 @@ module Nanoc::CLI::Commands::CompileListeners
       [headers] + rows
     end
 
-    def table_for_memoization
-      headers = %w[memoization hit miss %]
-
-      rows_raw = @telemetry.counter(:memoization).map do |(name, type), counter|
-        { name: name, type: type, count: counter.value }
-      end
-
-      rows = rows_raw.group_by { |r| r[:name] }.map do |name, rows_for_name|
-        rows_by_type = rows_for_name.group_by { |r| r[:type] }
-
-        num_hit = rows_by_type.fetch(:hit, []).fetch(0, {}).fetch(:count, 0)
-        num_miss = rows_by_type.fetch(:miss, []).fetch(0, {}).fetch(:count, 0)
-        pct = num_hit.to_f / (num_hit + num_miss).to_f
-
-        [name, num_hit.to_s, num_miss.to_s, "#{format('%3.1f', pct * 100)}%"]
-      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
       print_table_for_summary(:outdatedness_rules) if Nanoc::CLI.verbosity >= 2
-      print_table_for_memoization if Nanoc::CLI.verbosity >= 2
+      DDMemoize.print_telemetry(Nanoc::MEMOIZATION_TELEMETRY) if Nanoc::CLI.verbosity >= 2
     end
 
     def print_table_for_summary(name)
@@ -188,13 +160,6 @@ module Nanoc::CLI::Commands::CompileListeners
       print_table(table_for_summary_durations(name))
     end
 
-    def print_table_for_memoization
-      return if @telemetry.counter(:memoization).empty?
-
-      puts
-      print_table(table_for_memoization)
-    end
-
     def print_table(rows)
       puts DDTelemetry::Table.new(rows).to_s
     end

data/lib/nanoc/cli/error_handler.rb

@@ -58,12 +58,20 @@ module Nanoc::CLI
     rescue Interrupt
       exit(1)
     rescue StandardError, ScriptError => e
-      if trivial?(e)
-        $stderr.puts "Error: #{e.message}"
-        resolution = resolution_for(e)
-        $stderr.puts resolution if resolution
+      handle_error(e, exit_on_error: exit_on_error)
+    end
+
+    def handle_error(error, exit_on_error:)
+      if trivial?(error)
+        $stderr.puts
+        $stderr.puts "Error: #{error.message}"
+        resolution = resolution_for(error)
+        if resolution
+          $stderr.puts
+          $stderr.puts resolution
+        end
       else
-        print_error(e)
+        print_error(error)
       end
       exit(1) if exit_on_error
     end
@@ -148,6 +156,18 @@ module Nanoc::CLI
       feature_enabled || ruby_2_5_used
     end
 
+    # @api private
+    def trivial?(error)
+      case error
+      when Nanoc::Int::Errors::GenericTrivial, Errno::EADDRINUSE
+        true
+      when LoadError
+        GEM_NAMES.keys.include?(gem_name_from_load_error(error))
+      else
+        false
+      end
+    end
+
     protected
 
     # @return [Hash<String, Array>] A hash containing the gem names as keys and gem versions as value
@@ -196,15 +216,6 @@ module Nanoc::CLI
       'w3c_validators' => 'w3c_validators',
     }.freeze
 
-    def trivial?(error)
-      case error
-      when Nanoc::Int::Errors::GenericTrivial, Errno::EADDRINUSE
-        true
-      else
-        false
-      end
-    end
-
     # Attempts to find a resolution for the given error, or nil if no
     # resolution can be automatically obtained.
     #
@@ -216,15 +227,15 @@ module Nanoc::CLI
 
       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]]
+        gem_name = gem_name_from_load_error(error)
 
-        # Build message
         if gem_name
           if using_bundler?
-            'Make sure the gem is added to Gemfile and run `bundle install`.'
+            <<~RES
+              1. Add `gem '#{gem_name}'` to your Gemfile
+              2. Run `bundle install`
+              3. Re-run this command
+            RES
           else
             "Install the '#{gem_name}' gem using `gem install #{gem_name}`."
           end
@@ -241,6 +252,12 @@ module Nanoc::CLI
       end
     end
 
+    def gem_name_from_load_error(error)
+      matches = error.message.match(/(no such file to load|cannot load such file) -- ([^\s]+)/)
+      return nil if matches.nil?
+      GEM_NAMES[matches[2]]
+    end
+
     def using_bundler?
       defined?(Bundler) && Bundler::SharedHelpers.in_bundle?
     end

data/lib/nanoc/rule_dsl/action_sequence_calculator.rb

@@ -6,7 +6,7 @@ module Nanoc::RuleDSL
   #
   # @api private
   class ActionSequenceCalculator
-    extend Nanoc::Int::Memoization
+    DDMemoize.activate(self, telemetry: Nanoc::MEMOIZATION_TELEMETRY)
 
     class UnsupportedObjectTypeException < ::Nanoc::Error
       def initialize(obj)

data/lib/nanoc/version.rb

@@ -2,5 +2,5 @@
 
 module Nanoc
   # The current Nanoc version.
-  VERSION = '4.8.16'
+  VERSION = '4.8.17'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc
 version: !ruby/object:Gem::Version
-  version: 4.8.16
+  version: 4.8.17
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-09 00:00:00.000000000 Z
+date: 2017-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: ddmemoize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0a2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0a2
 - !ruby/object:Gem::Dependency
   name: ddplugin
   requirement: !ruby/object:Gem::Requirement
@@ -162,7 +176,6 @@ files:
 - lib/nanoc/base/error.rb
 - lib/nanoc/base/errors.rb
 - lib/nanoc/base/feature.rb
-- lib/nanoc/base/memoization.rb
 - lib/nanoc/base/repos.rb
 - lib/nanoc/base/repos/action_sequence_store.rb
 - lib/nanoc/base/repos/aggregate_data_source.rb

data/lib/nanoc/base/memoization.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc::Int
-  # Adds support for memoizing functions.
-  #
-  # @api private
-  module Memoization
-    class Value
-      attr_reader :value
-
-      def initialize(value)
-        @value = value
-      end
-    end
-
-    NONE = Object.new
-
-    # Memoizes the method with the given name. The modified method will cache
-    # the results of the original method, so that calling a method twice with
-    # the same arguments will short-circuit and return the cached results
-    # immediately.
-    #
-    # Memoization assumes that the current object as well as the function
-    # arguments are immutable. Mutating the object or the arguments will not
-    # cause memoized methods to recalculate their results. There is no way to
-    # un-memoize a result, and calculation results will remain in memory even
-    # if they are no longer needed.
-    #
-    # @example A fast fib function due to memoization
-    #
-    #     class FibFast
-    #
-    #       extend Nanoc::Int::Memoization
-    #
-    #       def run(n)
-    #         if n == 0
-    #           0
-    #         elsif n == 1
-    #           1
-    #         else
-    #           run(n-1) + run(n-2)
-    #         end
-    #       end
-    #       memoize :run
-    #
-    #     end
-    #
-    # @param [Symbol, String] method_name The name of the method to memoize
-    #
-    # @return [void]
-    def memoize(method_name)
-      original_method_name = '__nonmemoized_' + method_name.to_s
-      alias_method original_method_name, method_name
-
-      instance_cache = Hash.new { |hash, key| hash[key] = {} }
-
-      define_method(method_name) do |*args|
-        instance_method_cache = instance_cache[self]
-
-        value = NONE
-        if instance_method_cache.key?(args)
-          object = instance_method_cache[args].object
-          value = object ? object.value : NONE
-        end
-
-        counter_label = is_a?(Class) ? "#{self}.#{method_name}" : "#{self.class}##{method_name}"
-        if value.equal?(NONE)
-          Nanoc::Int::NotificationCenter.post(:memoization_miss, counter_label)
-          send(original_method_name, *args).tap do |r|
-            instance_method_cache[args] = Ref::SoftReference.new(Value.new(r))
-          end
-        else
-          Nanoc::Int::NotificationCenter.post(:memoization_hit, counter_label)
-          value
-        end
-      end
-    end
-    alias memoized memoize
-  end
-end