nanoc 4.0.0b4 → 4.0.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6a2272e514cd909fa601f4fea595a3827b82ae4
-  data.tar.gz: d2817ebcf5353f903262f858b7ce2b7dbcd995e6
+  metadata.gz: 43b1a732cd792777b84fed953191470f0147e4ec
+  data.tar.gz: d2ac5a5275b3486c88e94dd68e353d8ac19d50e2
 SHA512:
-  metadata.gz: bbaeae81947c39944044cb73ac30d7347c5a204ccfe70843f7796e7aa17d5def67be3fc1a77f65abca4f64ce704cf81dff123ced4c08e98f1b7e124841d96d63
-  data.tar.gz: e58c103c1bbf728768f349d286b1c299524513b20bff9a0621548b861eeba906b9cb4582a01f688ef6b8bc6318aefa7958166b58ba7db4187a8e8d61f9223745
+  metadata.gz: b6a63f720e046d3385085ff1b25ea062776389208d1c29936df3647c85dd59a8a65b4b107dad415ddaba25d859d9ec97c41f44d2a49921c6cf8114ee1aba7a97
+  data.tar.gz: ccf810ffe22680e674c52b06605ac20ed2851727aca8c149c12ac8988788aee6f174f318b7ab7822ecb00116104fc60169a3f3cc87c1c3616080d61803fd4ed6

data/Gemfile

@@ -12,7 +12,6 @@ gem 'compass'
 gem 'coffee-script'
 gem 'coveralls', require: false
 gem 'erubis'
-gem 'fakefs'
 gem 'fog'
 gem 'haml'
 gem 'handlebars', platforms: :ruby
@@ -42,9 +41,10 @@ gem 'redcarpet', platforms: [:ruby, :mswin]
 gem 'RedCloth'
 gem 'rouge'
 gem 'rspec'
-gem 'rubocop'
+gem 'rubocop', '~> 0.31.0'
 gem 'rubypants'
 gem 'sass', '~> 3.2.2'
+gem 'simplecov', require: false
 gem 'slim'
 gem 'typogruby'
 gem 'uglifier'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nanoc (4.0.0b4)
+    nanoc (4.0.0rc1)
       cri (~> 2.3)
 
 GEM
@@ -48,15 +48,14 @@ GEM
     erubis (2.7.0)
     excon (0.45.3)
     execjs (2.5.2)
-    fakefs (0.6.7)
     ffi (1.9.8)
     fission (0.5.0)
       CFPropertyList (~> 2.2)
-    fog (1.30.0)
+    fog (1.31.0)
       fog-atmos
       fog-aws (~> 0.0)
       fog-brightbox (~> 0.4)
-      fog-core (~> 1.27, >= 1.27.4)
+      fog-core (~> 1.30)
       fog-ecloud
       fog-google (>= 0.0.2)
       fog-json
@@ -78,7 +77,7 @@ GEM
     fog-atmos (0.1.0)
       fog-core
       fog-xml
-    fog-aws (0.4.0)
+    fog-aws (0.5.0)
       fog-core (~> 1.27)
       fog-json (~> 1.0)
       fog-xml (~> 0.1)
@@ -87,30 +86,30 @@ GEM
       fog-core (~> 1.22)
       fog-json
       inflecto (~> 0.0.2)
-    fog-core (1.30.0)
+    fog-core (1.31.1)
       builder
       excon (~> 0.45)
       formatador (~> 0.2)
       mime-types
       net-scp (~> 1.1)
       net-ssh (>= 2.1.3)
-    fog-ecloud (0.1.1)
+    fog-ecloud (0.1.3)
       fog-core
       fog-xml
     fog-google (0.0.5)
       fog-core
       fog-json
       fog-xml
-    fog-json (1.0.1)
+    fog-json (1.0.2)
       fog-core (~> 1.0)
-      multi_json (~> 1.0)
+      multi_json (~> 1.10)
     fog-local (0.2.1)
       fog-core (~> 1.27)
     fog-powerdns (0.1.1)
       fog-core (~> 1.27)
       fog-json (~> 1.0)
       fog-xml (~> 0.1)
-    fog-profitbricks (0.0.2)
+    fog-profitbricks (0.0.3)
       fog-core
       fog-xml
       nokogiri
@@ -159,12 +158,12 @@ GEM
       domain_name (~> 0.5)
     inflecto (0.0.2)
     ipaddress (0.8.0)
-    json (1.8.2)
+    json (1.8.3)
     kramdown (1.7.0)
     less (2.6.0)
       commonjs (~> 0.2.7)
     libv8 (3.16.14.7)
-    listen (2.10.0)
+    listen (2.10.1)
       celluloid (~> 0.16.0)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
@@ -178,7 +177,7 @@ GEM
     minitest (5.7.0)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    multi_json (1.11.0)
+    multi_json (1.11.1)
     mustache (1.0.1)
     net-scp (1.2.1)
       net-ssh (>= 2.6.5)
@@ -198,7 +197,7 @@ GEM
     pygments.rb (0.6.3)
       posix-spawn (~> 0.3.6)
       yajl-ruby (~> 1.2.0)
-    rack (1.6.1)
+    rack (1.6.4)
     rainbow (2.0.0)
     rainpress (1.0)
     rake (10.4.2)
@@ -207,26 +206,26 @@ GEM
       ffi (>= 0.5.0)
     rdiscount (2.1.8)
     rdoc (4.2.0)
-    redcarpet (3.2.3)
+    redcarpet (3.3.1)
     ref (1.0.5)
     rest-client (1.8.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
     rouge (1.9.0)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.3)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.1)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
     rubocop (0.31.0)
       astrolabe (~> 1.3)
       parser (>= 2.2.2.1, < 3.0)
@@ -242,12 +241,12 @@ GEM
       json (~> 1.8)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    slim (3.0.3)
+    slim (3.0.6)
       temple (~> 0.7.3)
       tilt (>= 1.3.3, < 2.1)
     slop (3.6.0)
-    temple (0.7.5)
-    term-ansicolor (1.3.0)
+    temple (0.7.6)
+    term-ansicolor (1.3.1)
       tins (~> 1.0)
     therubyracer (0.12.2)
       libv8 (~> 3.16.14.0)
@@ -290,7 +289,6 @@ DEPENDENCIES
   compass
   coveralls
   erubis
-  fakefs
   fog
   haml
   handlebars
@@ -316,9 +314,10 @@ DEPENDENCIES
   redcarpet
   rouge
   rspec
-  rubocop
+  rubocop (~> 0.31.0)
   rubypants
   sass (~> 3.2.2)
+  simplecov
   slim
   typogruby
   uglifier
@@ -329,4 +328,4 @@ DEPENDENCIES
   yuicompressor
 
 BUNDLED WITH
-   1.10.3
+   1.10.4

data/NEWS.md

@@ -1,5 +1,12 @@
 # nanoc news
 
+## 4.0.0rc1 (2015-06-21)
+
+Fixes:
+
+* Fixed double-wrapping of `@layout` in rendering helper (#631)
+* Fixed `show-rules` command (#633)
+
 ## 4.0.0b4 (2015-06-10)
 
 Fixes:

data/README.md

@@ -2,13 +2,12 @@
 [![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-ci.org/github/nanoc/nanoc.svg)](http://inch-ci.org/github/nanoc/nanoc/)
 
 ![nanoc logo](https://avatars1.githubusercontent.com/u/3260163?s=140)
 
 # nanoc
 
-nanoc is a flexible static site generator written in Ruby. See the [nanoc web site](http://nanoc.ws) for more information.
+nanoc is a flexible static-site generator written in Ruby. See the [nanoc web site](http://nanoc.ws) for more information.
 
 **Please take a moment and [donate](http://pledgie.com/campaigns/9282) to nanoc. A lot of time has gone into developing nanoc, and I would like to keep it going. Your support will ensure that nanoc will continue to improve.**
 

data/Rakefile

@@ -1,12 +1,3 @@
-# Set up env
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
-require './test/gem_loader.rb'
+Rake.add_rakelib 'tasks'
 
-# Load nanoc
-require 'nanoc'
-
-# Load tasks
-Dir.glob('tasks/**/*.rake').each { |r| Rake.application.add_import r }
-
-# Set default task
-task default: :test
+task default: [:test, :rubocop]

data/TODO.md

@@ -2,7 +2,6 @@
 
 ## Ideas
 
-* snapshots [name, array] is weird
 * binary snapshots could be possible
 * binary layotus could be possible
 

data/bin/nanoc

@@ -2,4 +2,8 @@
 require 'nanoc'
 require 'nanoc/cli'
 
+if File.file?('Gemfile') && !defined?(Bundler)
+  warn 'A Gemfile was detected, but Bundler is not loaded. This is probably not what you want. To run nanoc with Bundler, use `bundle exec nanoc`.'
+end
+
 Nanoc::CLI.run(ARGV)

data/lib/nanoc/base/checksummer.rb

@@ -66,7 +66,7 @@ module Nanoc::Int
             update(el, digest, visited + [obj])
             digest.update(',')
           end
-        when ::Hash
+        when ::Hash, ::Nanoc::Int::Configuration
           obj.each do |key, value|
             update(key, digest, visited + [obj])
             digest.update('=')

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

@@ -110,13 +110,10 @@ module Nanoc::Int
       return if @loaded || @loading
       @loading = true
 
-      # Load site if necessary
-      site.load
-
       # Preprocess
       rules_collection.load
       preprocess
-      site.setup_child_parent_links
+      Nanoc::Int::SiteLoader.new.setup_child_parent_links(site.items)
       build_reps
       route_reps
 
@@ -143,11 +140,8 @@ module Nanoc::Int
       @stack = []
 
       items.each { |item| item.reps.clear }
-      site.teardown_child_parent_links
       rules_collection.unload
 
-      site.unload
-
       @loaded = false
       @unloading = false
     end
@@ -260,9 +254,9 @@ module Nanoc::Int
     # @api private
     def assigns_for(rep)
       if rep.binary?
-        content_or_filename_assigns = { filename: rep.content_snapshots[:last].filename }
+        content_or_filename_assigns = { filename: rep.snapshot_contents[:last].filename }
       else
-        content_or_filename_assigns = { content: rep.content_snapshots[:last].string }
+        content_or_filename_assigns = { content: rep.snapshot_contents[:last].string }
       end
 
       # TODO: Do not expose @site (necessary for captures store though…)
@@ -320,7 +314,7 @@ module Nanoc::Int
 
       # Assign snapshots
       reps.each do |rep|
-        rep.snapshots = rules_collection.snapshots_for(rep)
+        rep.snapshot_defs = rules_collection.snapshots_defs_for(rep)
       end
 
       # Attempt to compile all active reps
@@ -373,7 +367,7 @@ module Nanoc::Int
       if !rep.item.forced_outdated? && !outdatedness_checker.outdated?(rep) && compiled_content_cache[rep]
         # Reuse content
         Nanoc::Int::NotificationCenter.post(:cached_content_used, rep)
-        rep.content_snapshots = compiled_content_cache[rep]
+        rep.snapshot_contents = compiled_content_cache[rep]
       else
         # Recalculate content
         executor.snapshot(rep, :raw)
@@ -384,7 +378,7 @@ module Nanoc::Int
       end
 
       rep.compiled = true
-      compiled_content_cache[rep] = rep.content_snapshots
+      compiled_content_cache[rep] = rep.snapshot_contents
 
       Nanoc::Int::NotificationCenter.post(:processing_ended,  rep)
       Nanoc::Int::NotificationCenter.post(:compilation_ended, rep)
@@ -451,7 +445,7 @@ module Nanoc::Int
         checksum_store,
         compiled_content_cache,
         dependency_tracker,
-        rule_memory_store
+        rule_memory_store,
       ]
     end
   end

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

@@ -159,7 +159,7 @@ module Nanoc::Int
     def data
       {
         edges: @graph.edges,
-        vertices: @graph.vertices.map { |obj| obj && obj.reference }
+        vertices: @graph.vertices.map { |obj| obj && obj.reference },
       }
     end
 

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

@@ -13,6 +13,8 @@ module Nanoc::Int
     # @since 3.2.0
     attr_reader :snapshot_name
 
+    attr_reader :pattern
+
     # Creates a new item compilation rule with the given identifier regex,
     # compiler and block. The block will be called during compilation with the
     # item rep as its argument.

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

@@ -217,9 +217,9 @@ module Nanoc::Int
     # @return [Array] A list of snapshots, represented as arrays where the
     #   first element is the snapshot name (a Symbol) and the last element is
     #   a Boolean indicating whether the snapshot is final or not
-    def snapshots_for(rep)
+    def snapshots_defs_for(rep)
       new_rule_memory_for_rep(rep).select { |e| e[0] == :snapshot }.map do |e|
-        [e[1], e[2].fetch(:final) { true }]
+        Nanoc::Int::SnapshotDef.new(e[1], e[2].fetch(:final, true))
       end
     end
 

data/lib/nanoc/base/entities/identifier.rb

@@ -2,6 +2,41 @@ module Nanoc
   class Identifier
     include Comparable
 
+    # @api private
+    class InvalidIdentifierError < ::Nanoc::Error
+      def initialize(string)
+        super("Invalid identifier (does not start with a slash): #{string.inspect}")
+      end
+    end
+
+    # @api private
+    class InvalidTypeError < ::Nanoc::Error
+      def initialize(type)
+        super("Invalid type for identifier: #{type.inspect} (can be :full or :legacy)")
+      end
+    end
+
+    # @api private
+    class InvalidPrefixError < ::Nanoc::Error
+      def initialize(string)
+        super("Invalid prefix (does not start with a slash): #{string.inspect}")
+      end
+    end
+
+    # @api private
+    class UnsupportedLegacyOperationError < ::Nanoc::Error
+      def initialize
+        super('Cannot use this method on legacy identifiers')
+      end
+    end
+
+    # @api private
+    class NonCoercibleObjectError < ::Nanoc::Error
+      def initialize(obj)
+        super("#{obj.inspect} cannot be converted into a Nanoc::Identifier")
+      end
+    end
+
     def self.from(obj)
       case obj
       when Nanoc::Identifier
@@ -9,7 +44,7 @@ module Nanoc
       when String
         Nanoc::Identifier.new(obj)
       else
-        raise ArgumentError, "Do not know how to convert #{obj} into a Nanoc::Identifier"
+        raise NonCoercibleObjectError.new(obj)
       end
     end
 
@@ -21,13 +56,11 @@ module Nanoc
         @string = "/#{string}/".gsub(/^\/+|\/+$/, '/').freeze
       when :full
         if string !~ /\A\//
-          raise Nanoc::Int::Errors::Generic,
-            "Invalid identifier (does not start with a slash): #{string.inspect}"
+          raise InvalidIdentifierError.new(string)
         end
         @string = string.dup.freeze
       else
-        raise Nanoc::Int::Errors::Generic,
-          "Invalid :type param for identifier: #{@type.inspect}"
+        raise InvalidTypeError.new(@type)
       end
     end
 
@@ -40,8 +73,8 @@ module Nanoc
       self.class.hash ^ to_s.hash
     end
 
-    def =~(pat)
-      Nanoc::Int::Pattern.from(pat).match?(to_s) ? 0 : nil
+    def =~(other)
+      Nanoc::Int::Pattern.from(other).match?(to_s) ? 0 : nil
     end
 
     def <=>(other)
@@ -60,15 +93,14 @@ module Nanoc
     end
 
     # @return [String]
-    def +(string)
-      to_s + string
+    def +(other)
+      to_s + other
     end
 
     # @return [Nanoc::Identifier]
     def prefix(string)
       if string !~ /\A\//
-        raise Nanoc::Int::Errors::Generic,
-          "Invalid prefix (does not start with a slash): #{@string.inspect}"
+        raise InvalidPrefixError.new(@string)
       end
       Nanoc::Identifier.new(string.sub(/\/+\z/, '') + @string, type: @type)
     end
@@ -76,8 +108,7 @@ module Nanoc
     # @return [String]
     def with_ext(ext)
       unless full?
-        raise Nanoc::Int::Errors::Generic,
-          'Cannot use #with_ext on identifier that does not include the file extension'
+        raise UnsupportedLegacyOperationError
       end
 
       # Strip extension, if any
@@ -109,8 +140,7 @@ module Nanoc
     # @return [String] The extension, without a leading dot.
     def ext
       unless full?
-        raise Nanoc::Int::Errors::Generic,
-          'Cannot use #ext on identifier that does not include the file extension'
+        raise UnsupportedLegacyOperationError
       end
 
       s = File.extname(@string)

data/lib/nanoc/base/entities/pattern.rb

@@ -41,6 +41,10 @@ module Nanoc::Int
     def captures(_identifier)
       nil
     end
+
+    def to_s
+      @string
+    end
   end
 
   # @api private
@@ -57,5 +61,9 @@ module Nanoc::Int
       matches = @regexp.match(identifier.to_s)
       matches && matches.captures
     end
+
+    def to_s
+      @regexp.to_s
+    end
   end
 end

data/lib/nanoc/base/entities/snapshot_def.rb

@@ -0,0 +1,16 @@
+module Nanoc
+  module Int
+    class SnapshotDef
+      attr_reader :name
+
+      def initialize(name, is_final)
+        @name = name
+        @is_final = is_final
+      end
+
+      def final?
+        @is_final
+      end
+    end
+  end
+end

data/lib/nanoc/base/entities.rb

@@ -3,3 +3,4 @@ require_relative 'entities/document'
 require_relative 'entities/identifier'
 require_relative 'entities/layout'
 require_relative 'entities/pattern'
+require_relative 'entities/snapshot_def'

data/lib/nanoc/base/plugin_registry.rb

@@ -183,7 +183,7 @@ module Nanoc::Int
             plugins << {
               class: klass,
               superclass: superclass,
-              identifiers: [identifier]
+              identifiers: [identifier],
             }
           end
         end

data/lib/nanoc/base/repos/config_loader.rb

@@ -0,0 +1,67 @@
+module Nanoc::Int
+  # @api private
+  class ConfigLoader
+    class NoConfigFileFoundError < ::Nanoc::Error
+      def initialize
+        super('No configuration file found')
+      end
+    end
+
+    class NoParentConfigFileFoundError < ::Nanoc::Error
+      def initialize(filename)
+        super("There is no parent configuration file at #{filename}")
+      end
+    end
+
+    class CyclicalConfigFileError < ::Nanoc::Error
+      def initialize(filename)
+        super("The parent configuration file at #{filename} includes one of its descendants")
+      end
+    end
+
+    # @return [Boolean]
+    def self.cwd_is_nanoc_site?
+      !config_filename_for_cwd.nil?
+    end
+
+    # @return [String]
+    def self.config_filename_for_cwd
+      filenames = %w( nanoc.yaml config.yaml )
+      candidate = filenames.find { |f| File.file?(f) }
+      candidate && File.expand_path(candidate)
+    end
+
+    def new_from_cwd
+      # Determine path
+      filename = self.class.config_filename_for_cwd
+      raise NoConfigFileFoundError if filename.nil?
+
+      # Read
+      apply_parent_config(
+        Nanoc::Int::Configuration.new(YAML.load_file(filename)),
+        [filename]).with_defaults
+    end
+
+    # @api private
+    def apply_parent_config(config, processed_paths = [])
+      parent_path = config[:parent_config_file]
+      return config if parent_path.nil?
+
+      # Get absolute path
+      parent_path = File.absolute_path(parent_path, File.dirname(processed_paths.last))
+      unless File.file?(parent_path)
+        raise NoParentConfigFileFoundError.new(parent_path)
+      end
+
+      # Check recursion
+      if processed_paths.include?(parent_path)
+        raise CyclicalConfigFileError.new(parent_path)
+      end
+
+      # Load
+      parent_config = Nanoc::Int::Configuration.new(YAML.load_file(parent_path))
+      full_parent_config = apply_parent_config(parent_config, processed_paths + [parent_path])
+      full_parent_config.merge(config.without(:parent_config_file))
+    end
+  end
+end