berkshelf 3.0.0.beta7 → 3.0.0.beta8

data/lib/berkshelf/formatters/base.rb

@@ -0,0 +1,42 @@
+module Berkshelf
+  class BaseFormatter
+    class << self
+      #
+      # @macro formatter_method
+      #   @method $1(*args)
+      #     Create a formatter method for the declaration
+      #
+      def formatter_method(name)
+        class_eval <<-EOH, __FILE__, __LINE__ + 1
+          def #{name}(*args)
+            raise AbstractFunction,
+              "##{name} must be implemented on \#{self.class.name}!"
+          end
+        EOH
+      end
+    end
+
+    # UI methods
+    formatter_method :deprecation
+    formatter_method :error
+    formatter_method :msg
+    formatter_method :warn
+
+    # Object methods
+    formatter_method :fetch
+    formatter_method :install
+    formatter_method :list
+    formatter_method :outdated
+    formatter_method :package
+    formatter_method :search
+    formatter_method :show
+    formatter_method :skip
+    formatter_method :upload
+    formatter_method :use
+    formatter_method :vendor
+    formatter_method :version
+
+    # The cleanup hook is defined by subclasses and is called by the CLI.
+    def cleanup_hook; end
+  end
+end

data/lib/berkshelf/formatters/human.rb

@@ -0,0 +1,145 @@
+module Berkshelf
+  class HumanFormatter < BaseFormatter
+    # Output the version of Berkshelf
+    def version
+      Berkshelf.ui.info Berkshelf::VERSION
+    end
+
+    # @param [Berkshelf::Dependency] dependency
+    def fetch(dependency)
+      Berkshelf.ui.info "Fetching '#{dependency.name}' from #{dependency.location}"
+    end
+
+    # Output a Cookbook installation message using {Berkshelf.ui}
+    #
+    # @param [Source] source
+    #   the source the dependency is being downloaded from
+    # @param [RemoteCookbook] cookbook
+    #   the cookbook to be downloaded
+    def install(source, cookbook)
+      message = "Installing #{cookbook.name} (#{cookbook.version})"
+
+      unless source.default?
+        message << " from #{source}"
+        message << " ([#{cookbook.location_type}] #{cookbook.location_path})"
+      end
+
+      Berkshelf.ui.info(message)
+    end
+
+    # Output a Cookbook use message using {Berkshelf.ui}
+    #
+    # @param [Dependency] dependency
+    def use(dependency)
+      message =  "Using #{dependency.name} (#{dependency.locked_version})"
+      message << " from #{dependency.location}" if dependency.location
+      Berkshelf.ui.info(message)
+    end
+
+    # Output a Cookbook upload message using {Berkshelf.ui}
+    #
+    # @param [Berkshelf::CachedCookbook] cookbook
+    # @param [Ridley::Connection] conn
+    def upload(cookbook, conn)
+      Berkshelf.ui.info "Uploading #{cookbook.cookbook_name} (#{cookbook.version}) to: '#{conn.server_url}'"
+    end
+
+    # Output a Cookbook skip message using {Berkshelf.ui}
+    #
+    # @param [Berkshelf::CachedCookbook] cookbook
+    # @param [Ridley::Connection] conn
+    def skip(cookbook, conn)
+      Berkshelf.ui.info "Skipping #{cookbook.cookbook_name} (#{cookbook.version}) (frozen)"
+    end
+
+    # Output a list of outdated cookbooks and the most recent version
+    # using {Berkshelf.ui}
+    #
+    # @param [Hash] hash
+    #   the list of outdated cookbooks in the format
+    #   { 'cookbook' => { 'api.berkshelf.com' => #<Cookbook> } }
+    def outdated(hash)
+      hash.keys.each do |name|
+        hash[name].each do |source, newest|
+          string = "  * #{newest.name} (#{newest.version})"
+          unless source == Berksfile::DEFAULT_API_URL
+            string << " [#{source}]"
+          end
+          Berkshelf.ui.info string
+        end
+      end
+    end
+
+    # Output a Cookbook package message using {Berkshelf.ui}
+    #
+    # @param [String] destination
+    def package(destination)
+      Berkshelf.ui.info "Cookbook(s) packaged to #{destination}"
+    end
+
+    # Output a list of cookbooks using {Berkshelf.ui}
+    #
+    # @param [Array<Dependency>] list
+    def list(dependencies)
+      Berkshelf.ui.info "Cookbooks installed by your Berksfile:"
+      dependencies.each do |dependency|
+        out =  "  * #{dependency}"
+        out << " from #{dependency.location}" if dependency.location
+        Berkshelf.ui.info(out)
+      end
+    end
+
+    # Ouput Cookbook search results using {Berkshelf.ui}
+    #
+    # @param [Array<APIClient::RemoteCookbook>] results
+    def search(results)
+      results.sort_by(&:name).each do |remote_cookbook|
+        Berkshelf.ui.info "#{remote_cookbook.name} (#{remote_cookbook.version})"
+      end
+    end
+
+    # Output Cookbook info message using {Berkshelf.ui}
+    #
+    # @param [CachedCookbook] cookbook
+    def show(cookbook)
+      Berkshelf.ui.info(cookbook.pretty_print)
+    end
+
+    # Output Cookbook vendor info message using {Berkshelf.ui}
+    #
+    # @param [CachedCookbook] cookbook
+    # @param [String] destination
+    def vendor(cookbook, destination)
+      cookbook_destination = File.join(destination, cookbook.cookbook_name)
+      Berkshelf.ui.info "Vendoring #{cookbook.cookbook_name} (#{cookbook.version}) to #{cookbook_destination}"
+    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
+
+    # Output a warning message using {Berkshelf.ui}
+    #
+    # @param [String] message
+    def warn(message)
+      Berkshelf.ui.warn message
+    end
+
+    # Output a deprecation warning
+    #
+    # @param [String] message
+    def deprecation(message)
+      Berkshelf.ui.info "DEPRECATED: #{message}"
+    end
+  end
+end

data/lib/berkshelf/formatters/json.rb

@@ -1,164 +1,180 @@
 module Berkshelf
-  module Formatters
-    class JSON
-      include AbstractFormatter
-
-      register_formatter :json
+  class JsonFormatter < BaseFormatter
+    # Output the version of Berkshelf
+    def version
+      @output = { version: Berkshelf::VERSION }
+    end
 
-      # Output the version of Berkshelf
-      def version
-        @output = { version: Berkshelf::VERSION }
-      end
+    def initialize
+      @output = {
+        cookbooks: [],
+        errors:    [],
+        messages:  [],
+        warnings:  [],
+      }
+      @cookbooks = Hash.new
 
-      def initialize
-        @output = {
-          cookbooks: Array.new,
-          errors: Array.new,
-          messages: Array.new
-        }
-        @cookbooks = Hash.new
+      Berkshelf.ui.mute { super }
+    end
 
-        Berkshelf.ui.mute { super }
+    def cleanup_hook
+      cookbooks.each do |name, details|
+        details[:name] = name
+        output[:cookbooks] << details
       end
 
-      def cleanup_hook
-        cookbooks.each do |name, details|
-          details[:name] = name
-          output[:cookbooks] << details
-        end
-
-        puts ::JSON.pretty_generate(output)
-      end
+      puts ::JSON.pretty_generate(output)
+    end
 
-      # @param [Berkshelf::Dependency] dependency
-      def fetch(dependency)
-        cookbooks[dependency] ||= {}
-        cookbooks[dependency][:version]  = dependency.locked_version.to_s
-        cookbooks[dependency][:location] = dependency.location
-      end
+    # @param [Berkshelf::Dependency] dependency
+    def fetch(dependency)
+      cookbooks[dependency] ||= {}
+      cookbooks[dependency][:version]  = dependency.locked_version.to_s
+      cookbooks[dependency][:location] = dependency.location
+    end
 
-      # Add a Cookbook installation entry to delayed output
-      #
-      # @param [Source] source
-      #   the source the dependency is being downloaded from
-      # @param [RemoteCookbook] cookbook
-      #   the cookbook to be downloaded
-      def install(source, cookbook)
-        cookbooks[cookbook.name] ||= {}
-        cookbooks[cookbook.name][:version] = cookbook.version
-
-        unless source.default?
-          cookbooks[cookbook.name][:api_source]    = source.uri
-          cookbooks[cookbook.name][:location_path] = cookbook.location_path
-        end
+    # Add a Cookbook installation entry to delayed output
+    #
+    # @param [Source] source
+    #   the source the dependency is being downloaded from
+    # @param [RemoteCookbook] cookbook
+    #   the cookbook to be downloaded
+    def install(source, cookbook)
+      cookbooks[cookbook.name] ||= {}
+      cookbooks[cookbook.name][:version] = cookbook.version
+
+      unless source.default?
+        cookbooks[cookbook.name][:api_source]    = source.uri
+        cookbooks[cookbook.name][:location_path] = cookbook.location_path
       end
+    end
 
-      # Add a Cookbook use entry to delayed output
-      #
-      # @param [Dependency] dependency
-      def use(dependency)
-        cookbooks[dependency.name] ||= {}
-        cookbooks[dependency.name][:version] = dependency.cached_cookbook.version
+    # Add a Cookbook use entry to delayed output
+    #
+    # @param [Dependency] dependency
+    def use(dependency)
+      cookbooks[dependency.name] ||= {}
+      cookbooks[dependency.name][:version] = dependency.cached_cookbook.version
 
-        if dependency.location.is_a?(PathLocation)
-          cookbooks[dependency.name][:metadata] = true if dependency.location.metadata?
-          cookbooks[dependency.name][:location] = dependency.location.relative_path
-        end
+      if dependency.location.is_a?(PathLocation)
+        cookbooks[dependency.name][:metadata] = true if dependency.location.metadata?
+        cookbooks[dependency.name][:location] = dependency.location.relative_path
       end
+    end
 
-      # Add a Cookbook upload entry to delayed output
-      #
-      # @param [Berkshelf::CachedCookbook] cookbook
-      # @param [Ridley::Connection] conn
-      def upload(cookbook, conn)
-        name = cookbook.cookbook_name
-        cookbooks[name] ||= {}
-        cookbooks[name][:version] = cookbook.version
-        cookbooks[name][:uploaded_to] = conn.server_url
-      end
+    # Add a Cookbook upload entry to delayed output
+    #
+    # @param [Berkshelf::CachedCookbook] cookbook
+    # @param [Ridley::Connection] conn
+    def upload(cookbook, conn)
+      name = cookbook.cookbook_name
+      cookbooks[name] ||= {}
+      cookbooks[name][:version] = cookbook.version
+      cookbooks[name][:uploaded_to] = conn.server_url
+    end
 
-      # Add a Cookbook skip entry to delayed output
-      #
-      # @param [Berkshelf::CachedCookbook] cookbook
-      # @param [Ridley::Connection] conn
-      def skip(cookbook, conn)
-        name = cookbook.cookbook_name
-        cookbooks[name] ||= {}
-        cookbooks[name][:version] = cookbook.version
-        cookbooks[name][:skipped] = true
-      end
+    # Add a Cookbook skip entry to delayed output
+    #
+    # @param [Berkshelf::CachedCookbook] cookbook
+    # @param [Ridley::Connection] conn
+    def skip(cookbook, conn)
+      name = cookbook.cookbook_name
+      cookbooks[name] ||= {}
+      cookbooks[name][:version] = cookbook.version
+      cookbooks[name][:skipped] = true
+    end
 
-      # Output a list of outdated cookbooks and the most recent version
-      # to delayed output
-      #
-      # @param [Hash] hash
-      #   the list of outdated cookbooks in the format
-      #   { 'cookbook' => { 'api.berkshelf.com' => #<Cookbook> } }
-      def outdated(hash)
-        hash.keys.each do |name|
-          hash[name].each do |source, cookbook|
-            cookbooks[name] ||= {}
-            cookbooks[name][:version] = cookbook.version
-            cookbooks[name][:sources] ||= {}
-            cookbooks[name][:sources][source] = cookbook
-          end
+    # Output a list of outdated cookbooks and the most recent version
+    # to delayed output
+    #
+    # @param [Hash] hash
+    #   the list of outdated cookbooks in the format
+    #   { 'cookbook' => { 'api.berkshelf.com' => #<Cookbook> } }
+    def outdated(hash)
+      hash.keys.each do |name|
+        hash[name].each do |source, cookbook|
+          cookbooks[name] ||= {}
+          cookbooks[name][:version] = cookbook.version
+          cookbooks[name][:sources] ||= {}
+          cookbooks[name][:sources][source] = cookbook
         end
       end
+    end
 
-      # Output a list of cookbooks to delayed output
-      #
-      # @param [Array<Dependency>] dependencies
-      def list(dependencies)
-        dependencies.each do |dependency, cookbook|
-          cookbooks[dependency.name] ||= {}
-          cookbooks[dependency.name][:version] = dependency.locked_version.to_s
-          if dependency.location
-            cookbooks[dependency.name][:location] = dependency.location
-          end
+    # Output a package message using
+    #
+    # @param [String] destination
+    def package(destination)
+      output[:messages] << "Cookbook(s) packaged to #{destination}"
+    end
+
+    # Output a list of cookbooks to delayed output
+    #
+    # @param [Array<Dependency>] dependencies
+    def list(dependencies)
+      dependencies.each do |dependency, cookbook|
+        cookbooks[dependency.name] ||= {}
+        cookbooks[dependency.name][:version] = dependency.locked_version.to_s
+        if dependency.location
+          cookbooks[dependency.name][:location] = dependency.location
         end
       end
+    end
 
-      # Output Cookbook info entry to delayed output
-      #
-      # @param [CachedCookbook] cookbook
-      def show(cookbook)
-        cookbooks[cookbook.cookbook_name] = cookbook.pretty_hash
-      end
+    # Output Cookbook info entry to delayed output
+    #
+    # @param [CachedCookbook] cookbook
+    def show(cookbook)
+      cookbooks[cookbook.cookbook_name] = cookbook.pretty_hash
+    end
 
-      # Add a vendor message to delayed output
-      #
-      # @param [CachedCookbook] cookbook
-      # @param [String] destination
-      def vendor(cookbook, destination)
-        cookbook_destination = File.join(destination, cookbook.cookbook_name)
-        msg("Vendoring #{cookbook.cookbook_name} (#{cookbook.version}) to #{cookbook_destination}")
+    # Ouput Cookbook search results to delayed output
+    #
+    # @param [Array<APIClient::RemoteCookbook>] results
+    def search(results)
+      results.sort_by(&:name).each do |remote_cookbook|
+        cookbooks[remote_cookbook.name] ||= {}
+        cookbooks[remote_cookbook.name][:version] = remote_cookbook.version
       end
+    end
 
-      # Add a generic message entry to delayed output
-      #
-      # @param [String] message
-      def msg(message)
-        output[:messages] << message
-      end
+    # Add a vendor message to delayed output
+    #
+    # @param [CachedCookbook] cookbook
+    # @param [String] destination
+    def vendor(cookbook, destination)
+      cookbook_destination = File.join(destination, cookbook.cookbook_name)
+      msg("Vendoring #{cookbook.cookbook_name} (#{cookbook.version}) to #{cookbook_destination}")
+    end
 
-      # Add an error message entry to delayed output
-      #
-      # @param [String] message
-      def error(message)
-        output[:errors] << message
-      end
+    # Add a generic message entry to delayed output
+    #
+    # @param [String] message
+    def msg(message)
+      output[:messages] << message
+    end
 
-      # Add a warning message entry to delayed output
-      #
-      # @param [String] message
-      def warn(message)
-        output[:warnings] << message
-      end
+    # Add an error message entry to delayed output
+    #
+    # @param [String] message
+    def error(message)
+      output[:errors] << message
+    end
 
-      private
+    # Add a warning message entry to delayed output
+    #
+    # @param [String] message
+    def warn(message)
+      output[:warnings] << message
+    end
 
-        attr_reader :output
-        attr_reader :cookbooks
+    def deprecation(message)
+      output[:warnings] << "DEPRECATED: #{message}"
     end
+
+    private
+
+    attr_reader :output
+    attr_reader :cookbooks
   end
 end