service_record 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3af5f714dc3195cb0877476b9d1a7c048549cd9c19ba40ab59a30d67a3d92ff0
-  data.tar.gz: fc6cf02ec07809395a782754a3416bafcaf26e59c3a8af911233a69958585cf2
+  metadata.gz: 761226eff3ab278171ca2a9250b6fe089ceb53eeb2b1e221b680d250c3f1d2be
+  data.tar.gz: 567e4aa90fff412e1d42eba985a9e7a3f6397a53d622ec7e996503e22aa78a75
 SHA512:
-  metadata.gz: ad3d7ab806691128d9790ea1f4d5e40f47b99435d0b68421b24d7c049af01783d942b2b39a9bf8357116e16d0d1bf728ce69ef73013b32dcc9630e1fe2d7ae54
-  data.tar.gz: 46d7eecfa6bdfcb4b323ea6f5858c19e56689c160b1ef0265c49ff9633eaf3789a27b7bce1de7b8809127502109e66b95c961ae946f4f4cfc23f132c392d229b
+  metadata.gz: 24c06c7384fca171053cd271ef96107ee36753015bd4198ed1b6f87e4ea5fe68db663d4a7a9e7b50af6cd8a03d71bce575ff3e17d8ffba2045442b55e8dafb19
+  data.tar.gz: 2889e28b5f8507849beaef07ce99fd886063a4cf40c91d035ad92190788d8322d956e0315aa94a85a067471671a36d634171e84a26d56c65692fd651c0b998de

data/README.md

@@ -1,15 +1,15 @@
 # ServiceRecord
 
+[![Gem](https://img.shields.io/gem/v/service_record)](https://rubygems.org/gems/service_record)
 [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/uxxman/service_record/CI)](https://github.com/uxxman/service_record/actions?query=workflow%3ACI)
 [![Code Climate coverage](https://img.shields.io/codeclimate/coverage/uxxman/service_record)](https://codeclimate.com/github/uxxman/service_record)
 [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/uxxman/service_record)](https://codeclimate.com/github/uxxman/service_record)
-[![Gem](https://img.shields.io/gem/v/service_record)](https://rubygems.org/gems/service_record)
 
 An ActiveRecord lookalike but for business model requirements, a.k.a Service Objects.
 
 Rails is packed with amazing tools to get you started with building your new awesome project and enforces reliable and battle-tested guidelines. One of those guideline is "**thin controllers and fat models**", but sometimes (actually most of the time) its difficult to follow because most business requirements are not that simple like most CRUD operations. 
 
-Enters, ServiceRecord. Its similar to ActiveRecord models but their sole purpose is to perform a big/complex/muilt-step task without bloating the controllers or models.
+Enters, ServiceRecord, a tiny wrapper around basic goodies included in Rails. Its similar to ActiveRecord models but their sole purpose is to perform a big/complex/muilt-step task without bloating the controllers or models.
 
 ## Installation
 
@@ -66,9 +66,7 @@ The returned response from a service will have the following useful attributes/m
 * `result` contains returned value of service perform function
 * `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.
-
-
+There is also a **perform!** (with a bang !) method which will raise **ServiceRecord::Failure** in case of service failure.
 
 ## Example
 
@@ -83,12 +81,12 @@ def sign_in
   errors = []
 
   # Basic validation
-  errors << 'Email is required' if params[:email].blank?
-  errors << 'Email is invalid' if params[:email].present? && /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i.match?(params[:email])
+  errors << 'Email is required'    if params[:email].blank?
+  errors << 'Email is invalid'     if params[:email].present? && /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i.match?(params[:email])
   errors << 'Password is required' if params[:password].blank?
 
   if errors.size == 0
-    user = User.find_by(email: params[:email]).try(:authenticate, params[:password])
+    user = User.find_by(email: params[:email])&.try(:authenticate, params[:password])
 
     if user.present?
       token = JsonWebToken.encode(user_id: user.id)
@@ -119,9 +117,11 @@ class AuthenticateUser < ApplicationService
   def perform
     user = User.find_by(email: email).try(:authenticate, password)
 
-    return JsonWebToken.encode(user_id: user.id) if user.present?
-    
-    errors.add :authentication, 'invalid credentials'
+    if user.present?
+      JsonWebToken.encode(user_id: user.id)
+    else
+      errors.add :authentication, 'invalid credentials'
+    end
   end
 end
 
@@ -174,7 +174,9 @@ Availble callbacks are `before_perform`, `after_perform` and `around_perform`. I
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+ServiceRecord uses appraisals to test the code base against multiple versions of Rails ActiveModel. When first developing, you need to run `bundle install` and then `bundle exec appraisal install`, to install the different gem sets. You can then run all appraisal files (like CI does), with `appraisal rake`.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/service_record/base.rb

@@ -2,13 +2,14 @@
 
 require 'active_model'
 require 'service_record/failure'
+require 'service_record/response'
 require 'service_record/callbacks'
 
 module ServiceRecord
   # Base class to be extended by all service classes
   #
-  #   class MyService < ServiceRecord
-  #   end
+  # class MyService < ServiceRecord
+  # end
   #
   class Base
     include Callbacks
@@ -23,11 +24,14 @@ module ServiceRecord
     def self.perform(args = {})
       new.tap do |service|
         service.attributes = args
-        break service unless service.valid?
 
-        service.run_callbacks :perform do
-          service.result = service.perform
+        if service.valid?
+          service.run_callbacks :perform do
+            service.result = service.perform
+          end
         end
+
+        return Response.new(service.result, service.errors)
       end
     end
 
@@ -39,16 +43,6 @@ module ServiceRecord
       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

data/lib/service_record/response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ServiceRecord
+  # Response to be returned by a service when it finishes
+  class Response
+    attr_reader :result, :errors
+
+    def initialize(result, errors)
+      @result = result
+      @errors = errors
+    end
+
+    # Checks for errors. Returns +true+ if no errors are found, +false+ otherwise.
+    def success?
+      errors.empty?
+    end
+
+    # Checks for errors. Returns +false+ if no errors are found, +true+ otherwise.
+    def failure?
+      !success?
+    end
+  end
+end

data/lib/service_record/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServiceRecord
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

data/lib/service_record.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require 'service_record/base'
+require 'service_record/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: service_record
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Muhammad Usman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -45,9 +45,6 @@ dependencies:
     - - "~>"
       - !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
@@ -55,9 +52,6 @@ dependencies:
     - - "~>"
       - !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
@@ -78,88 +72,88 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.5.2
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.14.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.1
+        version: 1.14.3
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.15.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.15'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.15.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !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'
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.1
   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'
+        version: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +186,7 @@ files:
 - lib/service_record/base.rb
 - lib/service_record/callbacks.rb
 - lib/service_record/failure.rb
+- lib/service_record/response.rb
 - lib/service_record/version.rb
 homepage: https://github.com/uxxman/service_record
 licenses:
@@ -209,14 +204,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.5
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Service objects for rails