nanoc 2.2.2 → 3.0.0a1

data/lib/nanoc/base/template.rb

@@ -1,64 +0,0 @@
-module Nanoc
-
-  # A Nanoc::Template represents a template, which can be used for creating
-  # new pages. Pages don't necessary have to be created using templates, but
-  # they can be useful for generating pages where you only have to "fill in
-  # the blanks".
-  class Template
-
-    # The Nanoc::Site this template belongs to.
-    attr_accessor :site
-
-    # The name of this template.
-    attr_reader :name
-
-    # The raw content a page created using this template will have.
-    attr_reader :page_content
-
-    # A hash containing the attributes a page created using this template will
-    # have.
-    attr_reader :page_attributes
-
-    # Creates a new template.
-    #
-    # +name+:: The name of this template.
-    #
-    # +page_content+:: The raw content a page created using this template will
-    #                  have.
-    #
-    # +page_attributes+:: A hash containing the attributes a page created
-    #                     using this template will have.
-    def initialize(page_content, page_attributes, name)
-      @page_content     = page_content
-      @page_attributes  = page_attributes.clean
-      @name             = name
-    end
-
-    # Saves the template in the database, creating it if it doesn't exist yet
-    # or updating it if it already exists. Tells the site's data source to
-    # save the template.
-    def save
-      @site.data_source.loading do
-        @site.data_source.save_template(self)
-      end
-    end
-
-    # Renames the template. Tells the site's data source to rename the
-    # template.
-    def move_to(new_name)
-      @site.data_source.loading do
-        @site.data_source.move_template(self, new_name)
-      end
-    end
-
-    # Deletes the template. Tells the site's data source to delete the
-    # template.
-    def delete
-      @site.data_source.loading do
-        @site.data_source.delete_template(self)
-      end
-    end
-
-  end
-
-end

data/lib/nanoc/binary_filters.rb

@@ -1 +0,0 @@
-require 'nanoc/binary_filters/image_science_thumbnail'

data/lib/nanoc/binary_filters/image_science_thumbnail.rb

@@ -1,28 +0,0 @@
-module Nanoc::BinaryFilters
-
-  class ImageScienceThumbnail < Nanoc::BinaryFilter
-
-    identifier :image_science_thumbnail
-
-    def run(file)
-      require 'image_science'
-
-      # Get temporary file path
-      tmp_file = Tempfile.new('filter')
-      tmp_path = tmp_file.path
-      tmp_file.close
-
-      # Create thumbnail
-      ImageScience.with_image(file.path) do |img|
-        img.thumbnail(@asset_rep.thumbnail_size || 150) do |thumbnail|
-          thumbnail.save(tmp_path)
-        end
-      end
-
-      # Return thumbnail file
-      File.open(tmp_path)
-    end
-
-  end
-
-end

data/lib/nanoc/cli.rb

@@ -1,9 +0,0 @@
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../../vendor/cri/lib'))
-require 'cri'
-
-module Nanoc::CLI # :nodoc:
-end
-
-require 'nanoc/cli/base'
-require 'nanoc/cli/commands'
-require 'nanoc/cli/logger'

data/lib/nanoc/cli/base.rb

@@ -1,132 +0,0 @@
-module Nanoc::CLI
-
-  # Nanoc::CLI::Base is the central class representing a commandline nanoc
-  # tool. It has a list of commands, and is linked to a specific nanoc site.
-  class Base < Cri::Base
-
-    attr_reader :commands, :site
-
-    # Creates a new instance of the commandline nanoc tool.
-    def initialize
-      super('nanoc')
-
-      # Add help command
-      self.help_command = Nanoc::CLI::HelpCommand.new
-      add_command(self.help_command)
-
-      # Add other commands
-      add_command(Nanoc::CLI::AutocompileCommand.new)
-      add_command(Nanoc::CLI::CompileCommand.new)
-      add_command(Nanoc::CLI::CreateLayoutCommand.new)
-      add_command(Nanoc::CLI::CreatePageCommand.new)
-      add_command(Nanoc::CLI::CreateSiteCommand.new)
-      add_command(Nanoc::CLI::CreateTemplateCommand.new)
-      add_command(Nanoc::CLI::InfoCommand.new)
-      add_command(Nanoc::CLI::SwitchCommand.new)
-      add_command(Nanoc::CLI::UpdateCommand.new)
-    end
-
-    # Helper function which can be called when a command is executed that
-    # requires a site, such as the compile command.
-    def require_site
-      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
-
-    # Gets the site (Nanoc::Site) in the current directory and loads its data.
-    def site
-      # Load site if possible
-      if File.file?('config.yaml') and @site.nil?
-        begin
-          @site = Nanoc::Site.new(YAML.load_file('config.yaml'))
-          @site.load_data
-        rescue Nanoc::Errors::UnknownDataSourceError => e
-          $stderr.puts "Unknown data source: #{e}"
-          exit 1
-        rescue Nanoc::Errors::UnknownRouterError => e
-          $stderr.puts "Unknown router: #{e}"
-          exit 1
-        rescue Exception => e
-          $stderr.puts "ERROR: An exception occured while loading this site."
-          $stderr.puts
-          $stderr.puts "If you think this is a bug in nanoc, please do report it at " +
-                       "<http://nanoc.stoneship.org/trac/newticket> -- thanks!"
-          $stderr.puts
-          $stderr.puts 'Message:'
-          $stderr.puts '  ' + e.message
-          $stderr.puts
-          $stderr.puts 'Backtrace:'
-          $stderr.puts e.backtrace.map { |t| '  - ' + t }.join("\n")
-          exit 1
-        end
-      end
-
-      @site
-    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=).
-    def set_vcs(vcs_name)
-      # Skip if not possible
-      return if vcs_name.nil?
-      return if site.nil? or !site.data_source.respond_to?(:vcs=)
-
-      # Find VCS
-      vcs_class = Nanoc::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
-
-      # Set VCS
-      site.data_source.vcs = vcs_class.new
-    end
-
-    # Returns the list of global option definitionss.
-    def global_option_definitions
-      [
-        {
-          :long => 'help', :short => 'h', :argument => :forbidden,
-          :desc => 'show this help message and quit'
-        },
-        {
-          :long => 'no-color', :short => 'C', :argument => :forbidden,
-          :desc => 'disable color'
-        },
-        {
-          :long => 'verbose', :short => 'V', :argument => :forbidden,
-          :desc => 'make nanoc output more detailed'
-        },
-        {
-          :long => 'version', :short => 'v', :argument => :forbidden,
-          :desc => 'show version information and quit'
-        }
-      ]
-    end
-
-    def handle_option(option)
-      # Handle no-color option
-      if option == :'no-color'
-        Nanoc::CLI::Logger.instance.color = false
-      # Handle verbose option
-      elsif option == :verbose
-        Nanoc::CLI::Logger.instance.level = :low
-      # Handle version option
-      elsif option == :version
-        puts "nanoc #{Nanoc::VERSION} (c) 2007-2009 Denis Defreyne."
-        puts "Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) running on #{RUBY_PLATFORM}"
-        exit 0
-      # Handle help option
-      elsif option == :help
-        show_help
-        exit 0
-      end
-    end
-
-  end
-
-end

data/lib/nanoc/cli/commands.rb

@@ -1,10 +0,0 @@
-require 'nanoc/cli/commands/autocompile'
-require 'nanoc/cli/commands/compile'
-require 'nanoc/cli/commands/create_layout'
-require 'nanoc/cli/commands/create_page'
-require 'nanoc/cli/commands/create_site'
-require 'nanoc/cli/commands/create_template'
-require 'nanoc/cli/commands/help'
-require 'nanoc/cli/commands/info'
-require 'nanoc/cli/commands/switch'
-require 'nanoc/cli/commands/update'

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

@@ -1,80 +0,0 @@
-module Nanoc::CLI
-
-  class AutocompileCommand < Cri::Command # :nodoc:
-
-    def name
-      'autocompile'
-    end
-
-    def aliases
-      [ 'aco', 'autocompile_site' ]
-    end
-
-    def short_desc
-      'start the autocompiler'
-    end
-
-    def long_desc
-      handler_names = Nanoc::Extra::AutoCompiler::HANDLER_NAMES.join(', ')
-
-      '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 \'mime/types\' and \'rack\'.' +
-      "\n" +
-      'Available handlers are (in order of preference): ' + handler_names +
-      ' (default is ' + Nanoc::Extra::AutoCompiler::HANDLER_NAMES[0].to_s + ').'
-    end
-
-    def usage
-      "nanoc autocompile [options]"
-    end
-
-    def option_definitions
-      [
-        # --all
-        {
-          :long => 'all', :short => 'a', :argument => :forbidden,
-          :desc => 'compile all pages, even those that aren\'t outdated'
-        },
-        # --port
-        {
-          :long => 'port', :short => 'p', :argument => :required,
-          :desc => 'specify a port number for the autocompiler'
-        },
-        # --handler
-        {
-          :long => 'handler', :short => 'H', :argument => :required,
-          :desc => 'specify the handler to use'
-        }
-      ]
-    end
-
-    def run(options, arguments)
-      # Check arguments
-      if arguments.size != 0
-        $stderr.puts "usage: #{usage}"
-        exit 1
-      end
-
-      # Make sure we are in a nanoc site directory
-      @base.require_site
-
-      # Autocompile site
-      begin
-        autocompiler = Nanoc::Extra::AutoCompiler.new(@base.site, options.has_key?(:all))
-        autocompiler.start(
-          options[:port],
-          options[:handler]
-        )
-      rescue LoadError
-        $stderr.puts "'mime/types' and 'rack' are required to autocompile sites. " +
-                     "You may want to install the 'mime-types' and 'rack' gems by " +
-                     "running 'gem install mime-types' and 'gem install rack'."
-      rescue Nanoc::Extra::AutoCompiler::UnknownHandlerError
-        $stderr.puts "The requested handler, #{options[:handler]}, is not available."
-      end
-    end
-
-  end
-
-end

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

@@ -1,311 +0,0 @@
-module Nanoc::CLI
-
-  class CompileCommand < Cri::Command # :nodoc:
-
-    def name
-      'compile'
-    end
-
-    def aliases
-      []
-    end
-
-    def short_desc
-      'compile pages and assets of this site'
-    end
-
-    def long_desc
-      'Compile all pages and all assets of the current site. If a path is ' +
-      'given, only the page or asset with the given path will be compiled. ' +
-      'Additionally, only pages and assets that are outdated will be ' +
-      'compiled, unless specified otherwise with the -a option.'
-    end
-
-    def usage
-      "nanoc compile [options] [path]"
-    end
-
-    def option_definitions
-      [
-        # --all
-        {
-          :long => 'all', :short => 'a', :argument => :forbidden,
-          :desc => 'compile all pages and assets, even those that aren\'t outdated'
-        },
-        # --pages
-        {
-          :long => 'pages', :short => 'P', :argument => :forbidden,
-          :desc => 'only compile pages (no assets)'
-        },
-        # --assets
-        {
-          :long => 'assets', :short => 'A', :argument => :forbidden,
-          :desc => 'only compile assets (no pages)'
-        },
-        # --only-outdated
-        {
-          :long => 'only-outdated', :short => 'o', :argument => :forbidden,
-          :desc => 'only compile outdated pages and assets'
-        },
-      ]
-    end
-
-    def run(options, arguments)
-      # Make sure we are in a nanoc site directory
-      @base.require_site
-
-      # Find object with given path
-      if arguments.size == 0
-        # Find all pages and/or assets
-        if options.has_key?(:pages)
-          objs = @base.site.pages
-        elsif options.has_key?(:assets)
-          objs = @base.site.assets
-        else
-          objs = nil
-        end
-      else
-        objs = arguments.map do |path|
-          # Find object
-          path = path.cleaned_path
-          obj = @base.site.pages.find { |page| page.path == path }
-          obj = @base.site.assets.find { |asset| asset.path == path } if obj.nil?
-
-          # Ensure object
-          if obj.nil?
-            $stderr.puts "Unknown page or asset: #{path}"
-            exit 1
-          end
-
-          obj
-        end
-      end
-
-      # Compile site
-      begin
-        # Give feedback
-        puts "Compiling #{objs.nil? ? 'site' : 'objects'}..."
-
-        # Initialize profiling stuff
-        time_before = Time.now
-        @filter_times ||= {}
-        @times_stack  ||= []
-        setup_notifications
-
-        # Parse all/only-outdated options
-        if options.has_key?(:all)
-          warn "WARNING: The --all option is no longer necessary as nanoc " +
-               "2.2 compiles all pages and assets by default. To change this " +
-               "behaviour, use the --only-outdated option."
-        end
-        compile_all = options.has_key?(:'only-outdated') ? false : true
-
-        # Compile
-        @base.site.compiler.run(
-          objs,
-          :even_when_not_outdated => compile_all
-        )
-
-        # Find reps
-        page_reps  = @base.site.pages.map { |p| p.reps }.flatten
-        asset_reps = @base.site.assets.map { |a| a.reps }.flatten
-        reps       = page_reps + asset_reps
-
-        # Show skipped reps
-        reps.select { |r| !r.compiled? }.each do |rep|
-          duration = @rep_times[rep.disk_path]
-          Nanoc::CLI::Logger.instance.file(:low, :skip, rep.disk_path, duration)
-        end
-
-        # Show non-written reps
-        reps.select { |r| r.compiled? && r.attribute_named(:skip_output) }.each do |rep|
-          duration = @rep_times[rep.disk_path]
-          Nanoc::CLI::Logger.instance.file(:low, :'not written', rep.disk_path, duration)
-        end
-
-        # Give general feedback
-        puts
-        puts "No objects were modified." unless reps.any? { |r| r.modified? }
-        puts "#{objs.nil? ? 'Site' : 'Object'} compiled in #{format('%.2f', Time.now - time_before)}s."
-
-        if options.has_key?(:verbose)
-          print_state_feedback(reps)
-          print_profiling_feedback(reps)
-        end
-      rescue Interrupt => e
-        exit
-      rescue Exception => e
-        print_error(e)
-      end
-    end
-
-  private
-
-    def setup_notifications
-      Nanoc::NotificationCenter.on(:compilation_started) do |rep|
-        rep_compilation_started(rep)
-      end
-      Nanoc::NotificationCenter.on(:compilation_ended) do |rep|
-        rep_compilation_ended(rep)
-      end
-      Nanoc::NotificationCenter.on(:filtering_started) do |rep, filter_name|
-        rep_filtering_started(rep, filter_name)
-      end
-      Nanoc::NotificationCenter.on(:filtering_ended) do |rep, filter_name|
-        rep_filtering_ended(rep, filter_name)
-      end
-    end
-
-    def print_state_feedback(reps)
-      # Categorise reps
-      rest              = reps
-      created,     rest = *rest.partition { |r| r.created? }
-      modified,    rest = *rest.partition { |r| r.modified? }
-      skipped,     rest = *rest.partition { |r| !r.compiled? }
-      not_written, rest = *rest.partition { |r| r.compiled? && r.attribute_named(:skip_output) }
-      identical         = rest
-
-      # Print
-      puts
-      puts format('  %4d  created',     created.size)
-      puts format('  %4d  modified',    modified.size)
-      puts format('  %4d  skipped',     skipped.size)
-      puts format('  %4d  not written', not_written.size)
-      puts format('  %4d  identical',   identical.size)
-    end
-
-    def print_profiling_feedback(reps)
-      # Get max filter length
-      max_filter_name_length = @filter_times.keys.map { |k| k.to_s.size }.max
-      return if max_filter_name_length.nil?
-
-      # Print warning if necessary
-      if reps.any? { |r| !r.compiled? }
-        $stderr.puts
-        $stderr.puts "Warning: profiling information may not be accurate because " +
-                     "some objects were not compiled."
-      end
-
-      # Print header
-      puts
-      puts ' ' * max_filter_name_length + ' | count    min    avg    max     tot'
-      puts '-' * max_filter_name_length + '-+-----------------------------------'
-
-      @filter_times.to_a.sort_by { |r| r[1] }.each do |row|
-        # Extract data
-        filter_name, samples = *row
-
-        # Calculate stats
-        count = samples.size
-        min   = samples.min
-        tot   = samples.inject { |memo, i| memo + i}
-        avg   = tot/count
-        max   = samples.max
-
-        # Format stats
-        count = format('%4d',   count)
-        min   = format('%4.2f', min)
-        avg   = format('%4.2f', avg)
-        max   = format('%4.2f', max)
-        tot   = format('%5.2f', tot)
-
-        # Output stats
-        filter_name = format("%#{max_filter_name_length}s", filter_name)
-        puts "#{filter_name} |  #{count}  #{min}s  #{avg}s  #{max}s  #{tot}s"
-      end
-    end
-
-    def print_error(error)
-      # Get rep
-      rep = @base.site.compiler.stack.select { |i| i.is_a?(Nanoc::PageRep) || i.is_a?(Nanoc::AssetRep) }[-1]
-      rep_name = rep.nil? ? 'the site' : "#{rep.is_a?(Nanoc::PageRep) ? rep.page.path : rep.asset.path} (rep #{rep.name})"
-
-      # Build message
-      case error
-      when Nanoc::Errors::UnknownLayoutError
-        message = "Unknown layout: #{error.message}"
-      when Nanoc::Errors::UnknownFilterError
-        message = "Unknown filter: #{error.message}"
-      when Nanoc::Errors::CannotDetermineFilterError
-        message = "Cannot determine filter for layout: #{error.message}"
-      when Nanoc::Errors::RecursiveCompilationError
-        message = "Recursive call to page content."
-      when Nanoc::Errors::NoLongerSupportedError
-        message = "No longer supported: #{error.message}"
-      else
-        message = "Error: #{error.message}"
-      end
-
-      # Print message
-      $stderr.puts
-      $stderr.puts "ERROR: An exception occured while compiling #{rep_name}."
-      $stderr.puts
-      $stderr.puts "If you think this is a bug in nanoc, please do report it at " +
-                   "<http://nanoc.stoneship.org/trac/newticket> -- thanks!"
-      $stderr.puts
-      $stderr.puts 'Message:'
-      $stderr.puts '  ' + message
-      $stderr.puts
-      $stderr.puts 'Compilation stack:'
-      @base.site.compiler.stack.reverse.each do |item|
-        if item.is_a?(Nanoc::PageRep) # page rep
-          $stderr.puts "  - [page]   #{item.page.path} (rep #{item.name})"
-        elsif item.is_a?(Nanoc::AssetRep) # asset rep
-          $stderr.puts "  - [asset]  #{item.asset.path} (rep #{item.name})"
-        else # layout
-          $stderr.puts "  - [layout] #{item.path}"
-        end
-      end
-      $stderr.puts
-      $stderr.puts 'Backtrace:'
-      $stderr.puts error.backtrace.map { |t| '  - ' + t }.join("\n")
-    end
-
-    def rep_compilation_started(rep)
-      # Profile compilation
-      @rep_times ||= {}
-      @rep_times[rep.disk_path] = Time.now
-    end
-
-    def rep_compilation_ended(rep)
-      # Profile compilation
-      @rep_times ||= {}
-      @rep_times[rep.disk_path] = Time.now - @rep_times[rep.disk_path]
-
-      # Skip if not outputted
-      return if rep.attribute_named(:skip_output)
-
-      # Get action and level
-      action, level = *if rep.created?
-        [ :create, :high ]
-      elsif rep.modified?
-        [ :update, :high ]
-      elsif !rep.compiled?
-        [ nil, nil ]
-      else
-        [ :identical, :low ]
-      end
-
-      # Log
-      unless action.nil?
-        duration = @rep_times[rep.disk_path]
-        Nanoc::CLI::Logger.instance.file(level, action, rep.disk_path, duration)
-      end
-    end
-
-    def rep_filtering_started(rep, filter_name)
-      @times_stack.push(Time.now)
-    end
-
-    def rep_filtering_ended(rep, filter_name)
-      # Get last time
-      time_start = @times_stack.pop
-
-      # Update times
-      @filter_times[filter_name.to_sym] ||= []
-      @filter_times[filter_name.to_sym] << Time.now - time_start
-    end
-
-  end
-
-end