nanoc3 3.2.4 → 3.3.0

data/lib/nanoc3/base/store.rb

@@ -1,135 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3
-
-  # An abstract superclass for classes that need to store data to the
-  # filesystem, such as checksums, cached compiled content and dependency
-  # graphs.
-  #
-  # Each store has a version number. When attempting to load data from a store
-  # that has an incompatible version number, no data will be loaded, but
-  # {#version_mismatch_detected} will be called.
-  #
-  # @abstract Subclasses must implement {#data} and {#data=}, and may
-  #   implement {#no_data_found} and {#version_mismatch_detected}.
-  #
-  # @api private
-  class Store
-
-    # @return [String] The name of the file where data will be loaded from and
-    #   stored to.
-    attr_reader :filename
-
-    # @return [Numeric] The version number corresponding to the file format
-    #   the data is in. When the file format changes, the version number
-    #   should be incremented.
-    attr_reader :version
-
-    # Creates a new store for the given filename.
-    #
-    # @param [String] filename The name of the file where data will be loaded
-    #   from and stored to.
-    #
-    # @param [Numeric] version The version number corresponding to the file
-    #   format the data is in. When the file format changes, the version
-    #   number should be incremented.
-    def initialize(filename, version)
-      @filename = filename
-      @version  = version
-    end
-
-    # @group Loading and storing data
-
-    # @return The data that should be written to the disk
-    #
-    # @abstract This method must be implemented by the subclass.
-    def data
-      raise NotImplementedError.new("Nanoc3::Store subclasses must implement #data and #data=")
-    end
-
-    # @param new_data The data that has been loaded from the disk
-    #
-    # @abstract This method must be implemented by the subclass.
-    #
-    # @return [void]
-    def data=(new_data)
-      raise NotImplementedError.new("Nanoc3::Store subclasses must implement #data and #data=")
-    end
-
-    # Loads the data from the filesystem into memory. This method will set the
-    #   loaded data using the {#data=} method.
-    #
-    # @return [void]
-    def load
-      # Don’t load twice
-      if @loaded
-        return
-      end
-
-      # Check file existance
-      if !File.file?(self.filename)
-        no_data_found
-        @loaded = true
-        return
-      end
-
-      pstore.transaction do
-        # Check version
-        if pstore[:version] != self.version
-          version_mismatch_detected
-          @loaded = true
-          return
-        end
-
-        # Load
-        self.data = pstore[:data]
-        @loaded = true
-      end
-    end
-
-    # Undoes the effects of {#load}. Used when {#load} raises an exception.
-    #
-    # @api private
-    def unload
-    end
-
-    # Stores the data contained in memory to the filesystem. This method will
-    #   use the {#data} method to fetch the data that should be written.
-    #
-    # @return [void]
-    def store
-      FileUtils.mkdir_p(File.dirname(self.filename))
-
-      pstore.transaction do
-        pstore[:data]    = self.data
-        pstore[:version] = self.version
-      end
-    end
-
-    # @group Callback methods
-
-    # Callback method that is called when no data file was found. By default,
-    # this implementation does nothing, but it should probably be overridden
-    # by the subclass.
-    #
-    # @return [void]
-    def no_data_found
-    end
-
-    # Callback method that is called when a version mismatch is detected. By
-    # default, this implementation does nothing, but it should probably be
-    # overridden by the subclass.
-    #
-    # @return [void]
-    def version_mismatch_detected
-    end
-
-  private
-
-    def pstore
-      @pstore ||= PStore.new(self.filename)
-    end
-
-  end
-
-end

data/lib/nanoc3/cli.rb

@@ -1,133 +0,0 @@
-# encoding: utf-8
-
-require 'cri'
-
-module Nanoc3::CLI
-
-  module Commands
-  end
-
-  autoload 'Logger',             'nanoc3/cli/logger'
-  autoload 'Command',            'nanoc3/cli/command'
-  autoload 'ErrorHandler',       'nanoc3/cli/error_handler'
-
-  # @return [Boolean] true if debug output is enabled, false if not
-  #
-  # @since 3.2.0
-  def self.debug?
-    @debug || false
-  end
-
-  # @param [Boolean] boolean true if debug output should be enabled,
-  #   false if it should not
-  #
-  # @return [void]
-  #
-  # @since 3.2.0
-  def self.debug=(boolean)
-    @debug = boolean
-  end
-
-  # Invokes the nanoc commandline tool with the given arguments.
-  #
-  # @param [Array<String>] args An array of commandline arguments
-  #
-  # @return [void]
-  def self.run(args)
-    Nanoc3::CLI::ErrorHandler.handle_while do
-      self.setup
-      self.load_custom_commands
-      self.root_command.run(args)
-    end
-  end
-
-  # Adds the given command to the collection of available commands.
-  #
-  # @param [Cri::Command] cmd The command to add
-  #
-  # @return [void]
-  def self.add_command(cmd)
-    self.root_command.add_command(cmd)
-  end
-
-protected
-
-  # Makes the commandline interface ready for using by loading the commands.
-  #
-  # @return [void]
-  def self.setup
-    # Reinit
-    @root_command = nil
-
-    # Add help command
-    help_cmd = Cri::Command.new_basic_help
-    self.add_command(help_cmd)
-
-    # Add other commands
-    cmd_filenames = Dir[File.dirname(__FILE__) + '/cli/commands/*.rb']
-    cmd_filenames.each do |filename|
-      next if File.basename(filename, '.rb') == 'nanoc'
-      cmd = self.load_command_at(filename)
-      self.add_command(cmd)
-    end
-  end
-
-  # Loads the commands in `commands/`.
-  #
-  # @return [void]
-  def self.load_custom_commands
-    self.recursive_contents_of('commands').each do |filename|
-      # Create command
-      command = Nanoc3::CLI.load_command_at(filename)
-
-      # Get supercommand
-      pieces = filename.gsub(/^commands\/|\.rb$/, '').split('/')
-      pieces = pieces[0, pieces.size-1] || []
-      root = Nanoc3::CLI.root_command
-      supercommand = pieces.inject(root) do |cmd, piece|
-        cmd.nil? ? nil : cmd.command_named(piece)
-      end
-
-      # Add to supercommand
-      if supercommand.nil?
-        raise "Cannot load command at #{filename} because its supercommand cannot be found"
-      end
-      supercommand.add_command(command)
-    end
-  end
-
-  # Loads the command in the file with the given filename.
-  #
-  # @param [String] filename The name of the file that contains the command
-  #
-  # @return [Cri::Command] The loaded command
-  def self.load_command_at(filename, command_name=nil)
-    # Load
-    code = File.read(filename)
-    cmd = Cri::Command.define(code, filename)
-
-    # Set name
-    command_name ||= File.basename(filename, '.rb')
-    cmd.modify { name command_name }
-
-    # Done
-    cmd
-  end
-
-  # @return [Cri::Command] The root command, i.e. the commandline tool itself
-  def self.root_command
-    @root_command ||= begin
-      filename = File.dirname(__FILE__) + "/cli/commands/nanoc.rb"
-      self.load_command_at(filename)
-    end
-  end
-
-  # @return [Array] The directory contents
-  def self.recursive_contents_of(path)
-    return [] unless File.directory?(path)
-    files, dirs = *Dir[path + '/*'].sort.partition { |e| File.file?(e) }
-    dirs.each { |d| files.concat self.recursive_contents_of(d) }
-    files
-  end
-
-end

data/lib/nanoc3/cli/command.rb

@@ -1,139 +0,0 @@
-# encoding: utf-8
-
-module Nanoc3::CLI
-
-  # An abstract superclass for commands that can be executed. These are not
-  # the same as Cri commands, but are used in conjuction with Cri commands.
-  # nanoc commands will be called by Cri commands and will perform the actual
-  # execution of the command, as well as perform error handling if necessary.
-  class Command
-
-    # @return [Hash] A hash contain the options and their values
-    attr_reader :options
-
-    # @return [Array] The list of arguments
-    attr_reader :arguments
-
-    # @return [Cri::Command] The Cri command
-    attr_reader :command
-
-    # @param [Hash] options A hash contain the options and their values
-    #
-    # @param [Array] arguments The list of arguments
-    #
-    # @param [Cri::Command] command The Cri command
-    def initialize(options, arguments, command)
-      @options   = options
-      @arguments = arguments
-      @command   = command
-    end
-
-    # Runs the command with the given options, arguments and Cri command. This
-    # is a convenience method so that no individual command needs to be
-    # created.
-    #
-    # @param [Hash] options A hash contain the options and their values
-    #
-    # @param [Array] arguments The list of arguments
-    #
-    # @param [Cri::Command] command The Cri command
-    #
-    # @return [void]
-    def self.call(options, arguments, command)
-      self.new(options, arguments, command).call
-    end
-
-    # Runs the command.
-    #
-    # @return [void]
-    def call
-      Nanoc3::CLI::ErrorHandler.handle_while(:command => self) do
-        self.run
-      end
-    end
-
-    # Performs the actual execution of the command.
-    #
-    # @return [void]
-    #
-    # @abstract
-    def run
-    end
-
-    # Gets the site ({Nanoc3::Site} instance) in the current directory and
-    # loads its data.
-    #
-    # @return [Nanoc3::Site] The site in the current working directory
-    def site
-      # Load site if possible
-      @site ||= nil
-      if File.file?('config.yaml') && @site.nil?
-        begin
-          @site = Nanoc3::Site.new('.')
-        rescue Nanoc3::Errors::UnknownDataSource => e
-          $stderr.puts "Unknown data source: #{e}"
-          exit 1
-        end
-      end
-
-      @site
-    end
-
-  protected
-
-    # @return [Boolean] true if debug output is enabled, false if not
-    #
-    # @see Nanoc3::CLI.debug?
-    def debug?
-      Nanoc3::CLI.debug?
-    end
-
-    # Asserts that the current working directory contains a site
-    # ({Nanoc3::Site} instance). If no site is present, prints an error
-    # message and exits.
-    #
-    # @return [void]
-    def require_site
-      @site = nil
-      if site.nil?
-        $stderr.puts 'The current working directory does not seem to be a ' +
-                     'valid/complete nanoc site directory; aborting.'
-        exit 1
-      end
-    end
-
-    # Sets the data source's VCS to the VCS with the given name. Does nothing
-    # when the site's data source does not support VCSes (i.e. does not
-    # implement #vcs=).
-    #
-    # @param [String] vcs_name The name of the VCS that should be used
-    #
-    # @return [void]
-    def set_vcs(vcs_name)
-      # Skip if not possible
-      return if vcs_name.nil? || site.nil?
-
-      # Find VCS
-      vcs_class = Nanoc3::Extra::VCS.named(vcs_name.to_sym)
-      if vcs_class.nil?
-        $stderr.puts "A VCS named #{vcs_name} was not found; aborting."
-        exit 1
-      end
-
-      site.data_sources.each do |data_source|
-        # Skip if not possible
-        next if !data_source.respond_to?(:vcs=)
-
-        # Set VCS
-        data_source.vcs = vcs_class.new
-      end
-    end
-
-    # @return [Array] The compilation stack.
-    def stack
-      (self.site && self.site.compiler.stack) || []
-    end
-
-  end
-
-end

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

@@ -1,60 +0,0 @@
-# encoding: utf-8
-
-usage       'autocompile [options]'
-summary     'start the autocompiler'
-aliases     :aco
-description <<-EOS
-Start the autocompiler web server. Unless specified, the web server will run
-on port 3000 and listen on all IP addresses. Running the autocompiler requires
-the 'mime/types' and 'rack' gems.
-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::AutoCompile.call(opts, args, cmd)
-end
-
-module Nanoc3::CLI::Commands
-
-  class AutoCompile < ::Nanoc3::CLI::Command
-
-    def run
-      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
-      autocompiler = Nanoc3::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