nanoc 3.8.0 → 4.0.0a1

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

@@ -1,69 +0,0 @@
-# encoding: utf-8
-
-usage 'autocompile [options]'
-summary 'start the autocompiler'
-be_hidden
-aliases :aco
-description <<-EOS
-Start the autocompiler web server. Unless overridden with command-line options
-or configuration entries, the web server will run on port 3000 and listen on all
-IP addresses. Running the autocompiler requires the `mime/types` and `rack` gems.
-
-To specify the host, port, and/or handler options in config.yaml, you can add
-any of the following:
-
-    autocompile:
-      host: '10.0.2.0'  # override the default host
-      port: 4000        # override the default port
-      handler: thin     # override the default handler
-
-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)'
-
-module Nanoc::CLI::Commands
-  class AutoCompile < ::Nanoc::CLI::CommandRunner
-    def run
-      warn 'WARNING: The `autocompile` command is deprecated. Please consider using `guard-nanoc` instead (see https://github.com/nanoc/guard-nanoc).'
-
-      require 'rack'
-
-      # Make sure we are in a nanoc site directory
-      require_site
-      autocompile_config = site.config[:autocompile] || {}
-
-      # Set options
-      options_for_rack = {
-        Port: (options[:port] || autocompile_config[:port] || 3000).to_i,
-        Host: (options[:host] || autocompile_config[:host] || '0.0.0.0')
-      }
-
-      # Guess which handler we should use
-      handler_option = options[:handler] || autocompile_config[:handler]
-      handler = Rack::Handler.get(handler_option)
-      unless handler
-        begin
-          handler = Rack::Handler::Mongrel
-        rescue LoadError
-          handler = Rack::Handler::WEBrick
-        end
-      end
-
-      # Build app
-      autocompiler = Nanoc::Extra::AutoCompiler.new('.')
-      app = Rack::Builder.new do
-        use Rack::CommonLogger, $stderr
-        use Rack::ShowExceptions
-        run autocompiler
-      end.to_app
-
-      # Run autocompiler
-      puts "Running on http://#{options_for_rack[:Host]}:#{options_for_rack[:Port]}/"
-      handler.run(app, options_for_rack)
-    end
-  end
-end
-
-runner Nanoc::CLI::Commands::AutoCompile

data/lib/nanoc/cli/commands/create-item.rb

@@ -1,55 +0,0 @@
-# encoding: utf-8
-
-usage 'create-item [options] identifier'
-aliases :create_item, :ci
-summary 'create an item'
-description <<-EOS
-Create a new item in the current site. The first data source in the site
-configuration will be used.
-EOS
-
-required :c, :vcs, 'specify the VCS to use'
-
-module Nanoc::CLI::Commands
-  class CreateItem < ::Nanoc::CLI::CommandRunner
-    def run
-      # Check arguments
-      if arguments.length != 1
-        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
-      end
-
-      # Extract arguments and options
-      identifier = arguments[0].cleaned_identifier
-
-      # Make sure we are in a nanoc site directory
-      require_site
-
-      # Set VCS if possible
-      set_vcs(options[:vcs])
-
-      # Check whether item is unique
-      unless site.items.find { |i| i.identifier == identifier }.nil?
-        raise Nanoc::Errors::GenericTrivial,
-          "An item already exists at #{identifier}. Please " \
-          'pick a unique name for the item you are creating.'
-      end
-
-      # Setup notifications
-      Nanoc::NotificationCenter.on(:file_created) do |file_path|
-        Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
-      end
-
-      # Create item
-      data_source = site.data_sources[0]
-      data_source.create_item(
-        "Hi, I'm a new item!\n",
-        { title: 'A New Item' },
-        identifier
-      )
-
-      puts "An item has been created at #{identifier}."
-    end
-  end
-end
-
-runner Nanoc::CLI::Commands::CreateItem

data/lib/nanoc/cli/commands/create-layout.rb

@@ -1,68 +0,0 @@
-# encoding: utf-8
-
-usage 'create-layout [options] identifier'
-aliases :create_layout, :cl
-summary 'create a layout'
-description <<-EOS
-Create a new layout in the current site. The first data source in the site
-configuration will be used.
-EOS
-
-module Nanoc::CLI::Commands
-  class CreateLayout < ::Nanoc::CLI::CommandRunner
-    def run
-      # Check arguments
-      if arguments.length != 1
-        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
-      end
-
-      # Extract arguments
-      identifier = arguments[0].cleaned_identifier
-
-      # Make sure we are in a nanoc site directory
-      require_site
-
-      # Set VCS if possible
-      set_vcs(options[:vcs])
-
-      # Check whether layout is unique
-      unless site.layouts.find { |l| l.identifier == identifier }.nil?
-        raise Nanoc::Errors::GenericTrivial,
-          "A layout already exists at #{identifier}. Please " \
-          'pick a unique name for the layout you are creating.'
-      end
-
-      # Check whether layout is not at /
-      if identifier == '/'
-        raise Nanoc::Errors::GenericTrivial,
-          "There cannot be a layout with the identifier '/'; " \
-          'please pick a different identifier for this layout.'
-      end
-
-      # Setup notifications
-      Nanoc::NotificationCenter.on(:file_created) do |file_path|
-        Nanoc::CLI::Logger.instance.file(:high, :create, file_path)
-      end
-
-      # Create layout
-      data_source = site.data_sources[0]
-      data_source.create_layout(
-        "<html>\n" \
-        "  <head>\n" \
-        "    <title><%= @item[:title] %></title>\n" \
-        "  </head>\n" \
-        "  <body>\n" \
-        "    <p>Hi, I'm a new layout. Please customize me!</p>\n" \
-        "<%= yield %>\n" \
-        "  </body>\n" \
-        "</html>\n",
-        {},
-        identifier
-      )
-
-      puts "A layout has been created at #{identifier}."
-    end
-  end
-end
-
-runner Nanoc::CLI::Commands::CreateLayout

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

@@ -1,32 +0,0 @@
-# encoding: utf-8
-
-usage 'sync'
-summary 'sync data sources'
-description <<-EOS
-Sync data source data. This command is useful for updating local item caches
-for data sources which rely on slow external APIs.
-EOS
-
-module Nanoc::CLI::Commands
-  class Sync < ::Nanoc::CLI::CommandRunner
-    def run
-      # Check arguments
-      if arguments.size != 0
-        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
-      end
-
-      # Make sure we are in a nanoc site directory
-      require_site
-
-      # Update all syncable data sources
-      site.data_sources.each do |data_source|
-        unless data_source.method(:sync).owner == Nanoc::DataSource
-          puts "Syncing #{data_source.config[:type]} data source: #{data_source.items_root}"
-          data_source.sync
-        end
-      end
-    end
-  end
-end
-
-runner Nanoc::CLI::Commands::Sync

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

@@ -1,63 +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'
-
-module Nanoc::CLI::Commands
-  class Update < ::Nanoc::CLI::CommandRunner
-    def run
-      # Check arguments
-      if arguments.size != 0
-        raise Nanoc::Errors::GenericTrivial, "usage: #{command.usage}"
-      end
-
-      # Make sure we are in a nanoc site directory
-      require_site
-
-      # Set VCS if possible
-      set_vcs(options[:vcs])
-
-      # Check for -y switch
-      unless options.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 "nanoc ' \
-                     'update -y".'
-        exit 1
-      end
-
-      # Update
-      site.data_sources.each(&:update)
-    end
-  end
-end
-
-runner Nanoc::CLI::Commands::Update

data/lib/nanoc/cli/commands/validate-css.rb

@@ -1,20 +0,0 @@
-# encoding: utf-8
-
-usage 'validate-css [options]'
-aliases :validate_css, :vcss
-summary 'validate the site’s CSS'
-be_hidden
-description "
-Validates the site’s CSS files.
-"
-
-module Nanoc::CLI::Commands
-  class ValidateCSS < ::Nanoc::CLI::CommandRunner
-    def run
-      warn 'The `validate-css` command is deprecated. Please use the new `check` command instead.'
-      Nanoc::CLI.run %w( check css )
-    end
-  end
-end
-
-runner Nanoc::CLI::Commands::ValidateCSS

data/lib/nanoc/cli/commands/validate-html.rb

@@ -1,20 +0,0 @@
-# encoding: utf-8
-
-usage 'validate-html [options]'
-aliases :validate_html, :vhtml
-summary 'validate the site’s HTML'
-be_hidden
-description "
-Validates the site’s HTML files.
-"
-
-module Nanoc::CLI::Commands
-  class ValidateHTML < ::Nanoc::CLI::CommandRunner
-    def run
-      warn 'The `validate-html` command is deprecated. Please use the new `check` command instead.'
-      Nanoc::CLI.run %w( check html )
-    end
-  end
-end
-
-runner Nanoc::CLI::Commands::ValidateHTML

data/lib/nanoc/cli/commands/validate-links.rb

@@ -1,27 +0,0 @@
-# encoding: utf-8
-
-usage 'validate-links [options]'
-aliases :validate_links, :vlink
-summary 'validate links in site'
-be_hidden
-description "
-Validates the site’s links. By default, both internal and external links will be checked.
-"
-
-flag :i, :internal, 'validate internal links only'
-flag :e, :external, 'validate external links only'
-
-module Nanoc::CLI::Commands
-  class ValidateLinks < ::Nanoc::CLI::CommandRunner
-    def run
-      warn 'The `validate-links` command is deprecated. Please use the new `check` command instead.'
-
-      checks = []
-      checks << 'ilinks' if options[:internal]
-      checks << 'elinks' if options[:external]
-      Nanoc::CLI.run ['check', checks].flatten
-    end
-  end
-end
-
-runner Nanoc::CLI::Commands::ValidateLinks

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

@@ -1,176 +0,0 @@
-# encoding: utf-8
-
-usage 'watch [options]'
-summary 'start the watcher'
-be_hidden
-description <<-EOS
-Start the watcher. When a change is detected, the site will be recompiled.
-EOS
-
-module Nanoc::CLI::Commands
-  class Watch < ::Nanoc::CLI::CommandRunner
-    def run
-      warn 'WARNING: The `watch` command is deprecated. Please consider using `guard-nanoc` instead (see https://github.com/nanoc/guard-nanoc).'
-
-      require 'listen'
-      require 'pathname'
-
-      require_site
-      watcher_config = site.config[:watcher] || {}
-
-      @notifier = Notifier.new
-
-      # Define rebuilder
-      rebuilder = lambda do |file_path|
-        # Determine filename
-        if file_path.nil?
-          filename = nil
-        else
-          filename = ::Pathname.new(file_path).relative_path_from(::Pathname.new(Dir.getwd)).to_s
-        end
-
-        # Notify
-        if filename
-          print "Change detected to #{filename}; recompiling… "
-        else
-          print 'Watcher started; compiling the entire site… '
-        end
-
-        # Recompile
-        start = Time.now
-        site = Nanoc::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
-          Nanoc::CLI::ErrorHandler.print_error(e)
-          puts
-        end
-      end
-
-      # Rebuild once
-      rebuilder.call(nil)
-
-      # Get directories to watch
-      dirs_to_watch  = watcher_config.fetch(:dirs_to_watch, %w( content layouts lib ))
-      files_to_watch = watcher_config.fetch(:files_to_watch, %w( nanoc.yaml config.yaml Rules rules Rules.rb rules.rb ))
-      files_to_watch = Regexp.new(files_to_watch.map { |name| Regexp.quote(name) + '$' }.join('|'))
-      ignore_dir = Regexp.new(Dir.glob('*').map { |dir| dir if File.directory?(dir) }.compact.join('|'))
-
-      # Watch
-      puts 'Watching for changes…'
-
-      callback = proc do |modified, added, removed|
-        rebuilder.call(modified[0]) if modified[0]
-        rebuilder.call(added[0]) if added[0]
-        rebuilder.call(removed[0]) if removed[0]
-      end
-
-      listener = Listen::Listener.new(*dirs_to_watch).change(&callback)
-      listener_root = Listen::Listener.new('.', filter: files_to_watch, ignore: ignore_dir).change(&callback)
-
-      begin
-        listener_root.start
-        listener.start!
-      rescue Interrupt
-        listener.stop
-        listener_root.stop
-      end
-    end
-
-    # Allows sending user notifications in a cross-platform way.
-    class Notifier
-      # A list of command-line tool names that can be used to send notifications
-      TOOLS = %w( growlnotify notify-send ) unless defined? TOOLS
-
-      # 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?
-        if tool == 'growlnotify' && self.on_windows?
-          growlnotify_windows(message)
-        else
-          send(tool.tr('-', '_'), message)
-        end
-      end
-
-      protected
-
-      def nix_tool_present?(tool)
-        !`which #{tool}`.empty?
-      rescue Errno::ENOENT
-        false
-      end
-
-      def windows_tool_present?(tool)
-        !`where #{tool} 2> nul`.empty?
-      rescue Errno::ENOENT
-        false
-      end
-
-      def tool_present?(tool)
-        if self.on_windows?
-          self.windows_tool_present?(tool)
-        else
-          self.nix_tool_present?(tool)
-        end
-      end
-
-      def tool
-        @tool ||= begin
-          require 'terminal-notifier'
-          'terminal-notify'
-        rescue LoadError
-          TOOLS.find { |t| tool_present?(t) }
-        end
-      end
-
-      def terminal_notify(message)
-        TerminalNotifier.notify(message, title: 'nanoc')
-      end
-
-      def growlnotify_cmd_for(message)
-        ['growlnotify', '-m', message]
-      end
-
-      def growlnotify(message)
-        system(*growlnotify_cmd_for(message))
-      end
-
-      def growlnotify_windows_cmd_for(message)
-        ['growlnotify', '/t:nanoc', message]
-      end
-
-      def growlnotify_windows(message)
-        system(*growlnotify_windows_cmd_for(message))
-      end
-
-      def notify_send(message)
-        system('notify-send', message)
-      end
-
-      def on_windows?
-        Nanoc.on_windows?
-      end
-    end
-  end
-end
-
-runner Nanoc::CLI::Commands::Watch