nanoc 4.4.7 → 4.5.0

data/spec/spec_helper.rb

@@ -76,6 +76,8 @@ RSpec.configure do |c|
   end
 end
 
+RSpec::Matchers.define_negated_matcher :not_match, :match
+
 RSpec::Matchers.define :raise_frozen_error do |_expected|
   match do |actual|
     begin

data/test/deploying/test_git.rb

@@ -0,0 +1,261 @@
+class Nanoc::Deploying::Deployers::GitTest < Nanoc::TestCase
+  def test_run_with_defaults_options
+    # Create deployer
+    git = Nanoc::Deploying::Deployers::Git.new(
+      'output/',
+      {}
+    )
+
+    # Mock run_cmd
+    def git.run_cmd(args, _opts = {})
+      @shell_cmd_args = [] unless defined? @shell_cmd_args
+      @shell_cmd_args << args.join(' ')
+    end
+
+    # Mock clean_repo?
+    def git.clean_repo?
+      false
+    end
+
+    # Create output dir + repo
+    FileUtils.mkdir_p('output')
+    Dir.chdir('output') { system('git', 'init', '--quiet') }
+
+    # Try running
+    git.run
+
+    commands = <<-EOS
+git config --get remote.origin.url
+git checkout master
+git add -A
+git commit -a --author Nanoc <> -m Automated commit at .+ by Nanoc \\d+\\.\\d+\\.\\d+\\w*
+git push origin master
+EOS
+
+    assert_match Regexp.new(/^#{commands.chomp}$/), git.instance_eval { @shell_cmd_args.join("\n") }
+  end
+
+  def test_run_with_clean_repository
+    # Create deployer
+    git = Nanoc::Deploying::Deployers::Git.new(
+      'output/',
+      {}
+    )
+
+    # Mock run_cmd
+    def git.run_cmd(args, _opts = {})
+      @shell_cmd_args = [] unless defined? @shell_cmd_args
+      @shell_cmd_args << args.join(' ')
+    end
+
+    # Mock clean_repo?
+    def git.clean_repo?
+      true
+    end
+
+    # Create output dir + repo
+    FileUtils.mkdir_p('output')
+    Dir.chdir('output') { system('git', 'init', '--quiet') }
+
+    # Try running
+    git.run
+
+    commands = <<-EOS
+git config --get remote.origin.url
+git checkout master
+EOS
+
+    assert_match Regexp.new(/^#{commands.chomp}$/), git.instance_eval { @shell_cmd_args.join("\n") }
+  end
+
+  def test_run_with_custom_options
+    # Create deployer
+    git = Nanoc::Deploying::Deployers::Git.new(
+      'output/',
+      remote: 'github', branch: 'gh-pages', forced: true,
+    )
+
+    # Mock run_cmd
+    def git.run_cmd(args, _opts = {})
+      @shell_cmd_args = [] unless defined? @shell_cmd_args
+      @shell_cmd_args << args.join(' ')
+    end
+
+    # Mock clean_repo?
+    def git.clean_repo?
+      false
+    end
+
+    # Create output dir + repo
+    FileUtils.mkdir_p('output')
+    Dir.chdir('output') { system('git', 'init', '--quiet') }
+
+    # Try running
+    git.run
+
+    commands = <<-EOS
+git config --get remote.github.url
+git checkout gh-pages
+git add -A
+git commit -a --author Nanoc <> -m Automated commit at .+ by Nanoc \\d+\\.\\d+\\.\\d+\\w*
+git push -f github gh-pages
+EOS
+
+    assert_match Regexp.new(/^#{commands.chomp}$/), git.instance_eval { @shell_cmd_args.join("\n") }
+  end
+
+  def test_run_without_git_init
+    # Create deployer
+    git = Nanoc::Deploying::Deployers::Git.new(
+      'output/',
+      {}
+    )
+
+    # Mock run_cmd
+    def git.run_cmd(args, _opts = {})
+      @shell_cmd_args = [] unless defined? @shell_cmd_args
+      @shell_cmd_args << args.join(' ')
+    end
+
+    # Mock clean_repo?
+    def git.clean_repo?
+      false
+    end
+
+    # Create site
+    FileUtils.mkdir_p('output/.git')
+
+    # Try running
+    git.run
+
+    commands = <<-EOS
+git config --get remote.origin.url
+git checkout master
+git add -A
+git commit -a --author Nanoc <> -m Automated commit at .+ by Nanoc \\d+\\.\\d+\\.\\d+\\w*
+git push origin master
+EOS
+
+    assert_match Regexp.new(/^#{commands.chomp}$/), git.instance_eval { @shell_cmd_args.join("\n") }
+  end
+
+  def test_run_with_ssh_url
+    # Create deployer
+    git = Nanoc::Deploying::Deployers::Git.new(
+      'output/',
+      remote: 'git@github.com:myself/myproject.git',
+    )
+
+    # Mock run_cmd
+    def git.run_cmd(args, _opts = {})
+      @shell_cmd_args = [] unless defined? @shell_cmd_args
+      @shell_cmd_args << args.join(' ')
+    end
+
+    # Mock clean_repo?
+    def git.clean_repo?
+      false
+    end
+
+    # Create output dir + repo
+    FileUtils.mkdir_p('output')
+    Dir.chdir('output') { system('git', 'init', '--quiet') }
+
+    # Try running
+    git.run
+
+    commands = <<-EOS
+git checkout master
+git add -A
+git commit -a --author Nanoc <> -m Automated commit at .+ by Nanoc \\d+\\.\\d+\\.\\d+\\w*
+git push git@github.com:myself/myproject.git master
+EOS
+
+    assert_match Regexp.new(/^#{commands.chomp}$/), git.instance_eval { @shell_cmd_args.join("\n") }
+  end
+
+  def test_run_with_http_url
+    # Create deployer
+    git = Nanoc::Deploying::Deployers::Git.new(
+      'output/',
+      remote: 'https://github.com/nanoc/nanoc.git',
+    )
+
+    # Mock run_cmd
+    def git.run_cmd(args, _opts = {})
+      @shell_cmd_args = [] unless defined? @shell_cmd_args
+      @shell_cmd_args << args.join(' ')
+    end
+
+    # Mock clean_repo?
+    def git.clean_repo?
+      false
+    end
+
+    # Create output dir + repo
+    FileUtils.mkdir_p('output')
+    Dir.chdir('output') { system('git', 'init', '--quiet') }
+
+    # Try running
+    git.run
+
+    commands = <<-EOS
+git checkout master
+git add -A
+git commit -a --author Nanoc <> -m Automated commit at .+ by Nanoc \\d+\\.\\d+\\.\\d+\\w*
+git push https://github.com/nanoc/nanoc.git master
+EOS
+
+    assert_match Regexp.new(/^#{commands.chomp}$/), git.instance_eval { @shell_cmd_args.join("\n") }
+  end
+
+  def test_clean_repo_on_a_clean_repo
+    # Create deployer
+    git = Nanoc::Deploying::Deployers::Git.new(
+      'output/',
+      remote: 'https://github.com/nanoc/nanoc.git',
+    )
+
+    FileUtils.mkdir_p('output')
+
+    piper = Nanoc::Extra::Piper.new(stdout: $stdout, stderr: $stderr)
+
+    Dir.chdir('output') do
+      piper.run('git init', nil)
+      assert git.send(:clean_repo?)
+    end
+  end
+
+  def test_clean_repo_on_a_dirty_repo
+    # Create deployer
+    git = Nanoc::Deploying::Deployers::Git.new(
+      'output/',
+      remote: 'https://github.com/nanoc/nanoc.git',
+    )
+
+    FileUtils.mkdir_p('output')
+
+    piper = Nanoc::Extra::Piper.new(stdout: $stdout, stderr: $stderr)
+    Dir.chdir('output') do
+      piper.run('git init', nil)
+      FileUtils.touch('foobar')
+      refute git.send(:clean_repo?)
+    end
+  end
+
+  def test_clean_repo_not_git_repo
+    # Create deployer
+    git = Nanoc::Deploying::Deployers::Git.new(
+      'output/',
+      remote: 'https://github.com/nanoc/nanoc.git',
+    )
+
+    FileUtils.mkdir_p('output')
+
+    Dir.chdir('output') do
+      assert_raises Nanoc::Extra::Piper::Error do
+        git.send(:clean_repo?)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nanoc
 version: !ruby/object:Gem::Version
-  version: 4.4.7
+  version: 4.5.0
 platform: ruby
 authors:
 - Denis Defreyne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-05 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cri
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ddplugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -146,7 +160,6 @@ files:
 - lib/nanoc/base/errors.rb
 - lib/nanoc/base/feature.rb
 - lib/nanoc/base/memoization.rb
-- lib/nanoc/base/plugin_registry.rb
 - lib/nanoc/base/repos.rb
 - lib/nanoc/base/repos/checksum_store.rb
 - lib/nanoc/base/repos/compiled_content_cache.rb
@@ -244,6 +257,7 @@ files:
 - lib/nanoc/deploying/deployer.rb
 - lib/nanoc/deploying/deployers.rb
 - lib/nanoc/deploying/deployers/fog.rb
+- lib/nanoc/deploying/deployers/git.rb
 - lib/nanoc/deploying/deployers/rsync.rb
 - lib/nanoc/extra.rb
 - lib/nanoc/extra/core_ext.rb
@@ -329,7 +343,6 @@ files:
 - spec/nanoc/base/feature_spec.rb
 - spec/nanoc/base/filter_spec.rb
 - spec/nanoc/base/item_rep_writer_spec.rb
-- spec/nanoc/base/plugin_registry_spec.rb
 - spec/nanoc/base/repos/checksum_store_spec.rb
 - spec/nanoc/base/repos/compiled_content_cache_spec.rb
 - spec/nanoc/base/repos/config_loader_spec.rb
@@ -370,10 +383,12 @@ files:
 - spec/nanoc/cli/commands/deploy_spec.rb
 - spec/nanoc/cli/commands/shell_spec.rb
 - spec/nanoc/cli/commands/show_data_spec.rb
+- spec/nanoc/cli/commands/show_plugins_spec.rb
 - spec/nanoc/cli/commands/show_rules_spec.rb
 - spec/nanoc/cli/commands/view_spec.rb
 - spec/nanoc/data_sources/filesystem_spec.rb
 - spec/nanoc/deploying/fog_spec.rb
+- spec/nanoc/deploying/git_spec.rb
 - spec/nanoc/extra/parallel_collection_spec.rb
 - spec/nanoc/filters/colorize_syntax/rouge_spec.rb
 - spec/nanoc/filters/less_spec.rb
@@ -448,7 +463,6 @@ files:
 - test/base/test_memoization.rb
 - test/base/test_notification_center.rb
 - test/base/test_outdatedness_checker.rb
-- test/base/test_plugin.rb
 - test/base/test_site.rb
 - test/base/test_store.rb
 - test/checking/checks/test_css.rb
@@ -473,6 +487,7 @@ files:
 - test/data_sources/test_filesystem.rb
 - test/data_sources/test_filesystem_tools.rb
 - test/deploying/test_fog.rb
+- test/deploying/test_git.rb
 - test/deploying/test_rsync.rb
 - test/extra/core_ext/test_pathname.rb
 - test/extra/core_ext/test_time.rb

data/lib/nanoc/base/plugin_registry.rb

@@ -1,219 +0,0 @@
-module Nanoc::Int
-  # The class responsible for keeping track of all loaded plugins, such as
-  # filters ({Nanoc::Filter}) and data sources ({Nanoc::DataSource}).
-  #
-  # @api private
-  class PluginRegistry
-    extend Nanoc::Int::Memoization
-
-    # A module that contains class methods for plugins. It provides functions
-    # for setting identifiers, registering plugins and finding plugins. Plugin
-    # classes should extend this module.
-    module PluginMethods
-      # @overload identifiers(*identifiers)
-      #
-      #   Sets the identifiers for this plugin.
-      #
-      #   @param [Array<Symbol>] identifiers A list of identifiers to assign to
-      #     this plugin.
-      #
-      #   @return [void]
-      #
-      # @overload identifiers
-      #
-      #   @return [Array<Symbol>] The identifiers for this plugin
-      def identifiers(*identifiers)
-        if identifiers.empty?
-          registry = Nanoc::Int::PluginRegistry.instance
-          registry.identifiers_of(registry.root_class_of(self), self)
-        else
-          register(self, *identifiers)
-        end
-      end
-
-      # @overload identifier(identifier)
-      #
-      #   Sets the identifier for this plugin.
-      #
-      #   @param [Symbol] identifier An identifier to assign to this plugin.
-      #
-      #   @return [void]
-      #
-      # @overload identifier
-      #
-      #   @return [Symbol] The first identifier for this plugin
-      def identifier(identifier = nil)
-        if identifier
-          identifiers(identifier)
-        else
-          registry = Nanoc::Int::PluginRegistry.instance
-          registry.identifiers_of(registry.root_class_of(self), self).first
-        end
-      end
-
-      # Registers the given class as a plugin with the given identifier.
-      #
-      # @param [Class, String] class_or_name The class to register, or a
-      #   string containing the class name to register.
-      #
-      # @param [Array<Symbol>] identifiers A list of identifiers to assign to
-      #   this plugin.
-      #
-      # @return [void]
-      def register(class_or_name, *identifiers)
-        registry = Nanoc::Int::PluginRegistry.instance
-        root = registry.root_class_of(self)
-        registry.register(root, class_or_name, *identifiers)
-      end
-
-      # @return [Hash<Symbol, Class>] All plugins of this type, with keys
-      #   being the identifiers and values the plugin classes
-      def all
-        Nanoc::Int::PluginRegistry.instance.find_all(self)
-      end
-
-      # Returns the plugin with the given name (identifier)
-      #
-      # @param [String] name The name of the plugin class to find
-      #
-      # @return [Class] The plugin class with the given name
-      def named(name)
-        Nanoc::Int::PluginRegistry.instance.find(self, name)
-      end
-    end
-
-    # Returns the shared {PluginRegistry} instance, creating it if none exists
-    # yet.
-    #
-    # @return [Nanoc::Int::PluginRegistry] The shared plugin registry
-    def self.instance
-      @instance ||= new
-    end
-
-    # Creates a new plugin registry. This should usually not be necessary; it
-    # is recommended to use the shared instance (obtained from
-    # {Nanoc::Int::PluginRegistry.instance}).
-    def initialize
-      @identifiers_to_classes = {}
-      @classes_to_identifiers = {}
-    end
-
-    # Registers the given class as a plugin.
-    #
-    # @param [Class] superclass The superclass of the plugin. For example:
-    #   {Nanoc::Filter}.
-    #
-    # @param [Class, String] class_or_name The class to register. This can be
-    #   a string, in which case it will be automatically converted to a proper
-    #   class at lookup. For example: `Nanoc::Filters::ERB`,
-    #   `"Nanoc::Filters::Haml"`.
-    #
-    # @param [Symbol] identifiers One or more symbols identifying the class.
-    #   For example: `:haml`, :`erb`.
-    #
-    # @return [void]
-    def register(superclass, class_or_name, *identifiers)
-      @identifiers_to_classes[superclass] ||= {}
-      @classes_to_identifiers[superclass] ||= {}
-
-      identifiers.each do |identifier|
-        @identifiers_to_classes[superclass][identifier.to_sym] = class_or_name
-        (@classes_to_identifiers[superclass][name_for_class(class_or_name)] ||= []) << identifier.to_sym
-      end
-    end
-
-    # @param [Class] superclass The superclass of the plugin. For example:
-    #   {Nanoc::Filter}.
-    #
-    # @param [Class] klass The class to get the identifiers for.
-    #
-    # @return [Array<Symbol>] An array of identifiers for the given class
-    def identifiers_of(superclass, klass)
-      (@classes_to_identifiers[superclass] || {})[name_for_class(klass)] || []
-    end
-
-    # Finds the plugin that is a subclass of the given class and has the given
-    # name.
-    #
-    # @param [Class] klass The class of the plugin to return
-    #
-    # @param [Symbol] name The name of the plugin to return
-    #
-    # @return [Class, nil] The plugin with the given name
-    def find(klass, name)
-      @identifiers_to_classes[klass] ||= {}
-      resolve(@identifiers_to_classes[klass][name.to_sym], klass)
-    end
-
-    # Returns all plugins of the given class.
-    #
-    # @param [Class] klass The class of the plugin to return
-    #
-    # @return [Enumerable<Class>] A collection of class plugins
-    def find_all(klass)
-      @identifiers_to_classes[klass] ||= {}
-      res = {}
-      @identifiers_to_classes[klass].each_pair { |k, v| res[k] = resolve(v, k) }
-      res
-    end
-
-    # @param [Class] subclass
-    #
-    # @return [Class]
-    #
-    # @api private
-    def root_class_of(subclass)
-      root_class = subclass
-      root_class = root_class.superclass while root_class.superclass.respond_to?(:register)
-      root_class
-    end
-
-    # Returns a list of all plugins. The returned list of plugins is an array
-    # with array elements in the following format:
-    #
-    #   { :class => ..., :superclass => ..., :identifiers => ... }
-    #
-    # @return [Array<Hash>] A list of all plugins in the format described
-    def all
-      plugins = []
-      @identifiers_to_classes.each_pair do |superclass, submap|
-        submap.each_pair do |identifier, klass|
-          # Find existing plugin
-          existing_plugin = plugins.find do |p|
-            p[:class] == klass && p[:superclass] == superclass
-          end
-
-          if existing_plugin
-            # Add identifier to existing plugin
-            existing_plugin[:identifiers] << identifier
-            existing_plugin[:identifiers] = existing_plugin[:identifiers].sort_by(&:to_s)
-          else
-            # Create new plugin
-            plugins << {
-              class: klass,
-              superclass: superclass,
-              identifiers: [identifier],
-            }
-          end
-        end
-      end
-
-      plugins
-    end
-
-    protected
-
-    def resolve(class_or_name, _klass)
-      if class_or_name.is_a?(String)
-        Kernel.const_get(class_or_name)
-      else
-        class_or_name
-      end
-    end
-    memoize :resolve
-
-    def name_for_class(klass)
-      klass.to_s.sub(/^(::)?/, '::')
-    end
-  end
-end