chefspec-coveragereports 0.0.1

data.tar.gz.sig

@@ -0,0 +1,2 @@
+OC
���5�������b��2jU��
+���3�|�?<z$�L��*����,��xN���V�c��j#�5&�'�E�Xh�wE�`�=s��S�a����o٢��u��Y��ɂ�]��0�(iS���

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Anthony Spring
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# ChefSpec::CoverageReports
+
+Provides a generic interface to creating ChefSpec coverage reports, including a default JSON template.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chefspec-coveragereports'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install chefspec-coveragereports
+
+## Usage
+
+To enable the Coverage Reports functionality, you must include the following inside of your spec_helper:
+
+```ruby
+require 'chefspec/coveragereports'
+```
+
+With this included you can now tell the Coverage Reports what reports to generate and where to place the reports.
+
+#### Using one of the included templates
+
+To utilize one of the included Erubis templates you can use the following:
+
+```ruby
+ChefSpec::CoverageReports.add('json', 'coverage.json')
+```
+
+This will utilize the built in json template, and create a file named coverage.json.
+
+#### Proving your own template
+
+To utilize your own Erubis template you can use the following:
+
+```ruby
+ChefSpec::CoverageReports.add_custom('some/path/template.erb', 'coverage.report')
+```
+
+Where you provide the path to the template, and the output file for the report.
+
+## Template Functionality
+
+Coverage Reports exposes a hash called `@coverage` that can be used to create your own custom Erubis templates.
+
+This hash provides full access to the raw coverage data generated by ChefSpec, as well as some already processed data.
+
+### raw
+
+```ruby
+	@coverage['raw']
+```
+
+Provides full access to the array of raw data generated by ChefSpec
+
+### coverage
+
+```ruby
+	@coverage['coverage']
+```
+
+Provides acccess to the data processed by Coverage Reports.
+
+##### files
+
+```ruby
+	@coverage['coverage']['files']
+```
+
+Provides access to a hash of all of the files and the resources observed inside of them.
+
+#####  resources - all
+
+```ruby
+	@coverage['coverage']['resources']['all']
+```
+
+Provides access to a hash of all of the resources, keyed by name.
+
+##### resources - covered
+
+```ruby
+	@coverage['coverage']['resources']['covered']
+```
+
+Provides access to a hash of all of the resources that were covered, keyed by name.
+
+##### resources - uncovered
+
+```ruby
+	@coverage['coverage']['resources']['uncovered']
+```
+
+Provides access to a hash of all of the resources that were **not** covered, keyed by name.
+
+##### totals
+
+```ruby
+	@coverage['coverage']['totals']
+```
+
+Provides a set of totals to help make reporting easier, including total resources, covered and uncovered resource counts, as well as percent coverage.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/chefspec-reports/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/chefspec/coverage.rb

@@ -0,0 +1,35 @@
+require 'chefspec/coverage'
+
+ChefSpec::Coverage.class_eval do
+  def report!
+    # Borrowed from simplecov#41
+    #
+    # If an exception is thrown that isn't a "SystemExit", we need to capture
+    # that error and re-raise.
+    if $ERROR_INFO
+      exit_status = $ERROR_INFO.is_a?(SystemExit) ? $ERROR_INFO.status : ChefSpec::Coverage::EXIT_FAILURE
+    else
+      exit_status = ChefSpec::Coverage::EXIT_SUCCESS
+    end
+
+    report = {}.tap do |h|
+      h[:total]     = @collection.size
+      h[:touched]   = @collection.count { |_, resource| resource.touched? }
+      h[:coverage]  = ((h[:touched] / h[:total].to_f) * 100).round(2)
+    end
+
+    report[:untouched_resources] = @collection.map do |_, resource|
+      resource unless resource.touched?
+    end.compact
+
+    template = ChefSpec.root.join('templates', 'coverage', 'human.erb')
+    erb = Erubis::Eruby.new(File.read(template))
+    puts erb.evaluate(report)
+
+    # Generate the coverage reports
+    ChefSpec::CoverageReports.generate_reports(@collection)
+
+    # Ensure we exit correctly (#351)
+    Kernel.exit(exit_status) if exit_status && exit_status > 0
+  end
+end

data/lib/chefspec/coveragereports.rb

@@ -0,0 +1,122 @@
+require 'chefspec'
+require 'chefspec/coveragereports/version'
+require 'fileutils'
+
+module ChefSpec
+  class CoverageReports
+    class << self
+      def method_added(name)
+        # Only delegate public methods
+        if method_defined?(name)
+          instance_eval <<-EOH, __FILE__, __LINE__ + 1
+            def #{name}(*args, &block)
+              instance.public_send(:#{name}, *args, &block)
+            end
+          EOH
+        end
+      end
+    end
+
+    include Singleton
+
+    attr_reader :reports
+
+    def initialize
+      @reports = {}
+    end
+
+    def add(type, output_file)
+      reports[root.join('templates', "#{type}.erb")] = output_file
+    end
+
+    def add_custom(template, output_file)
+      reports[template] = output_file
+    end
+
+    def clear_reports
+      @reports = {}
+    end
+
+    def delete(type)
+      reports[type] = nil
+    end
+
+    def generate_reports(data)
+      @coverage             = {}
+      @coverage['raw']      = data
+      @coverage['coverage'] = process_report_data(data)
+
+      reports.each do |template, output_file|
+        erb = Erubis::Eruby.new(File.read(template))
+
+        # Create the output directory if it doesnt exist
+        dirname = File.dirname(output_file)
+        FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+
+        File.open(output_file, 'w') { |f| f.write(erb.evaluate(@coverage)) }
+      end
+    end
+
+    private
+
+    def root
+      @root ||= Pathname.new(File.expand_path('../../../', __FILE__))
+    end
+
+    def process_report_data(data)
+      results                           = {}
+      results['files']                  = {}
+      results['resources']              = {}
+      results['resources']['all']       = {}
+      results['resources']['covered']   = {}
+      results['resources']['uncovered'] = {}
+      results['totals']                 = {}
+
+      # Process the report data
+      data.map do |name, resource|
+        resource_hash = generate_resource_hash(resource)
+
+        # Store the file information
+        results['files'][resource.source_file]        ||= {}
+        results['files'][resource.source_file][name]  = resource_hash
+
+        # Store the resources information
+        results['resources']['all'][name]        = resource_hash
+        results['resources']['covered'][name]    = resource_hash if resource.touched?
+        results['resources']['uncovered'][name]  = resource_hash unless resource.touched?
+      end
+
+      # Sort the results
+      results['files'].sort
+      results['files'].each do |f, _|
+        results['files'][f].sort
+      end
+      results['resources']['all'].sort
+      results['resources']['covered'].sort
+      results['resources']['uncovered'].sort
+
+      # Calculate the derived totals
+      results['totals']['resources']    = results['resources']['all'].size
+      results['totals']['covered']      = results['resources']['covered'].size
+      results['totals']['uncovered']    = results['resources']['uncovered'].size
+      results['totals']['percent']      = ((results['totals']['covered'] / results['totals']['resources'].to_f) * 100).round(2)
+      results['totals']['percent']      = 0 if results['totals']['percent'].nan?
+      results['totals']['percent']      = 100 if results['totals']['percent'].infinite?
+
+      results
+    end
+
+    def generate_resource_hash(resource)
+      result = {}
+
+      result['name']    = resource.to_s
+      result['source']  = resource.source_file
+      result['line']    = resource.source_line
+      result['covered'] = resource.touched?
+
+      result
+    end
+  end
+end
+
+require_relative 'coverage'

data/lib/chefspec/coveragereports/version.rb

@@ -0,0 +1,13 @@
+module ChefSpec
+  # This defines the version of the gem
+  class CoverageReports
+    module Version
+      MAJOR = 0
+      MINOR = 0
+      PATCH = 1
+      BUILD = nil
+
+      STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+    end
+  end
+end

data/templates/json.erb

@@ -0,0 +1 @@
+<%= JSON.pretty_generate(@coverage) + "\n" %>

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: chefspec-coveragereports
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Anthony Spring
+autorequire: 
+bindir: bin
+cert_chain:
+- !binary |-
+  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURwakNDQW82Z0F3SUJB
+  Z0lCQVRBTkJna3Foa2lHOXcwQkFRVUZBREJNTVEwd0N3WURWUVFEREFSMGIy
+  NTUKTVNZd0pBWUtDWkltaVpQeUxHUUJHUllXY0c5eWEyTm9iM0J6WVc1a2NH
+  RnBiblJqYUdsd2N6RVRNQkVHQ2dtUwpKb21UOGl4a0FSa1dBMk52YlRBZUZ3
+  MHhOVEF6TWpneU1qUTVOREJhRncweE5qQXpNamN5TWpRNU5EQmFNRXd4CkRU
+  QUxCZ05WQkFNTUJIUnZibmt4SmpBa0Jnb0praWFKay9Jc1pBRVpGaFp3YjNK
+  clkyaHZjSE5oYm1Sd1lXbHUKZEdOb2FYQnpNUk13RVFZS0NaSW1pWlB5TEdR
+  QkdSWURZMjl0TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQwpBUThBTUlJ
+  QkNnS0NBUUVBcUxDMzVTYmFLQnQ3YjdISncxdDh0ejRrYStSNDl5cjBrNFNx
+  eUxGd0JiOXRHSVBKCm9ORWNtUzJWL05pV0l0bWtlLzcrdVphaklROW9XKzlr
+  aDJJdzE1bDQ5S0JobkZDcTNrK2IxeVRTVm1OZXBLbXoKN21tdDA1Rjg4VkZ6
+  aDRkU2hyZjRMdnlGT1JuQVMyTmJVblNvTDBhMFUzVS9ielMyWVhGbGROdkdE
+  aTVIdVZ2WApvK21xMHpXemJnOERjdWhVUjVHWFA2dnNVVzJZVFErTURvRU1n
+  enNwcDRwTUNFbDRNc2d4UzhTb3NTRi9yQXl6Cml6bndXOGN5REVhNDFjUUlL
+  UzRySWkySnpwdkdKYjJVd0JNTXVXaGthRG84MUR4cGJaRktmSGo2cm1zK0Zi
+  OEMKVFhNUVpvd0JpR05DQ1lVS3ZrT3JXTXVqWW0zVWxIY2RCS0NOelFJREFR
+  QUJvNEdTTUlHUE1Ba0dBMVVkRXdRQwpNQUF3Q3dZRFZSMFBCQVFEQWdTd01C
+  MEdBMVVkRGdRV0JCVERheUdjT1Y1cXB1bnk2ejdjYVRjcW11MzJZakFxCkJn
+  TlZIUkVFSXpBaGdSOTBiMjU1UUhCdmNtdGphRzl3YzJGdVpIQmhhVzUwWTJo
+  cGNITXVZMjl0TUNvR0ExVWQKRWdRak1DR0JIM1J2Ym5sQWNHOXlhMk5vYjNC
+  ellXNWtjR0ZwYm5SamFHbHdjeTVqYjIwd0RRWUpLb1pJaHZjTgpBUUVGQlFB
+  RGdnRUJBSFJrL3gxTTAwd0o3OHVkTzlROUZFemw2ajhMWnF3NHoxdVRlZW1J
+  aHVlMlB2NWpWV0cxClF3ZlFsQ1pQKzFQajZiWFl2aWtrQkhoN1FSVkgxVFZM
+  cHVnTE5YY3BvVnNwVnhITnVvdTRjNmhHa0VlRTBBYVYKVVlqcGtTcTFSNGt5
+  Qy9ETzVmSU4rRGpNZDcvNFhDZXBNUWJLdWt6R2Yxait0QkgvclJEWkJEMXlO
+  Y245MHZOYQpXMGRmY0dLOW82Q05YU3NPcXVCeDd6R25uS2NGWGlrcjU1Z1Bx
+  VW5qdWxSQnFVT21LN3lYUlgxL2h6R3RrenVwCnRWM0ZWcmVPRmlpWFo2eXhE
+  djVxdUNQdUh0bzZmWnh0d0RTb0xlaWVHeXJNVDgwaEFTMW5FT1dWWVh4V3BS
+  VmEKWEJRZVBYREhnZmw1SkRMMDVLSXowK3grLzVkRnFsTW5XSVE9Ci0tLS0t
+  RU5EIENFUlRJRklDQVRFLS0tLS0K
+date: 2015-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chefspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: ChefSpec Coverage Reports
+email:
+- tony@porkchopsandpaintchips.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/chefspec/coverage.rb
+- lib/chefspec/coveragereports/version.rb
+- lib/chefspec/coveragereports.rb
+- templates/json.erb
+- LICENSE.txt
+- README.md
+homepage: https://github.com/aspring/chefspec-coveragereports
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: ChefSpec Coverage Reports
+test_files: []
+has_rdoc: