nanoc 3.7.4 → 3.7.5

data/lib/nanoc/helpers/breadcrumbs.rb

@@ -1,11 +1,9 @@
 # encoding: utf-8
 
 module Nanoc::Helpers
-
   # Provides support for breadcrumbs, which allow the user to go up in the
   # page hierarchy.
   module Breadcrumbs
-
     # Creates a breadcrumb trail leading from the current item to its parent,
     # to its parent’s parent, etc, until the root item is reached. This
     # function does not require that each intermediate item exist; for
@@ -29,7 +27,5 @@ module Nanoc::Helpers
 
       trail
     end
-
   end
-
 end

data/lib/nanoc/helpers/capturing.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::Helpers
-
   # Provides functionality for “capturing” content in one place and reusing
   # this content elsewhere.
   #
@@ -35,10 +34,8 @@ module Nanoc::Helpers
   #     <%= @item[:content_for_summary] || '(no summary)' %>
   #   </div>
   module Capturing
-
     # @api private
     class CapturesStore
-
       def initialize
         @store = {}
       end
@@ -52,11 +49,9 @@ module Nanoc::Helpers
         @store[item.identifier] ||= {}
         @store[item.identifier][name]
       end
-
     end
 
     class ::Nanoc::Site
-
       # @api private
       def captures_store
         @captures_store ||= CapturesStore.new
@@ -67,7 +62,6 @@ module Nanoc::Helpers
         require 'set'
         @captures_store_compiled_items ||= Set.new
       end
-
     end
 
     # @overload content_for(name, &block)
@@ -127,13 +121,13 @@ module Nanoc::Helpers
           # This is an extremely ugly hack to get the compiler to recompile the
           # item from which we use content. For this, we need to manually edit
           # the content attribute to reset it. :(
-          # FIXME clean this up
+          # FIXME: clean this up
           unless @site.captures_store_compiled_items.include? item
             @site.captures_store_compiled_items << item
             item.forced_outdated = true
             item.reps.each do |r|
               raw_content = item.raw_content
-              r.content = { :raw => raw_content, :last => raw_content }
+              r.content = { raw: raw_content, last: raw_content }
               raise Nanoc::Errors::UnmetDependency.new(r)
             end
           end
@@ -169,7 +163,5 @@ module Nanoc::Helpers
       # Done.
       erbout_addition
     end
-
   end
-
 end

data/lib/nanoc/helpers/filtering.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::Helpers
-
   # Provides functionality for filtering parts of an item or a layout.
   module Filtering
-
     require 'nanoc/helpers/capturing'
     include Nanoc::Helpers::Capturing
 
@@ -46,7 +44,5 @@ module Nanoc::Helpers
       buffer = eval('_erbout', block.binding)
       buffer << filtered_data
     end
-
   end
-
 end

data/lib/nanoc/helpers/html_escape.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::Helpers
-
   # Contains functionality for HTML-escaping strings.
   module HTMLEscape
-
     require 'nanoc/helpers/capturing'
     include Nanoc::Helpers::Capturing
 
@@ -39,9 +37,9 @@ module Nanoc::Helpers
         buffer << escaped_data
       elsif string
         string.gsub('&', '&amp;')
-               .gsub('<', '&lt;')
-               .gsub('>', '&gt;')
-               .gsub('"', '&quot;')
+          .gsub('<', '&lt;')
+          .gsub('>', '&gt;')
+          .gsub('"', '&quot;')
       else
         raise 'The #html_escape or #h function needs either a ' \
           'string or a block to HTML-escape, but neither a string nor a block was given'
@@ -49,7 +47,5 @@ module Nanoc::Helpers
     end
 
     alias_method :h, :html_escape
-
   end
-
 end

data/lib/nanoc/helpers/link_to.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::Helpers
-
   # Contains functions for linking to items and item representations.
   module LinkTo
-
     require 'nanoc/helpers/html_escape'
     include Nanoc::Helpers::HTMLEscape
 
@@ -154,7 +152,5 @@ module Nanoc::Helpers
       # Done
       relative_path
     end
-
   end
-
 end

data/lib/nanoc/helpers/rendering.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::Helpers
-
   # Provides functionality for rendering layouts as partials.
   module Rendering
-
     include Nanoc::Helpers::Capturing
 
     # Renders the given layout. The given layout will be run through the first
@@ -91,14 +89,14 @@ module Nanoc::Helpers
 
       # Get assigns
       assigns = {
-        :content    => captured_content,
-        :item       => @item,
-        :item_rep   => @item_rep,
-        :items      => @items,
-        :layout     => layout,
-        :layouts    => @layouts,
-        :config     => @config,
-        :site       => @site
+        content: captured_content,
+        item: @item,
+        item_rep: @item_rep,
+        items: @items,
+        layout: layout,
+        layouts: @layouts,
+        config: @config,
+        site: @site
       }.merge(other_assigns)
 
       # Get filter name
@@ -134,7 +132,5 @@ module Nanoc::Helpers
         Nanoc::NotificationCenter.post(:processing_ended, layout)
       end
     end
-
   end
-
 end

data/lib/nanoc/helpers/tagging.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 module Nanoc::Helpers
-
   # Provides support for managing tags added to items.
   #
   # To add tags to items, set the `tags` attribute to an array of tags that
@@ -11,7 +10,6 @@ module Nanoc::Helpers
   #
   #   tags: [ 'foo', 'bar', 'baz' ]
   module Tagging
-
     require 'nanoc/helpers/html_escape'
     include Nanoc::Helpers::HTMLEscape
 
@@ -65,7 +63,5 @@ module Nanoc::Helpers
     def link_for_tag(tag, base_url)
       %(<a href="#{h base_url}#{h tag}" rel="tag">#{h tag}</a>)
     end
-
   end
-
 end

data/lib/nanoc/helpers/text.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
 
 module Nanoc::Helpers
-
   # Contains several useful text-related helper functions.
   module Text
-
     # Returns an excerpt for the given string. HTML tags are ignored, so if
     # you don't want them to turn up, they should be stripped from the string
     # before passing it to the excerpt function.
@@ -35,10 +33,8 @@ module Nanoc::Helpers
     #
     # @return [String] The given string with all HTML stripped
     def strip_html(string)
-      # FIXME will need something more sophisticated than this, because it sucks
+      # FIXME: will need something more sophisticated than this, because it sucks
       string.gsub(/<[^>]*(>+|\s*\z)/m, '').strip
     end
-
   end
-
 end

data/lib/nanoc/helpers/xml_sitemap.rb

@@ -1,12 +1,10 @@
 # encoding: utf-8
 
 module Nanoc::Helpers
-
   # Contains functionality for building XML sitemaps that will be crawled by
   # search engines. See the [Sitemaps protocol site](http://www.sitemaps.org)
   # for details.
   module XMLSitemap
-
     # Builds an XML sitemap and returns it.
     #
     # The following attributes can optionally be set on items to change the
@@ -48,7 +46,7 @@ module Nanoc::Helpers
 
       # Create builder
       buffer = ''
-      xml = Builder::XmlMarkup.new(:target => buffer, :indent => 2)
+      xml = Builder::XmlMarkup.new(target: buffer, indent: 2)
 
       # Check for required attributes
       if @site.config[:base_url].nil?
@@ -57,9 +55,9 @@ module Nanoc::Helpers
 
       # Build sitemap
       xml.instruct!
-      xml.urlset(:xmlns => 'http://www.sitemaps.org/schemas/sitemap/0.9') do
+      xml.urlset(xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9') do
         # Add item
-        items.sort_by { |i| i.identifier }.each do |item|
+        items.sort_by(&:identifier).each do |item|
           reps = item.reps.reject { |r| r.raw_path.nil? }
           reps.reject! { |r| !select_proc[r] } if select_proc
           reps.sort_by { |r| r.name.to_s }.each do |rep|
@@ -76,7 +74,5 @@ module Nanoc::Helpers
       # Return sitemap
       buffer
     end
-
   end
-
 end

data/lib/nanoc/tasks/clean.rb

@@ -1,9 +1,7 @@
 # encoding: utf-8
 
 module Nanoc::Tasks
-
   class Clean
-
     def initialize(site)
       @site = site
     end
@@ -18,12 +16,8 @@ module Nanoc::Tasks
 
     def filenames
       @site.items.map do |item|
-        item.reps.map do |rep|
-          rep.raw_path
-        end
+        item.reps.map(&:raw_path)
       end.flatten
     end
-
   end
-
 end

data/lib/nanoc/tasks/deploy/rsync.rake

@@ -3,7 +3,6 @@
 require 'nanoc/cli'
 
 namespace :deploy do
-
   desc 'Upload the compiled site using rsync'
   task :rsync do
     dry_run     = ENV['dry_run']
@@ -14,5 +13,4 @@ namespace :deploy do
 
     Nanoc::CLI.run cmd
   end
-
 end

data/lib/nanoc/tasks/validate.rake

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 namespace :validate do
-
   desc 'Validate the site’s HTML files'
   task :html do
     Nanoc::CLI.run %w( validate_html )
@@ -13,7 +12,6 @@ namespace :validate do
   end
 
   namespace :links do
-
     desc 'Validate the site’s internal links'
     task :internal do
       Nanoc::CLI.run %w( validate_links --internal )
@@ -23,12 +21,10 @@ namespace :validate do
     task :external do
       Nanoc::CLI.run %w( validate_links --external )
     end
-
   end
 
   desc 'Validate the site’s internal and external links'
   task :links do
     Nanoc::CLI.run %w( validate_links )
   end
-
 end

data/lib/nanoc/version.rb

@@ -1,8 +1,6 @@
 # encoding: utf-8
 
 module Nanoc
-
   # The current nanoc version.
-  VERSION = '3.7.4'
-
+  VERSION = '3.7.5'
 end

data/nanoc.gemspec

@@ -14,17 +14,20 @@ Gem::Specification.new do |s|
   s.email   = 'denis.defreyne@stoneship.org'
   s.license = 'MIT'
 
-  s.files              = Dir['[A-Z]*'] +
-                         Dir['doc/yardoc_{templates,handlers}/**/*'] +
-                         Dir['{bin,lib,tasks,test}/**/*'] +
-                         [ 'nanoc.gemspec' ]
-  s.executables        = [ 'nanoc' ]
-  s.require_paths      = [ 'lib' ]
+  s.files =
+    Dir['[A-Z]*'] +
+      Dir['doc/yardoc_{templates,handlers}/**/*'] +
+      Dir['{bin,lib,tasks,test}/**/*'] +
+      ['nanoc.gemspec']
+  s.executables        = ['nanoc']
+  s.require_paths      = ['lib']
 
-  s.rdoc_options     = [ '--main', 'README.md' ]
-  s.extra_rdoc_files = [ 'ChangeLog', 'LICENSE', 'README.md', 'NEWS.md' ]
+  s.rdoc_options     = ['--main', 'README.md']
+  s.extra_rdoc_files = ['ChangeLog', 'LICENSE', 'README.md', 'NEWS.md']
+
+  s.required_ruby_version = '>= 1.9.3'
 
   s.add_runtime_dependency('cri', '~> 2.3')
 
-  s.add_development_dependency('bundler', '~> 1.5')
+  s.add_development_dependency('bundler', '>= 1.7.10', '< 2.0')
 end

data/tasks/rubocop.rake

@@ -6,5 +6,5 @@ begin
     task.patterns = ['lib/**/*.rb']
   end
 rescue LoadError
-  warn "Could not load RuboCop. RuboCop rake tasks will be unavailable."
+  warn 'Could not load RuboCop. RuboCop rake tasks will be unavailable.'
 end

data/tasks/test.rake

@@ -12,26 +12,25 @@ def run_tests(dir_glob)
   test_files = Dir["#{dir_glob}*_spec.rb"] + Dir["#{dir_glob}test_*.rb"]
   test_files.each { |f| require f }
 
-  exit MiniTest::Unit.new.run(ENV['ARGS'].split)
+  res = MiniTest::Unit.new.run(ENV['ARGS'].split)
+  exit(res) if res != 0
 end
 
 namespace :test do
-
   # test:all
   desc 'Run all tests'
   task :all do
-    run_tests "test/**/"
+    run_tests 'test/**/'
   end
 
   # test:...
   %w( base cli data_sources extra filters helpers tasks ).each do |dir|
     desc "Run all #{dir} tests"
-    task dir.to_sym do |task|
+    task dir.to_sym do |_task|
       run_tests "test/#{dir}/**/"
     end
   end
-
 end
 
-desc 'Alias for test:all'
-task :test => [ :'test:all' ]
+desc 'Alias for test:all + rubocop'
+task test: [:'test:all', :rubocop]

data/test/base/checksummer_spec.rb

@@ -3,21 +3,17 @@
 require 'tempfile'
 
 describe Nanoc::Checksummer do
-
   subject { Nanoc::Checksummer }
 
   CHECKSUM_REGEX = /\A[0-9a-zA-Z\/+]+=*\Z/
 
   describe 'for String' do
-
     it 'should checksum strings' do
       subject.calc('foo').must_equal('+5k/BWvkYc6T1qhGaSyf3861CyE=')
     end
-
   end
 
   describe 'for Array' do
-
     it 'should checksum arrays' do
       subject.calc([1, 'a', :a]).must_equal 'YtWOEFUAMQritkY38KXHFZM/n2E='
     end
@@ -30,10 +26,14 @@ describe Nanoc::Checksummer do
       subject.calc([-> {}]).must_match(CHECKSUM_REGEX)
     end
 
+    it 'should checksum recursive arrays' do
+      array = [:a]
+      array << array
+      subject.calc(array).must_equal('mR3c98xA5ecazxx+M3h0Ss4/J20=')
+    end
   end
 
   describe 'for Hash' do
-
     it 'should checksum hashes' do
       subject.calc({ a: 1, b: 2 }).must_equal 'qY8fW6gWK7F1XQ9MLrx3Gru/RTY='
     end
@@ -43,18 +43,28 @@ describe Nanoc::Checksummer do
     end
 
     it 'should checksum non-serializable hashes' do
-      subject.calc({ a: ->{} }).must_match(CHECKSUM_REGEX)
+      subject.calc({ a: -> {} }).must_match(CHECKSUM_REGEX)
     end
 
+    it 'should checksum recursive hash keys' do
+      hash = {}
+      hash[hash] = 123
+      subject.calc(hash).must_equal('mKucWMhRtR/FHWNqR/EErF4qgTk=')
+    end
+
+    it 'should checksum recursive hash values' do
+      hash = {}
+      hash[123] = hash
+      subject.calc(hash).must_equal('PBiDX0nWnV+DAYB+w+xM0Kf21ZM=')
+    end
   end
 
   describe 'for Pathname' do
-
     let(:file)            { Tempfile.new('foo') }
     let(:filename)        { file.path }
     let(:pathname)        { Pathname.new(filename) }
-    let(:atime)           { 1234567890 }
-    let(:mtime)           { 1234567890 }
+    let(:atime)           { 1_234_567_890 }
+    let(:mtime)           { 1_234_567_890 }
     let(:data)            { 'stuffs' }
     let(:normal_checksum) { 'THy7Y28oroov/KvPxT6wcMnXr/s=' }
 
@@ -69,14 +79,12 @@ describe Nanoc::Checksummer do
     end
 
     describe 'does not exist' do
-
       let(:non_existing_filename) { 'askldjfklaslasdfkjsajdf' }
       let(:pathname)              { Pathname.new(filename) }
 
       it 'should still checksum' do
         subject.calc(pathname).must_equal(normal_checksum)
       end
-
     end
 
     it 'should get the mtime right' do
@@ -94,43 +102,35 @@ describe Nanoc::Checksummer do
     end
 
     describe 'if the mtime changes' do
-
-      let(:mtime) { 1333333333 }
+      let(:mtime) { 1_333_333_333 }
 
       it 'should have a different checksum' do
         subject.calc(pathname).must_match(CHECKSUM_REGEX)
         subject.calc(pathname).wont_equal(normal_checksum)
       end
-
     end
 
     describe 'if the content changes, but not the file size' do
-
       let(:data) { 'STUFF!' }
 
       it 'should have the same checksum' do
         subject.calc(pathname).must_equal(normal_checksum)
       end
-
     end
 
     describe 'if the file size changes' do
-
       let(:data) { 'stuff and stuff and stuff!!!' }
 
       it 'should have a different checksum' do
         subject.calc(pathname).must_match(CHECKSUM_REGEX)
         subject.calc(pathname).wont_equal(normal_checksum)
       end
-
     end
-
   end
 
   it 'should not have the same checksum for same content but different class'
 
   describe 'for Nanoc::RulesCollection' do
-
     let(:data)            { 'STUFF!' }
     let(:normal_checksum) { 'r4SwDpCp5saBPeZk2gQOJcipTZU=' }
 
@@ -145,20 +145,16 @@ describe Nanoc::Checksummer do
     end
 
     describe 'if the content changes' do
-
       let(:data) { 'Other stuff!' }
 
       it 'should have a different checksum' do
         subject.calc(rules_collection).must_match(CHECKSUM_REGEX)
         subject.calc(rules_collection).wont_equal(normal_checksum)
       end
-
     end
-
   end
 
   describe 'for Nanoc::CodeSnippet' do
-
     let(:data)            { 'asdf' }
     let(:filename)        { File.expand_path('bob.txt') }
     let(:code_snippet)    { Nanoc::CodeSnippet.new(data, filename) }
@@ -169,30 +165,24 @@ describe Nanoc::Checksummer do
     end
 
     describe 'if the filename changes' do
-
       let(:filename) { File.expand_path('george.txt') }
 
       it 'should have the same checksum' do
         subject.calc(code_snippet).must_equal(normal_checksum)
       end
-
     end
 
     describe 'if the content changes' do
-
       let(:data) { 'Other stuff!' }
 
       it 'should have a different checksum' do
         subject.calc(code_snippet).must_match(CHECKSUM_REGEX)
         subject.calc(code_snippet).wont_equal(normal_checksum)
       end
-
     end
-
   end
 
   describe 'for Nanoc::Configuration' do
-
     let(:wrapped)         { { a: 1, b: 2 } }
     let(:configuration)   { Nanoc::Configuration.new(wrapped) }
     let(:normal_checksum) { 'eYYQ74x29njbtXMtuKZX/ogD8JA=' }
@@ -202,20 +192,16 @@ describe Nanoc::Checksummer do
     end
 
     describe 'if the content changes' do
-
       let(:wrapped) { { a: 666, b: 2 } }
 
       it 'should have a different checksum' do
         subject.calc(configuration).must_match(CHECKSUM_REGEX)
         subject.calc(configuration).wont_equal(normal_checksum)
       end
-
     end
-
   end
 
   describe 'for Nanoc::Item' do
-
     let(:content)         { 'asdf' }
     let(:filename)        { File.expand_path('bob.txt') }
     let(:attributes)      { { a: 1, b: 2 } }
@@ -227,48 +213,46 @@ describe Nanoc::Checksummer do
       subject.calc(item).must_equal(normal_checksum)
     end
 
-    describe 'with changed attributes' do
+    describe 'with recursive attributes' do
+      it 'should checksum' do
+        item.attributes[:a] = item
+        subject.calc(item).must_match(CHECKSUM_REGEX)
+        subject.calc(item).wont_equal(normal_checksum)
+      end
+    end
 
+    describe 'with changed attributes' do
       let(:attributes) { { x: 4, y: 5 } }
 
       it 'should have a different checksum' do
         subject.calc(item).must_match(CHECKSUM_REGEX)
         subject.calc(item).wont_equal(normal_checksum)
       end
-
     end
 
     describe 'with changed content' do
-
       let(:content) { 'something drastically different' }
 
       it 'should have a different checksum' do
         subject.calc(item).must_match(CHECKSUM_REGEX)
         subject.calc(item).wont_equal(normal_checksum)
       end
-
     end
-
   end
 
   describe 'for other marshal-able classes' do
-
     let(:obj) { :foobar }
 
     it 'should checksum' do
       subject.calc(obj).must_match(CHECKSUM_REGEX)
     end
-
   end
 
   describe 'for other non-marshal-able classes' do
-
     let(:obj) { proc {} }
 
     it 'should checksum' do
       subject.calc(obj).must_match(CHECKSUM_REGEX)
     end
-
   end
-
 end