pronto-gitlab_resolver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5af1fa16554a37c187cf4d47bf7665cd008757b60787cd2b69e6754c1a91872a
+  data.tar.gz: c0b7d55c844040a2c07e62dc11d4457cff61ebb7c85f097786c802f37498f848
+SHA512:
+  metadata.gz: fa23660d84dc2af2b4d880b0248dfef62c15209c4fb4b64c38b8e1d0d393223ed18f2bdff084b72c871596563f4b515fb2c62193903711c26604aec73adf994a
+  data.tar.gz: 38e062847e4fca332cf0f76707aa5fdb9297bbb1c0b022cf3b2c985e93e10c886e2a49f6f688468b26c3bc14c5f236df924550bcadeb646fe052e1cac0c53c08

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pronto-gitlab_resolver.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+gem "webmock"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    pronto-gitlab_resolver (0.1.0)
+      pronto (~> 0.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    faraday (2.7.1)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    gitlab (4.19.0)
+      httparty (~> 0.20)
+      terminal-table (>= 1.5.1)
+    hashdiff (1.0.1)
+    httparty (0.20.0)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.2)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_xml (0.6.0)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
+    parallel (1.22.1)
+    parser (3.1.2.1)
+      ast (~> 2.4.1)
+    pronto (0.11.0)
+      gitlab (~> 4.4, >= 4.4.0)
+      httparty (>= 0.13.7)
+      octokit (~> 4.7, >= 4.7.0)
+      rainbow (>= 2.2, < 4.0)
+      rexml (~> 3.2)
+      rugged (>= 0.23.0, < 1.1.0)
+      thor (>= 0.20.3, < 2.0)
+    public_suffix (5.0.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    rugged (1.0.1)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    thor (1.2.1)
+    unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-21
+
+DEPENDENCIES
+  pronto-gitlab_resolver!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  webmock
+
+BUNDLED WITH
+   2.3.10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Vasily Fedoseyev
+
+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,43 @@
+# Pronto::GitlabResolver
+
+Pronto gitlab formatter extension that marks fixed warning threads as resolved.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pronto-github_resolver', require: false
+```
+The line will probably go into `:lint` group, depending on your setup.
+
+And then execute:
+```sh
+bundle install
+```
+
+Or just:
+
+    $ bundle add pronto-gitlab_resolver
+
+
+## Usage
+
+Pronto will pick up this from gemfile automatically.
+If you already have pronto set up and working with `gitlab_mr` formatter, it should just work.
+
+Note that bot user should not be reused for other MR comments (because this will delete/resolve all other comments that are not returned by linters on current run).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Vasfed/pronto-gitlab_resolver.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/pronto/gitlab_resolver/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Pronto
+  module GitlabResolver
+    VERSION = "0.1.0"
+  end
+end

data/lib/pronto/gitlab_resolver.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "pronto"
+require_relative "gitlab_resolver/version"
+
+module Pronto
+  module Formatter
+    module GitlabResolver
+      def format(messages, repo, patches)
+        @messages = messages
+        @patches = patches
+        super
+      end
+
+      def approve_pull_request(_comments_count, _additions_count, client)
+        resolve_old_messages(client, new_comments(@messages, @patches))
+
+        super if defined?(super)
+      end
+
+      def resolve_old_messages(pronto_client, new_comments)
+        client = pronto_client.send(:client)
+        slug = pronto_client.send(:slug)
+        pull_id = pronto_client.send(:pull_id)
+        bot_id = client.user.id
+
+        # this is already done in #format upstream, repeated here not to monkey-patch that much
+        still_actual_comments = new_comments(@messages, @patches)
+
+        threads_to_resolve = client.merge_request_discussions(slug, pull_id).auto_paginate.select do |thread|
+          note = thread.notes&.first
+          # NOTE: this may cause issues if bot is reused for some other linters that also add code comments
+          next unless note&.author&.id == bot_id
+          next unless note["position"] && note.position&.[]("new_path")
+          note_position = [note.position.new_path, note.position.new_line]
+          next if still_actual_comments[note_position].any? { |comment| comment.body == note.body }
+          thread.notes.size == 1
+        end
+
+        threads_to_resolve.each do |thread|
+          if ENV['PRONTO_GITLAB_DELETE_RESOLVED']
+            client.delete_merge_request_discussion_note(slug, pull_id, thread.id, thread.notes.first.id)
+          else
+            client.resolve_merge_request_discussion(slug, pull_id, thread.id, resolved: true)
+          end
+        end
+      end
+    end
+  end
+end
+
+# if pronto did not have formatters array frozen - instead of monkeypatch we might have
+# class GitlabMergeRequestResolvingReviewFormatter < GitlabMergeRequestReviewFormatter
+#   prepend GitlabResolver
+# end
+Pronto::Formatter::GitlabMergeRequestReviewFormatter.prepend(Pronto::Formatter::GitlabResolver)

data/pronto-gitlab_resolver.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/pronto/gitlab_resolver/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "pronto-gitlab_resolver"
+  spec.version = Pronto::GitlabResolver::VERSION
+  spec.authors = ["Vasily Fedoseyev"]
+  spec.email = ["vasilyfedoseyev@gmail.com"]
+
+  spec.summary = "Pronto gitlab formatter extension that marks resolved comments"
+  # spec.description = "TODO: Write a longer description or delete this line."
+  spec.homepage = "https://github.com/Vasfed/pronto-gitlab_resolver"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "pronto", "~> 0.11"
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: pronto-gitlab_resolver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vasily Fedoseyev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description:
+email:
+- vasilyfedoseyev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/pronto/gitlab_resolver.rb
+- lib/pronto/gitlab_resolver/version.rb
+- pronto-gitlab_resolver.gemspec
+homepage: https://github.com/Vasfed/pronto-gitlab_resolver
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Vasfed/pronto-gitlab_resolver
+  source_code_uri: https://github.com/Vasfed/pronto-gitlab_resolver
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Pronto gitlab formatter extension that marks resolved comments
+test_files: []