code-scanning-rubocop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fba92930acfcdaf83b378482055fe0d246bdcd7703016c552fa5cd16cc5a33d8
+  data.tar.gz: e0db9ec9d8e166c0e113481750a797c2f3a2c154ad260c20d0157908fa6389aa
+SHA512:
+  metadata.gz: c072c9d8b0c08f54c3c31edf48ba49be2ef7d7241d177003f8cfdc9b455a1d7a6b5a6e906e751b0b686d4d9d0b9629692a15b1f3e6cf25c2caabbdf94818df09
+  data.tar.gz: e386d92ff361fa505a7d7d1d1b0f41992175170e2528e7cd9c13128e3469ce097b775c6554a135a9400cba7a2f0cc2f271061f63446512a30db216dbf54ca43a

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

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 arthurnn@gmail.com. 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/Dockerfile

@@ -0,0 +1,11 @@
+FROM ruby:2.7.1
+
+# throw errors if Gemfile has been modified since Gemfile.lock
+RUN bundle config --global frozen 1
+
+COPY . .
+RUN rake install
+
+ARG GITHUB_WORKSPACE
+
+ENTRYPOINT ["/entrypoint.sh"]

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    code-scanning-rubocop (0.1.0)
+      activesupport
+      rubocop (~> 0.82.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    ast (2.4.0)
+    concurrent-ruby (1.1.6)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    minitest (5.14.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rexml (3.2.4)
+    rubocop (0.82.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    ruby-progressbar (1.10.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  code-scanning-rubocop!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Arthur Nogueira Neves
+
+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,44 @@
+# Code::Scanning::Rubocop
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/code/scanning/rubocop`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'code-scanning-rubocop'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install code-scanning-rubocop
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/arthurnn/code-scanning-rubocop. 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/arthurnn/code-scanning-rubocop/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 Code::Scanning::Rubocop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/arthurnn/code-scanning-rubocop/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 "code/scanning/rubocop"
+
+# 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/code-scanning-rubocop.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative 'lib/code_scanning/rubocop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "code-scanning-rubocop"
+  spec.version       = CodeScanning::Rubocop::VERSION
+  spec.authors       = ["Arthur Neves"]
+  spec.email         = ["arthurnn@gmail.com"]
+
+  spec.summary       = %q{Extra formater to make rubocop compatible with GitHub's code-scanning feature.}
+  spec.description   = %q{This gem adds a SARIF formatter to rubocop, so we can export alerts to code-scanning inside GitHub.}
+  spec.homepage      = "https://github.com/arthurnn/code-scanning-rubocop"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/arthurnn/code-scanning-rubocop"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rubocop', '~> 0.82.0'
+  # TODO: remove this
+  spec.add_dependency 'activesupport'
+end

data/entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -x
+
+cd $GITHUB_WORKSPACE
+
+gem list
+rubocop --require code_scanning --format CodeScanning::SarifFormatter
+exit 0

data/lib/code_scanning.rb

@@ -0,0 +1,4 @@
+module CodeScanning
+end
+
+require 'code_scanning/rubocop/sarif_formatter'

data/lib/code_scanning/rubocop/sarif_formatter.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'rubocop/formatter/base_formatter'
+require 'json'
+require 'active_support/all'
+require 'pathname'
+
+# TODO: fix me
+ROOT = __dir__
+module CodeScanning
+
+  class SarifFormatter < RuboCop::Formatter::BaseFormatter
+    def initialize(output, options = {})
+      super
+      @sarif = {}
+    end
+
+    def started(_target_files)
+      @sarif['$schema'] = 'https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json'
+      @sarif['version'] = '2.1.0'
+      @rules_map = {}
+      @results = []
+      @rules = []
+      @sarif['runs'] = [
+        { 'tool' => {
+            'driver' => { 'name' => 'Rubocop', 'rules' => @rules }
+          },
+          'results' => @results }
+      ]
+      # TODO: under runs
+      #    "tool" : {
+      #      "driver" : {
+      #        "name" : "CodeQL command-line toolchain",
+      #        "organization" : "GitHub",
+      #        "semanticVersion" : "2.0.0",
+      #        "rules" : [ {
+    end
+
+    Rule = Struct.new(:name, :index, :hash) do
+    end
+
+    def set_rule(cop_name, severity)
+      if r = @rules_map[cop_name]
+        return r
+      end
+
+      desc = RuboCop::ConfigLoader.default_configuration[cop_name]['Description']
+      h = {
+        'id' => cop_name, 'name' => cop_name,
+        'shortDescription' => {
+          'text' => desc
+        },
+        'fullDescription' => {
+          'text' => desc
+        },
+        'defaultConfiguration' => {
+          'level' => sarif_severity(severity)
+        },
+        'properties' => {}
+      }
+      @rules << h
+      @rules_map[cop_name] = Rule.new(cop_name, @rules.size - 1, h)
+    end
+
+    def sarif_severity(cop_severity)
+      return cop_severity if cop_severity.in? %w[warning error]
+      return 'note' if cop_severity.in? %w[refactor convention]
+      return 'error' if cop_severity.in? %w[fatal]
+
+      'none'
+    end
+
+    def file_finished(file, offenses)
+      relative_path = Pathname.new(file).relative_path_from(Pathname.new(ROOT)).to_s
+
+      offenses.each do |o|
+        rule = set_rule(o.cop_name, o.severity.name.to_s)
+
+        @results << {
+          "ruleId" => rule.name,
+          'ruleIndex' => rule.index,
+          'message' => {
+            'text' => o.message
+          },
+          'locations' => [
+            {
+              'physicalLocation' => {
+                'artifactLocation' => {
+                  'uri' => relative_path,
+                  'uriBaseId' => '%SRCROOT%',
+                  'index' => 0
+                },
+                'region' => {
+                  'startLine' => o.first_line,
+                  'startColumn' => o.column,
+                  'endColumn' => o.last_column
+                }
+              }
+            }
+          ],
+          'partialFingerprints' => {
+            #        "primaryLocationLineHash" : "39fa2ee980eb94b0:1",
+            #        "primaryLocationStartColumnFingerprint" : "4"
+          }
+        }
+
+        #      #       "%<path>s:%<line>d:%<column>d: %<severity>s: %<message>s\n",
+        #      #       path: file,
+        #      #       line: o.line,
+        #      #       column: o.real_column,
+        #      #       severity: o.severity.code,
+        #      #       message: message(o)
+        #      #     )
+      end
+    end
+
+    def finished(_inspected_files)
+      json = JSON.pretty_generate(@sarif)
+      output.print(json)
+    end
+  end
+end

data/lib/code_scanning/rubocop/version.rb

@@ -0,0 +1,5 @@
+module CodeScanning
+  module Rubocop
+    VERSION = "0.1.0"
+  end
+end

data/rubocop-scan/action.yml

@@ -0,0 +1,5 @@
+name: 'Rubocop code-scanning'
+description: 'Rubocop and code-scanning integration'
+runs:
+  using: 'docker'
+  image: '../Dockerfile'

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: code-scanning-rubocop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arthur Neves
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: This gem adds a SARIF formatter to rubocop, so we can export alerts to
+  code-scanning inside GitHub.
+email:
+- arthurnn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- code-scanning-rubocop.gemspec
+- entrypoint.sh
+- lib/code_scanning.rb
+- lib/code_scanning/rubocop/sarif_formatter.rb
+- lib/code_scanning/rubocop/version.rb
+- rubocop-scan/action.yml
+homepage: https://github.com/arthurnn/code-scanning-rubocop
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/arthurnn/code-scanning-rubocop
+  source_code_uri: https://github.com/arthurnn/code-scanning-rubocop
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Extra formater to make rubocop compatible with GitHub's code-scanning feature.
+test_files: []