nanoc 4.7.10 → 4.7.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b056ea57fc16e94cee44d842ac7cc9d4f801b604
-  data.tar.gz: 743593e44dee1341ff69b3f799d322dc9361b743
+  metadata.gz: 99eef92742ae4e7c6eec52f7efc9c456a44b72ca
+  data.tar.gz: 2d4f5da906f23c186cf965541a582175a91fe38f
 SHA512:
-  metadata.gz: a6cd971e349f5d80baf44bcfe405788f6da72f9d7864ff4da44e708b72dcb0616ae26e740553037447b46390182e6d740b4e11735c8eb2dca369bba7e139ccbe
-  data.tar.gz: 84f84414da253488dde8866209c827928da5502c79f1d80c2a0e0dfc8bca2dbe504ebae7adbbfb7430c7ff0bb1e008926fe4589a86f4d1b54ff227b8dc40481d
+  metadata.gz: 95a74693fa0cc09e0789bbaca9cc2c8f846f5936ae3e57f49ce8bba64721b970809438f200057aa3d7c8d3c520795015a19a7c220a462dfae6d0f7bbb048b8b8
+  data.tar.gz: d1bd24af79448f4e22250c95ce4ebc1a3fab8e9e827d24b130bc5c486154c8db099dace97e669903d9d7c8f8559d43134afcb1478875d177938fbecde08c46a6

data/.github/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+Contributing
+============
+
+Reporting bugs
+--------------
+
+If you find a bug in Nanoc, you should report it! Some information that you should include in your bug report is the Nanoc version (`nanoc --version`) and, if relevant, the crash log (`crash.log`). For details, check the [*bug reporting* section of the development guide](http://nanoc.ws/development/#reporting-bugs).
+
+Contributing code
+-----------------
+
+Pull requests are appreciated! When submitting a PR, make sure that your changes have covering tests, that the documentation remains up-to-date and that you retain backwards compatibility. For details, check the [*contributing code* section of the development guide](http://nanoc.ws/development/#contributing-code).
+
+Contributor code of conduct
+---------------------------
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone. For details, see the contributor code of conduct at http://nanoc.ws/contributing/#contributor-code-of-conduct.

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,23 @@
+(Summarise the bug in a single line.)
+
+### Steps to reproduce
+
+1. [First step]
+2. [Second step]
+3. …
+
+### Expected behavior
+
+(Describe what you expected to happen.)
+
+### Actual behavior
+
+(Describe what actually happened instead.)
+
+### Details
+
+(Describe other details, if any, that you believe might be relevant.)
+
+### Crash log
+
+(When reporting a crash, create a [Gist](https://gist.github.com/) with the contents of the `crash.log` file, and link the Gist here.)

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+(Summarise the change in a single line.)
+
+### Detailed description
+
+(Describe the change in detail.)
+
+### To do
+
+(Include the to-do list for this PR to be finished here.)
+
+* [ ] Tests
+* [ ] Documentation
+* [ ] Feature flags
+* [ ] …
+
+### Related issues
+
+(Add issue IDs for related issues here.)

data/.gitignore

@@ -0,0 +1,8 @@
+doc/yardoc
+.DS_Store
+*.gem
+/coverage/
+/.yardoc
+*~
+/Gemfile.lock
+*.gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+-r ./spec/spec_helper.rb
+--format Fuubar
+--color

data/.rubocop.yml

@@ -0,0 +1,174 @@
+# ----- CONFIGURED -----
+
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+
+# We use filenames such as “create-site.rb” that translate to method names.
+FileName:
+  Exclude:
+    - 'lib/nanoc/cli/commands/*.rb'
+    - 'Appraisals'
+
+# A common pattern in tests is to define anonymous classes in which methods are defined, which trips
+# up Rubocop’s nested method definition cop.
+Lint/NestedMethodDefinition:
+  Exclude:
+    - 'test/**/*.rb'
+    - 'spec/**/*.rb'
+
+# This is used in tests, to verify the effect of state-changing functions.
+Style/GlobalVars:
+  Exclude:
+    - 'test/**/*.rb'
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+
+# `rescue nil` is useful in specs where the exception is not important, but
+# the size effects are.
+Style/RescueModifier:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Layout/IndentArray:
+  EnforcedStyle: consistent
+
+Lint/DuplicateMethods:
+  Exclude:
+    - 'test/data_sources/test_filesystem.rb'
+    - 'spec/spec_helper.rb'
+
+# This needs to be fixed in Ruby 2.4.
+Lint/UnifiedInteger:
+  Enabled: false
+
+Layout/IndentHeredoc:
+  EnforcedStyle: squiggly
+
+# This breaks RSpec on occasion, e.g. `expect { subject }.not_to change { foo }`,
+# and generally does not provide useful warnings
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+# ----- TO ENABLE LATER -----
+
+# Valid cops, but fixing the offenses they report is non-trivial.
+
+RegexpLiteral:
+  Enabled: false
+
+ClassAndModuleChildren:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+
+
+# ----- DISABLED (hard) -----
+
+# Rubocop trips up on this.
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+
+
+# ----- DISABLED (security) -----
+
+# Nanoc runs offline in a trusted environment, and these security checks are false positives.
+
+Security/YAMLLoad:
+  Enabled: false
+
+Security/MarshalLoad:
+  Enabled: false
+
+Security/Eval:
+  Exclude:
+    - 'test/**/*.rb'
+    - 'spec/**/*.rb'
+    - 'lib/nanoc/base/entities/code_snippet.rb'
+    - 'lib/nanoc/filters/erubi.rb'
+
+
+# ----- DISABLED (metrics) -----
+
+# Cops for metrics are disabled because they should not cause tests to fail.
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+
+
+# ----- DISABLED (opinionated) -----
+
+# We should embrace UTF-8, not avoid it. Since the Encoding cop is enabled,
+# there’s no point in enforcing ASCII comments.
+AsciiComments:
+  Enabled: false
+
+# It does not make sense to enforce everything to have documentation.
+Documentation:
+  Enabled: false
+
+# Nanoc suppresses exceptions for valid reasons in a few cases.
+HandleExceptions:
+  Enabled: false
+
+# if/unless at the end of the line makes it too easy to oversee.
+IfUnlessModifier:
+  Enabled: false
+
+# Personal preference is to have decent constructors for exceptions rather than
+# just a class and a message.
+RaiseArgs:
+  Enabled: false
+
+# Personal preference is to use `raise` to signal exceptions (normal control
+# flow should not use exceptions anyway).
+SignalException:
+  Enabled: false
+
+# Some methods that appear to be accessors (return a single value or set a
+# single value) should still not be considered to be accessors. This is a purely
+# semantic difference.
+TrivialAccessors:
+  Enabled: false
+
+# This does not always semantically make sense.
+GuardClause:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+rvm:
+  - "2.3"
+  - "2.4"
+branches:
+  only:
+    - "master"
+env:
+  global:
+    -
+      LC_ALL=en_US.UTF_8
+      LANG=en_US.UTF_8
+matrix:
+  fast_finish: true
+  include:
+    - rvm: jruby-9.1.9.0
+      env: DISABLE_NOKOGIRI=1
+  allow_failures:
+    - rvm: jruby-9.1.9.0
+      env: DISABLE_NOKOGIRI=1
+script:
+  - bundle exec rake test_ci
+  - bundle exec appraisal install && FOCUS=rouge bundle exec appraisal rake spec
+cache: bundler
+sudo: false
+git:
+  depth: 10

data/Gemfile

@@ -21,7 +21,7 @@ group :devel do
   gem 'rspec'
   gem 'rspec-its', '~> 1.2'
   gem 'rspec-mocks'
-  gem 'rubocop', github: 'bbatsov/rubocop'
+  gem 'rubocop', '~> 0.49'
   gem 'simplecov', require: false
   gem 'timecop'
   gem 'vcr'
@@ -44,13 +44,14 @@ group :plugins do
   gem 'handlebars', platforms: :ruby
   gem 'kramdown'
   gem 'less', '~> 2.0', platforms: :ruby
+  gem 'libv8', platforms: :ruby
   gem 'listen'
   gem 'markaby'
   gem 'maruku'
   gem 'mime-types'
   gem 'mustache', '~> 1.0'
   gem 'nokogiri', '~> 1.6'
-  gem 'nokogumbo', '~> 1.4'
+  gem 'nokogumbo', '~> 1.4', platforms: :ruby
   gem 'pandoc-ruby'
   gem 'pygments.rb', '~> 1.1', '>= 1.1.1', platforms: %i[ruby mswin]
   gem 'rack'
@@ -62,7 +63,7 @@ group :plugins do
   gem 'rubypants'
   gem 'sass'
   gem 'slim', '~> 3.0'
-  gem 'therubyracer', '~> 0.12'
+  gem 'therubyracer', '~> 0.12', platforms: :ruby
   gem 'typogruby'
   gem 'uglifier'
   gem 'w3c_validators'

data/NEWS.md

@@ -1,5 +1,16 @@
 # Nanoc news
 
+## 4.7.11 (2017-06-17)
+
+Fixes:
+
+* Made the `external_links` check always use GET, not HEAD (#1178, #1179)
+* Fixed an issue where changing identifiers during preprocessing could cause a crash (#1184, #1185)
+
+Enhancements:
+
+* Added `--preprocess` to `shell` command, to load preprocessed site data (#1180)
+
 ## 4.7.10 (2017-05-14)
 
 Fixes:

data/Rakefile

@@ -10,11 +10,14 @@ RuboCop::RakeTask.new(:rubocop)
 Coveralls::RakeTask.new
 
 Rake::TestTask.new(:test_all) do |t|
-  t.test_files = Dir['test/**/*_spec.rb'] + Dir['test/**/test_*.rb']
+  t.test_files = Dir['test/**/test_*.rb']
   t.libs << 'test'
+  t.verbose = false
 end
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
 
 task test: %i[spec test_all rubocop]
 task test_ci: %i[test coveralls:push]

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

@@ -6,16 +6,18 @@ module Nanoc::Int
   class Dependency
     include Nanoc::Int::ContractsSupport
 
-    contract C::None => C::Maybe[C::Or[Nanoc::Int::Item, Nanoc::Int::Layout]]
+    C_OBJ = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout, Nanoc::Int::Configuration]
+
+    contract C::None => C::Maybe[C_OBJ]
     attr_reader :from
 
-    contract C::None => C::Maybe[C::Or[Nanoc::Int::Item, Nanoc::Int::Layout]]
+    contract C::None => C::Maybe[C_OBJ]
     attr_reader :to
 
     contract C::None => Nanoc::Int::Props
     attr_reader :props
 
-    contract C::Maybe[C::Or[Nanoc::Int::Item, Nanoc::Int::Layout]], C::Maybe[C::Or[Nanoc::Int::Item, Nanoc::Int::Layout]], Nanoc::Int::Props => C::Any
+    contract C::Maybe[C_OBJ], C::Maybe[C_OBJ], Nanoc::Int::Props => C::Any
     def initialize(from, to, props)
       @from  = from
       @to    = to

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

@@ -4,7 +4,7 @@ module Nanoc::Int
   # @api private
   class Layout < ::Nanoc::Int::Document
     def reference
-      [:layout, identifier]
+      [:layout, identifier.to_s]
     end
   end
 end

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

@@ -14,11 +14,17 @@ module Nanoc::Int
       @items = items
       @layouts = layouts
 
+      @refs2objs = {}
+      items.each   { |o| add_vertex_for(o) }
+      layouts.each { |o| add_vertex_for(o) }
+
       @new_objects = []
-      @graph = Nanoc::Int::DirectedGraph.new([nil] + @items.to_a + @layouts.to_a)
+      @graph = Nanoc::Int::DirectedGraph.new([nil] + objs2refs(@items) + objs2refs(@layouts))
     end
 
-    contract C::Or[Nanoc::Int::Item, Nanoc::Int::ItemRep, Nanoc::Int::Layout] => C::ArrayOf[Nanoc::Int::Dependency]
+    # FIXME: ItemRep?
+    C_OBJ = C::Or[Nanoc::Int::Item, Nanoc::Int::ItemRep, Nanoc::Int::Layout, Nanoc::Int::Configuration]
+    contract C_OBJ => C::ArrayOf[Nanoc::Int::Dependency]
     def dependencies_causing_outdatedness_of(object)
       objects_causing_outdatedness_of(object).map do |other_object|
         props = props_for(other_object, object)
@@ -36,6 +42,16 @@ module Nanoc::Int
       end
     end
 
+    def items=(items)
+      @items = items
+      items.each { |o| @refs2objs[obj2ref(o)] = o }
+    end
+
+    def layouts=(layouts)
+      @layouts = layouts
+      layouts.each { |o| @refs2objs[obj2ref(o)] = o }
+    end
+
     # Returns the direct dependencies for the given object.
     #
     # The direct dependencies of the given object include the items and
@@ -57,13 +73,12 @@ module Nanoc::Int
       if @new_objects.any?
         [@new_objects.first]
       else
-        @graph.direct_predecessors_of(object)
+        refs2objs(@graph.direct_predecessors_of(obj2ref(object)))
       end
     end
 
-    C_DOC = C::Or[Nanoc::Int::Item, Nanoc::Int::Layout]
     C_ATTR = C::Or[C::IterOf[Symbol], C::Bool]
-    contract C::Maybe[C_DOC], C::Maybe[C_DOC], C::KeywordArgs[raw_content: C::Optional[C::Bool], attributes: C::Optional[C_ATTR], compiled_content: C::Optional[C::Bool], path: C::Optional[C::Bool]] => C::Any
+    contract C::Maybe[C_OBJ], C::Maybe[C_OBJ], C::KeywordArgs[raw_content: C::Optional[C::Bool], attributes: C::Optional[C_ATTR], compiled_content: C::Optional[C::Bool], path: C::Optional[C::Bool]] => C::Any
     # Records a dependency from `src` to `dst` in the dependency graph. When
     # `dst` is oudated, `src` will also become outdated.
     #
@@ -76,11 +91,23 @@ module Nanoc::Int
     #
     # @return [void]
     def record_dependency(src, dst, raw_content: false, attributes: false, compiled_content: false, path: false)
-      existing_props = Nanoc::Int::Props.new(@graph.props_for(dst, src) || {})
+      # TODO: do src == dst check first (faster)
+
+      add_vertex_for(src)
+      add_vertex_for(dst)
+
+      src_ref = obj2ref(src)
+      dst_ref = obj2ref(dst)
+
+      existing_props = Nanoc::Int::Props.new(@graph.props_for(dst_ref, src_ref) || {})
       new_props = Nanoc::Int::Props.new(raw_content: raw_content, attributes: attributes, compiled_content: compiled_content, path: path)
       props = existing_props.merge(new_props)
 
-      @graph.add_edge(dst, src, props: props.to_h) unless src == dst
+      @graph.add_edge(dst_ref, src_ref, props: props.to_h) unless src == dst
+    end
+
+    def add_vertex_for(o)
+      @refs2objs[obj2ref(o)] = o
     end
 
     # Empties the list of dependencies for the given object. This is necessary
@@ -93,13 +120,33 @@ module Nanoc::Int
     #
     # @return [void]
     def forget_dependencies_for(object)
-      @graph.delete_edges_to(object)
+      @graph.delete_edges_to(obj2ref(object))
     end
 
     protected
 
+    def obj2ref(obj)
+      obj && obj.reference
+    end
+
+    def ref2obj(reference)
+      if reference
+        @refs2objs[reference]
+      else
+        nil
+      end
+    end
+
+    def objs2refs(objs)
+      objs.map { |o| obj2ref(o) }
+    end
+
+    def refs2objs(refs)
+      refs.map { |r| ref2obj(r) }
+    end
+
     def props_for(a, b)
-      props = @graph.props_for(a, b) || {}
+      props = @graph.props_for(obj2ref(a), obj2ref(b)) || {}
 
       if props.values.any? { |v| v }
         props
@@ -111,37 +158,26 @@ module Nanoc::Int
     def data
       {
         edges: @graph.edges,
-        vertices: @graph.vertices.map { |obj| obj && obj.reference },
+        vertices: @graph.vertices,
       }
     end
 
     def data=(new_data)
-      objects = @items.to_a + @layouts.to_a
+      objects = Set.new(@items.to_a + @layouts.to_a)
+      refs = objs2refs(objects)
 
       # Create new graph
-      @graph = Nanoc::Int::DirectedGraph.new([nil] + objects)
+      @graph = Nanoc::Int::DirectedGraph.new([nil] + refs)
 
       # Load vertices
-      previous_objects = new_data[:vertices].map do |reference|
-        if reference
-          case reference[0]
-          when :item
-            @items.object_with_identifier(reference[1])
-          when :layout
-            @layouts.object_with_identifier(reference[1])
-          else
-            raise Nanoc::Int::Errors::InternalInconsistency, "unrecognised reference #{reference[0].inspect}"
-          end
-        else
-          nil
-        end
-      end
+      previous_refs = new_data[:vertices]
+      previous_objects = Set.new(refs2objs(previous_refs))
 
       # Load edges
       new_data[:edges].each do |edge|
         from_index, to_index, props = *edge
-        from = from_index && previous_objects[from_index]
-        to   = to_index && previous_objects[to_index]
+        from = from_index && previous_refs[from_index]
+        to   = to_index && previous_refs[to_index]
         @graph.add_edge(from, to, props: props)
       end