nanoc 2.0.4 → 2.1

data/lib/nanoc/base/template.rb

@@ -0,0 +1,64 @@
+module Nanoc
+
+  # A Nanoc::Template represents a template, which can be used for creating
+  # new pages. Pages don't necessary have to be created using templates, but
+  # they can be useful for generating pages where you only have to "fill in
+  # the blanks".
+  class Template
+
+    # The Nanoc::Site this template belongs to.
+    attr_accessor :site
+
+    # The name of this template.
+    attr_reader :name
+
+    # The raw content a page created using this template will have.
+    attr_reader :page_content
+
+    # A hash containing the attributes a page created using this template will
+    # have.
+    attr_reader :page_attributes
+
+    # Creates a new template.
+    #
+    # +name+:: The name of this template.
+    #
+    # +page_content+:: The raw content a page created using this template will
+    #                  have.
+    #
+    # +page_attributes+:: A hash containing the attributes a page created
+    #                     using this template will have.
+    def initialize(page_content, page_attributes, name)
+      @page_content     = page_content
+      @page_attributes  = page_attributes.clean
+      @name             = name
+    end
+
+    # Saves the template in the database, creating it if it doesn't exist yet
+    # or updating it if it already exists. Tells the site's data source to
+    # save the template.
+    def save
+      @site.data_source.loading do
+        @site.data_source.save_template(self)
+      end
+    end
+
+    # Renames the template. Tells the site's data source to rename the
+    # template.
+    def move_to(new_name)
+      @site.data_source.loading do
+        @site.data_source.move_template(self, new_name)
+      end
+    end
+
+    # Deletes the template. Tells the site's data source to delete the
+    # template.
+    def delete
+      @site.data_source.loading do
+        @site.data_source.delete_template(self)
+      end
+    end
+
+  end
+
+end

data/lib/nanoc/binary_filters/image_science_thumbnail.rb

@@ -0,0 +1,28 @@
+module Nanoc::BinaryFilters
+
+  class ImageScienceThumbnail < Nanoc::BinaryFilter
+
+    identifier :image_science_thumbnail
+
+    def run(file)
+      require 'image_science'
+
+      # Get temporary file path
+      tmp_file = Tempfile.new('filter')
+      tmp_path = tmp_file.path
+      tmp_file.close
+
+      # Create thumbnail
+      ImageScience.with_image(file.path) do |img|
+        img.thumbnail(@asset_rep.thumbnail_size || 150) do |thumbnail|
+          thumbnail.save(tmp_path)
+        end
+      end
+
+      # Return thumbnail file
+      File.open(tmp_path)
+    end
+
+  end
+
+end

data/lib/nanoc/cli.rb

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

data/lib/nanoc/cli/base.rb

@@ -0,0 +1,219 @@
+module Nanoc::CLI
+
+  # Nanoc::CLI::Base is the central class representing a commandline nanoc
+  # tool. It has a list of commands, and is linked to a specific nanoc site.
+  class Base
+
+    attr_reader :commands, :site
+
+    # Creates a new instance of the commandline nanoc tool.
+    def initialize
+      create_commands
+    end
+
+    # Parses the given commandline arguments and executes the requested
+    # command.
+    def run(args)
+      # Check arguments
+      if args.length == 0
+        @help_command.run([], [])
+        exit 1
+      end
+
+      # Find version or help options
+      if args.length == 1
+        # Parse arguments
+        begin
+          parsed_arguments = Nanoc::CLI::OptionParser.parse(args[0..1], global_option_definitions)
+        rescue Nanoc::CLI::OptionParser::IllegalOptionError => e
+          $stderr.puts "illegal option -- #{e}"
+          exit 1
+        end
+
+        # Handle version option
+        if parsed_arguments[:options].has_key?(:version)
+          puts "nanoc #{Nanoc::VERSION} (c) 2007-2008 Denis Defreyne."
+          exit 1
+        # Handle help option
+        elsif parsed_arguments[:options].has_key?(:help)
+          show_help
+          exit 1
+        end
+      end
+
+      # Find command
+      command = command_named(args[0])
+
+      # Get extended option definitions (with help)
+      extended_option_definitions = command.option_definitions + [
+        # --help
+        {
+          :long => 'help', :short => 'h', :argument => :forbidden,
+          :desc => 'show this help message and quit'
+        },
+        # --verbose
+        {
+          :long => 'verbose', :short => 'V', :argument => :forbidden,
+          :desc => 'enable more detailed output'
+        }
+      ]
+
+      # Parse arguments
+      begin
+        parsed_arguments = Nanoc::CLI::OptionParser.parse(args[1..-1], extended_option_definitions)
+      rescue Nanoc::CLI::OptionParser::IllegalOptionError => e
+        $stderr.puts "illegal option -- #{e}"
+        exit 1
+      rescue Nanoc::CLI::OptionParser::OptionRequiresAnArgumentError => e
+        $stderr.puts "option requires an argument -- #{e}"
+        exit 1
+      end
+
+      # Check help option
+      if parsed_arguments[:options].has_key?(:help)
+        show_help(command)
+        exit 1
+      end
+
+      # Check verbose option
+      if parsed_arguments[:options].has_key?(:verbose)
+        Nanoc::CLI::Logger.instance.level = :low
+      end
+
+      # Find and run command
+      command.run(parsed_arguments[:options], parsed_arguments[:arguments])
+    end
+
+    # Returns the command with the given name.
+    def command_named(name)
+      # Find by exact name or alias
+      command = @commands.find { |c| c.name == name or c.aliases.include?(name) }
+      return command unless command.nil?
+
+      # Find by approximation
+      commands = @commands.select { |c| c.name[0, name.length] == name }
+      if commands.length > 1
+        $stderr.puts "nanoc: '#{name}' is ambiguous:"
+        $stderr.puts "  #{commands.map { |c| c.name }.join(' ') }"
+        exit 1
+      elsif commands.length == 0
+        $stderr.puts "nanoc: unknown command '#{name}'\n"
+        show_help
+        exit 1
+      else
+        return commands[0]
+      end
+    end
+
+    # Shows the help text for the given command, or shows the general help
+    # text if no command is given.
+    def show_help(command=nil)
+      if command.nil?
+        @help_command.run([], [])
+      else
+        @help_command.run([], [ command.name ])
+      end
+    end
+
+    # Helper function which can be called when a command is executed that
+    # requires a site, such as the compile command.
+    def require_site
+      if site.nil?
+        $stderr.puts 'The current working directory does not seem to be a ' +
+                     'valid/complete nanoc site directory; aborting.'
+        exit 1
+      end
+    end
+
+    # Gets the site (Nanoc::Site) in the current directory and loads its data.
+    def site
+      # Load site if possible
+      if File.file?('config.yaml') and @site.nil?
+        begin
+          @site = Nanoc::Site.new(YAML.load_file('config.yaml'))
+          @site.load_data
+        rescue Nanoc::Errors::UnknownDataSourceError => e
+          $stderr.puts "Unknown data source: #{e}"
+          exit 1
+        rescue Nanoc::Errors::UnknownRouterError => e
+          $stderr.puts "Unknown router: #{e}"
+          exit 1
+        rescue Exception => e
+          $stderr.puts "ERROR: An exception occured while loading this site."
+          $stderr.puts
+          $stderr.puts "If you think this is a bug in nanoc, please do report it at " +
+                       "<http://nanoc.stoneship.org/trac/newticket> -- thanks!"
+          $stderr.puts
+          $stderr.puts 'Message:'
+          $stderr.puts '  ' + e.message
+          $stderr.puts
+          $stderr.puts 'Backtrace:'
+          $stderr.puts e.backtrace.map { |t| '  - ' + t }.join("\n")
+          exit 1
+        end
+      end
+
+      @site
+    end
+
+    # Sets the data source's VCS to the VCS with the given name. Does nothing
+    # when the site's data source does not support VCSes (i.e. does not
+    # implement #vcs=).
+    def set_vcs(vcs_name)
+      # Skip if not possible
+      return if vcs_name.nil?
+      return if site.nil? or !site.data_source.respond_to?(:vcs=)
+
+      # Find VCS
+      vcs_class = Nanoc::Extra::VCS.named(vcs_name.to_sym)
+      if vcs_class.nil?
+        $stderr.puts "A VCS named #{vcs_name} was not found; aborting."
+        exit 1
+      end
+
+      # Set VCS
+      site.data_source.vcs = vcs_class.new
+    end
+
+    # Returns the list of global option definitionss.
+    def global_option_definitions
+      [
+        {
+          :long => 'help', :short => 'h', :argument => :forbidden,
+          :desc => 'show this help message and quit'
+        },
+        {
+          :long => 'version', :short => 'v', :argument => :forbidden,
+          :desc => 'show version information and quit'
+        }
+      ]
+    end
+
+  protected
+
+    def create_commands
+      @commands = []
+
+      # Find all command classes
+      command_classes = []
+      ObjectSpace.each_object(Class) do |klass|
+        command_classes << klass if klass < Nanoc::CLI::Command
+      end
+
+      # Create commands
+      command_classes.each do |klass|
+        if klass.to_s == 'Nanoc::CLI::HelpCommand'
+          @help_command = HelpCommand.new
+          @commands << @help_command
+        else
+          @commands << klass.new
+        end
+      end
+
+      # Set base
+      @commands.each { |c| c.base = self }
+    end
+
+  end
+
+end

data/lib/nanoc/cli/cli.rb

@@ -0,0 +1,16 @@
+module Nanoc::CLI # :nodoc:
+end
+
+# Load extensions
+Nanoc.load('cli', 'ext.rb')
+Nanoc.load('cli', 'option_parser.rb')
+
+# Load logger
+Nanoc.load('cli', 'logger.rb')
+
+# Load commands
+Nanoc.load('cli', 'command.rb')
+Nanoc.load('cli', 'commands', '*.rb')
+
+# Load base
+Nanoc.load('cli', 'base.rb')

data/lib/nanoc/cli/command.rb

@@ -0,0 +1,105 @@
+module Nanoc::CLI
+
+  # Nanoc::CLI::Command represents a command that can be executed on the
+  # commandline. It is an abstract superclass for all commands.
+  class Command
+
+    attr_accessor :base
+
+    # Returns a string containing the name of thi command. Subclasses must
+    # implement this method.
+    def name
+      raise NotImplementedError.new("Command subclasses should override #name")
+    end
+
+    # Returns an array of strings containing the aliases for this command.
+    # Subclasses must implement this method.
+    def aliases
+      raise NotImplementedError.new("Command subclasses should override #aliases")
+    end
+
+    # Returns a string containing this command's short description, which
+    # should not be longer than 50 characters. Subclasses must implement this
+    # method.
+    def short_desc
+      raise NotImplementedError.new("Command subclasses should override #short_desc")
+    end
+
+    # Returns a string containing this command's complete description, which
+    # should explain what this command does and how it works in detail.
+    # Subclasses must implement this method.
+    def long_desc
+      raise NotImplementedError.new("Command subclasses should override #long_desc")
+    end
+
+    # Returns a string containing this command's usage. Subclasses must
+    # implement this method.
+    def usage
+      raise NotImplementedError.new("Command subclasses should override #usage")
+    end
+
+    # Returns an array containing this command's option definitions. See the
+    # documentation for Nanoc::CLI::OptionParser for details on what option
+    # definitions look like. Subclasses may implement this method if the
+    # command has options.
+    def option_definitions
+      []
+    end
+
+    # Executes the command. Subclasses must implement this method
+    # (obviously... what's the point of a command that can't be run?).
+    #
+    # +options+:: A hash containing the parsed commandline options. For
+    #             example, '--foo=bar' will be converted into { :foo => 'bar'
+    #             }. See the Nanoc::CLI::OptionParser documentation for
+    #             details.
+    #
+    # +arguments+:: An array of strings representing the commandline arguments
+    #               given to this command.
+    def run(options, arguments)
+      raise NotImplementedError.new("Command subclasses should override #run")
+    end
+
+    # Returns the help text for this command.
+    def help
+      text = ''
+
+      # Append usage
+      text << usage + "\n"
+
+      # Append aliases
+      unless aliases.empty?
+        text << "\n"
+        text << "aliases: #{aliases.join(' ')}\n"
+      end
+
+      # Append short description
+      text << "\n"
+      text << short_desc + "\n"
+
+      # Append long description
+      text << "\n"
+      text << long_desc.wrap_and_indent(78, 4) + "\n"
+
+      # Append options
+      unless option_definitions.empty?
+        text << "\n"
+        text << "options:\n"
+        text << "\n"
+        option_definitions.sort { |x,y| x[:long] <=> y[:long] }.each do |opt_def|
+          text << sprintf("    -%1s --%-10s %s\n", opt_def[:short], opt_def[:long], opt_def[:desc])
+        end
+      end
+
+      # Return text
+      text
+    end
+
+    # Compares this command's name to the other given command's name.
+    def <=>(other)
+      self.name <=> other.name
+    end
+
+  end
+
+end

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

@@ -0,0 +1,80 @@
+module Nanoc::CLI
+
+  class AutocompileCommand < Command # :nodoc:
+
+    def name
+      'autocompile'
+    end
+
+    def aliases
+      [ 'aco', 'autocompile_site' ]
+    end
+
+    def short_desc
+      'start the autocompiler'
+    end
+
+    def long_desc
+      handler_names = Nanoc::Extra::AutoCompiler::HANDLER_NAMES.join(', ')
+
+      'Start the autocompiler web server. Unless specified, the web ' +
+      'server will run on port 3000 and listen on all IP addresses. ' +
+      'Running the autocompiler requires \'mime/types\' and \'rack\'.' +
+      "\n" +
+      'Available handlers are (in order of preference): ' + handler_names +
+      ' (default is ' + Nanoc::Extra::AutoCompiler::HANDLER_NAMES[0].to_s + ').'
+    end
+
+    def usage
+      "nanoc autocompile [options]"
+    end
+
+    def option_definitions
+      [
+        # --all
+        {
+          :long => 'all', :short => 'a', :argument => :forbidden,
+          :desc => 'compile all pages, even those that aren\'t outdated'
+        },
+        # --port
+        {
+          :long => 'port', :short => 'p', :argument => :required,
+          :desc => 'specify a port number for the autocompiler'
+        },
+        # --handler
+        {
+          :long => 'handler', :short => 'H', :argument => :required,
+          :desc => 'specify the handler to use'
+        }
+      ]
+    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
+
+      # Autocompile site
+      begin
+        autocompiler = Nanoc::Extra::AutoCompiler.new(@base.site, options.has_key?(:all))
+        autocompiler.start(
+          options[:port],
+          options[:handler]
+        )
+      rescue LoadError
+        $stderr.puts "'mime/types' and 'rack' are required to autocompile sites. " +
+                     "You may want to install the 'mime-types' and 'rack' gems by " +
+                     "running 'gem install mime-types' and 'gem install rack'."
+      rescue Nanoc::Extra::AutoCompiler::UnknownHandlerError
+        $stderr.puts "The requested handler, #{options[:handler]}, is not available."
+      end
+    end
+
+  end
+
+end