chef-stove 7.1.1

data/lib/stove/config.rb

@@ -0,0 +1,76 @@
+require 'fileutils'
+require 'json'
+
+module Stove
+  class Config
+    include Logify
+    include Mixin::Instanceable
+
+    def method_missing(m, *args, &block)
+      if m.to_s.end_with?('=')
+        __set__(m.to_s.chomp('='), args.first)
+      else
+        __get__(m)
+      end
+    end
+
+    def respond_to_missing?(m, include_private = false)
+      __has__?(m) || super
+    end
+
+    def save
+      FileUtils.mkdir_p(File.dirname(__path__))
+      File.open(__path__, 'w') do |f|
+        f.write(JSON.fast_generate(__raw__))
+      end
+    end
+
+    def to_s
+      "#<#{self.class.name} #{__raw__.to_s}>"
+    end
+
+    def inspect
+      "#<#{self.class.name} #{__raw__.inspect}>"
+    end
+
+    def __get__(key)
+      __raw__[key.to_sym]
+    end
+
+    def __has__?(key)
+      __raw__.key?(key.to_sym)
+    end
+
+    def __set__(key, value)
+      __raw__[key.to_sym] = value
+    end
+
+    def __unset__(key)
+      __raw__.delete(key.to_sym)
+    end
+
+    def __path__
+      @path ||= File.expand_path(ENV['STOVE_CONFIG'] || '~/.stove')
+    end
+
+    def __raw__
+      return @__raw__ if @__raw__
+
+      @__raw__ = JSON.parse(File.read(__path__), symbolize_names: true)
+
+      if @__raw__.key?(:community)
+        $stderr.puts "Detected old Stove configuration file, converting..."
+
+        @__raw__ = {
+          :username => @__raw__[:community][:username],
+          :key      => @__raw__[:community][:key],
+        }
+      end
+
+      @__raw__
+    rescue Errno::ENOENT => e
+      log.warn { "No config file found at `#{__path__}'!" }
+      @__raw__ = {}
+    end
+  end
+end

data/lib/stove/cookbook.rb

@@ -0,0 +1,120 @@
+require 'fileutils'
+require 'tempfile'
+require 'time'
+
+module Stove
+  class Cookbook
+    include Logify
+
+    require_relative 'cookbook/metadata'
+
+    #
+    # The path to this cookbook on disk.
+    #
+    # @return [Pathname]
+    #
+    attr_reader :path
+
+    #
+    # The name of the cookbook (must correspond to the name of the
+    # cookbook on the Supermarket).
+    #
+    # @return [String]
+    #
+    attr_reader :name
+
+    #
+    # The version of this cookbook (originally).
+    #
+    # @return [String]
+    #
+    attr_reader :version
+
+    #
+    # The metadata for this cookbook.
+    #
+    # @return [Stove::Cookbook::Metadata]
+    #
+    attr_reader :metadata
+
+    #
+    # The changeset for this cookbook. This is written by the changelog
+    # generator and read by various plugins.
+    #
+    # @return [String, nil]
+    #   the changeset for this cookbook
+    #
+    attr_accessor :changeset
+
+    #
+    # Create a new wrapper around the cookbook object.
+    #
+    # @param [String] path
+    #   the relative or absolute path to the cookbook on disk
+    #
+    def initialize(path)
+      @path = File.expand_path(path)
+      load_metadata!
+    end
+
+    #
+    # The tag version. This is just the current version prefixed with the
+    # letter "v".
+    #
+    # @example Tag version for 1.0.0
+    #   cookbook.tag_version #=> "v1.0.0"
+    #
+    # @return [String]
+    #
+    def tag_version
+      "v#{version}"
+    end
+
+    #
+    # Deterine if this cookbook version is released on the Supermarket
+    #
+    # @warn
+    #   This is a fairly expensive operation and the result cannot be
+    #   reliably cached!
+    #
+    # @return [Boolean]
+    #   true if this cookbook at the current version exists on the community
+    #   site, false otherwise
+    #
+    def released?
+      Supermarket.cookbook(name, version)
+      true
+    rescue ChefAPI::Error::HTTPNotFound
+      false
+    end
+
+    #
+    # So there's this really really crazy bug that the tmp directory could
+    # be deleted mid-request...
+    #
+    # @return [File]
+    #
+    def tarball(extended_metadata = false)
+      @tarball ||= Packager.new(self, extended_metadata).tarball
+    end
+
+    private
+      # Load the metadata and set the @metadata instance variable.
+      #
+      # @raise [ArgumentError]
+      #   if there is no metadata.rb
+      #
+      # @return [String]
+      #   the path to the metadata file
+      def load_metadata!
+        metadata_path = File.join(path, 'metadata.rb')
+
+        @metadata = Stove::Cookbook::Metadata.from_file(metadata_path)
+        @name     = @metadata.name
+        @version  = @metadata.version
+
+        metadata_path
+      end
+      alias_method :reload_metadata!, :load_metadata!
+  end
+end

data/lib/stove/cookbook/metadata.rb

@@ -0,0 +1,245 @@
+require 'json'
+
+module Stove
+  class Cookbook
+    # Borrowed and modified from:
+    # {https://raw.github.com/opscode/chef/11.4.0/lib/chef/cookbook/metadata.rb}
+    #
+    # Copyright:: Copyright 2008-2017 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.
+    #
+    # == Chef::Cookbook::Metadata
+    # Chef::Cookbook::Metadata provides a convenient DSL for declaring metadata
+    # about Chef Cookbooks.
+    class Metadata
+      class << self
+        def from_file(path)
+          new.from_file(path)
+        end
+
+        def def_attribute(field)
+          class_eval <<-EOM, __FILE__, __LINE__ + 1
+            def #{field}(arg = nil)
+              set_or_return(:#{field}, arg)
+            end
+          EOM
+        end
+
+        def def_meta_cookbook(field, instance_variable)
+          class_eval <<-EOM, __FILE__, __LINE__ + 1
+            def #{field}(thing, *args)
+              version = args.first
+              @#{instance_variable}[thing] = version || DEFAULT_VERSION
+              @#{instance_variable}[thing]
+            end
+          EOM
+        end
+
+        def def_meta_setter(field, instance_variable)
+          class_eval <<-EOM, __FILE__, __LINE__ + 1
+            def #{field}(name, description)
+              @#{instance_variable}[name] = description
+              @#{instance_variable}
+            end
+          EOM
+        end
+
+        def def_meta_gems(field, instance_variable)
+          class_eval <<-EOM, __FILE__, __LINE__ + 1
+            def #{field}(*args)
+              @#{instance_variable} << args unless args.empty?
+              @#{instance_variable}
+            end
+          EOM
+        end
+
+        def def_meta_version(field)
+          class_eval <<-EOM, __FILE__, __LINE__ + 1
+            def #{field}(*args)
+              @#{field} << args unless args.empty?
+              @#{field}
+            end
+          EOM
+        end
+      end
+
+      DEFAULT_VERSION = '>= 0.0.0'.freeze
+
+      COMPARISON_FIELDS = [
+        :name, :description, :long_description, :maintainer,
+        :maintainer_email, :license, :platforms, :dependencies,
+        :recommendations, :suggestions, :conflicting, :providing,
+        :replacing, :attributes, :groupings, :recipes, :version
+      ]
+
+      def_attribute :name
+      def_attribute :maintainer
+      def_attribute :maintainer_email
+      def_attribute :license
+      def_attribute :description
+      def_attribute :long_description
+
+      # These attributes are available for reading, but are not written by
+      # default. In order to maintain backwards and forwards compatability,
+      # these attributes are here.
+      def_attribute :source_url
+      def_attribute :issues_url
+      def_meta_version :chef_version
+      def_meta_version :ohai_version
+
+      def_meta_cookbook :supports,   :platforms
+      def_meta_cookbook :depends,    :dependencies
+      def_meta_cookbook :recommends, :recommendations
+      def_meta_cookbook :suggests,   :suggestions
+      def_meta_cookbook :conflicts,  :conflicting
+      def_meta_cookbook :provides,   :providing
+      def_meta_cookbook :replaces,   :replacing
+
+      def_meta_setter :recipe,    :recipes
+      def_meta_setter :grouping,  :groupings
+      def_meta_setter :attribute, :attributes
+      def_meta_gems   :gem,       :gems
+
+      attr_reader :cookbook
+      attr_reader :platforms
+      attr_reader :dependencies
+      attr_reader :recommendations
+      attr_reader :gems
+      attr_reader :suggestions
+      attr_reader :conflicting
+      attr_reader :providing
+      attr_reader :replacing
+      attr_reader :attributes
+      attr_reader :groupings
+      attr_reader :recipes
+      attr_reader :version
+
+      def initialize(cookbook = nil, maintainer = 'YOUR_COMPANY_NAME', maintainer_email = 'YOUR_EMAIL', license = 'none')
+        @cookbook         = cookbook
+        @name             = cookbook ? cookbook.name : ''
+        @long_description = ''
+        @source_url       = Stove::Mash.new
+        @issues_url       = Stove::Mash.new
+        @gems             = []
+        @chef_version     = []
+        @ohai_version     = []
+        @platforms        = Stove::Mash.new
+        @dependencies     = Stove::Mash.new
+        @recommendations  = Stove::Mash.new
+        @suggestions      = Stove::Mash.new
+        @conflicting      = Stove::Mash.new
+        @providing        = Stove::Mash.new
+        @replacing        = Stove::Mash.new
+        @attributes       = Stove::Mash.new
+        @groupings        = Stove::Mash.new
+        @recipes          = Stove::Mash.new
+
+        self.maintainer(maintainer)
+        self.maintainer_email(maintainer_email)
+        self.license(license)
+        self.description('A fabulous new cookbook')
+        self.version('0.0.0')
+
+        if cookbook
+          @recipes = cookbook.fully_qualified_recipe_names.inject({}) do |r, e|
+            e = self.name if e =~ /::default$/
+            r[e] = ""
+            self.provides e
+            r
+          end
+        end
+      end
+
+      def from_file(path)
+        path = path.to_s
+        path_json = File.join(File.dirname(path), 'metadata.json')
+
+        if File.exist?(path) && File.readable?(path)
+          self.instance_eval(IO.read(path), path, 1)
+          self
+        elsif File.exist?(path_json) && File.readable?(path_json)
+          metadata_from_json(path_json)
+        else
+          raise Error::MetadataNotFound.new(path: path)
+        end
+      end
+
+      def ==(other)
+        COMPARISON_FIELDS.inject(true) do |equal_so_far, field|
+          equal_so_far && other.respond_to?(field) && (other.send(field) == send(field))
+        end
+      end
+
+      def version(arg = UNSET_VALUE)
+        if arg == UNSET_VALUE
+          @version
+        else
+          @version = arg.to_s
+        end
+      end
+
+      def to_hash(extended_metadata = false)
+        hash = {
+          'name'             => self.name,
+          'version'          => self.version,
+          'description'      => self.description,
+          'long_description' => self.long_description,
+          'maintainer'       => self.maintainer,
+          'maintainer_email' => self.maintainer_email,
+          'license'          => self.license,
+          'platforms'        => self.platforms,
+          'dependencies'     => self.dependencies,
+          'recommendations'  => self.recommendations,
+          'suggestions'      => self.suggestions,
+          'conflicting'      => self.conflicting,
+          'providing'        => self.providing,
+          'replacing'        => self.replacing,
+          'attributes'       => self.attributes,
+          'groupings'        => self.groupings,
+          'recipes'          => self.recipes,
+        }
+
+        if extended_metadata
+          hash['source_url']   = self.source_url unless self.source_url.empty?
+          hash['issues_url']   = self.issues_url unless self.issues_url.empty?
+          hash['gems']         = self.gems unless self.gems.empty?
+          hash['chef_version'] = self.chef_version.map(&:sort)
+          hash['ohai_version'] = self.ohai_version.map(&:sort)
+        end
+
+        return hash
+      end
+
+      private
+
+      def metadata_from_json(path)
+        json = JSON.parse(IO.read(path))
+        json.keys.each do |key|
+          set_or_return(key.to_sym, json[key])
+        end
+        self
+      end
+
+      def set_or_return(symbol, arg)
+        iv_symbol = "@#{symbol.to_s}".to_sym
+
+        if arg.nil? && self.instance_variable_defined?(iv_symbol)
+          self.instance_variable_get(iv_symbol)
+        else
+          self.instance_variable_set(iv_symbol, arg)
+        end
+      end
+    end
+  end
+end

data/lib/stove/error.rb

@@ -0,0 +1,56 @@
+require 'erb'
+
+module Stove
+  module Error
+    class ErrorBinding
+      def initialize(options = {})
+        options.each do |key, value|
+          instance_variable_set(:"@#{key}", value)
+        end
+      end
+
+      def get_binding
+        binding
+      end
+    end
+
+    class StoveError < StandardError
+      def initialize(options = {})
+        @options  = options
+        @filename = options.delete(:_template)
+
+        super()
+      end
+
+      def message
+        erb = ERB.new(File.read(template))
+        erb.result(ErrorBinding.new(@options).get_binding)
+      end
+      alias_method :to_s, :message
+
+      private
+
+      def template
+        class_name = self.class.to_s.split('::').last
+        filename   = @filename || Util.underscore(class_name)
+        Stove.root.join('templates', 'errors', "#{filename}.erb")
+      end
+    end
+
+    class GitFailed < StoveError; end
+    class GitTaggingFailed < StoveError; end
+    class MetadataNotFound < StoveError; end
+    class ServerUnavailable < StoveError; end
+    class CookbookAlreadyExists < StoveError; end
+
+    # Validations
+    class ValidationFailed < StoveError; end
+    class SupermarketCategoryValidationFailed < ValidationFailed; end
+    class SupermarketKeyValidationFailed < ValidationFailed; end
+    class SupermarketUsernameValidationFailed < ValidationFailed; end
+    class GitCleanValidationFailed < ValidationFailed; end
+    class GitRepositoryValidationFailed < ValidationFailed; end
+    class GitUpToDateValidationFailed < ValidationFailed; end
+    class ArtifactoryKeyValidationFailed < ValidationFailed; end
+  end
+end