poise-boiler 1.0.0

data/lib/poise_boiler/error.rb

@@ -0,0 +1,24 @@
+#
+# 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.
+#
+
+
+module PoiseBoiler
+  # Base class for poise-boiler errors.
+  #
+  # @since 1.0.0
+  class Error < Exception
+  end
+end

data/lib/poise_boiler/helpers.rb

@@ -0,0 +1,26 @@
+#
+# 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.
+#
+
+
+module PoiseBoiler
+  # Module for helper classes of various forms.
+  #
+  # @since 1.0.0
+  module Helpers
+    autoload :Rake, 'poise_boiler/helpers/rake'
+    autoload :SpecHelper, 'poise_boiler/helpers/spec_helper'
+  end
+end

data/lib/poise_boiler/helpers/rake.rb

@@ -0,0 +1,43 @@
+#
+# 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/helper_base'
+
+
+module PoiseBoiler
+  module Helpers
+    # Helper for a Rakefile to install common tasks for the Poise workflow.
+    #
+    # @since 1.0.0
+    # @see Badges
+    # @see Core
+    # @see Travis
+    class Rake < Halite::HelperBase
+      autoload :Badges, 'poise_boiler/helpers/rake/badges'
+      autoload :Core, 'poise_boiler/helpers/rake/core'
+      autoload :Travis, 'poise_boiler/helpers/rake/travis'
+
+      # Install all rake tasks.
+      #
+      # @return [void]
+      def install(*args)
+        Core.install(*args)
+        Badges.install(*args)
+        Travis.install(*args)
+      end
+    end
+  end
+end

data/lib/poise_boiler/helpers/rake/badges.rb

@@ -0,0 +1,124 @@
+#
+# 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 'addressable/uri'
+require 'halite/gem'
+require 'halite/helper_base'
+require 'mixlib/shellout'
+
+
+module PoiseBoiler
+  module Helpers
+    class Rake
+      # Helper for a Rakefile to add a `badges` command. This command will print
+      # out README badges suitable for use on GitHub.
+      #
+      # @since 1.0.0
+      # @example Installing tasks
+      #   require 'poise_boiler/helpers/rake/badges'
+      #   PoiseBoiler::Helpers::Rake::Badges.install
+      # @example Creating badges
+      #   $ rake badges >> README.md
+      class Badges < Halite::HelperBase
+        # Install the `badges` rake task.
+        #
+        # @return [void]
+        def install
+          # Delayed so that Rake doesn't need to be loaded to run this file.
+          extend ::Rake::DSL
+
+          desc "Generate README badges for #{gemspec.name}"
+          task 'badges' do
+            shell.say(generate_badges)
+          end
+        end
+
+        private
+
+        # Generate badges as a string.
+        #
+        # @return [String]
+        def generate_badges
+          # Example badges
+          # [![Build Status](https://img.shields.io/travis/poise/poise.svg)](https://travis-ci.org/poise/poise)
+          # [![Gem Version](https://img.shields.io/gem/v/poise.svg)](https://rubygems.org/gems/poise)
+          # [![Cookbook Version](https://img.shields.io/cookbook/v/poise.svg)](https://supermarket.chef.io/cookbooks/poise)
+          # [![Code Climate](https://img.shields.io/codeclimate/github/poise/poise.svg)](https://codeclimate.com/github/poise/poise)
+          # [![Coverage](https://img.shields.io/codecov/c/github/poise/poise.svg)](https://codecov.io/github/poise/poise)
+          # [![Gemnasium](https://img.shields.io/gemnasium/poise/poise.svg)](https://gemnasium.com/poise/poise)
+          # [![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+          ''.tap do |badges|
+            github = options[:github] || detect_github
+            badges << badge('Build Status', "travis/#{github}", "https://travis-ci.org/#{github}") if github
+            badges << badge('Gem Version', "gem/v/#{gemspec.name}", "https://rubygems.org/gems/#{gemspec.name}")
+            badges << badge('Cookbook Version', "cookbook/v/#{cookbook.cookbook_name}", "https://supermarket.chef.io/cookbooks/#{cookbook.cookbook_name}") if cookbook.is_halite_cookbook?
+            badges << badge('Code Climate', "codeclimate/github/#{github}", "https://codeclimate.com/github/#{github}") if github
+            badges << badge('Coverage', "codecov/c/github/#{github}", "https://codecov.io/github/#{github}") if github
+            badges << badge('Gemnasium', "gemnasium/#{github}", "https://gemnasium.com/#{github}") if github
+            badges << badge('License', 'badge/license-Apache_2-blue', 'https://www.apache.org/licenses/LICENSE-2.0')
+          end
+        end
+
+        # Create a single badge string.
+        #
+        # @param alt [String] Alt text for the badge.
+        # @param img [String] Image URI. If just a relative path is givenm it
+        #   will be a Shields.io image.
+        # @param href [String] URI to link to.
+        # @return [String]
+        def badge(alt, img, href)
+          # Default scheme and hostname because I can.
+          img = "https://img.shields.io/#{img}.svg" unless Addressable::URI.parse(img).host
+          "[![#{alt}](#{img})](#{href})\n"
+        end
+
+        # Find the GitHub user/org and repository name for this repository.
+        # Based on travis.rb https://github.com/travis-ci/travis.rb/blob/23ea1d2f34231a50a475b4ee8d19fa15b1d6b0e3/lib/travis/cli/repo_command.rb#L65
+        # Copyright (c) 2014-2015 Travis CI GmbH <support@travis-ci.com>
+        #
+        # @return [String, nil]
+        def detect_github
+          git_head = git_shell_out(%w{name-rev --name-only HEAD})
+          return nil unless git_head
+          git_remote = git_shell_out(%W{config --get branch.#{git_head}.remote})
+          git_remote = 'origin' if !git_remote || git_remote.empty? # Default value
+          git_info = git_shell_out(%w{ls-remote --get-url}+[git_remote])
+          git_regex = %r{/?(.*/.+?)(\.git)?$}
+          if md = Addressable::URI.parse(git_info).path.match(git_regex)
+            md[1]
+          else
+            # Unable to auto-detect
+            nil
+          end
+        end
+
+        # Run a git command and return the output.
+        #
+        # @param cmd [Array<String>] Command arguments to pass to git.
+        # @return [String, nil]
+        def git_shell_out(cmd)
+          cmd = Mixlib::ShellOut.new(['git']+cmd, cwd: base)
+          cmd.run_command
+          if cmd.error?
+            nil
+          else
+            cmd.stdout.strip
+          end
+        end
+      end
+    end
+  end
+end

data/lib/poise_boiler/helpers/rake/core.rb

@@ -0,0 +1,71 @@
+#
+# 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/helper_base'
+
+
+module PoiseBoiler
+  module Helpers
+    class Rake
+      # Helper for a Rakefile to install some standard tasks used by most
+      # Poise/Halite-style gems.
+      #
+      # @since 1.0.0
+      # @example Installing tasks
+      #   require 'poise_boiler/helpers/rake/core'
+      #   PoiseBoiler::Helpers::Rake::Core.install
+      # @example Running tests
+      #   $ rake test
+      class Core < Halite::HelperBase
+        # Install the rake tasks.
+        #
+        # @return [void]
+        def install
+          # Delayed so that Rake doesn't need to be loaded to run this file.
+          extend ::Rake::DSL
+
+          # Set the default task.
+          task default: %i{test}
+
+          # Create the spec task.
+          require 'rspec/core/rake_task'
+          RSpec::Core::RakeTask.new(:spec, :tag) do |t, args|
+            t.rspec_opts = [].tap do |a|
+              a << '--color'
+              a << "--format #{ENV['CI'] ? 'documentation' : 'Fuubar'}"
+              a << '--backtrace' if ENV['DEBUG']
+              a << "--seed #{ENV['SEED']}" if ENV['SEED']
+              a << "--tag #{args[:tag]}" if args[:tag]
+              a << "--default-path test"
+              a << '-I test/spec'
+            end.join(' ')
+          end
+
+          # Create the test task (which Halite will extend).
+          task test: %i{spec}
+
+          # Install gem tasks (build, upload, etc).
+          require 'bundler/gem_helper'
+          Bundler::GemHelper.install_tasks(options[:bundler] || {})
+
+          # Install the Halite tasks.
+          require 'halite/rake_helper'
+          Halite::RakeHelper.install(options)
+        end
+      end
+    end
+  end
+end

data/lib/poise_boiler/helpers/rake/travis.rb

@@ -0,0 +1,132 @@
+#
+# 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/helper_base'
+
+
+module PoiseBoiler
+  module Helpers
+    class Rake
+      # Helper for a Rakefile to install a task for testing on CI.
+      #
+      # @since 1.0.0
+      # @example Installing tasks
+      #   require 'poise_boiler/helpers/rake/travis'
+      #   PoiseBoiler::Helpers::Rake::Travis.install
+      # @example Running CI suite
+      #   $ rake travis
+      class Travis < Halite::HelperBase
+        # Install the rake tasks.
+        #
+        # @return [void]
+        def install
+          # Delayed so that Rake doesn't need to be loaded to run this file.
+          extend ::Rake::DSL
+
+          file 'test/docker/docker.key' do
+            sh 'openssl rsa -in test/docker/docker.pem -passin env:KITCHEN_DOCKER_PASS -out test/docker/docker.key'
+          end
+
+          file './docker' do
+            sh 'wget https://get.docker.io/builds/Linux/x86_64/docker-latest -O docker'
+            File.chmod(0755, './docker')
+          end
+
+          desc 'Run Test-Kitchen integration tests.'
+          task 'travis:integration' => %w{test/docker/docker.key ./docker} do
+            sh './bin/kitchen test -d always'
+          end
+
+          desc 'Run CI tests'
+          task 'travis' do
+            run_subtask('spec')
+            run_subtask('chef:foodcritic')
+            run_subtask('travis:integration') if integration_tests?
+          end
+        end
+
+        private
+
+        # Should we run integration tests?
+        #
+        # @return [Boolean]
+        def integration_tests?
+          ENV['TRAVIS_SECURE_ENV_VARS'] && !ENV['TRAVIS_SECURE_ENV_VARS'].empty? && !ENV['BUNDLE_GEMFILE'].to_s.include?('master')
+        end
+
+        # Convert a Time object to nanoseconds since the epoch.
+        #
+        # @param t [Time] Time object to convert.
+        # @return [Integer]
+        def time_nanoseconds(t)
+          (t.tv_sec * 1000000000) + t.nsec
+        end
+
+        # Wrap a block in Travis-CI timer tags. These are read by the web UI
+        # to nicely format timing information.
+        #
+        # @param block [Proc] Block to time.
+        # @return [void]
+        def travis_timer(&block)
+          begin
+            start_time = time_nanoseconds(Time.now)
+            timer_id = '%08x' % Random.rand(0xFFFFFFFF)
+            shell.say("travis_time:start:#{timer_id}")
+            block.call
+          ensure
+            end_time = time_nanoseconds(Time.now)
+            shell.say("travis_time:end:#{timer_id}:start=#{start_time},finish=#{end_time},duration=#{end_time - start_time}")
+          end
+        end
+
+        # Wrap a block in Travis-CI fold tags. These are read bu the web UI to
+        # allow hiding sections of output.
+        #
+        # @param name [String] Name of the fold block.
+        # @param block [Proc] Block to fold.
+        # @return [void]
+        def travis_fold(name, &block)
+          begin
+            shell.say("travis_fold:start:#{name}")
+            block.call
+          ensure
+            shell.say("travis_fold:end:#{name}")
+          end
+        end
+
+        # Decorate a Rake subtask for Travis.
+        #
+        # @param name [String] Task to run.
+        # @return [void]
+        def run_subtask(name)
+          travis_timer do
+            begin
+              shell.say("Running task #{name}")
+              task(name).invoke
+              shell.say("Task #{name} succeeded.", :green)
+            rescue StandardError => ex
+              shell.say("Task #{name} failed with #{ex}:", :red)
+              travis_fold "#{name}.backtrace" do
+                shell.say(ex.backtrace.map{|line| '  '+line }.join("\n"), :red)
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/poise_boiler/helpers/spec_helper.rb

@@ -0,0 +1,79 @@
+#
+# 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/helper_base'
+
+
+module PoiseBoiler
+  module Helpers
+    # Helper for a spec_helper.rb to configure things for the Poise workflow.
+    # This configures rspec, rspec-its, simplecov (with codeclimate and codecov
+    # if possible), and the Halite spec helper.
+    #
+    # @since 1.0.0
+    class SpecHelper < Halite::HelperBase
+      def install
+        require 'rspec'
+        require 'rspec/its'
+        require 'simplecov'
+
+        # Check for coverage stuffs
+        formatters = []
+        if ENV['CODECLIMATE_REPO_TOKEN']
+          require 'codeclimate-test-reporter'
+          formatters << CodeClimate::TestReporter::Formatter
+        end
+
+        if ENV['CODECOV_TOKEN'] || ENV['TRAVIS']
+          require 'codecov'
+          formatters << SimpleCov::Formatter::Codecov
+        end
+
+        unless formatters.empty?
+          SimpleCov.formatters = formatters
+        end
+
+        SimpleCov.start do
+          # Don't get coverage on the test cases themselves.
+          add_filter '/spec/'
+          add_filter '/test/'
+          # Codecov doesn't automatically ignore vendored files.
+          add_filter '/vendor/'
+        end
+
+        RSpec.configure do |config|
+          # Basic configuraiton
+          config.run_all_when_everything_filtered = true
+          config.filter_run(:focus)
+
+          # Run specs in random order to surface order dependencies. If you find an
+          # order dependency and want to debug it, you can fix the order by providing
+          # the seed, which is printed after each run.
+          #     --seed 1234
+          config.order = 'random'
+
+          unless options['no_halite']
+            require 'halite/spec_helper'
+            config.include Halite::SpecHelper(gem_name ? gemspec : nil)
+            # Hide the spec helper from RSpec traces by default.
+            config.backtrace_exclusion_patterns << %r{/halite/spec_helper}
+          end
+        end
+      end # /def install
+
+    end
+  end
+end