pronto-annotations_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d47d54a34a7ae4c0581de64e31dd7ee51d953ae6d6f8a7e2d87c3b90c0d5c977
+  data.tar.gz: a62ecd054dc312d9b5cbafb407e5ab9ceabc993e96aa0974338017ddd6130765
+SHA512:
+  metadata.gz: bea6670b76b06244805e08acfbd70919e7753ba3526c0d9ed5f7d8d72384578512e6aaae239e34722fb9182d6c4987a7320d6fb5823fc204c771d48e452e0bbd
+  data.tar.gz: c56169b1c22a30ce947055fc89216144ac2e9bd394287feb6de4330f63a7432c1504a5c717d0830f362f4a9dec49075baeb9041ab13c3054b8283f2b36d9e85a

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## 0.1.0
+
+This initial version uses a monkeypatch to change `FORMATTERS` const, adding the new formatter.
+Also, keeps compatibility with pronto versions prior to 0.11.2.
+
+### New features
+
+- Create AnnotationsFormatter class and change FORMATTERS const to include the new format

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Emílio
+
+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,70 @@
+# Pronto::AnnotationsFormatter
+
+Welcome!
+
+[prontolabs/pronto](https://github.com/prontolabs/pronto) is a great tool for code review, but it post the warnings as comments,
+which can be a bit of a mess and create many comments on the PR causing a huge noise for developers discussion.
+
+In a combination with [pronto-annotate-action](https://github.com/emilio2hd/pronto-annotate-action), it's possible to write annotations to the code, like this:
+
+![Annotation Warning on Code](https://raw.githubusercontent.com/emilio2hd/pronto-annotate-action/main/docs/annotation-warning-on-code.png)
+Leaving the comments just for the developers.
+
+Check the [.github/workflows/pr_linter.yml](.github/workflows/pr_linter.yml) and [this pull-request](https://github.com/emilio2hd/pronto-annotations_formatter/pull/1/files).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pronto-annotations_formatter'
+```
+
+And then execute:
+
+```shell
+  bundle install
+```
+
+Or install it yourself as:
+
+```shell
+  gem install pronto-annotations_formatter
+```
+
+## Usage
+
+```shell
+bundle exec pronto run -f annotations -c origin/main
+```
+
+The command above, will print some json like this:
+
+```json
+[
+  {
+    "message": "Migration file detected, but no changes in schema.rb",
+    "level": "warning",
+    "file": "db/migrate/20231013225210_create_products.rb",
+    "line": {
+      "start": 1,
+      "end": 1
+    },
+    "title": "Pronto::RailsSchema"
+  }
+]
+```
+
+## Development
+
+Then, run `bundle exec rspec` 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/emilio2hd/pronto-annotations_formatter>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/pronto/annotations_formatter/version.rb

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

data/lib/pronto/annotations_formatter.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require "pronto/formatter/base"
+
+require_relative "annotations_formatter/version"
+
+module Pronto
+  module Formatter
+    class AnnotationsFormatter < Pronto::Formatter::Base
+      # {
+      #   "message": "Some message",
+      #   "level": "warning",
+      #   "file": "some_file.rb",
+      #   "line": { "start": 1, "end": 1 },
+      #   "title": "The warning issuer, the runner"
+      # }
+      def format(messages, _repo, _patches)
+        messages.map { |m| build_report_line(m) }.to_json
+      end
+
+      private
+
+      def build_report_line(message)
+        lineno = message.line.new_lineno if message.line
+
+        result = {
+          message: message.msg,
+          level: get_github_level(message.level)
+        }
+        result[:file] = message.path if message.path
+        result[:line] = { start: lineno, end: lineno } if lineno
+        result[:title] = message.runner if message.runner
+
+        result
+      end
+
+      def get_github_level(pronto_level)
+        case pronto_level
+        when :error, :fatal
+          "error"
+        when :warning
+          "warning"
+        else
+          "notice"
+        end
+      end
+    end
+  end
+
+  module AnnotationsFormatterMonkeypatch
+    ANNOTATION_OPTION = "annotations"
+    ORIGINAL_FORMATTERS = {}.freeze
+
+    # Get Pronto::Formatter::FORMATTERS constant and set a new one, adding the annotations leading to new formatter.
+    # As FORMATTERS is a frozen hash, it's required remove it and set a new one with the new option.
+    def self.apply_patch
+      return unless Pronto::Formatter.const_defined?(:FORMATTERS)
+      return if Pronto::Formatter::FORMATTERS.keys.include?(ANNOTATION_OPTION)
+
+      formatters_const = Pronto::Formatter.const_get(:FORMATTERS)
+      Pronto::Formatter.send(:remove_const, :FORMATTERS)
+
+      send(:remove_const, :ORIGINAL_FORMATTERS)
+      const_set(:ORIGINAL_FORMATTERS, formatters_const)
+      Pronto::Formatter.const_set(
+        :FORMATTERS,
+        formatters_const.merge(ANNOTATION_OPTION => Pronto::Formatter::AnnotationsFormatter).freeze
+      )
+    end
+
+    apply_patch
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: pronto-annotations_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emilio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pronto
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+description: |2
+      This pronto formatter will print out the warnings in a json format to be consumed by
+      https://github.com/emilio2hd/pronto-annotate-action.
+email:
+- emilio2hd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/pronto/annotations_formatter.rb
+- lib/pronto/annotations_formatter/version.rb
+homepage: https://github.com/emilio2hd/pronto-annotations_formatter
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/emilio2hd/pronto-annotations_formatter/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: A gem to print out the warnings in a json format to be consumed by pronto-annotate-action.
+test_files: []