emeril 0.5.0

data/Rakefile

@@ -0,0 +1,33 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'cane/rake_task'
+require 'tailor/rake_task'
+
+Rake::TestTask.new(:unit) do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+desc "Run all test suites"
+task :test => [:unit]
+
+desc "Run cane to check quality metrics"
+Cane::RakeTask.new do |cane|
+  cane.canefile = './.cane'
+end
+
+Tailor::RakeTask.new
+
+desc "Display LOC stats"
+task :stats do
+  puts "\n## Production Code Stats"
+  sh "countloc -r lib"
+  puts "\n## Test Code Stats"
+  sh "countloc -r spec"
+end
+
+desc "Run all quality tasks"
+task :quality => [:cane, :tailor, :stats]
+
+task :default => [:test, :quality]

data/emeril.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'emeril/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "emeril"
+  spec.version       = Emeril::VERSION
+  spec.authors       = ["Fletcher Nichol"]
+  spec.email         = ["fnichol@nichol.ca"]
+  spec.description   = %q{Release Chef cookbooks}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/fnichol/emeril"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = []
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.2'
+
+  spec.add_dependency 'chef'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'fakefs'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_development_dependency 'cane'
+  spec.add_development_dependency 'guard-cane'
+  spec.add_development_dependency 'tailor'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'countloc'
+end

data/lib/emeril.rb

@@ -0,0 +1,11 @@
+# -*- encoding: utf-8 -*-
+
+require 'emeril/category'
+require 'emeril/git_tagger'
+require 'emeril/metadata_chopper'
+require 'emeril/publisher'
+require 'emeril/releaser'
+require 'emeril/version'
+
+module Emeril
+end

data/lib/emeril/category.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+require 'net/http'
+require 'json'
+
+module Emeril
+
+  # A category for a cookbook on the Community Site.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  class Category
+
+    # Returns the category for the given cookbook on the Community Site or
+    # nil if it is not present.
+    #
+    # @param [String] cookbook a cookbook name
+    # @return [String,nil] the cookbook category or nil if it is not present
+    #   on the Community site
+    #
+    def self.for_cookbook(cookbook)
+      path = "/api/v1/cookbooks/#{cookbook}"
+      response = Net::HTTP.get_response("cookbooks.opscode.com", path)
+      JSON.parse(response.body)['category']
+    end
+  end
+end

data/lib/emeril/git_tagger.rb

@@ -0,0 +1,122 @@
+# -*- encoding: utf-8 -*-
+
+require 'emeril/logging'
+
+module Emeril
+
+  # Exception class raised when a git repo is not clean.
+  #
+  class GitNotCleanError < StandardError ; end
+
+  # Exception class raised when a git push does not return successfully.
+  #
+  class GitPushError < StandardError ; end
+
+  # Applies a version tag on a git repository and pushes it to the origin
+  # remote.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  #
+  class GitTagger
+
+    include Logging
+
+    # Creates a new instance.
+    #
+    # @param [Hash] options configuration for a git tagger
+    # @option options [Logger] an optional logger instance
+    # @option options [String] source_path the path to a git repository
+    # @option options [String] tag_prefix a prefix for a git tag version string
+    # @option options [String] version (required) a version string
+    # @raise [ArgumentError] if any required options are not set
+    #
+    def initialize(options = {})
+      @logger = options[:logger]
+      @source_path = options.fetch(:source_path, Dir.pwd)
+      @tag_prefix = case options[:tag_prefix]
+      when nil then
+        DEFAULT_TAG_PREFIX
+      when false
+        ""
+      else
+        options[:tag_prefix]
+      end
+      @version = options.fetch(:version) do
+        raise ArgumentError, ":version must be set"
+      end
+    end
+
+    # Applies a version tag on a git repository and pushes it to the origin
+    # remote.
+    #
+    def run
+      guard_clean
+      tag_version { git_push } unless already_tagged?
+    end
+
+    private
+
+    DEFAULT_TAG_PREFIX = "v".freeze
+
+    attr_reader :logger, :source_path, :tag_prefix, :version
+
+    def already_tagged?
+      if sh_with_code('git tag')[0].split(/\n/).include?(version_tag)
+        info("Tag #{version_tag} has already been created.")
+        true
+      end
+    end
+
+    def clean?
+      sh_with_code("git status --porcelain")[0].empty?
+    end
+
+    def git_push
+      perform_git_push
+      perform_git_push ' --tags'
+      info("Pushed git commits and tags.")
+    end
+
+    def guard_clean
+      clean? or raise GitNotCleanError,
+        "There are files that need to be committed first."
+    end
+
+    def perform_git_push(options = '')
+      cmd = "git push origin master #{options}"
+      out, code = sh_with_code(cmd)
+      if code != 0
+        raise GitPushError,
+          "Couldn't git push. `#{cmd}' failed with the following output:" +
+            "\n\n#{out}\n"
+      end
+    end
+
+    def sh_with_code(cmd, &block)
+      cmd << " 2>&1"
+      outbuf = ''
+      debug(cmd)
+      Dir.chdir(source_path) {
+        outbuf = `#{cmd}`
+        if $? == 0
+          block.call(outbuf) if block
+        end
+      }
+      [outbuf, $?]
+    end
+
+    def tag_version
+      sh_with_code(%{git tag -a -m \"Version #{version}\" #{version_tag}})
+      info("Tagged #{version_tag}.")
+      yield if block_given?
+    rescue
+      error("Untagging #{version_tag} due to error.")
+      sh_with_code("git tag -d #{version_tag}")
+      raise
+    end
+
+    def version_tag
+      "#{tag_prefix}#{version}"
+    end
+  end
+end

data/lib/emeril/logging.rb

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+module Emeril
+
+  # A mixin providing log methods that gracefully fail if no logger is present.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  #
+  module Logging
+
+    %w{debug info warn error fatal}.map(&:to_sym).each do |meth|
+      define_method(meth) do |*args|
+        logger && logger.public_send(meth, *args)
+      end
+    end
+  end
+end

data/lib/emeril/metadata_chopper.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+module Emeril
+
+  # Exception class raised when there is a metadata.rb parsing issue.
+  #
+  class MetadataParseError < StandardError ; end
+
+  # A rather insane and questionable class to quickly consume a metadata.rb
+  # file and return the cookbook name and version attributes.
+  #
+  # @see https://twitter.com/fnichol/status/281650077901144064
+  # @see https://gist.github.com/4343327
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  #
+  class MetadataChopper < Hash
+
+    # Creates a new instances and loads in the contents of the metdata.rb
+    # file. If you value your life, you may want to avoid reading the
+    # implementation.
+    #
+    # @param metadata_file [String] path to a metadata.rb file
+    #
+    def initialize(metadata_file)
+      eval(IO.read(metadata_file), nil, metadata_file)
+      %w{name version}.map(&:to_sym).each do |attr|
+        if self[attr].nil?
+          raise MetadataParseError,
+            "Missing attribute `#{attr}' must be set in #{metadata_file}"
+        end
+      end
+    end
+
+    def method_missing(meth, *args, &block)
+      self[meth] = args.first
+    end
+  end
+end

data/lib/emeril/publisher.rb

@@ -0,0 +1,130 @@
+# -*- encoding: utf-8 -*-
+
+require 'chef/cookbook_uploader'
+require 'chef/cookbook_loader'
+require 'chef/cookbook_site_streaming_uploader'
+require 'chef/knife/cookbook_site_share'
+require 'chef/knife/core/ui'
+require 'fileutils'
+require 'tmpdir'
+
+require 'emeril/logging'
+
+module Emeril
+
+  # Takes a path to a cookbook and pushes it up to the Community Site.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  #
+  class Publisher
+
+    include Logging
+
+    # Creates a new instance.
+    #
+    # @param [Hash] options configuration for a publisher
+    # @option options [Logger] an optional logger instance
+    # @option options [String] source_path the path to a git repository
+    # @option options [String] name (required) the name of the cookbook
+    # @option options [String] category a Community Site category for the
+    #   cookbook
+    # @option options [Chef::Knife] knife_class an alternate Knife plugin class
+    #   to create, configure, and invoke
+    # @raise [ArgumentError] if any required options are not set
+    #
+    def initialize(options = {})
+      @logger = options[:logger]
+      @source_path = options.fetch(:source_path, Dir.pwd)
+      @name = options.fetch(:name) { raise ArgumentError, ":name must be set" }
+      @category = options[:category]
+      @knife_class = options.fetch(:knife_class, SharePlugin)
+      validate_chef_config!
+    end
+
+    # Prepares a sandbox copy of the cookbook and uploads it to the Community
+    # Site.
+    #
+    def run
+      sandbox_path = sandbox_cookbook
+      share = knife_class.new
+      share.ui = logging_ui(share.ui)
+      share.config[:cookbook_path] = sandbox_path
+      share.name_args = [name, category]
+      share.run
+    ensure
+      FileUtils.remove_dir(sandbox_path)
+    end
+
+    protected
+
+    attr_reader :logger, :source_path, :name, :category, :knife_class
+
+    def validate_chef_config!
+      %w{node_name client_key}.map(&:to_sym).each do |attr|
+        raise "Chef::Config[:#{attr}] must be set" if ::Chef::Config[attr].nil?
+      end
+    end
+
+    def sandbox_cookbook
+      path = Dir.mktmpdir
+      target = File.join(path, name)
+      debug("Creating cookbook sanbox directory at #{target}")
+      FileUtils.mkdir_p(target)
+      FileUtils.cp_r(cookbook_files, target)
+      path
+    end
+
+    def cookbook_files
+      entries = %w{
+        README.* CHANGELOG.* metadata.{json,rb}
+        attributes files libraries providers recipes resources templates
+      }
+
+      Dir.glob("#{source_path}/{#{entries.join(',')}}")
+    end
+
+    def logging_ui(ui)
+      LoggingUI.new(ui.stdout, ui.stderr, ui.stdin, ui.config, logger)
+    end
+
+    # A custom knife UI that sends logging methods to a logger, if it exists.
+    #
+    class LoggingUI < :: Chef::Knife::UI
+
+      def initialize(stdout, stderr, stdin, config, logger)
+        super(stdout, stderr, stdin, config)
+        @logger = logger
+      end
+
+      def msg(message)
+        logger ? logger.info(message) : super
+      end
+
+      def err(message)
+        logger ? logger.error(message) : super
+      end
+
+      def warn(message)
+        logger ? logger.warn(message) : super
+      end
+
+      def fatal(message)
+        logger ? logger.fatal(message) : super
+      end
+
+      private
+
+      attr_reader :logger
+    end
+
+    # A custom cookbook site share knife plugin that intercepts Kernel#exit
+    # calls and converts them to an exception raise.
+    #
+    class SharePlugin < ::Chef::Knife::CookbookSiteShare
+
+      def exit(code)
+        raise "Knife Plugin exited with error code: #{code}"
+      end
+    end
+  end
+end

data/lib/emeril/rake.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+
+require 'emeril/rake_tasks'
+
+Emeril::RakeTasks.new

data/lib/emeril/rake_tasks.rb

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+require 'rake/tasklib'
+require 'chef/knife'
+
+require 'emeril'
+
+module Emeril
+
+  # Emeril Rake task generator.
+  #
+  # @author Fletcher Nichol <fnichol@nichol.ca>
+  #
+  class RakeTasks < ::Rake::TaskLib
+
+    attr_accessor :config
+
+    # Creates Emeril Rake tasks and allows the callee to configure it.
+    #
+    # @yield [self] gives itself to the block
+    #
+    def initialize
+      @config = { :logger => Chef::Log }
+      yield self if block_given?
+      define
+    end
+
+    private
+
+    def define
+      metadata = Emeril::MetadataChopper.new("metadata.rb")
+
+      desc "Create git tag for #{metadata[:name]}-#{metadata[:version]}" +
+        " and push to the Community Site"
+      task "release" do
+        Chef::Knife.new.configure_chef
+        Emeril::Releaser.new(@config).run
+      end
+    end
+  end
+end