nanoc 4.5.2 → 4.5.3

data/spec/nanoc/base/filter_spec.rb

@@ -53,6 +53,7 @@ describe Nanoc::Filter do
         items: double(:items),
         dependency_tracker: dependency_tracker,
         compilation_context: double(:compilation_context),
+        snapshot_repo: double(:snapshot_repo),
       )
     end
 

data/spec/nanoc/base/item_rep_writer_spec.rb

@@ -6,7 +6,6 @@ describe Nanoc::Int::ItemRepWriter do
 
     let(:item_rep) do
       Nanoc::Int::ItemRep.new(item, :default).tap do |ir|
-        ir.snapshot_contents = snapshot_contents
         ir.raw_paths = raw_paths
       end
     end
@@ -24,10 +23,16 @@ describe Nanoc::Int::ItemRepWriter do
       { snapshot_name => raw_path }
     end
 
-    subject { described_class.new.write(item_rep, snapshot_name) }
+    let(:snapshot_repo) { Nanoc::Int::SnapshotRepo.new }
+
+    subject { described_class.new.write(item_rep, snapshot_repo, snapshot_name) }
 
     before do
       expect(File.directory?('output')).to be_falsy
+
+      snapshot_contents.each_pair do |key, value|
+        snapshot_repo.set(item_rep, key, value)
+      end
     end
 
     context 'binary item rep' do
@@ -49,7 +54,7 @@ describe Nanoc::Int::ItemRepWriter do
         expect(Nanoc::Int::NotificationCenter).to receive(:post)
           .with(:will_write_rep, item_rep, 'output/blah.dat')
         expect(Nanoc::Int::NotificationCenter).to receive(:post)
-          .with(:rep_written, item_rep, 'output/blah.dat', true, true)
+          .with(:rep_written, item_rep, true, 'output/blah.dat', true, true)
 
         subject
 
@@ -92,7 +97,7 @@ describe Nanoc::Int::ItemRepWriter do
         expect(Nanoc::Int::NotificationCenter).to receive(:post)
           .with(:will_write_rep, item_rep, 'output/blah.dat')
         expect(Nanoc::Int::NotificationCenter).to receive(:post)
-          .with(:rep_written, item_rep, 'output/blah.dat', true, true)
+          .with(:rep_written, item_rep, false, 'output/blah.dat', true, true)
 
         subject
 

data/spec/nanoc/base/repos/snapshot_repo_spec.rb

@@ -0,0 +1,314 @@
+describe Nanoc::Int::SnapshotRepo do
+  subject(:repo) { described_class.new }
+
+  describe '#get' do
+    subject { repo.get(rep, snapshot_name) }
+
+    let(:item) { Nanoc::Int::Item.new('contentz', {}, '/foo.md') }
+    let(:rep) { Nanoc::Int::ItemRep.new(item, :foo) }
+    let(:snapshot_name) { :donkey }
+
+    context 'rep does not exist in repo' do
+      it { is_expected.to be_nil }
+    end
+
+    context 'rep exists in repo' do
+      before { repo.set(rep, :foobar, Nanoc::Int::TextualContent.new('other content')) }
+
+      context 'snapshot does not exist in repo' do
+        it { is_expected.to be_nil }
+      end
+
+      context 'snapshot exists in repo' do
+        before { repo.set(rep, :donkey, Nanoc::Int::TextualContent.new('donkey')) }
+        it { is_expected.to be_some_textual_content('donkey') }
+      end
+    end
+  end
+
+  describe '#get_all' do
+    subject { repo.get_all(rep) }
+
+    let(:item) { Nanoc::Int::Item.new('contentz', {}, '/foo.md') }
+    let(:rep) { Nanoc::Int::ItemRep.new(item, :foo) }
+
+    context 'rep does not exist in repo' do
+      it { is_expected.to eq({}) }
+    end
+
+    context 'rep exists in repo' do
+      before { repo.set(rep, :foobar, Nanoc::Int::TextualContent.new('donkey')) }
+      it { is_expected.to match(foobar: some_textual_content('donkey')) }
+    end
+  end
+
+  describe '#set' do
+    subject { repo.set(rep, snapshot_name, contents) }
+
+    let(:item) { Nanoc::Int::Item.new('contentz', {}, '/foo.md') }
+    let(:rep) { Nanoc::Int::ItemRep.new(item, :foo) }
+    let(:snapshot_name) { :donkey }
+    let(:contents) { Nanoc::Int::TextualContent.new('donkey') }
+
+    it 'changes the given rep+snapshot' do
+      expect { subject }
+        .to change { repo.get(rep, snapshot_name) }
+        .from(nil)
+        .to(some_textual_content('donkey'))
+    end
+  end
+
+  describe '#set_all' do
+    subject { repo.set_all(rep, contents_by_snapshot) }
+
+    let(:other_item) { Nanoc::Int::Item.new('contentz', {}, '/foo.md') }
+    let(:other_rep) { Nanoc::Int::ItemRep.new(other_item, :foo) }
+
+    let(:item) { Nanoc::Int::Item.new('contentz', {}, '/foo.md') }
+    let(:rep) { Nanoc::Int::ItemRep.new(item, :foo) }
+    let(:contents_by_snapshot) { { donkey: Nanoc::Int::TextualContent.new('donkey') } }
+
+    it 'changes the given rep+snapshot' do
+      expect { subject }
+        .to change { repo.get(rep, :donkey) }
+        .from(nil)
+        .to(some_textual_content('donkey'))
+    end
+
+    it 'leaves other reps intact' do
+      expect { subject }
+        .not_to change { repo.get(other_rep, :donkey) }
+    end
+
+    it 'leaves other snapshots intact' do
+      expect { subject }
+        .not_to change { repo.get(rep, :giraffe) }
+    end
+  end
+
+  describe '#compiled_content' do
+    subject { repo.compiled_content(rep: rep, snapshot: snapshot_name) }
+
+    let(:snapshot_name) { raise 'override me' }
+
+    let(:item) { Nanoc::Int::Item.new('contentz', {}, '/foo.md') }
+    let(:rep) { Nanoc::Int::ItemRep.new(item, :foo) }
+
+    shared_examples 'a non-moving snapshot with content' do
+      context 'no snapshot def' do
+        it 'raises' do
+          expect { subject }.to raise_error(Nanoc::Int::Errors::NoSuchSnapshot)
+        end
+      end
+
+      context 'snapshot def exists' do
+        before do
+          rep.snapshot_defs = [Nanoc::Int::SnapshotDef.new(snapshot_name)]
+          repo.set_all(rep, snapshot_name => content)
+        end
+
+        context 'content is textual' do
+          let(:content) { Nanoc::Int::TextualContent.new('hellos') }
+          it { is_expected.to eql('hellos') }
+        end
+
+        context 'content is binary' do
+          before { File.write('donkey.dat', 'binary data') }
+          let(:content) { Nanoc::Int::BinaryContent.new(File.expand_path('donkey.dat')) }
+
+          it 'raises' do
+            expect { subject }.to raise_error(Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem)
+          end
+        end
+      end
+    end
+
+    shared_examples 'a non-moving snapshot' do
+      include_examples 'a non-moving snapshot with content'
+
+      context 'snapshot def exists, but not content' do
+        before do
+          rep.snapshot_defs = [Nanoc::Int::SnapshotDef.new(snapshot_name)]
+          repo.set_all(rep, {})
+        end
+
+        it 'errors' do
+          expect { subject }.to yield_from_fiber(an_instance_of(Nanoc::Int::Errors::UnmetDependency))
+        end
+      end
+    end
+
+    shared_examples 'snapshot :last' do
+      context 'no snapshot def' do
+        it 'errors' do
+          expect { subject }.to raise_error(Nanoc::Int::Errors::NoSuchSnapshot)
+        end
+      end
+
+      context 'snapshot exists' do
+        context 'snapshot is not final' do
+          before do
+            rep.snapshot_defs = [Nanoc::Int::SnapshotDef.new(snapshot_name)]
+          end
+
+          context 'snapshot content does not exist' do
+            before do
+              repo.set_all(rep, {})
+            end
+
+            it 'errors' do
+              expect { subject }.to yield_from_fiber(an_instance_of(Nanoc::Int::Errors::UnmetDependency))
+            end
+          end
+
+          context 'snapshot content exists' do
+            context 'content is textual' do
+              before do
+                repo.set(rep, snapshot_name, Nanoc::Int::TextualContent.new('hellos'))
+              end
+
+              context 'not compiled' do
+                before { rep.compiled = false }
+
+                it 'raises' do
+                  expect { subject }.to yield_from_fiber(an_instance_of(Nanoc::Int::Errors::UnmetDependency))
+                end
+              end
+
+              context 'compiled' do
+                before { rep.compiled = true }
+
+                it { is_expected.to eql('hellos') }
+              end
+            end
+
+            context 'content is binary' do
+              before do
+                File.write('donkey.dat', 'binary data')
+                repo.set(rep, snapshot_name, Nanoc::Int::BinaryContent.new(File.expand_path('donkey.dat')))
+              end
+
+              context 'not compiled' do
+                before { rep.compiled = false }
+
+                it 'raises' do
+                  expect { subject }.to yield_from_fiber(an_instance_of(Nanoc::Int::Errors::UnmetDependency))
+                end
+              end
+
+              context 'compiled' do
+                before { rep.compiled = true }
+
+                it 'raises' do
+                  expect { subject }.to raise_error(Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem)
+                end
+              end
+            end
+          end
+        end
+
+        context 'snapshot is final' do
+          before do
+            rep.snapshot_defs = [Nanoc::Int::SnapshotDef.new(snapshot_name)]
+          end
+
+          context 'snapshot content does not exist' do
+            before do
+              repo.set_all(rep, {})
+            end
+
+            it 'errors' do
+              expect { subject }.to yield_from_fiber(an_instance_of(Nanoc::Int::Errors::UnmetDependency))
+            end
+          end
+
+          context 'snapshot content exists' do
+            context 'content is textual' do
+              before do
+                repo.set(rep, snapshot_name, Nanoc::Int::TextualContent.new('hellos'))
+              end
+
+              context 'not compiled' do
+                before { rep.compiled = false }
+
+                it 'errors' do
+                  expect { subject }.to yield_from_fiber(an_instance_of(Nanoc::Int::Errors::UnmetDependency))
+                end
+              end
+
+              context 'compiled' do
+                before { rep.compiled = true }
+
+                it { is_expected.to eql('hellos') }
+              end
+            end
+
+            context 'content is binary' do
+              before do
+                File.write('donkey.dat', 'binary data')
+                repo.set(rep, snapshot_name, Nanoc::Int::BinaryContent.new(File.expand_path('donkey.dat')))
+              end
+
+              context 'not compiled' do
+                before { rep.compiled = false }
+
+                it 'raises' do
+                  expect { subject }.to yield_from_fiber(an_instance_of(Nanoc::Int::Errors::UnmetDependency))
+                end
+              end
+
+              context 'compiled' do
+                before { rep.compiled = true }
+
+                it 'raises' do
+                  expect { subject }.to raise_error(Nanoc::Int::Errors::CannotGetCompiledContentOfBinaryItem)
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    context 'snapshot nil' do
+      let(:snapshot_name) { :last }
+      subject { repo.compiled_content(rep: rep, snapshot: nil) }
+      include_examples 'snapshot :last'
+    end
+
+    context 'snapshot not specified' do
+      subject { repo.compiled_content(rep: rep) }
+
+      context 'pre exists' do
+        before { repo.set(rep, :pre, Nanoc::Int::TextualContent.new('omg')) }
+        let(:snapshot_name) { :pre }
+        include_examples 'a non-moving snapshot with content'
+      end
+
+      context 'pre does not exist' do
+        let(:snapshot_name) { :last }
+        include_examples 'snapshot :last'
+      end
+    end
+
+    context 'snapshot :pre specified' do
+      let(:snapshot_name) { :pre }
+      include_examples 'a non-moving snapshot'
+    end
+
+    context 'snapshot :post specified' do
+      let(:snapshot_name) { :post }
+      include_examples 'a non-moving snapshot'
+    end
+
+    context 'snapshot :last specified' do
+      let(:snapshot_name) { :last }
+      include_examples 'snapshot :last'
+    end
+
+    context 'snapshot :donkey specified' do
+      let(:snapshot_name) { :donkey }
+      include_examples 'a non-moving snapshot'
+    end
+  end
+end

data/spec/nanoc/base/services/compiler/phases/cache_spec.rb

@@ -0,0 +1,107 @@
+describe Nanoc::Int::Compiler::Phases::Cache do
+  subject(:phase) do
+    described_class.new(
+      compiled_content_cache: compiled_content_cache,
+      snapshot_repo: snapshot_repo,
+      wrapped: wrapped,
+    )
+  end
+
+  let(:compiled_content_cache) do
+    Nanoc::Int::CompiledContentCache.new(env_name: nil, items: [item])
+  end
+
+  let(:snapshot_repo) { Nanoc::Int::SnapshotRepo.new }
+
+  let(:wrapped_class) do
+    Class.new do
+      def initialize(snapshot_repo)
+        @snapshot_repo = snapshot_repo
+      end
+
+      def run(rep, is_outdated:) # rubocop:disable Lint/UnusedMethodArgument
+        @snapshot_repo.set(rep, :last, Nanoc::Int::TextualContent.new('wrapped content'))
+      end
+    end
+  end
+
+  let(:wrapped) { wrapped_class.new(snapshot_repo) }
+
+  let(:item) { Nanoc::Int::Item.new('item content', {}, '/donkey.md') }
+  let(:rep) { Nanoc::Int::ItemRep.new(item, :latex) }
+
+  describe '#run' do
+    subject { phase.run(rep, is_outdated: is_outdated) }
+
+    let(:is_outdated) { raise 'override me' }
+
+    shared_examples 'calls wrapped' do
+      it 'delegates to wrapped' do
+        expect(wrapped).to receive(:run).with(rep, is_outdated: is_outdated)
+        subject
+      end
+
+      it 'marks rep as compiled' do
+        expect { subject }
+          .to change { rep.compiled? }
+          .from(false)
+          .to(true)
+      end
+
+      it 'sends no notifications' do
+        expect(Nanoc::Int::NotificationCenter).not_to receive(:post)
+        subject
+      end
+
+      it 'updates compiled content cache' do
+        expect { subject }
+          .to change { compiled_content_cache[rep] }
+          .from(nil)
+          .to(last: some_textual_content('wrapped content'))
+      end
+    end
+
+    context 'outdated' do
+      let(:is_outdated) { true }
+      include_examples 'calls wrapped'
+    end
+
+    context 'not outdated' do
+      let(:is_outdated) { false }
+
+      context 'cached compiled content available' do
+        before do
+          compiled_content_cache[rep] = { last: Nanoc::Int::TextualContent.new('cached') }
+        end
+
+        it 'reuses content from cache' do
+          expect { subject }
+            .to change { snapshot_repo.get(rep, :last) }
+            .from(nil)
+            .to(some_textual_content('cached'))
+        end
+
+        it 'marks rep as compiled' do
+          expect { subject }
+            .to change { rep.compiled? }
+            .from(false)
+            .to(true)
+        end
+
+        it 'does not change compiled content cache' do
+          expect { subject }
+            .not_to change { compiled_content_cache[rep] }
+        end
+
+        it 'sends notification' do
+          expect(Nanoc::Int::NotificationCenter).to receive(:post).with(:cached_content_used, rep)
+          subject
+        end
+      end
+
+      context 'no cached compiled content available' do
+        include_examples 'calls wrapped'
+      end
+    end
+  end
+end