rubocop-github-annotations-formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1baabb90c972c46540d62a72d52ffd0fa17523b0e074d0a4c06d2b90b180e31
+  data.tar.gz: b6f7b618109be88c9ca34173a98dd553698f49c335ff29b271e4c78fafd70b0f
+SHA512:
+  metadata.gz: 0fe13cfca339f7729e31fe8d9119e3b446c2a8f5c4e742404d006396fa30d501fea1b73a46befcd2341e7e75b1146069cb3482ab6f055013077e2d2e300cd6d3
+  data.tar.gz: d00ead21419bd9eb287c8817325b668bcbcdf26d50a6de4a167708fed4ade2ce68d29d1a568f8283513471a84b208ba6937152947213bc5cb42e0f4d42701acd

data/.github/workflows/main.yml

@@ -0,0 +1,21 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake
+

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@colby.fyi. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop-github-annotations-formatter.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "rubocop"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    rubocop-github-annotations-formatter (0.1.0)
+      rubocop
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  rubocop
+  rubocop-github-annotations-formatter!
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Colby Swandale
+
+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,58 @@
+# Github Annotation Rubocop Formatter
+
+This gem adds support for rendering Rubocop errors into Github Annotations.
+
+![example github annotation](https://raw.githubusercontent.com/colby-swandale/rubocop-github-annotations-formatter/master/resources/example.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-github-annotations-formatter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rubocop-github-annotations-formatter
+
+## Usage
+
+**Note:** Rubocop must be executed inside [Github Actions](https://github.com/features/actions) for Annotations to work, using a 3rd party CI service like Travis-CI or CircleCI won't render any annotations.
+
+Append your `.rubocop.yml` file to load the formatter
+
+```yaml
+require:
+  - rubocop-github-annotation-formatter
+```
+
+Then append your CI scripts to run rubocop with:
+
+    bundle exec rubocop --format RubocopGithubAnnotationFormatter::AnnotationFormatter
+
+You can have multiple different sets of output to maintain your current setup:
+
+    bundle exec rubocop --format progress --format RubocopGithubAnnotationFormatter::AnnotationFormatter
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/colby-swandale/rubocop-github-annotations-formatter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rubocop-github-annotations-formatter/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Rubocop::Github::Annotations::Formatter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rubocop-github-annotations-formatter/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rubocop-github-annotation-formatter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/example/test.rb

@@ -0,0 +1,8 @@
+foo = [
+  a,
+      b,
+
+c
+]
+
+puts foo

data/lib/rubocop-github-annotation-formatter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "rubocop-github-annotation-formatter/version"
+require 'rubocop/formatter/base_formatter'
+
+module RubocopGithubAnnotationFormatter
+  class AnnotationFormatter < RuboCop::Formatter::BaseFormatter
+    ANNOTATION_TEMPLATE = "\n::error file=%<file>s,line=%<line>d,col=%<col>d :: %<message>s\n"
+
+    def file_finished(file, offenses)
+      return if offenses.empty?
+
+      offenses.each do |offense|
+        next if offense.corrected?
+
+        output.printf(ANNOTATION_TEMPLATE, file: file,  line: offense.location.line, col: offense.location.begin_pos,
+          message: offense.message)
+      end
+    end
+  end
+end

data/lib/rubocop-github-annotation-formatter/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubocopGithubAnnotationFormatter
+  VERSION = "0.1.0"
+end

data/rubocop-github-annotations-formatter.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/rubocop-github-annotation-formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubocop-github-annotations-formatter"
+  spec.version       = RubocopGithubAnnotationFormatter::VERSION
+  spec.authors       = ["Colby Swandale"]
+  spec.email         = ["me@colby.fyi"]
+
+  spec.summary       = %q{Format rubocop output for Github Annotations}
+  spec.description   = %q{Format rubocop output for Github Annotations}
+  spec.homepage      = "https://github.com/colby-swandale/rubocop-github-annotations-formatter"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/colby-swandale/rubocop-github-annotations-formatter"
+
+  spec.require_paths = ["lib"]
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.add_dependency "rubocop"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-github-annotations-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Colby Swandale
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Format rubocop output for Github Annotations
+email:
+- me@colby.fyi
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/test.rb
+- lib/rubocop-github-annotation-formatter.rb
+- lib/rubocop-github-annotation-formatter/version.rb
+- resources/example.png
+- rubocop-github-annotations-formatter.gemspec
+homepage: https://github.com/colby-swandale/rubocop-github-annotations-formatter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/colby-swandale/rubocop-github-annotations-formatter
+  source_code_uri: https://github.com/colby-swandale/rubocop-github-annotations-formatter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Format rubocop output for Github Annotations
+test_files: []