halite 1.0.0.rc.1 → 1.0.0

data/lib/halite/gem.rb

@@ -1,10 +1,38 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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 'chef/cookbook_version'
+
 require 'halite/dependencies'
 
+
 module Halite
+  # A model for a gem/cookbook within Halite.
+  #
+  # @since 1.0.0
+  # @example
+  #   g = Halite::Gem.new('chef-mycookbook', '1.1.0')
+  #   puts(g.cookbook_name) #=> mycookbook
   class Gem
+    attr_reader :name
+
     # name can be either a string name, Gem::Dependency, or Gem::Specification
+    # @param name [String, Gem::Dependency, Gem::Specification]
     def initialize(name, version=nil)
-      name = name.to_spec if name.is_a?(::Gem::Dependency) # Allow passing either
+      name = name.to_spec if name.is_a?(::Gem::Dependency) # Allow passing a Dependency by just grabbing its spec.
       if name.is_a?(::Gem::Specification)
         raise Error.new("Cannot pass version when using an explicit specficiation") if version
         @spec = name
@@ -20,10 +48,6 @@ module Halite
       @spec ||= ::Gem::Dependency.new(@name, ::Gem::Requirement.new(@version)).to_spec
     end
 
-    def method_missing(*args)
-      spec.send(*args)
-    end
-
     def version
       spec.version.to_s
     end
@@ -36,7 +60,12 @@ module Halite
       end
     end
 
-    # The Rubygems API is shit and just assumes the file layout
+    # Path to the .gemspec for this gem. This is different from
+    # Gem::Specification#spec_file because the Rubygems API is shit and just
+    # assumes the file layout matches normal, which is not the case with Bundler
+    # and path or git sources.
+    #
+    # @return [String]
     def spec_file
       File.join(spec.full_gem_path, spec.name + '.gemspec')
     end
@@ -45,26 +74,42 @@ module Halite
       IO.readlines(spec_file).take_while { |line| line.strip.empty? || line.strip.start_with?('#') }.join('')
     end
 
+    # Iterate over all the files in the gem, with an optional prefix. Each
+    # element in the iterable will be [full_path, relative_path], where
+    # relative_path is relative to the prefix or gem path.
+    #
+    # @param prefix_paths [String, Array<String>, nil] Option prefix paths.
+    # @param block [Proc] Callable for iteration.
+    # @return [Array<Array<String>>]
+    # @example
+    #   gem_data.each_file do |full_path, rel_path|
+    #     # ...
+    #   end
     def each_file(prefix_paths=nil, &block)
-      files = []
-      spec.files.each do |path|
-        prefix = if prefix_paths
-          Array(prefix_paths).map {|p| p.end_with?('/') ? p : p + '/' }.find {|p| path.start_with?(p) }
-        else
-          ''
+      globs = if prefix_paths
+        Array(prefix_paths).map {|path| File.join(spec.full_gem_path, path) }
+      else
+        [spec.full_gem_path]
+      end
+      [].tap do |files|
+        globs.each do |glob|
+          Dir[File.join(glob, '**', '*')].each do |path|
+            next unless File.file?(path)
+            val = [path, path[glob.length+1..-1]]
+            block.call(*val) if block
+            files << val
+          end
         end
-        next unless prefix # No match
-        value = [
-          File.join(spec.full_gem_path, path), # Full path
-          path[prefix.length..-1], # Relative path
-        ]
-        files << value
-        block.call(*value) if block
+        # Make sure the order is stable for my tests. Probably overkill, I think
+        # Dir#[] sorts already.
+        files.sort!
       end
-      files.sort! # To be safe
     end
 
-    # Special case of the above using spec's require paths
+    # Special case of the {#each_file} the gem's require paths.
+    #
+    # @param block [Proc] Callable for iteration.
+    # @return [Array<Array<String>>]
     def each_library_file(&block)
       each_file(spec.require_paths, &block)
     end
@@ -78,5 +123,45 @@ module Halite
       spec.dependencies.any? {|subdep| subdep.name == 'halite'} && !spec.metadata.include?('halite_ignore')
     end
 
+    # Create a Chef::CookbookVersion object that represents this gem. This can
+    # be injected in to Chef to simulate the cookbook being available.
+    #
+    # @return [Chef::CookbookVersion]
+    # @example
+    #   run_context.cookbook_collection[gem.cookbook_name] = gem.as_cookbook_version
+    def as_cookbook_version
+      # Put this in a local variable for a closure below.
+      path = spec.full_gem_path
+      Chef::CookbookVersion.new(cookbook_name, File.join(path, 'chef')).tap do |c|
+        c.attribute_filenames = each_file('chef/attributes').map(&:first)
+        c.file_filenames = each_file('chef/files').map(&:first)
+        c.recipe_filenames = each_file('chef/recipes').map(&:first)
+        c.template_filenames = each_file('chef/templates').map(&:first)
+        # Haxx, rewire the filevendor for this cookbook to look up in our folder.
+        # This is touching two different internal interfaces, but ¯\_(ツ)_/¯
+        c.send(:file_vendor).define_singleton_method(:get_filename) do |filename|
+          File.join(path, 'chef', filename)
+        end
+        # Store the true root for use in other tools.
+        c.define_singleton_method(:halite_root) { path }
+      end
+    end
+
+    # Search for a file like README.md or LICENSE.txt in the gem.
+    #
+    # @param name [String] Basename to search for.
+    # @return [String, Array<String>]
+    # @example
+    #   gem.misc_file('Readme') => /path/to/readme.txt
+    def find_misc_path(name)
+      [name, name.upcase, name.downcase].each do |base|
+        ['.md', '', '.txt', '.html'].each do |suffix|
+          path = File.join(spec.full_gem_path, base+suffix)
+          return path if File.exist?(path)
+        end
+      end
+      # Didn't find anything
+      nil
+    end
   end
 end

data/lib/halite/helper_base.rb

@@ -0,0 +1,129 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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.
+#
+
+
+# Much inspiration from Bundler's GemHelper. Thanks!
+require 'bundler'
+require 'thor/shell'
+
+require 'halite/error'
+require 'halite/gem'
+
+
+module Halite
+  # Base class for helpers like Rake tasks.
+  #
+  # @api semipublic
+  # @since 1.0.0
+  class HelperBase
+    # Class method helper to install the tasks.
+    #
+    # @param args Arguments to be passed to {#initialize}.
+    # @return [void]
+    # @example
+    #   MyApp::RakeHelper.install(gem_name: 'otherapp')
+    def self.install(*args)
+      new(*args).install
+    end
+
+    # Name of the gem to use in these Rake tasks.
+    # @return [String]
+    attr_reader :gem_name
+
+    # Base folder of the gem.
+    # @return [String]
+    attr_reader :base
+
+    # Helper options.
+    # @return [Hash<Symbol, Object>]
+    attr_reader :options
+
+    # @param gem_name [String] Name of the gem to use in these Rake tasks.
+    # @param base [String] Base folder of the gem.
+    # @options options [Boolean] no_color Forcibly disable using colors in the output.
+    def initialize(gem_name: nil, base: nil, **options)
+      @base = base || if defined?(::Rake) && ::Rake.original_dir
+        ::Rake.original_dir
+      else
+        Dir.pwd
+      end # rubocop:disable Lint/EndAlignment
+      @gem_name = gem_name || find_gem_name(@base)
+      @options = options
+    end
+
+    # Subclass hoook to provide the actual tasks or other helpers to install.
+    #
+    # @return [void]
+    # @example
+    #   def install
+    #     extend Rake::DSL
+    #     desc 'My awesome task'
+    #     task 'mytask' do
+    #       # ...
+    #     end
+    #   end
+    def install
+      raise NotImplementedError
+    end
+
+    private
+
+    # Return a Thor::Shell object based on output settings.
+    #
+    # @return [Thor::Shell::Basic]
+    # @example
+    #   shell.say('Operation completed', :green)
+    def shell
+      @shell ||= if options[:no_color] || !STDOUT.tty?
+        Thor::Shell::Basic
+      else
+        Thor::Base.shell
+      end.new
+    end
+
+    # Search a directory for a .gemspec file to determine the gem name.
+    # Returns nil if no gemspec is found.
+    #
+    # @param base [String] Folder to search.
+    # @return [String, nil]
+    def find_gem_name(base)
+      spec = Dir[File.join(base, '*.gemspec')].first
+      File.basename(spec, '.gemspec') if spec
+    end
+
+    # Gem specification for the current gem.
+    #
+    # @return [Gem::Specification]
+    def gemspec
+      @gemspec ||= begin
+        raise Error.new("Unable to automatically determine gem name from specs in #{base}. Please set the gem name via #{self.class.name}.install_tasks(gem_name: 'name')") unless gem_name
+        g = Bundler.load_gemspec(File.join(base, gem_name+'.gemspec'))
+        # This is returning the path it would be in if installed normally,
+        # override so we get the local path. Also for reasons that are entirely
+        # beyond me, #tap makes Gem::Specification flip out so do it old-school.
+        g.full_gem_path = base
+        g
+      end
+    end
+
+    # Cookbook model for the current gem.
+    #
+    # @return [Halite::Gem]
+    def cookbook
+      @cookbook ||= Halite::Gem.new(gemspec)
+    end
+  end
+end

data/lib/halite/rake_helper.rb

@@ -1,97 +1,83 @@
-# Much inspiration from Bundler's GemHelper. Thanks!
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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 'tmpdir'
-require 'thor/shell'
+
+require 'chef/version'
 
 require 'halite'
 require 'halite/error'
+require 'halite/helper_base'
 
-module Halite
-  class RakeHelper
-    include Rake::DSL if defined? Rake::DSL
-
-    def self.install_tasks(*args)
-      new(*args).install
-    end
-
-    attr_accessor :gem_name, :base, :cookbook_name
-
-    def initialize(gem_name=nil, base=nil, no_gem=nil, no_foodcritic=nil, no_kitchen=nil)
-      if gem_name.is_a?(Hash)
-        opts = gem_name.inject({}) {|memo, (key, value)| memo[key.to_s] = value; memo }
-        gem_name = opts['gem_name']
-        base = opts['base']
-        no_gem = opts['no_gem']
-        no_foodcritic = opts['no_foodcritic']
-        no_kitchen = opts['no_kitchen']
-      end
-      # Order is important, find_gem_name needs base to be set
-      @base = base || if defined? Rake
-        Rake.original_dir
-      else
-        Dir.pwd
-      end
-      @gem_name = gem_name || find_gem_name
-      @gemspec = Bundler.load_gemspec(@gem_name+'.gemspec')
-      @no_gem = no_gem
-      @no_foodcritic = no_foodcritic
-      @no_kitchen = no_kitchen
-    end
-
-    def find_gem_name
-      specs = Dir[File.join(base, '*.gemspec')]
-      raise Error.new("Unable to automatically determine gem name from specs in #{base}. Please set the gem name via Halite::RakeHelper.install_tasks(gem_name: 'name').") if specs.length != 1
-      File.basename(specs.first, '.gemspec')
-    end
-
-    def pkg_path
-      @pkg_path ||= File.join(base, 'pkg', "#{@gem_name}-#{@gemspec.version}")
-    end
-
-    def shell
-      @shell ||= if @no_color || !STDOUT.tty?
-        Thor::Shell::Basic
-      else
-        Thor::Base.shell
-      end.new
-    end
 
+module Halite
+  # Helper class to install Halite rake tasks.
+  #
+  # @since 1.0.0
+  # @example Rakefile
+  #   require 'halite/rake_helper'
+  #   Halite::RakeHelper.install
+  class RakeHelper < HelperBase
+    # Install all Rake tasks.
+    #
+    # @return [void]
     def install
+      extend Rake::DSL
       # Core Halite tasks
-      desc "Convert #{@gem_name}-#{@gemspec.version} to a cookbook in the pkg directory"
+      desc "Convert #{gemspec.name}-#{gemspec.version} to a cookbook in the pkg directory"
       task 'chef:build' do
         build_cookbook
       end
 
-      desc "Push #{@gem_name}-#{@gemspec.version} to Supermarket"
+      desc "Push #{gemspec.name}-#{gemspec.version} to Supermarket"
       task 'chef:release' => ['chef:build'] do
         release_cookbook
       end
 
       # Patch the core gem tasks to run ours too
-      if !@no_gem
+      unless options[:no_gem]
         task 'build' => ['chef:build']
         task 'release' => ['chef:release']
       end
 
       # Foodcritic doesn't have a config file, so just always try to add it.
-      if !@no_foodcritic
+      unless options[:no_foodcritic]
         install_foodcritic
       end
 
       # If a .kitchen.yml exists, install the Test Kitchen tasks.
-      if !@no_kitchen && File.exists?(File.join(@base, '.kitchen.yml'))
+      unless options[:no_kitchen] || !File.exist?(File.join(@base, '.kitchen.yml'))
         install_kitchen
       end
     end
 
+    private
+
+    def pkg_path
+      @pkg_path ||= File.join(base, 'pkg', "#{gemspec.name}-#{gemspec.version}")
+    end
+
     def install_foodcritic
       require 'foodcritic'
 
       desc 'Run Foodcritic linter'
       task 'chef:foodcritic' do
         Dir.mktmpdir('halite_test') do |path|
-          Halite.convert(gem_name, path)
-          sh("foodcritic -f any '#{path}'")
+          Halite.convert(gemspec, path)
+          sh("foodcritic --chef-version #{Chef::VERSION} --epic-fail any --tags ~FC054 '#{path}'")
         end
       end
 
@@ -122,12 +108,12 @@ module Halite
       FileUtils.mkdir_p(pkg_path)
       remove_files_in_folder(pkg_path)
       Halite.convert(gem_name, pkg_path)
-      shell.say("#{@gem_name} #{@gemspec.version} converted to pkg/#{@gem_name}-#{@gemspec.version}/.", :green)
+      shell.say("#{gemspec.name} #{gemspec.version} converted to pkg/#{gemspec.name}-#{gemspec.version}/.", :green)
     end
 
     def release_cookbook
       Dir.chdir(pkg_path) do
-        #sh('stove --sign')
+        sh('stove --no-git')
       end
     end