Merge pull request #10 from blocknotes/github_actions_improvements

Add linters workflow

Author: blocknotes

.fasterer.yml

@@ -0,0 +1,6 @@
+---
+exclude_paths:
+  - bin/*
+  - db/schema.rb
+  - spec/dummy/**/*
+  - vendor/**/*

.github/workflows/linters.yml

@@ -0,0 +1,35 @@
+---
+name: Linters
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  reviewdog:
+    name: reviewdog
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - uses: reviewdog/action-setup@v1
+        with:
+          reviewdog_version: latest
+
+      - name: Run reviewdog
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          reviewdog -fail-on-error -reporter=github-pr-review -runners=brakeman,fasterer,reek,rubocop
+
+        # NOTE: check with: reviewdog -fail-on-error -reporter=github-pr-review -runners=fasterer -diff="git diff" -tee

.github/workflows/specs.yml

@@ -1,3 +1,4 @@
+---
 name: Specs
 
 on:

.reek.yml

@@ -0,0 +1,6 @@
+---
+exclude_paths:
+  - bin/*
+  - db/schema.rb
+  - spec/dummy/**/*
+  - vendor/**/*

.reviewdog.yml

@@ -0,0 +1,14 @@
+---
+runner:
+  brakeman:
+    cmd: bin/brakeman
+    level: info
+  fasterer:
+    cmd: bin/fasterer
+    level: info
+  reek:
+    cmd: bin/reek
+    level: info
+  rubocop:
+    cmd: bin/rubocop
+    level: info

.rubocop.yml

@@ -1,10 +1,13 @@
+---
 inherit_from:
   - https://relaxed.ruby.style/rubocop.yml
 
 AllCops:
   Exclude:
     - bin/*
+    - db/schema.rb
     - spec/dummy/**/*
+    - vendor/**/*
   NewCops: enable
 
 Gemspec/RequiredRubyVersion:

Gemfile

@@ -8,12 +8,22 @@ group :development, :test do
   gem 'activestorage', '~> 6.0'
   gem 'capybara', '~> 3.33'
   gem 'puma', '~> 4.3'
-  gem 'rspec-rails', '~> 4.0'
   gem 'rspec_junit_formatter', '~> 0.4'
-  gem 'rubocop', '~> 1.0'
+  gem 'rspec-rails', '~> 4.0'
   gem 'selenium-webdriver', '~> 3.142'
   gem 'sprockets-rails', '~> 3.2'
   gem 'sqlite3', '~> 1.4'
 
+  # Linters
+  gem 'brakeman'
+  gem 'fasterer'
+  gem 'reek'
+  gem 'rubocop'
+  gem 'rubocop-packaging'
+  gem 'rubocop-performance'
+  gem 'rubocop-rails'
+  gem 'rubocop-rspec'
+
+  # Tools
   gem 'pry-rails'
 end

bin/brakeman

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'brakeman' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("brakeman", "brakeman")

bin/code_climate_reek

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'code_climate_reek' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("reek", "code_climate_reek")

bin/fasterer

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'fasterer' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("fasterer", "fasterer")