RubyGems - nanoc3 - Versions diffs - 3.0.9 → 3.1.0a1 - Mend

nanoc3 3.0.9 → 3.1.0a1

Files changed (104) hide show

data/LICENSE +1 -1
data/NEWS.md +360 -0
data/README.md +85 -0
data/Rakefile +2 -2
data/bin/nanoc3 +0 -4
data/lib/nanoc3/base/code_snippet.rb +14 -6
data/lib/nanoc3/base/compiler.rb +68 -49
data/lib/nanoc3/base/compiler_dsl.rb +70 -29
data/lib/nanoc3/base/context.rb +47 -0
data/lib/nanoc3/base/core_ext/array.rb +4 -0
data/lib/nanoc3/base/core_ext/hash.rb +5 -1
data/lib/nanoc3/base/core_ext/string.rb +2 -0
data/lib/nanoc3/base/data_source.rb +132 -96
data/lib/nanoc3/base/dependency_tracker.rb +160 -185
data/lib/nanoc3/base/directed_graph.rb +252 -0
data/lib/nanoc3/base/errors.rb +52 -4
data/lib/nanoc3/base/filter.rb +43 -28
data/lib/nanoc3/base/item.rb +93 -25
data/lib/nanoc3/base/item_rep.rb +166 -55
data/lib/nanoc3/base/layout.rb +16 -13
data/lib/nanoc3/base/notification_center.rb +28 -12
data/lib/nanoc3/base/plugin_registry.rb +158 -0
data/lib/nanoc3/base/rule.rb +27 -8
data/lib/nanoc3/base/rule_context.rb +59 -46
data/lib/nanoc3/base/site.rb +124 -77
data/lib/nanoc3/base.rb +7 -2
data/lib/nanoc3/cli/base.rb +4 -1
data/lib/nanoc3/cli/commands/autocompile.rb +5 -4
data/lib/nanoc3/cli/commands/compile.rb +28 -7
data/lib/nanoc3/cli/commands/create_item.rb +1 -1
data/lib/nanoc3/cli/commands/create_layout.rb +1 -1
data/lib/nanoc3/cli/commands/create_site.rb +46 -22
data/lib/nanoc3/cli/commands/debug.rb +100 -0
data/lib/nanoc3/cli/commands/help.rb +1 -1
data/lib/nanoc3/cli/commands/info.rb +1 -1
data/lib/nanoc3/cli/commands/view.rb +85 -0
data/lib/nanoc3/cli/commands.rb +2 -0
data/lib/nanoc3/cli/logger.rb +7 -0
data/lib/nanoc3/cli.rb +0 -3
data/lib/nanoc3/data_sources/{delicious.rb → deprecated/delicious.rb} +1 -24
data/lib/nanoc3/data_sources/{last_fm.rb → deprecated/last_fm.rb} +1 -27
data/lib/nanoc3/data_sources/{twitter.rb → deprecated/twitter.rb} +1 -14
data/lib/nanoc3/data_sources/filesystem.rb +188 -176
data/lib/nanoc3/data_sources/filesystem_unified.rb +107 -0
data/lib/nanoc3/data_sources/filesystem_verbose.rb +80 -0
data/lib/nanoc3/data_sources.rb +18 -9
data/lib/nanoc3/extra/core_ext/enumerable.rb +39 -0
data/lib/nanoc3/extra/core_ext/time.rb +2 -2
data/lib/nanoc3/extra/core_ext.rb +1 -0
data/lib/nanoc3/extra/deployers/rsync.rb +49 -3
data/lib/nanoc3/extra/file_proxy.rb +7 -0
data/lib/nanoc3/extra/vcs.rb +25 -24
data/lib/nanoc3/extra/vcses/bazaar.rb +4 -0
data/lib/nanoc3/extra/vcses/dummy.rb +4 -0
data/lib/nanoc3/extra/vcses/git.rb +4 -0
data/lib/nanoc3/extra/vcses/mercurial.rb +4 -0
data/lib/nanoc3/extra/vcses/subversion.rb +4 -0
data/lib/nanoc3/extra.rb +4 -1
data/lib/nanoc3/filters/erb.rb +1 -1
data/lib/nanoc3/filters/erubis.rb +1 -1
data/lib/nanoc3/filters/haml.rb +1 -1
data/lib/nanoc3/filters/kramdown.rb +14 -0
data/lib/nanoc3/filters/maruku.rb +1 -1
data/lib/nanoc3/filters/rainpress.rb +1 -1
data/lib/nanoc3/filters/rdiscount.rb +3 -1
data/lib/nanoc3/filters.rb +2 -0
data/lib/nanoc3/helpers/blogging.rb +91 -75
data/lib/nanoc3/helpers/breadcrumbs.rb +18 -10
data/lib/nanoc3/helpers/capturing.rb +24 -29
data/lib/nanoc3/helpers/filtering.rb +20 -17
data/lib/nanoc3/helpers/html_escape.rb +7 -4
data/lib/nanoc3/helpers/link_to.rb +51 -41
data/lib/nanoc3/helpers/rendering.rb +15 -8
data/lib/nanoc3/helpers/tagging.rb +27 -21
data/lib/nanoc3/helpers/text.rb +12 -8
data/lib/nanoc3/helpers/xml_sitemap.rb +13 -15
data/lib/nanoc3/tasks/deploy/rsync.rake +4 -1
data/lib/nanoc3/tasks.rb +2 -1
data/lib/nanoc3.rb +24 -1
metadata +43 -87
data/NEWS.rdoc +0 -328
data/README.rdoc +0 -83
data/lib/nanoc3/base/plugin.rb +0 -88
data/lib/nanoc3/base/preprocessor_context.rb +0 -37
data/lib/nanoc3/data_sources/filesystem_combined.rb +0 -214
data/lib/nanoc3/data_sources/filesystem_common.rb +0 -22
data/lib/nanoc3/data_sources/filesystem_compact.rb +0 -256
data/lib/nanoc3/extra/context.rb +0 -24
data/lib/nanoc3/package.rb +0 -107
data/vendor/cri/ChangeLog +0 -0
data/vendor/cri/LICENSE +0 -19
data/vendor/cri/NEWS +0 -0
data/vendor/cri/README +0 -4
data/vendor/cri/Rakefile +0 -25
data/vendor/cri/lib/cri/base.rb +0 -153
data/vendor/cri/lib/cri/command.rb +0 -105
data/vendor/cri/lib/cri/core_ext/string.rb +0 -41
data/vendor/cri/lib/cri/core_ext.rb +0 -8
data/vendor/cri/lib/cri/option_parser.rb +0 -186
data/vendor/cri/lib/cri.rb +0 -12
data/vendor/cri/test/test_base.rb +0 -6
data/vendor/cri/test/test_command.rb +0 -6
data/vendor/cri/test/test_core_ext.rb +0 -21
data/vendor/cri/test/test_option_parser.rb +0 -279

data/lib/nanoc3/cli/commands/create_site.rb CHANGED Viewed

@@ -4,6 +4,39 @@ module Nanoc3::CLI::Commands
   class CreateSite < Cri::Command
+    DEFAULT_RULES = <<EOS
+#!/usr/bin/env ruby
+# A few helpful tips about the Rules file:
+#
+# * The order of rules is important: for each item, only the first matching
+#   rule is applied.
+#
+# * Item identifiers start and end with a slash (e.g. “/about/” for the file
+#   “content/about.html”). To select all children, grandchildren, … of an
+#   item, use the pattern “/about/*/”; “/about/*” will also select the parent,
+#   because “*” matches zero or more characters.
+compile '/stylesheet/' do
+  # don’t filter or layout
+end
+compile '*' do
+  filter :erb
+  layout 'default'
+end
+route '/stylesheet/' do
+  '/style.css'
+end
+route '*' do
+  item.identifier + 'index.html'
+end
+layout '*', :erb
+EOS
     DEFAULT_ITEM = <<EOS
 <h1>A Brand New nanoc Site</h1>
@@ -128,6 +161,7 @@ EOS
     <title>A Brand New nanoc Site - <%= @item[:title] %></title>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
     <link rel="stylesheet" type="text/css" href="/style.css" media="screen">
+    <meta name="generator" content="nanoc #{Nanoc3::VERSION}">
   </head>
   <body>
     <div id="main">
@@ -169,7 +203,7 @@ EOS
     end
     def usage
-      "nanoc3 create_site [path]"
+      "nanoc3 create_site [options] path"
     end
     def option_definitions
@@ -252,18 +286,7 @@ EOS
       # Create rules
       File.open('Rules', 'w') do |io|
-        io.write "#!/usr/bin/env ruby\n"
-        io.write "\n"
-        io.write "compile '*' do\n"
-        io.write "  filter :erb\n"
-        io.write "  layout 'default'\n"
-        io.write "end\n"
-        io.write "\n"
-        io.write "route '*' do\n"
-        io.write "  item.identifier + 'index.html'\n"
-        io.write "end\n"
-        io.write "\n"
-        io.write "layout '*', :erb\n"
+        io.write DEFAULT_RULES
       end
       Nanoc3::NotificationCenter.post(:file_created, 'Rules')
     end
@@ -285,29 +308,30 @@ EOS
     def site_populate
       # Get site
       site = Nanoc3::Site.new('.')
-      # Create item
       data_source = site.data_sources[0]
+      # Create home page
       data_source.create_item(
         DEFAULT_ITEM,
         { :title => "Home" },
         '/'
       )
+      # Create stylesheet
+      data_source.create_item(
+        DEFAULT_STYLESHEET,
+        {},
+        '/stylesheet/',
+        :extension => '.css'
+      )
       # Create layout
-      data_source = site.data_sources[0]
       data_source.create_layout(
         DEFAULT_LAYOUT,
         {},
         '/default/'
       )
-      # Create stylesheet
-      FileUtils.mkdir_p('output')
-      File.open('output/style.css', 'w') do |io|
-        io.write DEFAULT_STYLESHEET
-      end
       # Create code
       FileUtils.mkdir_p('lib')
       File.open('lib/default.rb', 'w') do |io|

data/lib/nanoc3/cli/commands/debug.rb ADDED Viewed

@@ -0,0 +1,100 @@
+# encoding: utf-8
+module Nanoc3::CLI::Commands
+  class Debug < Cri::Command
+    def name
+      'debug'
+    end
+    def aliases
+      []
+    end
+    def short_desc
+      'show debug information for this site'
+    end
+    def long_desc
+      'Show information about all items, item representations and layouts ' \
+      'in the current site.'
+    end
+    def usage
+      "nanoc3 debug"
+    end
+    def option_definitions
+      []
+    end
+    def run(options, arguments)
+      # Make sure we are in a nanoc site directory
+      print "Loading site data... "
+      @base.require_site
+      @base.site.load_data
+      puts "done"
+      puts
+      # Get data
+      items   = @base.site.items
+      reps    = items.map { |i| i.reps }.flatten
+      layouts = @base.site.layouts
+      # Calculate prettification data
+      identifier_length = items.map { |i| i.identifier.size }.max
+      rep_name_length   = reps.map  { |r| r.name.size }.max
+      # Print items
+      puts '=== Items'
+      puts
+      row = 0
+      items.sort_by { |i| i.identifier }.each do |item|
+        item.reps.sort_by { |r| r.name.to_s }.each do |rep|
+          # Determine filler
+          filler = (row % 3 == 0 ? '· ' : ' ')
+          row += 1
+          # Print rep
+          puts "* %s %s -> %s" % [
+            fill(item.identifier, identifier_length, filler),
+            fill(rep.name.to_s,   rep_name_length,   ' '),
+            rep.raw_path || '-'
+          ]
+        end
+      end
+      puts
+      # Print layouts
+      puts '=== Layouts'
+      puts
+      layouts.each do |layout|
+        puts "* #{layout.identifier}"
+      end
+    end
+  private
+    # Returns a string that is exactly `length` long, starting with `text` and
+    # filling up any unused space by repeating the string `filler`.
+    def fill(text, length, filler)
+      res = text.dup
+      filler_length = (length - 1 - text.length)
+      if filler_length >= 0
+        # Append spacer to ensure alignment
+        spacer_length = text.size % filler.length
+        filler_length -= spacer_length
+        res << ' ' * (spacer_length + 1)
+        # Append leader
+        res << filler*(filler_length/filler.length)
+      end
+      res
+    end
+  end
+end

data/lib/nanoc3/cli/commands/help.rb CHANGED Viewed

@@ -25,7 +25,7 @@ module Nanoc3::CLI::Commands
     end
     def usage
-      "nanoc3 help [command]"
+      "nanoc3 help [options] [command]"
     end
     def run(options, arguments)

data/lib/nanoc3/cli/commands/info.rb CHANGED Viewed

@@ -23,7 +23,7 @@ module Nanoc3::CLI::Commands
     end
     def usage
-      "nanoc3 info"
+      "nanoc3 info [options]"
     end
     def option_definitions

data/lib/nanoc3/cli/commands/view.rb ADDED Viewed

@@ -0,0 +1,85 @@
+# encoding: utf-8
+module Nanoc3::CLI::Commands
+  class View < Cri::Command
+    def name
+      'view'
+    end
+    def aliases
+      []
+    end
+    def short_desc
+      'start the web server that serves static files'
+    end
+    def long_desc
+      'Start the static web server. Unless specified, the web server will run on port 3000 and listen on all IP addresses. Running the autocompiler requires \'adsf\' and \'rack\'.'
+    end
+    def usage
+      "nanoc3 view [options]"
+    end
+    def option_definitions
+      [
+        # --handler
+        {
+          :long => 'handler', :short => 'H', :argument => :required,
+          :desc => 'specify the handler to use (webrick/mongrel/...)'
+        },
+        # --host
+        {
+          :long => 'host', :short => 'o', :argument => :required,
+          :desc => 'specify the host to listen on (default: 0.0.0.0)'
+        },
+        # --port
+        {
+          :long => 'port', :short => 'p', :argument => :required,
+          :desc => 'specify the port to listen on (default: 3000)'
+        }
+      ]
+    end
+    def run(options, arguments)
+      require 'rack'
+      require 'adsf'
+      # Make sure we are in a nanoc site directory
+      @base.require_site
+      # Set options
+      options_for_rack = {
+        :Port      => (options[:port] || 3000).to_i,
+        :Host      => (options[:host] || '0.0.0.0')
+      }
+      # Guess which handler we should use
+      unless handler = Rack::Handler.get(options[:handler])
+        begin
+          handler = Rack::Handler::Mongrel
+        rescue LoadError => e
+          handler = Rack::Handler::WEBrick
+        end
+      end
+      # Build app
+      site = @base.site
+      app = Rack::Builder.new do
+        use Rack::CommonLogger
+        use Rack::ShowExceptions
+        use Rack::Lint
+        use Adsf::Rack::IndexFileFinder, :root => site.config[:output_dir]
+        run Rack::File.new(site.config[:output_dir])
+      end.to_app
+      # Run autocompiler
+      handler.run(app, options_for_rack)
+    end
+  end
+end

data/lib/nanoc3/cli/commands.rb CHANGED Viewed

@@ -8,6 +8,8 @@ require 'nanoc3/cli/commands/compile'
 require 'nanoc3/cli/commands/create_layout'
 require 'nanoc3/cli/commands/create_item'
 require 'nanoc3/cli/commands/create_site'
+require 'nanoc3/cli/commands/debug'
 require 'nanoc3/cli/commands/help'
 require 'nanoc3/cli/commands/info'
 require 'nanoc3/cli/commands/update'
+require 'nanoc3/cli/commands/view'

data/lib/nanoc3/cli/logger.rb CHANGED Viewed

@@ -29,6 +29,13 @@ module Nanoc3::CLI
     def initialize
       @level = :high
       @color = true
+      # Try enabling color support on Windows
+      begin
+        require 'Win32/Console/ANSI' if RUBY_PLATFORM =~/mswin|mingw/
+      rescue LoadError
+        warn 'The win32console gem is not available. Install it to enable color support on Windows.'
+      end
     end
     # Logs a file-related action.

data/lib/nanoc3/cli.rb CHANGED Viewed

@@ -1,8 +1,5 @@
 # encoding: utf-8
-# Add Cri to load path
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../../vendor/cri/lib'))
 # Load Cri
 require 'cri'

data/lib/nanoc3/data_sources/{delicious.rb → deprecated/delicious.rb} RENAMED Viewed

@@ -2,30 +2,7 @@
 module Nanoc3::DataSources
-  # Nanoc3::DataSources::Delicious provides for a delicious.com bookmarks from
-  # a single user as items (Nanoc3::Item instances).
-  #
-  # The configuration must have a "username" attribute containing the username
-  # of the account from which to fetch the bookmarks.
-  #
-  # The items returned by this data source will be mounted at {root}/{id},
-  # where +id+ is a sequence number that is not necessarily unique for this
-  # bookmark (because delicious.com unfortunately does not provide unique IDs
-  # for each bookmark).
-  #
-  # The items returned by this data source will have the following attributes:
-  #
-  # +:url+:: The URL the bookmark leads to.
-  #
-  # +:description+:: The description (title, usually) of the bookmark.
-  #
-  # +:tags+:: An array of tags (strings) for this bookmark.
-  #
-  # +:date+:: The timestamp when this bookmark was created (a Time object).
-  #
-  # +:note+:: The personal note for this bookmark (can be nil).
-  #
-  # +:author+:: The username of the person storing the bookmark.
+  # @deprecated Fetch data from online data sources manually instead
   class Delicious < Nanoc3::DataSource
     def items

data/lib/nanoc3/data_sources/{last_fm.rb → deprecated/last_fm.rb} RENAMED Viewed

@@ -2,33 +2,7 @@
 module Nanoc3::DataSources
-  # Nanoc3::DataSources::LastFM provides data about recently played tracks
-  # from from a single Last.fm user as items (Nanoc3::Item instances).
-  #
-  # The configuration must have a "username" attribute containing the username
-  # of the account from which to fetch the data, and an "api_key" attribute
-  # containing the API key (which can be obtained from the Last.fm site).
-  #
-  # The items returned by this data source will be mounted at {root}/{id},
-  # where +id+ is a sequence number that is not necessarily unique for this
-  # bookmark (because delicious.com unfortunately does not provide unique IDs
-  # for each track).
-  #
-  # The items returned by this data source will have the following attributes:
-  #
-  # +:name+:: The name of the track.
-  #
-  # +played_at+:: The timestamp when the track was played (a Time instance).
-  #
-  # +url+:: The Last.fm URL corresponding to the track (a String instance).
-  #
-  # +artist+:: A hash containing information about the track's artist.
-  #
-  # The +artist+ hash consists of the following keys:
-  #
-  # +name+:: The name of the artist.
-  #
-  # +url+:: The Last.fm URL corresponding to the artist (a String instance).
+  # @deprecated Fetch data from online data sources manually instead
   class LastFM < Nanoc3::DataSource
     def items

data/lib/nanoc3/data_sources/{twitter.rb → deprecated/twitter.rb} RENAMED Viewed

@@ -2,20 +2,7 @@
 module Nanoc3::DataSources
-  # Nanoc3::DataSources::Twitter provides tweets from a single user as items
-  # (Nanoc3::Item instances).
-  #
-  # The configuration must have a "username" attribute containing the username
-  # of the account from which to fetch the tweets.
-  #
-  # The items returned by this data source will be mounted at {root}/{id},
-  # where +id+ is the unique identifier of the tweet.
-  #
-  # The items returned by this data source will have the following attributes:
-  #
-  # +:created_at+:: The timestamp when this tweet was posted (a string).
-  #
-  # +source+:: The client used to tweet this message (HTML-encoded).
+  # @deprecated Fetch data from online data sources manually instead
   class Twitter < Nanoc3::DataSource
     def items