service_record 1.0.0 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 904da829c98aa5d247c5979f1a01d4a23214e96cb24855bd3ca501275f28dbec
-  data.tar.gz: 1b5443f94ceab5481cbf3afcb08180ca3af00de5ab4e9ec04e315bb431f9c3ef
+  metadata.gz: b7916d1e6a73deee6ce9dddf92550452365db224960d08d4171db0581bc67fde
+  data.tar.gz: 57d614b6361e6643890c88730100fe33b490c109962d66e4dae241a985bf9e42
 SHA512:
-  metadata.gz: 02bebf02ace3c9af193819c7ff4ce0cd33427ef6f7e91b8911a0f6c3ceb2a547c0f4dbd301409652dc0f199e1ca5de304b8e2732c8516d655f11fb7597504961
-  data.tar.gz: cd925c97f73d12b5af2ca54351b93ee64654e5065c7e9363281f5542976941ccf99f73dbd474d77b834c8b622e0c4d737e373c221064803cdf01a959b24c2401
+  metadata.gz: 4e4807fa30e0d3b053dd769078c8d3938eb02ad7de3f14812fa3bf9a6442f38652a317bff66ac4765c273b1b29c24697ae71cc857040263de03df4361869f4cd
+  data.tar.gz: '0488df45e2d0177e24db8f1f88077ccc94b1e8c91e7612a6176ad70f99802561fe0f774e61a73eaccaf0a0c1ce9cfaf4b6223a0cbe1a4743877305e389924e8f'

data/README.md

@@ -1,8 +1,13 @@
 # ServiceRecord
 
+[![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 all the amazing tools to get you started with building your new awesome project and enforces reliable and battle-tested guidelines. One of the 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. 
+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.
 
@@ -59,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.
 
 
 
@@ -133,14 +140,12 @@ end
 
 ## Validations
 
-ServiceRecord extends on `ActiveModel::Validations`, so, everything that you can do there can be done inside a service class and ServiceRecord will make sure that a service only runs the perform function when all validations are passed, otherwise `errors` will contain details about the validation issues. Since services don't have an underlining object that needs to persisted like in ActiveRecord, you should avoid conditons filters like on create/update/save etc.
-
-You can also define callbacks like `before_validation` and `after_validation` just like you do inside an ActiveRecord class.
+ServiceRecord extends on `ActiveModel::Validations`, so, everything that you can do there can be done inside a service class and ServiceRecord will make sure that a service only runs the perform function when all validations are passed, otherwise `errors` will contain details about the validation issues.
 
 
 ## Custom Errors
 
-Just like validation errors, you can also add custom errors that you want to be reported. It useful to handle errors which are not related to input parameters validation. E.g.
+Just like validation errors, you can also add custom errors that you want to be reported. Use them to handle errors which are not related to input parameters validation. E.g.
 
 ```ruby
 errors.add :authentication, 'invalid credentials'
@@ -158,12 +163,13 @@ class SampleService < ApplicationService
   end
 
   private
-    def do_something
-    end
+    
+  def do_something
+  end
 end
 ```
 
-Availble callbacks are `before_perform`, `after_perform` and `around_perform`. If a `before_perform` calls `throw :abort`, the callback chain is hallted and perform function would not be called.
+Availble callbacks are `before_perform`, `after_perform` and `around_perform`. If a `before_perform` calls `throw :abort`, the callback chain is hallted and perform function will not be called.
 
 
 ## Development
@@ -174,7 +180,13 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/uxxman-sherwani/service_record.
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/uxxman/service_record.
 
 
 ## License

data/lib/service_record.rb

@@ -1,3 +1,2 @@
 require 'active_model'
 require 'service_record/base'
-require 'service_record/version'

data/lib/service_record/base.rb

@@ -1,3 +1,4 @@
+require 'service_record/failure'
 require 'service_record/callbacks'
 
 module ServiceRecord
@@ -6,21 +7,26 @@ module ServiceRecord
     include ActiveModel::Attributes
     include ActiveModel::Validations
     include ActiveModel::AttributeAssignment
-    include ActiveModel::Validations::Callbacks
 
     def self.perform(args = {})
       new.tap do |service|
         service.attributes = args
+        break service unless service.valid?
 
-        if service.valid?
-          service.run_callbacks :perform do
-            service.result = service.perform
-            service.result = nil if service.failure?
-          end
+        service.run_callbacks :perform do
+          service.result = service.perform
+          service.result = nil if service.failure?
         end
       end
     end
 
+    def self.perform!(args = {})
+      service = perform(args)
+      return service if service.success?
+
+      raise Failure, service
+    end
+
     attr_accessor :result
 
     def success?

data/lib/service_record/callbacks.rb

@@ -5,7 +5,7 @@ module ServiceRecord
     included do
       include ActiveSupport::Callbacks
 
-      define_callbacks :perform
+      define_callbacks :perform, skip_after_callbacks_if_terminated: true
     end
 
     class_methods do

data/lib/service_record/failure.rb

@@ -0,0 +1,11 @@
+module ServiceRecord
+  class Failure < StandardError
+    attr_reader :service
+
+    def initialize(service)
+      @service = service
+
+      super(@service.errors.full_messages.join(','))
+    end
+  end
+end

data/lib/service_record/version.rb

@@ -1,3 +1,3 @@
 module ServiceRecord
-  VERSION = '1.0.0'
+  VERSION = '1.2.4'.freeze
 end

metadata

@@ -1,61 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: service_record
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.4
 platform: ruby
 authors:
 - Muhammad Usman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '5.0'
 description: ActiveRecord lookalike but for business model requirements
 email:
 - uxman.sherwani@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/rails/generators/service/service_generator.rb
 - lib/rails/generators/service/templates/application_service.rb.tt
 - lib/rails/generators/service/templates/service.rb.tt
 - lib/service_record.rb
 - lib/service_record/base.rb
 - lib/service_record/callbacks.rb
+- lib/service_record/failure.rb
 - lib/service_record/version.rb
-- service_record.gemspec
 homepage: https://github.com/uxxman/service_record
 licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/uxxman/service_record
   source_code_uri: https://github.com/uxxman/service_record
-  changelog_uri: https://github.com/uxxman/service_record
+  changelog_uri: https://github.com/uxxman/service_record/releases
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.0
-before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in service_record.gemspec
-gemspec
-
-gem 'rake', '~> 12.3'
-gem 'rspec', '~> 3.9'

data/Gemfile.lock

@@ -1,51 +0,0 @@
-PATH
-  remote: .
-  specs:
-    service_record (1.0.0)
-      activemodel (~> 6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activesupport (6.0.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
-    concurrent-ruby (1.1.6)
-    diff-lcs (1.3)
-    i18n (1.8.2)
-      concurrent-ruby (~> 1.0)
-    minitest (5.14.0)
-    rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    thread_safe (0.3.6)
-    tzinfo (1.2.6)
-      thread_safe (~> 0.1)
-    zeitwerk (2.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake (~> 12.3)
-  rspec (~> 3.9)
-  service_record!
-
-BUNDLED WITH
-   2.1.4

data/Rakefile

@@ -1,6 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "service_record"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/service_record.gemspec

@@ -1,30 +0,0 @@
-require_relative 'lib/service_record/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'service_record'
-  spec.version       = ServiceRecord::VERSION
-  spec.authors       = ['Muhammad Usman']
-  spec.email         = ['uxman.sherwani@gmail.com']
-
-  spec.summary       = 'Service objects for rails'
-  spec.description   = 'ActiveRecord lookalike but for business model requirements'
-  spec.homepage      = 'https://github.com/uxxman/service_record'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = spec.homepage
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'activemodel', '~> 6.0'
-end