nanoc3 3.2.0a4 → 3.2.0b1

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

@@ -1,48 +1,34 @@
 # 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
+usage       'debug'
+summary     'show debug information for this site'
+description <<-EOS
+Show information about all items, item representations and layouts in the
+current site.
+EOS
+
+run do |opts, args, cmd|
+  Nanoc3::CLI::Commands::Debug.call(opts, args, cmd)
+end
 
-    def usage
-      "nanoc3 debug"
-    end
+module Nanoc3::CLI::Commands
 
-    def option_definitions
-      []
-    end
+  class Debug < ::Nanoc3::CLI::Command
 
-    def run(options, arguments)
+    def run
       # Make sure we are in a nanoc site directory
       print "Loading site data... "
-      @base.require_site
+      self.require_site
       puts "done"
       puts
 
       # Get data
-      items   = @base.site.items
+      items   = self.site.items
       reps    = items.map { |i| i.reps }.flatten
-      layouts = @base.site.layouts
+      layouts = self.site.layouts
 
       # Get dependency tracker
-      compiler = @base.site.compiler
+      compiler = self.site.compiler
       compiler.load
       dependency_tracker = compiler.dependency_tracker
 

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

@@ -1,36 +1,21 @@
 # encoding: utf-8
 
-module Nanoc3::CLI::Commands
-
-  class Info < Cri::Command
-
-    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 VCSes. If the current directory contains a nanoc web site, ' +
-      'the plugins defined in this site will be shown as well.'
-    end
+summary     'show info about available plugins'
+usage       'info [options]'
+description <<-EOS
+Show a list of available plugins, including filters, data sources and VCSes.
+If the current directory contains a nanoc web site, the plugins defined in this site will be shown as well.
+EOS
+
+run do |opts, args, cmd|
+  Nanoc3::CLI::Commands::Info.call(opts, args, cmd)
+end
 
-    def usage
-      "nanoc3 info [options]"
-    end
+module Nanoc3::CLI::Commands
 
-    def option_definitions
-      []
-    end
+  class Info < ::Nanoc3::CLI::Command
 
-    def run(options, arguments)
+    def run
       # Check arguments
       if arguments.size != 0
         $stderr.puts "usage: #{usage}"
@@ -39,7 +24,7 @@ module Nanoc3::CLI::Commands
 
       # Get list of plugins (before and after)
       plugins_before = Nanoc3::Plugin.all
-      @base.site.code_snippets if @base.site
+      self.site.code_snippets if self.site
       plugins_after  = Nanoc3::Plugin.all
 
       # Divide list of plugins into builtin and custom

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

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+usage   'nanoc command [options] [arguments]'
+summary 'nanoc, a static site compiler written in Ruby'
+
+opt :l, :color, 'enable color' do
+  Nanoc3::CLI::Logger.instance.color = true
+end
+
+opt :d, :debug, 'enable debugging' do
+  Nanoc3::CLI.debug = true
+end
+
+opt :h, :help, 'show the help message and quit' do |value, cmd|
+  puts cmd.help
+  exit 0
+end
+
+opt :C, :'no-color', 'disable color' do
+  Nanoc3::CLI::Logger.instance.color = false
+end
+
+opt :V, :verbose, 'make nanoc output more detailed' do
+  Nanoc3::CLI::Logger.instance.level = :low
+end
+
+opt :v, :version, 'show version information and quit' do
+  gem_info = defined?(Gem) ? "with RubyGems #{Gem::VERSION}" : "without RubyGems"
+  engine   = defined?(RUBY_ENGINE) ? RUBY_ENGINE : "ruby"
+  puts "nanoc #{Nanoc3::VERSION} (c) 2007-2011 Denis Defreyne."
+  puts "Running #{engine} #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) on #{RUBY_PLATFORM} #{gem_info}"
+  exit 0
+end
+
+opt :w, :warn, 'enable warnings' do
+  $-w = true
+end

data/lib/nanoc3/cli/commands/update.rb

@@ -1,52 +1,29 @@
 # encoding: utf-8
 
-module Nanoc3::CLI::Commands
-
-  class Update < Cri::Command
-
-    def name
-      'update'
-    end
+usage   'update [options]'
+summary 'update the data stored by the data source to a newer version'
+description <<-EOS
+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.
 
-    def aliases
-      []
-    end
+This command will change data, and it is therefore recommended to make a
+backup in case something goes wrong.
+EOS
 
-    def short_desc
-      'update the data stored by the data source to a newer version'
-    end
+option :c, :vcs, 'select the VCS to use'
+flag   :y, :yes, 'update the data without warning'
 
-    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
+run do |opts, args, cmd|
+  Nanoc3::CLI::Commands::Update.call(opts, args, cmd)
+end
 
-    def usage
-      "nanoc3 update [options]"
-    end
+module Nanoc3::CLI::Commands
 
-    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
+  class Update < ::Nanoc3::CLI::Command
 
-    def run(options, arguments)
+    def run
       # Check arguments
       if arguments.size != 0
         $stderr.puts "usage: #{usage}"
@@ -54,10 +31,10 @@ module Nanoc3::CLI::Commands
       end
 
       # Make sure we are in a nanoc site directory
-      @base.require_site
+      self.require_site
 
       # Set VCS if possible
-      @base.set_vcs(options[:vcs])
+      self.set_vcs(options[:vcs])
 
       # Check for -y switch
       unless options.has_key?(:yes)
@@ -85,7 +62,7 @@ module Nanoc3::CLI::Commands
       end
 
       # Update
-      @base.site.data_sources.each do |data_source|
+      self.site.data_sources.each do |data_source|
         data_source.update
       end
     end

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

@@ -1,55 +1,29 @@
 # 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
+usage       'view [options]'
+summary     'start the web server that serves static files'
+description <<-EOS
+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'.
+EOS
+
+option :H, :handler, 'specify the handler to use (webrick/mongrel/...)'
+option :o, :host,    'specify the host to listen on (default: 0.0.0.0)'
+option :p, :port,    'specify the port to listen on (default: 3000)'
+
+run do |opts, args, cmd|
+  Nanoc3::CLI::Commands::View.call(opts, args, cmd)
+end
 
-    def usage
-      "nanoc3 view [options]"
-    end
+module Nanoc3::CLI::Commands
 
-    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
+  class View < ::Nanoc3::CLI::Command
 
-    def run(options, arguments)
+    def run
       require 'rack'
       require 'adsf'
 
       # Make sure we are in a nanoc site directory
-      @base.require_site
+      self.require_site
 
       # Set options
       options_for_rack = {
@@ -67,7 +41,7 @@ module Nanoc3::CLI::Commands
       end
 
       # Build app
-      site = @base.site
+      site = self.site
       app = Rack::Builder.new do
         use Rack::CommonLogger
         use Rack::ShowExceptions

data/lib/nanoc3/cli/commands/watch.rb

@@ -1,36 +1,20 @@
 # encoding: utf-8
 
-module Nanoc3::CLI::Commands
-
-  # @since 3.2.0
-  class Watch < Cri::Command
-
-    def name
-      'watch'
-    end
-
-    def aliases
-      [ ]
-    end
-
-    def short_desc
-      'start the watcher'
-    end
-
-    def long_desc
-      'Start the watcher. When a change is detected, the site will be ' \
-      'recompiled.'
-    end
+usage       'watch [options]'
+summary     'start the watcher'
+description <<-EOS
+Start the watcher. When a change is detected, the site will be recompiled.
+EOS
+
+run do |opts, args, cmd|
+  Nanoc3::CLI::Commands::Watch.call(opts, args, cmd)
+end
 
-    def usage
-      "nanoc3 watch"
-    end
+module Nanoc3::CLI::Commands
 
-    def option_definitions
-      []
-    end
+  class Watch < ::Nanoc3::CLI::Command
 
-    def run(options, arguments)
+    def run
       require 'fssm'
       require 'pathname'
 
@@ -78,7 +62,7 @@ module Nanoc3::CLI::Commands
           end
 
           puts
-          @base.print_error(e)
+          base.print_error(e)
           puts
         end
       end
@@ -87,9 +71,10 @@ module Nanoc3::CLI::Commands
       rebuilder.call(nil, nil)
 
       # Get directories to watch
-      watcher_config = @base.site.config[:watcher] || {}
+      watcher_config = self.site.config[:watcher] || {}
       dirs_to_watch  = watcher_config[:dirs_to_watch]  || %w( content layouts lib )
-      files_to_watch = watcher_config[:files_to_watch] || %w( config.yaml Rules )
+      files_to_watch = watcher_config[:files_to_watch] || %w( config.yaml Rules rules Rules.rb rules.rb' )
+      files_to_watch.delete_if { |f| !File.file?(f) }
 
       # Watch
       puts "Watching for changes…".make_compatible_with_env

data/lib/nanoc3/data_sources/filesystem.rb

@@ -263,13 +263,32 @@ module Nanoc3::DataSources
     # the default external encoding, but this can be overridden by the
     # “encoding” configuration attribute in the data source configuration.
     def read(filename)
-      data = File.read(filename)
-      if data.respond_to?(:encode)
-        data.force_encoding(@config[:encoding]) if @config && @config[:encoding]
-        data.encode('UTF-8')
-      else
-        data
+      # Read
+      begin
+        data = File.read(filename)
+      rescue => e
+        raise RuntimeError.new("Could not read #{filename}: #{e.inspect}")
       end
+
+      # Fix
+      if data.respond_to?(:encode!)
+        if @config && @config[:encoding]
+          original_encoding = Encoding.find(@config[:encoding])
+          data.force_encoding(@config[:encoding])
+        else
+          original_encoding = data.encoding
+        end
+
+        data.encode!('UTF-8') rescue raise_encoding_error(filename, original_encoding)
+        raise_encoding_error(filename, original_encoding) if !data.valid_encoding?
+      end
+
+      data
+    end
+
+    # Raises an invalid encoding error for the given filename and encoding.
+    def raise_encoding_error(filename, encoding)
+      raise RuntimeError.new("Could not read #{filename} because the file is not valid #{encoding}.")
     end
 
   end

data/lib/nanoc3/data_sources/filesystem_unified.rb

@@ -40,8 +40,8 @@ module Nanoc3::DataSources
   #     (`allow_periods_in_identifiers` set to false)
   #     foo.html.erb → /foo/
   #
-  # Note that it is possible for two different, separate files to have the
-  # same identifier. It is recommended to avoid such situations.
+  # Note that each item must have an unique identifier. nanoc will display an
+  # error if two items with the same identifier are found.
   #
   # Some more examples:
   #
@@ -103,10 +103,10 @@ module Nanoc3::DataSources
     # Returns the identifier derived from the given filename, first stripping
     # the given directory name off the filename.
     def identifier_for_filename(filename)
-      if filename =~ /index\.[^\/]+$/
-        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /index\.[^\/\.]+$/ : /index\.[^\/]+$/)
+      if filename =~ /(^|\/)index\.[^\/]+$/
+        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\/?index\.[^\/\.]+$/ : /\/?index\.[^\/]+$/)
       else
-        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\.[^\/\.]+$/      : /\.[^\/]+$/)
+        regex = ((@config && @config[:allow_periods_in_identifiers]) ? /\.[^\/\.]+$/         : /\.[^\/]+$/)
       end
       filename.sub(regex, '').cleaned_identifier
     end