Rubocop rails omakase (#602)

* add rubocop-rails-omakase

* rubocop autocorrect

* add ci

Author: jmilljr24

.github/workflows/rubocop.yml

@@ -0,0 +1,39 @@
+# .github/workflows/rubocop.yml
+# https://lovro-bikic.github.io/github-actions-rubocop-workflow/
+#
+name: RuboCop
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    env:
+      RUBOCOP_CACHE_ROOT: tmp/rubocop
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Prepare RuboCop cache
+        uses: actions/cache@v4
+        env:
+          DEPENDENCIES_HASH: ${{ hashFiles('.ruby-version', '**/.rubocop.yml', '**/.rubocop_todo.yml', 'Gemfile.lock') }}
+        with:
+          path: ${{ env.RUBOCOP_CACHE_ROOT }}
+          key: rubocop-cache-${{ runner.os }}-${{ env.DEPENDENCIES_HASH }}-${{ github.ref_name == github.event.repository.default_branch && github.run_id || 'default' }}
+          restore-keys: |
+            rubocop-cache-${{ runner.os }}-${{ env.DEPENDENCIES_HASH }}-
+      - name: Run RuboCop
+        run: bundle exec rubocop --format github --format clang

.rubocop.yml

@@ -1,26 +1,5 @@
-Encoding:
-  Enabled: false
+# Omakase Ruby styling for Rails
+inherit_gem:
+  rubocop-rails-omakase: rubocop.yml
 
-Documentation:
-  Enabled: false
-
-ClassAndModuleChildren:
-  Enabled: false
-
-ClassLength:
-  Enabled: false
-
-MethodLength:
-  Enabled: false
-
-AbcSize:
-  Max: 30
-
-DoubleNegation:
-  Enabled: false
-
-AllCops:
-  Exclude:
-    - "bin/**/*"
-    - "db/**/*"
-    - "config/**/*"
+# Your own specialized rules go here

Gemfile

@@ -47,6 +47,10 @@ gem "stimulus-rails", "~> 1.3"
 
 gem "active_storage_validations", "~> 3.0"
 
+group :development do
+  gem "rubocop-rails-omakase", require: false
+end
+
 group :development, :test do
   gem "better_errors"
   gem "brakeman", "~> 7.1.2", require: false

Gemfile.lock

@@ -90,6 +90,7 @@ GEM
     apipie-rails (1.5.0)
       actionpack (>= 5.0)
       activesupport (>= 5.0)
+    ast (2.4.3)
     aws-eventstream (1.4.0)
     aws-partitions (1.1198.0)
     aws-sdk-core (3.240.0)
@@ -223,6 +224,8 @@ GEM
       marcel (~> 1.0.1)
       mime-types
       terrapin (~> 0.6.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
@@ -266,6 +269,10 @@ GEM
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     orm_adapter (0.5.0)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
     polyglot (0.3.5)
     positioning (0.4.7)
       activerecord (>= 6.1)
@@ -281,6 +288,7 @@ GEM
       net-smtp
       premailer (~> 1.7, >= 1.7.9)
     prettyprint (0.2.0)
+    prism (1.7.0)
     pry (0.15.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -335,6 +343,7 @@ GEM
       thor (~> 1.0, >= 1.2.2)
       tsort (>= 0.2)
       zeitwerk (~> 2.6)
+    rainbow (3.1.1)
     rake (13.3.0)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
@@ -370,6 +379,35 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.5)
+    rubocop (1.82.1)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rails (2.34.2)
+      activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
+      rack (>= 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+    rubocop-rails-omakase (1.1.0)
+      rubocop (>= 1.72)
+      rubocop-performance (>= 1.24)
+      rubocop-rails (>= 2.30)
+    ruby-progressbar (1.13.0)
     ruby-vips (2.2.5)
       ffi (~> 1.12)
       logger
@@ -422,6 +460,9 @@ GEM
     uglifier (4.2.1)
       execjs (>= 0.3.0, < 3)
     unaccent (0.4.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
     uri (1.0.4)
     useragent (0.16.11)
     vite_rails (3.0.19)
@@ -486,6 +527,7 @@ DEPENDENCIES
   rack-cors
   rails (~> 8.1.0)
   rspec-rails
+  rubocop-rails-omakase
   search_cop (~> 1.0.6)
   selenium-webdriver
   shoulda-matchers

Rakefile

@@ -6,4 +6,4 @@ Rails.application.load_tasks
 desc "Build local docker image"
 task "build:docker" do |t, args|
     sh "docker build --no-cache -t awbw-portal ."
-end
+end

app/controllers/admin/analytics_controller.rb

@@ -1,59 +1,58 @@
 module Admin
-	class AnalyticsController < Admin::BaseController
-		protect_from_forgery with: :null_session
-
-		def index
-			@most_viewed_workshops    = Workshop.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
-			@most_viewed_workshop_variations = WorkshopVariation.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
-			@most_viewed_resources    = Resource.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
-			@most_viewed_community_news = CommunityNews.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
-			@most_viewed_stories      = Story.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
-			@most_viewed_quotes       = Quote.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
-			@most_viewed_tutorials    = Tutorial.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
-			@most_viewed_projects     = Project.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
-			@most_viewed_events       = Event.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
-			@most_viewed_facilitators = Facilitator.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
-
-			@most_printed_workshops = Workshop.published.order(print_count: :desc, created_at: :desc).limit(10).decorate
-			@most_downloaded_resources = Resource.published.order(download_count: :desc, created_at: :desc).limit(10).decorate
-
-			@zero_engagement_workshops = Workshop.published.where(view_count: 0).order(created_at: :desc).limit(10).decorate
-			@zero_engagement_resources = Resource.published.where(view_count: 0).order(created_at: :desc).limit(10).decorate
-
-			@summary = {
-				workshops: Workshop.sum(:view_count),
-				workshop_prints: Workshop.sum(:print_count),
-				resources: Resource.sum(:view_count),
-				resource_downloads: Resource.sum(:download_count),
-				community_news: CommunityNews.sum(:view_count),
-				stories: Story.sum(:view_count),
-				events: Event.sum(:view_count),
-				workshop_variations: WorkshopVariation.sum(:view_count),
-				quotes: Quote.sum(:view_count),
-				tutorials: Tutorial.sum(:view_count),
-				projects: Project.sum(:view_count),
-				facilitators: Facilitator.sum(:view_count)
-			}
-		end
-
-		def print
-			printable_models = {
-				"Resource" => Resource,
-				"Story" => Story,
-				"Workshop" => Workshop,
-				"CommunityNews" => CommunityNews
-			}.freeze
-
-			klass = printable_models[params[:printable_type]]
-			return head :bad_request unless klass
-
-			record = klass.find_by(id: params[:printable_id])
-			return head :not_found unless record
-
-			record.increment_print_count!
-
-			head :ok
-		end
-	end
-
+  class AnalyticsController < Admin::BaseController
+    protect_from_forgery with: :null_session
+
+    def index
+      @most_viewed_workshops    = Workshop.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
+      @most_viewed_workshop_variations = WorkshopVariation.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
+      @most_viewed_resources    = Resource.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
+      @most_viewed_community_news = CommunityNews.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
+      @most_viewed_stories      = Story.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
+      @most_viewed_quotes       = Quote.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
+      @most_viewed_tutorials    = Tutorial.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
+      @most_viewed_projects     = Project.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
+      @most_viewed_events       = Event.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
+      @most_viewed_facilitators = Facilitator.published.order(view_count: :desc, created_at: :desc).limit(10).decorate
+
+      @most_printed_workshops = Workshop.published.order(print_count: :desc, created_at: :desc).limit(10).decorate
+      @most_downloaded_resources = Resource.published.order(download_count: :desc, created_at: :desc).limit(10).decorate
+
+      @zero_engagement_workshops = Workshop.published.where(view_count: 0).order(created_at: :desc).limit(10).decorate
+      @zero_engagement_resources = Resource.published.where(view_count: 0).order(created_at: :desc).limit(10).decorate
+
+      @summary = {
+        workshops: Workshop.sum(:view_count),
+        workshop_prints: Workshop.sum(:print_count),
+        resources: Resource.sum(:view_count),
+        resource_downloads: Resource.sum(:download_count),
+        community_news: CommunityNews.sum(:view_count),
+        stories: Story.sum(:view_count),
+        events: Event.sum(:view_count),
+        workshop_variations: WorkshopVariation.sum(:view_count),
+        quotes: Quote.sum(:view_count),
+        tutorials: Tutorial.sum(:view_count),
+        projects: Project.sum(:view_count),
+        facilitators: Facilitator.sum(:view_count)
+      }
+    end
+
+    def print
+      printable_models = {
+        "Resource" => Resource,
+        "Story" => Story,
+        "Workshop" => Workshop,
+        "CommunityNews" => CommunityNews
+      }.freeze
+
+      klass = printable_models[params[:printable_type]]
+      return head :bad_request unless klass
+
+      record = klass.find_by(id: params[:printable_id])
+      return head :not_found unless record
+
+      record.increment_print_count!
+
+      head :ok
+    end
+  end
 end

app/controllers/admin/base_controller.rb

@@ -1,11 +1,11 @@
 module Admin
-	class BaseController < ApplicationController
-		before_action :require_super_user
+  class BaseController < ApplicationController
+    before_action :require_super_user
 
-		private
+    private
 
-		def require_super_user
-			redirect_to authenticated_root_path, alert: "Not authorized" unless current_user&.super_user?
-		end
-	end
+    def require_super_user
+      redirect_to authenticated_root_path, alert: "Not authorized" unless current_user&.super_user?
+    end
+  end
 end

app/controllers/api/v1/api_controller.rb

@@ -1,6 +1,6 @@
 class Api::V1::ApiController < ActionController::API
   include ActionController::RequestForgeryProtection
-  protect_from_forgery with: :null_session, :if => Proc.new { |c| c.request.format.json? }
+  protect_from_forgery with: :null_session, if: Proc.new { |c| c.request.format.json? }
 
   rescue_from AuthenticationFailed, with: :authentication_failed
   before_action :authenticate_api_user!
@@ -18,17 +18,17 @@ def current_api_user
   end
 
   def authentication_failed(exception)
-    render json: {error: exception.message}, status: :unauthorized
+    render json: { error: exception.message }, status: :unauthorized
   end
 
   private
 
   def http_auth_header_content
-    if request.headers['Authorization'].present?
+    if request.headers["Authorization"].present?
       @http_auth_header_content ||=
-        request.headers['Authorization'].split(' ').last
+        request.headers["Authorization"].split(" ").last
     else
-      @http_auth_header_content ||= params['Authorization']
+      @http_auth_header_content ||= params["Authorization"]
     end
   end
 end

app/controllers/api/v1/authentications_controller.rb

@@ -1,9 +1,9 @@
 class Api::V1::AuthenticationsController < Api::V1::ApiController
   skip_before_action :authenticate_api_user!
-  api :POST, '/v1/authentications'
-  param :email, String, 'User\'s email', required: true
-  param :password, String, 'User\'s password', required: true
-  desc 'With valid credentials, return\'s an API Authorization token'
+  api :POST, "/v1/authentications"
+  param :email, String, "User's email", required: true
+  param :password, String, "User's password", required: true
+  desc "With valid credentials, return's an API Authorization token"
   def create
     user = User.find_by_email(params[:email])
     if user.present? && user.valid_password?(params[:password])
@@ -12,7 +12,7 @@ def create
       token = AuthenticationToken.generate_token(user.id).to_s
       render json: { token: token, user: user, url: "#{request.base_url}/?Authorization=#{token}" }, status: :created
     else
-      render json: { error: 'Not Authorized', status: :unauthorized }
+      render json: { error: "Not Authorized", status: :unauthorized }
     end
   end
 end

app/controllers/api/v1/quotes_controller.rb

@@ -1,13 +1,13 @@
 class Api::V1::QuotesController < Api::V1::ApiController
-  api :GET, '/v1/quotes'
-  param :Authorization, String, desc: 'API Authorization token returned by successful'\
-                                      ' user authentication', required: true
+  api :GET, "/v1/quotes"
+  param :Authorization, String, desc: "API Authorization token returned by successful"\
+                                      " user authentication", required: true
   param :sector, String, desc: "One of #{Sector.all.pluck(:name).join(', ')}"
-  desc 'Without a Sector parameter, gives a list of all quotes grouped by Sector.'
+  desc "Without a Sector parameter, gives a list of all quotes grouped by Sector."
   def index
     sector = Sector.find_by(name: params[:sector]) || Sector.all
-    quotes = sector.to_json(only: :name, :include => {
-      :quotes => { only: :quote }
+    quotes = sector.to_json(only: :name, include: {
+      quotes: { only: :quote }
     })
     render json: { quotes: quotes }, status: :ok
   end