nanoc 4.11.12 → 4.11.13

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

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  module MutableDocumentViewMixin
-    # @api private
-    class DisallowedAttributeValueError < Nanoc::Error
-      attr_reader :value
-
-      def initialize(value)
-        @value = value
-      end
-
-      def message
-        "The #{value.class} cannot be stored inside an attribute. Store its identifier instead."
-      end
-    end
-
-    def raw_content=(arg)
-      _unwrap.content = Nanoc::Core::Content.create(arg)
-    end
-
-    # Sets the value for the given attribute.
-    #
-    # @param [Symbol] key
-    #
-    # @see Hash#[]=
-    def []=(key, value)
-      disallowed_value_classes = Set.new([
-        Nanoc::Core::Item,
-        Nanoc::Core::Layout,
-        Nanoc::CompilationItemView,
-        Nanoc::LayoutView,
-      ])
-      if disallowed_value_classes.include?(value.class)
-        raise DisallowedAttributeValueError.new(value)
-      end
-
-      _unwrap.set_attribute(key, value)
-    end
-
-    # Sets the identifier to the given argument.
-    #
-    # @param [String, Nanoc::Core::Identifier] arg
-    def identifier=(arg)
-      _unwrap.identifier = Nanoc::Core::Identifier.from(arg)
-    end
-
-    # Updates the attributes based on the given hash.
-    #
-    # @param [Hash] hash
-    #
-    # @return [self]
-    def update_attributes(hash)
-      hash.each { |k, v| _unwrap.set_attribute(k, v) }
-      self
-    end
-  end
-end

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

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class MutableConfigView < Nanoc::ConfigView
-    # Sets the value for the given attribute.
-    #
-    # @param [Symbol] key
-    #
-    # @see Hash#[]=
-    def []=(key, value)
-      @config[key] = value
-    end
-  end
-end

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

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class MutableIdentifiableCollectionView < Nanoc::IdentifiableCollectionView
-    # Deletes every object for which the block evaluates to true.
-    #
-    # @yieldparam [#identifier] object
-    #
-    # @yieldreturn [Boolean]
-    #
-    # @return [self]
-    def delete_if(&_block)
-      @objects = @objects.reject { |o| yield(view_class.new(o, @context)) }
-      self
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class MutableItemCollectionView < Nanoc::MutableIdentifiableCollectionView
-    # @api private
-    def view_class
-      Nanoc::MutableItemView
-    end
-
-    # Creates a new item and adds it to the site’s collection of items.
-    #
-    # @param [String] content The uncompiled item content (if it is a textual
-    #   item) or the path to the filename containing the content (if it is a
-    #   binary item).
-    #
-    # @param [Hash] attributes A hash containing this item's attributes.
-    #
-    # @param [Nanoc::Core::Identifier, String] identifier This item's identifier.
-    #
-    # @param [Boolean] binary Whether or not this item is binary
-    #
-    # @param [String] filename Absolute path to the file
-    #   containing this content (if any)
-    #
-    # @return [self]
-    def create(content, attributes, identifier, binary: false, filename: nil)
-      content = Nanoc::Core::Content.create(content, binary: binary, filename: filename)
-      @objects = @objects.add(Nanoc::Core::Item.new(content, attributes, identifier))
-      self
-    end
-  end
-end

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class MutableItemView < Nanoc::BasicItemView
-    include Nanoc::MutableDocumentViewMixin
-  end
-end

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

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class MutableLayoutCollectionView < Nanoc::MutableIdentifiableCollectionView
-    # @api private
-    def view_class
-      Nanoc::MutableLayoutView
-    end
-
-    # Creates a new layout and adds it to the site’s collection of layouts.
-    #
-    # @param [String] content The layout content.
-    #
-    # @param [Hash] attributes A hash containing this layout's attributes.
-    #
-    # @param [Nanoc::Core::Identifier, String] identifier This layout's identifier.
-    #
-    # @return [self]
-    def create(content, attributes, identifier)
-      @objects = @objects.add(Nanoc::Core::Layout.new(content, attributes, identifier))
-      self
-    end
-  end
-end

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

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class MutableLayoutView < Nanoc::LayoutView
-    include Nanoc::MutableDocumentViewMixin
-  end
-end

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

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class PostCompileItemCollectionView < Nanoc::IdentifiableCollectionView
-    # @api private
-    def view_class
-      Nanoc::PostCompileItemView
-    end
-  end
-end

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

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class PostCompileItemRepCollectionView < Nanoc::BasicItemRepCollectionView
-    # @api private
-    def view_class
-      Nanoc::PostCompileItemRepView
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class PostCompileItemRepView < ::Nanoc::BasicItemRepView
-    def item_view_class
-      Nanoc::PostCompileItemView
-    end
-
-    def compiled_content(snapshot: nil)
-      compilation_context = @context.compilation_context
-      snapshot_contents = compilation_context.compiled_content_cache[_unwrap] || {}
-
-      snapshot_name = snapshot || (snapshot_contents[:pre] ? :pre : :last)
-
-      unless snapshot_contents[snapshot_name]
-        raise Nanoc::Int::Errors::NoSuchSnapshot.new(_unwrap, snapshot_name)
-      end
-
-      content = snapshot_contents[snapshot_name]
-      if content.binary?
-        raise Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem.new(_unwrap)
-      end
-
-      content.string
-    end
-
-    def raw_path(snapshot: :last)
-      @item_rep.raw_path(snapshot: snapshot)
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class PostCompileItemView < Nanoc::CompilationItemView
-    def reps
-      Nanoc::PostCompileItemRepCollectionView.new(@context.reps[_unwrap], @context)
-    end
-
-    # @deprecated Use {#modified_reps} instead
-    def modified
-      modified_reps
-    end
-
-    def modified_reps
-      reps.select { |rep| rep._unwrap.modified? }
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Nanoc
-  class View
-    include Nanoc::Core::ContractsSupport
-
-    # @api private
-    # TODO: disallow nil
-    contract C::Maybe[C::Or[
-      Nanoc::Core::ViewContextForCompilation,
-      Nanoc::Core::ViewContextForPreCompilation,
-      Nanoc::Core::ViewContextForShell
-    ]] => C::Any
-    def initialize(context)
-      @context = context
-    end
-
-    # @api private
-    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
-
-    def inspect
-      "<#{self.class}>"
-    end
-  end
-end

data/lib/nanoc/cli.rb

@@ -1,241 +0,0 @@
-# frozen_string_literal: true
-
-begin
-  require 'cri'
-rescue LoadError => e
-  $stderr.puts e
-  $stderr.puts "If you are using a Gemfile, make sure that the Gemfile contains Nanoc ('gem \"nanoc\"')."
-  exit 1
-end
-
-# @api private
-module Nanoc::CLI
-  module Commands
-  end
-end
-
-require_relative 'cli/ansi_string_colorizer'
-require_relative 'cli/logger'
-require_relative 'cli/command_runner'
-require_relative 'cli/cleaning_stream'
-require_relative 'cli/stream_cleaners'
-require_relative 'cli/error_handler'
-require_relative 'cli/stack_trace_writer'
-require_relative 'cli/transform'
-
-require_relative 'cli/commands/compile_listeners/abstract'
-require_relative 'cli/commands/compile_listeners/debug_printer'
-require_relative 'cli/commands/compile_listeners/diff_generator'
-require_relative 'cli/commands/compile_listeners/file_action_printer'
-require_relative 'cli/commands/compile_listeners/timing_recorder'
-require_relative 'cli/commands/compile_listeners/aggregate'
-
-# @api private
-module Nanoc::CLI
-  # @return [Boolean] true if debug output is enabled, false if not
-  def self.debug?
-    @debug || false
-  end
-
-  # @param [Boolean] boolean true if debug output should be enabled,
-  #   false if it should not
-  #
-  # @return [void]
-  def self.debug=(boolean)
-    @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
-  #
-  # @return [void]
-  def self.run(args)
-    Nanoc::CLI::ErrorHandler.handle_while do
-      setup
-      root_command.run(args)
-    end
-  end
-
-  # @return [Cri::Command] The root command, i.e. the command-line tool itself
-  def self.root_command
-    @root_command
-  end
-
-  # Adds the given command to the collection of available commands.
-  #
-  # @param [Cri::Command] cmd The command to add
-  #
-  # @return [void]
-  def self.add_command(cmd)
-    root_command.add_command(cmd)
-  end
-
-  # Schedules the given block to be executed after the CLI has been set up.
-  #
-  # @return [void]
-  def self.after_setup(&block)
-    # TODO: decide what should happen if the CLI is already set up
-    add_after_setup_proc(block)
-  end
-
-  # Makes the command-line interface ready for use.
-  #
-  # @return [void]
-  def self.setup
-    setup_cleaning_streams
-    setup_commands
-    load_custom_commands
-    after_setup_procs.each(&:call)
-  end
-
-  # Sets up the root command and base subcommands.
-  #
-  # @return [void]
-  def self.setup_commands
-    # Reinit
-    @root_command = nil
-
-    # Add root command
-    filename = __dir__ + '/cli/commands/nanoc.rb'
-    @root_command = Cri::Command.load_file(filename, infer_name: true)
-
-    # Add help command
-    help_cmd = Cri::Command.new_basic_help
-    add_command(help_cmd)
-
-    # Add other commands
-    cmd_filenames = Dir[__dir__ + '/cli/commands/*.rb']
-    cmd_filenames.each do |cmd_filename|
-      basename = File.basename(cmd_filename, '.rb')
-
-      next if basename == 'nanoc'
-
-      cmd = Cri::Command.load_file(cmd_filename, infer_name: true)
-      add_command(cmd)
-    end
-
-    if defined?(Bundler)
-      # Discover external commands through Bundler
-      begin
-        Bundler.require(:nanoc)
-      rescue Bundler::GemfileNotFound
-        # When running Nanoc with Bundler being defined but
-        # no gemfile being present (rubygems automatically loads
-        # Bundler when executing from command line), don't crash.
-      end
-    end
-  end
-
-  # Loads site-specific commands.
-  #
-  # @return [void]
-  def self.load_custom_commands
-    if Nanoc::Int::SiteLoader.cwd_is_nanoc_site?
-      config = Nanoc::Int::ConfigLoader.new.new_from_cwd
-      config[:commands_dirs].each do |path|
-        load_commands_at(path)
-      end
-    end
-  end
-
-  def self.load_commands_at(path)
-    recursive_contents_of(path).each do |filename|
-      # Create command
-      command = Cri::Command.load_file(filename, infer_name: true)
-
-      # Get supercommand
-      pieces = filename.gsub(/^#{path}\/|\.rb$/, '').split('/')
-      pieces = pieces[0, pieces.size - 1] || []
-      root = Nanoc::CLI.root_command
-      supercommand = pieces.reduce(root) do |cmd, piece|
-        cmd.nil? ? nil : cmd.command_named(piece)
-      end
-
-      # Add to supercommand
-      if supercommand.nil?
-        raise "Cannot load command at #{filename} because its supercommand cannot be found"
-      end
-
-      supercommand.add_command(command)
-    end
-  end
-
-  # Loads the command in the file with the given filename.
-  #
-  # @param [String] filename The name of the file that contains the command
-  #
-  # @return [Cri::Command] The loaded command
-  #
-  # @deprecated
-  def self.load_command_at(filename)
-    # TODO: remove me one guard-nanoc is in this repo
-    Cri::Command.load_file(filename, infer_name: true)
-  end
-
-  # @return [Array] The directory contents
-  def self.recursive_contents_of(path)
-    return [] unless File.directory?(path)
-
-    files, dirs = *Dir[path + '/*'].sort.partition { |e| File.file?(e) }
-    dirs.each { |d| files.concat recursive_contents_of(d) }
-    files
-  end
-
-  # Wraps the given stream in a cleaning stream. The cleaning streams will
-  # have the proper stream cleaners configured.
-  #
-  # @param [IO] io The stream to wrap
-  #
-  # @return [::Nanoc::CLI::CleaningStream]
-  def self.wrap_in_cleaning_stream(io)
-    cio = ::Nanoc::CLI::CleaningStream.new(io)
-
-    unless enable_utf8?(io)
-      cio.add_stream_cleaner(Nanoc::CLI::StreamCleaners::UTF8)
-    end
-
-    unless enable_ansi_colors?(io)
-      cio.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
-    end
-
-    cio
-  end
-
-  # Wraps `$stdout` and `$stderr` in appropriate cleaning streams.
-  #
-  # @return [void]
-  def self.setup_cleaning_streams
-    $stdout = wrap_in_cleaning_stream($stdout)
-    $stderr = wrap_in_cleaning_stream($stderr)
-  end
-
-  # @return [Boolean] true if UTF-8 support is present, false if not
-  def self.enable_utf8?(io)
-    return true unless io.tty?
-
-    %w[LC_ALL LC_CTYPE LANG].any? { |e| ENV[e] =~ /UTF/i }
-  end
-
-  # @return [Boolean] true if color support is present, false if not
-  def self.enable_ansi_colors?(io)
-    io.tty? && !ENV.key?('NO_COLOR')
-  end
-
-  def self.after_setup_procs
-    @after_setup_procs || []
-  end
-
-  def self.add_after_setup_proc(proc)
-    @after_setup_procs ||= []
-    @after_setup_procs << proc
-  end
-end