stove 1.1.2 → 2.0.0.beta.1

data/lib/stove/rake_task.rb

@@ -1,63 +1,82 @@
 require 'rake'
 require 'rake/tasklib'
+require 'stove'
 
+#
+# @todo Most of these options are duplicated from the CLI, can we unify?
+#
 module Stove
-  #
-  # Run Stove tasks from your +Rakefile+.
-  #
-  # @example
-  #   desc "Run stove tasks"
-  #   Stove::RakeTask.new(:release) do |stove|
-  #     stove.git = true
-  #     stove.devodd = true
-  #   end
-  #
-  class RakeTask < ::Rake::TaskLib
+  class RakeTask < Rake::TaskLib
+    include Mixin::Loggable
+
     class << self
       #
       # Define a CLI option.
       #
       # @param [Symbol] option
       #
-      def cli_option(option)
+      def option(option)
         define_method("#{option}=".to_sym) do |value|
-          options[option] = value
-        end
-
-        define_method(option.to_sym) do
-          options[option]
+          log.debug("Setting #{option} = #{value.inspect}")
+          options[option.to_sym] = value
         end
       end
     end
 
-    # @return [Symbol]
-    attr_accessor :name
+    # Actions
+    Action.constants.map(&Action.method(:const_get)).select(&:id).each do |action|
+      option action.id
+    end
 
-    # @return [Hash]
-    attr_reader :options
+    # Plugins
+    Plugin.constants.map(&Plugin.method(:const_get)).select(&:id).each do |plugin|
+      option plugin.id
+    end
 
-    def initialize(task_name = nil)
-      @options = {}
-      @name    = (task_name || :publish).to_sym
+    option :category
+    option :path
+    option :remote
+    option :branch
 
+    def initialize(name = nil)
       yield self if block_given?
 
       desc 'Publish this cookbook' unless ::Rake.application.last_comment
-      task name do |t, args|
-        require 'stove'
-        Stove::Cookbook.new(options).release!
+      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)
       end
     end
 
-    cli_option :branch
-    cli_option :category
-    cli_option :changelog
-    cli_option :devodd
-    cli_option :git
-    cli_option :jira
-    cli_option :log_level
-    cli_option :path
-    cli_option :remote
-    cli_option :upload
+    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

@@ -0,0 +1,84 @@
+module Stove
+  class Runner
+    include Mixin::Instanceable
+    include Mixin::Loggable
+    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 = []
+    end
+
+    def run(cookbook, options = {})
+      @cookbook, @options = cookbook, options
+
+      run_validations
+      run_actions
+    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
+      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
+    end
+  end
+end

data/lib/stove/util.rb

@@ -0,0 +1,56 @@
+module Stove
+  module Util
+    extend self
+
+    # Convert a version string (x.y.z) to a community-site friendly format
+    # (x_y_z).
+    #
+    # @example Convert a version to a version string
+    #   format_version('1.2.3') #=> 1_2_3
+    #
+    # @param [#to_s] version
+    #  the version string to convert
+    #
+    # @return [String]
+    def version_for_url(version)
+      version
+        .to_s
+        .gsub('.', '_')
+    end
+
+    #
+    # Covert the given CaMelCaSeD string to under_score. Graciously borrowed
+    # from http://stackoverflow.com/questions/1509915.
+    #
+    # @param [String] string
+    #   the string to use for transformation
+    #
+    # @return [String]
+    #
+    def underscore(string)
+      string
+        .to_s
+        .gsub(/::/, '/')
+        .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+        .tr('-', '_')
+        .downcase
+    end
+
+    #
+    # Convert an underscored string to it's camelcase equivalent constant.
+    #
+    # @param [String]
+    #   the string to convert
+    #
+    # @return [String]
+    #
+    def camelize(string)
+      string
+        .to_s
+        .split('_')
+        .map { |e| e.capitalize }
+        .join
+    end
+  end
+end

data/lib/stove/validator.rb

@@ -0,0 +1,67 @@
+module Stove
+  class Validator
+    include Mixin::Insideable
+    include Mixin::Loggable
+
+    #
+    # The class that created this validator.
+    #
+    # @return [~Class]
+    #
+    attr_reader :klass
+
+    #
+    # The identifier or field this validator runs against.
+    #
+    # @return [Symbol]
+    #
+    attr_reader :id
+
+    #
+    # The block to execute to see if the validation passes.
+    #
+    # @return [Proc]
+    #
+    attr_reader :block
+
+    #
+    # Create a new validator object.
+    #
+    # @param [~Class] klass
+    #   the class that created this validator
+    # @param [Symbol] id
+    #   the identifier or field this validator runs against
+    # @param [Proc] block
+    #   the block to execute to see if the validation passes
+    #
+    def initialize(klass, id, &block)
+      @klass   = klass
+      @id      = id
+      @block   = block
+    end
+
+    #
+    # Execute this validation in the context of the creating class, inside the
+    # given cookbook's path.
+    #
+    # @param [Cookbook]
+    #   the cookbook to run this validation against
+    #
+    def run(cookbook, options = {})
+      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,
+          )
+        end
+      end
+
+      log.debug("Validation #{id} passed!")
+    end
+  end
+end

data/lib/stove/version.rb

@@ -1,3 +1,3 @@
 module Stove
-  VERSION = '1.1.2'
+  VERSION = '2.0.0.beta.1'
 end

data/locales/en.yml

@@ -0,0 +1,231 @@
+en:
+  stove:
+    errors:
+      abstract_method: >
+        `%{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. Please file a bug report
+        at https://github.com/sethvargo/stove/issues/new and include the
+        command(s) you ran to arrive at this error.
+
+      git_failed: >
+        An error occurred while running:
+
+            git %{command}
+
+        There is likely an informative message from git that explains what
+        happened right above this message.
+
+      metadata_not_found: >
+        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.
+
+      server_unavailable: >
+        The server at `%{url}` 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.
+
+
+    validations:
+      # Bump validations
+      # ----------------
+      bump:
+        changed: >
+          The version you are trying to bump already exists! You must specify a
+          new version.
+
+        incremented: >
+          The cookbook version you are attempting to bump to is less than the
+          existing version. You cannot (re-)release a previous version of the
+          same cookbook. Please specify a higher version.
+
+
+      # Changelog validations
+      # ---------------------
+      changelog:
+        editor: >
+          The `$EDITOR' environment variable is not set. In order to use the
+          Changelog plugin, you must set a default editor for Stove to open when
+          generating the CHANGLEOG. You can set the editor like this:
+
+              export EDITOR=vi
+
+        exists: >
+          There is no `CHANGELOG.md' found at `%{path}. In order to use the
+          Changelog plugin, you must have a changelog in markdown format at the
+          root of your cookbook. You can also skip the Changelog plugin by
+          specifying the `--no-changelog' option:
+
+              bake x.y.z --no-changelog
+
+        format: >
+          The changelog at `%{path}' does not appear to be a valid format. The
+          changelog must be in the following format:
+
+              [Cookbook Name]
+              ===============
+
+              v[version] ([release date])
+              ---------------------------
+              - [Release point]
+
+          For example:
+
+              Apache 2
+              ========
+
+              v1.0.0 (2013-04-05)
+              -------------------
+              - Initial release
+
+
+      # Git validations
+      # ---------------
+      git:
+        clean: >
+          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.
+
+        repository: >
+          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}
+
+        up_to_date: >
+          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
+
+
+      # GitHub validations
+      # ------------------
+      github:
+        access_token: >
+          The Stove configuration for GitHub does not contain an access token.
+          In order to use the GitHub plugin, you must set an access token in the
+          GitHub section of the `~/.stove' file:
+
+              {
+                "github": {
+                  "access_token": "YOUR_ACCESS_TOKEN"
+                }
+              }
+
+          You can generate an access token for GitHub by following the
+          instructions at: https://help.github.com/articles/creating-an-access-token-for-command-line-use.
+
+        configuration: >
+          The Stove configuration for GitHub does not exist! In order to use the
+          GitHub plugin, you must set your GitHub information in the `~/.stove'
+          file:
+
+              {
+                "github": {
+                  "access_token": "YOUR_ACCESS_TOKEN"
+                }
+              }
+
+        git: >
+          In order to use the GitHub plugin, you must also activate the `git'
+          plugin.
+
+
+      # JIRA validations
+      # ----------------
+      jira:
+        configuration: >
+          The Stove configuration for JIRA does not exist! In order to use the
+          JIRA plugin, you must set your JIRA information in the `~/.stove'
+          file:
+
+              {
+                "jira": {
+                  "username": "YOUR_USERNAME",
+                  "password": "YOUR_PASSWORD"
+                }
+              }
+
+        password: >
+          The Stove configuration for JIRA does not contain a password. In order
+          to use JIRA features, you must set a password in the jira section of
+          the `~/.stove' file:
+
+              {
+                "jira": {
+                  "password": "YOUR_PASSWORD"
+                }
+              }
+
+        username: >
+          The Stove configuration for JIRA does not contain a username. In order
+          to use JIRA features, you must set a username in the jira section of
+          the `~/.stove' file:
+
+              {
+                "jira": {
+                  "username": "YOUR_USERNAME"
+                }
+              }
+
+
+      # Upload validations
+      # ---------------------
+      upload:
+        configuration: >
+          The Stove configuration for the Chef community site does not exist! In
+          order to perform operations against the Chef community site, you must
+          set your username and path to your client key in the community section
+          of the `~/.stove' file:
+
+              {
+                "community": {
+                  "username": "YOUR_USERNAME",
+                  "key": "YOUR_KEY_PATH"
+                }
+              }
+
+        key: >
+          The Stove configuration for the Chef community site does not contain a
+          key. In order to use the Chef community site features, you must set
+          the path to your key the community section of the `~/.stove' file:
+
+              {
+                "community": {
+                  "key": "YOUR_KEY_PATH"
+                }
+              }
+
+        username: >
+          The Stove configuration for the Chef community site does not contain a
+          username. In order to use the Chef community site features, you must
+          set a username the community section of the `~/.stove' file:
+
+              {
+                "community": {
+                  "username": "YOUR_USERNAME"
+                }
+              }
+
+        category: >
+          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:
+
+              bake x.y.z --category Utilities
+
+          For a complete listing of categories, please see the Chef community
+          site.