service_record 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7480968cffcfeaa22303ad0e8e0eefbe9eb5c748a562eb24651e1a0563fdaec
-  data.tar.gz: cd4d145d8bf049e67586a5bc64d1b9c70939815a42996407ffd26744de2e2328
+  metadata.gz: 3af5f714dc3195cb0877476b9d1a7c048549cd9c19ba40ab59a30d67a3d92ff0
+  data.tar.gz: fc6cf02ec07809395a782754a3416bafcaf26e59c3a8af911233a69958585cf2
 SHA512:
-  metadata.gz: e1cf4a2872060a83ac89f578721a9169db038bc4502f31a0382162ac3ea5402aa76effc3cd7f5e66c05b66a160f3148dd094fd3f9ea476d0d0902eea81a01b6e
-  data.tar.gz: 6ea144985aa85012173f7275782e118473f22c5cc2a9a5c85c7ef8d49409f4c68b7a97de4e8fd479a9ae90e58a7e635eb594f191bafec97e29d76e7b7b2cd565
+  metadata.gz: ad3d7ab806691128d9790ea1f4d5e40f47b99435d0b68421b24d7c049af01783d942b2b39a9bf8357116e16d0d1bf728ce69ef73013b32dcc9630e1fe2d7ae54
+  data.tar.gz: 46d7eecfa6bdfcb4b323ea6f5858c19e56689c160b1ef0265c49ff9633eaf3789a27b7bce1de7b8809127502109e66b95c961ae946f4f4cfc23f132c392d229b

data/README.md

@@ -64,7 +64,9 @@ The returned response from a service will have the following useful attributes/m
 * `success?` contains true if service was performed without any errors, false otherwise
 * `failure?` contains opposite of success?
 * `result` contains returned value of service perform function
-* `errors` contains details about issues that occurr while performing the service 
+* `errors` contains details about issues that occurr while performing the service
+
+There is a **perform!** (with a bang !) method which will raise **ServiceRecord::Failure** in case of service failure.
 
 
 

data/lib/rails/generators/service/service_generator.rb

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+
 require 'rails/generators/named_base'
 
 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'
 

data/lib/service_record/base.rb

@@ -1,13 +1,25 @@
+# frozen_string_literal: true
+
+require 'active_model'
 require 'service_record/failure'
 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
     include ActiveModel::Validations
     include ActiveModel::AttributeAssignment
 
+    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
@@ -15,27 +27,29 @@ module ServiceRecord
 
         service.run_callbacks :perform do
           service.result = service.perform
-          service.result = nil if service.failure?
         end
       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 if service.failure?
+      raise Failure, service
     end
 
-    attr_accessor :result
-
+    # 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

data/lib/service_record/callbacks.rb

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

data/lib/service_record/failure.rb

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

data/lib/service_record/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ServiceRecord
-  VERSION = '1.2.2'.freeze
+  VERSION = '1.3.0'
 end

data/lib/service_record.rb

@@ -1,2 +1,3 @@
-require 'active_model'
+# frozen_string_literal: true
+
 require 'service_record/base'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_record
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
 - Muhammad Usman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -24,6 +24,156 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.8.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.44.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.44.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
 description: ActiveRecord lookalike but for business model requirements
 email:
 - uxman.sherwani@gmail.com
@@ -49,8 +199,9 @@ licenses:
 metadata:
   homepage_uri: https://github.com/uxxman/service_record
   source_code_uri: https://github.com/uxxman/service_record
+  rubygems_mfa_required: 'true'
   changelog_uri: https://github.com/uxxman/service_record/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Service objects for rails
 test_files: []