nanoc 3.2.4 → 3.3.0

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

@@ -0,0 +1,117 @@
+# encoding: utf-8
+
+usage       'debug'
+summary     'show debug information for this site'
+description <<-EOS
+Show information about all items, item representations and layouts in the
+current site.
+EOS
+
+module Nanoc::CLI::Commands
+
+  class Debug < ::Nanoc::CLI::CommandRunner
+
+    def run
+      # Make sure we are in a nanoc site directory
+      print "Loading site data... "
+      self.require_site
+      puts "done"
+      puts
+
+      # Get data
+      items   = self.site.items
+      reps    = items.map { |i| i.reps }.flatten
+      layouts = self.site.layouts
+
+      # Get dependency tracker
+      compiler = self.site.compiler
+      compiler.load
+      dependency_tracker = compiler.dependency_tracker
+
+      # Print item dependencies
+      puts '=== Item dependencies ======================================================='
+      puts
+      items.sort_by { |i| i.identifier }.each do |item|
+        puts "item #{item.identifier} depends on:"
+        predecessors = dependency_tracker.objects_causing_outdatedness_of(item).sort_by { |i| i ? i.identifier : '' }
+        predecessors.each do |pred|
+          if pred
+            puts "  [ #{format '%6s', pred.type} ] #{pred.identifier}"
+          else
+            puts "  ( removed item )"
+          end
+        end
+        puts "  (nothing)" if predecessors.empty?
+        puts
+      end
+
+      # Print representation paths
+      puts '=== Representation paths ===================================================='
+      puts
+      items.sort_by { |i| i.identifier }.each do |item|
+        item.reps.sort_by { |r| r.name.to_s }.each do |rep|
+          puts "item #{item.identifier}, rep #{rep.name}:"
+          if rep.raw_paths.empty?
+            puts "  (not written)"
+          end
+          length = rep.raw_paths.keys.map { |s| s.to_s.length }.max
+          rep.raw_paths.each do |snapshot_name, raw_path|
+            puts "  [ %-#{length}s ] %s" % [ snapshot_name, raw_path ]
+          end
+        end
+        puts
+      end
+
+      # Print representation outdatedness
+      puts '=== Representation outdatedness ============================================='
+      puts
+      items.sort_by { |i| i.identifier }.each do |item|
+        item.reps.sort_by { |r| r.name.to_s }.each do |rep|
+          puts "item #{item.identifier}, rep #{rep.name}:"
+          outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(rep)
+          if outdatedness_reason
+            puts "  is outdated: #{outdatedness_reason.message}"
+          else
+            puts "  is not outdated"
+          end
+        end
+        puts
+      end
+
+      # Print layout dependencies
+      puts '=== Layout dependencies ====================================================='
+      puts
+      layouts.sort_by { |l| l.identifier }.each do |layout|
+        puts "layout #{layout.identifier} depends on:"
+        predecessors = dependency_tracker.objects_causing_outdatedness_of(layout).sort_by { |i| i ? i.identifier : '' }
+        predecessors.each do |pred|
+          if pred
+            puts "  [ #{format '%6s', pred.type} ] #{pred.identifier}"
+          else
+            puts "  ( removed item )"
+          end
+        end
+        puts "  (nothing)" if predecessors.empty?
+        puts
+      end
+
+      # Print layouts
+      puts '=== Layouts'
+      puts
+      layouts.sort_by { |l| l.identifier }.each do |layout|
+        puts "layout #{layout.identifier}:"
+        outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(layout)
+        if outdatedness_reason
+          puts "  is outdated: #{outdatedness_reason.message}"
+        else
+          puts "  is not outdated"
+        end
+        puts
+      end
+    end
+
+  end
+
+end
+
+runner Nanoc::CLI::Commands::Debug

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

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+# Find all
+registry       = Nanoc::PluginRegistry.instance
+deployer_class = Nanoc::Extra::Deployer
+deployers      = registry.find_all(deployer_class)
+deployer_names = deployers.keys.sort_by { |k| k.to_s }
+
+usage       'deploy [options]'
+summary     'deploy the compiled site'
+description <<-EOS
+Deploys the compiled site. The compiled site contents in the output directory will be uploaded to the destination, which is specified using the -t/--target option.
+
+Available deployers: #{deployer_names.join(', ')}
+
+EOS
+
+option :t, :target,    'specify the location to deploy to', :argument => :required
+flag   :l, :list,      'list available locations to deploy to'
+option :n, :'dry-run', 'show what would be deployed'
+
+module Nanoc::CLI::Commands
+
+  class Deploy < ::Nanoc::CLI::CommandRunner
+
+    def run
+      require_site
+
+      # Get config
+      deploy_configs = site.config.fetch(:deploy) do
+        $stderr.puts "The site configuration has no deploy configuration."
+        exit 1
+      end
+
+      # List
+      if options[:list]
+        puts "Available deployment configurations:"
+        deploy_configs.keys.each do |name|
+          puts "  #{name}"
+        end
+        return
+      end
+
+      # Get target
+      target = options.fetch(:target) do
+        $stderr.puts "The deploy command requires a --target option."
+        exit 1
+      end
+      target = target.to_sym
+      config = deploy_configs.fetch(target) do
+        $stderr.puts "The site configuration has no deploy configuration for #{target}."
+        exit 1
+      end
+
+      # Get deployer
+      name = config.fetch(:kind) do
+        $stderr.puts "The specified deploy target does not have a kind."
+        $stderr.puts "(expected one of #{KIND_MAPPING.keys.join(', ')})"
+        exit 1
+      end
+      deployer_class = Nanoc::Extra::Deployer.named(name) do
+        $stderr.puts "The specified deploy target has an unrecognised kind (#{kind})."
+        $stderr.puts "(expected one of #{KIND_MAPPING.keys.join(', ')})"
+        exit 1
+      end
+
+      # Run
+      deployer = deployer_class.new(
+        site.config[:output_dir],
+        config,
+        :dry_run => options[:'dry-run'])
+      deployer.run
+    end
+
+  end
+
+end
+
+runner Nanoc::CLI::Commands::Deploy

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

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+summary     'show info about available plugins'
+usage       'info [options]'
+description <<-EOS
+Show a list of available plugins, including filters, data sources and VCSes.
+If the current directory contains a nanoc web site, the plugins defined in this site will be shown as well.
+EOS
+
+module Nanoc::CLI::Commands
+
+  class Info < ::Nanoc::CLI::CommandRunner
+
+    def run
+      # Check arguments
+      if arguments.size != 0
+        $stderr.puts "usage: #{command.usage}"
+        exit 1
+      end
+
+      # Get list of plugins (before and after)
+      plugins_before = Nanoc::Plugin.all
+      self.site.code_snippets if self.site
+      plugins_after  = Nanoc::Plugin.all
+
+      # Divide list of plugins into builtin and custom
+      plugins_builtin = plugins_before
+      plugins_custom  = plugins_after - plugins_before
+
+      # Find max identifiers length
+      plugin_with_longest_identifiers = plugins_after.inject do |longest, current|
+        longest[:identifiers].join(', ').size > current[:identifiers].join(', ').size ? longest : current
+      end
+      max_identifiers_length = plugin_with_longest_identifiers[:identifiers].join(', ').size
+
+      PLUGIN_CLASS_ORDER.each do |superclass|
+        plugins_with_this_superclass = {
+          :builtin => plugins_builtin.select { |p| p[:superclass] == superclass },
+          :custom  => plugins_custom.select  { |p| p[:superclass] == superclass }
+        }
+
+        # Print kind
+        kind = name_for_plugin_class(superclass)
+        puts "#{kind}:"
+        puts
+
+        # Print plugins organised by subtype
+        [ :builtin, :custom ].each do |type|
+          # Find relevant plugins
+          relevant_plugins = plugins_with_this_superclass[type]
+
+          # Print type
+          puts "  #{type}:"
+          if relevant_plugins.empty?
+            puts "    (none)"
+            next
+          end
+
+          # Print plugins
+          relevant_plugins.sort_by { |k| k[:identifiers].join(', ') }.each do |plugin|
+            # Display
+            puts sprintf(
+              "    %-#{max_identifiers_length}s (%s)",
+              plugin[:identifiers].join(', '),
+              plugin[:class].to_s.sub(/^::/, '')
+            )
+          end
+        end
+
+        puts
+      end
+    end
+
+  private
+
+    PLUGIN_CLASS_ORDER = [
+      Nanoc::Filter,
+      Nanoc::Extra::VCS,
+      Nanoc::DataSource,
+      Nanoc::Extra::Deployer
+    ]
+
+    PLUGIN_CLASSES = {
+      Nanoc::Filter          => 'Filters',
+      Nanoc::DataSource      => 'Data Sources',
+      Nanoc::Extra::VCS      => 'VCSes',
+      Nanoc::Extra::Deployer => 'Deployers'
+    }
+
+    def name_for_plugin_class(klass)
+      PLUGIN_CLASSES[klass]
+    end
+
+  end
+
+end
+
+runner Nanoc::CLI::Commands::Info

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

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+usage   'nanoc command [options] [arguments]'
+summary 'nanoc, a static site compiler written in Ruby'
+
+opt :l, :color, 'enable color' do
+  Nanoc::CLI::Logger.instance.color = true
+end
+
+opt :d, :debug, 'enable debugging' do
+  Nanoc::CLI.debug = true
+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
+  Nanoc::CLI::Logger.instance.color = false
+end
+
+opt :V, :verbose, 'make nanoc output more detailed' do
+  Nanoc::CLI::Logger.instance.level = :low
+end
+
+opt :v, :version, 'show version information and quit' do
+  puts Nanoc.version_information
+  exit 0
+end
+
+opt :w, :warn, 'enable warnings' do
+  $-w = true
+end
+
+run do |opts, args, cmd|
+  cmd.command_named('compile').run([])
+end

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

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+usage       'prune'
+summary     'removes 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 site configuration option in config.yaml, which will
+automatically prune after compilation.
+EOS
+
+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
+      require_site
+
+      if options.has_key?(:yes)
+        Nanoc::Extra::Pruner.new(self.site, :exclude => self.prune_config_exclude).run
+      elsif options.has_key?(:'dry-run')
+        Nanoc::Extra::Pruner.new(self.site, :exclude => self.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
+      self.site.config[:prune] || {}
+    end
+
+    def prune_config_exclude
+      self.prune_config[:exclude] || {}
+    end
+    
+  end
+
+end
+
+runner Nanoc::CLI::Commands::Prune

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

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+usage   'update [options]'
+summary 'update the data stored by the data source to a newer version'
+description <<-EOS
+Update the data stored by the data source to a newer format. The format in
+which data is stored can change between releases, and even though backward
+compatibility is usually preserved, it is often a good idea to store the site
+data in a newer format so newer features can be taken advantage of.
+
+This command will change data, and it is therefore recommended to make a
+backup in case something goes wrong.
+EOS
+
+required :c, :vcs, 'select the VCS to use'
+flag     :y, :yes, 'update the data without warning'
+
+module Nanoc::CLI::Commands
+
+  class Update < ::Nanoc::CLI::CommandRunner
+
+    def run
+      # Check arguments
+      if arguments.size != 0
+        $stderr.puts "usage: #{command.usage}"
+        exit 1
+      end
+
+      # Make sure we are in a nanoc site directory
+      self.require_site
+
+      # Set VCS if possible
+      self.set_vcs(options[:vcs])
+
+      # Check for -y switch
+      unless options.has_key?(:yes)
+        $stderr.puts '*************'
+        $stderr.puts '** WARNING **'
+        $stderr.puts '*************'
+        $stderr.puts
+        $stderr.puts 'Are you absolutely sure you want to update the ' +
+                     'content for this site? Updating the site content ' +
+                     'will change the structure of existing data. This ' +
+                     'operation is destructive and cannot be reverted. ' +
+                     'Please do not interrupt this operation; doing so can ' +
+                     'result in data loss. As always, consider making a ' +
+                     'backup copy.'
+        $stderr.puts
+        $stderr.puts 'If this nanoc site is versioned using a VCS ' +
+                     'supported by nanoc, consider using the --vcs option ' +
+                     'to have nanoc perform add/delete/move operations ' +
+                     'using the specified VCS. To get a list of VCSes ' +
+                     'supported by nanoc, issue the "info" command.'
+        $stderr.puts
+        $stderr.puts 'To continue, use the -y/--yes option, like "nanoc ' +
+                     'update -y".'
+        exit 1
+      end
+
+      # Update
+      self.site.data_sources.each do |data_source|
+        data_source.update
+      end
+    end
+
+  end
+
+end
+
+runner Nanoc::CLI::Commands::Update