stove 2.0.0 → 3.0.0

data/lib/stove/plugins/base.rb

@@ -1,35 +1,48 @@
 module Stove
   class Plugin::Base
-    extend Mixin::Filterable
     include Logify
+
     extend Mixin::Optionable
     extend Mixin::Validatable
 
-    option :id
-    option :description
-
     class << self
-      def onload(&block)
-        if block
-          @onload = block
-        else
-          @onload
+      def run(description, &block)
+        actions << Proc.new do |instance|
+          log.info { description }
+          instance.instance_eval(&block)
         end
       end
+
+      def actions
+        @actions ||= []
+      end
     end
 
+    option :id
+    option :description
+
     attr_reader :cookbook
     attr_reader :options
 
     def initialize(cookbook, options = {})
       @cookbook, @options = cookbook, options
-      instance_eval(&onload)
     end
 
-    private
+    def run
+      run_validations
+      run_actions
+    end
 
-    def onload
-      self.class.onload || Proc.new {}
+    def run_validations
+      self.class.validations.each do |id, validation|
+        validation.run(cookbook, options)
+      end
+    end
+
+    def run_actions
+      self.class.actions.each do |action|
+        action.call(self)
+      end
     end
   end
 end

data/lib/stove/plugins/community.rb

@@ -3,23 +3,19 @@ module Stove
     id 'community'
     description 'Publish the release to the Chef community site'
 
-    validate(:configuration) do
-      Config.has_key?(:community)
-    end
-
     validate(:username) do
-      Config[:community].has_key?(:username)
+      Config.username
     end
 
     validate(:key) do
-      Config[:community].has_key?(:key)
+      Config.key
     end
 
     validate(:category) do
       !cookbook.category.nil?
     end
 
-    after(:upload, 'Publishing the release to the Chef community site') do
+    run('Publishing the release to the Chef community site') do
       Community.upload(cookbook)
     end
   end

data/lib/stove/plugins/git.rb

@@ -13,48 +13,37 @@ module Stove
 
     validate(:up_to_date) do
       git_null('fetch')
-      local  = git_null("rev-parse #{options[:branch]}").strip
-      remote = git_null("rev-parse #{options[:remote]}/#{options[:branch]}").strip
+      local_sha  = git_null("rev-parse #{branch}").strip
+      remote_sha = git_null("rev-parse #{remote}/#{branch}").strip
 
-      log.debug("Local SHA: #{local}")
-      log.debug("Remote SHA: #{remote}")
+      log.debug("Local SHA: #{local_sha}")
+      log.debug("Remote SHA: #{remote_sha}")
 
-      local == remote
+      local_sha == remote_sha
     end
 
-    after(:bump, 'Performing version bump') do
-      git %|add metadata.rb|
-      git %|commit -m "Version bump to #{cookbook.version}"|
-    end
-
-    after(:changelog, 'Committing CHANGELOG') do
-      git %|add CHANGELOG.md|
-      git %|commit -m "Publish #{cookbook.version} Changelog"|
-    end
+    run('Tagging new release') do
+      annotation_type = options[:sign] ? '-s' : '-a'
+      tag = cookbook.tag_version
 
-    before(:upload, 'Tagging new release') do
-      git %|tag #{cookbook.tag_version}|
-      git %|push #{options[:remote]} #{cookbook.tag_version}|
+      git %|tag #{annotation_type} #{tag} -m "Release #{tag}"|
+      git %|push #{remote} #{branch}|
+      git %|push #{remote} #{tag}|
     end
 
-    after(:dev, 'Bumping devodd release') do
-      git %|add metadata.rb|
-      git %|commit -m "Version bump to #{cookbook.version} (for development)"|
-    end
-
-    before(:finish, 'Pushing to git remote(s)') do
-      git %|push #{options[:remote]} #{options[:branch]}|
-    end
+    private
 
     def git(command, errors = true)
       log.debug("Running `git #{command}', errors: #{errors}")
-      response = %x|cd "#{cookbook.path}" && git #{command}|
+      Dir.chdir(cookbook.path) do
+        response = %x|git #{command}|
 
-      if errors && !$?.success?
-        raise Error::GitFailed.new(command: command)
-      end
+        if errors && !$?.success?
+          raise Error::GitFailed.new(command: command)
+        end
 
-      response
+        response
+      end
     end
 
     def git_null(command)
@@ -67,5 +56,13 @@ module Stove
 
       git("#{command} 2>#{null}", false)
     end
+
+    def remote
+      options[:remote]
+    end
+
+    def branch
+      options[:branch]
+    end
   end
 end

data/lib/stove/rake_task.rb

@@ -2,81 +2,21 @@ require 'rake'
 require 'rake/tasklib'
 require 'stove'
 
-#
-# @todo Most of these options are duplicated from the CLI, can we unify?
-#
 module Stove
   class RakeTask < Rake::TaskLib
-    include Logify
-
-    class << self
-      #
-      # Define a CLI option.
-      #
-      # @param [Symbol] option
-      #
-      def option(option)
-        define_method("#{option}=".to_sym) do |value|
-          log.debug("Setting #{option} = #{value.inspect}")
-          options[option.to_sym] = value
-        end
-      end
-    end
-
-    # Actions
-    Action.constants.map(&Action.method(:const_get)).select(&:id).each do |action|
-      option action.id
-    end
-
-    # Plugins
-    Plugin.constants.map(&Plugin.method(:const_get)).select(&:id).each do |plugin|
-      option plugin.id
-    end
-
-    option :category
-    option :path
-    option :remote
-    option :branch
+    attr_accessor :stove_opts
 
     def initialize(name = nil)
       yield self if block_given?
 
       desc 'Publish this cookbook' unless ::Rake.application.last_comment
-      task(name || :publish, :version) do |t, args|
-        log.info("Options: #{options.inspect}")
-
-        cookbook = Cookbook.new(options[:path])
-        options[:version] = args[:version] || minor_bump(cookbook.version)
-        Runner.run(cookbook, options)
+      task(name || :publish) do |t, args|
+        Cli.new(stove_opts || []).execute!
       end
     end
 
-    def locale=(locale)
-      log.debug("Setting locale = #{locale.inspect}")
-      I18n.locale = locale
-    end
-
     def log_level=(level)
-      log.debug("Setting log_level = #{level.inspect}")
       Stove.log_level = level
     end
-
-    private
-
-    def minor_bump(version)
-      split = version.split('.').map(&:to_i)
-      split[2] += 1
-      split.join('.')
-    end
-
-    def options
-      @options ||= Hash.new(true).tap do |h|
-        h[:path] = Dir.pwd
-        h[:jira] = false
-
-        h[:remote]    = 'origin'
-        h[:branch]    = 'master'
-      end
-    end
   end
 end

data/lib/stove/runner.rb

@@ -1,84 +1,35 @@
 module Stove
   class Runner
-    include Mixin::Instanceable
     include Logify
-    include Mixin::Optionable
-
-    class << self
-      def action(id)
-        actions << id
-        filters[id] = { before: [], after: [] }
-      end
-    end
 
     attr_reader :cookbook
     attr_reader :options
-    attr_reader :validations
-
-    option :actions, []
-    option :filters, {}
-
-    action :start
-    action :bump
-    action :changelog
-    action :upload
-    action :dev
-    action :finish
 
-    def initialize
-      @validations = []
+    def initialize(cookbook, options = {})
+      @cookbook = cookbook
+      @options  = options
     end
 
-    def run(cookbook, options = {})
-      @cookbook, @options = cookbook, options
-
-      run_validations
-      run_actions
+    def run
+      run_plugin :git
+      run_plugin :community
     end
 
     private
 
-    def skip?(thing)
-      !options[thing.to_sym]
-    end
-
-    def run_actions
-      actions.each do |action|
-        if skip?(action)
-          log.debug("Skipping action `#{action}' and filters")
-        else
-          run_filters(:before, action)
-
-          klass = Action.const_get(Util.camelize(action))
-          klass.new(cookbook, options).run
-
-          run_filters(:after, action)
-        end
+    def run_plugin(name)
+      if skip?(name)
+        log.info { "Skipping plugin `:#{name}'" }
+      else
+        log.info { "Running plugin `:#{name}'" }
+        klass = Plugin.const_get(Util.camelize(name))
+        klass.new(cookbook, options).run
       end
     end
 
-    def run_filters(placement, action)
-      filters[action][placement].each do |filter|
-        plugin = filter.klass.id
-
-        if skip?(plugin)
-          log.debug("Skipping filter `#{filter.message}'")
-        else
-          filter.run(cookbook, options)
-        end
-      end
-    end
-
-    def run_validations
-      validations.each do |validation|
-        parent = validation.klass.id
-
-        if skip?(parent)
-          log.debug("Skipping validation `#{validation.id}' for `#{parent}'")
-        else
-          validation.run(cookbook, options)
-        end
-      end
+    def skip?(thing)
+      key = "no_#{thing}".to_sym
+      !!options[key]
     end
   end
 end

data/lib/stove/validator.rb

@@ -1,8 +1,9 @@
 module Stove
   class Validator
-    include Mixin::Insideable
     include Logify
 
+    include Mixin::Insideable
+
     #
     # The class that created this validator.
     #
@@ -48,16 +49,16 @@ module Stove
     #   the cookbook to run this validation against
     #
     def run(cookbook, options = {})
-      log.info("Running validations for #{klass.id}.#{id}")
+      log.info("Running validations for `#{klass.id}.#{id}'")
 
       inside(cookbook) do
         instance = klass.new(cookbook, options)
         unless result = instance.instance_eval(&block)
           log.debug("Validation failed, result: #{result.inspect}")
-          raise Error::ValidationFailed.new(klass.id, id,
-            path:   Dir.pwd,
-            result: result,
-          )
+
+          # Convert the class and id to their magical equivalents
+          error = Error.const_get("#{Util.camelize(klass.id)}#{Util.camelize(id)}ValidationFailed")
+          raise error.new(path: Dir.pwd, result: result)
         end
       end
 

data/lib/stove/version.rb

@@ -1,3 +1,3 @@
 module Stove
-  VERSION = '2.0.0'
+  VERSION = '3.0.0'
 end

data/lib/stove.rb

@@ -2,13 +2,12 @@ require 'logify'
 require 'pathname'
 
 module Stove
-  autoload :Config,     'stove/config'
   autoload :Community,  'stove/community'
+  autoload :Config,     'stove/config'
   autoload :Cookbook,   'stove/cookbook'
   autoload :Cli,        'stove/cli'
   autoload :Error,      'stove/error'
   autoload :Filter,     'stove/filter'
-  autoload :JIRA,       'stove/jira'
   autoload :Mash,       'stove/mash'
   autoload :Packager,   'stove/packager'
   autoload :Runner,     'stove/runner'
@@ -16,23 +15,12 @@ module Stove
   autoload :Validator,  'stove/validator'
   autoload :VERSION,    'stove/version'
 
-  module Action
-    autoload :Base,      'stove/actions/base'
-    autoload :Bump,      'stove/actions/bump'
-    autoload :Changelog, 'stove/actions/changelog'
-    autoload :Dev,       'stove/actions/dev'
-    autoload :Finish,    'stove/actions/finish'
-    autoload :Start,     'stove/actions/start'
-    autoload :Upload,    'stove/actions/upload'
-  end
-
   module Middleware
     autoload :ChefAuthentication, 'stove/middlewares/chef_authentication'
     autoload :Exceptions,         'stove/middlewares/exceptions'
   end
 
   module Mixin
-    autoload :Filterable,   'stove/mixins/filterable'
     autoload :Insideable,   'stove/mixins/insideable'
     autoload :Instanceable, 'stove/mixins/instanceable'
     autoload :Optionable,   'stove/mixins/optionable'
@@ -43,8 +31,6 @@ module Stove
     autoload :Base,      'stove/plugins/base'
     autoload :Community, 'stove/plugins/community'
     autoload :Git,       'stove/plugins/git'
-    autoload :GitHub,    'stove/plugins/github'
-    autoload :JIRA,      'stove/plugins/jira'
   end
 
   #
@@ -80,11 +66,11 @@ module Stove
     # @example Set the log level to :info
     #   ChefAPI.log_level = :info
     #
-    # @param [Symbol] level
+    # @param [#to_sym] level
     #   the log level to set
     #
     def log_level=(level)
-      Logify.level = level
+      Logify.level = level.to_sym
     end
 
     #
@@ -97,7 +83,3 @@ module Stove
     end
   end
 end
-
-require 'i18n'
-I18n.enforce_available_locales = true
-I18n.load_path << Dir[Stove.root.join('locales', '*.yml').to_s]

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'stove'

data/spec/unit/error_spec.rb

@@ -0,0 +1,148 @@
+require 'spec_helper'
+
+module Stove::Error
+  describe StoveError do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          Oh no! Something really bad happened. I am not sure what actually happened because this is the catch-all error, but you should most definitely report an issue on GitHub at https://github.com/sethvargo/stove.
+        EOH
+      }
+    end
+  end
+
+  describe GitFailed do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class.new(command: 'foo') }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          An error occurred while running:
+
+              git foo
+
+          There is likely an informative message from git that explains what happened right above this message.
+        EOH
+      }
+    end
+  end
+
+  describe MetadataNotFound do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class.new(path: '/path') }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The file at `/path' does not exist or does not contain valid metadata. Please make sure you have specified the correct path and that the metdata file exists.
+        EOH
+      }
+    end
+  end
+
+  describe ServerUnavailable do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class.new(url: 'http://server') }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The server at `http://server' is unavailable or is not currently accepting client connections. Please ensure the server is accessible via ping (or telnet) on your local network. If this error persists, please contact your network administrator.
+        EOH
+      }
+    end
+  end
+
+  describe CommunityCategoryValidationFailed do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          You did not specify a category! The Chef community site requires all cookbooks belong to a category. For existing cookboks, Stove can query the Chef community site API and automatically complete the category for you. However, for new cookbooks, you must specify the `--category' flag at runtime:
+
+              stove --category Utilities
+
+          For a complete listing of categories, please see the Chef community site.
+        EOH
+      }
+    end
+  end
+
+  describe CommunityKeyValidationFailed do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          You did not specify the path to a private key! The Chef community site requires a private key for authentication:
+
+              stove --key ~/.chef/sethvargo.pem
+        EOH
+      }
+    end
+  end
+
+  describe CommunityUsernameValidationFailed do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          You did not specify the username to authenticate with! The Chef community site requires a username for authentication:
+
+              stove --username sethvargo
+        EOH
+      }
+    end
+  end
+
+  describe GitCleanValidationFailed do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class.new(path: '/path') }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The cookbook at `/path' has untracked files! In order to use the git plugin, you must have a clean working directory. Please commit or stash your changes before running Stove again.
+        EOH
+      }
+    end
+  end
+
+  describe GitRepositoryValidationFailed do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class.new(path: '/path') }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The cookbook at `/path' does not appear to be a valid git repository. In order to use the git plugin, your cookbook must be initialized as a git repository. To create a git repository, run:
+
+              git init /path
+        EOH
+      }
+    end
+  end
+
+  describe GitUpToDateValidationFailed do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class.new(path: '/path') }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          The cookbook at `/path' is out of sync with the remote repository. Please update your local cache with the remote repository before continuing:
+
+              git pull
+
+          And then push your local changes to the remote repository:
+
+              git push
+        EOH
+      }
+    end
+  end
+
+  describe GitFailed do
+    it 'raises an exception with the correct message' do
+      expect { raise described_class.new(command: 'run') }.to raise_error { |error|
+        expect(error).to be_a(described_class)
+        expect(error.message).to eq <<-EOH.gsub(/^ {10}/, '')
+          An error occurred while running:
+
+              git run
+
+          There is likely an informative message from git that explains what happened right above this message.
+        EOH
+      }
+    end
+  end
+end

data/stove.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Stove::VERSION
   spec.authors       = ['Seth Vargo']
   spec.email         = ['sethvargo@gmail.com']
-  spec.description   = %q|A simple gem for packaging, releasing, and sanity-checking a community cookbook|
-  spec.summary       = %q|A simple gem for packaging, releasing, and sanity-checking an Opscode community cookbook. This gem automatically packages the appropiate files, syncs with JIRA issues (if applicable), and automatically generates CHANGELOGs.|
+  spec.description   = "A utility for releasing Chef community cookbooks"
+  spec.summary       = "A command-line utility for releasing Chef community cookbooks"
   spec.homepage      = 'https://github.com/sethvargo/stove'
   spec.license       = 'Apache 2.0'
 
@@ -18,20 +18,16 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  # Runtime dependencies
-  spec.add_dependency 'faraday',               '~> 0.8.9'
-  spec.add_dependency 'faraday_middleware',    '~> 0.9.0'
-  spec.add_dependency 'i18n',                  '~> 0.6'
+  spec.required_ruby_version = '>= 1.9'
 
-  spec.add_dependency 'logify',                '~> 0.2'
-  spec.add_dependency 'minitar',               '~> 0.5'
-  spec.add_dependency 'mixlib-authentication', '~> 1.3'
-  spec.add_dependency 'octokit',               '~> 3.0'
-  spec.add_dependency 'solve',                 '~> 0.8'
+  # Runtime dependencies
+  spec.add_dependency 'chef-api', '~> 0.4'
+  spec.add_dependency 'logify',   '~> 0.2'
+  spec.add_dependency 'minitar',  '~> 0.5'
 
-  spec.add_development_dependency 'aruba',          '~> 0.5'
-  spec.add_development_dependency 'bundler',        '~> 1.3'
+  spec.add_development_dependency 'aruba',          '~> 0.6'
+  spec.add_development_dependency 'bundler',        '~> 1.6'
   spec.add_development_dependency 'community-zero', '~> 2.0'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec',          '~> 2.14'
+  spec.add_development_dependency 'rspec',          '~> 3.0'
 end

data/templates/errors/abstract_method.erb

@@ -0,0 +1,5 @@
+'<%= @method %>' is an abstract method. You must override this method in your subclass with the proper implementation and logic. For more information, please see the inline documentation for <%= @method %>. If you are not a developer, this is most likely a bug in the ChefAPI gem. Please file a bug report at:
+
+    https://github.com/sethvargo/stove/issues/new
+
+and include the command(s) or code you ran to arrive at this error.

data/templates/errors/community_category_validation_failed.erb

@@ -0,0 +1,5 @@
+You did not specify a category! The Chef community site requires all cookbooks belong to a category. For existing cookboks, Stove can query the Chef community site API and automatically complete the category for you. However, for new cookbooks, you must specify the `--category' flag at runtime:
+
+    stove --category Utilities
+
+For a complete listing of categories, please see the Chef community site.

data/templates/errors/community_key_validation_failed.erb

@@ -0,0 +1,3 @@
+You did not specify the path to a private key! The Chef community site requires a private key for authentication:
+
+    stove --key ~/.chef/sethvargo.pem