Adding code comments

.rubocop.yml

@@ -13,8 +13,5 @@ AllCops:
     - gemfiles/*
     - vendor/**/*
 
-Style/Documentation:
-  Enabled: false
-
 Metrics/BlockLength:
   IgnoredMethods: ['describe']

lib/rails/generators/service/service_generator.rb

@@ -4,6 +4,11 @@
 
 module Rails
   module Generators
+    # Create AppicationService and SubService classes using Rails generators.
+    #
+    # E.g:
+    # bin/rails service my_service
+    #
     class ServiceGenerator < Rails::Generators::NamedBase
       desc 'This generator creates a service file at app/services'
 

lib/service_record/base.rb

@@ -5,6 +5,11 @@
 require 'service_record/callbacks'
 
 module ServiceRecord
+  # Base class to be extended by all service classes
+  #
+  #   class MyService < ServiceRecord
+  #   end
+  #
   class Base
     include Callbacks
     include ActiveModel::Attributes
@@ -13,6 +18,8 @@ class Base
 
     attr_accessor :result
 
+    # Wrapper around the *perform* instance method that runs all the validations
+    # and callbacks before eventually calling *perform*.
     def self.perform(args = {})
       new.tap do |service|
         service.attributes = args
@@ -24,21 +31,25 @@ def self.perform(args = {})
       end
     end
 
+    # Wapper around the *perform* class method that raises exception if service fails
     def self.perform!(args = {})
       service = perform(args)
       return service if service.success?
 
       raise Failure, service
     end
 
+    # Checks the service for errors. Returns +true+ if no errors are found, +false+ otherwise.
     def success?
       errors.empty?
     end
 
+    # Checks the service for errors. Returns +false+ if no errors are found, +true+ otherwise.
     def failure?
       !success?
     end
 
+    # Each subclass must define the *perform* method
     def perform
       raise NotImplementedError
     end

lib/service_record/callbacks.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module ServiceRecord
+  # Defines before/around/after callbacks for the 'perform' method
   module Callbacks
     extend ActiveSupport::Concern
 

lib/service_record/failure.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module ServiceRecord
+  # Exception to be raised when a service fails
   class Failure < StandardError
     attr_reader :service