danger-wcc 0.0.3 → 0.1.1

data/lib/wcc/todos.rb

@@ -6,8 +6,8 @@ class Danger::DangerWCC < Danger::Plugin
   class Todos
     include Utils
 
-    TODO_REGEX = /^\+.*\#.*TODO:?/i
-    LINK_REGEX = /\#.*(https?\:\/\/\S+)/i
+    TODO_REGEX = /^\+.*\#.*TODO:?/i.freeze
+    LINK_REGEX = /\#.*(https?\:\/\/\S+)/i.freeze
 
     def initialize(plugin, options = {})
       @plugin = plugin
@@ -26,11 +26,11 @@ class Danger::DangerWCC < Danger::Plugin
       if result[:link]
         plugin.message "TODO added in #{result[:file_link]} "\
           "referencing [#{result[:link]}](#{result[:link]})",
-          file: result[:file], line: result[:line]
+                       file: result[:file], line: result[:line]
       else
         plugin.warn "TODO added in #{result[:file_link]} - "\
           'is there a card associated with that?',
-          file: result[:file], line: result[:line]
+                    file: result[:file], line: result[:line]
       end
     end
 
@@ -72,6 +72,7 @@ class Danger::DangerWCC < Danger::Plugin
     def max(a, b)
       return a if b.nil?
       return b if a.nil?
+
       a > b ? a : b
     end
   end

data/lib/wcc/util/yarn_info.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+class Danger::DangerWCC::Util
+  class YarnInfo
+    def yarn_lock
+      @yarn_lock ||= File.readlines(@options[:lockfile] || 'yarn.lock')
+    end
+
+    def package_json_dependencies
+      @package_json_dependencies ||=
+        JSON.parse(File.read('package.json'))['dependencies']&.keys || []
+    end
+
+    def package_json_changes
+      @package_json_changes ||= find_package_json_changes
+    end
+
+    def modified_yarn_dependencies
+      @modified_yarn_dependencies ||= find_modified_yarn_packages
+    end
+
+    attr_reader :plugin
+
+    def initialize(plugin, options = nil)
+      @plugin = plugin
+      @options = options || {}
+    end
+
+    def find_index_in_lockfile(package, version)
+      return 0 unless version
+
+      re = Regexp.new("^\"?#{Regexp.escape(package)}@", Regexp::IGNORECASE)
+      indexes =
+        yarn_lock.each_with_index
+          .select { |l, _i| re.match(l) }
+          .map { |pair| pair[1] }
+      idx =
+        indexes.find do |i|
+          yarn_lock[i + 1].include?("version \"#{version}\"")
+        end
+      (idx || -1) + 1
+    end
+
+    def parse_yarn_semver(line)
+      match = /(?<package>\S+)\@(?<version>\S+)/.match(line)
+      [match['package'], Gem::Version.new(match['version'])] if match
+    end
+
+    private
+
+    def find_package_json_changes
+      return [] unless file = plugin.find_file_in_diff('package.json')
+
+      adds = file.hunks.flat_map { |h| h.lines.select(&:addition?) }
+      adds.map { |l| /\"(?<package>\S+)\"\: \"\S+\"/.match(l.content) }
+        .compact
+        .map { |match| match['package'] }
+    end
+
+    def find_modified_yarn_packages # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      diff = plugin.run_and_diff(
+        'NODE_ENV=production yarn list --depth 0 2>/dev/null'
+      )
+      diff = GitDiff.from_string(diff)
+
+      {}.tap do |modified_packages|
+        plugin.each_file_in_diff(diff) do |file, _diff|
+          file.hunks.each do |hunk|
+            deleted, added =
+              %i[deletion? addition?].map do |type|
+                Hash[hunk.lines.select { |l| l.public_send(type) }
+                  .map { |l| parse_yarn_semver(l.content) }
+                  .compact]
+              end
+            deleted.each do |(package, version)|
+              modified_packages[package] =
+                [version, added[package]]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wcc/utils.rb

@@ -1,4 +1,3 @@
-
 # frozen_string_literal: true
 
 require 'git_diff'
@@ -13,6 +12,7 @@ module Utils
 
   def logger
     return @logger if @logger
+
     @logger = Logger.new(STDERR)
     @logger.level = ENV['DANGER_LOG_LEVEL'] ||
       (plugin.verbose ? Logger::INFO : Logger::ERROR)
@@ -22,7 +22,7 @@ module Utils
   # All the diffs in the PR parsed into GitDiff objects
   def parsed_diffs
     @parsed_diffs ||=
-      plugin.git.diff.map do |d|
+      plugin.git.diff&.map do |d|
         begin
           GitDiff.from_string(d.patch)
         rescue StandardError
@@ -32,6 +32,13 @@ module Utils
       end
   end
 
+  def find_file_in_diff(filename)
+    each_file_in_diff do |file, _diff|
+      return file if file.b_path == filename
+    end
+    nil
+  end
+
   # Finds lines in the overall diff matching the given regex, and
   # executes a block for each matched line.
   # The results of the yield block are returned as an array.
@@ -52,17 +59,22 @@ module Utils
 
   def each_file_in_diff(passed_diff = nil)
     diffs = passed_diff ? [passed_diff] : parsed_diffs
-    diffs.flat_map do |diff|
+    diffs&.flat_map do |diff|
       diff.files.flat_map do |file|
         yield(file, diff)
       end
     end
   end
 
-  def each_addition_in_diff(passed_diff = nil)
+  def each_addition_in_diff(passed_diff = nil, &block)
+    each_line_in_diff(passed_diff, type: :addition, &block)
+  end
+
+  def each_line_in_diff(passed_diff = nil, type: nil)
     each_file_in_diff(passed_diff) do |file, diff|
       file.hunks.flat_map do |hunk|
-        lines = hunk.lines.select(&:addition?)
+        lines = hunk.lines
+        lines = lines.select { |l| l.public_send("#{type}?") } if type
         lines = lines.map { |l| yield(l, hunk, file, diff) } if block_given?
         lines
       end

data/lib/wcc/yarn_deduplicate.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative 'utils'
+
+class Danger::DangerWCC < Danger::Plugin
+  class YarnDeduplicate
+    include Utils
+
+    DEFAULT_OPTIONS = {
+      lockfile: 'yarn.lock',
+      severity: :warn
+    }.freeze
+
+    def yarn_info
+      @yarn_info ||=
+        Danger::DangerWCC::Util::YarnInfo.new(self, @options)
+    end
+
+    def initialize(plugin, options = {})
+      @plugin = plugin
+      @options = DEFAULT_OPTIONS.merge(options)
+    end
+
+    def perform
+      diff = run_yarn_deduplicate_diff
+
+      each_addition_in_diff(diff) do |line|
+        add_deduplicate_warning(line)
+      end
+    end
+
+    private
+
+    def run_yarn_deduplicate_diff
+      diff =
+        run_and_diff do
+          run('npx yarn-deduplicate -s fewer --list '\
+            "#{@options[:lockfile]}")
+        end
+      GitDiff.from_string(diff)
+    end
+
+    # rubocop:disable Layout/LineLength
+    DEDUPE_REGEXP = /^\+Package \"([^\"]+)\" wants (\S+) and could get (\S+), but got (\S+)$/i.freeze
+    # rubocop:enable Layout/LineLength
+
+    def add_deduplicate_warning(line) # rubocop:disable Metrics/MethodLength
+      warning = line.content.match(DEDUPE_REGEXP)
+      return unless warning
+
+      pkg, semver, wanted, got = warning.captures
+
+      idx = yarn_info.find_index_in_lockfile(
+        pkg, got
+      )
+      msg = <<~HEREDOC
+        You have an opportunity to deduplicate "#{pkg}".
+        It wants #{semver} and could unify with #{wanted}, but instead #{got}
+        was installed alongside it.
+
+        You can fix this by running :
+        `npx yarn-deduplicate -s fewer --packages "#{pkg}"`
+      HEREDOC
+      plugin.public_send(@options[:severity],
+                         msg,
+                         file: @options[:lockfile],
+                         line: idx)
+    end
+  end
+end
+
+require_relative './util/yarn_info'

data/spec/fixtures/dependencies/package.json

@@ -0,0 +1,112 @@
+{
+  "name": "paper-signs",
+  "private": true,
+  "workspaces": [
+    ".",
+    "packages/*"
+  ],
+  "scripts": {
+    "fix-css": "stylelint app/**/*.scss --syntax scss --fix",
+    "fix-js": "tslint --project tsconfig.json app/assets/javascripts/**/*.ts?\\(x\\) --fix",
+    "fix": "yarn fix-js && yarn fix-css",
+    "check-types": "tsc --noemit",
+    "lint": "yarn lint-js && yarn lint-css",
+    "lint-css": "stylelint app/**/*.scss --syntax scss",
+    "lint-js": "tslint --project tsconfig.json app/assets/javascripts/**/*.ts?\\(x\\)",
+    "analyze": "RAILS_ENV=production NODE_ENV=production bin/webpack --profile --json > tmp/stats.json && webpack-bundle-analyzer tmp/stats.json public/packs --exclude server_rendering -m static",
+    "test": "jest && NODE_ENV=test karma start --",
+    "test-css": "mocha app/assets/stylesheets/true.js",
+    "test-watch": "NODE_ENV=test karma start --auto-watch --no-single-run",
+    "prepare": "contentful-ts-generator --download=false && for d in packages/*/; do (cd $d; yarn prepare) || exit -1; done"
+  },
+  "engines": {},
+  "dependencies": {
+    "@babel/core": "^7.8.3",
+    "@babel/plugin-proposal-class-properties": "^7.8.3",
+    "@babel/preset-env": "^7.8.3",
+    "@babel/preset-react": "^7.8.3",
+    "@babel/preset-typescript": "^7.8.3",
+    "@rails/webpacker": "^4.0.2",
+    "@types/algoliasearch": "^3.30.1",
+    "@types/algoliasearch-helper": "^2.26.1",
+    "@types/bootstrap": "^4.3.1",
+    "@types/bugsnag-js": "^3.1.0",
+    "@types/chai": "^4.1.7",
+    "@types/chai-jquery": "^1.1.38",
+    "@types/enzyme": "^3.1.15",
+    "@types/enzyme-adapter-react-16": "^1.0.3",
+    "@types/fontfaceobserver": "^0.0.6",
+    "@types/i18n-js": "^3.0.1",
+    "@types/lodash": "^4.14.134",
+    "@types/mocha": "^5.2.5",
+    "@types/qs": "^6.5.3",
+    "@types/react": "^16.9.34",
+    "@types/react-dom": "^16.0.9",
+    "@types/react-infinite-scroller": "^1.2.1",
+    "@types/react-instantsearch": "^5.2.1",
+    "@types/sinon": "^7.0.3",
+    "@types/webpack-env": "^1.13.9",
+    "@watermarkchurch/contentful-migration": "^1.0.9",
+    "@watermarkchurch/react-instantsearch-components": "*",
+    "async-toolbox": "^0.6.6",
+    "babel-preset-react": "^6.24.1",
+    "contentful-export": "^7.4.0",
+    "contentful-shell": "^0.2.7",
+    "contentful-ts-generator": "^0.2.4",
+    "core-js": "3",
+    "date-fns": "^1.30.1",
+    "enzyme": "^3.7.0",
+    "enzyme-adapter-react-16": "^1.7.0",
+    "fontfaceobserver": "^2.1.0",
+    "html-react-parser": "^0.9.1",
+    "i18n-js": "^3.5.1",
+    "identity-obj-proxy": "^3.0.0",
+    "inflection": "^1.12.0",
+    "postcss-cssnext": "^3.1.0",
+    "prop-types": "^15.6.2",
+    "qs": "^6.7.0",
+    "react": "^16.12.0",
+    "react-calendar": "^2.19.0",
+    "react-dom": "^16.12.0",
+    "react-infinite-scroller": "^1.2.2",
+    "react-instantsearch": "^5.3.2",
+    "react-svg-loader": "^3.0.3",
+    "react_ujs": "^2.4.4",
+    "sinon": "^7.2.2",
+    "typescript": "^3.3.3"
+  },
+  "devDependencies": {
+    "@percy/agent": "^0.28.0",
+    "@types/jest": "^25.2.1",
+    "@watermarkchurch/contentful-check": "*",
+    "@watermarkchurch/load-tester": "*",
+    "babel-jest": "^25.5.0",
+    "chai": "^4.2.0",
+    "chai-jquery": "^2.0.0",
+    "graphql-schema-diff": "^0.6.3",
+    "hard-source-webpack-plugin": "^0.13.1",
+    "jest": "^25.5.0",
+    "karma": "^3.1.1",
+    "karma-chai": "^0.1.0",
+    "karma-chai-jquery": "^1.0.0",
+    "karma-chrome-launcher": "^2.2.0",
+    "karma-jquery": "^0.2.3",
+    "karma-junit-reporter": "^1.2.0",
+    "karma-mocha": "^1.3.0",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-sourcemap-loader": "^0.3.7",
+    "karma-webpack": "^3.0.5",
+    "lerna": "^3.13.1",
+    "mocha": "^5.2.0",
+    "react-test-renderer": "^16.12.0",
+    "sass-true": "^4.0.0",
+    "stylelint": "^9.6.0",
+    "stylelint-config-sass-guidelines": "^5.2.0",
+    "stylelint-scss": "^3.3.2",
+    "ts-node": "^7.0.1",
+    "tslint": "^5.11.0",
+    "tslint-eslint-rules": "^5.4.0",
+    "webpack-bundle-analyzer": "^3.0.3",
+    "webpack-dev-server": "^3.3.1"
+  }
+}

data/spec/fixtures/dependencies/package.json.diff

@@ -0,0 +1,28 @@
+diff --git a/package.json b/package.json
+index 74d7ad8a..ea999d34 100644
+--- a/package.json
++++ b/package.json
+@@ -41,7 +41,6 @@
+     "@types/mocha": "^5.2.5",
+     "@types/qs": "^6.5.3",
+     "@types/react": "^16.9.34",
+-    "@types/react-autosuggest": "^9.3.6",
+     "@types/react-dom": "^16.0.9",
+     "@types/react-infinite-scroller": "^1.2.1",
+     "@types/react-instantsearch": "^5.2.1",
+@@ -67,7 +66,6 @@
+     "prop-types": "^15.6.2",
+     "qs": "^6.7.0",
+     "react": "^16.12.0",
+-    "react-autosuggest": "^9.4.3",
+     "react-calendar": "^2.19.0",
+     "react-dom": "^16.12.0",
+     "react-infinite-scroller": "^1.2.2",
+@@ -78,6 +76,7 @@
+     "typescript": "^3.3.3"
+   },
+   "devDependencies": {
++    "@percy/agent": "^0.28.0",
+     "@types/jest": "^25.2.1",
+     "@watermarkchurch/contentful-check": "*",
+     "@watermarkchurch/load-tester": "*",

data/spec/fixtures/dependencies/package.json_patch_bumps_minor.diff

@@ -0,0 +1,13 @@
+diff --git a/package.json b/package.json
+index ea999d3..efa8440 100644
+--- a/package.json
++++ b/package.json
+@@ -69,7 +69,7 @@
+     "react-calendar": "^2.19.0",
+     "react-dom": "^16.12.0",
+     "react-infinite-scroller": "^1.2.2",
+-    "react-instantsearch": "^5.3.2",
++    "react-instantsearch": "^5.3.3",
+     "react-svg-loader": "^3.0.3",
+     "react_ujs": "^2.4.4",
+     "sinon": "^7.2.2",

data/spec/fixtures/dependencies/package.json_patch_bumps_minor.json

@@ -0,0 +1,112 @@
+{
+  "name": "paper-signs",
+  "private": true,
+  "workspaces": [
+    ".",
+    "packages/*"
+  ],
+  "scripts": {
+    "fix-css": "stylelint app/**/*.scss --syntax scss --fix",
+    "fix-js": "tslint --project tsconfig.json app/assets/javascripts/**/*.ts?\\(x\\) --fix",
+    "fix": "yarn fix-js && yarn fix-css",
+    "check-types": "tsc --noemit",
+    "lint": "yarn lint-js && yarn lint-css",
+    "lint-css": "stylelint app/**/*.scss --syntax scss",
+    "lint-js": "tslint --project tsconfig.json app/assets/javascripts/**/*.ts?\\(x\\)",
+    "analyze": "RAILS_ENV=production NODE_ENV=production bin/webpack --profile --json > tmp/stats.json && webpack-bundle-analyzer tmp/stats.json public/packs --exclude server_rendering -m static",
+    "test": "jest && NODE_ENV=test karma start --",
+    "test-css": "mocha app/assets/stylesheets/true.js",
+    "test-watch": "NODE_ENV=test karma start --auto-watch --no-single-run",
+    "prepare": "contentful-ts-generator --download=false && for d in packages/*/; do (cd $d; yarn prepare) || exit -1; done"
+  },
+  "engines": {},
+  "dependencies": {
+    "@babel/core": "^7.8.3",
+    "@babel/plugin-proposal-class-properties": "^7.8.3",
+    "@babel/preset-env": "^7.8.3",
+    "@babel/preset-react": "^7.8.3",
+    "@babel/preset-typescript": "^7.8.3",
+    "@rails/webpacker": "^4.0.2",
+    "@types/algoliasearch": "^3.30.1",
+    "@types/algoliasearch-helper": "^2.26.1",
+    "@types/bootstrap": "^4.3.1",
+    "@types/bugsnag-js": "^3.1.0",
+    "@types/chai": "^4.1.7",
+    "@types/chai-jquery": "^1.1.38",
+    "@types/enzyme": "^3.1.15",
+    "@types/enzyme-adapter-react-16": "^1.0.3",
+    "@types/fontfaceobserver": "^0.0.6",
+    "@types/i18n-js": "^3.0.1",
+    "@types/lodash": "^4.14.134",
+    "@types/mocha": "^5.2.5",
+    "@types/qs": "^6.5.3",
+    "@types/react": "^16.9.34",
+    "@types/react-dom": "^16.0.9",
+    "@types/react-infinite-scroller": "^1.2.1",
+    "@types/react-instantsearch": "^5.2.1",
+    "@types/sinon": "^7.0.3",
+    "@types/webpack-env": "^1.13.9",
+    "@watermarkchurch/contentful-migration": "^1.0.9",
+    "@watermarkchurch/react-instantsearch-components": "*",
+    "async-toolbox": "^0.6.6",
+    "babel-preset-react": "^6.24.1",
+    "contentful-export": "^7.4.0",
+    "contentful-shell": "^0.2.7",
+    "contentful-ts-generator": "^0.2.4",
+    "core-js": "3",
+    "date-fns": "^1.30.1",
+    "enzyme": "^3.7.0",
+    "enzyme-adapter-react-16": "^1.7.0",
+    "fontfaceobserver": "^2.1.0",
+    "html-react-parser": "^0.9.1",
+    "i18n-js": "^3.5.1",
+    "identity-obj-proxy": "^3.0.0",
+    "inflection": "^1.12.0",
+    "postcss-cssnext": "^3.1.0",
+    "prop-types": "^15.6.2",
+    "qs": "^6.7.0",
+    "react": "^16.12.0",
+    "react-calendar": "^2.19.0",
+    "react-dom": "^16.12.0",
+    "react-infinite-scroller": "^1.2.2",
+    "react-instantsearch": "^5.3.3",
+    "react-svg-loader": "^3.0.3",
+    "react_ujs": "^2.4.4",
+    "sinon": "^7.2.2",
+    "typescript": "^3.3.3"
+  },
+  "devDependencies": {
+    "@percy/agent": "^0.28.0",
+    "@types/jest": "^25.2.1",
+    "@watermarkchurch/contentful-check": "*",
+    "@watermarkchurch/load-tester": "*",
+    "babel-jest": "^25.5.0",
+    "chai": "^4.2.0",
+    "chai-jquery": "^2.0.0",
+    "graphql-schema-diff": "^0.6.3",
+    "hard-source-webpack-plugin": "^0.13.1",
+    "jest": "^25.5.0",
+    "karma": "^3.1.1",
+    "karma-chai": "^0.1.0",
+    "karma-chai-jquery": "^1.0.0",
+    "karma-chrome-launcher": "^2.2.0",
+    "karma-jquery": "^0.2.3",
+    "karma-junit-reporter": "^1.2.0",
+    "karma-mocha": "^1.3.0",
+    "karma-mocha-reporter": "^2.2.5",
+    "karma-sourcemap-loader": "^0.3.7",
+    "karma-webpack": "^3.0.5",
+    "lerna": "^3.13.1",
+    "mocha": "^5.2.0",
+    "react-test-renderer": "^16.12.0",
+    "sass-true": "^4.0.0",
+    "stylelint": "^9.6.0",
+    "stylelint-config-sass-guidelines": "^5.2.0",
+    "stylelint-scss": "^3.3.2",
+    "ts-node": "^7.0.1",
+    "tslint": "^5.11.0",
+    "tslint-eslint-rules": "^5.4.0",
+    "webpack-bundle-analyzer": "^3.0.3",
+    "webpack-dev-server": "^3.3.1"
+  }
+}