berkshelf 0.4.0 → 0.5.0.rc1

data/lib/berkshelf/cli.rb

@@ -1,4 +1,5 @@
 require 'thor'
+require 'thor/monkies'
 require 'berkshelf'
 
 module Berkshelf
@@ -11,12 +12,11 @@ module Berkshelf
       end
     end
     
-    def initialize(*)
-      super
-      # JW TODO: Replace Chef::Knife::UI with our own UI class
-      ::Berkshelf.ui = Chef::Knife::UI.new(STDOUT, STDERR, STDIN, {})
-      ::Berkshelf.config_path = @options[:config]
-      ::Berkshelf.set_format @options[:format]
+    def initialize(*args)
+      super(*args)
+      self.shell = Berkshelf.ui
+      Berkshelf.config_path = @options[:config]
+      Berkshelf.set_format @options[:format]
       @options = options.dup # unfreeze frozen options Hash from Thor
     end
 
@@ -36,33 +36,32 @@ module Berkshelf
       banner: "PATH"
     class_option :format,
       type: :string,
+      default: "human",
       desc: "Output format to use.",
       aliases: "-F",
       banner: "FORMAT"
 
-    method_option :shims,
-      type: :string,
-      default: nil,
-      lazy_default: File.join(Dir.pwd, "cookbooks"),
-      desc: "Create a directory of shims pointing to Cookbook Versions.",
-      banner: "PATH"
-    method_option :without,
+    method_option :except,
       type: :array,
-      default: Array.new,
       desc: "Exclude cookbooks that are in these groups.",
-      aliases: "-w"
+      aliases: "-e"
+    method_option :only,
+      type: :array,
+      desc: "Only cookbooks that are in these groups.",
+      aliases: "-o"
     method_option :berksfile,
       type: :string,
       default: File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME),
       desc: "Path to a Berksfile to operate off of.",
       aliases: "-b",
       banner: "PATH"
+    method_option :path,
+      type: :string,
+      desc: "Path to install cookbooks to (i.e. vendor/cookbooks).",
+      aliases: "-p",
+      banner: "PATH"
     desc "install", "Install the Cookbooks specified by a Berksfile or a Berksfile.lock."
     def install
-      unless options[:shims].nil?
-        options[:shims] = File.expand_path(options[:shims])
-      end
-
       berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
       berksfile.install(options)
     end
@@ -73,11 +72,14 @@ module Berkshelf
       desc: "Path to a Berksfile to operate off of.",
       aliases: "-b",
       banner: "PATH"
-    method_option :without,
+    method_option :except,
       type: :array,
-      default: Array.new,
       desc: "Exclude cookbooks that are in these groups.",
-      aliases: "-w"
+      aliases: "-e"
+    method_option :only,
+      type: :array,
+      desc: "Only cookbooks that are in these groups.",
+      aliases: "-o"
     desc "update", "Update all Cookbooks and their dependencies specified by a Berksfile to their latest versions."
     def update
       Lockfile.remove!
@@ -90,11 +92,14 @@ module Berkshelf
       desc: "Path to a Berksfile to operate off of.",
       aliases: "-b",
       banner: "PATH"
-    method_option :without,
+    method_option :except,
       type: :array,
-      default: Array.new,
       desc: "Exclude cookbooks that are in these groups.",
-      aliases: "-w"
+      aliases: "-e"
+    method_option :only,
+      type: :array,
+      desc: "Only cookbooks that are in these groups.",
+      aliases: "-o"
     method_option :freeze,
       type: :boolean,
       default: false,
@@ -107,7 +112,13 @@ module Berkshelf
     def upload
       Berkshelf.load_config 
       berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
-      berksfile.upload(Chef::Config[:chef_server_url], options)
+
+      berksfile.upload(
+        server_url: Chef::Config[:chef_server_url],
+        client_name: Chef::Config[:node_name],
+        client_key: Chef::Config[:client_key],
+        organization: ChefAPILocation.extract_organization(Chef::Config[:chef_server_url])
+      )
     end
 
     desc "init [PATH]", "Prepare a local path to have its Cookbook dependencies managed by Berkshelf."

data/lib/berkshelf/cookbook_source.rb

@@ -69,6 +69,8 @@ module Berkshelf
     attr_reader :location
     attr_accessor :cached_cookbook
 
+    def_delegator :cached_cookbook, :version, :locked_version
+
     #  @param [String] name
     #  @param [Hash] options
     #
@@ -132,14 +134,22 @@ module Berkshelf
       groups.include?(group.to_sym)
     end
 
-    def locked_version
-      @locked_version || cached_cookbook.version
-    end
-
     def to_s
       msg = "#{self.name} (#{self.version_constraint}) groups: #{self.groups}"
       msg << " location: #{self.location}" if self.location
       msg
     end
+
+    def to_hash
+      {}.tap do |h|
+        h[:name]           = self.name
+        h[:locked_version] = self.locked_version
+        h[:location]       = self.location.to_hash if self.location
+      end
+    end
+
+    def to_json
+      MultiJson.dump(self.to_hash, pretty: true)
+    end
   end
 end

data/lib/berkshelf/errors.rb

@@ -12,6 +12,7 @@ module Berkshelf
   end
 
   class InternalError < BerkshelfError; status_code(99); end
+  class ArgumentError < InternalError; end
   class AbstractFunction < InternalError
     def to_s
       "Function must be implemented on includer"
@@ -74,7 +75,9 @@ module Berkshelf
     status_code(113)
 
     def status_code
-      @original_error ? @original_error.status_code : 113
+      @original_error.respond_to?(:status_code) ? @original_error.status_code : 113
     end
   end
+
+  class AmbiguousCookbookName < BerkshelfError; status_code(114); end
 end

data/lib/berkshelf/formatters.rb

@@ -1,10 +1,74 @@
 module Berkshelf
+  # @author Michael Ivey <ivey@gweezlebur.com>
+  # @author Jamie Winsor <jamie@vialstudios.com>
   module Formatters
+    class << self
+      @@formatters = Hash.new
+
+      # Access the formatters map that links string symbols to Formatter
+      # implementations
+      #
+      # @return [Hash]
+      def formatters
+        @@formatters
+      end
+
+      # @param [#to_sym] id
+      # @param [Constant] klass
+      #
+      # @raise [Berkshelf::InternalError] if an ID that has already been registered is attempted
+      #   to be registered again
+      #
+      # @return [Hash]
+      #   a hash of registered formatters
+      def register(id, klass)
+        unless id.respond_to?(:to_sym)
+          raise ArgumentError, "Invalid Formatter ID: must respond to #to_sym. You gave: #{id}"
+        end
+
+        id = id.to_sym
+        if self.formatters.has_key?(id)
+          raise Berkshelf::InternalError, "Formatter ID '#{id}' already registered"
+        end
+
+        self.formatters[id] = klass
+      end
+
+      # @param [#to_sym] id
+      #
+      # @return [~AbstractFormatter, nil]
+      def get(id)
+        unless id.respond_to?(:to_sym)
+          raise ArgumentError, "Invalid Formatter ID: must respond to #to_sym. You gave: #{id}"
+        end
+
+        self.formatters.fetch(id.to_sym, nil)
+      end
+      alias_method :[], :get
+    end
+
+    # @author Michael Ivey <ivey@gweezlebur.com>
+    #
     # @abstract Include and override {#install} {#use} {#upload} 
-    #   {#shims_written} {#msg} {#error} to implement.
+    #   {#msg} {#error} to implement.
     #
     #   Implement {#cleanup_hook} to run any steps required to run after the task is finished
     module AbstractFormatter
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        # @param [Symbol] id
+        #
+        # @raise [Berkshelf::InternalError] if an ID that has already been registered is attempted
+        #   to be registered again
+        #
+        # @return [Hash]
+        #   a hash of registered formatters
+        def register_formatter(id)
+          Formatters.register(id, self)
+        end
+      end
+
       def cleanup_hook
         # run after the task is finished
       end
@@ -21,10 +85,6 @@ module Berkshelf
         raise AbstractFunction, "#upload must be implemented on #{self.class}"
       end
 
-      def shims_written(directory)
-        raise AbstractFunction, "#shims_written must be implemented on #{self.class}"
-      end
-
       def msg(message)
         raise AbstractFunction, "#msg must be implemented on #{self.class}"
       end
@@ -32,6 +92,10 @@ module Berkshelf
       def error(message)
         raise AbstractFunction, "#error must be implemented on #{self.class}"
       end
+
+      private
+
+        attr_reader :args
     end
   end
 end

data/lib/berkshelf/formatters/human_readable.rb

@@ -1,30 +1,48 @@
 module Berkshelf
   module Formatters
+    # @author Michael Ivey <ivey@gweezlebur.com>
     class HumanReadable
       include AbstractFormatter
 
-      Berkshelf.formatters["human"] = self
+      register_formatter :human
 
+      # Output a Cookbook installation message using {Berkshelf.ui}
+      #
+      # @param [String] cookbook
+      # @param [String] version
+      # @param [~Location] location
       def install(cookbook, version, location)
         Berkshelf.ui.info "Installing #{cookbook} (#{version}) from #{location}"
       end
 
-      def use(cookbook, version, path=nil)
+      # Output a Cookbook use message using {Berkshelf.ui}
+      #
+      # @param [String] cookbook
+      # @param [String] version
+      # @param [String] path
+      def use(cookbook, version, path = nil)
         Berkshelf.ui.info "Using #{cookbook} (#{version})#{' at '+path if path}"
       end
 
-      def upload(cookbook, version, chef_server_url)
-        Berkshelf.ui.info "Uploading #{cookbook} (#{version}) to: '#{chef_server_url}'"
-      end
-
-      def shims_written(directory)
-        Berkshelf.ui.info "Shims written to: '#{directory}'"
+      # Output a Cookbook upload message using {Berkshelf.ui}
+      #
+      # @param [String] cookbook
+      # @param [String] version
+      # @param [String] chef_api_url
+      def upload(cookbook, version, chef_api_url)
+        Berkshelf.ui.info "Uploading #{cookbook} (#{version}) to: '#{chef_api_url}'"
       end
 
+      # Output a generic message using {Berkshelf.ui}
+      #
+      # @param [String] message
       def msg(message)
         Berkshelf.ui.info message
       end
 
+      # Output an error message using {Berkshelf.ui}
+      #
+      # @param [String] message
       def error(message)
         Berkshelf.ui.error message
       end

data/lib/berkshelf/formatters/json.rb

@@ -1,53 +1,81 @@
 module Berkshelf
   module Formatters
+    # @author Michael Ivey <ivey@gweezlebur.com>
     class JSON
       include AbstractFormatter
 
-      Berkshelf.formatters["json"] = self
+      register_formatter :json
 
       def initialize
-        @output = {cookbooks: [], errors: [], messages: []}
-        @cookbooks = {}
+        @output = {
+          cookbooks: Array.new,
+          errors: Array.new,
+          messages: Array.new
+        }
+        @cookbooks = Hash.new
         super
       end
 
       def cleanup_hook
-        @cookbooks.each do |name, details|
+        cookbooks.each do |name, details|
           details[:name] = name
-          @output[:cookbooks] << details
+          output[:cookbooks] << details
         end
-        print @output.to_json
+        
+        print MultiJson.dump(output)
       end
 
+      # Add a Cookbook installation entry to delayed output
+      #
+      # @param [String] cookbook
+      # @param [String] version
+      # @param [~Location] location
       def install(cookbook, version, location)
-        @cookbooks[cookbook] ||= {}
-        @cookbooks[cookbook][:version] = version
-        @cookbooks[cookbook][:location] = location
+        cookbooks[cookbook] ||= {}
+        cookbooks[cookbook][:version] = version
+        cookbooks[cookbook][:location] = location.to_s
       end
 
-      def use(cookbook, version, path=nil)
-        @cookbooks[cookbook] ||= {}
-        @cookbooks[cookbook][:version] = version
-        @cookbooks[cookbook][:location] = path if path
+      # Add a Cookbook use entry to delayed output
+      #
+      # @param [String] cookbook
+      # @param [String] version
+      # @param [String] path
+      def use(cookbook, version, path = nil)
+        cookbooks[cookbook] ||= {}
+        cookbooks[cookbook][:version] = version
+        cookbooks[cookbook][:location] = path if path
       end
 
-      def upload(cookbook, version, chef_server_url)
-        @cookbooks[cookbook] ||= {}
-        @cookbooks[cookbook][:version] = version
-        @cookbooks[cookbook][:uploaded_to] = chef_server_url
-      end
-
-      def shims_written(directory)
-        @output[:shims_dir] = directory
+      # Add a Cookbook upload entry to delayed output
+      #
+      # @param [String] cookbook
+      # @param [String] version
+      # @param [String] chef_api_url
+      def upload(cookbook, version, chef_api_url)
+        cookbooks[cookbook] ||= {}
+        cookbooks[cookbook][:version] = version
+        cookbooks[cookbook][:uploaded_to] = chef_api_url
       end
 
+      # Add a generic message entry to delayed output
+      #
+      # @param [String] message
       def msg(message)
-        @output[:messages] << message
+        output[:messages] << message
       end
 
+      # Add an error message entry to delayed output
+      #
+      # @param [String] message
       def error(message)
-        @output[:errors] << message
+        output[:errors] << message
       end
+
+      private
+
+        attr_reader :output
+        attr_reader :cookbooks
     end
   end
 end

data/lib/berkshelf/init_generator.rb

@@ -1,8 +1,8 @@
 module Berkshelf
   # @author Jamie Winsor <jamie@vialstudios.com>
   class InitGenerator < BaseGenerator
-    def initialize(*)
-      super
+    def initialize(*args)
+      super(*args)
       if @options[:cookbook_name]
         @cookbook_name = @options[:cookbook_name]
       end
@@ -54,7 +54,7 @@ module Berkshelf
         template "gitignore.erb", target.join(".gitignore")
         unless File.exists?(target.join(".git"))
           inside target do
-            run "git init"
+            run "git init", capture: true
           end
         end
       end
@@ -73,7 +73,7 @@ module Berkshelf
 
       if options[:vagrant]
         template "Vagrantfile.erb", target.join("Vagrantfile")
-        ::Berkshelf::Cli.new([], berksfile: target.join("Berksfile"), shims: target.join("cookbooks")).invoke(:install)
+        ::Berkshelf::Cli.new([], berksfile: target.join("Berksfile")).invoke(:install)
       end
     end