nanoc 4.0.0b2 → 4.0.0b3

data/lib/nanoc/data_sources/filesystem_unified.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::DataSources
   # The filesystem_unified data source stores its items and layouts in nested
   # directories. Items and layouts are represented by one or two files; if it

data/lib/nanoc/extra.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # @api private
 module Nanoc::Extra
   autoload 'Checking',            'nanoc/extra/checking'

data/lib/nanoc/extra/checking.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra
   # @api private
   module Checking

data/lib/nanoc/extra/checking/check.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra::Checking
   # @api private
   class OutputDirNotFoundError < Nanoc::Int::Errors::Generic
@@ -9,14 +7,32 @@ module Nanoc::Extra::Checking
   end
 
   # @api private
-  class Check
+  class Check < Nanoc::Int::Context
     extend Nanoc::Int::PluginRegistry::PluginMethods
 
-    attr_reader :site
     attr_reader :issues
 
-    def initialize(site)
-      @site   = site
+    def self.create(site)
+      output_dir = site.config[:output_dir]
+      unless File.exist?(output_dir)
+        raise Nanoc::Extra::Checking::OutputDirNotFoundError.new(output_dir)
+      end
+      output_filenames = Dir[output_dir + '/**/*'].select { |f| File.file?(f) }
+
+      context = {
+        items: Nanoc::ItemCollectionView.new(site.items),
+        layouts: Nanoc::LayoutCollectionView.new(site.layouts),
+        config: Nanoc::ConfigView.new(site.config),
+        site: Nanoc::SiteView.new(site), # TODO: remove me
+        output_filenames: output_filenames,
+      }
+
+      new(context)
+    end
+
+    def initialize(context)
+      super(context)
+
       @issues = Set.new
     end
 
@@ -25,17 +41,9 @@ module Nanoc::Extra::Checking
     end
 
     def add_issue(desc, params = {})
-      subject  = params.fetch(:subject, nil)
+      subject = params.fetch(:subject, nil)
 
       @issues << Issue.new(desc, subject, self.class)
     end
-
-    def output_filenames
-      output_dir = @site.config[:output_dir]
-      unless File.exist?(output_dir)
-        raise Nanoc::Extra::Checking::OutputDirNotFoundError.new(output_dir)
-      end
-      Dir[output_dir + '/**/*'].select { |f| File.file?(f) }
-    end
   end
 end

data/lib/nanoc/extra/checking/checks.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # @api private
 module Nanoc::Extra::Checking::Checks
   autoload 'CSS',           'nanoc/extra/checking/checks/css'

data/lib/nanoc/extra/checking/checks/css.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module ::Nanoc::Extra::Checking::Checks
   # @api private
   class CSS < ::Nanoc::Extra::Checking::Check
@@ -8,7 +6,7 @@ module ::Nanoc::Extra::Checking::Checks
     def run
       require 'w3c_validators'
 
-      Dir[site.config[:output_dir] + '/**/*.css'].each do |filename|
+      Dir[@config[:output_dir] + '/**/*.css'].each do |filename|
         results = ::W3CValidators::CSSValidator.new.validate_file(filename)
         lines = File.readlines(filename)
         results.errors.each do |e|

data/lib/nanoc/extra/checking/checks/external_links.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'net/http'
 require 'net/https'
 require 'nokogiri'

data/lib/nanoc/extra/checking/checks/html.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module ::Nanoc::Extra::Checking::Checks
   # @api private
   class HTML < ::Nanoc::Extra::Checking::Check
@@ -8,7 +6,7 @@ module ::Nanoc::Extra::Checking::Checks
     def run
       require 'w3c_validators'
 
-      Dir[site.config[:output_dir] + '/**/*.{htm,html}'].each do |filename|
+      Dir[@config[:output_dir] + '/**/*.{htm,html}'].each do |filename|
         results = ::W3CValidators::MarkupValidator.new.validate_file(filename)
         lines = File.readlines(filename)
         results.errors.each do |e|

data/lib/nanoc/extra/checking/checks/internal_links.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'uri'
 
 module Nanoc::Extra::Checking::Checks
@@ -51,7 +49,7 @@ module Nanoc::Extra::Checking::Checks
 
       # Make absolute
       if path[0, 1] == '/'
-        path = @site.config[:output_dir] + path
+        path = @config[:output_dir] + path
       else
         path = ::File.expand_path(path, ::File.dirname(origin))
       end
@@ -60,14 +58,14 @@ module Nanoc::Extra::Checking::Checks
       return true if File.file?(path)
 
       # Check whether directory with index file exists
-      return true if File.directory?(path) && @site.config[:index_filenames].any? { |fn| File.file?(File.join(path, fn)) }
+      return true if File.directory?(path) && @config[:index_filenames].any? { |fn| File.file?(File.join(path, fn)) }
 
       # Nope :(
       false
     end
 
     def excluded?(href)
-      excludes =  @site.config.fetch(:checks, {}).fetch(:internal_links, {}).fetch(:exclude, [])
+      excludes =  @config.fetch(:checks, {}).fetch(:internal_links, {}).fetch(:exclude, [])
       excludes.any? { |pattern| Regexp.new(pattern).match(href) }
     end
   end

data/lib/nanoc/extra/checking/checks/mixed_content.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra::Checking::Checks
   # A check that verifies HTML files do not reference external resources with
   # URLs that would trigger "mixed content" warnings.

data/lib/nanoc/extra/checking/checks/stale.rb

@@ -1,12 +1,10 @@
-# encoding: utf-8
-
 module Nanoc::Extra::Checking::Checks
   # @api private
   class Stale < ::Nanoc::Extra::Checking::Check
     def run
       require 'set'
 
-      item_rep_paths = Set.new(@site.items.map(&:reps).flatten.map(&:raw_path))
+      item_rep_paths = Set.new(@items.map(&:reps).flatten.map(&:raw_path))
 
       output_filenames.each do |f|
         next if pruner.filename_excluded?(f)
@@ -21,7 +19,7 @@ module Nanoc::Extra::Checking::Checks
     protected
 
     def pruner
-      exclude_config = @site.config.fetch(:prune, {}).fetch(:exclude, [])
+      exclude_config = @config.fetch(:prune, {}).fetch(:exclude, [])
       @pruner ||= Nanoc::Extra::Pruner.new(@site, exclude: exclude_config)
     end
   end

data/lib/nanoc/extra/checking/dsl.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra::Checking
   # @api private
   class DSL

data/lib/nanoc/extra/checking/issue.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra::Checking
   # @api private
   class Issue

data/lib/nanoc/extra/checking/runner.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra::Checking
   # Runner is reponsible for running issue checks.
   #
@@ -116,7 +114,7 @@ module Nanoc::Extra::Checking
       classes.each do |klass|
         print format("  %-#{length}s", "Running check #{klass.identifier}… ")
 
-        check = klass.new(@site)
+        check = klass.create(@site)
         check.run
 
         checks << check

data/lib/nanoc/extra/core_ext.rb

@@ -1,4 +1,2 @@
-# encoding: utf-8
-
 require 'nanoc/extra/core_ext/pathname'
 require 'nanoc/extra/core_ext/time'

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra
   # @api private
   module PathnameExtensions

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # @api private
 module Nanoc::Extra::TimeExtensions
   # @return [String] The time in an ISO-8601 date format.

data/lib/nanoc/extra/deployer.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra
   # Represents a deployer, an object that allows uploading the compiled site
   # to a specific (remote) location.

data/lib/nanoc/extra/deployers.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra
   # @api private
   module Deployers

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra::Deployers
   # A deployer that deploys a site using [fog](https://github.com/geemus/fog).
   #
@@ -73,6 +71,7 @@ module Nanoc::Extra::Deployers
       end
       keys_to_destroy = files.all.map(&:key)
       keys_to_invalidate = []
+      etags = read_etags(files)
 
       # Upload all the files in the output folder to the clouds
       puts 'Uploading local files'
@@ -80,12 +79,7 @@ module Nanoc::Extra::Deployers
         files = Dir['**/*'].select { |f| File.file?(f) }
         files.each do |file_path|
           key = path ? File.join(path, file_path) : file_path
-          directory.files.create(
-            key: key,
-            body: File.open(file_path),
-            public: true)
-          keys_to_destroy.delete(key)
-          keys_to_invalidate.push(key)
+          upload(key, file_path, etags, keys_to_destroy, keys_to_invalidate, directory)
         end
       end
 
@@ -115,6 +109,44 @@ module Nanoc::Extra::Deployers
 
     private
 
+    def upload(key, file_path, etags, keys_to_destroy, keys_to_invalidate, dir)
+      keys_to_destroy.delete(key)
+
+      return unless needs_upload?(key, file_path, etags)
+
+      dir.files.create(
+        key: key,
+        body: File.open(file_path),
+        public: true)
+      keys_to_invalidate.push(key)
+    end
+
+    def needs_upload?(key, file_path, etags)
+      remote_etag = etags[key]
+      return true if remote_etag.nil?
+
+      local_etag = calc_local_etag(file_path)
+      remote_etag != local_etag
+    end
+
+    def read_etags(files)
+      case config[:provider]
+      when 'aws'
+        files.each_with_object({}) do |file, etags|
+          etags[file.key] = file.etag
+        end
+      else
+        {}
+      end
+    end
+
+    def calc_local_etag(file_path)
+      case config[:provider]
+      when 'aws'
+        Digest::MD5.file(file_path).hexdigest
+      end
+    end
+
     # Prints the given message on stderr and exits.
     def error(msg)
       raise RuntimeError.new(msg)

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra::Deployers
   # A deployer that deploys a site using rsync.
   #

data/lib/nanoc/extra/filesystem_tools.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra
   # Contains useful functions for managing the filesystem.
   #

data/lib/nanoc/extra/jruby_nokogiri_warner.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'singleton'
 
 module Nanoc::Extra

data/lib/nanoc/extra/link_collector.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'set'
 
 module ::Nanoc::Extra

data/lib/nanoc/extra/piper.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'open3'
 
 module Nanoc::Extra

data/lib/nanoc/extra/pruner.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Extra
   # Responsible for finding and deleting files in the site’s output directory
   # that are not managed by nanoc.

data/lib/nanoc/filters.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # @api private
 module Nanoc::Filters
   autoload 'AsciiDoc',        'nanoc/filters/asciidoc'

data/lib/nanoc/filters/asciidoc.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @since 3.2.0
   #

data/lib/nanoc/filters/bluecloth.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @api private
   class BlueCloth < Nanoc::Filter

data/lib/nanoc/filters/coffeescript.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @since 3.3.0
   #

data/lib/nanoc/filters/colorize_syntax.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @api private
   class ColorizeSyntax < Nanoc::Filter

data/lib/nanoc/filters/erb.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @api private
   class ERB < Nanoc::Filter

data/lib/nanoc/filters/erubis.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @api private
   class Erubis < Nanoc::Filter

data/lib/nanoc/filters/haml.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @api private
   class Haml < Nanoc::Filter

data/lib/nanoc/filters/handlebars.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @since 3.4.0
   #

data/lib/nanoc/filters/kramdown.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @api private
   class Kramdown < Nanoc::Filter

data/lib/nanoc/filters/less.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @api private
   class Less < Nanoc::Filter

data/lib/nanoc/filters/markaby.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Nanoc::Filters
   # @api private
   class Markaby < Nanoc::Filter