nanoc 4.11.2 → 4.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c038b8ba7dfde390ca7151a64421060d91173371c080b1de0e8cf2b44cea073f
-  data.tar.gz: aef94fe2c56a0c01506d933fe68497b9e930b8b3b81933f5140dc15b9307b024
+  metadata.gz: 7e5efc6d26dd09a85227e75e05633aa88a5af1fad6a141831e7958d22777c457
+  data.tar.gz: 53db1fb790e25df48988c9aa3c4ce08806bfd6e57217ffb44c6d35cabf6626d5
 SHA512:
-  metadata.gz: a9687e4103a49256b1065f92107f0659f204e5b65b975af71f0240f9eb2857086b096081282a3038a25e1595a7af5c18077b44fbe4c6ce0ed388eca142369eae
-  data.tar.gz: ed741694c5373b8d8770211695dd7e6a53e2fe393ed1dfd96a6464e2ffd030e754a6c4e7eeb0cc04e0fe26bc09e4395849071967c8d0e0539a91affe01302fa3
+  metadata.gz: 84eada303df7cef2126c6cf0c655e4bb1053ea50162827bf14f21b308e72ab4107e90c39530c73414db9c8bf0ec2ef5d46bb872dcc650f2bef337db59ffae6fd
+  data.tar.gz: 4db294481349814d49966c8612e780a9a789dc2c1cf74a0b92ffe9cafa42ad3db0fd3403f090043bef806d7778e33639efa64efe98af1d221b894020cd3225d9

data/NEWS.md

@@ -1,5 +1,12 @@
 # Nanoc news
 
+## 4.11.3 (2019-04-27)
+
+Enhancements:
+
+* Set a User-Agent for HTTP requests made by the `external_links` check (#1417) [Daniel Aleksandersen]
+* Added `atom:link[type]` attributes (#1415) [Daniel Aleksandersen]
+
 ## 4.11.2 (2019-02-16)
 
 Fixes:
@@ -1013,11 +1020,11 @@ Enhancements:
 
 * Added several convenience methods to view classes (#570, #572)
 
-See the [nanoc 4 upgrade guide](http://nanoc.ws/doc/nanoc-4-upgrade-guide/) for details.
+See the [nanoc 4 upgrade guide](https://nanoc.ws/doc/nanoc-4-upgrade-guide/) for details.
 
 ## 4.0.0a1 (2015-05-09)
 
-This is a major upgrade. For details on upgrading, see the [nanoc 4 upgrade guide](http://nanoc.ws/doc/nanoc-4-upgrade-guide/).
+This is a major upgrade. For details on upgrading, see the [nanoc 4 upgrade guide](https://nanoc.ws/doc/nanoc-4-upgrade-guide/).
 
 This release provides no new features, but streamlines the API and functionality, in order to easen future development, both for features and for optimisations.
 
@@ -1183,7 +1190,7 @@ Enhancements:
 
 * Reduced number of dependencies generated by Sass filter (#306) [Gregory Pakosz]
 * Recognised lowercase `utf` in language value (e.g. `en_US.utf8`) as being UTF-8 (#335, #338)
-* Set [Thin](http://code.macournoyer.com/thin/) as the default server for `nanoc view` (#342, #345)
+* Set [Thin](https://github.com/macournoyer/thin) as the default server for `nanoc view` (#342, #345)
 * Removed watcher section from the default configuration file (#343, #344)
 
 Fixes:
@@ -1201,7 +1208,7 @@ Fixes:
 
 Enhancements:
 
-* Deprecated `watch` and `autocompile` commands in favour of [`guard-nanoc`](https://github.com/nanoc/guard-nanoc)
+* Deprecated `watch` and `autocompile` commands in favour of [`guard-nanoc`](https://github.com/guard/guard-nanoc)
 
 Fixes:
 
@@ -1548,7 +1555,7 @@ New:
 * A new “+” wildcard in rule patterns that matches one or more characters
 * A `view` command that starts a web server in the output directory
 * A `debug` command that shows information about the items, reps and layouts
-* A `kramdown` filter ([kramdown site](http://kramdown.gettalong.org/))
+* A `kramdown` filter ([kramdown site](https://kramdown.gettalong.org/))
 * A diff between the previously compiled content and the last compiled content is now written to `output.diff` if the `enable_output_diff` site configuration attribute is true
 * Assigns, such as `@items`, `@layouts`, `@item`, … are accessible without `@`
 * Support for binary items
@@ -1676,7 +1683,7 @@ New:
 * `--no-color` command-line option
 * `Filtering` helper
 * `#relative_path_to` function in `LinkTo` helper
-* `rainpress` filter ([Rainpress site](http://code.google.com/p/rainpress/))
+* `rainpress` filter ([Rainpress site](https://github.com/ddfreyne/rainpress))
 * `relativize_paths` filter
 * The current layout is now accessible through the `@layout` variable
 * Much more informative stack traces when something goes wrong
@@ -1730,12 +1737,12 @@ Removed:
 ## 2.1 (2008-08-17)
 
 This is only a short summary of all changes in 2.1. For details, see the
-[nanoc web site](http://nanoc.stoneship.org/). Especially the blog and the
+[nanoc web site](https://nanoc.ws/). Especially the blog and the
 updated manual will be useful.
 
 New:
 
-* New `rdiscount` filter ([RDiscount site](http://github.com/rtomayko/rdiscount))
+* New `rdiscount` filter ([RDiscount site](https://github.com/davidfstr/rdiscount))
 * New `maruku` filter ([Maruku site](https://github.com/bhollis/maruku/))
 * New `erubis` filter ([Erubis site](http://www.kuwata-lab.com/erubis/))
 * A better command-line frontend

data/README.md

@@ -2,4 +2,4 @@
 
 # Nanoc
 
-Nanoc is a flexible static-site generator written in Ruby. See the [Nanoc web site](http://nanoc.ws) for more information.
+Nanoc is a flexible static-site generator written in Ruby. See the [Nanoc web site](https://nanoc.ws) for more information.

data/lib/nanoc.rb

@@ -21,7 +21,7 @@ module Nanoc
   #
   # @api private
   def self.on_windows?
-    RUBY_PLATFORM =~ /windows|bccwin|cygwin|djgpp|mingw|mswin|wince/i
+    @_on_windows ||= TTY::Platform.new.windows?
   end
 
   # Similar to `nil` except that it can only be compared against using
@@ -53,6 +53,9 @@ require 'time'
 require 'timeout'
 require 'tomlrb'
 require 'tmpdir'
+require 'tty-file'
+require 'tty-platform'
+require 'tty-which'
 require 'uri'
 require 'yaml'
 

data/lib/nanoc/base/entities.rb

@@ -4,10 +4,8 @@
 Nanoc::Identifier = Nanoc::Core::Identifier
 
 require_relative 'entities/props'
-require_relative 'entities/action_sequence'
 require_relative 'entities/site'
 
-require_relative 'entities/checksum_collection'
 require_relative 'entities/outdatedness_status'
 require_relative 'entities/outdatedness_reasons'
 require_relative 'entities/dependency'

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

@@ -4,6 +4,13 @@ module Nanoc
   module Int
     # @api private
     class Site
+      # Error that is raised when multiple items or layouts with the same identifier exist.
+      class DuplicateIdentifierError < ::Nanoc::Error
+        def initialize(identifier, type)
+          super("There are multiple #{type}s with the #{identifier} identifier.")
+        end
+      end
+
       include Nanoc::Core::ContractsSupport
 
       attr_reader :code_snippets
@@ -52,7 +59,7 @@ module Nanoc
         seen = Set.new
         objects.each do |obj|
           if seen.include?(obj.identifier)
-            raise Nanoc::Int::Errors::DuplicateIdentifier.new(obj.identifier, type)
+            raise DuplicateIdentifierError.new(obj.identifier, type)
           end
 
           seen << obj.identifier

data/lib/nanoc/base/errors.rb

@@ -180,18 +180,6 @@ module Nanoc
         end
       end
 
-      # Error that is raised when a snapshot with an existing name is made.
-      class CannotCreateMultipleSnapshotsWithSameName < Generic
-        # @param [Nanoc::Core::ItemRep] rep The item representation for which a
-        #   snapshot was attempted to be made
-        #
-        # @param [Symbol] snapshot The name of the snapshot that was attempted to
-        #   be made
-        def initialize(rep, snapshot)
-          super("Attempted to create a snapshot with a duplicate name #{snapshot.inspect} for the item rep #{rep}")
-        end
-      end
-
       # Error that is raised when the compiled content of a binary item is attempted to be accessed.
       class CannotGetCompiledContentOfBinaryItem < Generic
         # @param [Nanoc::Core::ItemRep] rep The binary item representation whose compiled content was attempted to be accessed
@@ -200,13 +188,6 @@ module Nanoc
         end
       end
 
-      # Error that is raised when multiple items or layouts with the same identifier exist.
-      class DuplicateIdentifier < Generic
-        def initialize(identifier, type)
-          super("There are multiple #{type}s with the #{identifier} identifier.")
-        end
-      end
-
       # Error that is raised when attempting to call #parent or #children on an item with a legacy identifier.
       class CannotGetParentOrChildrenOfNonLegacyItem < Generic
         def initialize(identifier)

data/lib/nanoc/base/services.rb

@@ -1,14 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'services/action_provider'
-require_relative 'services/action_sequence_builder'
 require_relative 'services/compilation_context'
 require_relative 'services/compiler'
 require_relative 'services/compiler_loader'
 require_relative 'services/dependency_tracker'
 require_relative 'services/executor'
 require_relative 'services/filter'
-require_relative 'services/instrumentor'
 require_relative 'services/item_rep_builder'
 require_relative 'services/item_rep_router'
 require_relative 'services/item_rep_selector'

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

@@ -6,7 +6,7 @@ module Nanoc
       class Stage
         def call(*args)
           notify(:stage_started)
-          res = Nanoc::Int::Instrumentor.call(:stage_ran, self.class) do
+          res = Nanoc::Core::Instrumentor.call(:stage_ran, self.class) do
             run(*args)
           end
           notify(:stage_ended)

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

@@ -35,7 +35,7 @@ module Nanoc
             checksums[[@config.reference, :each_attribute]] =
               Nanoc::Core::Checksummer.calc_for_each_attribute_of(@config)
 
-            Nanoc::Int::ChecksumCollection.new(checksums)
+            Nanoc::Core::ChecksumCollection.new(checksums)
           end
         end
       end

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

@@ -26,7 +26,7 @@ module Nanoc
 
           contract Nanoc::Int::Store => C::Any
           def load_store(store)
-            Nanoc::Int::Instrumentor.call(:store_loaded, store.class) do
+            Nanoc::Core::Instrumentor.call(:store_loaded, store.class) do
               store.load
             end
           end

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

@@ -15,7 +15,7 @@ module Nanoc
             @action_sequences = action_sequences
           end
 
-          contract Nanoc::Int::ChecksumCollection => C::Any
+          contract Nanoc::Core::ChecksumCollection => C::Any
           def run(checksums)
             # Calculate action sequence
             (@reps.to_a + @layouts.to_a).each do |obj|

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

@@ -15,7 +15,7 @@ module Nanoc
         checksum_store =
           Nanoc::Int::ChecksumStore.new(config: site.config, objects: objects)
 
-        action_provider ||= Nanoc::Int::ActionProvider.named(site.config.action_provider).for(site)
+        action_provider ||= Nanoc::Core::ActionProvider.named(site.config.action_provider).for(site)
 
         outdatedness_store =
           Nanoc::Int::OutdatednessStore.new(config: site.config)

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

@@ -38,7 +38,7 @@ module Nanoc
         layout = find_layout(layout_identifier)
         filter_name, filter_args = *@compilation_context.filter_name_and_args_for_layout(layout)
         if filter_name.nil?
-          raise Nanoc::Int::Errors::Generic, "Cannot find rule for layout matching #{layout_identifier}"
+          raise ::Nanoc::Core::Error, "Cannot find rule for layout matching #{layout_identifier}"
         end
 
         filter_args = filter_args.merge(extra_filter_args || {})

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

@@ -4,6 +4,8 @@ module Nanoc
   module Int
     # @api private
     class ItemRepBuilder
+      include Nanoc::Core::ContractsSupport
+
       attr_reader :reps
 
       def initialize(site, action_provider, reps)
@@ -22,11 +24,30 @@ module Nanoc
         action_sequences = Nanoc::Int::ItemRepRouter.new(@reps, @action_provider, @site).run
 
         @reps.each do |rep|
-          rep.snapshot_defs = action_sequences[rep].snapshots_defs
+          rep.snapshot_defs = self.class.snapshot_defs_for(action_sequences[rep])
         end
 
         action_sequences
       end
+
+      contract Nanoc::Core::ActionSequence => C::ArrayOf[Nanoc::Core::SnapshotDef]
+      def self.snapshot_defs_for(action_sequence)
+        is_binary = action_sequence.item_rep.item.content.binary?
+        snapshot_defs = []
+
+        action_sequence.each do |action|
+          case action
+          when Nanoc::Core::ProcessingActions::Snapshot
+            action.snapshot_names.each do |snapshot_name|
+              snapshot_defs << Nanoc::Core::SnapshotDef.new(snapshot_name, binary: is_binary)
+            end
+          when Nanoc::Core::ProcessingActions::Filter
+            is_binary = Nanoc::Filter.named!(action.filter_name).to_binary?
+          end
+        end
+
+        snapshot_defs
+      end
     end
   end
 end

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

@@ -113,9 +113,9 @@ module Nanoc
 
       C_OBJ = C::Or[Nanoc::Core::Item, Nanoc::Core::ItemRep, Nanoc::Core::Configuration, Nanoc::Core::Layout, Nanoc::Core::ItemCollection]
       C_ITEM_OR_REP = C::Or[Nanoc::Core::Item, Nanoc::Core::ItemRep]
-      C_ACTION_SEQUENCES = C::HashOf[C_OBJ => Nanoc::Int::ActionSequence]
+      C_ACTION_SEQUENCES = C::HashOf[C_OBJ => Nanoc::Core::ActionSequence]
 
-      contract C::KeywordArgs[site: Nanoc::Int::Site, checksum_store: Nanoc::Int::ChecksumStore, checksums: Nanoc::Int::ChecksumCollection, dependency_store: Nanoc::Int::DependencyStore, action_sequence_store: Nanoc::Int::ActionSequenceStore, action_sequences: C_ACTION_SEQUENCES, reps: Nanoc::Int::ItemRepRepo] => C::Any
+      contract C::KeywordArgs[site: Nanoc::Int::Site, checksum_store: Nanoc::Int::ChecksumStore, checksums: Nanoc::Core::ChecksumCollection, dependency_store: Nanoc::Int::DependencyStore, action_sequence_store: Nanoc::Int::ActionSequenceStore, action_sequences: C_ACTION_SEQUENCES, reps: Nanoc::Int::ItemRepRepo] => C::Any
       def initialize(site:, checksum_store:, checksums:, dependency_store:, action_sequence_store:, action_sequences:, reps:)
         @site = site
         @checksum_store = checksum_store

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

@@ -8,7 +8,7 @@ module Nanoc
       include Singleton
 
       def call(obj, outdatedness_checker)
-        Nanoc::Int::Instrumentor.call(:outdatedness_rule_ran, self.class) do
+        Nanoc::Core::Instrumentor.call(:outdatedness_rule_ran, self.class) do
           apply(obj, outdatedness_checker)
         end
       end

data/lib/nanoc/checking/check.rb

@@ -2,7 +2,7 @@
 
 module Nanoc::Checking
   # @api private
-  class OutputDirNotFoundError < Nanoc::Int::Errors::Generic
+  class OutputDirNotFoundError < ::Nanoc::Core::Error
     def initialize(directory_path)
       super("Unable to run check against output directory at “#{directory_path}”: directory does not exist.")
     end

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

@@ -77,6 +77,10 @@ module ::Nanoc::Checking::Checks
           location = extract_location(res, url)
           return Result.new(href, 'redirection without a target location') if location.nil?
 
+          if /^30[18]$/.match?(res.code)
+            return Result.new(href, "link have moved permanently to '#{location}'")
+          end
+
           url = URI.parse(location)
         elsif res.code == '200'
           return nil
@@ -125,6 +129,7 @@ module ::Nanoc::Checking::Checks
 
     def request_url_once(url)
       req = Net::HTTP::Get.new(path_for_url(url))
+      req['User-Agent'] = "Mozilla/5.0 Nanoc/#{Nanoc::VERSION} (link rot checker)"
       http = Net::HTTP.new(url.host, url.port)
       if url.instance_of? URI::HTTPS
         http.use_ssl = true

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

@@ -55,9 +55,7 @@ module Nanoc::CLI::Commands::CompileListeners
         end
 
         # Generate diff
-        diff = diff_strings(old_content, new_content)
-        diff.sub!(/^--- .*/,    '--- ' + path)
-        diff.sub!(/^\+\+\+ .*/, '+++ ' + path)
+        diff = ['--- ' + path, '+++ ' + path, diff_strings(old_content, new_content)].join("\n")
 
         # Write diff
         @diff_lock.synchronize do
@@ -77,11 +75,7 @@ module Nanoc::CLI::Commands::CompileListeners
           new_file.flush
 
           # Diff
-          cmd = ['diff', '-u', old_file.path, new_file.path]
-          Open3.popen3(*cmd) do |_stdin, stdout, _stderr|
-            result = stdout.read
-            return (result == '' ? nil : result)
-          end
+          TTY::File.diff_files(old_file.path, new_file.path, verbose: false)
         end
       end
     rescue Errno::ENOENT

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

@@ -201,14 +201,14 @@ module Nanoc::CLI::Commands
           <div id="sidebar">
             <h2>Documentation</h2>
             <ul>
-              <li><a href="http://nanoc.ws/doc/">Documentation</a></li>
-              <li><a href="http://nanoc.ws/doc/tutorial/">Tutorial</a></li>
+              <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="http://nanoc.ws/contributing/">Contributing</a></li>
+              <li><a href="https://nanoc.ws/contributing/">Contributing</a></li>
             </ul>
           </div>
         </body>

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

@@ -29,7 +29,7 @@ module Nanoc::CLI::Commands
 
     def self.reps_for(site)
       Nanoc::Int::ItemRepRepo.new.tap do |reps|
-        action_provider = Nanoc::Int::ActionProvider.named(site.config.action_provider).for(site)
+        action_provider = Nanoc::Core::ActionProvider.named(site.config.action_provider).for(site)
         builder = Nanoc::Int::ItemRepBuilder.new(site, action_provider, reps)
         builder.run
       end

data/lib/nanoc/cli/commands/show-rules.rb

@@ -16,7 +16,7 @@ module Nanoc::CLI::Commands
       res = Nanoc::Int::Compiler.new_for(site).run_until_reps_built
       reps = res.fetch(:reps)
 
-      action_provider = Nanoc::Int::ActionProvider.named(site.config.action_provider).for(site)
+      action_provider = Nanoc::Core::ActionProvider.named(site.config.action_provider).for(site)
       rules = action_provider.rules_collection
 
       items = site.items.sort_by(&:identifier)

data/lib/nanoc/deploying/deployers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'tty-command'
+
 # @api private
 module Nanoc::Deploying::Deployers
 end

data/lib/nanoc/deploying/deployers/git.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nanoc::Deploying::Deployers
-  # A deployer that deploys a site using [Git](http://git-scm.com).
+  # A deployer that deploys a site using [Git](https://git-scm.com).
   #
   # @example A deployment configuration for GitHub Pages:
   #
@@ -16,7 +16,7 @@ module Nanoc::Deploying::Deployers
     identifier :git
 
     module Errors
-      class Generic < ::Nanoc::Error
+      class Generic < ::Nanoc::Core::Error
       end
 
       class OutputDirDoesNotExist < Generic
@@ -64,7 +64,7 @@ module Nanoc::Deploying::Deployers
         if remote_is_name?(remote)
           begin
             run_cmd(%W[git config --get remote.#{remote}.url])
-          rescue Nanoc::Extra::Piper::Error
+          rescue TTY::Command::ExitError
             raise Errors::RemoteDoesNotExist.new(remote)
           end
         end
@@ -72,7 +72,7 @@ module Nanoc::Deploying::Deployers
         # If the branch exists then switch to it, otherwise prompt the user to create one.
         begin
           run_cmd_unless_dry(%W[git checkout #{branch}])
-        rescue Nanoc::Extra::Piper::Error
+        rescue TTY::Command::ExitError
           raise Errors::BranchDoesNotExist.new(branch)
         end
 
@@ -97,24 +97,16 @@ module Nanoc::Deploying::Deployers
       remote !~ /:\/\/|@.+:/
     end
 
-    def run_cmd(cmd)
-      piper = Nanoc::Extra::Piper.new(stdout: $stdout, stderr: $stderr)
-      piper.run(cmd, nil)
+    def run_cmd(cmd, dry_run: false)
+      TTY::Command.new(printer: :null).run(*cmd, dry_run: dry_run)
     end
 
     def run_cmd_unless_dry(cmd)
-      if dry_run
-        puts cmd.join(' ')
-      else
-        run_cmd(cmd)
-      end
+      run_cmd(cmd, dry_run: dry_run)
     end
 
     def clean_repo?
-      stdout = StringIO.new
-      piper = Nanoc::Extra::Piper.new(stdout: stdout, stderr: $stderr)
-      piper.run(%w[git status --porcelain], nil)
-      stdout.string.empty?
+      TTY::Command.new(printer: :null).run('git status --porcelain').out.empty?
     end
   end
 end