nanoc 3.2.4 → 3.3.0

data/lib/nanoc/extra/core_ext.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'nanoc/extra/core_ext/enumerable'
+require 'nanoc/extra/core_ext/pathname'
+require 'nanoc/extra/core_ext/time'
+

data/lib/nanoc/extra/core_ext/enumerable.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+module Enumerable
+
+  if !Enumerable.instance_methods.include?('group_by')
+
+    # Returns a hash, which keys are evaluated result from the block, and
+    # values are arrays of elements in enum corresponding to the key. This
+    # method is provided for backward compatibility with Ruby 1.8.6 and lower,
+    # since {#group_by} is only available in 1.8.7 and higher.
+    #
+    # @yieldparam [Object] obj The object to classify
+    #
+    # @return [Hash]
+    #
+    # @example Grouping integers by rest by division through 3
+    #
+    #   (1..6).group_by { |i| i % 3 }
+    #   # => { 0 => [3, 6], 1 => [1, 4], 2 => [2, 5] }
+    def group_by
+      groups = {}
+      each do |item|
+        key = yield(item)
+
+        groups[key] ||= []
+        groups[key] << item
+      end
+      groups
+    end
+
+  end
+
+end

data/lib/nanoc/extra/core_ext/pathname.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Nanoc::Extra
+
+  module PathnameExtensions
+
+    def components
+      components = []
+      tmp = self
+      loop do
+        old = tmp
+        components << File.basename(tmp)
+        tmp = File.dirname(tmp)
+        break if old == tmp
+      end
+      components.reverse
+    end
+
+    def include_component?(component)
+      self.components.include?(component)
+    end
+
+  end
+
+end
+
+class ::Pathname
+  include ::Nanoc::Extra::PathnameExtensions
+end
+

data/lib/nanoc/extra/core_ext/time.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+module Nanoc::Extra::TimeExtensions
+
+  # @return [String] The time in an ISO-8601 date format.
+  def to_iso8601_date
+    self.strftime("%Y-%m-%d")
+  end
+
+  # @return [String] The time in an ISO-8601 time format.
+  def to_iso8601_time
+    self.getutc.strftime("%Y-%m-%dT%H:%M:%SZ")
+  end
+
+end
+
+class Time
+  include Nanoc::Extra::TimeExtensions
+end

data/lib/nanoc/extra/deployer.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+module Nanoc::Extra
+
+  # Represents a deployer, an object that allows uploading the compiled site
+  # to a specific (remote) location.
+  #
+  # @abstract Subclass and override {#run} to implement a custom filter.
+  class Deployer
+
+    extend Nanoc::PluginRegistry::PluginMethods
+
+    # @return [String] The path to the directory that contains the files to
+    #   upload. It should not have a trailing slash.
+    attr_reader :source_path
+
+    # @return [Hash] The deployer configuration
+    attr_reader :config
+
+    # @return [Boolean] true if the deployer should only show what would be
+    #   deployed instead of doing the actual deployment
+    attr_reader :dry_run
+    alias_method :dry_run?, :dry_run
+
+    # @param [String] source_path The path to the directory that contains the
+    #   files to upload. It should not have a trailing slash.
+    #
+    # @return [Hash] config The deployer configuration
+    #
+    # @option params [Boolean] :dry_run (false) true if the deployer should
+    #   only show what would be deployed instead actually deploying
+    def initialize(source_path, config, params={})
+      @source_path  = source_path
+      @config       = config
+      @dry_run      = params.fetch(:dry_run) { false }
+    end
+
+    # Performs the actual deployment.
+    #
+    # @abstract
+    def run
+      raise NotImplementedError.new("Nanoc::Extra::Deployer subclasses must implement #run")
+    end
+
+  end
+
+end

data/lib/nanoc/extra/deployers.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Nanoc::Extra
+
+  module Deployers
+
+    autoload 'Fog',   'nanoc/extra/deployers/fog'
+    autoload 'Rsync', 'nanoc/extra/deployers/rsync'
+
+    Nanoc::Extra::Deployer.register '::Nanoc::Extra::Deployers::Fog',   :fog
+    Nanoc::Extra::Deployer.register '::Nanoc::Extra::Deployers::Rsync', :rsync
+
+  end
+
+end

data/lib/nanoc/extra/deployers/fog.rb

@@ -0,0 +1,98 @@
+# encoding: utf-8
+
+module Nanoc::Extra::Deployers
+
+  # A deployer that deploys a site using [fog](https://github.com/geemus/fog).
+  #
+  # @example A deployment configuration with public and staging configurations
+  #
+  #   deploy:
+  #     public:
+  #       kind:       fog
+  #       provider:   local
+  #       local_root: ~/myCloud
+  #       bucket:     nanoc-site
+  #     staging:
+  #       kind:       fog
+  #       provider:   local
+  #       local_root: ~/myCloud
+  #       bucket:     nanoc-site-staging
+  class Fog < ::Nanoc::Extra::Deployer
+
+    # @see Nanoc::Extra::Deployer#run
+    def run
+      require 'fog'
+
+      # Get params
+      src      = File.expand_path(self.source_path)
+      bucket   = self.config.delete(:bucket) || self.config.delete(:bucket_name)
+      path     = self.config[:path]
+
+      self.config.delete(:kind)
+
+      # Validate params
+      error 'The path requires no trailing slash' if path && path[-1,1] == '/'
+
+      # Mock if necessary
+      if self.dry_run?
+        ::Fog.mock!
+      end
+
+      # Get connection
+      puts "Connecting"
+      connection = ::Fog::Storage.new(self.config)
+
+      # Get bucket
+      puts "Getting bucket"
+      begin
+        directory = connection.directories.get(bucket)
+      rescue ::Excon::Errors::NotFound
+        should_create_bucket = true
+      end
+      should_create_bucket = true if directory.nil?
+
+      # Create bucket if necessary
+      if should_create_bucket
+        directory = connection.directories.create(:key => bucket)
+      end
+
+      # Get list of remote files
+      files = directory.files
+      truncated = files.respond_to?(:is_truncated) && files.is_truncated
+      while truncated
+        set = directory.files.all(:marker => files.last.key)
+        truncated = set.is_truncated
+        files = files + set
+      end
+
+      # Delete all the files in the bucket
+      puts "Removing remote files"
+      files.all.each do |file|
+        file.destroy
+      end
+
+      # Upload all the files in the output folder to the clouds
+      puts "Uploading local files"
+      FileUtils.cd(src) do
+        files = Dir['**/*'].select { |f| File.file?(f) }
+        files.each do |file_path|
+          directory.files.create(
+            :key => "#{path}#{file_path}",
+            :body => File.open(file_path),
+            :public => true)
+        end
+      end
+
+      puts "Done!"
+    end
+
+  private
+
+    # Prints the given message on stderr and exits.
+    def error(msg)
+      raise RuntimeError.new(msg)
+    end
+
+  end
+
+end

data/lib/nanoc/extra/deployers/rsync.rb

@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+module Nanoc::Extra::Deployers
+
+  # A deployer that deploys a site using rsync.
+  #
+  # The configuration has should include a `:dst` value, a string containing
+  # the destination to where rsync should upload its data. It will likely be
+  # in `host:path` format. It should not end with a slash. For example,
+  # `"example.com:/var/www/sites/mysite/html"`.
+  #
+  # @example A deployment configuration with public and staging configurations
+  #
+  #   deploy:
+  #     public:
+  #       kind: rsync
+  #       dst: "ectype:sites/stoneship/public"
+  #     staging:
+  #       kind: rsync
+  #       dst: "ectype:sites/stoneship-staging/public"
+  #       options: [ "-glpPrtvz" ]
+  class Rsync < ::Nanoc::Extra::Deployer
+
+    # Default rsync options
+    DEFAULT_OPTIONS = [
+      '-glpPrtvz',
+      '--exclude=".hg"',
+      '--exclude=".svn"',
+      '--exclude=".git"'
+    ]
+
+    # @see Nanoc::Extra::Deployer#run
+    def run
+      require 'systemu'
+
+      # Get params
+      src = File.expand_path(self.source_path) + '/'
+      dst = self.config[:dst]
+      options = self.config[:options] || DEFAULT_OPTIONS
+
+      # Validate
+      error 'No dst found in deployment configuration' if dst.nil?
+      error 'dst requires no trailing slash' if dst[-1,1] == '/'
+
+      # Run
+      if dry_run
+        warn 'Performing a dry-run; no actions will actually be performed'
+        run_shell_cmd([ 'echo', 'rsync', options, src, dst ].flatten)
+      else
+        run_shell_cmd([ 'rsync', options, src, dst ].flatten)
+      end
+    end
+
+  private
+
+    # Prints the given message on stderr and exits.
+    def error(msg)
+      raise RuntimeError.new(msg)
+    end
+
+    # Runs the given shell command. It will raise an error if execution fails 
+    # (results in a nonzero exit code).
+    def run_shell_cmd(args)
+      status = systemu(args, 'stdout' => $stdout, 'stderr' => $stderr)
+      raise "command exited with a nonzero status code #{$?.exitstatus} (command: #{args.join(' ')})" if !status.success?
+    end
+
+  end
+
+end

data/lib/nanoc/extra/file_proxy.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Nanoc::Extra
+
+  # @deprecated Create a File instance directly and use that instead.
+  class FileProxy
+
+    instance_methods.each { |m| undef_method m unless m =~ /^__/ || m.to_s == 'object_id' }
+
+    @@deprecation_warning_shown = false
+
+    def initialize(path)
+      @path = path
+    end
+
+    def freeze
+    end
+
+    def respond_to?(meth)
+      file_instance_methods.include?(meth.to_sym)
+    end
+
+    def method_missing(sym, *args, &block)
+      if !@@deprecation_warning_shown
+        $stderr.puts 'WARNING: The :file attribute is deprecated and will be removed in a future version of nanoc. Instead of using this :file attribute, consider manually creating a File object when it’s needed, using the :content_filename, :meta_filename or :filename attributes.'
+        @@deprecation_warning_shown = true
+      end
+
+      File.open(@path, 'r') { |io| io.__send__(sym, *args, &block) }
+    end
+
+  private
+
+    def file_instance_methods
+      @@file_instance_methods ||= Set.new(File.instance_methods.map { |m| m.to_sym })
+    end
+
+  end
+
+end

data/lib/nanoc/extra/pruner.rb

@@ -0,0 +1,86 @@
+# encoding: utf-8
+
+module Nanoc::Extra
+
+  # Responsible for finding and deleting files in the site’s output directory
+  # that are not managed by nanoc.
+  class Pruner
+
+    # @return [Nanoc::Site] The site this pruner belongs to  
+    attr_reader :site
+
+    # @param [Nanoc::Site] The site for which a pruner is created
+    #
+    # @option params [Boolean] :dry_run (false) true if the files to be deleted
+    # should only be printed instead of actually deleted, false if the files
+    # should actually be deleted.
+    def initialize(site, params={})
+      @site    = site
+      @dry_run = params.fetch(:dry_run) { false }
+      @exclude = params.fetch(:exclude) { [] }
+    end
+
+    # Prunes all output files not managed by nanoc.
+    #
+    # @return [void]
+    def run
+      require 'find'
+
+      # Get compiled files
+      compiled_files = self.site.items.map do |item|
+        item.reps.map do |rep|
+          rep.raw_path
+        end
+      end.flatten.compact.select { |f| File.file?(f) }
+
+      # Get present files and dirs
+      present_files_and_dirs = Set.new
+      Find.find(self.site.config[:output_dir]) do |f|
+        present_files_and_dirs << f
+      end
+      present_files = present_files_and_dirs.select { |f| File.file?(f) }
+      present_dirs  = present_files_and_dirs.select { |f| File.directory?(f) }
+
+      # Remove stray files
+      stray_files = (present_files - compiled_files)
+      stray_files.each do |f|
+        next if filename_excluded?(f)
+        self.delete_file(f)
+      end
+
+      # Remove empty directories
+      present_dirs.sort_by{ |d| -d.length }.each do |dir|
+        next if Dir.foreach(dir) { |n| break true if n !~ /\A\.\.?\z/ }
+        next if filename_excluded?(dir)
+        self.delete_dir(dir)
+      end
+    end
+
+  protected
+
+    def filename_excluded?(f)
+      pathname = Pathname.new(f)
+      @exclude.any? { |e| pathname.include_component?(e) } 
+    end
+
+    def delete_file(file)
+      if @dry_run
+        puts file
+      else
+        Nanoc::CLI::Logger.instance.file(:high, :delete, file)
+        FileUtils.rm(file)
+      end
+    end
+
+    def delete_dir(dir)
+      if @dry_run
+        puts dir
+      else
+        Nanoc::CLI::Logger.instance.file(:high, :delete, dir)
+        Dir.rmdir(dir)
+      end
+    end
+
+  end
+
+end