Merge pull request #764 from nanoc/fix-pre-snapshot

Fix final :pre snapshot not being generated

lib/nanoc/base/entities/rule_memory.rb

@@ -24,7 +24,7 @@ def add_layout(layout_identifier, params)
     end
 
     def add_snapshot(snapshot_name, final, path)
-      will_add_snapshot(snapshot_name)
+      will_add_snapshot(snapshot_name) if final
       @actions << Nanoc::Int::RuleMemoryActions::Snapshot.new(snapshot_name, final, path)
     end
 

lib/nanoc/rule_dsl/recording_executor.rb

@@ -1,12 +1,6 @@
 module Nanoc
   module RuleDSL
     class RecordingExecutor
-      class NonFinalSnapshotWithPathError < ::Nanoc::Error
-        def initialize
-          super('This call to #snapshot specifies `final: false`, but it also specifies a path, which is an impossible combination.')
-        end
-      end
-
       class PathWithoutInitialSlashError < ::Nanoc::Error
         def initialize(rep, basic_path)
           super("The path returned for the #{rep.inspect} item representation, “#{basic_path}”, does not start with a slash. Please ensure that all routing rules return a path that starts with a slash.")
@@ -28,14 +22,15 @@ def filter(_rep, filter_name, filter_args = {})
       end
 
       def layout(_rep, layout_identifier, extra_filter_args = {})
+        unless @rule_memory.any_layouts?
+          @rule_memory.add_snapshot(:pre, true, nil)
+        end
+
         @rule_memory.add_layout(layout_identifier, extra_filter_args)
       end
 
       def snapshot(rep, snapshot_name, final: true, path: nil)
-        actual_path = path || basic_path_from_rules_for(rep, snapshot_name)
-        if !final && actual_path
-          raise NonFinalSnapshotWithPathError
-        end
+        actual_path = final ? (path || basic_path_from_rules_for(rep, snapshot_name)) : nil
         @rule_memory.add_snapshot(snapshot_name, final, actual_path)
       end
 

spec/nanoc/base/entities/rule_memory_spec.rb

@@ -70,13 +70,23 @@
       end
     end
 
-    context 'snapshot already exist' do
+    context 'non-final snapshot already exist' do
       before do
         rule_memory.add_snapshot(:before_layout, false, '/bar.md')
       end
 
-      example do
-        expect { rule_memory.add_snapshot(:before_layout, false, '/foo.md') }
+      it 'does not raise' do
+        rule_memory.add_snapshot(:before_layout, true, '/foo.md')
+      end
+    end
+
+    context 'final snapshot already exist' do
+      before do
+        rule_memory.add_snapshot(:before_layout, true, '/bar.md')
+      end
+
+      it 'raises' do
+        expect { rule_memory.add_snapshot(:before_layout, true, '/foo.md') }
           .to raise_error(Nanoc::Int::Errors::CannotCreateMultipleSnapshotsWithSameName)
       end
     end

spec/nanoc/rule_dsl/recording_executor_spec.rb

@@ -29,19 +29,31 @@
     it 'records layout call without arguments' do
       executor.layout(rep, '/default.*')
 
-      expect(executor.rule_memory.size).to eql(1)
-      expect(executor.rule_memory[0]).to be_a(Nanoc::Int::RuleMemoryActions::Layout)
-      expect(executor.rule_memory[0].layout_identifier).to eql('/default.*')
-      expect(executor.rule_memory[0].params).to eql({})
+      expect(executor.rule_memory.size).to eql(2)
+
+      expect(executor.rule_memory[0]).to be_a(Nanoc::Int::RuleMemoryActions::Snapshot)
+      expect(executor.rule_memory[0].snapshot_name).to eql(:pre)
+      expect(executor.rule_memory[0]).to be_final
+      expect(executor.rule_memory[0].path).to be_nil
+
+      expect(executor.rule_memory[1]).to be_a(Nanoc::Int::RuleMemoryActions::Layout)
+      expect(executor.rule_memory[1].layout_identifier).to eql('/default.*')
+      expect(executor.rule_memory[1].params).to eql({})
     end
 
     it 'records layout call with arguments' do
       executor.layout(rep, '/default.*', final: false)
 
-      expect(executor.rule_memory.size).to eql(1)
-      expect(executor.rule_memory[0]).to be_a(Nanoc::Int::RuleMemoryActions::Layout)
-      expect(executor.rule_memory[0].layout_identifier).to eql('/default.*')
-      expect(executor.rule_memory[0].params).to eql({ final: false })
+      expect(executor.rule_memory.size).to eql(2)
+
+      expect(executor.rule_memory[0]).to be_a(Nanoc::Int::RuleMemoryActions::Snapshot)
+      expect(executor.rule_memory[0].snapshot_name).to eql(:pre)
+      expect(executor.rule_memory[0]).to be_final
+      expect(executor.rule_memory[0].path).to be_nil
+
+      expect(executor.rule_memory[1]).to be_a(Nanoc::Int::RuleMemoryActions::Layout)
+      expect(executor.rule_memory[1].layout_identifier).to eql('/default.*')
+      expect(executor.rule_memory[1].params).to eql({ final: false })
     end
   end
 
@@ -167,6 +179,7 @@
 
         it 'records' do
           subject
+
           expect(executor.rule_memory.size).to eql(1)
           expect(executor.rule_memory[0]).to be_a(Nanoc::Int::RuleMemoryActions::Snapshot)
           expect(executor.rule_memory[0].snapshot_name).to eql(:foo)
@@ -177,8 +190,14 @@
         context 'explicit path given' do
           let(:path) { '/routed-foo.html' }
 
-          it 'errors' do
-            expect { subject }.to raise_error(Nanoc::RuleDSL::RecordingExecutor::NonFinalSnapshotWithPathError)
+          it 'records without path' do
+            subject
+
+            expect(executor.rule_memory.size).to eql(1)
+            expect(executor.rule_memory[0]).to be_a(Nanoc::Int::RuleMemoryActions::Snapshot)
+            expect(executor.rule_memory[0].snapshot_name).to eql(:foo)
+            expect(executor.rule_memory[0].path).to be_nil
+            expect(executor.rule_memory[0]).not_to be_final
           end
         end
 
@@ -202,8 +221,14 @@
             allow(site).to receive(:config).and_return(double(:config))
           end
 
-          it 'errors' do
-            expect { subject }.to raise_error(Nanoc::RuleDSL::RecordingExecutor::NonFinalSnapshotWithPathError)
+          it 'records without path' do
+            subject
+
+            expect(executor.rule_memory.size).to eql(1)
+            expect(executor.rule_memory[0]).to be_a(Nanoc::Int::RuleMemoryActions::Snapshot)
+            expect(executor.rule_memory[0].snapshot_name).to eql(:foo)
+            expect(executor.rule_memory[0].path).to be_nil
+            expect(executor.rule_memory[0]).not_to be_final
           end
         end
       end

spec/nanoc/rule_dsl/rule_memory_calculator_spec.rb

@@ -31,7 +31,7 @@
       example do
         subject
 
-        expect(subject.size).to eql(7)
+        expect(subject.size).to eql(8)
 
         expect(subject[0]).to be_a(Nanoc::Int::RuleMemoryActions::Snapshot)
         expect(subject[0].snapshot_name).to eql(:raw)
@@ -47,23 +47,28 @@
         expect(subject[2].filter_name).to eql(:erb)
         expect(subject[2].params).to eql({ speed: :over_9000 })
 
-        expect(subject[3]).to be_a(Nanoc::Int::RuleMemoryActions::Layout)
-        expect(subject[3].layout_identifier).to eql('/default.*')
-        expect(subject[3].params).to be_nil
+        expect(subject[3]).to be_a(Nanoc::Int::RuleMemoryActions::Snapshot)
+        expect(subject[3].snapshot_name).to eql(:pre)
+        expect(subject[3]).to be_final
+        expect(subject[3].path).to be_nil
 
-        expect(subject[4]).to be_a(Nanoc::Int::RuleMemoryActions::Filter)
-        expect(subject[4].filter_name).to eql(:typohero)
-        expect(subject[4].params).to eql({})
+        expect(subject[4]).to be_a(Nanoc::Int::RuleMemoryActions::Layout)
+        expect(subject[4].layout_identifier).to eql('/default.*')
+        expect(subject[4].params).to be_nil
 
-        expect(subject[5]).to be_a(Nanoc::Int::RuleMemoryActions::Snapshot)
-        expect(subject[5].snapshot_name).to eql(:post)
-        expect(subject[5]).to be_final
-        expect(subject[5].path).to be_nil
+        expect(subject[5]).to be_a(Nanoc::Int::RuleMemoryActions::Filter)
+        expect(subject[5].filter_name).to eql(:typohero)
+        expect(subject[5].params).to eql({})
 
         expect(subject[6]).to be_a(Nanoc::Int::RuleMemoryActions::Snapshot)
-        expect(subject[6].snapshot_name).to eql(:last)
+        expect(subject[6].snapshot_name).to eql(:post)
         expect(subject[6]).to be_final
         expect(subject[6].path).to be_nil
+
+        expect(subject[7]).to be_a(Nanoc::Int::RuleMemoryActions::Snapshot)
+        expect(subject[7].snapshot_name).to eql(:last)
+        expect(subject[7]).to be_final
+        expect(subject[7].path).to be_nil
       end
     end
 
@@ -120,7 +125,7 @@
     end
 
     example do
-      expect(subject.size).to eql(4)
+      expect(subject.size).to eql(5)
 
       expect(subject[0]).to be_a(Nanoc::Int::SnapshotDef)
       expect(subject[0].name).to eql(:raw)
@@ -131,12 +136,16 @@
       expect(subject[1]).not_to be_final
 
       expect(subject[2]).to be_a(Nanoc::Int::SnapshotDef)
-      expect(subject[2].name).to eql(:post)
+      expect(subject[2].name).to eql(:pre)
       expect(subject[2]).to be_final
 
       expect(subject[3]).to be_a(Nanoc::Int::SnapshotDef)
-      expect(subject[3].name).to eql(:last)
+      expect(subject[3].name).to eql(:post)
       expect(subject[3]).to be_final
+
+      expect(subject[4]).to be_a(Nanoc::Int::SnapshotDef)
+      expect(subject[4].name).to eql(:last)
+      expect(subject[4]).to be_final
     end
   end
 end

test/base/test_compiler.rb

@@ -39,8 +39,6 @@ def test_compile_rep_should_write_proper_snapshots_real
       File.write('content/moo.txt', '<%= 1 %> <%%= 2 %> <%%%= 3 %>')
       File.write('layouts/default.erb', 'head <%= yield %> foot')
 
-      # FIXME: :pre is broken (it’s always non-final)
-
       File.open('Rules', 'w') do |io|
         io.write "compile '/**/*' do\n"
         io.write "  filter :erb\n"
@@ -53,10 +51,10 @@ def test_compile_rep_should_write_proper_snapshots_real
         io.write "  '/moo-raw.txt'\n"
         io.write "end\n"
         io.write "\n"
-        # io.write "route '/**/*', snapshot: :pre do\n"
-        # io.write "  '/moo-pre.txt'\n"
-        # io.write "end\n"
-        # io.write "\n"
+        io.write "route '/**/*', snapshot: :pre do\n"
+        io.write "  '/moo-pre.txt'\n"
+        io.write "end\n"
+        io.write "\n"
         io.write "route '/**/*', snapshot: :post do\n"
         io.write "  '/moo-post.txt'\n"
         io.write "end\n"