nanoc 2.0.4 → 2.1

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

@@ -0,0 +1,273 @@
+module Nanoc::CLI
+
+  class CompileCommand < Command # :nodoc:
+
+    def name
+      'compile'
+    end
+
+    def aliases
+      []
+    end
+
+    def short_desc
+      'compile pages and assets of this site'
+    end
+
+    def long_desc
+      'Compile all pages and all assets of the current site. If a path is ' +
+      'given, only the page or asset with the given path will be compiled. ' +
+      'Additionally, only pages and assets that are outdated will be ' +
+      'compiled, unless specified otherwise with the -a option.'
+    end
+
+    def usage
+      "nanoc compile [options] [path]"
+    end
+
+    def option_definitions
+      [
+        # --all
+        {
+          :long => 'all', :short => 'a', :argument => :forbidden,
+          :desc => 'compile all pages and assets, even those that aren\'t outdated'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Find object with given path
+      if arguments.size == 0
+        objs = nil
+      else
+        objs = arguments.map do |path|
+          # Find object
+          path = path.cleaned_path
+          obj = @base.site.pages.find { |page| page.path == path }
+          obj = @base.site.assets.find { |asset| asset.path == path } if obj.nil?
+
+          # Ensure object
+          if obj.nil?
+            $stderr.puts "Unknown page or asset: #{path}"
+            exit 1
+          end
+
+          obj
+        end
+      end
+
+      # Compile site
+      begin
+        # Give feedback
+        puts "Compiling #{objs.nil? ? 'site' : 'objects'}..."
+
+        # Initialize profiling stuff
+        time_before = Time.now
+        @filter_times ||= {}
+        @times_stack  ||= []
+        setup_notifications
+
+        # Compile
+        @base.site.compiler.run(
+          objs,
+          :even_when_not_outdated => options.has_key?(:all)
+        )
+
+        # Find reps
+        page_reps  = @base.site.pages.map { |p| p.reps }.flatten
+        asset_reps = @base.site.assets.map { |a| a.reps }.flatten
+        reps       = page_reps + asset_reps
+
+        # Show skipped reps
+        reps.select { |r| !r.compiled? }.each do |rep|
+          duration = @rep_times[rep.disk_path]
+          Nanoc::CLI::Logger.instance.file(:low, :skip, rep.disk_path, duration)
+        end
+
+        # Give general feedback
+        puts
+        puts "No objects were modified." unless reps.any? { |r| r.modified? }
+        puts "#{objs.nil? ? 'Site' : 'Object'} compiled in #{format('%.2f', Time.now - time_before)}s."
+
+        if options.has_key?(:verbose)
+          print_state_feedback(reps)
+          print_profiling_feedback(reps)
+        end
+      rescue Interrupt => e
+        exit
+      rescue Exception => e
+        print_error(e)
+      end
+    end
+
+  private
+
+    def setup_notifications
+      Nanoc::NotificationCenter.on(:compilation_started) do |rep|
+        rep_compilation_started(rep)
+      end
+      Nanoc::NotificationCenter.on(:compilation_ended) do |rep|
+        rep_compilation_ended(rep)
+      end
+      Nanoc::NotificationCenter.on(:filtering_started) do |rep, filter_name|
+        rep_filtering_started(rep, filter_name)
+      end
+      Nanoc::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
+        rep_filtering_ended(rep, filter_name)
+      end
+    end
+
+    def print_state_feedback(reps)
+      # Categorise reps
+      rest            = reps
+      created, rest   = *rest.partition { |r| r.created? }
+      modified, rest  = *rest.partition { |r| r.modified? }
+      skipped, rest   = *rest.partition { |r| !r.compiled? }
+      identical       = rest
+
+      # Print
+      puts
+      puts format('  %4d  created',   created.size)
+      puts format('  %4d  modified',  modified.size)
+      puts format('  %4d  skipped',   skipped.size)
+      puts format('  %4d  identical', identical.size)
+    end
+
+    def print_profiling_feedback(reps)
+      # Get max filter length
+      max_filter_name_length = @filter_times.keys.map { |k| k.to_s.size }.max
+      return if max_filter_name_length.nil?
+
+      # Print warning if necessary
+      if reps.any? { |r| !r.compiled? }
+        $stderr.puts
+        $stderr.puts "Warning: profiling information may not be accurate because " +
+                     "some objects were not compiled."
+      end
+
+      # Print header
+      puts
+      puts ' ' * max_filter_name_length + ' | count    min    avg    max     tot'
+      puts '-' * max_filter_name_length + '-+-----------------------------------'
+
+      @filter_times.to_a.sort_by { |r| r[1] }.each do |row|
+        # Extract data
+        filter_name, samples = *row
+
+        # Calculate stats
+        count = samples.size
+        min   = samples.min
+        tot   = samples.inject { |memo, i| memo + i}
+        avg   = tot/count
+        max   = samples.max
+
+        # Format stats
+        count = format('%4d',   count)
+        min   = format('%4.2f', min)
+        avg   = format('%4.2f', avg)
+        max   = format('%4.2f', max)
+        tot   = format('%5.2f', tot)
+
+        # Output stats
+        filter_name = format("%#{max_filter_name_length}s", filter_name)
+        puts "#{filter_name} |  #{count}  #{min}s  #{avg}s  #{max}s  #{tot}s"
+      end
+    end
+
+    def print_error(error)
+      # Get rep
+      rep = @base.site.compiler.stack.select { |i| i.is_a?(Nanoc::PageRep) || i.is_a?(Nanoc::AssetRep) }[-1]
+      rep_name = rep.nil? ? 'the site' : "#{rep.is_a?(Nanoc::PageRep) ? rep.page.path : rep.asset.path} (rep #{rep.name})"
+
+      # Build message
+      case error
+      when Nanoc::Errors::UnknownLayoutError
+        message = "Unknown layout: #{error.message}"
+      when Nanoc::Errors::UnknownFilterError
+        message = "Unknown filter: #{error.message}"
+      when Nanoc::Errors::CannotDetermineFilterError
+        message = "Cannot determine filter for layout: #{error.message}"
+      when Nanoc::Errors::RecursiveCompilationError
+        message = "Recursive call to page content."
+      when Nanoc::Errors::NoLongerSupportedError
+        message = "No longer supported: #{error.message}"
+      else
+        message = "Error: #{error.message}"
+      end
+
+      # Print message
+      $stderr.puts
+      $stderr.puts "ERROR: An exception occured while compiling #{rep_name}."
+      $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 '  ' + message
+      $stderr.puts
+      $stderr.puts 'Compilation stack:'
+      @base.site.compiler.stack.reverse.each do |item|
+        if item.is_a?(Nanoc::PageRep) # page rep
+          $stderr.puts "  - [page]   #{item.page.path} (rep #{item.name})"
+        elsif item.is_a?(Nanoc::AssetRep) # asset rep
+          $stderr.puts "  - [asset]  #{item.asset.path} (rep #{item.name})"
+        else # layout
+          $stderr.puts "  - [layout] #{item.path}"
+        end
+      end
+      $stderr.puts
+      $stderr.puts 'Backtrace:'
+      $stderr.puts error.backtrace.map { |t| '  - ' + t }.join("\n")
+    end
+
+    def rep_compilation_started(rep)
+      # Profile compilation
+      @rep_times ||= {}
+      @rep_times[rep.disk_path] = Time.now
+    end
+
+    def rep_compilation_ended(rep)
+      # Profile compilation
+      @rep_times ||= {}
+      @rep_times[rep.disk_path] = Time.now - @rep_times[rep.disk_path]
+
+      # Skip if not outputted
+      return if rep.attribute_named(:skip_output)
+
+      # Get action and level
+      action, level = *if rep.created?
+        [ :create, :high ]
+      elsif rep.modified?
+        [ :update, :high ]
+      elsif !rep.compiled?
+        [ nil, nil ]
+      else
+        [ :identical, :low ]
+      end
+
+      # Log
+      unless action.nil?
+        duration = @rep_times[rep.disk_path]
+        Nanoc::CLI::Logger.instance.file(level, action, rep.disk_path, duration)
+      end
+    end
+
+    def rep_filtering_started(rep, filter_name)
+      @times_stack.push(Time.now)
+    end
+
+    def rep_filtering_ended(rep, filter_name)
+      # Get last time
+      time_start = @times_stack.pop
+
+      # Update times
+      @filter_times[filter_name.to_sym] ||= []
+      @filter_times[filter_name.to_sym] << Time.now - time_start
+    end
+
+  end
+
+end

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

@@ -0,0 +1,85 @@
+module Nanoc::CLI
+
+  class CreateLayoutCommand < Command # :nodoc:
+
+    def name
+      'create_layout'
+    end
+
+    def aliases
+      [ 'cl' ]
+    end
+
+    def short_desc
+      'create a layout'
+    end
+
+    def long_desc
+      'Create a new layout in the current site.'
+    end
+
+    def usage
+      "nanoc create_layout [path]"
+    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
+      path = arguments[0].cleaned_path
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Set VCS if possible
+      @base.set_vcs(options[:vcs])
+
+      # Check whether layout is unique
+      if !@base.site.layouts.find { |l| l.path == path }.nil?
+        $stderr.puts "A layout already exists at #{path}. Please pick a unique name " +
+                     "for the layout you are creating."
+        exit 1
+      end
+
+      # Setup notifications
+      Nanoc::NotificationCenter.on(:file_created) do |file_path|
+        Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
+      end
+
+      # Create layout
+      layout = Nanoc::Layout.new(
+        "<html>\n" +
+        "  <head>\n" +
+        "    <title><%= @page.title %></title>\n" +
+        "  </head>\n" +
+        "  <body>\n" +
+        "    <p>Hi, I'm a new layout. Please customize me!</p>\n" +
+        "<%= @page.content %>\n" +
+        "  </body>\n" +
+        "</html>\n",
+        { :filter => 'erb' },
+        path
+      )
+      layout.site = @base.site
+      layout.save
+
+      puts "A layout has been created at #{path}."
+    end
+
+  end
+
+end

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

@@ -0,0 +1,85 @@
+module Nanoc::CLI
+
+  class CreatePageCommand < Command # :nodoc:
+
+    def name
+      'create_page'
+    end
+
+    def aliases
+      [ 'cp' ]
+    end
+
+    def short_desc
+      'create a page'
+    end
+
+    def long_desc
+      'Create a new page in the current site. The template that will be ' +
+      'used for generating the page will be \'default\', unless otherwise ' +
+      'specified.'
+    end
+
+    def usage
+      "nanoc create_page [options] [path]"
+    end
+
+    def option_definitions
+      [
+        # --vcs
+        {
+          :long => 'vcs', :short => 'c', :argument => :required,
+          :desc => 'select the VCS to use'
+        },
+        # --template
+        {
+          :long => 'template', :short => 't', :argument => :required,
+          :desc => 'specify the template for the new page'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.length != 1
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      # Extract arguments and options
+      path          = arguments[0].cleaned_path
+      template_name = options[:template] || 'default'
+
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+
+      # Set VCS if possible
+      @base.set_vcs(options[:vcs])
+
+      # Find template
+      template = @base.site.templates.find { |t| t.name == template_name }
+      if template.nil?
+        $stderr.puts "A template named '#{template_name}' was not found; aborting."
+        exit 1
+      end
+
+      # Setup notifications
+      Nanoc::NotificationCenter.on(:file_created) do |file_path|
+        Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
+      end
+
+      # Create page
+      page = Nanoc::Page.new(
+        template.page_content,
+        template.page_attributes,
+        path
+      )
+      page.site = @base.site
+      page.save
+
+      puts "A page has been created at #{path}."
+    end
+
+  end
+
+end

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

@@ -0,0 +1,327 @@
+module Nanoc::CLI
+
+  class CreateSiteCommand < Command # :nodoc:
+
+    DEFAULT_PAGE = <<EOS
+<h1>A Brand New nanoc Site</h1>
+<p>You&#8217;ve just created a new nanoc site. The page you are looking at right now is the home page for your site (and it&#8217;s probably the only page).</p>
+<p>To get started, consider replacing this default homepage with your own customized homepage. Some pointers on how to do so:</p>
+<ul>
+  <li><strong>Change this page&#8217;s content</strong> by editing &#8220;content.txt&#8221; file in the &#8220;content&#8221; directory. This is the actual page content, and therefore doesn&#8217;t include the header, sidebar or style information (those are part of the layout).</li>
+  <li><strong>Change the layout</strong>, which is the &#8220;default.txt&#8221; file in the &#8220;layouts/default&#8221; directory, and create something unique (and hopefully less bland).</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_LAYOUT = <<EOS
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+  <head>
+    <title>A Brand New nanoc Site - <%= @page.title %></title>
+    <style type="text/css" media="screen">
+      * {
+        margin: 0;
+        padding: 0;
+      
+        font-family: Georgia, Palatino, Times, 'Times New Roman', sans-serif;
+      }
+      
+      body {
+        background: #fff;
+      }
+      
+      a {
+        text-decoration: none;
+      }
+      
+      a:link,
+      a:visited {
+        color: #f30;
+      }
+      
+      a:hover {
+        color: #f90;
+      }
+      
+      #main {
+        position: absolute;
+      
+        top: 20px;
+        left: 280px;
+      
+        width: 500px;
+      }
+      
+      #main h1 {
+        font-size: 40px;
+        font-weight: normal;
+      
+        line-height: 40px;
+      
+        padding: 20px 0 20px 0;
+      
+        letter-spacing: -1px;
+      }
+      
+      #main p {
+        margin: 0 0 20px 0;
+        
+        font-size: 15px;
+        
+        line-height: 20px;
+      }
+      
+      #main ul {
+        padding: 0 0 0 20px;
+      }
+      
+      #main li {
+        margin: 0 0 20px 0;
+      
+        list-style-type: square;
+      
+        font-size: 15px;
+        
+        line-height: 20px;
+      }
+      
+      #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;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="main">
+<%= @page.content %>
+    </div>
+    <div id="sidebar">
+      <h2>Documentation</h2>
+      <ul>
+        <li><a href="http://nanoc.stoneship.org/help/tutorial/">Tutorial</a></li>
+        <li><a href="http://nanoc.stoneship.org/help/manual/">Manual</a></li>
+      </ul>
+      <h2>Community</h2>
+      <ul>
+        <li><a href="http://groups.google.com/group/nanoc/">Discussion Group</a></li>
+        <li><a href="http://groups.google.com/group/nanoc-es/">Spanish Discussion Group</a></li>
+        <li><a href="http://nanoc.stoneship.org/trac/">Wiki</a></li>
+      </ul>
+    </div>
+  </body>
+</html>
+EOS
+
+    def name
+      'create_site'
+    end
+
+    def aliases
+      [ 'cs' ]
+    end
+
+    def short_desc
+      'create a site'
+    end
+
+    def long_desc
+      'Create a new site at the given path. The site will use the ' +
+      'filesystem data source (but this can be changed later on). It will ' +
+      'also include a few stub rakefiles to make adding new tasks easier.'
+    end
+
+    def usage
+      "nanoc create_site [path]"
+    end
+
+    def option_definitions
+      [
+        # --datasource
+        {
+          :long => 'datasource', :short => 'd', :argument => :required,
+          :desc => 'specify the data source for the new site'
+        }
+      ]
+    end
+
+    def run(options, arguments)
+      # Check arguments
+      if arguments.length != 1
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      # Extract arguments and options
+      path        = arguments[0]
+      data_source = options[:datasource] || 'filesystem'
+
+      # Check whether site exists
+      if File.exist?(path)
+        $stderr.puts "A site at '#{path}' already exists."
+        exit 1
+      end
+
+      # Check whether data source exists
+      if Nanoc::DataSource.named(data_source).nil?
+        $stderr.puts "Unrecognised data source: #{data_source}"
+        exit 1
+      end
+
+      # Setup notifications
+      Nanoc::NotificationCenter.on(:file_created) do |file_path|
+        Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
+      end
+
+      # Build entire site
+      FileUtils.mkdir_p(path)
+      begin
+        FileUtils.cd(File.join(path))
+
+        site_create_minimal(data_source)
+        site_setup
+        site_populate
+      ensure
+        FileUtils.cd(File.join(path.map { |n| '..' }))
+      end
+
+      puts "Created a blank nanoc site at '#{path}'. Enjoy!"
+    end
+
+  protected
+
+    # Creates a configuration file and a output directory for this site, as
+    # well as a rakefile and a 'tasks' directory because raking is fun.
+    def site_create_minimal(data_source)
+      # Create output
+      FileUtils.mkdir_p('output')
+
+      # Create config
+      File.open('config.yaml', 'w') do |io|
+        io.write "output_dir:  \"output\"\n"
+        io.write "data_source: \"#{data_source}\"\n"
+        io.write "router:      \"default\"\n"
+      end
+      Nanoc::NotificationCenter.post(:file_created, 'config.yaml')
+
+      # Create rakefile
+      File.open('Rakefile', 'w') do |io|
+        io.write "Dir['tasks/**/*.rake'].sort.each { |rakefile| load rakefile }\n"
+        io.write "\n"
+        io.write "task :default do\n"
+        io.write "  puts 'This is an example rake task.'\n"
+        io.write "end\n"
+      end
+      Nanoc::NotificationCenter.post(:file_created, 'Rakefile')
+
+      # Create tasks
+      FileUtils.mkdir_p('tasks')
+      File.open('tasks/default.rake', 'w') do |io|
+        io.write "task :example do\n"
+        io.write "  puts 'This is an example rake task in tasks/default.rake.'\n"
+        io.write "end\n"
+      end
+      Nanoc::NotificationCenter.post(:file_created, 'tasks/default.rake')
+    end
+
+    # Sets up the site's data source, i.e. creates the bare essentials for
+    # this data source to work.
+    def site_setup
+      # Get site
+      site = Nanoc::Site.new(YAML.load_file('config.yaml'))
+
+      # Set up data source
+      site.data_source.loading do
+        site.data_source.setup
+      end
+    end
+
+    # Populates the site with some initial data, such as a root page, a
+    # default layout, a default template, and so on.
+    def site_populate
+      # Get site
+      site = Nanoc::Site.new(YAML.load_file('config.yaml'))
+
+      # Create page
+      page = Nanoc::Page.new(
+        DEFAULT_PAGE,
+        { :title => 'Home' },
+        '/'
+      )
+      page.site = site
+      page.save
+
+      # Fill asset defaults
+      Nanoc::Asset::DEFAULTS.each_pair do |key, value|
+        site.asset_defaults.attributes[key] = value
+      end
+      site.asset_defaults.save
+
+      # Fill page defaults
+      Nanoc::Page::DEFAULTS.each_pair do |key, value|
+        site.page_defaults.attributes[key] = value
+      end
+      site.page_defaults.save
+
+      # Create layout
+      layout = Nanoc::Layout.new(
+        DEFAULT_LAYOUT,
+        { :filter => 'erb' },
+        '/default/'
+      )
+      layout.site = site
+      layout.save
+
+      # Create template
+      template = Nanoc::Template.new(
+        "Hi, I'm a new page!\n",
+        { :title => "A New Page" },
+        'default'
+      )
+      template.site = site
+      template.save
+
+      # Fill code
+      code = Nanoc::Code.new(
+        "\# All files in the 'lib' directory will be loaded\n" +
+        "\# before nanoc starts compiling.\n"
+      )
+      code.site = site
+      code.save
+    end
+
+  end
+
+end