nanoc 2.0 → 2.1

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

data/lib/nanoc/cli/ext.rb

@@ -0,0 +1,37 @@
+class String
+
+  # Word-wraps and indents the string.
+  #
+  # +width+:: The maximal width of each line. This also includes indentation,
+  #           i.e. the actual maximal width of the text is width-indentation.
+  #
+  # +indentation+:: The number of spaces to indent each wrapped line.
+  def wrap_and_indent(width, indentation)
+    # Split into paragraphs
+    paragraphs = self.split("\n").map { |p| p.strip }.reject { |p| p == '' }
+
+    # Wrap and indent each paragraph
+    paragraphs.map do |paragraph|
+      # Initialize
+      lines = []
+      line = ''
+
+      # Split into words
+      paragraph.split(/\s/).each do |word|
+        # Begin new line if it's too long
+        if (line + ' ' + word).length >= width
+          lines << line
+          line = ''
+        end
+
+        # Add word to line
+        line += (line == '' ? '' : ' ' ) + word
+      end
+      lines << line
+
+      # Join lines
+      lines.map { |l| ' '*indentation + l }.join("\n")
+    end.join("\n\n")
+  end
+
+end

data/lib/nanoc/cli/logger.rb

@@ -0,0 +1,66 @@
+require 'singleton'
+
+module Nanoc::CLI
+
+  # Nanoc::CLI::Logger is a singleton class responsible for generating
+  # feedback in the terminal.
+  class Logger
+
+    ACTION_COLORS = {
+      :create     => "\e[1m" + "\e[32m", # bold + green
+      :update     => "\e[1m" + "\e[33m", # bold + yellow
+      :identical  => "\e[1m",            # bold
+      :skip       => "\e[1m"             # bold
+    }
+
+    include Singleton
+
+    # The log leve, which can be :high, :low or :off (which will log all
+    # messages, only high-priority messages, or no messages at all,
+    # respectively).
+    attr_accessor :level
+
+    def initialize # :nodoc:
+      @level = :high
+    end
+
+    # Logs a file-related action.
+    #
+    # +level+:: The importance of this action. Can be :high or :low.
+    #
+    # +action+:: The kind of file action. Can be :create, :update or
+    #            :identical.
+    #
+    # +path+:: The path to the file the action was performed on.
+    def file(level, action, path, duration=nil)
+      log(
+        level,
+        '%s%12s%s  %s%s' % [
+          ACTION_COLORS[action.to_sym],
+          action,
+          "\e[0m",
+          duration.nil? ? '' : "[%2.2fs]  " % [ duration ],
+          path
+        ]
+      )
+    end
+
+    # Logs a message.
+    #
+    # +level+:: The importance of this message. Can be :high or :low.
+    #
+    # +s+:: The message to be logged.
+    #
+    # +io+:: The IO instance to which the message will be written. Defaults to
+    #        standard output.
+    def log(level, s, io=$stdout)
+      # Don't log when logging is disabled
+      return if @level == :off
+
+      # Log when level permits it
+      io.puts(s) if (@level == :low or @level == level)
+    end
+
+  end
+
+end

data/lib/nanoc/cli/option_parser.rb

@@ -0,0 +1,168 @@
+module Nanoc::CLI
+
+  # Nanoc::CLI::OptionParser is used for parsing commandline options.
+  class OptionParser
+
+    # Error that will be raised when an unknown option is encountered.
+    class IllegalOptionError < RuntimeError ; end
+
+    # Error that will be raised when an option without argument is
+    # encountered.
+    class OptionRequiresAnArgumentError < RuntimeError ; end
+
+    # Parses the commandline arguments in +arguments_and_options+, using the
+    # commandline option definitions in +definitions+.
+    #
+    # +arguments_and_options+ is an array of commandline arguments and
+    # options. This will usually be +ARGV+.
+    #
+    # +definitions+ contains a list of hashes defining which options are
+    # allowed and how they will be handled. Such a hash has three keys:
+    #
+    # :short:: The short name of the option, e.g. +a+. Do not include the '-'
+    #          prefix.
+    #
+    # :long:: The long name of the option, e.g. +all+. Do not include the '--'
+    #         prefix.
+    #
+    # :argument:: Whether this option's argument is required (:required) or
+    #             forbidden (:forbidden).
+    #
+    # A sample array of definition hashes could look like this:
+    #
+    #     [
+    #       { :short => 'a', :long => 'all',  :argument => :forbidden },
+    #       { :short => 'p', :long => 'port', :argument => :required  },
+    #     ]
+    #
+    # During parsing, two errors can be raised:
+    #
+    # IllegalOptionError:: An unrecognised option was encountered, i.e. an
+    #                      option that is not present in the list of option
+    #                      definitions.
+    #
+    # OptionRequiresAnArgumentError:: An option was found that did not have a
+    #                                 value, even though this value was
+    #                                 required.
+    #
+    # What will be returned, is a hash with two keys, :arguments and :options.
+    # The :arguments value contains a list of arguments, and the :options
+    # value contains a hash with key-value pairs for each option. Options
+    # without values will have a +nil+ value instead.
+    #
+    # For example, the following commandline options (which should not be
+    # passed as a string, but as an array of strings):
+    #
+    #     foo bar -xyz -a hiss --level 50 --father=ani -n luke squeak
+    #
+    # with the following option definitions:
+    #
+    #     [
+    #       { :short => 'x', :long => 'xxx',    :argument => :forbidden },
+    #       { :short => 'y', :long => 'yyy',    :argument => :forbidden },
+    #       { :short => 'z', :long => 'zzz',    :argument => :forbidden },
+    #       { :short => 'a', :long => 'all',    :argument => :forbidden },
+    #       { :short => 'l', :long => 'level',  :argument => :required  },
+    #       { :short => 'f', :long => 'father', :argument => :required  },
+    #       { :short => 'n', :long => 'name',   :argument => :required  }
+    #     ]
+    #
+    # will be translated into:
+    #
+    #     {
+    #       :arguments => [ 'foo', 'bar', 'hiss', 'squeak' ],
+    #       :options => {
+    #         :xxx    => nil,
+    #         :yyy    => nil,
+    #         :zzz    => nil,
+    #         :all    => nil,
+    #         :level  => '50',
+    #         :father => 'ani',
+    #         :name   => 'luke'
+    #       }
+    #     }
+    def self.parse(arguments_and_options, definitions)
+      # Don't touch original argument
+      unprocessed_arguments_and_options = arguments_and_options.dup
+
+      # Initialize
+      arguments = []
+      options   = {}
+
+      # Determines whether we've passed the '--' marker or not
+      no_more_options = false
+
+      loop do
+        # Get next item
+        e = unprocessed_arguments_and_options.shift
+        break if e.nil?
+
+        # Handle end-of-options marker
+        if e == '--'
+          no_more_options = true
+        # Handle incomplete options
+        elsif e =~ /^--./ and !no_more_options
+          # Get option key, and option value if included
+          if e =~ /^--([^=]+)=(.+)$/
+            option_key   = $1
+            option_value = $2
+          else
+            option_key    = e[2..-1]
+            option_value  = nil
+          end
+
+          # Find definition
+          definition = definitions.find { |d| d[:long] == option_key }
+          raise IllegalOptionError.new(option_key) if definition.nil?
+
+          if definition[:argument] == :required
+            # Get option value if necessary
+            if option_value.nil?
+              option_value = unprocessed_arguments_and_options.shift
+              raise OptionRequiresAnArgumentError.new(option_key) if option_value.nil?
+            end
+
+            # Store option
+            options[definition[:long].to_sym] = option_value
+          else
+            # Store option
+            options[definition[:long].to_sym] = nil
+          end
+        # Handle -xyz options
+        elsif e =~ /^-./ and !no_more_options
+          # Get option keys
+          option_keys = e[1..-1].scan(/./)
+
+          # For each key
+          option_keys.each do |option_key|
+            # Find definition
+            definition = definitions.find { |d| d[:short] == option_key }
+            raise IllegalOptionError.new(option_key) if definition.nil?
+
+            if option_keys.length > 1 and definition[:argument] == :required
+              # This is a combined option and it requires an argument, so complain
+              raise OptionRequiresAnArgumentError.new(option_key) if option_value.nil?
+            elsif definition[:argument] == :required
+              # Get option value
+              option_value = unprocessed_arguments_and_options.shift
+              raise OptionRequiresAnArgumentError.new(option_key) if option_value.nil?
+
+              # Store option
+              options[definition[:long].to_sym] = option_value
+            else
+              # Store option
+              options[definition[:long].to_sym] = nil
+            end
+          end
+        # Handle normal arguments
+        else
+          arguments << e
+        end
+      end
+
+      { :options => options, :arguments => arguments }
+    end
+
+  end
+
+end

data/lib/nanoc/cli.rb

@@ -0,0 +1 @@
+Nanoc.load('cli', '*.rb')