nanoc3 3.2.4 → 3.3.0

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

@@ -1,119 +0,0 @@
-# encoding: utf-8
-
-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
-
-module Nanoc3::CLI::Commands
-
-  class Debug < ::Nanoc3::CLI::Command
-
-    def run
-      # Make sure we are in a nanoc site directory
-      print "Loading site data... "
-      self.require_site
-      puts "done"
-      puts
-
-      # Get data
-      items   = self.site.items
-      reps    = items.map { |i| i.reps }.flatten
-      layouts = self.site.layouts
-
-      # Get dependency tracker
-      compiler = self.site.compiler
-      compiler.load
-      dependency_tracker = compiler.dependency_tracker
-
-      # Print item dependencies
-      puts '=== Item dependencies ======================================================='
-      puts
-      items.sort_by { |i| i.identifier }.each do |item|
-        puts "item #{item.identifier} depends on:"
-        predecessors = dependency_tracker.objects_causing_outdatedness_of(item).sort_by { |i| i ? i.identifier : '' }
-        predecessors.each do |pred|
-          if pred
-            puts "  [ #{format '%6s', pred.type} ] #{pred.identifier}"
-          else
-            puts "  ( removed item )"
-          end
-        end
-        puts "  (nothing)" if predecessors.empty?
-        puts
-      end
-
-      # Print representation paths
-      puts '=== Representation paths ===================================================='
-      puts
-      items.sort_by { |i| i.identifier }.each do |item|
-        item.reps.sort_by { |r| r.name.to_s }.each do |rep|
-          puts "item #{item.identifier}, rep #{rep.name}:"
-          if rep.raw_paths.empty?
-            puts "  (not written)"
-          end
-          length = rep.raw_paths.keys.map { |s| s.to_s.length }.max
-          rep.raw_paths.each do |snapshot_name, raw_path|
-            puts "  [ %-#{length}s ] %s" % [ snapshot_name, raw_path ]
-          end
-        end
-        puts
-      end
-
-      # Print representation outdatedness
-      puts '=== Representation outdatedness ============================================='
-      puts
-      items.sort_by { |i| i.identifier }.each do |item|
-        item.reps.sort_by { |r| r.name.to_s }.each do |rep|
-          puts "item #{item.identifier}, rep #{rep.name}:"
-          outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(rep)
-          if outdatedness_reason
-            puts "  is outdated: #{outdatedness_reason.message}"
-          else
-            puts "  is not outdated"
-          end
-        end
-        puts
-      end
-
-      # Print layout dependencies
-      puts '=== Layout dependencies ====================================================='
-      puts
-      layouts.sort_by { |l| l.identifier }.each do |layout|
-        puts "layout #{layout.identifier} depends on:"
-        predecessors = dependency_tracker.objects_causing_outdatedness_of(layout).sort_by { |i| i ? i.identifier : '' }
-        predecessors.each do |pred|
-          if pred
-            puts "  [ #{format '%6s', pred.type} ] #{pred.identifier}"
-          else
-            puts "  ( removed item )"
-          end
-        end
-        puts "  (nothing)" if predecessors.empty?
-        puts
-      end
-
-      # Print layouts
-      puts '=== Layouts'
-      puts
-      layouts.sort_by { |l| l.identifier }.each do |layout|
-        puts "layout #{layout.identifier}:"
-        outdatedness_reason = compiler.outdatedness_checker.outdatedness_reason_for(layout)
-        if outdatedness_reason
-          puts "  is outdated: #{outdatedness_reason.message}"
-        else
-          puts "  is not outdated"
-        end
-        puts
-      end
-    end
-
-  end
-
-end

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

@@ -1,98 +0,0 @@
-# encoding: utf-8
-
-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
-
-module Nanoc3::CLI::Commands
-
-  class Info < ::Nanoc3::CLI::Command
-
-    def run
-      # Check arguments
-      if arguments.size != 0
-        $stderr.puts "usage: #{command.usage}"
-        exit 1
-      end
-
-      # Get list of plugins (before and after)
-      plugins_before = Nanoc3::Plugin.all
-      self.site.code_snippets if self.site
-      plugins_after  = Nanoc3::Plugin.all
-
-      # Divide list of plugins into builtin and custom
-      plugins_builtin = plugins_before
-      plugins_custom  = plugins_after - plugins_before
-
-      # Find max identifiers length
-      plugin_with_longest_identifiers = plugins_after.inject do |longest, current|
-        longest[:identifiers].join(', ').size > current[:identifiers].join(', ').size ? longest : current
-      end
-      max_identifiers_length = plugin_with_longest_identifiers[:identifiers].join(', ').size
-
-      PLUGIN_CLASS_ORDER.each do |superclass|
-        plugins_with_this_superclass = {
-          :builtin => plugins_builtin.select { |p| p[:superclass] == superclass },
-          :custom  => plugins_custom.select  { |p| p[:superclass] == superclass }
-        }
-
-        # Print kind
-        kind = name_for_plugin_class(superclass)
-        puts "#{kind}:"
-        puts
-
-        # Print plugins organised by subtype
-        [ :builtin, :custom ].each do |type|
-          # Find relevant plugins
-          relevant_plugins = plugins_with_this_superclass[type]
-
-          # Print type
-          puts "  #{type}:"
-          if relevant_plugins.empty?
-            puts "    (none)"
-            next
-          end
-
-          # Print plugins
-          relevant_plugins.sort_by { |k| k[:identifiers].join(', ') }.each do |plugin|
-            # Display
-            puts sprintf(
-              "    %-#{max_identifiers_length}s (%s)",
-              plugin[:identifiers].join(', '),
-              plugin[:class].to_s.sub(/^::/, '')
-            )
-          end
-        end
-
-        puts
-      end
-    end
-
-  private
-
-    PLUGIN_CLASS_ORDER = [
-      Nanoc3::Filter,
-      Nanoc3::Extra::VCS,
-      Nanoc3::DataSource
-    ]
-
-    PLUGIN_CLASSES = {
-      Nanoc3::Filter       => 'Filters',
-      Nanoc3::DataSource   => 'Data Sources',
-      Nanoc3::Extra::VCS   => 'VCSes'
-    }
-
-    def name_for_plugin_class(klass)
-      PLUGIN_CLASSES[klass]
-    end
-
-  end
-
-end

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

@@ -1,37 +0,0 @@
-# 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-2012 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,72 +0,0 @@
-# encoding: utf-8
-
-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.
-
-This command will change data, and it is therefore recommended to make a
-backup in case something goes wrong.
-EOS
-
-required :c, :vcs, 'select the VCS to use'
-flag     :y, :yes, 'update the data without warning'
-
-run do |opts, args, cmd|
-  Nanoc3::CLI::Commands::Update.call(opts, args, cmd)
-end
-
-module Nanoc3::CLI::Commands
-
-  class Update < ::Nanoc3::CLI::Command
-
-    def run
-      # Check arguments
-      if arguments.size != 0
-        $stderr.puts "usage: #{command.usage}"
-        exit 1
-      end
-
-      # Make sure we are in a nanoc site directory
-      self.require_site
-
-      # Set VCS if possible
-      self.set_vcs(options[:vcs])
-
-      # Check for -y switch
-      unless options.has_key?(:yes)
-        $stderr.puts '*************'
-        $stderr.puts '** WARNING **'
-        $stderr.puts '*************'
-        $stderr.puts
-        $stderr.puts 'Are you absolutely sure you want to update the ' +
-                     'content for this site? Updating the site content ' +
-                     'will change the structure of existing data. This ' +
-                     'operation is destructive and cannot be reverted. ' +
-                     'Please do not interrupt this operation; doing so can ' +
-                     'result in data loss. As always, consider making a ' +
-                     'backup copy.'
-        $stderr.puts
-        $stderr.puts 'If this nanoc site is versioned using a VCS ' +
-                     'supported by nanoc, consider using the --vcs option ' +
-                     'to have nanoc perform add/delete/move operations ' +
-                     'using the specified VCS. To get a list of VCSes ' +
-                     'supported by nanoc, issue the "info" command.'
-        $stderr.puts
-        $stderr.puts 'To continue, use the -y/--yes option, like "nanoc3 ' +
-                     'update -y".'
-        exit 1
-      end
-
-      # Update
-      self.site.data_sources.each do |data_source|
-        data_source.update
-      end
-    end
-
-  end
-
-end

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

@@ -1,84 +0,0 @@
-# encoding: utf-8
-
-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 this static web server requires 'adsf' (not 'asdf'!).
-EOS
-
-required :H, :handler, 'specify the handler to use (webrick/mongrel/...)'
-required :o, :host,    'specify the host to listen on (default: 0.0.0.0)'
-required :p, :port,    'specify the port to listen on (default: 3000)'
-
-run do |opts, args, cmd|
-  Nanoc3::CLI::Commands::View.call(opts, args, cmd)
-end
-
-module Nanoc3::CLI::Commands
-
-  class View < ::Nanoc3::CLI::Command
-
-    def run
-      load_adsf
-      require 'rack'
-
-      # Make sure we are in a nanoc site directory
-      self.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 = self.site
-      app = Rack::Builder.new do
-        use Rack::CommonLogger
-        use Rack::ShowExceptions
-        use Rack::Lint
-        use Rack::Head
-        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
-
-  protected
-
-    def load_adsf
-      # Load adsf
-      begin
-        require 'adsf'
-        return
-      rescue LoadError
-        $stderr.puts "Could not find the required 'adsf' gem, " \
-          "which is necessary for the view command."
-      end
-
-      # Check asdf
-      begin
-        require 'asdf'
-        $stderr.puts "You appear to have 'asdf' installed, " \
-          "but not 'adsf'. Please install 'adsf' (check the spelling)!"
-      rescue LoadError
-      end
-
-      # Done
-      exit 1
-    end
-
-  end
-
-end

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

@@ -1,125 +0,0 @@
-# encoding: utf-8
-
-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
-
-module Nanoc3::CLI::Commands
-
-  class Watch < ::Nanoc3::CLI::Command
-
-    def run
-      require 'fssm'
-      require 'pathname'
-
-      watcher_config = self.site.config[:watcher] || {}
-
-      @notifier = Notifier.new
-
-      # Define rebuilder
-      rebuilder = lambda do |base, relative|
-        # Determine filename
-        if base.nil? || relative.nil?
-          filename = nil
-        else
-          filename = ::Pathname.new(File.join([ base, relative ])).relative_path_from(::Pathname.new(Dir.getwd)).to_s
-        end
-
-        # Notify
-        if filename
-          print "Change detected to #{filename}; recompiling… ".make_compatible_with_env
-        else
-          print "Watcher started; compiling the entire site… ".make_compatible_with_env
-        end
-
-        # Recompile
-        start = Time.now
-        site = Nanoc3::Site.new('.')
-        begin
-          site.compile
-
-          # TODO include icon (--image misc/success-icon.png)
-          notify_on_compilation_success = watcher_config.fetch(:notify_on_compilation_success) { true }
-          if notify_on_compilation_success
-            @notifier.notify('Compilation complete')
-          end
-
-          time_spent = ((Time.now - start)*1000.0).round
-          puts "done in #{format '%is %ims', *(time_spent.divmod(1000))}"
-        rescue Exception => e
-          # TODO include icon (--image misc/error-icon.png)
-          notify_on_compilation_failure = watcher_config.fetch(:notify_on_compilation_failure) { true }
-          if notify_on_compilation_failure
-            @notifier.notify('Compilation failed')
-          end
-
-          puts
-          Nanoc3::CLI::ErrorHandler.print_error(e)
-          puts
-        end
-      end
-
-      # Rebuild once
-      rebuilder.call(nil, nil)
-
-      # Get directories to watch
-      dirs_to_watch  = watcher_config[:dirs_to_watch]  || %w( content layouts lib )
-      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
-      watcher = lambda do |*args|
-        update(&rebuilder)
-        delete(&rebuilder)
-        create(&rebuilder)
-      end
-      monitor = FSSM::Monitor.new
-      dirs_to_watch.each  { |dir|      monitor.path(dir, '**/*', &watcher) }
-      files_to_watch.each { |filename| monitor.file(filename, &watcher)    }
-      monitor.run
-    end
-
-    # Allows sending user notifications in a cross-platform way.
-    class Notifier
-
-      # A list of commandline tool names that can be used to send notifications
-      TOOLS = %w( growlnotify notify-send )
-
-      # The tool to use for discovering binaries' locations
-      FIND_BINARY_COMMAND = RUBY_PLATFORM =~ /mingw|mswin/ ? "where" : "which"
-
-      # Send a notification. If no notifier is found, no notification will be
-      # created.
-      #
-      # @param [String] message The message to include in the notification
-      def notify(message)
-        return if tool.nil?
-        send(tool.tr('-', '_'), message)
-      end
-
-    private
-
-      def tool
-        @tool ||= TOOLS.find { |t| !`#{FIND_BINARY_COMMAND} #{t}`.empty? }
-      end
-
-      def growlnotify(message)
-        system('growlnotify', '-m', message)
-      end
-
-      def notify_send(message)
-        system('notify-send', message)
-      end
-
-    end
-
-  end
-
-end