nanoc 4.4.5 → 4.4.6

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

@@ -0,0 +1,55 @@
+describe Nanoc::Int::CompiledContentCache do
+  let(:cache) { described_class.new(items: items) }
+
+  let(:items) { [item] }
+
+  let(:item) { Nanoc::Int::Item.new('asdf', {}, '/foo.md') }
+  let(:item_rep) { Nanoc::Int::ItemRep.new(item, :default) }
+
+  let(:other_item) { Nanoc::Int::Item.new('asdf', {}, '/sneaky.md') }
+  let(:other_item_rep) { Nanoc::Int::ItemRep.new(other_item, :default) }
+
+  let(:content) { Nanoc::Int::Content.create('omg') }
+
+  it 'has no content by default' do
+    expect(cache[item_rep]).to be_nil
+  end
+
+  context 'setting content on known item' do
+    before { cache[item_rep] = { last: content } }
+
+    it 'has content' do
+      expect(cache[item_rep][:last].string).to eql('omg')
+    end
+
+    context 'after storing and loading' do
+      before do
+        cache.store
+        cache.load
+      end
+
+      it 'has content' do
+        expect(cache[item_rep][:last].string).to eql('omg')
+      end
+    end
+  end
+
+  context 'setting content on unknown item' do
+    before { cache[other_item_rep] = { last: content } }
+
+    it 'has content' do
+      expect(cache[other_item_rep][:last].string).to eql('omg')
+    end
+
+    context 'after storing and loading' do
+      before do
+        cache.store
+        cache.load
+      end
+
+      it 'has no content' do
+        expect(cache[other_item_rep]).to be_nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,243 @@
+describe Nanoc::Int::ConfigLoader do
+  let(:loader) { described_class.new }
+
+  describe '#new_from_cwd' do
+    subject { loader.new_from_cwd }
+
+    context 'no config file present' do
+      it 'errors' do
+        expect { subject }.to raise_error(
+          Nanoc::Int::ConfigLoader::NoConfigFileFoundError,
+        )
+      end
+    end
+
+    context 'config file present' do
+      before do
+        File.write('nanoc.yaml', YAML.dump(foo: 'bar'))
+      end
+
+      it 'returns a configuration' do
+        expect(subject).to be_a(Nanoc::Int::Configuration)
+      end
+
+      it 'has the defaults' do
+        expect(subject[:output_dir]).to eq('output')
+      end
+
+      it 'has the custom option' do
+        expect(subject[:foo]).to eq('bar')
+      end
+    end
+
+    context 'config file and parent present' do
+      before do
+        File.write('nanoc.yaml', YAML.dump(parent_config_file: 'parent.yaml'))
+        File.write('parent.yaml', YAML.dump(foo: 'bar'))
+      end
+
+      it 'returns the configuration' do
+        expect(subject).to be_a(Nanoc::Int::Configuration)
+      end
+
+      it 'has the defaults' do
+        expect(subject[:output_dir]).to eq('output')
+      end
+
+      it 'has the custom option' do
+        expect(subject[:foo]).to eq('bar')
+      end
+
+      it 'does not include parent config option' do
+        expect(subject[:parent_config_file]).to be_nil
+      end
+    end
+
+    context 'config file present, environment defined' do
+      let(:active_env_name) { 'default' }
+
+      let(:config) do
+        {
+          foo: 'bar',
+          tofoo: 'bar',
+          environments: {
+            test: { foo: 'test-bar' },
+            default: { foo: 'default-bar' },
+          },
+        }
+      end
+
+      before do
+        File.write('nanoc.yaml', YAML.dump(config))
+      end
+
+      before do
+        expect(ENV).to receive(:fetch).with('NANOC_ENV', 'default').and_return(active_env_name)
+      end
+
+      it 'returns the configuration' do
+        expect(subject).to be_a(Nanoc::Int::Configuration)
+      end
+
+      it 'has option defined not within environments' do
+        expect(subject[:tofoo]).to eq('bar')
+      end
+
+      context 'current env is test' do
+        let(:active_env_name) { 'test' }
+
+        it 'has the test environment custom option' do
+          expect(subject[:foo]).to eq('test-bar')
+        end
+      end
+
+      it 'has the default environment custom option' do
+        expect(subject[:foo]).to eq('default-bar')
+      end
+    end
+  end
+
+  describe '.cwd_is_nanoc_site? + .config_filename_for_cwd' do
+    context 'no config files' do
+      it 'is not considered a nanoc site dir' do
+        expect(described_class.cwd_is_nanoc_site?).to eq(false)
+        expect(described_class.config_filename_for_cwd).to be_nil
+      end
+    end
+
+    context 'nanoc.yaml config file' do
+      before do
+        File.write('nanoc.yaml', 'stuff')
+      end
+
+      it 'is considered a nanoc site dir' do
+        expect(described_class.cwd_is_nanoc_site?).to eq(true)
+        expect(described_class.config_filename_for_cwd).to eq(File.expand_path('nanoc.yaml'))
+      end
+    end
+
+    context 'config.yaml config file' do
+      before do
+        File.write('config.yaml', 'stuff')
+      end
+
+      it 'is considered a nanoc site dir' do
+        expect(described_class.cwd_is_nanoc_site?).to eq(true)
+        expect(described_class.config_filename_for_cwd).to eq(File.expand_path('config.yaml'))
+      end
+    end
+  end
+
+  describe '#apply_parent_config' do
+    subject { loader.apply_parent_config(config, processed_paths) }
+
+    let(:config) { Nanoc::Int::Configuration.new(hash: { foo: 'bar' }) }
+
+    let(:processed_paths) { ['nanoc.yaml'] }
+
+    context 'no parent_config_file' do
+      it 'returns self' do
+        expect(subject).to eq(config)
+      end
+    end
+
+    context 'parent config file is set' do
+      let(:config) do
+        Nanoc::Int::Configuration.new(hash: { parent_config_file: 'foo.yaml', foo: 'bar' })
+      end
+
+      context 'parent config file is not present' do
+        it 'errors' do
+          expect { subject }.to raise_error(
+            Nanoc::Int::ConfigLoader::NoParentConfigFileFoundError,
+          )
+        end
+      end
+
+      context 'parent config file is present' do
+        context 'parent-child cycle' do
+          before do
+            File.write('foo.yaml', 'parent_config_file: bar.yaml')
+            File.write('bar.yaml', 'parent_config_file: foo.yaml')
+          end
+
+          it 'errors' do
+            expect { subject }.to raise_error(
+              Nanoc::Int::ConfigLoader::CyclicalConfigFileError,
+            )
+          end
+        end
+
+        context 'self parent-child cycle' do
+          before do
+            File.write('foo.yaml', 'parent_config_file: foo.yaml')
+          end
+
+          it 'errors' do
+            expect { subject }.to raise_error(
+              Nanoc::Int::ConfigLoader::CyclicalConfigFileError,
+            )
+          end
+        end
+
+        context 'no parent-child cycle' do
+          before do
+            File.write('foo.yaml', 'animal: giraffe')
+          end
+
+          it 'returns a configuration' do
+            expect(subject).to be_a(Nanoc::Int::Configuration)
+          end
+
+          it 'has no defaults (added in #new_from_cwd only)' do
+            expect(subject[:output_dir]).to be_nil
+          end
+
+          it 'inherits options from parent' do
+            expect(subject[:animal]).to eq('giraffe')
+          end
+
+          it 'takes options from child' do
+            expect(subject[:foo]).to eq('bar')
+          end
+
+          it 'does not include parent config option' do
+            expect(subject[:parent_config_file]).to be_nil
+          end
+        end
+
+        context 'long parent chain' do
+          before do
+            File.write('foo.yaml', "parrots: 43\nparent_config_file: bar.yaml\n")
+            File.write('bar.yaml', "day_one: lasers\nslugs: false\n")
+          end
+
+          it 'returns a configuration' do
+            expect(subject).to be_a(Nanoc::Int::Configuration)
+          end
+
+          it 'has no defaults (added in #new_from_cwd only)' do
+            expect(subject[:output_dir]).to be_nil
+          end
+
+          it 'inherits options from grandparent' do
+            expect(subject[:day_one]).to eq('lasers')
+            expect(subject[:slugs]).to eq(false)
+          end
+
+          it 'inherits options from parent' do
+            expect(subject[:parrots]).to eq(43)
+          end
+
+          it 'takes options from child' do
+            expect(subject[:foo]).to eq('bar')
+          end
+
+          it 'does not include parent config option' do
+            expect(subject[:parent_config_file]).to be_nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,195 @@
+describe Nanoc::Int::DependencyStore do
+  let(:store) { described_class.new(objects) }
+
+  let(:objects) do
+    [obj_a, obj_b, obj_c]
+  end
+
+  let(:obj_a) { Nanoc::Int::Item.new('a', {}, '/a.md') }
+  let(:obj_b) { Nanoc::Int::Item.new('b', {}, '/b.md') }
+  let(:obj_c) { Nanoc::Int::Item.new('c', {}, '/c.md') }
+
+  describe '#dependencies_causing_outdatedness_of' do
+    context 'no dependencies' do
+      it 'returns nothing for each' do
+        expect(store.dependencies_causing_outdatedness_of(obj_a)).to be_empty
+        expect(store.dependencies_causing_outdatedness_of(obj_b)).to be_empty
+        expect(store.dependencies_causing_outdatedness_of(obj_c)).to be_empty
+      end
+    end
+
+    context 'one dependency' do
+      context 'no props' do
+        before do
+          # FIXME: weird argument order (obj_b depends on obj_a, not th other way around)
+          store.record_dependency(obj_a, obj_b)
+        end
+
+        it 'returns one dependency' do
+          deps = store.dependencies_causing_outdatedness_of(obj_a)
+          expect(deps.size).to eql(1)
+        end
+
+        it 'returns dependency from b to a' do
+          deps = store.dependencies_causing_outdatedness_of(obj_a)
+          expect(deps[0].from).to eql(obj_b)
+          expect(deps[0].to).to eql(obj_a)
+        end
+
+        it 'returns true for all props by default' do
+          deps = store.dependencies_causing_outdatedness_of(obj_a)
+          expect(deps[0].props.raw_content?).to eq(true)
+          expect(deps[0].props.attributes?).to eq(true)
+          expect(deps[0].props.compiled_content?).to eq(true)
+          expect(deps[0].props.path?).to eq(true)
+        end
+
+        it 'returns nothing for the others' do
+          expect(store.dependencies_causing_outdatedness_of(obj_b)).to be_empty
+          expect(store.dependencies_causing_outdatedness_of(obj_c)).to be_empty
+        end
+      end
+
+      context 'one prop' do
+        before do
+          # FIXME: weird argument order (obj_b depends on obj_a, not th other way around)
+          store.record_dependency(obj_a, obj_b, compiled_content: true)
+        end
+
+        it 'returns false for all unspecified props' do
+          deps = store.dependencies_causing_outdatedness_of(obj_a)
+          expect(deps[0].props.raw_content?).to eq(false)
+          expect(deps[0].props.attributes?).to eq(false)
+          expect(deps[0].props.path?).to eq(false)
+        end
+
+        it 'returns the specified props' do
+          deps = store.dependencies_causing_outdatedness_of(obj_a)
+          expect(deps[0].props.compiled_content?).to eq(true)
+        end
+      end
+
+      context 'two props' do
+        before do
+          # FIXME: weird argument order (obj_b depends on obj_a, not th other way around)
+          store.record_dependency(obj_a, obj_b, compiled_content: true)
+          store.record_dependency(obj_a, obj_b, attributes: true)
+        end
+
+        it 'returns false for all unspecified props' do
+          deps = store.dependencies_causing_outdatedness_of(obj_a)
+          expect(deps[0].props.raw_content?).to eq(false)
+          expect(deps[0].props.path?).to eq(false)
+        end
+
+        it 'returns the specified props' do
+          deps = store.dependencies_causing_outdatedness_of(obj_a)
+          expect(deps[0].props.attributes?).to eq(true)
+          expect(deps[0].props.compiled_content?).to eq(true)
+        end
+      end
+    end
+
+    context 'two dependency in a chain' do
+      before do
+        # FIXME: weird argument order (obj_b depends on obj_a, not th other way around)
+        store.record_dependency(obj_a, obj_b)
+        store.record_dependency(obj_b, obj_c)
+      end
+
+      it 'returns one dependency for object A' do
+        deps = store.dependencies_causing_outdatedness_of(obj_a)
+        expect(deps.size).to eql(1)
+        expect(deps[0].from).to eql(obj_b)
+      end
+
+      it 'returns one dependency for object B' do
+        deps = store.dependencies_causing_outdatedness_of(obj_b)
+        expect(deps.size).to eql(1)
+        expect(deps[0].from).to eql(obj_c)
+      end
+
+      it 'returns nothing for the others' do
+        expect(store.dependencies_causing_outdatedness_of(obj_c)).to be_empty
+      end
+    end
+  end
+
+  describe 'reloading' do
+    before do
+      store.record_dependency(obj_a, obj_b, compiled_content: true)
+      store.record_dependency(obj_a, obj_b, attributes: true)
+
+      store.store
+      store.objects = objects_after
+      store.load
+    end
+
+    context 'no new objects' do
+      let(:objects_after) { objects }
+
+      it 'has the right dependencies for item A' do
+        deps = store.dependencies_causing_outdatedness_of(obj_a)
+        expect(deps.size).to eql(1)
+
+        expect(deps[0].from).to eql(obj_b)
+        expect(deps[0].to).to eql(obj_a)
+
+        expect(deps[0].props.raw_content?).to eq(false)
+        expect(deps[0].props.attributes?).to eq(true)
+        expect(deps[0].props.compiled_content?).to eq(true)
+        expect(deps[0].props.path?).to eq(false)
+      end
+
+      it 'has the right dependencies for item B' do
+        deps = store.dependencies_causing_outdatedness_of(obj_b)
+        expect(deps).to be_empty
+      end
+
+      it 'has the right dependencies for item C' do
+        deps = store.dependencies_causing_outdatedness_of(obj_c)
+        expect(deps).to be_empty
+      end
+    end
+
+    context 'one new object' do
+      let(:objects_after) do
+        [obj_a, obj_b, obj_c, obj_d]
+      end
+
+      let(:obj_d) { Nanoc::Int::Item.new('d', {}, '/d.md') }
+
+      it 'marks existing items as outdated' do
+        expect(store.objects_causing_outdatedness_of(obj_a)).to eq([obj_d])
+        expect(store.objects_causing_outdatedness_of(obj_b)).to eq([obj_d])
+        expect(store.objects_causing_outdatedness_of(obj_c)).to eq([obj_d])
+      end
+
+      it 'marks new items as outdated' do
+        expect(store.objects_causing_outdatedness_of(obj_d)).to eq([obj_d])
+      end
+    end
+
+    context 'two new objects' do
+      let(:objects_after) do
+        [obj_a, obj_b, obj_c, obj_d, obj_e]
+      end
+
+      let(:obj_d) { Nanoc::Int::Item.new('d', {}, '/d.md') }
+      let(:obj_e) { Nanoc::Int::Item.new('e', {}, '/e.md') }
+
+      it 'marks existing items as outdated' do
+        # Only one of obj D or E needed!
+        expect(store.objects_causing_outdatedness_of(obj_a)).to eq([obj_d]).or eq([obj_e])
+        expect(store.objects_causing_outdatedness_of(obj_b)).to eq([obj_d]).or eq([obj_e])
+        expect(store.objects_causing_outdatedness_of(obj_c)).to eq([obj_d]).or eq([obj_e])
+      end
+
+      it 'marks new items as outdated' do
+        # Only one of obj D or E needed!
+        expect(store.objects_causing_outdatedness_of(obj_d)).to eq([obj_d]).or eq([obj_e])
+        expect(store.objects_causing_outdatedness_of(obj_e)).to eq([obj_d]).or eq([obj_e])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,214 @@
+describe Nanoc::Int::SiteLoader do
+  let(:loader) { described_class.new }
+
+  describe '#new_empty' do
+    subject { loader.new_empty }
+
+    it 'has the default configuration' do
+      expect(subject.config).to be_a(Nanoc::Int::Configuration)
+      expect(subject.config[:index_filenames]).to eq(['index.html'])
+    end
+
+    it 'has no code snippets' do
+      expect(subject.code_snippets).to be_empty
+    end
+
+    it 'has no items' do
+      expect(subject.items).to be_empty
+    end
+
+    it 'has no layouts' do
+      expect(subject.layouts).to be_empty
+    end
+  end
+
+  describe '#new_with_config' do
+    subject { loader.new_with_config(arg) }
+
+    let(:arg) { { foo: 'bar' } }
+
+    it 'has a slightly modified configuration' do
+      expect(subject.config).to be_a(Nanoc::Int::Configuration)
+      expect(subject.config[:index_filenames]).to eq(['index.html'])
+      expect(subject.config[:foo]).to eq('bar')
+    end
+
+    it 'has no code snippets' do
+      expect(subject.code_snippets).to be_empty
+    end
+
+    it 'has no items' do
+      expect(subject.items).to be_empty
+    end
+
+    it 'has no layouts' do
+      expect(subject.layouts).to be_empty
+    end
+  end
+
+  describe '#new_from_cwd' do
+    subject { loader.new_from_cwd }
+
+    context 'no config file' do
+      it 'errors' do
+        expect { subject }.to raise_error(
+          Nanoc::Int::ConfigLoader::NoConfigFileFoundError,
+        )
+      end
+    end
+
+    shared_examples 'a directory with a config file' do
+      it 'has the default configuration' do
+        expect(subject.config).to be_a(Nanoc::Int::Configuration)
+        expect(subject.config[:index_filenames]).to eq(['index.html'])
+        expect(subject.config[:foo]).to eq('bar')
+      end
+
+      it 'has no code snippets' do
+        expect(subject.code_snippets).to be_empty
+      end
+
+      it 'has no items' do
+        expect(subject.items).to be_empty
+      end
+
+      it 'has no layouts' do
+        expect(subject.layouts).to be_empty
+      end
+
+      context 'some items, layouts, and code snippets' do
+        before do
+          FileUtils.mkdir_p('lib')
+          File.write('lib/foo.rb', '$spirit_animal = :donkey')
+
+          FileUtils.mkdir_p('content')
+          File.write('content/about.md', 'I am Denis!')
+
+          FileUtils.mkdir_p('layouts')
+          File.write('layouts/page.erb', '<html><%= yield %></html>')
+        end
+
+        it 'has a code snippet' do
+          expect(subject.code_snippets.size).to eq(1)
+          expect(subject.code_snippets[0].data).to eq('$spirit_animal = :donkey')
+        end
+
+        it 'has an item' do
+          expect(subject.items.size).to eq(1)
+          expect(subject.items['/about.md'].content).to be_a(Nanoc::Int::TextualContent)
+          expect(subject.items['/about.md'].content.string).to eq('I am Denis!')
+          expect(subject.items['/about.md'].attributes[:content_filename])
+            .to eq('content/about.md')
+          expect(subject.items['/about.md'].attributes[:extension])
+            .to eq('md')
+          expect(subject.items['/about.md'].attributes[:filename])
+            .to eq('content/about.md')
+          expect(subject.items['/about.md'].attributes[:meta_filename])
+            .to be_nil
+          expect(subject.items['/about.md'].attributes[:mtime])
+            .to be > Time.now - 5
+          expect(subject.items['/about.md'].identifier.to_s).to eq('/about.md')
+        end
+
+        it 'has a layout' do
+          expect(subject.layouts.size).to eq(1)
+          expect(subject.layouts['/page.erb'].content).to be_a(Nanoc::Int::TextualContent)
+          expect(subject.layouts['/page.erb'].content.string).to eq('<html><%= yield %></html>')
+          expect(subject.layouts['/page.erb'].attributes[:content_filename])
+            .to eq('layouts/page.erb')
+          expect(subject.layouts['/page.erb'].attributes[:extension])
+            .to eq('erb')
+          expect(subject.layouts['/page.erb'].attributes[:filename])
+            .to eq('layouts/page.erb')
+          expect(subject.layouts['/page.erb'].attributes[:meta_filename])
+            .to be_nil
+          expect(subject.layouts['/page.erb'].attributes[:mtime])
+            .to be > Time.now - 5
+          expect(subject.layouts['/page.erb'].identifier.to_s).to eq('/page.erb')
+        end
+      end
+    end
+
+    context 'nanoc.yaml config file' do
+      before do
+        File.write('nanoc.yaml', "---\nfoo: bar\n")
+      end
+
+      it_behaves_like 'a directory with a config file'
+    end
+
+    context 'config.yaml config file' do
+      before do
+        File.write('config.yaml', "---\nfoo: bar\n")
+      end
+
+      it_behaves_like 'a directory with a config file'
+    end
+
+    context 'configuration has non-existant data source' do
+      before do
+        File.write('nanoc.yaml', <<-EOS.gsub(/^ {10}/, ''))
+          data_sources:
+            - type: eenvaleed
+        EOS
+      end
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(Nanoc::Int::Errors::UnknownDataSource)
+      end
+    end
+
+    context 'environments defined' do
+      before do
+        File.write('nanoc.yaml', <<-EOS.gsub(/^ {10}/, ''))
+          animal: donkey
+          environments:
+            staging:
+              animal: giraffe
+        EOS
+      end
+
+      before do
+        expect(ENV).to receive(:fetch).with('NANOC_ENV', 'default').and_return('staging')
+      end
+
+      it 'does not load environment' do
+        expect(subject.config[:animal]).to eq('giraffe')
+      end
+    end
+
+    context 'code snippet with data source implementation' do
+      before do
+        FileUtils.mkdir_p('lib')
+        File.write('lib/foo_data_source.rb', <<-EOS.gsub(/^ {10}/, ''))
+          class FooDataSource < Nanoc::DataSource
+            identifier :site_loader_spec_sample
+
+            def items
+              [
+                Nanoc::Int::Item.new(
+                  'Generated content!',
+                  { generated: true },
+                  '/generated.txt',
+                )
+              ]
+            end
+          end
+        EOS
+
+        File.write('nanoc.yaml', <<-EOS.gsub(/^ {10}/, ''))
+          data_sources:
+            - type: site_loader_spec_sample
+        EOS
+      end
+
+      it 'loads code snippets before items/layouts' do
+        expect(subject.items.size).to eq(1)
+        expect(subject.items['/generated.txt'].content).to be_a(Nanoc::Int::TextualContent)
+        expect(subject.items['/generated.txt'].content.string).to eq('Generated content!')
+        expect(subject.items['/generated.txt'].attributes).to eq(generated: true)
+        expect(subject.items['/generated.txt'].identifier.to_s).to eq('/generated.txt')
+      end
+    end
+  end
+end