service_record 1.2.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7916d1e6a73deee6ce9dddf92550452365db224960d08d4171db0581bc67fde
-  data.tar.gz: 57d614b6361e6643890c88730100fe33b490c109962d66e4dae241a985bf9e42
+  metadata.gz: 761226eff3ab278171ca2a9250b6fe089ceb53eeb2b1e221b680d250c3f1d2be
+  data.tar.gz: 567e4aa90fff412e1d42eba985a9e7a3f6397a53d622ec7e996503e22aa78a75
 SHA512:
-  metadata.gz: 4e4807fa30e0d3b053dd769078c8d3938eb02ad7de3f14812fa3bf9a6442f38652a317bff66ac4765c273b1b29c24697ae71cc857040263de03df4361869f4cd
-  data.tar.gz: '0488df45e2d0177e24db8f1f88077ccc94b1e8c91e7612a6176ad70f99802561fe0f774e61a73eaccaf0a0c1ce9cfaf4b6223a0cbe1a4743877305e389924e8f'
+  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/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,25 +1,41 @@
+# frozen_string_literal: true
+
+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 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
-        break service unless service.valid?
 
-        service.run_callbacks :perform do
-          service.result = service.perform
-          service.result = nil if service.failure?
+        if service.valid?
+          service.run_callbacks :perform do
+            service.result = service.perform
+          end
         end
+
+        return Response.new(service.result, service.errors)
       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?
@@ -27,16 +43,7 @@ module ServiceRecord
       raise Failure, service
     end
 
-    attr_accessor :result
-
-    def success?
-      errors.empty?
-    end
-
-    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/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,3 +1,5 @@
+# frozen_string_literal: true
+
 module ServiceRecord
-  VERSION = '1.2.4'.freeze
+  VERSION = '1.4.0'
 end

data/lib/service_record.rb

@@ -1,2 +1,4 @@
-require 'active_model'
+# 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.2.4
+  version: 1.4.0
 platform: ruby
 authors:
 - Muhammad Usman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-20 00:00:00.000000000 Z
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,14 +16,158 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !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.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.3
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.15'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.15.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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: '2.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.12.1
+- !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
@@ -42,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:
@@ -49,8 +194,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
@@ -58,15 +204,15 @@ 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.1.2
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Service objects for rails
 test_files: []