RubyGems - nanoc - Versions diffs - 2.0 → 2.1 - Mend

nanoc 2.0 → 2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (99) hide show

data/ChangeLog +54 -0
data/LICENSE +1 -1
data/README +63 -3
data/Rakefile +61 -14
data/bin/nanoc +7 -199
data/lib/nanoc/base/asset.rb +113 -0
data/lib/nanoc/base/asset_defaults.rb +21 -0
data/lib/nanoc/base/asset_rep.rb +277 -0
data/lib/nanoc/base/binary_filter.rb +44 -0
data/lib/nanoc/base/code.rb +41 -0
data/lib/nanoc/base/compiler.rb +46 -34
data/lib/nanoc/base/core_ext/hash.rb +51 -7
data/lib/nanoc/base/core_ext/string.rb +8 -0
data/lib/nanoc/base/data_source.rb +253 -20
data/lib/nanoc/base/defaults.rb +30 -0
data/lib/nanoc/base/enhancements.rb +9 -84
data/lib/nanoc/base/filter.rb +109 -6
data/lib/nanoc/base/layout.rb +91 -0
data/lib/nanoc/base/notification_center.rb +66 -0
data/lib/nanoc/base/page.rb +94 -121
data/lib/nanoc/base/page_defaults.rb +20 -0
data/lib/nanoc/base/page_rep.rb +318 -0
data/lib/nanoc/base/plugin.rb +57 -9
data/lib/nanoc/base/proxies/asset_proxy.rb +29 -0
data/lib/nanoc/base/proxies/asset_rep_proxy.rb +26 -0
data/lib/nanoc/base/proxies/layout_proxy.rb +25 -0
data/lib/nanoc/base/proxies/page_proxy.rb +35 -0
data/lib/nanoc/base/proxies/page_rep_proxy.rb +28 -0
data/lib/nanoc/base/proxy.rb +37 -0
data/lib/nanoc/base/router.rb +72 -0
data/lib/nanoc/base/site.rb +220 -91
data/lib/nanoc/base/template.rb +64 -0
data/lib/nanoc/binary_filters/image_science_thumbnail.rb +28 -0
data/lib/nanoc/cli/base.rb +219 -0
data/lib/nanoc/cli/cli.rb +16 -0
data/lib/nanoc/cli/command.rb +105 -0
data/lib/nanoc/cli/commands/autocompile.rb +80 -0
data/lib/nanoc/cli/commands/compile.rb +273 -0
data/lib/nanoc/cli/commands/create_layout.rb +85 -0
data/lib/nanoc/cli/commands/create_page.rb +85 -0
data/lib/nanoc/cli/commands/create_site.rb +327 -0
data/lib/nanoc/cli/commands/create_template.rb +76 -0
data/lib/nanoc/cli/commands/help.rb +69 -0
data/lib/nanoc/cli/commands/info.rb +114 -0
data/lib/nanoc/cli/commands/switch.rb +141 -0
data/lib/nanoc/cli/commands/update.rb +91 -0
data/lib/nanoc/cli/ext.rb +37 -0
data/lib/nanoc/cli/logger.rb +66 -0
data/lib/nanoc/cli/option_parser.rb +168 -0
data/lib/nanoc/cli.rb +1 -0
data/lib/nanoc/data_sources/filesystem.rb +650 -215
data/lib/nanoc/data_sources/filesystem_combined.rb +495 -0
data/lib/nanoc/extra/auto_compiler.rb +265 -0
data/lib/nanoc/extra/context.rb +22 -0
data/lib/nanoc/extra/core_ext/hash.rb +54 -0
data/lib/nanoc/extra/core_ext/time.rb +13 -0
data/lib/nanoc/extra/file_proxy.rb +29 -0
data/lib/nanoc/extra/vcs.rb +48 -0
data/lib/nanoc/extra/vcses/bazaar.rb +21 -0
data/lib/nanoc/extra/vcses/dummy.rb +20 -0
data/lib/nanoc/extra/vcses/git.rb +21 -0
data/lib/nanoc/extra/vcses/mercurial.rb +21 -0
data/lib/nanoc/extra/vcses/subversion.rb +21 -0
data/lib/nanoc/filters/bluecloth.rb +13 -0
data/lib/nanoc/filters/erb.rb +6 -22
data/lib/nanoc/filters/erubis.rb +14 -0
data/lib/nanoc/filters/haml.rb +11 -6
data/lib/nanoc/filters/markaby.rb +5 -5
data/lib/nanoc/filters/maruku.rb +14 -0
data/lib/nanoc/filters/old.rb +19 -0
data/lib/nanoc/filters/rdiscount.rb +13 -0
data/lib/nanoc/filters/rdoc.rb +5 -4
data/lib/nanoc/filters/redcloth.rb +14 -0
data/lib/nanoc/filters/rubypants.rb +14 -0
data/lib/nanoc/filters/sass.rb +13 -0
data/lib/nanoc/helpers/blogging.rb +170 -0
data/lib/nanoc/helpers/capturing.rb +59 -0
data/lib/nanoc/helpers/html_escape.rb +23 -0
data/lib/nanoc/helpers/link_to.rb +69 -0
data/lib/nanoc/helpers/render.rb +47 -0
data/lib/nanoc/helpers/tagging.rb +52 -0
data/lib/nanoc/helpers/xml_sitemap.rb +58 -0
data/lib/nanoc/routers/default.rb +54 -0
data/lib/nanoc/routers/no_dirs.rb +66 -0
data/lib/nanoc/routers/versioned.rb +79 -0
data/lib/nanoc.rb +83 -12
metadata +144 -47
data/lib/nanoc/base/auto_compiler.rb +0 -124
data/lib/nanoc/base/layout_processor.rb +0 -33
data/lib/nanoc/base/page_proxy.rb +0 -31
data/lib/nanoc/base/plugin_manager.rb +0 -33
data/lib/nanoc/data_sources/database.rb +0 -259
data/lib/nanoc/data_sources/trivial.rb +0 -145
data/lib/nanoc/filters/markdown.rb +0 -13
data/lib/nanoc/filters/smartypants.rb +0 -13
data/lib/nanoc/filters/textile.rb +0 -13
data/lib/nanoc/layout_processors/erb.rb +0 -35
data/lib/nanoc/layout_processors/haml.rb +0 -18
data/lib/nanoc/layout_processors/markaby.rb +0 -16

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

@@ -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

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

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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