halite 1.0.0.rc.1 → 1.0.0

data/README.md

@@ -2,8 +2,8 @@
 
 [![Build Status](https://img.shields.io/travis/coderanger/halite.svg)](https://travis-ci.org/coderanger/halite)
 [![Gem Version](https://img.shields.io/gem/v/halite.svg)](https://rubygems.org/gems/halite)
-[![Code Climate](https://img.shields.io/codeclimate/github/coderanger/halite.svg)](https://codeclimate.com/github/coderanger/halite)
-[![Coverage](https://img.shields.io/codeclimate/coverage/github/coderanger/halite.svg)](https://codeclimate.com/github/coderanger/halite)
+[![Coverage](https://img.shields.io/codecov/c/github/coderanger/halite.svg)](https://codecov.io/github/coderanger/halite)
+[![Gemnasium](https://img.shields.io/gemnasium/coderanger/halite.svg)](https://gemnasium.com/coderanger/halite)
 [![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
 Write as a gem, release as a cookbook.
@@ -18,6 +18,15 @@ All Ruby code in the gem will be converted in to `libraries/` files. You can
 add cookbook-specific files by add them to a `chef/` folder in the root of the
 gem.
 
+## Why?
+
+Developing cookbooks as gems allows using the full Ruby development ecosystem
+and tooling more directly. This includes things like Simplecov for coverage
+testing, YARD for documentation, and Gemnasium for dependency monitoring. For
+a cookbook that is already mostly library files, this is a natural transition,
+with few cookbook-specific pieces to start with. This also allows using Bundler
+to manage versions instead of Berkshelf.
+
 ## Cookbook Dependencies
 
 To add cookbook dependencies either add them to the gem requirements or use
@@ -73,3 +82,96 @@ To activate it, include the extension in your `Berksfile`:
 ```ruby
 extension 'halite'
 ```
+
+## Spec Helper
+
+Halite includes a set of helpers for RSpec tests. You can enable them in your
+`spec_helper.rb`:
+
+```ruby
+require 'halite/spec_helper'
+
+RSpec.configure do |config|
+  config.include Halite::SpecHelper
+end
+```
+
+### `recipe`
+
+Recipes to converge for the test can be defined inline on example groups:
+
+```ruby
+describe 'cookbook recipe' do
+  recipe 'myrecipe'
+  it { is_expected.to create_file('/myfile') }
+end
+
+describe 'inline recipe' do
+  recipe do
+    file '/myfile' do
+      content 'mycontent'
+    end
+  end
+  it { is_expected.to create_file('/myfile') }
+end
+```
+
+### `step_into`
+
+A resource can be added to the list to step in to via the `step_into` helper:
+
+```ruby
+describe 'mycookbook' do
+  recipe 'mycookbook::server'
+  step_into :mycookbook_lwrp
+  it { is_expected.to ... }
+end
+```
+
+### `resource` and `provider`
+
+For testing mixin-based cookbooks, new resource and provider classes can be
+declared on an example group:
+
+```ruby
+describe MyMixin do
+  resource(:test_resource) do
+    include MyMixin
+    def foo(val=nil)
+      set_or_return(:foo, val, {})
+    end
+  end
+  provider(:test_resource) do
+    def action_run
+      # ...
+    end
+  end
+  recipe do
+    test_resource 'test' do
+      foo 1
+      action :run
+    end
+  end
+  it { is_expected.to ... }
+end
+```
+
+These helper resources and providers are only available within the scope of
+recipes defined on that example group or groups nested inside it. Helper
+resources are automatically `step_into`'d.
+
+## License
+
+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.

data/Rakefile

@@ -1,18 +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 'bundler/gem_tasks'
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = [].tap do |a|
-    a.push('--color')
-    a.push('--format Fuubar')
-    a.push('--tag ~slow')
+    a << '--color'
+    a << "--format #{ENV['CI'] ? 'documentation' : 'Fuubar'}"
+    a << '--tag ~slow'
+    a << '--backtrace' if ENV['DEBUG']
+    a << "--seed #{ENV['SEED']}" if ENV['SEED']
   end.join(' ')
 end
 
 RSpec::Core::RakeTask.new(:integration) do |t|
   t.rspec_opts = [].tap do |a|
-    a.push('--color')
-    a.push('--format Fuubar')
+    a << '--color'
+    a << "--format #{ENV['CI'] ? 'documentation' : 'Fuubar'}"
+    a << '--backtrace' if ENV['DEBUG']
+    a << "--seed #{ENV['SEED']}" if ENV['SEED']
   end.join(' ')
 end
 

data/gemfiles/default.gemfile

@@ -0,0 +1,17 @@
+#
+# 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.
+#
+
+eval_gemfile File.expand_path('../../Gemfile', __FILE__)

data/gemfiles/master.gemfile

@@ -0,0 +1,21 @@
+#
+# 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.
+#
+
+eval_gemfile File.expand_path('../../Gemfile', __FILE__)
+
+gem 'chef', github: 'chef/chef'
+# gem 'poise', github: 'poise/poise'
+# gem 'poise-boiler', github: 'poise/poise-boiler'

data/halite.gemspec

@@ -1,4 +1,19 @@
-# coding: utf-8
+#
+# 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.
+#
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'halite/version'
@@ -18,16 +33,12 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w{lib}
 
-  spec.add_dependency 'stove', '~> 3.2.3'
+  spec.add_dependency 'chef', '~> 12.0'
+  spec.add_dependency 'stove', '~> 3.2', '>= 3.2.3'
   spec.add_dependency 'bundler' # Used for Bundler.load_gemspec
   spec.add_dependency 'thor' # Used for Thor::Shell
 
-  spec.add_development_dependency 'rake', '~> 10.4.2'
-  spec.add_development_dependency 'rspec', '~> 3.1.0'
-  spec.add_development_dependency 'rspec-its', '~> 1.1.0'
-  spec.add_development_dependency 'fuubar', '~> 2.0.0'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'simplecov', '~> 0.9.1'
-  spec.add_development_dependency 'mixlib-shellout', '~> 2.0.0'
-  spec.add_development_dependency 'chef', '~> 12.0.0'
+  spec.add_development_dependency 'poise', '~> 2.0'
+  spec.add_development_dependency 'poise-boiler', '~> 1.0'
+  spec.add_development_dependency 'rspec-command', '~> 1.0'
 end

data/lib/berkshelf/halite.rb

@@ -1,2 +1,27 @@
+#
+# 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.
+#
+
+# Install the Halite source
 require 'halite/berkshelf/helper'
 ::Halite::Berkshelf::Helper.install
+
+
+# Berkshelf plugin loading.
+# @api private
+module Berkshelf
+  # Set up the :gem location type.
+  autoload :GemLocation, 'berkshelf/locations/gem'
+end

data/lib/berkshelf/locations/gem.rb

@@ -0,0 +1,84 @@
+#
+# 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 'halite'
+
+
+module Berkshelf
+  # Berkshelf location plugin to install via Halite gems.
+  #
+  # @since 1.0.0
+  # @api private
+  class GemLocation < BaseLocation
+    attr_reader :gem_name
+
+    def initialize(*args)
+      super
+      @gem_name = options[:gem]
+    end
+
+
+    # Always force the re-install.
+    #
+    # @see BaseLocation#installed?
+    def installed?
+      false
+    end
+
+    # Convert the gem.
+    #
+    # @see BaseLocation#install
+    def install
+      cache_path.rmtree if cache_path.exist?
+      cache_path.mkpath
+      Halite.convert(gem_name, cache_path)
+      validate_cached!(cache_path)
+    end
+
+    # @see BaseLocation#cached_cookbook
+    def cached_cookbook
+      if cache_path.join('metadata.rb').exist?
+        @cached_cookbook ||= CachedCookbook.from_path(cache_path)
+      else
+        nil
+      end
+    end
+
+    # Lockfile rendering for Halite gem cookbooks.
+    def to_lock
+      "    gem: #{gem_name}\n"
+    end
+
+    def ==(other)
+      other.is_a?(GemLocation) && other.gem_name == gem_name
+    end
+
+    def to_s
+      "gem from #{gem_name}"
+    end
+
+    def inspect
+      "#<Berkshelf::GemLocation gem: #{gem_name}>"
+    end
+
+    # The path to the converted gem.
+    #
+    # @return [Pathname]
+    def cache_path
+      @cache_path ||= Pathname.new(Berkshelf.berkshelf_path).join('.cache', 'halite', dependency.name)
+    end
+  end
+end

data/lib/halite.rb

@@ -1,11 +1,41 @@
-require 'logify'
+#
+# 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 'halite/converter'
-require 'halite/gem'
 
+# Library to convert a Ruby gem to a Chef cookbook.
+#
+# @since 1.0.0
+# @see convert
 module Halite
-  include Logify
+  autoload :Converter, 'halite/converter'
+  autoload :Dependencies, 'halite/dependencies'
+  autoload :Error, 'halite/error'
+  autoload :Gem, 'halite/gem'
+  autoload :SpecHelper, 'halite/spec_helper'
+  autoload :VERSION, 'halite/version'
 
+  # Convert a Ruby gem to a Chef cookbook.
+  #
+  # @param gem_name [String, Gem::Specification] Gem to convert.
+  # @param base_path [String] Output path.
+  # @return [void]
+  # @example Converting a gem by name
+  #   Halite.convert('mygem', 'dest')
+  # @example Converting a gem from a loaded gemspec
+  #   Halite.convert(Bundler.load_gemspec('mygem.gemspec'), 'dest')
   def self.convert(gem_name, base_path)
     Converter.write(Gem.new(gem_name), base_path)
   end

data/lib/halite/berkshelf/helper.rb

@@ -19,9 +19,13 @@ require 'halite/berkshelf/source'
 require 'berkshelf/berksfile'
 require 'berkshelf/downloader'
 
+
 module Halite
   module Berkshelf
-
+    # Helper class to monkeypatch global gem support in to Berkshelf.
+    #
+    # @since 1.0.0
+    # @api private
     class Helper
       def self.install(*args)
         new(*args).install
@@ -30,8 +34,10 @@ module Halite
       def initialize
       end
 
+      # Install the two patches.
+      #
+      # @return [void]
       def install
-
         # Switch this to use Module#prepend at some point when I stop caring about Ruby 1.9.
         ::Berkshelf::Berksfile.class_exec do
           old_sources = instance_method(:sources)

data/lib/halite/berkshelf/source.rb

@@ -18,11 +18,18 @@ require 'halite/gem'
 require 'berkshelf/source'
 require 'berkshelf/api_client/remote_cookbook'
 
+
 module Halite
   module Berkshelf
-
+    # Berkshelf global source to find all Halite cookbooks in the current
+    # gems environment.
+    #
+    # @since 1.0.0
+    # @api private
     class Source < ::Berkshelf::Source
       def initialize
+        # Pretend our URL is set even though it isn't used. Otherwise berks
+        # complains.
         super 'https://supermarket.chef.io'
       end
 
@@ -46,6 +53,7 @@ module Halite
         end
       end
 
+      # Show "... from Halite gems" when installing.
       def to_s
         "Halite gems"
       end