nanoc 4.4.5 → 4.4.6

data/spec/nanoc/cli/commands/deploy_spec.rb

@@ -0,0 +1,327 @@
+describe Nanoc::CLI::Commands::Shell, site: true, stdio: true do
+  describe '#run' do
+    let(:config) { {} }
+
+    before do
+      # Prevent double-loading
+      expect(Nanoc::CLI).to receive(:setup)
+
+      File.write('nanoc.yaml', YAML.dump(config))
+    end
+
+    shared_examples 'no effective deploy' do
+      it 'does not write any files' do
+        expect { run rescue nil }.not_to change { Dir['remote/*'] }
+        expect(Dir['remote/*']).to be_empty
+      end
+    end
+
+    shared_examples 'effective deploy' do
+      it 'writes files' do
+        expect { run }.to change { Dir['remote/*'] }.from([]).to(['remote/success.txt'])
+        expect(File.read('remote/success.txt')).to eql('hurrah')
+      end
+    end
+
+    shared_examples 'attempted/effective deploy' do
+      context 'no checks' do
+        include_examples 'effective deploy'
+      end
+
+      context 'checks fail' do
+        before do
+          File.write(
+            'Checks',
+            "check :donkey do\n" \
+            "  add_issue('things are broken', subject: 'success.txt')\n" \
+            "end\n" \
+            "\n" \
+            "deploy_check :donkey\n",
+          )
+        end
+
+        include_examples 'no effective deploy'
+
+        context 'checks disabled' do
+          context '--no-check' do
+            let(:command) { super() + ['--no-check'] }
+            include_examples 'effective deploy'
+          end
+
+          context '--Ck' do
+            let(:command) { super() + ['-C'] }
+            include_examples 'effective deploy'
+          end
+        end
+      end
+
+      context 'checks pass' do
+        before do
+          File.write(
+            'Checks',
+            "check :donkey do\n" \
+            "end\n" \
+            "\n" \
+            "deploy_check :donkey\n",
+          )
+        end
+
+        include_examples 'effective deploy'
+      end
+    end
+
+    describe 'listing deployers' do
+      shared_examples 'lists all deployers' do
+        let(:run) { Nanoc::CLI.run(command) }
+
+        it 'lists all deployers' do
+          expect { run }.to output(/Available deployers:\n  fog\n  rsync/).to_stdout
+        end
+
+        include_examples 'no effective deploy'
+      end
+
+      context '--list-deployers' do
+        let(:command) { %w(deploy --list-deployers) }
+        include_examples 'lists all deployers'
+      end
+
+      context '-D' do
+        let(:command) { %w(deploy -D) }
+        include_examples 'lists all deployers'
+      end
+    end
+
+    describe 'listing deployment configurations' do
+      shared_examples 'lists all deployment configurations' do
+        let(:run) { Nanoc::CLI.run(command) }
+
+        context 'no deployment configurations' do
+          let(:config) { { donkeys: 'lots' } }
+
+          it 'says nothing is found' do
+            expect { run }.to output(/No deployment configurations./).to_stdout
+          end
+
+          include_examples 'no effective deploy'
+        end
+
+        context 'some deployment configurations' do
+          let(:config) do
+            {
+              deploy: {
+                production: {
+                  kind: 'rsync',
+                  dst: 'remote',
+                },
+                staging: {
+                  kind: 'rsync',
+                  dst: 'remote',
+                },
+              },
+            }
+          end
+
+          it 'says some targets are found' do
+            expect { run }.to output(/Available deployment configurations:\n  production\n  staging/).to_stdout
+          end
+
+          include_examples 'no effective deploy'
+        end
+      end
+
+      context '--list' do
+        let(:command) { %w(deploy --list) }
+        include_examples 'lists all deployment configurations'
+      end
+
+      context '-L' do
+        let(:command) { %w(deploy -L) }
+        include_examples 'lists all deployment configurations'
+      end
+    end
+
+    describe 'deploying' do
+      let(:run) { Nanoc::CLI.run(command) }
+      let(:command) { %w(deploy) }
+
+      before do
+        FileUtils.mkdir_p('output')
+        FileUtils.mkdir_p('remote')
+        File.write('output/success.txt', 'hurrah')
+      end
+
+      shared_examples 'missing kind warning' do
+        it 'warns about missing kind' do
+          expect { run }.to output(/Warning: The specified deploy target does not have a kind attribute. Assuming rsync./).to_stderr
+        end
+      end
+
+      context 'no deploy configs' do
+        it 'errors' do
+          expect { run }.to raise_error(
+            Nanoc::Int::Errors::GenericTrivial,
+            'The site has no deployment configurations.',
+          )
+        end
+
+        include_examples 'no effective deploy'
+
+        context 'configuration created in preprocessor' do
+          before do
+            File.write(
+              'Rules',
+              "preprocess do\n" \
+              "  @config[:deploy] = {\n" \
+              "    default: { dst: 'remote' },\n" \
+              "  }\n" \
+              "end\n\n" + File.read('Rules'),
+            )
+          end
+
+          include_examples 'attempted/effective deploy'
+        end
+      end
+
+      context 'some deploy configs' do
+        let(:config) do
+          {
+            deploy: {
+              irrelevant: {
+                kind: 'rsync',
+                dst: 'remote',
+              },
+            },
+          }
+        end
+
+        context 'default target' do
+          context 'requested deploy config does not exist' do
+            it 'errors' do
+              expect { run }.to raise_error(
+                Nanoc::Int::Errors::GenericTrivial,
+                'The site has no deployment configuration named `default`.',
+              )
+            end
+
+            include_examples 'no effective deploy'
+          end
+
+          context 'requested deploy config exists' do
+            let(:config) do
+              {
+                deploy: {
+                  default: {
+                    kind: 'rsync',
+                    dst: 'remote',
+                  },
+                },
+              }
+            end
+
+            include_examples 'attempted/effective deploy'
+
+            context 'dry run' do
+              let(:command) { super() + ['--dry-run'] }
+              include_examples 'no effective deploy'
+            end
+          end
+
+          context 'requested deploy config exists, but has no kind' do
+            let(:config) do
+              {
+                deploy: {
+                  default: {
+                    dst: 'remote',
+                  },
+                },
+              }
+            end
+
+            include_examples 'attempted/effective deploy'
+            include_examples 'missing kind warning'
+
+            context 'dry run' do
+              let(:command) { super() + ['--dry-run'] }
+              include_examples 'no effective deploy'
+            end
+          end
+        end
+
+        shared_examples 'deploy with non-default target' do
+          context 'requested deploy config does not exist' do
+            it 'errors' do
+              expect { run }.to raise_error(
+                Nanoc::Int::Errors::GenericTrivial,
+                'The site has no deployment configuration named `production`.',
+              )
+            end
+
+            include_examples 'no effective deploy'
+          end
+
+          context 'requested deploy config exists' do
+            let(:config) do
+              {
+                deploy: {
+                  production: {
+                    kind: 'rsync',
+                    dst: 'remote',
+                  },
+                },
+              }
+            end
+
+            include_examples 'attempted/effective deploy'
+
+            context 'dry run' do
+              let(:command) { (super() + ['--dry-run']) }
+              include_examples 'no effective deploy'
+            end
+          end
+
+          context 'requested deploy config exists, but has no kind' do
+            let(:config) do
+              {
+                deploy: {
+                  production: {
+                    dst: 'remote',
+                  },
+                },
+              }
+            end
+
+            include_examples 'attempted/effective deploy'
+            include_examples 'missing kind warning'
+
+            context 'dry run' do
+              let(:command) { (super() + ['--dry-run']) }
+              include_examples 'no effective deploy'
+            end
+          end
+        end
+
+        context 'non-default target, specified as argument' do
+          let(:command) { %w(deploy production) }
+          include_examples 'deploy with non-default target'
+        end
+
+        context 'non-default target, specified as option (--target)' do
+          let(:command) { %w(deploy --target production) }
+          include_examples 'deploy with non-default target'
+        end
+
+        context 'multiple targets specified' do
+          let(:command) { %w(deploy --target staging production) }
+
+          it 'errors' do
+            expect { run }.to raise_error(
+              Nanoc::Int::Errors::GenericTrivial,
+              'Only one deployment target can be specified on the command line.',
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/spec/nanoc/cli/commands/shell_spec.rb

@@ -0,0 +1,54 @@
+describe Nanoc::CLI::Commands::Shell, site: true, stdio: true do
+  describe '#run' do
+    before do
+      # Prevent double-loading
+      expect(Nanoc::CLI).to receive(:setup)
+    end
+
+    it 'can be invoked' do
+      context = Object.new
+      allow(Nanoc::Int::Context).to receive(:new).with(anything).and_return(context)
+      expect(context).to receive(:pry)
+
+      Nanoc::CLI.run(['shell'])
+    end
+  end
+
+  describe '#env_for_site' do
+    subject { described_class.env_for_site(site) }
+
+    before do
+      File.write('content/hello.md', 'Hello!')
+      File.write('layouts/default.erb', '<title>MY SITE!</title><%= yield %>')
+    end
+
+    let(:site) do
+      Nanoc::Int::SiteLoader.new.new_from_cwd
+    end
+
+    it 'returns views' do
+      expect(subject[:items]).to be_a(Nanoc::ItemCollectionWithRepsView)
+      expect(subject[:layouts]).to be_a(Nanoc::LayoutCollectionView)
+      expect(subject[:config]).to be_a(Nanoc::ConfigView)
+    end
+
+    it 'returns correct items' do
+      expect(subject[:items].size).to eq(1)
+      expect(subject[:items].first.identifier.to_s).to eq('/hello.md')
+    end
+
+    it 'returns correct layouts' do
+      expect(subject[:layouts].size).to eq(1)
+      expect(subject[:layouts].first.identifier.to_s).to eq('/default.erb')
+    end
+
+    it 'returns items with reps' do
+      expect(subject[:items].first.reps).not_to be_nil
+      expect(subject[:items].first.reps.first.name).to eq(:default)
+    end
+
+    it 'returns items with rep paths' do
+      expect(subject[:items].first.reps.first.path).to eq('/hello.md')
+    end
+  end
+end

data/spec/nanoc/cli/commands/show_data_spec.rb

@@ -0,0 +1,126 @@
+describe Nanoc::CLI::Commands::ShowData, stdio: true do
+  describe '#print_item_dependencies' do
+    subject { runner.send(:print_item_dependencies, items, dependency_store) }
+
+    let(:runner) do
+      described_class.new(options, arguments, command)
+    end
+
+    let(:options) { {} }
+    let(:arguments) { [] }
+    let(:command) { double(:command) }
+
+    let(:items) do
+      Nanoc::Int::IdentifiableCollection.new(config).tap do |ic|
+        ic << item_about
+        ic << item_dog
+        ic << item_other
+      end
+    end
+
+    let(:item_about) { Nanoc::Int::Item.new('About Me', {}, '/about.md') }
+    let(:item_dog)   { Nanoc::Int::Item.new('About My Dog', {}, '/dog.md') }
+    let(:item_other) { Nanoc::Int::Item.new('Raw Data', {}, '/other.dat') }
+
+    let(:config) { Nanoc::Int::Configuration.new }
+
+    let(:dependency_store) do
+      Nanoc::Int::DependencyStore.new(objects)
+    end
+
+    let(:objects) do
+      items.to_a + layouts.to_a
+    end
+
+    let(:layouts) do
+      Nanoc::Int::IdentifiableCollection.new(config).tap do |ic|
+      end
+    end
+
+    it 'prints a legend' do
+      expect { subject }.to output(%r{Item dependencies =+\n\nLegend:}).to_stdout
+    end
+
+    context 'no dependencies' do
+      it 'outputs no dependencies for /about.md' do
+        expect { subject }.to output(%r{^item /about.md depends on:\n  \(nothing\)$}m).to_stdout
+      end
+
+      it 'outputs no dependencies for /dog.md' do
+        expect { subject }.to output(%r{^item /dog.md depends on:\n  \(nothing\)$}m).to_stdout
+      end
+
+      it 'outputs no dependencies for /other.dat' do
+        expect { subject }.to output(%r{^item /other.dat depends on:\n  \(nothing\)$}m).to_stdout
+      end
+    end
+
+    context 'dependency (without props) from about to dog' do
+      before do
+        dependency_store.record_dependency(item_dog, item_about)
+      end
+
+      it 'outputs no dependencies for /about.md' do
+        expect { subject }.to output(%r{^item /about.md depends on:\n  \(nothing\)$}m).to_stdout
+      end
+
+      it 'outputs dependencies for /dog.md' do
+        expect { subject }.to output(%r{^item /dog.md depends on:\n  \[   item \] \(racp\) /about.md$}m).to_stdout
+      end
+
+      it 'outputs no dependencies for /other.dat' do
+        expect { subject }.to output(%r{^item /other.dat depends on:\n  \(nothing\)$}m).to_stdout
+      end
+    end
+
+    context 'dependency (with raw_content prop) from about to dog' do
+      before do
+        dependency_store.record_dependency(item_dog, item_about, raw_content: true)
+      end
+
+      it 'outputs dependencies for /dog.md' do
+        expect { subject }.to output(%r{^item /dog.md depends on:\n  \[   item \] \(r___\) /about.md$}m).to_stdout
+      end
+    end
+
+    context 'dependency (with attributes prop) from about to dog' do
+      before do
+        dependency_store.record_dependency(item_dog, item_about, attributes: true)
+      end
+
+      it 'outputs dependencies for /dog.md' do
+        expect { subject }.to output(%r{^item /dog.md depends on:\n  \[   item \] \(_a__\) /about.md$}m).to_stdout
+      end
+    end
+
+    context 'dependency (with compiled_content prop) from about to dog' do
+      before do
+        dependency_store.record_dependency(item_dog, item_about, compiled_content: true)
+      end
+
+      it 'outputs dependencies for /dog.md' do
+        expect { subject }.to output(%r{^item /dog.md depends on:\n  \[   item \] \(__c_\) /about.md$}m).to_stdout
+      end
+    end
+
+    context 'dependency (with path prop) from about to dog' do
+      before do
+        dependency_store.record_dependency(item_dog, item_about, path: true)
+      end
+
+      it 'outputs dependencies for /dog.md' do
+        expect { subject }.to output(%r{^item /dog.md depends on:\n  \[   item \] \(___p\) /about.md$}m).to_stdout
+      end
+    end
+
+    context 'dependency (with multiple props) from about to dog' do
+      before do
+        dependency_store.record_dependency(item_dog, item_about, attributes: true, raw_content: true)
+      end
+
+      it 'outputs dependencies for /dog.md' do
+        expect { subject }.to output(%r{^item /dog.md depends on:\n  \[   item \] \(ra__\) /about.md$}m).to_stdout
+      end
+    end
+  end
+end

data/spec/nanoc/cli/commands/show_rules_spec.rb

@@ -0,0 +1,112 @@
+describe Nanoc::CLI::Commands::ShowRules, stdio: true do
+  describe '#run' do
+    subject { runner.run }
+
+    let(:runner) do
+      described_class.new(options, arguments, command).tap do |runner|
+        runner.site = site
+      end
+    end
+
+    let(:options) { {} }
+
+    let(:arguments) { [] }
+
+    let(:command) { double(:command) }
+
+    let(:site) do
+      double(
+        :site,
+        items: items,
+        layouts: layouts,
+        compiler: compiler,
+      )
+    end
+
+    let(:items) do
+      Nanoc::Int::IdentifiableCollection.new(config).tap do |ic|
+        ic << Nanoc::Int::Item.new('About Me', {}, '/about.md')
+        ic << Nanoc::Int::Item.new('About My Dog', {}, '/dog.md')
+        ic << Nanoc::Int::Item.new('Raw Data', {}, '/other.dat')
+      end
+    end
+
+    let(:reps) do
+      Nanoc::Int::ItemRepRepo.new.tap do |reps|
+        reps << Nanoc::Int::ItemRep.new(items['/about.md'], :default)
+        reps << Nanoc::Int::ItemRep.new(items['/about.md'], :text)
+        reps << Nanoc::Int::ItemRep.new(items['/dog.md'], :default)
+        reps << Nanoc::Int::ItemRep.new(items['/dog.md'], :text)
+        reps << Nanoc::Int::ItemRep.new(items['/other.dat'], :default)
+      end
+    end
+
+    let(:layouts) do
+      Nanoc::Int::IdentifiableCollection.new(config).tap do |ic|
+        ic << Nanoc::Int::Layout.new('Default', {}, '/default.erb')
+        ic << Nanoc::Int::Layout.new('Article', {}, '/article.haml')
+        ic << Nanoc::Int::Layout.new('Other', {}, '/other.xyzzy')
+      end
+    end
+
+    let(:config) { Nanoc::Int::Configuration.new }
+
+    let(:action_provider) { double(:action_provider, rules_collection: rules_collection) }
+    let(:compiler) { double(:compiler, action_provider: action_provider, reps: reps) }
+
+    let(:rules_collection) do
+      Nanoc::RuleDSL::RulesCollection.new.tap do |rc|
+        rc.add_item_compilation_rule(
+          Nanoc::RuleDSL::Rule.new(Nanoc::Int::Pattern.from('/dog.*'), :default, proc {}),
+        )
+        rc.add_item_compilation_rule(
+          Nanoc::RuleDSL::Rule.new(Nanoc::Int::Pattern.from('/*.md'), :default, proc {}),
+        )
+        rc.add_item_compilation_rule(
+          Nanoc::RuleDSL::Rule.new(Nanoc::Int::Pattern.from('/**/*'), :text, proc {}),
+        )
+
+        rc.layout_filter_mapping[Nanoc::Int::Pattern.from('/*.haml')] = [:haml, {}]
+        rc.layout_filter_mapping[Nanoc::Int::Pattern.from('/*.erb')] = [:erb, {}]
+      end
+    end
+
+    let(:expected_out) do
+      <<-EOS
+        \e[1m\e[33mItem /about.md\e[0m:
+          Rep default: /*.md
+          Rep text: /**/*
+
+        \e[1m\e[33mItem /dog.md\e[0m:
+          Rep default: /dog.*
+          Rep text: /**/*
+
+        \e[1m\e[33mItem /other.dat\e[0m:
+          Rep default: (none)
+
+        \e[1m\e[33mLayout /article.haml\e[0m:
+          /*.haml
+
+        \e[1m\e[33mLayout /default.erb\e[0m:
+          /*.erb
+
+        \e[1m\e[33mLayout /other.xyzzy\e[0m:
+          (none)
+
+      EOS
+        .gsub(/^ {8}/, '')
+    end
+
+    before do
+      expect(compiler).to receive(:build_reps).once
+    end
+
+    it 'writes item and layout rules to stdout' do
+      expect { subject }.to output(expected_out).to_stdout
+    end
+
+    it 'writes status informaion to stderr' do
+      expect { subject }.to output("Loading site… done\n").to_stderr
+    end
+  end
+end

data/spec/nanoc/cli/commands/view_spec.rb

@@ -0,0 +1,58 @@
+describe Nanoc::CLI::Commands::View, site: true, stdio: true do
+  describe '#run' do
+    def run_nanoc_cmd(cmd)
+      pid = fork { Nanoc::CLI.run(cmd) }
+
+      # Wait for server to start up
+      20.times do |i|
+        begin
+          Net::HTTP.get('127.0.0.1', '/', 50_385)
+        rescue Errno::ECONNREFUSED, Errno::ECONNRESET
+          sleep(0.1 * 1.2**i)
+          retry
+        end
+        break
+      end
+
+      yield
+    ensure
+      Process.kill('TERM', pid)
+    end
+
+    context 'default configuration' do
+      it 'serves /index.html as /' do
+        File.write('output/index.html', 'Hello there! Nanoc loves you! <3')
+        run_nanoc_cmd(['view', '--port', '50385']) do
+          expect(Net::HTTP.get('127.0.0.1', '/', 50_385)).to eql('Hello there! Nanoc loves you! <3')
+        end
+      end
+
+      it 'does not serve /index.xhtml as /' do
+        File.write('output/index.xhtml', 'Hello there! Nanoc loves you! <3')
+        run_nanoc_cmd(['view', '--port', '50385']) do
+          expect(Net::HTTP.get('127.0.0.1', '/', 50_385)).to eql("File not found: /\n")
+        end
+      end
+    end
+
+    context 'index_filenames including index.xhtml' do
+      before do
+        File.write('nanoc.yaml', 'index_filenames: [index.xhtml]')
+      end
+
+      it 'serves /index.xhtml as /' do
+        File.write('output/index.xhtml', 'Hello there! Nanoc loves you! <3')
+        run_nanoc_cmd(['view', '--port', '50385']) do
+          expect(Net::HTTP.get('127.0.0.1', '/', 50_385)).to eql('Hello there! Nanoc loves you! <3')
+        end
+      end
+    end
+
+    it 'does not serve other files as /' do
+      File.write('output/index.html666', 'Hello there! Nanoc loves you! <3')
+      run_nanoc_cmd(['view', '--port', '50385']) do
+        expect(Net::HTTP.get('127.0.0.1', '/', 50_385)).to eql("File not found: /\n")
+      end
+    end
+  end
+end