knife-spork 0.1.11 → 1.0.0

data/Rakefile

@@ -1,122 +1,2 @@
-require 'rubygems'
-require 'rake'
-require 'date'
-
-#############################################################################
-#
-# Helper functions
-#
-#############################################################################
-
-def name
-  @name ||= Dir['*.gemspec'].first.split('.').first
-end
-
-def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
-  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
-end
-
-def date
-  Date.today.to_s
-end
-
-def rubyforge_project
-  name
-end
-
-def gemspec_file
-  "#{name}.gemspec"
-end
-
-def gem_file
-  "#{name}-#{version}.gem"
-end
-
-def replace_header(head, header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
-end
-
-#############################################################################
-#
-# Standard tasks
-#
-#############################################################################
-
-task :default => :validate
-
-desc "Open an irb session preloaded with this library"
-task :console do
-  sh "irb -rubygems -r ./lib/#{name}.rb"
-end
-
-#############################################################################
-#
-# Custom tasks (add your own tasks here)
-#
-#############################################################################
-
-
-
-#############################################################################
-#
-# Packaging tasks
-#
-#############################################################################
-
-desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
-task :release => :build do
-  unless `git branch` =~ /^\* master$/
-    puts "You must be on the master branch to release!"
-    exit!
-  end
-  sh "git commit --allow-empty -a -m 'Release #{version}'"
-  sh "git tag v#{version}"
-  sh "git push origin master"
-  sh "git push origin v#{version}"
-  sh "gem push pkg/#{name}-#{version}.gem"
-end
-
-desc "Build #{gem_file} into the pkg directory"
-task :build => :gemspec do
-  sh "mkdir -p pkg"
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end
-
-desc "Generate #{gemspec_file}"
-task :gemspec => :validate do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
-
-  # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-  replace_header(head, :date)
-  #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg)/ }.
-    map { |file| "    #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
-end
-
-desc "Validate #{gemspec_file}"
-task :validate do
-  unless Dir['VERSION*'].empty?
-    puts "A `VERSION` file at root level violates Gem best practices."
-    exit!
-  end
-end
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'

data/knife-spork.gemspec

@@ -1,68 +1,21 @@
-## This is the rakegem gemspec template. Make sure you read and understand
-## all of the comments. Some sections require modification, and others can
-## be deleted if you don't need them. Once you understand the contents of
-## this file, feel free to delete any comments that begin with two hash marks.
-## You can find comprehensive Gem::Specification documentation, at
-## http://docs.rubygems.org/read/chapter/20
-Gem::Specification.new do |s|
-  s.specification_version = 2 if s.respond_to? :specification_version=
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.rubygems_version = '1.3.5'
-
-  ## Leave these as is they will be modified for you by the rake gemspec task.
-  ## If your rubyforge_project name is different, then edit it and comment out
-  ## the sub! line in the Rakefile
-  s.name              = 'knife-spork'
-  s.version           = '0.1.11'
-  s.date              = '2012-06-05'
-  s.rubyforge_project = 'knife-spork'
-
-  ## Make sure your summary is short. The description may be as long
-  ## as you like.
-  s.summary     = "A workflow plugin to help many devs work with the same chef repo/server"
-  s.description = "A workflow plugin to help many devs work with the same chef repo/server"
-
-  ## List the primary authors. If there are a bunch of authors, it's probably
-  ## better to set the email to an email list or something. If you don't have
-  ## a custom homepage, consider using your GitHub URL or the like.
-  s.authors  = ["Jon Cowie"]
-  s.email    = 'jonlives@gmail.com'
-  s.homepage = 'https://github.com/jonlives/knife-spork'
-
-  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
-  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
-  s.require_paths = %w[lib]
-
-  ## Specify any RDoc options here. You'll want to add your README and
-  ## LICENSE files to the extra_rdoc_files list.
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = %w[README.md]
-
-  ## List your runtime dependencies here. Runtime dependencies are those
-  ## that are needed for an end user to actually USE your code.
-  s.add_dependency('chef', [">= 0.10.4"])
-  s.add_dependency('git', [">= 1.2.5"])
-  s.add_dependency('app_conf', [">= 0.4.0"])
-  s.add_dependency('hipchat', [">= 0.4.0"])
-
-  ## Leave this section as-is. It will be automatically generated from the
-  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
-  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
-  # = MANIFEST =
-  s.files = %w[
-    README.md
-    CHANGELOG.md
-    Rakefile
-    knife-spork.gemspec
-    lib/chef/knife/spork-bump.rb
-    lib/chef/knife/spork-check.rb
-    lib/chef/knife/spork-promote.rb
-    lib/chef/knife/spork-upload.rb
-    lib/knife-spork.rb
-  ]
-  # = MANIFEST =
-
-  ## Test files will be grabbed from the file list. Make sure the path glob
-  ## matches what you actually use.
-  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'knife-spork'
+  gem.version       = '1.0.0'
+  gem.authors       = ["Jon Cowie"]
+  gem.email         = 'jonlives@gmail.com'
+  gem.homepage      = 'https://github.com/jonlives/knife-spork'
+  gem.summary       = "A workflow plugin to help many devs work with the same chef repo/server"
+  gem.description   = "A workflow plugin to help many devs work with the same chef repo/server"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "knife-spork"
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'chef', '>= 0.10.4'
+  gem.add_runtime_dependency 'git', '>= 1.2.5'
+  gem.add_runtime_dependency 'app_conf', '>= 0.4.0'
 end

data/lib/chef/knife/spork-bump.rb

@@ -1,228 +1,54 @@
-#
-# Modifying Author:: Jon Cowie (<jonlives@gmail.com>)
-# Copyright:: Copyright (c) 2011 Jon Cowie
-# License:: GPL
-
-# Based on the knife-cookbook-bump plugin by:
-# Alalanta (no license specified)
-
-require 'app_conf'
 require 'chef/knife'
-require 'chef/cookbook_loader'
-require 'chef/cookbook_uploader'
+require 'knife-spork/runner'
 
 module KnifeSpork
   class SporkBump < Chef::Knife
+    include KnifeSpork::Runner
 
-    TYPE_INDEX = { "major" => 0, "minor" => 1, "patch" => 2, "manual" => 3 }
+    TYPE_INDEX = { :major => 0, :minor => 1, :patch => 2, :manual => 3 }.freeze
 
-    banner "knife spork bump COOKBOOK [MAJOR|MINOR|PATCH|MANUAL]"
-
-      @@gitavail = true
-      deps do
-        begin
-          require "git"
-        rescue LoadError
-            @@gitavail = false
-        end
-      end
+    banner 'knife spork bump COOKBOOK [major|minor|patch|manual]'
 
     def run
-
-      if RUBY_VERSION.to_f < 1.9
-        ui.fatal "Sorry, knife-spork requires ruby 1.9 or newer."
-        exit 1
-      end
-      
       self.config = Chef::Config.merge!(config)
+      @cookbook = load_cookbook(name_args.first)
 
-      @conf = AppConf.new
-      
-      if File.exists?("#{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml")
-        @conf.load("#{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml")
-        ui.msg "Loaded config file #{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml...\n\n"
-      end
-      
-      if File.exists?("/etc/spork-config.yml")
-        @conf.load("/etc/spork-config.yml")
-        ui.msg "Loaded config file /etc/spork-config.yml...\n\n"
-      end
-    
-      if File.exists?(File.expand_path("~/.chef/spork-config.yml"))
-        @conf.load(File.expand_path("~/.chef/spork-config.yml"))
-        ui.msg "Loaded config file #{File.expand_path("~/.chef/spork-config.yml")}...\n\n"
-      end
-        
-      bump_type=""
-      
-      if !config.has_key?(:cookbook_path)
-        ui.fatal "No default cookbook_path; Specify with -o or fix your knife.rb."
-        show_usage
-        exit 1
-      end
-
-      if name_args.size == 0
-        show_usage
-        exit 0
-      end
-
-      if name_args.size == 3
-        bump_type = name_args[1]
-      elsif name_args.size == 2
-        bump_type = name_args.last
-      elsif name_args.size == 1
-        bump_type = "patch"
-      else
-        ui.fatal "Please specify the cookbook whose version you which to bump, and the type of bump you wish to apply."
-        show_usage
-        exit 1
-      end
-      
-      unless TYPE_INDEX.has_key?(bump_type)
-        ui.fatal "Sorry, '#{name_args.last}' isn't a valid bump type.  Specify one of 'major', 'minor', 'patch' or 'manual'"
-        show_usage
-        exit 1
-      end
-      
-      cookbook = name_args.first
-      cookbook_path = cookbook_repo[cookbook].root_dir.gsub("#{cookbook}","")
-        
-      if !@conf.git.nil? && @conf.git.enabled
-        if !@@gitavail
-            ui.msg "Git gem not available, skipping git pull.\n\n"
-        else
-            git_pull_if_repo([cookbook_path])
-        end
-      end
-
-      if bump_type == "manual"
-        manual_version = name_args.last
-        patch_manual(cookbook_path, cookbook, manual_version)
-      else
-          patch(cookbook_path, cookbook, bump_type)
-      end
-
-      if !@conf.git.nil? && @conf.git.enabled
-        if !@@gitavail
-            ui.msg "Git gem not available, skipping git add.\n\n"
-        else
-            git_add(cookbook)
-        end
-      end
+      run_plugins(:before_bump)
+      bump
+      run_plugins(:after_bump)
     end
 
-    def cookbook_repo
-        @cookbook_loader ||= begin
-          Chef::Cookbook::FileVendor.on_create { |manifest| Chef::Cookbook::FileSystemFileVendor.new(manifest, config[:cookbook_path]) }
-          Chef::CookbookLoader.new(config[:cookbook_path])
-        end
-    end
-      
-    def patch(cookbook_path, cookbook, type)
-      t = TYPE_INDEX[type]
-      current_version = get_version(cookbook_path, cookbook).split(".").map{|i| i.to_i}
-      bumped_version = current_version.clone
-      bumped_version[t] = bumped_version[t] + 1
-      while t < 2
-        t+=1
-        bumped_version[t] = 0
-      end
-      metadata_file = File.join(cookbook_path, cookbook, "metadata.rb")
-      old_version = current_version.join('.')
-      new_version = bumped_version.join('.')
-      update_version(new_version, metadata_file)
-      ui.msg("Bumping #{type} level of the #{cookbook} cookbook from #{old_version} to #{new_version}\n\n")
-    end
-
-    def patch_manual(cookbook_path, cookbook, version)
-      current_version = get_version(cookbook_path, cookbook)
-      v = version.split(".")
-      if v.size < 3 or v.size > 3
-        ui.msg "That isn't a valid version number to bump to."
-        exit 1
-      end
+    private
+    def bump
+      old_version = @cookbook.version
 
-      v.each do |v_comp|
-         if !v_comp.is_i?
-           ui.msg "That isn't a valid version number to bump to."
-           exit 1
-         end
+      if bump_type == 3
+        # manual bump
+        version_array = manual_bump_version.split('.')
+      else
+        # major, minor, or patch bump
+        version_array = old_version.split('.').collect{ |i| i.to_i }
+        version_array[bump_type] += 1
+        ((bump_type+1)..2).each{ |i| version_array[i] = 0 } # reset all lower version numbers to 0
       end
 
-      metadata_file = File.join(cookbook_path, cookbook, "metadata.rb")
-      update_version(version, metadata_file)
-      ui.msg("Manually bumped version of the #{cookbook} cookbook from #{current_version} to #{version}")
-    end
+      new_version = version_array.join('.')
 
-    def update_version(new_version, metadata_file)
-      open_file = File.open(metadata_file, "r")
-      body_of_file = open_file.read
-      open_file.close
-      body_of_file.gsub!(/version\s+"[0-9\.]+"/, "version    \"#{new_version}\"")
-      File.open(metadata_file, "w") { |file| file << body_of_file }
-    end
+      metadata_file = "#{@cookbook.root_dir}/metadata.rb"
+      new_contents = File.read(metadata_file).gsub(/version\s+['"][0-9\.]+['"]/, "version \"#{new_version}\"")
+      File.open(metadata_file, 'w'){ |f| f.write(new_contents) }
 
-    def get_version(cookbook_path, cookbook)
-      loader = ::Chef::CookbookLoader.new(cookbook_path)
-      return loader[cookbook].version
+      ui.info "Successfully bumped #{@cookbook.name} to v#{new_version}!"
     end
 
-    def git_add(cookbook)
-      strio = StringIO.new
-      l = Logger.new strio
-      cookbook_path = cookbook_repo[cookbook].root_dir.gsub("#{cookbook}","")
-      begin
-        path = cookbook_path.gsub("/site-cookbooks","").gsub("/cookbooks","")
-        ui.msg "Opening git repo #{path}\n\n"
-        g = Git.open(path, :log => Logger.new(strio))
-        ui.msg "Git add'ing #{cookbook_path}#{cookbook}/metadata.rb\n\n"
-        g.add("#{cookbook_path}/#{cookbook}/metadata.rb")
-      rescue ArgumentError => e
-        ui.warn "Git: The root of your chef repo doesn't look like it's a git repo. Skipping git add...\n\n"
-      rescue
-        ui.warn "Git: Cookbook bump succeeded, but something went wrong with git add metadata.rb, so you'll want to manually git add it. Dumping log info..."
-        ui.warn "#{strio.string}"
-      end
+    def bump_type
+      TYPE_INDEX[(name_args[1] || 'patch').to_sym]
     end
-    
-    def git_pull_if_repo(cookbook_path)
-        strio = StringIO.new
-        l = Logger.new strio
-        begin
-          path = cookbook_path[0].gsub("/site-cookbooks","").gsub("/cookbooks","")
-          ui.msg "Opening git repo #{path}\n\n"
-          g = Git.open(path, :log => Logger.new(strio))
-          ui.msg "Pulling latest changes from git\n\n"
-          output = IO.popen ("cd #{path} && git pull 2>&1")
-          Process.wait
-          exit_code = $?            
-          if exit_code.exitstatus ==  0
-            ui.msg "#{output.read()}\n"
-          else
-            ui.error "#{output.read()}\n"
-            exit 1
-          end
-
-          ui.msg "Pulling latest changes from git submodules (if any)\n\n"
-          output = IO.popen ("cd #{path} && git submodule foreach git pull 2>&1")
-          Process.wait
-          exit_code = $?
-          if exit_code.exitstatus ==  0
-            ui.msg "#{output.read()}\n"
-          else
-            ui.error "#{output.read()}\n"
-            exit 1
-          end
-        rescue ArgumentError => e
-          ui.warn "Git: #{cookbook_path.join} doesn't look like it's a git repo. Skipping git pull...\n\n"
-        end
-      end
-    end
-
-end
 
-class String
-    def is_i?
-       !!(self =~ /^[-+]?[0-9]+$/)
+    def manual_bump_version
+      version = name_args.last
+      validate_version!(version)
+      version
     end
+  end
 end