nanoc-cli 4.11.13

data/lib/nanoc/cli/command_runner.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module CLI
+    # A command runner subclass for Nanoc commands that adds Nanoc-specific
+    # convenience methods and error handling.
+    #
+    # @api private
+    class CommandRunner < ::Cri::CommandRunner
+      # @see http://rubydoc.info/gems/cri/Cri/CommandRunner#call-instance_method
+      #
+      # @return [void]
+      def call
+        Nanoc::CLI::ErrorHandler.handle_while do
+          run
+        end
+      end
+
+      # @return [Boolean] true if the current working directory is a Nanoc site
+      #   directory, false otherwise
+      def in_site_dir?
+        Nanoc::Core::SiteLoader.cwd_is_nanoc_site?
+      end
+
+      def self.find_site_dir
+        start_here = Dir.pwd
+
+        here = start_here
+        until Nanoc::Core::SiteLoader.cwd_is_nanoc_site?
+          Dir.chdir('..')
+          return nil if Dir.pwd == here
+
+          here = Dir.pwd
+        end
+        here
+      ensure
+        Dir.chdir(start_here)
+      end
+
+      def self.enter_site_dir
+        dir = find_site_dir
+        if dir.nil?
+          raise ::Nanoc::Core::TrivialError, 'The current working directory, nor any of its parents, seems to be a Nanoc site.'
+        end
+
+        return if Dir.getwd == dir
+
+        $stderr.puts "Using Nanoc site in #{dir}"
+        Dir.chdir(dir)
+      end
+
+      # Asserts that the current working directory contains a site and loads the site into memory.
+      #
+      # @return [void]
+      def load_site
+        self.class.enter_site_dir
+
+        $stderr.print 'Loading site… '
+        $stderr.flush
+        site = Nanoc::Core::SiteLoader.new.new_from_cwd
+
+        $stderr.puts 'done'
+        site
+      end
+
+      # @return [Boolean] true if debug output is enabled, false if not
+      #
+      # @see Nanoc::CLI.debug?
+      def debug?
+        Nanoc::CLI.debug?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+usage 'compile [options]'
+summary 'compile items of this site'
+description <<~EOS
+  Compile all items of the current site.
+EOS
+no_params
+
+flag nil, :diff, 'generate diff'
+if Nanoc::Core::Feature.enabled?(Nanoc::Core::Feature::LIVE_CMD)
+  flag :w, :watch, 'watch for changes and recompile when needed'
+end
+
+module Nanoc::CLI::Commands
+  class Compile < ::Nanoc::CLI::CommandRunner
+    attr_accessor :listener_classes
+
+    def run
+      self.class.enter_site_dir
+
+      if options[:watch]
+        run_repeat
+      else
+        run_once
+      end
+    end
+
+    def run_repeat
+      require 'nanoc/live'
+      Nanoc::Live::LiveRecompiler.new(command_runner: self).run
+    end
+
+    def run_once
+      time_before = Time.now
+
+      @site = load_site
+
+      puts 'Compiling site…'
+      compiler = Nanoc::Core::Compiler.new_for(@site)
+      listener = Nanoc::CLI::CompileListeners::Aggregate.new(
+        command_runner: self,
+        site: @site,
+        compiler: compiler,
+      )
+      listener.run_while do
+        compiler.run_until_end
+      end
+
+      time_after = Time.now
+      puts
+      puts "Site compiled in #{format('%.2f', time_after - time_before)}s."
+    end
+  end
+end
+
+runner Nanoc::CLI::Commands::Compile

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

@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+usage 'create-site [options] path'
+aliases :create_site, :cs
+summary 'create a site'
+description 'Create a new site at the given path. The site will use the `filesystem` data source.'
+flag nil, :force, 'force creation of new site'
+param :path
+
+module Nanoc::CLI::Commands
+  class CreateSite < ::Nanoc::CLI::CommandRunner
+    class << self
+      protected
+
+      # Converts the given array to YAML format
+      def array_to_yaml(array)
+        '[ ' + array.map { |s| "'" + s + "'" }.join(', ') + ' ]'
+      end
+    end
+
+    DEFAULT_CONFIG = <<~EOS unless defined? DEFAULT_CONFIG
+      # A list of file extensions that Nanoc will consider to be textual rather than
+      # binary. If an item with an extension not in this list is found,  the file
+      # will be considered as binary.
+      text_extensions: #{array_to_yaml(Nanoc::Core::Configuration::DEFAULT_CONFIG[:text_extensions])}
+
+      prune:
+        auto_prune: true
+
+      data_sources:
+        - type: filesystem
+          encoding: utf-8
+    EOS
+
+    DEFAULT_RULES = <<~EOS unless defined? DEFAULT_RULES
+      #!/usr/bin/env ruby
+
+      compile '/index.html' do
+        layout '/default.*'
+        write '/index.html'
+      end
+
+      compile '/**/*.html' do
+        layout '/default.*'
+        write item.identifier.without_ext + '/index.html'
+      end
+
+      # This is an example rule that matches Markdown (.md) files, and filters them
+      # using the :kramdown filter. It is commented out by default, because kramdown
+      # is not bundled with Nanoc or Ruby.
+      #
+      #compile '/**/*.md' do
+      #  filter :kramdown
+      #  layout '/default.*'
+      #  write item.identifier.without_ext + '/index.html'
+      #end
+
+      compile '/**/*' do
+        write item.identifier.to_s
+      end
+
+      layout '/**/*', :erb
+    EOS
+
+    DEFAULT_ITEM = <<~EOS unless defined? DEFAULT_ITEM
+      ---
+      title: Home
+      ---
+
+      <h1>A Brand New Nanoc Site</h1>
+
+      <p>You’ve just created a new Nanoc site. The page you are looking at right now is the home page for your site. To get started, consider replacing this default homepage with your own customized homepage. Some pointers on how to do so:</p>
+
+      <ul>
+        <li><p><strong>Change this page’s content</strong> by editing the “index.html” file in the “content” directory. This is the actual page content, and therefore doesn’t include the header, sidebar or style information (those are part of the layout).</p></li>
+        <li><p><strong>Change the layout</strong>, which is the “default.html” file in the “layouts” directory, and create something unique (and hopefully less bland).</p></li>
+      </ul>
+
+      <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
+      * {
+        margin: 0;
+        padding: 0;
+
+        font-family: Georgia, Palatino, serif;
+      }
+
+      body {
+        background: #fff;
+      }
+
+      a {
+        text-decoration: none;
+      }
+
+      a:link,
+      a:visited {
+        color: #f30;
+      }
+
+      a:hover {
+        color: #f90;
+      }
+
+      #main {
+        position: absolute;
+
+        top: 40px;
+        left: 280px;
+
+        width: 500px;
+      }
+
+      #main h1 {
+        font-size: 40px;
+        font-weight: normal;
+
+        line-height: 40px;
+
+        letter-spacing: -1px;
+      }
+
+      #main p {
+        margin: 20px 0;
+
+        font-size: 15px;
+
+        line-height: 20px;
+      }
+
+      #main ul, #main ol {
+        margin: 20px;
+      }
+
+      #main li {
+        font-size: 15px;
+
+        line-height: 20px;
+      }
+
+      #main ul li {
+        list-style-type: square;
+      }
+
+      #sidebar {
+        position: absolute;
+
+        top: 40px;
+        left: 20px;
+        width: 200px;
+
+        padding: 20px 20px 0 0;
+
+        border-right: 1px solid #ccc;
+
+        text-align: right;
+      }
+
+      #sidebar h2 {
+        text-transform: uppercase;
+
+        font-size: 13px;
+
+        color: #333;
+
+        letter-spacing: 1px;
+
+        line-height: 20px;
+      }
+
+      #sidebar ul {
+        list-style-type: none;
+
+        margin: 20px 0;
+      }
+
+      #sidebar li {
+        font-size: 14px;
+
+        line-height: 20px;
+      }
+    EOS
+
+    DEFAULT_LAYOUT = <<~EOS unless defined? DEFAULT_LAYOUT
+      <!DOCTYPE HTML>
+      <html lang="en">
+        <head>
+          <meta charset="utf-8">
+          <title>A Brand New Nanoc Site - <%= @item[:title] %></title>
+          <link rel="stylesheet" href="/stylesheet.css">
+
+          <!-- you don't need to keep this, but it's cool for stats! -->
+          <meta name="generator" content="Nanoc <%= Nanoc::VERSION %>">
+        </head>
+        <body>
+          <div id="main">
+            <%= yield %>
+          </div>
+          <div id="sidebar">
+            <h2>Documentation</h2>
+            <ul>
+              <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="https://nanoc.ws/contributing/">Contributing</a></li>
+            </ul>
+          </div>
+        </body>
+      </html>
+    EOS
+
+    def run
+      path = arguments[:path]
+
+      # Check whether site exists
+      if File.exist?(path) && (!File.directory?(path) || !(Dir.entries(path) - %w[. ..]).empty?) && !options[:force]
+        raise(
+          Nanoc::Core::TrivialError,
+          "The site was not created because '#{path}' already exists. " \
+          'Re-run the command using --force to create the site anyway.',
+        )
+      end
+
+      # Build entire site
+      FileUtils.mkdir_p(path)
+      FileUtils.cd(File.join(path)) do
+        FileUtils.mkdir_p('content')
+        FileUtils.mkdir_p('layouts')
+        FileUtils.mkdir_p('lib')
+        FileUtils.mkdir_p('output')
+
+        write('nanoc.yaml', DEFAULT_CONFIG)
+        write('Rules', DEFAULT_RULES)
+        write('content/index.html', DEFAULT_ITEM)
+        write('content/stylesheet.css', DEFAULT_STYLESHEET)
+        write('layouts/default.html', DEFAULT_LAYOUT)
+      end
+
+      puts "Created a blank Nanoc site at '#{path}'. Enjoy!"
+    end
+
+    private
+
+    def write(filename, content)
+      File.write(filename, content)
+      Nanoc::CLI::Logger.instance.file(:high, :create, filename)
+    end
+  end
+end
+
+runner Nanoc::CLI::Commands::CreateSite

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+usage 'nanoc command [options] [arguments]'
+summary 'Nanoc, a static site compiler written in Ruby'
+default_subcommand 'compile'
+
+opt :l, :color, 'enable color' do
+  $stdout.remove_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
+  $stderr.remove_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
+end
+
+opt :d, :debug, 'enable debugging' do
+  Nanoc::CLI.debug = true
+end
+
+opt :e, :env, 'set environment', argument: :required do |value|
+  ENV.store('NANOC_ENV', value)
+end
+
+opt :h, :help, 'show the help message and quit' do |_value, cmd|
+  puts cmd.help
+  exit 0
+end
+
+opt :C, :'no-color', 'disable color' do
+  $stdout.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
+  $stderr.add_stream_cleaner(Nanoc::CLI::StreamCleaners::ANSIColors)
+end
+
+opt :V, :verbose, 'make output more detailed', multiple: true do |val|
+  Nanoc::CLI::Logger.instance.level = :low
+  Nanoc::CLI.verbosity = val.size
+end
+
+opt :v, :version, 'show version information and quit' do
+  puts Nanoc::Core.version_information
+  exit 0
+end
+
+opt :w, :warn, 'enable warnings' do
+  $-w = true
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+usage 'prune'
+summary 'remove files not managed by Nanoc from the output directory'
+description <<~EOS
+  Find all files in the output directory that do not correspond to an item
+  managed by Nanoc and remove them. Since this is a hazardous operation, an
+  additional `--yes` flag is needed as confirmation.
+
+  Also see the `auto_prune` configuration option in `nanoc.yaml` (`config.yaml`
+  for older Nanoc sites), which will automatically prune after compilation.
+EOS
+no_params
+
+flag :y, :yes,       'confirm deletion'
+flag :n, :'dry-run', 'print files to be deleted instead of actually deleting them'
+
+module Nanoc::CLI::Commands
+  class Prune < ::Nanoc::CLI::CommandRunner
+    def run
+      @site = load_site
+      res = Nanoc::Core::Compiler.new_for(@site).run_until_reps_built
+      reps = res.fetch(:reps)
+
+      if options.key?(:yes)
+        Nanoc::Core::Pruner.new(@site.config, reps, exclude: prune_config_exclude).run
+      elsif options.key?(:'dry-run')
+        Nanoc::Core::Pruner.new(@site.config, reps, exclude: prune_config_exclude, dry_run: true).run
+      else
+        $stderr.puts 'WARNING: Since the prune command is a destructive command, it requires an additional --yes flag in order to work.'
+        $stderr.puts
+        $stderr.puts 'Please ensure that the output directory does not contain any files (such as images or stylesheets) that are necessary but are not managed by Nanoc. If you want to get a list of all files that would be removed, pass --dry-run.'
+        exit 1
+      end
+    end
+
+    protected
+
+    def prune_config
+      @site.config[:prune] || {}
+    end
+
+    def prune_config_exclude
+      prune_config[:exclude] || {}
+    end
+  end
+end
+
+runner Nanoc::CLI::Commands::Prune