omnibus 3.1.1 → 3.2.0.rc.1

data/lib/omnibus/logger.rb

@@ -1,7 +1,30 @@
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 require 'logger'
 
 module Omnibus
   class Logger < ::Logger
+    #
+    # The amount of padding on the left column.
+    #
+    # @return [Fixnum]
+    #
+    LEFT = 40
+
     def initialize(logdev = $stdout, *)
       super
       @level = Logger::WARN
@@ -44,6 +67,24 @@ module Omnibus
       @live_streams[level.to_sym] ||= LiveStream.new(self, level)
     end
 
+    #
+    # The string representation of this object.
+    #
+    # @return [String]
+    #
+    def to_s
+      "#<#{self.class.name}>"
+    end
+
+    #
+    # The detailed string representation of this object.
+    #
+    # @return [String]
+    #
+    def inspect
+      "#<#{self.class.name} level: #{@level}>"
+    end
+
     private
 
     def format_message(severity, _datetime, progname, msg)
@@ -53,7 +94,7 @@ module Omnibus
                "#{severity[0]} | "
              end
 
-      "#{left.rjust(30)}#{msg}\n"
+      "#{left.rjust(LEFT)}#{msg}\n"
     end
 
     #
@@ -84,6 +125,24 @@ module Omnibus
         log_lines(data)
       end
 
+      #
+      # The string representation of this object.
+      #
+      # @return [String]
+      #
+      def to_s
+        "#<#{self.class.name}>"
+      end
+
+      #
+      # The detailed string representation of this object.
+      #
+      # @return [String]
+      #
+      def inspect
+        "#<#{self.class.name} level: #{@level}>"
+      end
+
       private
 
       #

data/lib/omnibus/null_argumentable.rb

@@ -0,0 +1,51 @@
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Omnibus
+  module NullArgumentable
+    #
+    # The "empty" null object.
+    #
+    # @return [Object]
+    #
+    NULL = Object.new.freeze
+
+    #
+    # Called when the module is included.
+    #
+    # @param [Object] base
+    #
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      #
+      # Check if the given object is null.
+      #
+      # @return [true, false]
+      #
+      def null?(object)
+        object.equal?(NULL)
+      end
+    end
+
+    # @see (NullArgumentable.null?)
+    def null?(object)
+      self.class.null?(object)
+    end
+  end
+end

data/lib/omnibus/ohai.rb

@@ -16,8 +16,36 @@
 
 require 'ohai'
 
+class Mash
+  #
+  # @todo Remove in the next major release
+  #
+  # Ohai 7 removed the ability to access Ohai attributes via dot notation. This
+  # temporary monkey patch provides the ability for users to still use the old
+  # dot notation, while printing out a deprecation error.
+  #
+  def method_missing(m, *args, &block)
+    if key?(m)
+      Omnibus.logger.deprecated('Ohai') do
+        "Ohai.#{m}. Please use Ohai['#{m}'] instead."
+      end
+
+      fetch(m)
+    else
+      super
+    end
+  end
+end
+
 module Omnibus
   class Ohai
+    PLUGINS = [
+      'cpu',
+      'kernel',
+      'os',
+      'platform',
+    ].freeze
+
     class << self
       def method_missing(m, *args, &block)
         ohai.send(m, *args, &block)
@@ -26,14 +54,7 @@ module Omnibus
       private
 
       def ohai
-        return @ohai if @ohai
-
-        @ohai = ::Ohai::System.new
-        @ohai.require_plugin('os')
-        @ohai.require_plugin('platform')
-        @ohai.require_plugin('linux/cpu') if @ohai.os == 'linux'
-        @ohai.require_plugin('kernel')
-        @ohai
+        @ohai ||= ::Ohai::System.new.tap { |o| o.all_plugins(PLUGINS) }.data
       end
     end
   end

data/lib/omnibus/package.rb

@@ -0,0 +1,240 @@
+#
+# Copyright 2014 Chef Software, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'json'
+
+module Omnibus
+  class Package
+    class Metadata
+      class << self
+        #
+        # Generate a +metadata.json+ from the given package and data hash.
+        #
+        # @param [Package] package
+        #   the package for this metadata
+        # @param [Hash] data
+        #   the hash of attributes to set in the metadata
+        #
+        # @return [String]
+        #   the path where the metadata was saved on disk
+        #
+        def generate(package, data = {})
+          data = {
+            basename: package.name,
+            md5:      package.md5,
+            sha1:     package.sha1,
+            sha256:   package.sha256,
+            sha512:   package.sha512,
+          }.merge(data)
+
+          instance = new(package, data)
+          instance.save
+          instance.path
+        end
+
+        #
+        # Load the metadata from disk.
+        #
+        # @param [Package] package
+        #   the package for this metadata
+        #
+        # @return [Metadata]
+        #
+        def for_package(package)
+          data = File.read(path_for(package))
+          hash = JSON.parse(data, symbolize_names: true)
+          new(package, hash)
+        rescue Errno::ENOENT
+          raise NoPackageMetadataFile.new(package.path)
+        end
+
+        #
+        # The metadata path that corresponds to the package.
+        #
+        # @param [Package] package
+        #   the package for this metadata
+        #
+        # @return [String]
+        #
+        def path_for(package)
+          "#{package.path}.metadata.json"
+        end
+      end
+
+      #
+      # Create a new metadata object for the given package and hash data.
+      #
+      # @param [Package] package
+      #   the package for this metadata
+      # @param [Hash] data
+      #   the hash of attributes to set in the metadata
+      #
+      def initialize(package, data = {})
+        @package = package
+        @data    = data.dup.freeze
+      end
+
+      #
+      # Helper for accessing the information inside the metadata hash.
+      #
+      # @return [Object]
+      #
+      def [](key)
+        @data[key]
+      end
+
+      #
+      # The name of this metadata file.
+      #
+      # @return [String]
+      #
+      def name
+        @name ||= File.basename(path)
+      end
+
+      #
+      # @see (Metadata.path_for)
+      #
+      def path
+        @path ||= self.class.path_for(@package)
+      end
+
+      #
+      # Save the file to disk.
+      #
+      # @return [true]
+      #
+      def save
+        File.open(path, 'w+')  do |f|
+          f.write(to_json)
+        end
+
+        true
+      end
+
+      #
+      # The JSON representation of this metadata.
+      #
+      # @return [String]
+      #
+      def to_json
+        JSON.pretty_generate(@data)
+      end
+    end
+
+    include Digestable
+
+    attr_reader :path
+
+    #
+    # Create a new package from the given path.
+    #
+    # @param [String] path
+    #   the path to the package on disk
+    #
+    def initialize(path)
+      @path = File.expand_path(path)
+    end
+
+    #
+    # The shortname of this package (the basename of the file).
+    #
+    # @return [String]
+    #
+    def name
+      @name ||= File.basename(path)
+    end
+
+    #
+    # The MD5 checksum for this file.
+    #
+    # @return [String]
+    #
+    def md5
+      @md5 ||= digest(path, :md5)
+    end
+
+    #
+    # The SHA1 checksum for this file.
+    #
+    # @return [String]
+    #
+    def sha1
+      @sha1 ||= digest(path, :sha1)
+    end
+
+    #
+    # The SHA256 checksum for this file.
+    #
+    # @return [String]
+    #
+    def sha256
+      @sha256 ||= digest(path, :sha256)
+    end
+
+    #
+    # The SHA512 checksum for this file.
+    #
+    # @return [String]
+    #
+    def sha512
+      @sha512 ||= digest(path, :sha512)
+    end
+
+    #
+    # The actual contents of the package.
+    #
+    # @return [String]
+    #
+    def content
+      @content ||= IO.read(path)
+    rescue Errno::ENOENT
+      raise NoPackageFile.new(path)
+    end
+
+    #
+    # The parsed contents of the metadata.
+    #
+    # @raise [NoPackageMetadataFile] if the {metadata} does not exist
+    # @raise [JSON::ParserError] if the JSON is not valid
+    #
+    # @return [Hash<Symbol, String>]
+    #
+    def metadata
+      @metadata ||= Metadata.for_package(self)
+    end
+
+    #
+    # Validate the presence of the required components for the package.
+    #
+    # @raise [NoPackageFile] if the package is not present
+    # @raise [NoPackageMetadataFile] if the metadata file is not present
+    #
+    # @return [true]
+    #
+    def validate!
+      unless File.exist?(path)
+        raise NoPackageFile.new(path)
+      end
+
+      unless File.exist?(metadata.path)
+        raise NoPackageMetadataFile.new(metadata.path)
+      end
+
+      true
+    end
+  end
+end

data/lib/omnibus/packagers/base.rb

@@ -27,46 +27,6 @@ module Omnibus
     # The Omnibus::Project instance that we're packaging.
     attr_reader :project
 
-    # !@method name
-    #   @return (see Project#name)
-    def_delegator :@project, :name
-
-    # !@method friendly_name
-    #   @return (see Project#friendly_name)
-    def_delegator :@project, :friendly_name
-
-    # !@method maintainer
-    #   @return (see Project#maintainer)
-    def_delegator :@project, :maintainer
-
-    # !@method version
-    #   @return (see Project#build_version)
-    def_delegator :@project, :build_version, :version
-
-    # !@method iteration
-    #   @return (see Project#iteration)
-    def_delegator :@project, :iteration, :iteration
-
-    # !@method identifier
-    #   @return (see Project#mac_pkg_identifier)
-    def_delegator :@project, :mac_pkg_identifier, :identifier
-
-    # !@method install_path
-    #   @return (see Project#install_path)
-    def_delegator :@project, :install_path, :install_path
-
-    # !@method scripts
-    #   @return (see Project#package_scripts_path)
-    def_delegator :@project, :package_scripts_path, :scripts
-
-    # !@method files_path
-    #   @return (see Project#files_path)
-    def_delegator :@project, :files_path
-
-    # !@method package_dir
-    #   @return (see Project#package_dir)
-    def_delegator :@project, :package_dir
-
     # The commands/steps to setup the file system.
     def self.setup(&block)
       if block_given?
@@ -110,6 +70,25 @@ module Omnibus
       @project = project
     end
 
+    # Hacky way to get around the fact that older versions of Omnibus used to
+    # delegate magical methods to this DSL.
+    #
+    # @deprecated Use +project+ methods instead
+    def method_missing(m, *args, &block)
+      if project.respond_to?(m)
+        log.deprecated("#{log_key}##{m}") { "#{m}. Please use project.#{m} instead." }
+        project.send(m, *args, &block)
+      else
+        super
+      end
+    end
+
+    # @deprecated
+    def version
+      log.deprecated("#{log_key}#version") { 'version. Please use project.build_version instead.' }
+      project.build_version
+    end
+
     #
     # Generation methods
     # ------------------------------
@@ -229,7 +208,7 @@ module Omnibus
     #
     # @return [String]
     def staging_dir
-      File.expand_path("#{project.package_tmp}/#{underscore_name}")
+      File.expand_path("#{Config.package_tmp}/#{underscore_name}")
     end
 
     # The path to the directory where the packager resources are
@@ -258,7 +237,7 @@ module Omnibus
       base_path = if project.resources_path
                     project.resources_path
                   else
-                    files_path
+                    project.files_path
                   end
 
       File.expand_path(File.join(base_path, underscore_name, 'Resources'))