netsoft-danger 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b7b3e2a4fbfa992da4950813e78d8276a5f8055b4b09987d36b62b761134f8a
-  data.tar.gz: e7f4046f836e76a11c5fcb5e37b31acdf664e921f506f8f7312a489852418168
+  metadata.gz: 456103b5d2e1de2010b9b7872ad35e05dd9280ccf2895626362750a5024abaa6
+  data.tar.gz: c57c9638ae3d747d64dfeb492ca75e68b6380d63b7f4bef38d2d90d6af9a37c8
 SHA512:
-  metadata.gz: 2cde3fa84fa78f571710f9d52d4508410550f0e30d7795e5f925aca31902453e328ccb332db3fb003bcfd692a22a55a470eff5ed0859a87492131b5c3636aa76
-  data.tar.gz: 38b61ca91282d42ba78b2bd7752f0be930fc1790f751bfb7c1e53e4772d66ca74dcf3d5e756aeb8011c6da009340bbacd436c7969f1030cce123ea406aefe8d1
+  metadata.gz: 12e7f27cd942a9bb9d9c425fc1ecbdca8a443076dabdb51a9770577ff67441bd2612b16a16d700bfd6f3e18e7ff2273b7a7105af1b56a0356b67bf5374451c65
+  data.tar.gz: 992cc446f38681c82f12b8d1191df42872717c84512c9185939f1ee5671d9099d0871592d936214e797e0e9f09cf6cc0f08eb2208b97946006ad20e2e78e8f1f

data/.circleci/config.yml

@@ -111,6 +111,10 @@ jobs:
           name: Build gem
           command: |-
             gem build *.gemspec
+      - run:
+          name: Run rubocop
+          command: |-
+            bundle exec rubocop
       - run:
           name: Run Danger
           command: |-

data/.rubocop.yml

@@ -0,0 +1,15 @@
+inherit_gem:
+  netsoft-rubocop:
+    - default.yml
+
+Style/SignalException:
+  Exclude:
+    - Dangerfile
+
+Style/IfUnlessModifier:
+  Exclude:
+    - Dangerfile
+
+Layout/EmptyLineAfterGuardClause:
+  Exclude:
+    - Dangerfile

data/CHANGELOG.md

@@ -9,6 +9,31 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Changed
 ### Fixed
 
+## [0.4.0]
+### Fixed
+- correct simplecov merge on newer simplecov release
+
+## [0.3.9]
+### Fixed
+- correct API call to github for adding labels and fix logic in determining if we should or should not add the label
+
+## [0.3.8]
+### Added
+- auto add/remove some labels
+- allow conventional commit format for our migration, gemfile, and package.json
+- add support for product review labels
+- add support for renamed code review labels
+
+## [0.3.7]
+### Fixed
+- require English in the netsoft-circle bin
+
+## [0.3.6]
+### Added
+- rubocop checks for this gem
+### Changed
+- allow bundler 1.17.3
+
 ## [0.3.5]
 ### Added
 - package.json checks

data/Dangerfile

@@ -1,118 +1,156 @@
+# frozen_string_literal: true
+
+def toggle_label(github, label, should_set)
+  repo_name = github.pr_json['head']['repo']['full_name']
+  pr_number = github.pr_json['number']
+  has_label = github.pr_labels.include?(label)
+
+  if should_set && !has_label
+    github.api.add_labels_to_an_issue(repo_name, pr_number, [label])
+  elsif !should_set && has_label
+    github.api.remove_label(repo_name, pr_number, label)
+  end
+end
+
 # Don't let testing shortcuts get into master by accident
-if Dir.exists?('spec')
-  fail("fdescribe left in tests") if `grep -r -e '\\bfdescribe\\b' spec/ |grep -v 'danger ok' `.length > 1
-  fail("fcontext left in tests") if `grep -r -e '\\bfcontext\\b' spec/ |grep -v 'danger ok' `.length > 1
-  fail("fit left in tests") if `grep -r -e '\\bfit\\b' spec/ | grep -v 'danger ok' `.length > 1
-  fail("ap left in tests") if `grep -r -e '\\bap\\b' spec/ | grep -v 'danger ok' `.length > 1
-  fail("puts left in tests") if `grep -r -e '\\bputs\\b' spec/ | grep -v 'danger ok' `.length > 1
+if Dir.exist?('spec')
+  fail('fdescribe left in tests') if `grep -r -e '\\bfdescribe\\b' spec/ |grep -v 'danger ok' `.length > 1
+  fail('fcontext left in tests') if `grep -r -e '\\bfcontext\\b' spec/ |grep -v 'danger ok' `.length > 1
+  fail('fit left in tests') if `grep -r -e '\\bfit\\b' spec/ | grep -v 'danger ok' `.length > 1
+  fail('ap left in tests') if `grep -r -e '\\bap\\b' spec/ | grep -v 'danger ok' `.length > 1
+  fail('puts left in tests') if `grep -r -e '\\bputs\\b' spec/ | grep -v 'danger ok' `.length > 1
 end
 
-if File.exists?('Gemfile')
+if File.exist?('Gemfile')
   if `grep -r -e "^ *gem 'hubstaff_[a-z]\\+" Gemfile | grep -e ",.\\+[a-zA-Z]" `.length > 1
-    fail("[gemfile] Beta hubstaff_* gems are not allowed in master/production")
+    fail('gemfile: Beta hubstaff_* gems are not allowed in master/production')
   end
   if `grep -r -e "^ *gem 'hubstaff_[a-z]\\+" Gemfile | grep -e ",.\\+'[~>=]\\+.\\+[a-zA-Z]" `.length > 1
-    fail("[gemfile] Beta hubstaff_* gems should be the exact version")
+    fail('gemfile: Beta hubstaff_* gems should be the exact version')
   end
   if `grep -r -e "^ *gem 'hubstaff_[a-z]\\+" Gemfile | grep -e ",.\\+[' ][0-9.]\\+'" | grep -v '~>' `.length > 1
-    fail("[gemfile] Release hubstaff_* gems should be using a ~> version")
+    fail('gemfile: Release hubstaff_* gems should be using a ~> version')
   end
 end
 
+if github.branch_for_head.start_with?('security')
+  toggle_label(github, 'security', true)
+end
+
+should_have_migration_label = false
+
 git.commits.each do |c|
-  short = " ( #{c.sha[0..7]} )"
-  has_migrations = c.diff_parent.any? {|f| f.path =~ /db\/migrate\// }
-  has_schema_changes = c.diff_parent.any? {|f| f.path =~ /db\/schema\.rb/ }
-  has_migration_msg = c.message =~ /\A\[migration\]/
-  no_schema_ok = ENV['DANGER_NO_SCHEMA_OK'] || false
+  short              = " ( #{c.sha[0..7]} )"
+  has_migrations     = c.diff_parent.any? { |f| f.path =~ %r{db/migrate/} }
+  has_schema_changes = c.diff_parent.any? { |f| f.path =~ %r{db/schema\.rb} }
+  old_migration_msg  = c.message.start_with?('[migration]')
+  has_migration_msg  = old_migration_msg || c.message.match?(/\Amigration(\([A-Za-z]+\))?:/)
+  no_schema_ok       = ENV['DANGER_NO_SCHEMA_OK'] || false
   if has_migrations || has_schema_changes
     unless has_migration_msg
-      fail '[migration] Schema migration commits need to be prefixed with [migration]' + short
+      fail 'migration: Schema migration commits needs to be tagged with (migration). e.g. migration(Module): ' + short
+    end
+    if old_migration_msg
+      warn 'migration: Please switch to the new conventional commit format.'
     end
     if has_migrations && !has_schema_changes && !no_schema_ok
-      fail '[migration] Please checkin your schema.rb changes with your migration' + short
+      fail 'migration: Please checkin your schema.rb changes with your migration' + short
     end
     if !has_migrations && has_schema_changes
-      warn '[migration] Please checkin your migrations with your schema.rb changes' + short
+      warn 'migration: Please checkin your migrations with your schema.rb changes' + short
     end
-    if c.diff_parent.any? {|f| !( f.path =~ /db\/migrate\/|db\/schema\.rb/ ) }
-      fail '[migration] Migration commit contains non-migration changes' + short
+    if c.diff_parent.any? { |f| f.path !~ %r{db/migrate/|db/schema\.rb} }
+      fail 'migration: Migration commit contains non-migration changes' + short
     end
+
+    should_have_migration_label = true
   elsif has_migration_msg
     fail '[migration] Migration commit with no migrations!' + short
   end
 
-  has_hubstaff_icon_changes = c.diff_parent.any? {|f| f.path =~ /hubstaff(icons|font)|fontcustom-manifest/ }
+  has_hubstaff_icon_changes = c.diff_parent.any? { |f| f.path =~ /hubstaff(icons|font)|fontcustom-manifest/ }
   if has_hubstaff_icon_changes
-    if c.diff_parent.any? {|f| !( f.path =~ /hubstaff-(icons|font)/ || f.path =~ /fontcustom-manifest/ ) }
-      fail '[hubstaff-icons] Put hubstaff-icon changes into their own commit' + short
+    if c.diff_parent.any? { |f| !(f.path =~ /hubstaff-(icons|font)/ || f.path =~ /fontcustom-manifest/) }
+      fail 'hubstaff-icons: Put hubstaff-icon changes into their own commit' + short
     end
   end
 
-  has_gemfile_changes = c.diff_parent.any? {|f| f.path =~ /Gemfile|gemspec/ }
-  has_gemfile_msg = c.message =~ /\A\[gemfile\]/
+  has_gemfile_changes = c.diff_parent.any? { |f| f.path =~ /Gemfile|gemspec/ }
+  old_gemfile_msg     = c.message.start_with?('[gemfile]')
+  has_gemfile_msg     = old_gemfile_msg || c.message.match?(/\Agemfile(\([A-Za-z]+\))?:/)
   if has_gemfile_changes
     unless has_gemfile_msg
-      fail '[gemfile] Gemfile commits need to be prefixed with [gemfile] ' + short
+      fail 'gemfile: Gemfile commits needs to be tagged with (gemfile). e.g. gemfile(Module): ' + short
+    end
+    if old_migration_msg
+      warn 'gemfile: Please switch to the new conventional commit format.'
     end
-    if c.diff_parent.any? {|f| !( f.path =~ /Gemfile|gemspec/ ) }
-      fail '[gemfile] Gemfile commit contains non-gemfile changes' + short
+    if c.diff_parent.any? { |f| f.path !~ /Gemfile|gemspec/ }
+      fail 'gemfile: Gemfile commit contains non-gemfile changes' + short
     end
-    if c.diff_parent.any? {|f| f.path == 'Gemfile.lock' }
-      unless `grep -e '^   1.15.2$' Gemfile.lock`.length > 1
-        fail("[gemfile] Gemfile not bundled with bundler 1.15.2")
+    if c.diff_parent.any? { |f| f.path == 'Gemfile.lock' }
+      unless `grep -E -- '^BUNDLED WITH\s*\n\s+(1\\.15\\.2|1\\.17\\.3)$' Gemfile.lock`.length > 1
+        fail('gemfile: Gemfile not bundled with bundler 1.15.2 or 1.17.3')
       end
     end
   elsif has_gemfile_msg
-    fail '[gemfile] Gemfile commit has no gemfile changes!' + short
+    fail 'gemfile: Gemfile commit has no gemfile changes!' + short
   end
 
-  has_package_changes = c.diff_parent.any? {|f| f.path =~ /package\.json|yarn\.lock/ }
-  has_package_msg = c.message =~ /\A\[package\.json\]/
+  has_package_changes = c.diff_parent.any? { |f| f.path =~ /package\.json|yarn\.lock/ }
+  old_package_msg     = c.message.start_with?('[package.json]')
+  has_package_msg     = old_package_msg || c.message.match?(/\Apackage(\([A-Za-z]+\))?:/)
   if has_package_changes
     unless has_package_msg
-      fail '[package.json] Package.json commits need to be prefixed with [package.json] ' + short
+      fail 'package: Package.json commits needs to be tagged with package. e.g package(Module): ' + short
+    end
+    if old_package_msg
+      warn 'package: Please switch to the new conventional commit format.'
     end
-    if c.diff_parent.any? {|f| !( f.path =~ /package\.json|yarn\.lock/ ) }
-      fail '[package.json] Package.json commit contains non-package changes' + short
+    if c.diff_parent.any? { |f| f.path !~ /package\.json|yarn\.lock/ }
+      fail 'package: Package.json commit contains non-package changes' + short
     end
   elsif has_package_msg
-    fail '[package.json] Pacakge.json commit has no package changes!' + short
+    fail 'package: Pacakge.json commit has no package changes!' + short
   end
 end
 
-require 'open-uri'
-
-artifact_url = "https://circleci.com/api/v1.1/project/github/#{ENV['CIRCLE_PROJECT_USERNAME']}/#{ENV["CIRCLE_PROJECT_REPONAME"]}/#{ENV['CIRCLE_BUILD_NUM']}/artifacts?circle-token=#{ENV['CIRCLE_TOKEN']}"
-artifacts = JSON.load(open(artifact_url).read).map{|a| a["url"]}
-
-jest = artifacts.find{ |artifact| artifact.end_with?('jest/index.html') }
-coverage = artifacts.find{ |artifact| artifact.end_with?('coverage/index.html') }
-rubocop = artifacts.find{ |artifact| artifact.end_with?('rubocop/report.html') }
-eslint = artifacts.find{ |artifact| artifact.end_with?('eslint/report.html') }
-rspec_files = artifacts.select{ |artifact| artifact =~ /rspec-(.+)\.html$/ }
-
-{}.tap do |hash|
-  hash['Ruby coverage report'] = coverage if coverage
-  hash['RSpec test report'] = rspec_files unless rspec_files.empty?
-  hash['RuboCop inspection report'] = rubocop if rubocop
-  hash['ESLint inspection report'] = eslint if eslint
-  hash['Jest coverage report'] = jest if jest
-end.each do |msg, links|
-  links = [*links]
-  if links.size == 1
-    message("[#{msg}](#{links[0]})")
-  else
-    r         = /rspec-(.+)\.html$/
-    the_links = links.map do |l|
-      m = r.match(l)
-      if m
-        "[#{m[1]}](#{l})"
-      else
-        "[link](#{l})"
-      end
-    end.join(', ')
+toggle_label(github, 'run migration', should_have_migration_label)
+
+if ENV['CIRCLE_TOKEN']
+  require 'open-uri'
 
-    message("#{msg} - #{the_links}")
+  artifact_url = "https://circleci.com/api/v1.1/project/github/#{ENV['CIRCLE_PROJECT_USERNAME']}/#{ENV['CIRCLE_PROJECT_REPONAME']}/#{ENV['CIRCLE_BUILD_NUM']}/artifacts?circle-token=#{ENV['CIRCLE_TOKEN']}"
+  artifacts    = JSON.parse(URI.parse(artifact_url).read).map { |a| a['url'] }
+
+  jest        = artifacts.find { |artifact| artifact.end_with?('jest/index.html') }
+  coverage    = artifacts.find { |artifact| artifact.end_with?('coverage/index.html') }
+  rubocop     = artifacts.find { |artifact| artifact.end_with?('rubocop/report.html') }
+  eslint      = artifacts.find { |artifact| artifact.end_with?('eslint/report.html') }
+  rspec_files = artifacts.select { |artifact| artifact =~ /rspec-(.+)\.html$/ }
+
+  {}.tap do |hash|
+    hash['Ruby coverage report']      = coverage if coverage
+    hash['RSpec test report']         = rspec_files unless rspec_files.empty?
+    hash['RuboCop inspection report'] = rubocop if rubocop
+    hash['ESLint inspection report']  = eslint if eslint
+    hash['Jest coverage report']      = jest if jest
+  end.each do |msg, links|
+    links = [*links]
+    if links.size == 1
+      message("[#{msg}](#{links[0]})")
+    else
+      r         = /rspec-(.+)\.html$/
+      the_links = links.map { |l|
+        m = r.match(l)
+        if m
+          "[#{m[1]}](#{l})"
+        else
+          "[link](#{l})"
+        end
+      }.join(', ')
+
+      message("#{msg} - #{the_links}")
+    end
   end
 end

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
 desc 'Default: run build.'
-task :default => :build
+task default: :build

data/bin/netsoft-circle

@@ -1,35 +1,36 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'thor'
 require 'fileutils'
+require 'English'
 
-class NetsoftCircle < Thor
+class NetsoftCircle < Thor # :nodoc:
   desc 'setup', 'Setup Heroku for deployment'
   def setup
-
     File.open("#{ENV['HOME']}/.netrc", 'a+') do |file|
-      file << <<-EOF
+      file << <<~CONFIG
 
-machine api.heroku.com
-  login #{ENV['HEROKU_LOGIN']}
-  password #{ENV['HEROKU_API_KEY']}
-machine git.heroku.com
-  login #{ENV['HEROKU_LOGIN']}
-  password #{ENV['HEROKU_API_KEY']}
-EOF
+        machine api.heroku.com
+          login #{ENV['HEROKU_LOGIN']}
+          password #{ENV['HEROKU_API_KEY']}
+        machine git.heroku.com
+          login #{ENV['HEROKU_LOGIN']}
+          password #{ENV['HEROKU_API_KEY']}
+      CONFIG
     end
 
-    Dir.mkdir("#{ENV['HOME']}/.ssh") unless Dir.exists?("#{ENV['HOME']}/.ssh")
+    Dir.mkdir("#{ENV['HOME']}/.ssh") unless Dir.exist?("#{ENV['HOME']}/.ssh")
     File.open("#{ENV['HOME']}/.ssh/config", 'a+') do |file|
-      file << <<-EOF
+      file << <<~CONFIG
 
-VerifyHostKeyDNS yes
-StrictHostKeyChecking no
-EOF
+        VerifyHostKeyDNS yes
+        StrictHostKeyChecking no
+      CONFIG
     end
 
     system('git config --global url."https://git.heroku.com/".insteadOf heroku:')
-    exit(1) unless $?.success?
+    exit(1) unless $CHILD_STATUS.success?
   end
 
   desc 'merge', 'Merges several simplecov json result files'
@@ -37,13 +38,14 @@ EOF
   def merge(*files)
     require 'simplecov'
     return if files.empty?
+
     results = []
 
     files.each do |file|
       json = JSON.parse(File.read(file))
       json.each do |command_name, data|
         result = SimpleCov::Result.from_hash(command_name => data)
-        results << result
+        results.concat [*result]
       end
     end
 
@@ -54,7 +56,7 @@ EOF
 
   desc 'rspec', 'Run rspec'
   def rspec
-    system <<-EOF
+    system <<~COMMAND
       bundle _${BUNDLE_VERSION}_ exec rspec \
         --color \
         --format RspecJunitFormatter \
@@ -63,20 +65,20 @@ EOF
         --out $CIRCLE_ARTIFACTS/rspec.html \
         --format progress \
         $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
-    EOF
-    exit(1) unless $?.success?
+    COMMAND
+    exit(1) unless $CHILD_STATUS.success?
   end
 
   desc 'rubocop', 'Run rubocop'
   def rubocop
-    system <<-EOF
+    system <<~COMMAND
       bundle _${BUNDLE_VERSION}_ exec rubocop \
         --parallel \
         --format progress \
         --format html \
         --out $CIRCLE_ARTIFACTS/rubocop/report.html
-    EOF
-    exit(1) unless $?.success?
+    COMMAND
+    exit(1) unless $CHILD_STATUS.success?
   end
 
   def self.exit_on_failure?

data/dangerfiles/pr.js

@@ -15,8 +15,12 @@ if ((danger.github.pr.body || '').length < 5) {
   fail("Please provide a summary in the Pull Request description");
 }
 
-if (!labels.includes('review passed')) {
-  fail("Has not passed code-review");
+if (labels.includes('product review needed')) {
+  fail('Has not passed product review');
+}
+
+if (!(labels.includes('review passed') || labels.includes('code review passed'))) {
+  fail("Has not passed code review");
 }
 
 if (!labels.includes('QA passed')) {

data/lib/netsoft-danger/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module NetsoftDanger
-  VERSION = '0.3.5'.freeze
+  VERSION = '0.4.0'
 end

data/netsoft-danger.gemspec

@@ -1,5 +1,6 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'netsoft-danger/version'
 
 Gem::Specification.new do |s|
@@ -15,8 +16,15 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'rake'
   s.add_runtime_dependency 'danger', '~> 5.0'
+  s.add_runtime_dependency 'faraday'
   s.add_runtime_dependency 'thor'
-  s.add_runtime_dependency 'faraday', '~> 0.15.0'
+
+  s.add_development_dependency 'rake'
+
+  s.add_development_dependency 'netsoft-rubocop', '= 1.0.1'
+  s.add_development_dependency 'rubocop', '= 0.74.0'
+  s.add_development_dependency 'rubocop-performance', '= 1.5.2'
+  s.add_development_dependency 'rubocop-rails', '= 2.4.2'
+  s.add_development_dependency 'rubocop-rspec', '= 1.38.1'
 end