danger-xccov_summary 0.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc1ff235a1007c5ca9867d5c1f9d47c94e553a940481f2b7bb10448e8ddc062b
+  data.tar.gz: 850e573e050727e116a33ed196695b75ffa8c7259dea71e3d7d250608a581370
+SHA512:
+  metadata.gz: '08186c58944a085eb14beff82a9922af2db4967b3660323634a58348ddbdc79db5ed782f26a2165f13c26802f761c788e3a0dfd35ffe458cb54e6d0845737c77'
+  data.tar.gz: 163f3f5335188494cf1c94c238a9ad7b27c7b637d46a894a19d7a3526f4c1985e6362fb7ed1fde44a801cfb012bf16b0384d3f37650f991c0f9ba28ffa591300

data/.rubocop.yml

@@ -0,0 +1,2 @@
+AllCops:
+  TargetRubyVersion: 2.5

data/.yardoc/checksums

@@ -0,0 +1,4 @@
+/Users/taylor.ledingham/dev/xccov-summary/lib/danger_plugin.rb 4513d492d2e564d195467d85a5f30d504900bf71
+/Users/taylor.ledingham/dev/xccov-summary/lib/xccov_summary/gem_version.rb 149d6852d4b67ad013804282329e1710dcd3ad91
+/Users/taylor.ledingham/dev/xccov-summary/lib/xccov_summary/plugin.rb f02350d748e3a824a2c009cf7a781a5702b3ee43
+/Users/taylor.ledingham/dev/xccov-summary/lib/danger_xccov_summary.rb dc27021b9601fe654563c3525688abe17b632775

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-xccov_summary.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    danger-xccov_summary (0.0.7)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    claide (1.0.2)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (5.6.2)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 1.0)
+      git (~> 1)
+      kramdown (~> 1.5)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    faraday (0.15.2)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.1)
+      faraday (~> 0.8)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    git (1.4.0)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    kramdown (1.17.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    multipart-post (2.0.0)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.9.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.56.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+    shellany (0.0.1)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.0)
+    unicode-display_width (1.4.0)
+    yard (0.9.14)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  danger-xccov_summary!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  yard
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2018 HootSuite Media 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.

data/README.md

@@ -0,0 +1,30 @@
+# danger-xccov_summary
+
+A description of danger-xccov_summary.
+
+## Installation
+
+    $ gem install danger-xccov_summary
+
+## Usage
+
+Simply add `xccov_summary` to your `Dangerfile`.
+
+```ruby
+xccov_summary.configure('path/to/buildDirectory')
+xccov_summary.show_coverage
+```
+And it will look like:
+
+To make sure the PR has a minimum amount of coverage call the method. Passing `fail` for `notify_level` will fail the build if coverage doesn't meet the minimum: 
+```ruby
+xccov_summary.notify_if_coverage_is_less_than(minimum_coverage: 100.00, options: {:notify_level=>:warn})
+```
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-xccov_summary.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xccov_summary/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-xccov_summary'
+  spec.version       = XccovSummary::VERSION
+  spec.authors       = ['Taylor Ledingham']
+  spec.email         = ['taylor.ledingham@hootsuite.com']
+  spec.description   = ''
+  spec.summary       = ''
+  spec.homepage      = 'https://github.hootops.com/taylorledingham/xccov-summary'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'yard'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require 'xccov_summary/plugin'

data/lib/danger_xccov_summary.rb

@@ -0,0 +1 @@
+require "xccov_summary/gem_version"

data/lib/xccov_summary/gem_version.rb

@@ -0,0 +1,3 @@
+module XccovSummary
+  VERSION = '0.0.7'.freeze
+end

data/lib/xccov_summary/plugin.rb

@@ -0,0 +1,67 @@
+module Danger
+  # This plugin will show the coverage of the project. You can add warnings or failures
+  # depending on the coverage percentage. It uses Xcode xccov to generate the coverage report.
+  #
+  # @example Require a minimum file coverage of 30%, a project coverage of 60% and show all modified files coverage
+  #       xccov_summary.configure("Path/to/my/build_directory")
+  #       xccov_summary.notify_if_coverage_is_less_than(minimum_coverage: 60)
+  #       xccov_summary.show_coverage
+  # @see  /danger-xccov_summary
+  # @tags codecoverage
+
+class DangerXccovSummary < Plugin
+
+  # Required method to configure xccov. It's required to provide the path to the build directory.
+  # @param    [String] build_directory path where the derivied data folder lives
+  # @return  [void]
+  def configure(project_build_directory)
+     @build_directory = project_build_directory
+     calculate_total_coverage
+  end
+
+
+  # Method to check if the coverage of the project is at least a minumum
+  # @param options [Hash] a hash with the options
+  # @option options [Float] :minimum_coverage the minimum code coverage required
+  # @option options [Symbol] :notify_level the level of notification
+  # @return [Array<String>]
+  def notify_if_coverage_is_less_than(options)
+    minimum_coverage = options[:minimum_coverage]
+    notify_level = options[:notify_level] || :fail
+    current_coverage = @current_coverage
+    if current_coverage < minimum_coverage
+      notify_message = "Total coverage is #{current_coverage} and is less than minimum: #{minimum_coverage}%"
+      if notify_level == :fail
+        fail notify_message
+      else
+        warn notify_message
+      end
+    end
+  end
+
+  # Show a header with the total coverage and coverage table
+  # @return [Array<String>]
+  def show_coverage
+    line = "## Code coverage\n"
+    line << total_coverage_markdown
+    markdown line
+  end
+
+  private
+
+  # String header with the total coverage of the project
+  # @return [String]
+  def total_coverage_markdown
+    "### Total coverage: **`#{@current_coverage}%`**\n"
+  end
+
+  # Total coverage of the project
+
+  def calculate_total_coverage
+    result = `xcrun xccov view #{@build_directory}/Logs/Test/*.xccovreport --json`
+    coverage_report = JSON.parse(result)
+    @current_coverage = (coverage_report['lineCoverage'] * 100).round(2)
+  end
+
+end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,65 @@
+require "pathname"
+ROOT = Pathname.new(File.expand_path("../../", __FILE__))
+$:.unshift((ROOT + "lib").to_s)
+$:.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+if `git remote -v` == ''
+  puts "You cannot run tests without setting a local git remote on this repo"
+  puts "It's a weird side-effect of Danger's internals."
+  exit(0)
+end
+
+# Use coloured output, it's the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it's already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

data/spec/xccov_summary_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+module Danger
+  describe Danger::DangerXccovSummary do
+    it "should be a plugin" do
+      expect(Danger::DangerXccovSummary.new(nil)).to be_a Danger::Plugin
+    end
+
+    #
+    # You should test your custom attributes and methods here
+    #
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @my_plugin = @dangerfile.xccov_summary
+        @my_plugin.total_coverage_markdown("70.99")
+
+        # mock the PR data
+        # you can then use this, eg. github.pr_author, later in the spec
+        json = File.read(File.dirname(__FILE__) + '/support/fixtures/github_pr.json') # example json: `curl https://api.github.com/repos/danger/danger-plugin-template/pulls/18 > github_pr.json`
+        allow(@my_plugin.github).to receive(:pr_json).and_return(json)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: danger-xccov_summary
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Taylor Ledingham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- taylor.ledingham@hootsuite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".yardoc/checksums"
+- ".yardoc/complete"
+- ".yardoc/object_types"
+- ".yardoc/objects/root.dat"
+- ".yardoc/proxy_types"
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-xccov_summary.gemspec
+- lib/danger_plugin.rb
+- lib/danger_xccov_summary.rb
+- lib/xccov_summary/gem_version.rb
+- lib/xccov_summary/plugin.rb
+- pkg/danger-xccov_summary-0.0.1.gem
+- spec/spec_helper.rb
+- spec/xccov_summary_spec.rb
+homepage: https://github.hootops.com/taylorledingham/xccov-summary
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/spec_helper.rb
+- spec/xccov_summary_spec.rb