nanoc 4.1.1 → 4.1.2

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

@@ -1,7 +1,7 @@
 module Nanoc::Int
   # @api private
   class ItemRepWriter
-    TMP_TEXT_ITEMS_DIR = 'text_items'
+    TMP_TEXT_ITEMS_DIR = 'text_items'.freeze
 
     def write(item_rep, raw_path)
       # Create parent directory

data/lib/nanoc/base/views/config_view.rb

@@ -1,7 +1,7 @@
 module Nanoc
   class ConfigView < ::Nanoc::View
     # @api private
-    NONE = Object.new
+    NONE = Object.new.freeze
 
     # @api private
     def initialize(config, context)

data/lib/nanoc/base/views/item_rep_view.rb

@@ -15,7 +15,7 @@ module Nanoc
     def ==(other)
       other.respond_to?(:item) && other.respond_to?(:name) && item == other.item && name == other.name
     end
-    alias_method :eql?, :==
+    alias eql? ==
 
     # @see Object#hash
     def hash

data/lib/nanoc/base/views/item_without_reps_view.rb

@@ -33,7 +33,7 @@ module Nanoc
 
       parent = @context.items[parent_identifier]
 
-      parent && self.class.new(parent, @context).freeze
+      parent && self.class.new(parent, @context)
     end
 
     # @return [Boolean] True if the item is binary, false otherwise

data/lib/nanoc/base/views/mixins/document_view_mixin.rb

@@ -1,7 +1,7 @@
 module Nanoc
   module DocumentViewMixin
     # @api private
-    NONE = Object.new
+    NONE = Object.new.freeze
 
     # @api private
     def initialize(document, context)
@@ -18,7 +18,7 @@ module Nanoc
     def ==(other)
       other.respond_to?(:identifier) && identifier == other.identifier
     end
-    alias_method :eql?, :==
+    alias eql? ==
 
     # @see Object#hash
     def hash
@@ -53,14 +53,12 @@ module Nanoc
 
       if unwrap.attributes.key?(key)
         unwrap.attributes[key]
+      elsif !fallback.equal?(NONE)
+        fallback
+      elsif block_given?
+        yield(key)
       else
-        if !fallback.equal?(NONE)
-          fallback
-        elsif block_given?
-          yield(key)
-        else
-          raise KeyError, "key not found: #{key.inspect}"
-        end
+        raise KeyError, "key not found: #{key.inspect}"
       end
     end
 

data/lib/nanoc/base/views/view.rb

@@ -8,5 +8,19 @@ module Nanoc
     def _context
       @context
     end
+
+    # @api private
+    def unwrap
+      raise NotImplementedError
+    end
+
+    # True if the wrapped object is frozen; false otherwise.
+    #
+    # @return [Boolean]
+    #
+    # @see Object#frozen?
+    def frozen?
+      unwrap.frozen?
+    end
   end
 end

data/lib/nanoc/cli.rb

@@ -180,11 +180,11 @@ module Nanoc::CLI
   def self.wrap_in_cleaning_stream(io)
     cio = ::Nanoc::CLI::CleaningStream.new(io)
 
-    unless self.enable_utf8?(io)
+    unless enable_utf8?(io)
       cio.add_stream_cleaner(Nanoc::CLI::StreamCleaners::UTF8)
     end
 
-    unless self.enable_ansi_colors?(io)
+    unless enable_ansi_colors?(io)
       cio.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
     end
 

data/lib/nanoc/cli/ansi_string_colorizer.rb

@@ -11,7 +11,7 @@ module Nanoc::CLI
       green: "\e[32m",
       yellow: "\e[33m",
       blue: "\e[34m",
-    }
+    }.freeze
 
     # @param [String] s The string to colorize
     #

data/lib/nanoc/cli/cleaning_stream.rb

@@ -114,7 +114,7 @@ module Nanoc::CLI
 
     # @see IO.winsize=
     def winsize=(arg)
-      @stream.winsize = (arg)
+      @stream.winsize = arg
     end
 
     # @see IO.sync

data/lib/nanoc/cli/command_runner.rb

@@ -20,7 +20,7 @@ module Nanoc::CLI
     def site
       # Load site if possible
       @site ||= nil
-      if self.is_in_site_dir? && @site.nil?
+      if is_in_site_dir? && @site.nil?
         @site = Nanoc::Int::SiteLoader.new.new_from_cwd
       end
 
@@ -39,26 +39,19 @@ module Nanoc::CLI
     def in_site_dir?
       Nanoc::Int::SiteLoader.cwd_is_nanoc_site?
     end
-    alias_method :is_in_site_dir?, :in_site_dir?
+    alias is_in_site_dir? in_site_dir?
 
-    # Asserts that the current working directory contains a site
-    # ({Nanoc::Int::Site} instance). If no site is present, prints an error
-    # message and exits.
+    # Asserts that the current working directory contains a site and loads the site into memory.
     #
     # @return [void]
-    def require_site
+    def load_site
+      print 'Loading site… '
+      $stdout.flush
+
       if site.nil?
         raise ::Nanoc::Int::Errors::GenericTrivial, 'The current working directory does not seem to be a Nanoc site.'
       end
-    end
 
-    # Asserts that the current working directory contains a site (just like
-    # {#require_site}) and loads the site into memory.
-    #
-    # @return [void]
-    def load_site
-      print 'Loading site… '
-      require_site
       puts 'done'
     end
 

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

@@ -12,7 +12,7 @@ module Nanoc::CLI::Commands
   class Check < ::Nanoc::CLI::CommandRunner
     def run
       validate_options_and_arguments
-      require_site
+      load_site
 
       runner = Nanoc::Extra::Checking::Runner.new(site)
 

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

@@ -15,7 +15,7 @@ module Nanoc::CLI::Commands
       end
     end
 
-    DEFAULT_CONFIG = <<EOS unless defined? DEFAULT_CONFIG
+    DEFAULT_CONFIG = <<EOS.freeze unless defined? DEFAULT_CONFIG
 # The syntax to use for patterns in the Rules file. Can be either `"glob"`
 # (default) or `"legacy"`. The former will enable glob patterns, which behave
 # like Ruby’s File.fnmatch. The latter will enable Nanoc 3.x-style patterns.
@@ -108,7 +108,7 @@ checks:
     exclude_files: []
 EOS
 
-    DEFAULT_RULES = <<EOS unless defined? DEFAULT_RULES
+    DEFAULT_RULES = <<EOS.freeze unless defined? DEFAULT_RULES
 #!/usr/bin/env ruby
 
 compile '/**/*.html' do
@@ -139,7 +139,7 @@ end
 layout '/**/*', :erb
 EOS
 
-    DEFAULT_ITEM = <<EOS unless defined? DEFAULT_ITEM
+    DEFAULT_ITEM = <<EOS.freeze unless defined? DEFAULT_ITEM
 ---
 title: Home
 ---
@@ -156,7 +156,7 @@ title: Home
 <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
+    DEFAULT_STYLESHEET = <<EOS.freeze unless defined? DEFAULT_STYLESHEET
 * {
   margin: 0;
   padding: 0;
@@ -260,7 +260,7 @@ a:hover {
 }
 EOS
 
-    DEFAULT_LAYOUT = <<EOS unless defined? DEFAULT_LAYOUT
+    DEFAULT_LAYOUT = <<EOS.freeze unless defined? DEFAULT_LAYOUT
 <!DOCTYPE HTML>
 <html lang="en">
   <head>

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

@@ -10,7 +10,7 @@ module Nanoc::CLI::Commands
     def run
       require 'pry'
 
-      require_site
+      load_site
 
       Nanoc::Int::Context.new(env).pry
     end

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

@@ -73,13 +73,13 @@ module Nanoc::CLI::Commands
       Nanoc::Filter,
       Nanoc::DataSource,
       Nanoc::Extra::Deployer,
-    ] unless defined? PLUGIN_CLASS_ORDER
+    ].freeze unless defined? PLUGIN_CLASS_ORDER
 
     PLUGIN_CLASSES = {
       Nanoc::Filter          => 'Filters',
       Nanoc::DataSource      => 'Data Sources',
       Nanoc::Extra::Deployer => 'Deployers',
-    } unless defined? PLUGIN_CLASSES
+    }.freeze unless defined? PLUGIN_CLASSES
 
     def name_for_plugin_class(klass)
       PLUGIN_CLASSES[klass]

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

@@ -8,7 +8,7 @@ Prints the rules used for all items and layouts in the current site.
 module Nanoc::CLI::Commands
   class ShowRules < ::Nanoc::CLI::CommandRunner
     def run
-      require_site
+      load_site
 
       @c = Nanoc::CLI::ANSIStringColorizer
       @reps = site.compiler.reps

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

@@ -18,7 +18,7 @@ module Nanoc::CLI::Commands
       load_adsf
       require 'rack'
 
-      require_site
+      load_site
 
       # Set options
       options_for_rack = {

data/lib/nanoc/cli/error_handler.rb

@@ -138,7 +138,6 @@ module Nanoc::CLI
       write_version_information(stream, verbose: true)
       write_system_information(stream, verbose: true)
       write_installed_gems(stream, verbose: true)
-      write_environment(stream, verbose: true)
       write_gemfile_lock(stream, verbose: true)
       write_load_paths(stream, verbose: true)
     end
@@ -208,7 +207,7 @@ module Nanoc::CLI
       'rubypants'      => 'rubypants',
       'sass'           => 'sass',
       'w3c_validators' => 'w3c_validators',
-    }
+    }.freeze
 
     # Attempts to find a resolution for the given error, or nil if no
     # resolution can be automatically obtained.
@@ -226,7 +225,7 @@ module Nanoc::CLI
 
         # Build message
         if gem_name
-          if self.using_bundler?
+          if using_bundler?
             'Make sure the gem is added to Gemfile and run `bundle install`.'
           else
             "Install the '#{gem_name}' gem using `gem install #{gem_name}`."
@@ -262,7 +261,7 @@ module Nanoc::CLI
 
       stream.puts "#{error.class}: #{error.message}"
       resolution = resolution_for(error)
-      stream.puts "#{resolution}" if resolution
+      stream.puts resolution.to_s if resolution
     end
 
     def write_compilation_stack(stream, _error, verbose: false)
@@ -320,13 +319,6 @@ module Nanoc::CLI
       end
     end
 
-    def write_environment(stream, verbose: false)
-      write_section_header(stream, 'Environment', verbose: verbose)
-      ENV.sort.each do |e|
-        stream.puts "#{e.first} => #{e.last.inspect}"
-      end
-    end
-
     def write_gemfile_lock(stream, verbose: false)
       if File.exist?('Gemfile.lock')
         write_section_header(stream, 'Gemfile.lock', verbose: verbose)

data/lib/nanoc/cli/logger.rb

@@ -14,7 +14,7 @@ module Nanoc::CLI
       identical: '',    # (nothing)
       skip: '',         # (nothing)
       delete: "\e[31m"  # red
-    }
+    }.freeze
 
     include Singleton
 
@@ -48,7 +48,7 @@ module Nanoc::CLI
           "\e[0m",
           duration.nil? ? '' : format('[%2.2fs]  ', duration),
           name,
-        )
+        ),
       )
     end
 

data/lib/nanoc/data_sources/filesystem_unified.rb

@@ -89,11 +89,12 @@ module Nanoc::DataSources
         return Nanoc::Identifier.new(filename)
       end
 
-      if filename =~ /(^|\/)index(\.[^\/]+)?$/
-        regex = @config && @config[:allow_periods_in_identifiers] ? /\/?(index)?(\.[^\/\.]+)?$/ : /\/?index(\.[^\/]+)?$/
-      else
-        regex = @config && @config[:allow_periods_in_identifiers] ? /\.[^\/\.]+$/ : /\.[^\/]+$/
-      end
+      regex =
+        if filename =~ /(^|\/)index(\.[^\/]+)?$/
+          @config && @config[:allow_periods_in_identifiers] ? /\/?(index)?(\.[^\/\.]+)?$/ : /\/?index(\.[^\/]+)?$/
+        else
+          @config && @config[:allow_periods_in_identifiers] ? /\.[^\/\.]+$/ : /\.[^\/]+$/
+        end
       Nanoc::Identifier.new(filename.sub(regex, ''), type: :legacy)
     end
   end

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

@@ -90,7 +90,7 @@ module ::Nanoc::Extra::Checking::Checks
       end
 
       # Skip excluded URLs
-      return nil if self.excluded?(href)
+      return nil if excluded?(href)
 
       # Skip non-HTTP URLs
       return nil if url.scheme !~ /^https?$/
@@ -142,11 +142,12 @@ module ::Nanoc::Extra::Checking::Checks
     end
 
     def path_for_url(url)
-      if url.path.nil? || url.path.empty?
-        path = '/'
-      else
-        path = url.path
-      end
+      path =
+        if url.path.nil? || url.path.empty?
+          '/'
+        else
+          url.path
+        end
 
       if url.query
         path << '?' << url.query

data/lib/nanoc/extra/checking/checks/internal_links.rb

@@ -34,7 +34,7 @@ module Nanoc::Extra::Checking::Checks
       return true if href == '.'
 
       # Skip hrefs that are specified in the exclude configuration
-      return true if self.excluded?(href)
+      return true if excluded?(href)
 
       # Remove target
       path = href.sub(/#.*$/, '')
@@ -48,11 +48,12 @@ module Nanoc::Extra::Checking::Checks
       path = URI.unescape(path)
 
       # Make absolute
-      if path[0, 1] == '/'
-        path = @config[:output_dir] + path
-      else
-        path = ::File.expand_path(path, ::File.dirname(origin))
-      end
+      path =
+        if path[0, 1] == '/'
+          @config[:output_dir] + path
+        else
+          ::File.expand_path(path, ::File.dirname(origin))
+        end
 
       # Check whether file exists
       return true if File.file?(path)

data/lib/nanoc/extra/checking/checks/mixed_content.rb

@@ -25,7 +25,7 @@ module Nanoc::Extra::Checking::Checks
     def guaranteed_insecure?(href)
       protocol = PROTOCOL_PATTERN.match(href)
 
-      protocol && protocol[1].downcase == 'http'
+      protocol && protocol[1].casecmp('http').zero?
     end
   end
 end

data/lib/nanoc/extra/checking/runner.rb

@@ -3,7 +3,7 @@ module Nanoc::Extra::Checking
   #
   # @api private
   class Runner
-    CHECKS_FILENAMES = ['Checks', 'Checks.rb', 'checks', 'checks.rb']
+    CHECKS_FILENAMES = ['Checks', 'Checks.rb', 'checks', 'checks.rb'].freeze
 
     # @param [Nanoc::Int::Site] site The Nanoc site this runner is for
     def initialize(site)
@@ -19,7 +19,7 @@ module Nanoc::Extra::Checking
     def dsl_present?
       checks_filename && File.file?(checks_filename)
     end
-    alias_method :has_dsl?, :dsl_present?
+    alias has_dsl? dsl_present?
 
     # Lists all available checks on stdout.
     #
@@ -65,11 +65,12 @@ module Nanoc::Extra::Checking
     def load_dsl_if_available
       @dsl_loaded ||= false
       unless @dsl_loaded
-        if self.dsl_present?
-          @dsl = Nanoc::Extra::Checking::DSL.from_file(checks_filename)
-        else
-          @dsl = nil
-        end
+        @dsl =
+          if dsl_present?
+            Nanoc::Extra::Checking::DSL.from_file(checks_filename)
+          else
+            nil
+          end
         @dsl_loaded = true
       end
     end