nanoc 3.7.5 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 271aacd59754102c8bd997df253a98ca21f7fac3
-  data.tar.gz: 37db9384d0b9dbcbc80bb22714d856766fa9af42
+  metadata.gz: e62cf6c5f843fd4a0ed676cac0ce30d3cb8e45b9
+  data.tar.gz: c9cb11079a6a930f93e3e977e50b28db2d8bc5e9
 SHA512:
-  metadata.gz: 2b38d502d8dc8d17401312089add955515c7807e1b85bf7c9993fa68350cf9201b859eb305425fa69e2cb13b40d10d2ac2487150d0a3678f444883fb069e0ad0
-  data.tar.gz: a468ae8a49f2d3a025f0946aae7a58ee8e4328b3f188c5052e6d64a91751fb55c41077e64d025adff3bac3dfa40c886ca2a77a33f9baa7489249158808e52a09
+  metadata.gz: d5417fff2968fb9b1efbdc49095ebb4b2e0ff17cd1cdbfeb7a2e81ad059c0bdad3940bfeaa06956b9d07a923e2c2e4b50d4470851a07b5071b6f3409c3f124c2
+  data.tar.gz: cb15bed72ebe0b15babbee93386554fc2512fbd17c8ffce24a2224448a22ab8876d551a2ab550cdd396bbcfa84106405c1e87e7f7e6d1f2078fda4054a10cb36

data/ChangeLog

@@ -1,3 +1,3 @@
 For a list of all changes, please see the changelog on the project repository
-instead (http://projects.stoneship.org/hg/nanoc). For release notes, please
-see the NEWS file.
+instead (https://github.com/nanoc/nanoc). For release notes, please see the
+NEWS file.

data/Gemfile

@@ -21,7 +21,7 @@ gem 'listen'
 gem 'markaby'
 gem 'maruku'
 gem 'mime-types'
-gem 'minitest', '~> 4.0'
+gem 'minitest', '~> 5.0'
 gem 'mocha'
 if RUBY_VERSION >= '2.0.0'
   gem 'mustache', '~> 1.0'

data/NEWS.md

@@ -1,5 +1,26 @@
 # nanoc news
 
+## 3.8.0 (2015-05-04)
+
+Features:
+
+* Added `mixed_content` check (#542, #543) [Mike Pennisi]
+* Added `commands_dirs` configuration option for specifying directories to read commands from (#475) [Gregory Pakosz]
+* Added `:cdn_id` option to fog deployer for invalidating CDN objects (#451) [Vlatko Kosturjak]
+* Add access to regular expressions group matches in rules (#478) [Michal Papis]
+* Allow filtering the items array by regex (#458) [Mike Pennisi]
+
+Enhancements:
+
+* Added `:preserve_order` option to preserve order in Atom feed (#533, #534)
+* Allowed accessing `:pre` snapshot from within item itself (#537, #538, #548)
+
+Fixes:
+
+* Allowed passing generic Pandoc options with :args (#526, #535)
+* Fix crash when compiling extensionless binary items (#524, #525)
+* Fix double snapshot creation error (#547)
+
 ## 3.7.5 (2015-01-12)
 
 Enhancements:
@@ -631,7 +652,7 @@ Removed:
 New:
 
 * `--pages` and `--assets` compiler options
-* `--no-color` commandline option
+* `--no-color` command-line option
 * `Filtering` helper
 * `#relative_path_to` function in `LinkTo` helper
 * `rainpress` filter ([Rainpress site](http://code.google.com/p/rainpress/))
@@ -641,7 +662,7 @@ New:
 
 Changed:
 
-* The commandline option parser is now a lot more reliable
+* The command-line option parser is now a lot more reliable
 * `#atom_feed` now takes optional `:content_proc`, `:excerpt_proc` and `:articles` parameters
 * The compile command show non-written items (those with `skip_output: true`)
 * The compile command compiles everything by default
@@ -696,7 +717,7 @@ New:
 * New `rdiscount` filter ([RDiscount site](http://github.com/rtomayko/rdiscount))
 * New `maruku` filter ([Maruku site](https://github.com/bhollis/maruku/))
 * New `erubis` filter ([Erubis site](http://www.kuwata-lab.com/erubis/))
-* A better commandline frontend
+* A better command-line frontend
 * A new filesystem data source named `filesystem_combined`
 * Routers, which decide where compiled pages should be written to
 * Page/layout mtimes can now be retrieved through `page.mtime`/`layout.mtime`

data/README.md

@@ -2,7 +2,7 @@
 [![Build status](http://img.shields.io/travis/nanoc/nanoc.svg)](https://travis-ci.org/nanoc/nanoc)
 [![Code Climate](http://img.shields.io/codeclimate/github/nanoc/nanoc.svg)](https://codeclimate.com/github/nanoc/nanoc)
 [![Code Coverage](http://img.shields.io/coveralls/nanoc/nanoc.svg)](https://coveralls.io/r/nanoc/nanoc)
-[![Documentation Coverage](http://inch-pages.github.io/github/nanoc/nanoc.svg)](http://inch-pages.github.io/github/nanoc/nanoc/)
+[![Documentation Coverage](http://inch-ci.org/github/nanoc/nanoc.svg)](http://inch-ci.org/github/nanoc/nanoc/)
 
 ![nanoc logo](https://avatars1.githubusercontent.com/u/3260163?s=140)
 

data/bin/nanoc

@@ -12,7 +12,7 @@ begin
   end
 rescue LoadError
   # no problem
-end
+end if File.file?('Gemfile')
 
 # Add lib to load path
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))

data/lib/nanoc/base/compilation/dependency_tracker.rb

@@ -192,7 +192,7 @@ module Nanoc
       new_data[:edges].each do |edge|
         from_index, to_index = *edge
         from = from_index && previous_objects[from_index]
-        to   = to_index   && previous_objects[to_index]
+        to   = to_index && previous_objects[to_index]
         @graph.add_edge(from, to)
       end
 

data/lib/nanoc/base/compilation/item_rep_recorder_proxy.rb

@@ -70,7 +70,7 @@ module Nanoc
 
       # Count
       existing = Set.new
-      names = @rule_memory.select { |r| r[0] == :snapshot }.map { |r| r[2] }
+      names = @rule_memory.select { |r| r[0] == :snapshot }.map { |r| r[1] }
       names.each do |n|
         if existing.include?(n)
           raise Nanoc::Errors::CannotCreateMultipleSnapshotsWithSameName.new(@item_rep, snapshot_name)

data/lib/nanoc/base/compilation/rule.rb

@@ -65,7 +65,21 @@ module Nanoc
         raise ArgumentError, 'Required :compiler option is missing'
       end
       rep = Nanoc::ItemRepProxy.new(rep, compiler) unless rep.proxy?
-      Nanoc::RuleContext.new(rep: rep, compiler: compiler).instance_eval(&@block)
+      context = Nanoc::RuleContext.new(rep: rep, compiler: compiler)
+      context.instance_exec(matches(rep.item.identifier), &@block)
+    end
+
+    protected
+
+    # Matches the rule regexp against items identifier and gives back group
+    # captures if any
+    #
+    # @param [String] identifier Identifier to capture groups for
+    #
+    # @return [nil, Array] Captured groups, if any
+    def matches(identifier)
+      matches = @identifier_regex.match(identifier)
+      matches && matches.captures
     end
   end
 end

data/lib/nanoc/base/result_data/item_rep.rb

@@ -235,20 +235,29 @@ module Nanoc
       Nanoc::NotificationCenter.post(:visit_ended,   item)
 
       # Get name of last pre-layout snapshot
-      snapshot = params.fetch(:snapshot) { @content[:pre] ? :pre : :last }
-      is_moving = [:pre, :post, :last].include?(snapshot)
+      snapshot_name = params.fetch(:snapshot) { @content[:pre] ? :pre : :last }
+      is_moving = [:pre, :post, :last].include?(snapshot_name)
 
       # Check existance of snapshot
-      if !is_moving && snapshots.find { |s| s.first == snapshot && s.last == true }.nil?
-        raise Nanoc::Errors::NoSuchSnapshot.new(self, snapshot)
+      snapshot = snapshots.find { |s| s.first == snapshot_name }
+      if !is_moving && (snapshot.nil? || snapshot[-1] == false)
+        raise Nanoc::Errors::NoSuchSnapshot.new(self, snapshot_name)
       end
 
-      # Require compilation
-      if @content[snapshot].nil? || (!self.compiled? && is_moving)
+      # Verify snapshot is usable
+      is_still_moving =
+        case snapshot_name
+        when :post, :last
+          true
+        when :pre
+          snapshot.nil? || !snapshot[-1]
+        end
+      is_usable_snapshot = @content[snapshot_name] && (self.compiled? || !is_still_moving)
+      unless is_usable_snapshot
         raise Nanoc::Errors::UnmetDependency.new(self)
-      else
-        @content[snapshot]
       end
+
+      @content[snapshot_name]
     end
 
     # Checks whether content exists at a given snapshot.
@@ -416,8 +425,16 @@ module Nanoc
     #
     # @return [void]
     def snapshot(snapshot_name, params = {})
-      is_final = params.fetch(:final) { true }
-      @content[snapshot_name] = @content[:last] unless self.binary?
+      is_final = params.fetch(:final, true)
+
+      unless self.binary?
+        @content[snapshot_name] = @content[:last]
+      end
+
+      if snapshot_name == :pre && is_final
+        snapshots << [:pre, true]
+      end
+
       write(snapshot_name) if is_final
     end
 

data/lib/nanoc/base/source_data/item_array.rb

@@ -32,6 +32,8 @@ module Nanoc
     def [](*args)
       if 1 == args.size && args.first.is_a?(String)
         item_with_identifier(args.first)
+      elsif 1 == args.size && args.first.is_a?(Regexp)
+        @items.select { |i| i.identifier =~ args.first }
       else
         @items[*args]
       end

data/lib/nanoc/base/source_data/site.rb

@@ -32,6 +32,7 @@ module Nanoc
     DEFAULT_CONFIG = {
       text_extensions: %w( css erb haml htm html js less markdown md php rb sass scss txt xhtml xml coffee hb handlebars mustache ms slim ).sort,
       lib_dirs: %w( lib ),
+      commands_dirs: %w( commands ),
       output_dir: 'output',
       data_sources: [{}],
       index_filenames: ['index.html'],

data/lib/nanoc/cli.rb

@@ -47,9 +47,9 @@ module Nanoc::CLI
     @debug = boolean
   end
 
-  # Invokes the nanoc commandline tool with the given arguments.
+  # Invokes the nanoc command-line tool with the given arguments.
   #
-  # @param [Array<String>] args An array of commandline arguments
+  # @param [Array<String>] args An array of command-line arguments
   #
   # @return [void]
   def self.run(args)
@@ -59,7 +59,7 @@ module Nanoc::CLI
     end
   end
 
-  # @return [Cri::Command] The root command, i.e. the commandline tool itself
+  # @return [Cri::Command] The root command, i.e. the command-line tool itself
   def self.root_command
     @root_command
   end
@@ -83,7 +83,7 @@ module Nanoc::CLI
 
   protected
 
-  # Makes the commandline interface ready for use.
+  # Makes the command-line interface ready for use.
   #
   # @return [void]
   def self.setup
@@ -117,16 +117,25 @@ module Nanoc::CLI
     end
   end
 
-  # Loads site-specific commands in `commands/`.
+  # Loads site-specific commands.
   #
   # @return [void]
   def self.load_custom_commands
-    recursive_contents_of('commands').each do |filename|
+    if Nanoc::Site.cwd_is_nanoc_site?
+      site = Nanoc::Site.new('.')
+      site.config[:commands_dirs].each do |path|
+        load_commands_at(path)
+      end
+    end
+  end
+
+  def self.load_commands_at(path)
+    recursive_contents_of(path).each do |filename|
       # Create command
       command = Nanoc::CLI.load_command_at(filename)
 
       # Get supercommand
-      pieces = filename.gsub(/^commands\/|\.rb$/, '').split('/')
+      pieces = filename.gsub(/^#{path}\/|\.rb$/, '').split('/')
       pieces = pieces[0, pieces.size - 1] || []
       root = Nanoc::CLI.root_command
       supercommand = pieces.reduce(root) do |cmd, piece|

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

@@ -5,7 +5,7 @@ summary 'start the autocompiler'
 be_hidden
 aliases :aco
 description <<-EOS
-Start the autocompiler web server. Unless overridden with commandline options
+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.
 

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

@@ -4,7 +4,7 @@ usage 'create-site [options] path'
 aliases :create_site, :cs
 summary 'create a site'
 description "
-Create a new site at the given path. The site will use the `filesystem_unified` data source by default, but this can be changed using the `--datasource` commandline option.
+Create a new site at the given path. The site will use the `filesystem_unified` data source by default, but this can be changed using the `--datasource` command-line option.
 "
 
 required :d, :datasource, 'specify the data source for the new site'
@@ -130,7 +130,7 @@ route '*' do
     item.identifier.chop + '.css'
   elsif item.binary?
     # Write item with identifier /foo/ to /foo.ext
-    item.identifier.chop + '.' + item[:extension]
+    item.identifier.chop + (item[:extension] ? '.' + item[:extension] : '')
   else
     # Write item with identifier /foo/ to /foo/index.html
     item.identifier + 'index.html'

data/lib/nanoc/cli/commands/show-rules.rb

@@ -36,14 +36,12 @@ module Nanoc::CLI::Commands
           @calc[rep].each do |mem|
             puts format('    %s %s',
               @c.c(format('%-10s', mem[0].to_s), :blue),
-              mem[1..-1].map(&:inspect).join(', ')
-            )
+              mem[1..-1].map(&:inspect).join(', '))
           end
           if rep.raw_path
             puts format('    %s %s',
               @c.c(format('%-10s', 'write to'), :blue),
-              rep.raw_path
-            )
+              rep.raw_path)
           end
         end
       end
@@ -55,8 +53,7 @@ module Nanoc::CLI::Commands
       puts "  (from #{layout[:filename]})" if layout[:filename]
       puts format('  %s %s',
         @c.c(format('%-10s', 'filter'), :blue),
-        @calc[layout].map(&:inspect).join(', ')
-      )
+        @calc[layout].map(&:inspect).join(', '))
       puts
     end
   end

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

@@ -67,8 +67,8 @@ module Nanoc::CLI::Commands
       rebuilder.call(nil)
 
       # Get directories to watch
-      dirs_to_watch  = watcher_config[:dirs_to_watch]  || %w( content layouts lib )
-      files_to_watch = watcher_config[:files_to_watch] || %w( nanoc.yaml config.yaml Rules rules Rules.rb rules.rb )
+      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('|'))
 
@@ -95,7 +95,7 @@ module Nanoc::CLI::Commands
 
     # Allows sending user notifications in a cross-platform way.
     class Notifier
-      # A list of commandline tool names that can be used to send notifications
+      # 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

data/lib/nanoc/cli/error_handler.rb

@@ -283,7 +283,7 @@ module Nanoc::CLI
       if stack.empty?
         stream.puts '  (empty)'
       else
-        stack.reverse.each do |obj|
+        stack.reverse_each do |obj|
           if obj.is_a?(Nanoc::ItemRep)
             stream.puts "  - [item]   #{obj.item.identifier} (rep #{obj.name})"
           else # layout

data/lib/nanoc/cli/logger.rb

@@ -11,8 +11,8 @@ module Nanoc::CLI
     ACTION_COLORS = {
       create: "\e[32m", # green
       update: "\e[33m", # yellow
-      identical: '',       # (nothing)
-      skip: '',       # (nothing)
+      identical: '',    # (nothing)
+      skip: '',         # (nothing)
       delete: "\e[31m"  # red
     }
 
@@ -46,9 +46,7 @@ module Nanoc::CLI
           action,
           "\e[0m",
           duration.nil? ? '' : format('[%2.2fs]  ', duration),
-          name
-        )
-      )
+          name))
     end
 
     # Logs a message.

data/lib/nanoc/data_sources/filesystem.rb

@@ -119,7 +119,7 @@ module Nanoc::DataSources
         end
 
         # Get modification times
-        meta_mtime    = meta_filename    ? File.stat(meta_filename).mtime    : nil
+        meta_mtime = meta_filename ? File.stat(meta_filename).mtime : nil
         content_mtime = content_filename ? File.stat(content_filename).mtime : nil
         if meta_mtime && content_mtime
           mtime = meta_mtime > content_mtime ? meta_mtime : content_mtime
@@ -170,7 +170,7 @@ module Nanoc::DataSources
         end
 
         # Reorder elements and convert to extnames
-        filenames[0] = meta_filenames[0]    ? 'yaml'                                   : nil
+        filenames[0] = meta_filenames[0] ? 'yaml' : nil
         filenames[1] = content_filenames[0] ? ext_of(content_filenames[0])[1..-1] || '' : nil
       end
 

data/lib/nanoc/extra/auto_compiler.rb

@@ -65,7 +65,7 @@ module Nanoc::Extra
     rescue StandardError, ScriptError => e
       # Add compilation stack to env
       env['nanoc.stack'] = []
-      stack.reverse.each do |obj|
+      stack.reverse_each do |obj|
         if obj.is_a?(Nanoc::ItemRep) # item rep
           env['nanoc.stack'] << "[item] #{obj.item.identifier} (rep #{obj.name})"
         else # layout

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

@@ -6,6 +6,7 @@ module Nanoc::Extra::Checking::Checks
   autoload 'HTML',          'nanoc/extra/checking/checks/html'
   autoload 'InternalLinks', 'nanoc/extra/checking/checks/internal_links'
   autoload 'Stale',         'nanoc/extra/checking/checks/stale'
+  autoload 'MixedContent',  'nanoc/extra/checking/checks/mixed_content'
 
   Nanoc::Extra::Checking::Check.register '::Nanoc::Extra::Checking::Checks::CSS',           :css
   Nanoc::Extra::Checking::Check.register '::Nanoc::Extra::Checking::Checks::ExternalLinks', :external_links
@@ -14,4 +15,5 @@ module Nanoc::Extra::Checking::Checks
   Nanoc::Extra::Checking::Check.register '::Nanoc::Extra::Checking::Checks::InternalLinks', :internal_links
   Nanoc::Extra::Checking::Check.register '::Nanoc::Extra::Checking::Checks::InternalLinks', :ilinks
   Nanoc::Extra::Checking::Check.register '::Nanoc::Extra::Checking::Checks::Stale',         :stale
+  Nanoc::Extra::Checking::Check.register '::Nanoc::Extra::Checking::Checks::MixedContent',  :mixed_content
 end

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

@@ -0,0 +1,31 @@
+# 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.
+  class MixedContent < ::Nanoc::Extra::Checking::Check
+    PROTOCOL_PATTERN = /^(\w+):\/\//
+
+    def run
+      filenames = output_filenames.select { |f| File.extname(f) == '.html' }
+      resource_uris_with_filenames = ::Nanoc::Extra::LinkCollector.new(filenames).filenames_per_resource_uri
+
+      resource_uris_with_filenames.each_pair do |uri, fns|
+        next unless guaranteed_insecure?(uri)
+        fns.each do |filename|
+          add_issue(
+            "mixed content include: #{uri}",
+            subject: filename)
+        end
+      end
+    end
+
+    private
+
+    def guaranteed_insecure?(href)
+      protocol = PROTOCOL_PATTERN.match(href)
+
+      protocol && protocol[1].downcase == 'http'
+    end
+  end
+end