nanoc 2.0.4 → 2.1

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

@@ -0,0 +1,76 @@
+module Nanoc::CLI
+
+  class CreateTemplateCommand < Command # :nodoc:
+
+    def name
+      'create_template'
+    end
+
+    def aliases
+      [ 'ct' ]
+    end
+
+    def short_desc
+      'create a template'
+    end
+
+    def long_desc
+      'Create a new template in the current site.'
+    end
+
+    def usage
+      "nanoc create_template [name]"
+    end
+
+    def option_definitions
+      [
+        # --vcs
+        {
+          :long => 'vcs', :short => 'c', :argument => :required,
+          :desc => 'select the VCS to use'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.length != 1
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      # Extract arguments
+      name = arguments[0]
+
+      # Check template name
+      if name.include?('/')
+        $stderr.puts 'Template names cannot contain slashes; aborting.'
+        exit 1
+      end
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Set VCS if possible
+      @base.set_vcs(options[:vcs])
+
+      # Setup notifications
+      Nanoc::NotificationCenter.on(:file_created) do |file_path|
+        Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
+      end
+
+      # Create template
+      template = Nanoc::Template.new(
+        "Hi, I'm a new template. Please edit me!",
+        { :title => "A Title" },
+        name
+      )
+      template.site = @base.site
+      template.save
+
+      puts "A template named '#{name}' has been created."
+    end
+
+  end
+
+end

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

@@ -0,0 +1,69 @@
+module Nanoc::CLI
+
+  class HelpCommand < Command # :nodoc:
+
+    def name
+      'help'
+    end
+
+    def aliases
+      []
+    end
+
+    def short_desc
+      'show help for a command'
+    end
+
+    def long_desc
+      'Show help for the given command, or show general help. When no ' +
+      'command is given, a list of available commands is displayed, as ' +
+      'well as a list of global commandline options. When a command is ' +
+      'given, a command description as well as command-specific ' +
+      'commandline options are shown.'
+    end
+
+    def usage
+      "nanoc help [command]"
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.size > 1
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      if arguments.length == 0
+        # Build help text
+        text = ''
+
+        # Add title
+        text << "nanoc, a static site compiler written in Ruby.\n"
+
+        # Add available commands
+        text << "\n"
+        text << "Available commands:\n"
+        text << "\n"
+        @base.commands.sort.each do |command|
+          text << sprintf("    %-20s %s\n", command.name, command.short_desc)
+        end
+
+        # Add global options
+        text << "\n"
+        text << "Global options:\n"
+        text << "\n"
+        @base.global_option_definitions.sort { |x,y| x[:long] <=> y[:long] }.each do |opt_def|
+          text << sprintf("    -%1s --%-15s %s\n", opt_def[:short], opt_def[:long], opt_def[:desc])
+        end
+
+        # Display text
+        puts text
+      elsif arguments.length == 1
+        command = @base.command_named(arguments[0])
+        puts command.help
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,114 @@
+module Nanoc::CLI
+
+  class InfoCommand < Command # :nodoc:
+
+    def name
+      'info'
+    end
+
+    def aliases
+      []
+    end
+
+    def short_desc
+      'show info about available plugins'
+    end
+
+    def long_desc
+      'Show a list of available plugins, including filters, data sources ' +
+      'and routers. If the current directory contains a nanoc web site, ' +
+      'the plugins defined in this site will be shown as well.'
+    end
+
+    def usage
+      "nanoc info"
+    end
+
+    def option_definitions
+      []
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.size != 0
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      # Get list of plugins (before and after)
+      plugins_before  = find_all_plugins
+      @base.site
+      plugins_after   = find_all_plugins
+
+      # Get structured list of plugins
+      plugins = {}
+      plugin_classes.each do |klass|
+        plugins[klass] = {
+          :builtin  => plugins_before[klass],
+          :custom   => plugins_after[klass] - plugins_before[klass]
+        }
+      end
+
+      # Find longest name
+      max_length = plugins.values.map { |k| k.values }.flatten.map { |k| k.identifiers.join(', ').length }.max + 2
+
+      plugins.each_pair do |superclass, structured_plugins|
+        # Print kind
+        kind = name_for_plugin_class(superclass)
+        puts "#{kind}:"
+        puts
+
+        # Print plugins organised by subtype
+        [ :builtin, :custom ].each do |type|
+          # Find relevant plugins
+          subclasses = structured_plugins[type]
+
+          # Print type
+          puts "  #{type}:"
+          if subclasses.empty?
+            puts "    (none)"
+            next
+          end
+
+          # Print plugins
+          subclasses.sort_by { |k| k.identifier.to_s }.each do |klass|
+            # Get data
+            is_custom   = !plugins_before[superclass].include?(klass)
+            klass_name  = klass.to_s
+            klass_id    = klass.identifiers.join(', ')
+
+            # Display
+            puts sprintf("    %-#{max_length}s (%s)", klass_id, klass_name)
+          end
+        end
+
+        puts
+      end
+    end
+
+  private
+
+    PLUGIN_CLASSES = {
+      Nanoc::Filter     => 'Filters',
+      Nanoc::DataSource => 'Data Sources',
+      Nanoc::Router     => 'Routers',
+      Nanoc::Extra::VCS => 'VCSes'
+    }
+
+    def find_all_plugins
+      plugin_classes.inject({}) do |memo, klass|
+        memo.merge(klass => Nanoc::Plugin::MAP[klass].values.uniq)
+      end
+    end
+
+    def plugin_classes
+      PLUGIN_CLASSES.keys
+    end
+
+    def name_for_plugin_class(klass)
+      PLUGIN_CLASSES[klass]
+    end
+
+  end
+
+end

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

@@ -0,0 +1,141 @@
+module Nanoc::CLI
+
+  class SwitchCommand < Command # :nodoc:
+
+    def name
+      'switch'
+    end
+
+    def aliases
+      []
+    end
+
+    def short_desc
+      'switch the site to a new data source'
+    end
+
+    def long_desc
+      'Move the data stored in the site to a new, given data source.' +
+      "\n" +
+      'The given new data source may need additional configuration ' +
+      'parameters that cannot be specified on the commandline. These ' +
+      'should be stored in the configuration file (config.yaml) BEFORE ' +
+      'executing the switch command.' +
+      "\n" +
+      'This command first loads all existing data into memory, destroys ' +
+      'the on-disk data, changes the site\'s data source, and finally ' +
+      'writes the data back to the disk using the new data source. Because ' +
+      'of this action\'s destructive nature, THIS OPERATION SHOULD NOT BE ' +
+      'INTERRUPTED as interruption could result in data loss.' +
+      "\n" +
+      'This command will change data, and it is therefore recommended to ' +
+      'make a backup in case something goes wrong.'
+    end
+
+    def usage
+      "nanoc switch [options]"
+    end
+
+    def option_definitions
+      [
+        # --vcs
+        {
+          :long => 'vcs', :short => 'c', :argument => :required,
+          :desc => 'select the VCS to use'
+        },
+        # --yes
+        {
+          :long => 'yes', :short => 'y', :argument => :forbidden,
+          :desc => 'switches the data source without warning'
+        },
+        # --datasource
+        {
+          :long => 'datasource', :short => 'd', :argument => :required,
+          :desc => 'specify the new data source for the site'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.size != 0
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      # Check options
+      unless options.has_key?(:datasource)
+        $stderr.puts 'A new data source should be specified using the ' +
+                     '-d/--datasource option.'
+        exit 1
+      end
+
+      # Find data source
+      data_source = Nanoc::DataSource.named(options[:datasource])
+      if data_source.nil?
+        $stderr.puts "Unrecognised data source: #{options[:datasource]}"
+        exit 1
+      end
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Set VCS if possible
+      @base.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 set up the data ' +
+                     'source for this site? Setting up the data source ' +
+                     'will remove 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 'To continue, use the -y/--yes option, like "nanoc ' +
+                     'switch -y".'
+        exit 1
+      end
+
+      # Setup notifications
+      Nanoc::NotificationCenter.on(:file_created) do |file_path|
+        Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
+      end
+      Nanoc::NotificationCenter.on(:file_updated) do |file_path|
+        Nanoc::CLI::Logger.instance.file(:high, :update, file_path)
+      end
+
+      # Load data
+      @base.site.load_data
+
+      # Destroy existing data
+      @base.site.data_source.destroy
+
+      # Update configuration
+      @base.site.config[:data_source] = options[:datasource]
+      @base.site.instance_eval { @data_source = data_source.new(self) }
+      File.open('config.yaml', 'w') { |io| io.write(YAML.dump(@base.site.config.stringify_keys)) }
+
+      # Set VCS on new data source if possible
+      @base.set_vcs(options[:vcs])
+
+      @base.site.data_source.loading do
+        # Create initial data source
+        @base.site.data_source.setup
+
+        # Store all data
+        @base.site.pages.each { |p| @base.site.data_source.save_page(p) }
+        @base.site.data_source.save_page_defaults(@base.site.page_defaults)
+        @base.site.layouts.each { |l| @base.site.data_source.save_layout(l) }
+        @base.site.templates.each { |t| @base.site.data_source.save_template(t) }
+        @base.site.data_source.save_code(@base.site.code)
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,91 @@
+module Nanoc::CLI
+
+  class UpdateCommand < Command # :nodoc:
+
+    def name
+      'update'
+    end
+
+    def aliases
+      []
+    end
+
+    def short_desc
+      'update the data stored by the data source to a newer version'
+    end
+
+    def long_desc
+      '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.' +
+      "\n" +
+      'This command will change data, and it is therefore recommended to ' +
+      'make a backup in case something goes wrong.'
+    end
+
+    def usage
+      "nanoc update [options]"
+    end
+
+    def option_definitions
+      [
+        # --vcs
+        {
+          :long => 'vcs', :short => 'c', :argument => :required,
+          :desc => 'select the VCS to use'
+        },
+        # --yes
+        {
+          :long => 'yes', :short => 'y', :argument => :forbidden,
+          :desc => 'updates the data without warning'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.size != 0
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Set VCS if possible
+      @base.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
+      @base.site.data_source.update
+    end
+
+  end
+
+end