nanoc 4.4.7 → 4.5.0

data/lib/nanoc/filters/relativize_paths.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class RelativizePaths < Nanoc::Filter
+    identifier :relativize_paths
+
     require 'nanoc/helpers/link_to'
     include Nanoc::Helpers::LinkTo
 

data/lib/nanoc/filters/rubypants.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class RubyPants < Nanoc::Filter
+    identifier :rubypants
+
     requires 'rubypants'
 
     # Runs the content through [RubyPants](http://rubydoc.info/gems/rubypants/).

data/lib/nanoc/filters/sass.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Sass < Nanoc::Filter
+    identifier :sass
+
     requires 'sass', 'nanoc/filters/sass/sass_filesystem_importer'
 
     # Runs the content through [Sass](http://sass-lang.com/).

data/lib/nanoc/filters/slim.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Slim < Nanoc::Filter
+    identifier :slim
+
     requires 'slim'
 
     # Runs the content through [Slim](http://slim-lang.com/).

data/lib/nanoc/filters/typogruby.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class Typogruby < Nanoc::Filter
+    identifier :typogruby
+
     requires 'typogruby'
 
     # Runs the content through [Typogruby](http://avdgaag.github.com/typogruby/).

data/lib/nanoc/filters/uglify_js.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class UglifyJS < Nanoc::Filter
+    identifier :uglify_js
+
     requires 'uglifier'
 
     # Runs the content through [UglifyJS](https://github.com/mishoo/UglifyJS2/).

data/lib/nanoc/filters/xsl.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class XSL < Nanoc::Filter
+    identifier :xsl
+
     requires 'nokogiri'
 
     # Runs the item content through an [XSLT](http://www.w3.org/TR/xslt)

data/lib/nanoc/filters/yui_compressor.rb

@@ -1,6 +1,8 @@
 module Nanoc::Filters
   # @api private
   class YUICompressor < Nanoc::Filter
+    identifier :yui_compressor
+
     requires 'yuicompressor'
 
     # Compress Javascript or CSS using [YUICompressor](http://rubydoc.info/gems/yuicompressor).

data/lib/nanoc/helpers.rb

@@ -1,13 +1,14 @@
 module Nanoc::Helpers
-  autoload 'Blogging',    'nanoc/helpers/blogging'
-  autoload 'Breadcrumbs', 'nanoc/helpers/breadcrumbs'
-  autoload 'Capturing',   'nanoc/helpers/capturing'
-  autoload 'ChildParent', 'nanoc/helpers/child_parent'
-  autoload 'Filtering',   'nanoc/helpers/filtering'
-  autoload 'HTMLEscape',  'nanoc/helpers/html_escape'
-  autoload 'LinkTo',      'nanoc/helpers/link_to'
-  autoload 'Rendering',   'nanoc/helpers/rendering'
-  autoload 'Tagging',     'nanoc/helpers/tagging'
-  autoload 'Text',        'nanoc/helpers/text'
-  autoload 'XMLSitemap',  'nanoc/helpers/xml_sitemap'
 end
+
+require_relative 'helpers/blogging'
+require_relative 'helpers/breadcrumbs'
+require_relative 'helpers/capturing'
+require_relative 'helpers/child_parent'
+require_relative 'helpers/filtering'
+require_relative 'helpers/html_escape'
+require_relative 'helpers/link_to'
+require_relative 'helpers/rendering'
+require_relative 'helpers/tagging'
+require_relative 'helpers/text'
+require_relative 'helpers/xml_sitemap'

data/lib/nanoc/version.rb

@@ -1,4 +1,4 @@
 module Nanoc
   # The current Nanoc version.
-  VERSION = '4.4.7'.freeze
+  VERSION = '4.5.0'.freeze
 end

data/nanoc.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('cri', '~> 2.3')
   s.add_runtime_dependency('hamster', '~> 3.0')
   s.add_runtime_dependency('ref', '~> 2.0')
+  s.add_runtime_dependency('ddplugin', '~> 1.0')
 
   s.add_development_dependency('bundler', '>= 1.7.10', '< 2.0')
   s.add_development_dependency('appraisal', '~> 2.1')

data/spec/nanoc/base/filter_spec.rb

@@ -1,7 +1,7 @@
 describe Nanoc::Filter do
   describe '.define' do
     context 'simple filter' do
-      let(:filter_name) { 'b5355bbb4d772b9853d21be57da614dba521dbbb' }
+      let(:filter_name) { :b5355bbb4d772b9853d21be57da614dba521dbbb }
       let(:filter_class) { Nanoc::Filter.named(filter_name) }
 
       before do
@@ -20,7 +20,7 @@ describe Nanoc::Filter do
     end
 
     context 'filter that accesses assigns' do
-      let(:filter_name) { 'd7ed105d460e99a3d38f46af023d9490c140fdd9' }
+      let(:filter_name) { :d7ed105d460e99a3d38f46af023d9490c140fdd9 }
       let(:filter_class) { Nanoc::Filter.named(filter_name) }
       let(:filter) { filter_class.new(assigns) }
       let(:assigns) { { animal: 'Giraffe' } }

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

@@ -1,4 +1,4 @@
-describe Nanoc::CLI::Commands::Shell, site: true, stdio: true do
+describe Nanoc::CLI::Commands::Deploy, site: true, stdio: true do
   describe '#run' do
     let(:config) { {} }
 
@@ -75,7 +75,7 @@ describe Nanoc::CLI::Commands::Shell, site: true, stdio: true do
         let(:run) { Nanoc::CLI.run(command) }
 
         it 'lists all deployers' do
-          expect { run }.to output(/Available deployers:\n  fog\n  rsync/).to_stdout
+          expect { run }.to output(/Available deployers:\n  fog\n  git\n  rsync/).to_stdout
         end
 
         include_examples 'no effective deploy'

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

@@ -0,0 +1,18 @@
+describe Nanoc::CLI::Commands::ShowPlugins, site: true, stdio: true do
+  describe '#run' do
+    it 'can be invoked' do
+      Nanoc::CLI.run(['show-plugins'])
+    end
+
+    context 'site with plugins' do
+      before do
+        File.write('lib/default.rb', 'Nanoc::Filter.define(:show_plugins_x) {}')
+      end
+
+      it 'outputs show_plugins_x under the right section' do
+        expect { Nanoc::CLI.run(['show-plugins']) }
+          .to output(/  custom:\n    show_plugins_x/).to_stdout
+      end
+    end
+  end
+end

data/spec/nanoc/deploying/git_spec.rb

@@ -0,0 +1,302 @@
+describe Nanoc::Deploying::Deployers::Git, stdio: true do
+  let(:deployer) { described_class.new(output_dir, options, dry_run: dry_run) }
+
+  subject { deployer.run }
+
+  let(:output_dir) { 'output/' }
+  let(:options) { remote_options.merge(branch_options).merge(forced_options) }
+  let(:dry_run) { false }
+
+  let(:remote_options) { {} }
+  let(:branch_options) { {} }
+  let(:forced_options) { {} }
+
+  def run_and_get_stdout(*args)
+    stdout = ''
+    piper = Nanoc::Extra::Piper.new(stdout: stdout, stderr: '')
+    piper.run(args, '')
+    stdout
+  end
+
+  def add_changes_to_remote
+    system('git', 'init', '--quiet', 'rere_tmp')
+    Dir.chdir('rere_tmp') do
+      system('git', 'config', 'user.name', 'Zebra Platypus')
+      system('git', 'config', 'user.email', 'zebra@platypus.example.com')
+      system('git', 'remote', 'add', 'origin', '../rere')
+
+      File.write('evil.txt', 'muaha')
+      system('git', 'add', 'evil.txt')
+      system('git', 'commit', '--quiet', '-m', 'muaha')
+      system('git', 'checkout', '--quiet', '-b', 'giraffe')
+      system('git', 'push', '--quiet', 'origin', 'master')
+      system('git', 'push', '--quiet', 'origin', 'giraffe')
+    end
+  end
+
+  def rev_list
+    run_and_get_stdout('git', 'rev-list', '--objects', '--all')
+  end
+
+  shared_examples 'branch configured properly' do
+    context 'clean working copy' do
+      it 'does not commit or push' do
+        subject
+      end
+    end
+
+    context 'non-clean working copy' do
+      before do
+        Dir.chdir(output_dir) { File.write('hello.txt', 'Hi there') }
+      end
+
+      shared_examples 'successful push' do
+        context 'no dry run' do
+          it 'outputs status' do
+            expect { subject }
+              .to output(/Deploying via Git to branch “#{branch}” on remote “#{remote}”…/)
+              .to_stdout
+          end
+
+          it 'makes a change in the local repo' do
+            expect { subject }
+              .to change { Dir.chdir(output_dir) { rev_list } }
+              .from(not_match(/^[a-f0-9]{40} hello\.txt$/))
+              .to(match(/^[a-f0-9]{40} hello\.txt$/))
+
+            expect(Dir.chdir(output_dir) { run_and_get_stdout('git', 'show', branch) })
+              .to match(/^Author: Nanoc <>$/)
+          end
+
+          it 'makes a change in the remote repo' do
+            expect { subject }
+              .to change { Dir.chdir('rere') { rev_list } }
+              .from(not_match(/^[a-f0-9]{40} hello\.txt$/))
+              .to(match(/^[a-f0-9]{40} hello\.txt$/))
+          end
+        end
+
+        context 'dry run' do
+          let(:dry_run) { true }
+
+          it 'makes a change in the local repo' do
+            expect { subject }
+              .not_to change { Dir.chdir(output_dir) { rev_list } }
+          end
+
+          it 'makes a change in the remote repo' do
+            expect { subject }
+              .not_to change { Dir.chdir('rere') { rev_list } }
+          end
+        end
+      end
+
+      context 'forced' do
+        let(:forced_options) { { forced: true } }
+
+        context 'remote has no other changes' do
+          include_examples 'successful push'
+        end
+
+        context 'remote has other changes' do
+          before { add_changes_to_remote }
+          include_examples 'successful push'
+        end
+      end
+
+      context 'not forced (implicit)' do
+        let(:forced_options) { {} }
+
+        context 'remote has no other changes' do
+          include_examples 'successful push'
+        end
+
+        context 'remote has other changes' do
+          before { add_changes_to_remote }
+
+          it 'raises' do
+            expect { subject }.to raise_error(Nanoc::Extra::Piper::Error)
+          end
+        end
+      end
+
+      context 'not forced (explicit)' do
+        let(:forced_options) { { forced: false } }
+
+        context 'remote has no other changes' do
+          include_examples 'successful push'
+        end
+
+        context 'remote has other changes' do
+          before { add_changes_to_remote }
+
+          it 'raises' do
+            expect { subject }.to raise_error(Nanoc::Extra::Piper::Error)
+          end
+        end
+      end
+    end
+  end
+
+  shared_examples 'remote configured properly' do
+    before do
+      system('git', 'init', '--bare', '--quiet', 'rere')
+    end
+
+    context 'default branch' do
+      context 'branch does not exist' do
+        it 'raises' do
+          expect { subject }.to raise_error(
+            Nanoc::Deploying::Deployers::Git::Errors::BranchDoesNotExist,
+            'The branch to deploy, master, does not exist.',
+          )
+        end
+      end
+
+      context 'branch exists' do
+        before do
+          Dir.chdir(output_dir) do
+            system('git', 'commit', '--quiet', '-m', 'init', '--allow-empty')
+          end
+        end
+
+        let(:branch) { 'master' }
+
+        include_examples 'branch configured properly'
+      end
+    end
+
+    context 'custom branch' do
+      let(:branch) { 'giraffe' }
+      let(:branch_options) { { branch: branch } }
+
+      context 'branch does not exist' do
+        it 'raises' do
+          expect { subject }.to raise_error(
+            Nanoc::Deploying::Deployers::Git::Errors::BranchDoesNotExist,
+            'The branch to deploy, giraffe, does not exist.',
+          )
+        end
+      end
+
+      context 'branch exists' do
+        before do
+          Dir.chdir(output_dir) do
+            system('git', 'commit', '--quiet', '-m', 'init', '--allow-empty')
+            system('git', 'branch', 'giraffe')
+          end
+        end
+
+        include_examples 'branch configured properly'
+      end
+    end
+  end
+
+  context 'output dir does not exist' do
+    it 'raises' do
+      expect { subject }.to raise_error(
+        Nanoc::Deploying::Deployers::Git::Errors::OutputDirDoesNotExist,
+        'The directory to deploy, output/, does not exist.',
+      )
+    end
+  end
+
+  context 'output dir exists' do
+    before do
+      FileUtils.mkdir_p(output_dir)
+    end
+
+    context 'output dir is not a Git repo' do
+      it 'raises' do
+        expect { subject }.to raise_error(
+          Nanoc::Deploying::Deployers::Git::Errors::OutputDirIsNotAGitRepo,
+          'The directory to deploy, output/, is not a Git repository.',
+        )
+      end
+    end
+
+    context 'output dir is a Git repo' do
+      before do
+        Dir.chdir(output_dir) do
+          system('git', 'init', '--quiet')
+          system('git', 'config', 'user.name', 'Donkey Giraffe')
+          system('git', 'config', 'user.email', 'donkey@giraffe.example.com')
+        end
+      end
+
+      context 'default remote' do
+        context 'remote does not exist' do
+          it 'raises' do
+            expect { subject }.to raise_error(
+              Nanoc::Deploying::Deployers::Git::Errors::RemoteDoesNotExist,
+              'The remote to deploy to, origin, does not exist.',
+            )
+          end
+        end
+
+        context 'remote exists' do
+          before do
+            Dir.chdir(output_dir) do
+              system('git', 'remote', 'add', 'origin', '../rere')
+            end
+          end
+
+          let(:remote) { 'origin' }
+
+          include_examples 'remote configured properly'
+        end
+      end
+
+      context 'custom remote (name)' do
+        let(:remote_options) { { remote: 'donkey' } }
+
+        context 'remote does not exist' do
+          it 'raises' do
+            expect { subject }.to raise_error(
+              Nanoc::Deploying::Deployers::Git::Errors::RemoteDoesNotExist,
+              'The remote to deploy to, donkey, does not exist.',
+            )
+          end
+        end
+
+        context 'remote exists' do
+          before do
+            Dir.chdir(output_dir) do
+              system('git', 'remote', 'add', 'donkey', '../rere')
+            end
+          end
+
+          let(:remote) { 'donkey' }
+
+          include_examples 'remote configured properly'
+        end
+      end
+
+      context 'custom remote (file:// URL)' do
+        let(:remote_options) { { remote: remote } }
+
+        let(:remote) { "file://#{Dir.getwd}/rere" }
+
+        include_examples 'remote configured properly'
+      end
+    end
+  end
+
+  describe '#remote_is_name?' do
+    def val(remote)
+      deployer.send(:remote_is_name?, remote)
+    end
+
+    it 'recognises names' do
+      expect(val('denis')).to be
+    end
+
+    it 'recognises URLs' do
+      expect(val('git@github.com:/foo')).not_to be
+      expect(val('http://example.com/donkey.git')).not_to be
+      expect(val('https://example.com/donkey.git')).not_to be
+      expect(val('ssh://example.com/donkey.git')).not_to be
+      expect(val('file:///example.com/donkey.git')).not_to be
+    end
+  end
+end