add-run-rubocop

.github/workflows/main_flow.yml

@@ -38,4 +38,35 @@ jobs:
         run: bin/rails db:schema:load
       # Add or replace test runners here
       - name: Run tests
-        run: bin/rake test
+        run: bin/rake
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          args:
+            -Dsonar.projectKey=lytrungtin_url_shortener
+            -Dsonar.organization=lytrungtin
+            -Dsonar.exclusions=/vendor/**
+            -Dsonar.java.file.suffixes=-
+            -Dsonar.c.file.suffixes=-
+            -Dsonar.cpp.file.suffixes=-
+            -Dsonar.objc.file.suffixes=-
+            -Dsonar.ruby.coverage.reportPaths=/home/runner/work/url_shortener/url_shortener/coverage/.resultset.json
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Install Ruby and gems
+        uses: ruby/setup-ruby@ee2113536afb7f793eed4ce60e8d3b26db912da4 # v1.127.0
+        with:
+          bundler-cache: true
+      # Add or replace any other lints here
+      - name: Security audit dependencies
+        run: bundle exec bundler-audit update
+      - name: Security audit application code
+        run: bundle exe brakeman -q -w2
+      - name: Lint Ruby files
+        run: bundle exec rubocop -A --parallel --require rubocop-rails

Gemfile

@@ -40,13 +40,12 @@ gem 'rack-cors'
 
 group :development, :test do
   # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
-  gem 'debug', platforms: %i[mri mingw x64_mingw]
-  gem 'dotenv-rails'
-  gem 'simplecov', require: false, group: :test
-end
-
-group :development do
   gem 'brakeman'
   gem 'bundle-audit'
+  gem 'debug', platforms: %i[mri mingw x64_mingw]
+  gem 'dotenv-rails'
   gem 'rubocop'
+  gem 'rubocop-rails'
+  gem 'rubocop-rake'
+  gem 'simplecov', group: :test
 end

Gemfile.lock

@@ -179,6 +179,12 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
+    rubocop-rails (2.17.4)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -211,6 +217,8 @@ DEPENDENCIES
   rack-cors
   rails (~> 7.0.4)
   rubocop
+  rubocop-rails
+  rubocop-rake
   simplecov
   tzinfo-data
 

app/controllers/api/v1/url_controller.rb

@@ -2,6 +2,7 @@
 
 module Api
   module V1
+    # /api/v1/url
     class UrlController < ApplicationController
       before_action :decode_params, only: [:decode]
       before_action :encode_params, only: [:encode]

app/controllers/redirection_controller.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-class RedirectionController < ActionController::Base
+# Handles redirections for All urls already shortened with :slug param
+class RedirectionController < ApplicationController
   before_action :validate_slug
   def redirect
     result = Rails.cache.fetch("decode_shortened_url:#{request.original_url}") do
@@ -14,7 +15,7 @@ def redirect
   private
 
   def not_found
-    render file: "#{Rails.root}/public/404.html", layout: false, status: :not_found
+    render file: Rails.root.join('/public/404.html'), layout: false, status: :not_found
   end
 
   def validate_slug

app/mailers/application_mailer.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# app/mailers/application_mailer.rb
 class ApplicationMailer < ActionMailer::Base
   default from: 'from@example.com'
   layout 'mailer'

app/models/application_record.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# app/models/application_record.rb
 class ApplicationRecord < ActiveRecord::Base
   primary_abstract_class
 end

app/models/url.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+# Storing and validating URLs input before generate shorten slug
 class Url < ApplicationRecord
-  validates_presence_of :original_url, :slug
+  validates :original_url, :slug, presence: true
   validates :original_url, url: true
-  validates_uniqueness_of :slug
-  validates_length_of :original_url, within: 10..2048
-  validates_length_of :slug, within: 4..4
+  validates :slug, uniqueness: true
+  validates :original_url, length: { within: 10..2048 }
+  validates :slug, length: { within: 4..4 }
 
   before_validation :generate_slug
   before_save do
@@ -18,7 +19,7 @@ class Url < ApplicationRecord
   end
 
   def generate_slug
-    return if !slug.nil? && !slug.empty?
+    return if !slug.nil? && !slug.strip.nil?
 
     slug = SecureRandom.alphanumeric(4)
     return generate_slug if Url.exists?(slug:)
@@ -43,7 +44,7 @@ def self.decode(shortened_url)
       return ['Shorten URL is not valid']
     end
 
-    url = Url.find_by_slug(shortened_uri.path.split('/').last)
+    url = Url.find_by(slug: shortened_uri.path.split('/').last)
     return url.original_url if url
 
     ['Shorten URL is not existed']

app/validators/url_validator.rb

@@ -2,6 +2,7 @@
 
 require 'net/http'
 
+# URL validator for urls from Model should valid, be able to redirect or response success
 class UrlValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
     return if value.blank?

config/application.rb

@@ -12,6 +12,7 @@
 Dotenv::Railtie.load if %w[development test].include? ENV['RAILS_ENV']
 
 module Shortening
+  # config/application.rb
   class Application < Rails::Application
     # Initialize configuration defaults for originally generated Rails version.
     config.load_defaults 7.0

db/migrate/20221224115757_create_urls.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# db/migrate/20221224115757_create_urls.rb
 class CreateUrls < ActiveRecord::Migration[7.0]
   def change
     create_table :urls do |t|

db/migrate/20221227171400_remove_index_to_urls.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# db/migrate/20221227171400_remove_index_to_urls.rb
 class RemoveIndexToUrls < ActiveRecord::Migration[7.0]
   def change
     remove_index :urls, :original_url, unique: true

test/controllers/redirection_controller_test.rb

@@ -14,6 +14,11 @@ class RedirectionControllerTest < ActionDispatch::IntegrationTest
     assert_response :not_found
   end
 
+  test 'access with invalid slug format should render to not found' do
+    get shortened_url(slug: 'te@@st')
+    assert_response :not_found
+  end
+
   test 'access with not existed slug should render to not found' do
     get shortened_url(slug: '1a2b3c')
     assert_response :not_found

test/test_helper.rb

@@ -2,9 +2,16 @@
 
 ENV['RAILS_ENV'] ||= 'test'
 require 'simplecov'
-require "simplecov_json_formatter"
-SimpleCov.formatter = SimpleCov::Formatter::JSONFormatter
-SimpleCov.start
+require 'simplecov_json_formatter'
+
+# Generate HTML and JSON reports
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new([
+                                                                  SimpleCov::Formatter::HTMLFormatter,
+                                                                  SimpleCov::Formatter::JSONFormatter
+                                                                ])
+SimpleCov.start do
+  enable_coverage :branch
+end
 require_relative '../config/environment'
 require 'rails/test_help'