nanoc 3.8.0 → 4.0.0a1

data/lib/nanoc/helpers/link_to.rb

@@ -14,7 +14,7 @@ module Nanoc::Helpers
     #
     # @param [String] text The visible link text
     #
-    # @param [String, Nanoc::Item, Nanoc::ItemRep] target The path/URL,
+    # @param [String, Nanoc::Int::Item, Nanoc::Int::ItemRep] target The path/URL,
     #   item or item representation that should be linked to
     #
     # @param [Hash] attributes A hash containing HTML attributes (e.g.
@@ -68,7 +68,7 @@ module Nanoc::Helpers
     #
     # @param [String] text The visible link text
     #
-    # @param [String, Nanoc::Item, Nanoc::ItemRep] target The path/URL,
+    # @param [String, Nanoc::Int::Item, Nanoc::Int::ItemRep] target The path/URL,
     #   item or item representation that should be linked to
     #
     # @param [Hash] attributes A hash containing HTML attributes (e.g.
@@ -100,7 +100,7 @@ module Nanoc::Helpers
     # Returns the relative path from the current item to the given path or
     # item representation. The returned path will not be HTML-escaped.
     #
-    # @param [String, Nanoc::Item, Nanoc::ItemRep] target The path/URL,
+    # @param [String, Nanoc::Int::Item, Nanoc::Int::ItemRep] target The path/URL,
     #   item or item representation to which the relative path should be
     #   generated
     #

data/lib/nanoc/helpers/rendering.rb

@@ -64,25 +64,25 @@ module Nanoc::Helpers
     #     I'm boxy! Luvz!
     #   </div>
     #
-    # @raise [Nanoc::Errors::UnknownLayout] if the given layout does not
+    # @raise [Nanoc::Int::Errors::UnknownLayout] if the given layout does not
     #   exist
     #
-    # @raise [Nanoc::Errors::CannotDetermineFilter] if there is no layout
+    # @raise [Nanoc::Int::Errors::CannotDetermineFilter] if there is no layout
     #   rule for the given layout
     #
-    # @raise [Nanoc::Errors::UnknownFilter] if the layout rule for the given
+    # @raise [Nanoc::Int::Errors::UnknownFilter] if the layout rule for the given
     #   layout specifies an unknown filter
     #
     # @return [String, nil] The rendered partial, or nil if this method was
     #   invoked with a block
     def render(identifier, other_assigns = {}, &block)
       # Find layout
-      layout = @site.layouts.find { |l| l.identifier == identifier.cleaned_identifier }
-      raise Nanoc::Errors::UnknownLayout.new(identifier.cleaned_identifier) if layout.nil?
+      layout = @site.layouts.find { |l| l.identifier == identifier.__nanoc_cleaned_identifier }
+      raise Nanoc::Int::Errors::UnknownLayout.new(identifier.__nanoc_cleaned_identifier) if layout.nil?
 
       # Visit
-      Nanoc::NotificationCenter.post(:visit_started, layout)
-      Nanoc::NotificationCenter.post(:visit_ended,   layout)
+      Nanoc::Int::NotificationCenter.post(:visit_started, layout)
+      Nanoc::Int::NotificationCenter.post(:visit_ended,   layout)
 
       # Capture content, if any
       captured_content = block_given? ? capture(&block) : nil
@@ -101,18 +101,18 @@ module Nanoc::Helpers
 
       # Get filter name
       filter_name, filter_args = @site.compiler.rules_collection.filter_for_layout(layout)
-      raise Nanoc::Errors::CannotDetermineFilter.new(layout.identifier) if filter_name.nil?
+      raise Nanoc::Int::Errors::CannotDetermineFilter.new(layout.identifier) if filter_name.nil?
 
       # Get filter class
       filter_class = Nanoc::Filter.named(filter_name)
-      raise Nanoc::Errors::UnknownFilter.new(filter_name) if filter_class.nil?
+      raise Nanoc::Int::Errors::UnknownFilter.new(filter_name) if filter_class.nil?
 
       # Create filter
       filter = filter_class.new(assigns)
 
       begin
         # Notify start
-        Nanoc::NotificationCenter.post(:processing_started, layout)
+        Nanoc::Int::NotificationCenter.post(:processing_started, layout)
 
         # Layout
         result = filter.setup_and_run(layout.raw_content, filter_args)
@@ -129,7 +129,7 @@ module Nanoc::Helpers
         end
       ensure
         # Notify end
-        Nanoc::NotificationCenter.post(:processing_ended, layout)
+        Nanoc::Int::NotificationCenter.post(:processing_ended, layout)
       end
     end
   end

data/lib/nanoc/helpers/xml_sitemap.rb

@@ -49,7 +49,7 @@ module Nanoc::Helpers
       xml = Builder::XmlMarkup.new(target: buffer, indent: 2)
 
       # Check for required attributes
-      if @site.config[:base_url].nil?
+      if @config[:base_url].nil?
         raise RuntimeError.new('The Nanoc::Helpers::XMLSitemap helper requires the site configuration to specify the base URL for the site.')
       end
 
@@ -62,8 +62,8 @@ module Nanoc::Helpers
           reps.reject! { |r| !select_proc[r] } if select_proc
           reps.sort_by { |r| r.name.to_s }.each do |rep|
             xml.url do
-              xml.loc @site.config[:base_url] + rep.path
-              xml.lastmod item[:mtime].to_iso8601_date unless item[:mtime].nil?
+              xml.loc @config[:base_url] + rep.path
+              xml.lastmod item[:mtime].__nanoc_to_iso8601_date unless item[:mtime].nil?
               xml.changefreq item[:changefreq] unless item[:changefreq].nil?
               xml.priority item[:priority] unless item[:priority].nil?
             end

data/lib/nanoc/tasks.rb

@@ -3,6 +3,7 @@
 require 'nanoc'
 require 'rake'
 
+# @api private
 module Nanoc::Tasks
 end
 

data/lib/nanoc/tasks/clean.rake

@@ -3,7 +3,7 @@
 desc 'Remove output files generated by nanoc'
 task :clean do
   # Load site
-  site = Nanoc::Site.new('.')
+  site = Nanoc::Int::Site.new('.')
   if site.nil?
     $stderr.puts 'The current working directory does not seem to be a ' \
                  'valid/complete nanoc site directory; aborting.'

data/lib/nanoc/version.rb

@@ -2,5 +2,5 @@
 
 module Nanoc
   # The current nanoc version.
-  VERSION = '3.8.0'
+  VERSION = '4.0.0a1'
 end

data/tasks/doc.rake

@@ -12,6 +12,7 @@ YARD::Rake::YardocTask.new(:doc) do |yard|
     '--files',           'NEWS.md,LICENSE',
     '--output-dir',      'doc/yardoc',
     '--template-path',   'doc/yardoc_templates',
-    '--load',            'doc/yardoc_handlers/identifier.rb'
+    '--load',            'doc/yardoc_handlers/identifier.rb',
+    '--query',           '@api.text != "private"',
   ]
 end

data/tasks/test.rake

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'rspec/core/rake_task'
+
 def run_tests(dir_glob)
   ENV['ARGS'] ||= ''
   ENV['QUIET'] ||= 'true'
@@ -32,5 +34,9 @@ namespace :test do
   end
 end
 
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = '-r ./spec/spec_helper.rb --color'
+end
+
 desc 'Alias for test:all + rubocop'
-task test: [:'test:all', :rubocop]
+task test: [:spec, :'test:all', :rubocop]

data/test/base/checksummer_spec.rb

@@ -2,8 +2,8 @@
 
 require 'tempfile'
 
-describe Nanoc::Checksummer do
-  subject { Nanoc::Checksummer }
+describe Nanoc::Int::Checksummer do
+  subject { Nanoc::Int::Checksummer }
 
   CHECKSUM_REGEX = /\A[0-9a-zA-Z\/+]+=*\Z/
 
@@ -130,12 +130,12 @@ describe Nanoc::Checksummer do
 
   it 'should not have the same checksum for same content but different class'
 
-  describe 'for Nanoc::RulesCollection' do
+  describe 'for Nanoc::Int::RulesCollection' do
     let(:data)            { 'STUFF!' }
-    let(:normal_checksum) { 'r4SwDpCp5saBPeZk2gQOJcipTZU=' }
+    let(:normal_checksum) { 'Y6mX13i8ZEd4a11xRPc2yNQSRDs=' }
 
     let(:rules_collection) do
-      coll = Nanoc::RulesCollection.new(nil)
+      coll = Nanoc::Int::RulesCollection.new(nil)
       coll.data = data
       coll
     end
@@ -154,11 +154,11 @@ describe Nanoc::Checksummer do
     end
   end
 
-  describe 'for Nanoc::CodeSnippet' do
+  describe 'for Nanoc::Int::CodeSnippet' do
     let(:data)            { 'asdf' }
     let(:filename)        { File.expand_path('bob.txt') }
-    let(:code_snippet)    { Nanoc::CodeSnippet.new(data, filename) }
-    let(:normal_checksum) { 'ZSo56CFoBcNgiDsWOfLLquH2sF0=' }
+    let(:code_snippet)    { Nanoc::Int::CodeSnippet.new(data, filename) }
+    let(:normal_checksum) { 's6oZ1xLVekKDVhYrXsJuHChFjek=' }
 
     it 'should checksum the data' do
       subject.calc(code_snippet).must_equal(normal_checksum)
@@ -182,13 +182,13 @@ describe Nanoc::Checksummer do
     end
   end
 
-  describe 'for Nanoc::Configuration' do
+  describe 'for Nanoc::Int::Configuration' do
     let(:wrapped)         { { a: 1, b: 2 } }
-    let(:configuration)   { Nanoc::Configuration.new(wrapped) }
-    let(:normal_checksum) { 'eYYQ74x29njbtXMtuKZX/ogD8JA=' }
+    let(:configuration)   { Nanoc::Int::Configuration.new(wrapped) }
+    let(:normal_checksum) { 'xwbPeftLbSXYx0OJbKCqrPHctPU=' }
 
     it 'should checksum the hash' do
-      subject.calc(configuration).must_equal('eYYQ74x29njbtXMtuKZX/ogD8JA=')
+      subject.calc(configuration).must_equal(normal_checksum)
     end
 
     describe 'if the content changes' do
@@ -201,13 +201,13 @@ describe Nanoc::Checksummer do
     end
   end
 
-  describe 'for Nanoc::Item' do
+  describe 'for Nanoc::Int::Item' do
     let(:content)         { 'asdf' }
     let(:filename)        { File.expand_path('bob.txt') }
     let(:attributes)      { { a: 1, b: 2 } }
     let(:identifier)      { '/foo/' }
-    let(:item)            { Nanoc::Item.new(content, attributes, identifier) }
-    let(:normal_checksum) { 'eTPdmaG7UAuPzH210HM1JvJaWDo=' }
+    let(:item)            { Nanoc::Int::Item.new(content, attributes, identifier) }
+    let(:normal_checksum) { '6VtlVLx1JE69erzfDczZW7HSWeY=' }
 
     it 'should checksum item' do
       subject.calc(item).must_equal(normal_checksum)

data/test/base/core_ext/array_spec.rb

@@ -1,27 +1,27 @@
 # encoding: utf-8
 
-describe 'Array#symbolize_keys_recursively' do
+describe 'Array#__nanoc_symbolize_keys_recursively' do
   it 'should convert keys to symbols' do
     array_old = [:abc, 'xyz', { 'foo' => 'bar', :baz => :qux }]
     array_new = [:abc, 'xyz', { foo: 'bar', baz: :qux }]
-    array_old.symbolize_keys_recursively.must_equal array_new
+    array_old.__nanoc_symbolize_keys_recursively.must_equal array_new
   end
 end
 
-describe 'Array#stringify_keys_recursively' do
+describe 'Array#__nanoc_stringify_keys_recursively' do
   it 'should convert keys to strings' do
     array_old = [:abc, 'xyz', { :foo  => 'bar', 'baz' => :qux }]
     array_new = [:abc, 'xyz', { 'foo' => 'bar', 'baz' => :qux }]
-    array_old.stringify_keys_recursively.must_equal array_new
+    array_old.__nanoc_stringify_keys_recursively.must_equal array_new
   end
 end
 
-describe 'Array#freeze_recursively' do
+describe 'Array#__nanoc_freeze_recursively' do
   include Nanoc::TestHelpers
 
   it 'should prevent first-level elements from being modified' do
     array = [:a, [:b, :c], :d]
-    array.freeze_recursively
+    array.__nanoc_freeze_recursively
 
     assert_raises_frozen_error do
       array[0] = 123
@@ -30,7 +30,7 @@ describe 'Array#freeze_recursively' do
 
   it 'should prevent second-level elements from being modified' do
     array = [:a, [:b, :c], :d]
-    array.freeze_recursively
+    array.__nanoc_freeze_recursively
 
     assert_raises_frozen_error do
       array[1][0] = 123
@@ -41,7 +41,7 @@ describe 'Array#freeze_recursively' do
     a = []
     a << a
 
-    a.freeze_recursively
+    a.__nanoc_freeze_recursively
 
     assert a.frozen?
     assert a[0].frozen?
@@ -49,9 +49,9 @@ describe 'Array#freeze_recursively' do
   end
 end
 
-describe 'Array#checksum' do
+describe 'Array#__nanoc_checksum' do
   it 'should work' do
     expectation = 'CEUlNvu/3DUmlbtpFRiLHU8oHA0='
-    [[:foo, 123]].checksum.must_equal expectation
+    [[:foo, 123]].__nanoc_checksum.must_equal expectation
   end
 end

data/test/base/core_ext/hash_spec.rb

@@ -1,51 +1,51 @@
 # encoding: utf-8
 
-describe 'Hash#symbolize_keys_recursively' do
+describe 'Hash#__nanoc_symbolize_keys_recursively' do
   it 'should convert keys to symbols' do
     hash_old = { 'foo' => 'bar' }
     hash_new = { foo: 'bar' }
-    hash_old.symbolize_keys_recursively.must_equal hash_new
+    hash_old.__nanoc_symbolize_keys_recursively.must_equal hash_new
   end
 
   it 'should not require string keys' do
     hash_old = { Time.now => 'abc' }
     hash_new = hash_old
-    hash_old.symbolize_keys_recursively.must_equal hash_new
+    hash_old.__nanoc_symbolize_keys_recursively.must_equal hash_new
   end
 end
 
-describe 'Hash#stringify_keys_recursively' do
+describe 'Hash#__nanoc_stringify_keys_recursively' do
   it 'should leave strings as strings' do
     hash_old = { 'foo' => 'bar' }
     hash_new = { 'foo' => 'bar' }
-    hash_old.stringify_keys_recursively.must_equal hash_new
+    hash_old.__nanoc_stringify_keys_recursively.must_equal hash_new
   end
 
   it 'should convert symbols to strings' do
     hash_old = { foo: 'bar' }
     hash_new = { 'foo' => 'bar' }
-    hash_old.stringify_keys_recursively.must_equal hash_new
+    hash_old.__nanoc_stringify_keys_recursively.must_equal hash_new
   end
 
   it 'should convert integers to strings' do
     hash_old = { 123   => 'bar' }
     hash_new = { '123' => 'bar' }
-    hash_old.stringify_keys_recursively.must_equal hash_new
+    hash_old.__nanoc_stringify_keys_recursively.must_equal hash_new
   end
 
   it 'should convert nil to an empty string' do
     hash_old = { nil => 'bar' }
     hash_new = { ''  => 'bar' }
-    hash_old.stringify_keys_recursively.must_equal hash_new
+    hash_old.__nanoc_stringify_keys_recursively.must_equal hash_new
   end
 end
 
-describe 'Hash#freeze_recursively' do
+describe 'Hash#__nanoc_freeze_recursively' do
   include Nanoc::TestHelpers
 
   it 'should prevent first-level elements from being modified' do
     hash = { a: { b: :c } }
-    hash.freeze_recursively
+    hash.__nanoc_freeze_recursively
 
     assert_raises_frozen_error do
       hash[:a] = 123
@@ -54,7 +54,7 @@ describe 'Hash#freeze_recursively' do
 
   it 'should prevent second-level elements from being modified' do
     hash = { a: { b: :c } }
-    hash.freeze_recursively
+    hash.__nanoc_freeze_recursively
 
     assert_raises_frozen_error do
       hash[:a][:b] = 123
@@ -65,7 +65,7 @@ describe 'Hash#freeze_recursively' do
     a = {}
     a[:x] = a
 
-    a.freeze_recursively
+    a.__nanoc_freeze_recursively
 
     assert a.frozen?
     assert a[:x].frozen?
@@ -73,15 +73,15 @@ describe 'Hash#freeze_recursively' do
   end
 end
 
-describe 'Hash#checksum' do
+describe 'Hash#__nanoc_checksum' do
   it 'should work' do
     expectation = 'wy7gHokc700tqJ/BmJ+EK6/F0bc='
-    { foo: 123 }.checksum.must_equal expectation
+    { foo: 123 }.__nanoc_checksum.must_equal expectation
   end
 
   it 'should not sort keys' do
-    a = { a: 1, c: 2, b: 3 }.checksum
-    b = { a: 1, b: 3, c: 2 }.checksum
+    a = { a: 1, c: 2, b: 3 }.__nanoc_checksum
+    b = { a: 1, b: 3, c: 2 }.__nanoc_checksum
     a.wont_equal b
   end
 end

data/test/base/core_ext/pathname_spec.rb

@@ -11,7 +11,7 @@ describe 'Pathname#checksum' do
 
       # Create checksum
       pathname = Pathname.new('tmp/myfile')
-      pathname.checksum.must_equal 'oU+0fYgGm4EDTl+uErBv8rB9YhU='
+      pathname.__nanoc_checksum.must_equal 'oU+0fYgGm4EDTl+uErBv8rB9YhU='
     ensure
       FileUtils.rm_rf('tmp')
     end
@@ -27,7 +27,7 @@ describe 'Pathname#checksum' do
 
       # Create checksum
       pathname = Pathname.new('tmp/myfile')
-      pathname.checksum.must_equal 'IAoqYXvcDheQjaYmZ8waPtEO8zU='
+      pathname.__nanoc_checksum.must_equal 'IAoqYXvcDheQjaYmZ8waPtEO8zU='
     ensure
       FileUtils.rm_rf('tmp')
     end

data/test/base/core_ext/string_spec.rb

@@ -1,33 +1,33 @@
 # encoding: utf-8
 
-describe 'String#cleaned_identifier' do
+describe 'String#__nanoc_cleaned_identifier' do
   it 'should not convert already clean paths' do
-    '/foo/bar/'.cleaned_identifier.must_equal '/foo/bar/'
+    '/foo/bar/'.__nanoc_cleaned_identifier.must_equal '/foo/bar/'
   end
 
   it 'should prepend slash if necessary' do
-    'foo/bar/'.cleaned_identifier.must_equal '/foo/bar/'
+    'foo/bar/'.__nanoc_cleaned_identifier.must_equal '/foo/bar/'
   end
 
   it 'should append slash if necessary' do
-    '/foo/bar'.cleaned_identifier.must_equal '/foo/bar/'
+    '/foo/bar'.__nanoc_cleaned_identifier.must_equal '/foo/bar/'
   end
 
   it 'should remove double slashes at start' do
-    '//foo/bar/'.cleaned_identifier.must_equal '/foo/bar/'
+    '//foo/bar/'.__nanoc_cleaned_identifier.must_equal '/foo/bar/'
   end
 
   it 'should remove double slashes at end' do
-    '/foo/bar//'.cleaned_identifier.must_equal '/foo/bar/'
+    '/foo/bar//'.__nanoc_cleaned_identifier.must_equal '/foo/bar/'
   end
 end
 
-describe 'String#checksum' do
+describe 'String#__nanoc_checksum' do
   it 'should work on empty strings' do
-    ''.checksum.must_equal 'PfY7essFItpoXa1f6EuB/deyUmQ='
+    ''.__nanoc_checksum.must_equal 'PfY7essFItpoXa1f6EuB/deyUmQ='
   end
 
   it 'should work on all strings' do
-    'abc'.checksum.must_equal 'NkkYRO+25f6psNSeCYykXKCg3C0='
+    'abc'.__nanoc_checksum.must_equal 'NkkYRO+25f6psNSeCYykXKCg3C0='
   end
 end