chore: change rubocop style

Author: Alexandro castro

backend/.rubocop.yml

@@ -1,5 +1,6 @@
 # Omakase Ruby styling for Rails
-inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+inherit_gem:
+  rubocop-shopify: rubocop.yml
 
 plugins:
   - rubocop-erb
@@ -8,6 +9,8 @@ AllCops:
   Exclude:
     - 'db/schema.rb'
     - 'db/migrate/**/*'
+    - 'Gemfile.lock'
+    - 'bin/*'
 
 Layout/IndentationStyle:
   EnforcedStyle: spaces
@@ -16,4 +19,13 @@ Layout/IndentationStyle:
 
 Layout/IndentationWidth:
   Width: 2
-  Enabled: true
+  Enabled: true
+
+Style/ClassMethodsDefinitions:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

backend/Gemfile

@@ -22,7 +22,7 @@ gem "stimulus-rails"
 # Build JSON APIs with ease [https://github.com/rails/jbuilder]
 gem "jbuilder"
 # Static analysis for security vulnerabilities [https://brakemanscanner.org/]
-gem "brakeman", require: false, group: [ :development, :test ]
+gem "brakeman", require: false, group: [:development, :test]
 # Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
 gem "image_processing", "~> 1.2"
 # Deploy this application anywhere as a Docker container [https://kamal-deploy.org]
@@ -50,16 +50,16 @@ gem "pg", "~> 1.5"
 # Code Quality
 # =================
 # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/]
-gem "rubocop-rails-omakase", require: false, group: [ :development, :test ]
-gem "rubocop-erb", require: false, group: [ :development, :test ]
-gem "rubocop-performance", require: false, group: [ :development, :test ]
+gem "rubocop-rails-omakase", require: false, group: [:development, :test]
+gem "rubocop-erb", require: false, group: [:development, :test]
+gem "rubocop-performance", require: false, group: [:development, :test]
 
 # =================
 # Tools
 # =================
 gem "metainspector"
-gem "annotaterb", group: [ :development, :test ]
-gem "web-console", group: [ :development, :test ]
+gem "annotaterb", group: [:development, :test]
+gem "web-console", group: [:development, :test]
 gem "httparty"
 # Validation helpers
 gem "dry-validation"
@@ -86,4 +86,4 @@ gem "redis-objects"
 # =================
 gem "sentry-ruby"
 gem "sentry-rails"
-gem "stackprof"
+gem "stackprof"

backend/app/controllers/api/me/shortlinks_controller.rb

@@ -1,26 +1,29 @@
 class Api::Me::ShortlinksController < ApplicationController
-  before_action :load_link, only: [ :destroy, :show ]
+  before_action :load_link, only: [:destroy, :show]
 
   # GET /api/me/shortlinks/:id
   def show
-    render json: ShortlinkSerializer.new(@link).serialize, status: :ok
+    render(json: ShortlinkSerializer.new(@link).serialize, status: :ok)
   end
 
   # GET /api/me/shortlinks
   def index
-    render json: ShortlinkSerializer.new(@current_user.shortlinks).serialize(meta: {
-      total: @current_user.shortlinks.count
-    }), status: :ok
+    render(
+      json: ShortlinkSerializer.new(@current_user.shortlinks).serialize(meta: {
+        total: @current_user.shortlinks.count,
+      }),
+      status: :ok,
+    )
   end
 
   # POST /api/me/shortlinks
   def create
     validate_contract(ShortlinkContract) do |validated_params|
       link = @current_user.shortlinks.new(validated_params)
       if link.save
-        render json: ShortlinkSerializer.new(link).serialize, status: :created
+        render(json: ShortlinkSerializer.new(link).serialize, status: :created)
       else
-        render json: { errors: link.errors.full_messages }, status: :unprocessable_entity
+        render(json: { errors: link.errors.full_messages }, status: :unprocessable_entity)
       end
     end
   end
@@ -30,15 +33,15 @@ def destroy
     link = @current_user.shortlinks.find_by(id: params[:id])
     if link
       link.destroy
-      head :no_content
+      head(:no_content)
     else
-      render json: { error: "Link not found" }, status: :not_found
+      render(json: { error: "Link not found" }, status: :not_found)
     end
   end
 
   private
 
-    def load_link
-      @link = @current_user.shortlinks.find(params[:id])
-    end
+  def load_link
+    @link = @current_user.shortlinks.find(params[:id])
+  end
 end

backend/app/controllers/api/me/users_controller.rb

@@ -1,5 +1,5 @@
 class Api::Me::UsersController < ApplicationController
   def show
-    render json: UserSerializer.new(current_user).serialize, status: :ok
+    render(json: UserSerializer.new(current_user).serialize, status: :ok)
   end
 end

backend/app/controllers/api/sessions_controller.rb

@@ -1,15 +1,15 @@
 class Api::SessionsController < ApplicationController
-  skip_before_action :authenticate_user!, only: [ :create, :verify ]
+  skip_before_action :authenticate_user!, only: [:create, :verify]
 
   # POST /api/login_request
   def create
     if params[:email].present?
       user = User.find_or_create_by(email: params[:email])
       user.send_magic_link
 
-      render json: { message: "If the email exists, the link has been sent." }
+      render(json: { message: "If the email exists, the link has been sent." })
     else
-      render json: { error: "Email is required" }, status: :unprocessable_entity
+      render(json: { error: "Email is required" }, status: :unprocessable_entity)
     end
   end
 
@@ -21,17 +21,16 @@ def verify
       token = generate_jwt(user)
       user.clear_login_token!
 
-
-      render json: UserSerializer.new(user).serialize(meta: { token: token }), status: :ok
+      render(json: UserSerializer.new(user).serialize(meta: { token: token }), status: :ok)
     else
-      render json: { error: "Token invalid or expired" }, status: :unauthorized
+      render(json: { error: "Token invalid or expired" }, status: :unauthorized)
     end
   end
 
   private
 
-    def generate_jwt(user)
-      payload = { sub: user.id, exp: 1.hour.from_now.to_i }
-      JWT.encode(payload, Rails.application.secret_key_base, "HS256")
-    end
+  def generate_jwt(user)
+    payload = { sub: user.id, exp: 1.hour.from_now.to_i }
+    JWT.encode(payload, Rails.application.secret_key_base, "HS256")
+  end
 end

backend/app/controllers/application_controller.rb

@@ -11,36 +11,35 @@ def validate_contract(contract_class, context: nil)
     # Contract validation
     contract = contract_class.new.call(params.to_unsafe_h, context: context)
     if contract.errors.any?
-      render json: { errors: contract.errors.to_h }, status: :unprocessable_entity
-    else
-      yield contract.to_h, params if block_given?
+      render(json: { errors: contract.errors.to_h }, status: :unprocessable_entity)
+    elsif block_given?
+      yield contract.to_h, params
     end
   end
 
   private
 
-    def record_not_found(exception)
-      render json: { message: "Resource not found" }, status: :not_found
-    end
+  def record_not_found(exception)
+    render(json: { message: "Resource not found" }, status: :not_found)
+  end
 
   def record_not_destroyed(exception)
-    render json: { message: "Resource could not be destroyed", details: exception.record.errors.full_messages }, status: :unprocessable_entity
+    render(json: { message: "Resource could not be destroyed", details: exception.record.errors.full_messages }, status: :unprocessable_entity)
   end
 
   def record_invalid(exception)
-    render json: { message: "Resource is invalid", details: exception.record.errors.full_messages }, status: :unprocessable_entity
+    render(json: { message: "Resource is invalid", details: exception.record.errors.full_messages }, status: :unprocessable_entity)
   end
 
-
   def authenticate_user!
     auth_header = request.headers["Authorization"]
-    return render json: { message: "Missing token" }, status: :unauthorized unless auth_header
+    return render(json: { message: "Missing token" }, status: :unauthorized) unless auth_header
 
     token = auth_header.split(" ").last
     decoded = JWT.decode(token, Rails.application.secret_key_base, true, algorithm: "HS256")
     user_id = decoded.first["sub"]
     @current_user = User.find(user_id)
   rescue JWT::ExpiredSignature, JWT::DecodeError
-    render json: { message: "Invalid or expired token" }, status: :unauthorized
+    render(json: { message: "Invalid or expired token" }, status: :unauthorized)
   end
 end

backend/app/jobs/concerns/retryable_job.rb

@@ -9,16 +9,16 @@ module RetryableJob
 
   private
 
-    def handle_retry(exception)
-      retry_count = (arguments.last[:retry_count] || 0) + 1
-      max_retries = 5
-      wait_seconds = 2**retry_count
+  def handle_retry(exception)
+    retry_count = (arguments.last[:retry_count] || 0) + 1
+    max_retries = 5
+    wait_seconds = 2**retry_count
 
-      if retry_count <= max_retries
-        Rails.logger.warn("Retrying #{self.class.name} (#{retry_count}/#{max_retries}) after #{wait_seconds}s due to #{exception.class}: #{exception.message}")
-        self.class.set(wait: wait_seconds.seconds).perform_later(*arguments.first(1), retry_count: retry_count)
-      else
-        Rails.logger.error("#{self.class.name} failed permanently after #{max_retries} attempts")
-      end
+    if retry_count <= max_retries
+      Rails.logger.warn("Retrying #{self.class.name} (#{retry_count}/#{max_retries}) after #{wait_seconds}s due to #{exception.class}: #{exception.message}")
+      self.class.set(wait: wait_seconds.seconds).perform_later(*arguments.first(1), retry_count: retry_count)
+    else
+      Rails.logger.error("#{self.class.name} failed permanently after #{max_retries} attempts")
     end
+  end
 end

backend/app/jobs/ipaddr_job.rb

@@ -1,7 +1,7 @@
 class IpaddrJob < ApplicationJob
   include RetryableJob
   queue_as :default
-  
+
   def perform(event_id, retry_count: 3)
     event = Event.find_by(id: event_id)
     return if event.nil?
@@ -16,8 +16,7 @@ def perform(event_id, retry_count: 3)
       event.country_code = nil
       event.region = nil
     end
-    
+
     event.save!
   end
-
 end

backend/app/models/event.rb

@@ -44,15 +44,15 @@ class Event < ApplicationRecord
 
   private
 
-    def set_clicked_at
-      self.clicked_at ||= Time.current
-    end
+  def set_clicked_at
+    self.clicked_at ||= Time.current
+  end
 
   def update_last_visited
-    self.shortlink.update(last_accessed_at: clicked_at)
+    shortlink.update(last_accessed_at: clicked_at)
   end
 
   def ipaddr_job
-    IpaddrJob.perform_later(self.id)
+    IpaddrJob.perform_later(id)
   end
 end

backend/app/models/shortlink.rb

@@ -26,41 +26,41 @@ class Shortlink < ApplicationRecord
   # Validations
   # ===============
   validates :original_url, presence: true
-    validates :short_code, presence: true, uniqueness: true
-    validates :user_id, presence: true
+  validates :short_code, presence: true, uniqueness: true
+  validates :user_id, presence: true
 
-    # ===============
-    # Associations
-    # ===============
-    belongs_to :user
-    has_many :events, dependent: :destroy
+  # ===============
+  # Associations
+  # ===============
+  belongs_to :user
+  has_many :events, dependent: :destroy
 
-    # ===============
-    # Callbacks
-    # ===============
-    after_commit :save_cache, on: :create
-    before_validation :generate_short_code, on: :create
+  # ===============
+  # Callbacks
+  # ===============
+  after_commit :save_cache, on: :create
+  before_validation :generate_short_code, on: :create
 
-    private
+  private
 
-      def short_url
-        "#{ENV['EDGE_API']}/#{short_code}"
-      end
+  def short_url
+    "#{ENV["EDGE_API"]}/#{short_code}"
+  end
 
-    def save_cache
-      Rails.cache.redis.with do |conn|
-        conn.set(cache_key, original_url)
-      end
+  def save_cache
+    Rails.cache.redis.with do |conn|
+      conn.set(cache_key, original_url)
     end
+  end
 
-    def cache_key
-      "shortlink:#{short_code}"
-    end
+  def cache_key
+    "shortlink:#{short_code}"
+  end
 
-    def generate_short_code
-      self.short_code ||= loop do
-        code = SecureRandom.alphanumeric(6)
-          break code unless Shortlink.exists?(short_code: code)
-      end
+  def generate_short_code
+    self.short_code ||= loop do
+      code = SecureRandom.alphanumeric(6)
+      break code unless Shortlink.exists?(short_code: code)
     end
+  end
 end