berkshelf 2.0.0.beta → 2.0.0

data/lib/berkshelf/formatters.rb

@@ -1,6 +1,4 @@
 module Berkshelf
-  # @author Michael Ivey <michael.ivey@riotgames.com>
-  # @author Jamie Winsor <reset@riotgames.com>
   module Formatters
     class << self
       @@formatters = Hash.new
@@ -47,8 +45,6 @@ module Berkshelf
       alias_method :[], :get
     end
 
-    # @author Michael Ivey <michael.ivey@riotgames.com>
-    #
     # @abstract Include and override {#install} {#use} {#upload}
     #   {#msg} {#error} to implement.
     #
@@ -81,7 +77,7 @@ module Berkshelf
         end
       end
 
-      formatter_methods :install, :use, :upload, :msg, :error, :package
+      formatter_methods :install, :use, :upload, :msg, :error, :package, :show
 
       def cleanup_hook
         # run after the task is finished
@@ -95,5 +91,5 @@ module Berkshelf
 end
 
 Dir["#{File.dirname(__FILE__)}/formatters/*.rb"].sort.each do |path|
-  require "berkshelf/formatters/#{File.basename(path, '.rb')}"
+  require_relative "formatters/#{File.basename(path, '.rb')}"
 end

data/lib/berkshelf/formatters/human_readable.rb

@@ -1,6 +1,5 @@
 module Berkshelf
   module Formatters
-    # @author Michael Ivey <michael.ivey@riotgames.com>
     class HumanReadable
       include AbstractFormatter
 
@@ -38,7 +37,14 @@ module Berkshelf
       # @param [String] cookbook
       # @param [String] destination
       def package(cookbook, destination)
-        Berkshelf.ui.info "Cookbook '#{cookbook}' saved to #{destination}!"
+        Berkshelf.ui.info "Cookbook(s) packaged to #{destination}!"
+      end
+
+      # Output Cookbook info message using {Berkshelf.ui}
+      #
+      # @param [CachedCookbook] cookbook
+      def show(cookbook)
+        Berkshelf.ui.info(cookbook.pretty_print)
       end
 
       # Output a generic message using {Berkshelf.ui}

data/lib/berkshelf/formatters/json.rb

@@ -1,6 +1,5 @@
 module Berkshelf
   module Formatters
-    # @author Michael Ivey <michael.ivey@riotgames.com>
     class JSON
       include AbstractFormatter
 
@@ -69,6 +68,13 @@ module Berkshelf
         cookbooks[cookbook][:destination] = destination
       end
 
+      # Output Cookbook info entry to delayed output
+      #
+      # @param [CachedCookbook] cookbook
+      def show(cookbook)
+        cookbooks[cookbook.cookbook_name] = cookbook.pretty_hash
+      end
+
       # Add a generic message entry to delayed output
       #
       # @param [String] message

data/lib/berkshelf/formatters/null.rb

@@ -1,6 +1,5 @@
 module Berkshelf
   module Formatters
-    # @author Seth Vargo <sethvargo@gmail.com>
     class Null
       include AbstractFormatter
 

data/lib/berkshelf/git.rb

@@ -1,9 +1,10 @@
 require 'uri'
-require 'mixlib/shellout'
 
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
   class Git
+    require 'berkshelf/mixin/shellout'
+    extend Berkshelf::Mixin::Shellout
+
     GIT_REGEXP = URI.regexp(%w(http https ssh git+ssh git rsync))
     SCP_REGEXP = /^(.+@)?[\w\d\.-]+:.*$/
 
@@ -21,14 +22,13 @@ module Berkshelf
       def git(*command)
         command.unshift(git_cmd)
         command_str = command.map { |p| quote_cmd_arg(p) }.join(' ')
-        cmd = Mixlib::ShellOut.new(command_str)
-        cmd.run_command
+        result = shellout(command_str)
 
-        unless cmd.exitstatus == 0
-          raise GitError.new(cmd.stderr)
+        unless result.success?
+          raise GitError.new(result.stderr)
         end
 
-        cmd.stdout.chomp
+        result.stdout
       end
 
       # Clone a remote Git repository to disk
@@ -41,7 +41,7 @@ module Berkshelf
       # @return [String]
       #   the destination the URI was cloned to
       def clone(uri, destination = Dir.mktmpdir)
-        git("clone", uri, destination.to_s)
+        git('clone', uri, destination.to_s)
 
         destination
       end
@@ -54,14 +54,14 @@ module Berkshelf
       #   reference to checkout
       def checkout(repo_path, ref)
         Dir.chdir repo_path do
-          git("checkout", "-qf", revision_from_ref(repo_path, ref))
+          git('checkout', '-qf', revision_from_ref(repo_path, ref))
         end
       end
 
       # @param [String] repo_path
       def rev_parse(repo_path)
         Dir.chdir repo_path do
-          git("rev-parse", "HEAD")
+          git('rev-parse', 'HEAD')
         end
       end
 
@@ -78,7 +78,7 @@ module Berkshelf
       # @raise [AmbiguousGitRef] if the ref could refer to more than one revision
       def show_ref(repo_path, ref)
         Dir.chdir repo_path do
-          lines = git('show-ref', "'#{ref}'").lines.to_a
+          lines = git('show-ref', ref).lines.to_a
 
           raise AmbiguousGitRef, ref if lines.size > 1
 
@@ -121,7 +121,7 @@ module Berkshelf
       # @raise [GitNotFound] if executable is not found in system path
       def find_git
         git_path = nil
-        ENV["PATH"].split(::File::PATH_SEPARATOR).each do |path|
+        ENV['PATH'].split(::File::PATH_SEPARATOR).each do |path|
           git_path = detect_git_path(path)
           break if git_path
         end
@@ -138,11 +138,11 @@ module Berkshelf
       # SSH protocol, or HTTPS protocol.
       #
       # @example Valid Git protocol URI
-      #   "git://github.com/reset/thor-foodcritic.git"
+      #   'git://github.com/reset/thor-foodcritic.git'
       # @example Valid HTTPS URI
-      #   "https://github.com/reset/solve.git"
+      #   'https://github.com/reset/solve.git'
       # @example Valid SSH protocol URI
-      #   "git@github.com:reset/solve.git"
+      #   'git@github.com:reset/solve.git'
       #
       # @param [String] uri
       #
@@ -188,7 +188,7 @@ module Berkshelf
         end
 
         def detect_git_path(base_dir)
-          %w{ git git.exe git.cmd }.each do |git_cmd|
+          %w(git git.exe git.cmd).each do |git_cmd|
             potential_path = File.join(base_dir, git_cmd)
             if File.executable?(potential_path)
               return potential_path

data/lib/berkshelf/init_generator.rb

@@ -1,6 +1,6 @@
+require 'kitchen/generator/init'
+
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
-  # @author Josiah Kiehl <jkiehl@riotgames.com>
   class InitGenerator < BaseGenerator
     def initialize(*args)
       super(*args)
@@ -20,17 +20,17 @@ module Berkshelf
     class_option :skip_vagrant,
       type: :boolean,
       default: false,
-      desc: "Skips adding a Vagrantfile and adding supporting gems to the Gemfile"
+      desc: 'Skips adding a Vagrantfile and adding supporting gems to the Gemfile'
 
     class_option :skip_git,
       type: :boolean,
       default: false,
-      desc: "Skips adding a .gitignore and running git init in the cookbook directory"
+      desc: 'Skips adding a .gitignore and running git init in the cookbook directory'
 
     class_option :foodcritic,
       type: :boolean,
       default: false,
-      desc: "Creates a Thorfile with Foodcritic support to lint test your cookbook"
+      desc: 'Creates a Thorfile with Foodcritic support to lint test your cookbook'
 
     class_option :chef_minitest,
       type: :boolean,
@@ -39,12 +39,12 @@ module Berkshelf
     class_option :scmversion,
       type: :boolean,
       default: false,
-      desc: "Creates a Thorfile with SCMVersion support to manage versions for continuous integration"
+      desc: 'Creates a Thorfile with SCMVersion support to manage versions for continuous integration'
 
     class_option :no_bundler,
       type: :boolean,
       default: false,
-      desc: "Skips generation of a Gemfile and other Bundler specific support"
+      desc: 'Skips generation of a Gemfile and other Bundler specific support'
 
     class_option :cookbook_name,
       type: :string
@@ -52,53 +52,55 @@ module Berkshelf
     class_option :skip_test_kitchen,
       type: :boolean,
       default: false,
-      desc: "Skip adding a testing environment to your cookbook"
+      desc: 'Skip adding a testing environment to your cookbook'
 
     def generate
       validate_configuration
       check_option_support
 
-      template "Berksfile.erb", target.join("Berksfile")
+      template 'Berksfile.erb', target.join('Berksfile')
+      template 'Thorfile.erb', target.join('Thorfile')
 
       if options[:chefignore]
-        copy_file "chefignore", target.join(Berkshelf::Chef::Cookbook::Chefignore::FILENAME)
+        copy_file 'chefignore', target.join(Berkshelf::Chef::Cookbook::Chefignore::FILENAME)
       end
 
       unless options[:skip_git]
-        template "gitignore.erb", target.join(".gitignore")
+        template 'gitignore.erb', target.join('.gitignore')
 
-        unless File.exists?(target.join(".git"))
+        unless File.exists?(target.join('.git'))
           inside target do
-            run "git init", capture: true
+            run 'git init', capture: true
           end
         end
       end
 
-      if options[:foodcritic] || options[:scmversion]
-        template "Thorfile.erb", target.join("Thorfile")
-      end
-
       if options[:chef_minitest]
-        empty_directory target.join("files/default/tests/minitest/support")
-        template "default_test.rb.erb", target.join("files/default/tests/minitest/default_test.rb")
-        template "helpers.rb.erb", target.join("files/default/tests/minitest/support/helpers.rb")
+        empty_directory target.join('files/default/tests/minitest/support')
+        template 'default_test.rb.erb', target.join('files/default/tests/minitest/default_test.rb')
+        template 'helpers.rb.erb', target.join('files/default/tests/minitest/support/helpers.rb')
       end
 
       if options[:scmversion]
-        create_file target.join("VERSION"), "0.1.0"
+        create_file target.join('VERSION'), '0.1.0'
       end
 
       unless options[:no_bundler]
-        template "Gemfile.erb", target.join("Gemfile")
+        template 'Gemfile.erb', target.join('Gemfile')
       end
 
       unless options[:skip_test_kitchen]
-        Kitchen::Generator::Init.new([], options).invoke_all
+        # Temporarily use Dir.chdir to ensure the destionation_root of test kitchen's generator
+        # is where we expect until this bug can be addressed:
+        # https://github.com/opscode/test-kitchen/pull/140
+        Dir.chdir target do
+          # Kitchen::Generator::Init.new([], {}, destination_root: target).invoke_all
+          Kitchen::Generator::Init.new([], {}).invoke_all
+        end
       end
 
       unless options[:skip_vagrant]
-        template "Vagrantfile.erb", target.join("Vagrantfile")
-        ::Berkshelf::Cli.new([], berksfile: target.join("Berksfile")).invoke(:install)
+        template 'Vagrantfile.erb', target.join('Vagrantfile')
       end
     end
 
@@ -114,7 +116,7 @@ module Berkshelf
       #   name of the cookbook
       def cookbook_name
         @cookbook_name ||= begin
-          metadata = Ridley::Chef::Cookbook::Metadata.from_file(target.join("metadata.rb").to_s)
+          metadata = Ridley::Chef::Cookbook::Metadata.from_file(target.join('metadata.rb').to_s)
           metadata.name.empty? ? File.basename(target) : metadata.name
         rescue CookbookNotFound, IOError
           File.basename(target)

data/lib/berkshelf/location.rb

@@ -1,9 +1,10 @@
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
   module Location
     OPSCODE_COMMUNITY_API = 'http://cookbooks.opscode.com/api/v1/cookbooks'.freeze
 
     module ClassMethods
+      require_relative 'cookbook_source'
+
       # Returns the location identifier key for the class
       #
       # @return [Symbol]
@@ -31,14 +32,14 @@ module Berkshelf
       # version of the Cookbook can be downloaded from
       #
       # @example:
-      #   constraint = Solve::Constraint.new("~> 0.101.2")
+      #   constraint = Solve::Constraint.new('~> 0.101.2')
       #   versions = {
-      #     "1.0.0" => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/1_0_0",
-      #     "2.0.0" => "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/2_0_0"
+      #     '1.0.0' => 'http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/1_0_0',
+      #     '2.0.0' => 'http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/2_0_0'
       #   }
       #
       #   subject.solve_for_constraint(versions, constraint) =>
-      #     [ "2.0.0", "http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/2_0_0" ]
+      #     [ '2.0.0', 'http://cookbooks.opscode.com/api/v1/cookbooks/nginx/versions/2_0_0' ]
       #
       # @param [String, Solve::Constraint] constraint
       #   version constraint to solve for
@@ -71,19 +72,19 @@ module Berkshelf
       # instantiated.
       #
       # @example
-      #   Location.init("nginx", ">= 0.0.0", git: "git://github.com/RiotGames/artifact-cookbook.git") =>
+      #   Location.init('nginx', '>= 0.0.0', git: 'git://github.com/RiotGames/artifact-cookbook.git') =>
       #     instantiates a GitLocation
       #
-      #   Location.init("nginx", ">= 0.0.0", path: "/Users/reset/code/nginx-cookbook") =>
+      #   Location.init('nginx', '>= 0.0.0', path: '/Users/reset/code/nginx-cookbook') =>
       #     instantiates a PathLocation
       #
-      #   Location.init("nginx", ">= 0.0.0", site: "http://cookbooks.opscode.com/api/v1/cookbooks") =>
+      #   Location.init('nginx', '>= 0.0.0', site: 'http://cookbooks.opscode.com/api/v1/cookbooks') =>
       #     instantiates a SiteLocation
       #
-      #   Location.init("nginx", ">= 0.0.0", chef_api: "https://api.opscode.com/organizations/vialstudios") =>
+      #   Location.init('nginx', '>= 0.0.0', chef_api: 'https://api.opscode.com/organizations/vialstudios') =>
       #     instantiates a ChefAPILocation
       #
-      #   Location.init("nginx", ">= 0.0.0") =>
+      #   Location.init('nginx', '>= 0.0.0') =>
       #     instantiates a SiteLocation
       #
       # @param [String] name
@@ -179,5 +180,5 @@ module Berkshelf
 end
 
 Dir["#{File.dirname(__FILE__)}/locations/*.rb"].sort.each do |path|
-  require "berkshelf/locations/#{File.basename(path, '.rb')}"
+  require_relative "locations/#{File.basename(path, '.rb')}"
 end

data/lib/berkshelf/locations/chef_api_location.rb

@@ -1,5 +1,4 @@
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
   class ChefAPILocation
     class << self
       # @return [Proc]
@@ -174,7 +173,8 @@ module Berkshelf
         else
           conn.cookbook.latest_version(name)
         end
-      rescue Ridley::Errors::HTTPNotFound
+      rescue Ridley::Errors::HTTPNotFound,
+             Ridley::Errors::ResourceNotFound
         @target_cookbook = nil
       end
 

data/lib/berkshelf/locations/git_location.rb

@@ -1,5 +1,4 @@
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
   class GitLocation
     class << self
       # Create a temporary directory for the cloned repository within Berkshelf's

data/lib/berkshelf/locations/github_location.rb

@@ -1,5 +1,4 @@
 module Berkshelf
-  # @author Josiah Kiehl <jkiehl@riotgames.com>
   class GithubLocation < GitLocation
     DEFAULT_PROTOCOL = :git
 

data/lib/berkshelf/locations/path_location.rb

@@ -1,5 +1,4 @@
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
   class PathLocation
     class << self
       # Expand and return a string representation of the given path if it is
@@ -12,7 +11,7 @@ module Berkshelf
       # @return [String]
       def normalize_path(path)
         path = path.to_s
-        if (path[0] == "~") || Pathname.new(path).absolute?
+        if (path[0] == '~') || Pathname.new(path).absolute?
           File.expand_path(path)
         else
           path

data/lib/berkshelf/locations/site_location.rb

@@ -1,5 +1,4 @@
 module Berkshelf
-  # @author Jamie Winsor <reset@riotgames.com>
   class SiteLocation
     extend Forwardable
     include Location
@@ -22,7 +21,9 @@ module Berkshelf
       @name               = name
       @version_constraint = version_constraint
 
-      api_uri = if options[:site].nil? || SHORTNAMES.has_key?(options[:site])
+      api_uri = if options[:site].nil?
+        SHORTNAMES[:opscode]
+      elsif SHORTNAMES.has_key?(options[:site])
         SHORTNAMES[options[:site]]
       elsif options[:site].kind_of?(Symbol)
         raise InvalidSiteShortnameError.new(options[:site])

data/lib/berkshelf/lockfile.rb

@@ -2,9 +2,9 @@ module Berkshelf
   # The object representation of the Berkshelf lockfile. The lockfile is useful
   # when working in teams where the same cookbook versions are desired across
   # multiple workstations.
-  #
-  # @author Seth Vargo <sethvargo@gmail.com>
   class Lockfile
+    require_relative 'cookbook_source'
+
     # @return [Pathname]
     #   the path to this Lockfile
     attr_reader :filepath
@@ -39,8 +39,8 @@ module Berkshelf
         hash = JSON.parse(contents, symbolize_names: true)
       rescue JSON::ParserError
         if contents =~ /^cookbook ["'](.+)["']/
-          Berkshelf.ui.warn "You are using the old lockfile format. Attempting to convert..."
-          hash = LockfileLegacy.parse(contents)
+          Berkshelf.ui.warn 'You are using the old lockfile format. Attempting to convert...'
+          hash = LockfileLegacy.parse(berksfile, contents)
         else
           raise
         end
@@ -194,20 +194,23 @@ module Berkshelf
 
       # Legacy support for old lockfiles
       #
-      # @author Seth Vargo <sethvargo@gmail.com>
-      # @todo Remove this class in the next major release.
+      # @todo Remove this class in Berkshelf 3.0.0
       class LockfileLegacy
+        require 'pathname'
+
         class << self
           # Read the old lockfile content and instance eval in context.
           #
+          # @param [Berkshelf::Berksfile] berksfile
+          #   the associated berksfile
           # @param [String] content
           #   the string content read from a legacy lockfile
-          def parse(content)
+          def parse(berksfile, content)
             sources = {}.tap do |hash|
               content.split("\n").each do |line|
                 next if line.empty?
 
-                source = self.new(line)
+                source = self.new(berksfile, line)
                 hash[source.name] = source.options
               end
             end
@@ -227,11 +230,16 @@ module Berkshelf
         #   the name of this cookbook
         attr_reader :name
 
+        # @return [Berkshelf::Berksfile]
+        #   the berksfile
+        attr_reader :berksfile
+
         # Create a new legacy lockfile for processing
         #
         # @param [String] content
         #   the content to parse out and convert to a hash
-        def initialize(content)
+        def initialize(berksfile, content)
+          @berksfile = berksfile
           instance_eval(content).to_hash
         end
 
@@ -244,8 +252,19 @@ module Berkshelf
         #   the locked version of this cookbook
         def cookbook(name, options = {})
           @name = name
-          @options = options
+          @options = manipulate(options)
         end
+
+        private
+          # Perform various manipulations on the hash.
+          #
+          # @param [Hash] options
+          def manipulate(options = {})
+            if options[:path]
+              options[:path] = berksfile.find(name).instance_variable_get(:@options)[:path] || options[:path]
+            end
+            options
+          end
       end
   end
 end