services 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d81b81f1b90d4c408865594ca48558fe9469e7d
-  data.tar.gz: a33b8e7d9007b638feddadd7270780756a083a0f
+  metadata.gz: b511fc23143b4bd0ddf9eef2574f76f3c0bf12cf
+  data.tar.gz: f34f312482dc3e0025b98d3acf0dae0c92d45275
 SHA512:
-  metadata.gz: 28c253c6305653cd64b7fed56a905d6b4215f6ca579500ac3c0015f6ed0c682958478771b7a7b45bd90360b86b745bfa8c19b1d5814e845476d65bb1e107747f
-  data.tar.gz: 0942c38383e122fdf186cde9fd278c684d1e2fe8211b82724fb306f6bd168bf8b587abe362c61927a87752326276ef488d331227e856ceabfb39def0453fcb72
+  metadata.gz: c7f9e9850c3435b6e525dc7708521bef50682544088b93afa8fb81554730b4b7faf9d8d92a71eb06ad56b4a2c55ef8e9a404055dd3b5161e40daa5f0e571fa54
+  data.tar.gz: ee3ec81535144e849340bc75b037c829731da0edc1bebe0ac666704dbd8c384be2fb5daf8f51c65251851e30c7222f8cd68c109cc5a8f90ef79c9be89c03c8e3

data/Guardfile

@@ -1,4 +1,26 @@
+class Guard::StartRedisAndSidekiq
+  def call(guard_class, event, *args)
+    puts guard_class
+    puts event
+    puts args
+  end
+end
+
+class Guard::StopRedisAndSidekiq
+  def call(guard_class, event, *args)
+    sleep 5
+    puts guard_class
+    puts event
+    puts args
+  end
+end
+
 guard 'rspec', cmd: 'bundle exec rspec' do
+  # callback StartRedisAndSidekiq.new, :start_begin
+  # callback StopRedisAndSidekiq.new, :stop
+  # callback StopRedisAndSidekiq.new, :stop_begin
+  # callback StopRedisAndSidekiq.new, :stop_end
+
   # Specs
   watch(%r(^spec/.+_spec\.rb$))
   watch('spec/spec_helper.rb')       { 'spec' }

data/README.md

@@ -39,6 +39,15 @@ Follow these conventions that Services expects/recommends:
 * services are namespaced with the model they operate on and their names are verbs, e.g. `app/services/users/delete.rb` defines `Services::Users::Delete`. If a service operates on multiple models or no models at all, don't namespace them (`Services::DoLotsOfStuff`) or namespace them by logical groups unrelated to models (`Services::Maintenance::CleanOldUsers`, `Services::Maintenance::SendDailySummary`, etc.)
 * Sometimes services must call other services. Try to not combine multiple calls to other services and business logic in one service. Instead, some services should contain only business logic and other services only a bunch of service calls but no (or little) business logic. This keeps your services nice and modular.
 
+### Rails autoload fix
+
+By default, Rails expects `app/services/users/delete.rb` to define `Users::Delete`, but we want it to expect `Services::Users::Delete`. To make this work, add the `app` folder to the autoload path:
+
+```ruby
+# config/application.rb
+config.autoload_paths += [config.root.join('app')]
+```
+
 ### Dependence
 
 To process services in the background, Services uses [Sidekiq](https://github.com/mperham/sidekiq). Sidekiq is not absolutely required to use Services though, if it's not present, a service will raise an exception when you try to enqueue it for background processing. If you're using Sidekiq, make sure to load the Services gem after the Sidekiq gem.

data/lib/services/base_finder.rb

@@ -1,5 +1,7 @@
 module Services
   class BaseFinder < Services::Base
+    disable_call_logging
+
     def call(ids = [], conditions = {})
       ids, conditions = Array(ids), conditions.symbolize_keys
       special_conditions = conditions.extract!(:order, :limit, :page, :per_page)

data/lib/services/modules/call_logger.rb

@@ -1,41 +1,52 @@
 module Services
   class Base
     module CallLogger
+      def self.prepended(mod)
+        mod.extend ClassMethods
+      end
+
+      module ClassMethods
+        attr_accessor :call_logging_disabled
+
+        def disable_call_logging
+          @call_logging_disabled = true
+        end
+
+        def enable_call_logging
+          @call_logging_disabled = false
+        end
+      end
+
       def call(*args)
         return super if Services.configuration.logger.nil?
-
-        log "START with args #{args}"
-        log "CALLED BY #{caller || '(not found)'}"
-        start = Time.now
+        unless self.class.call_logging_disabled
+          log "START with args: #{args}", caller: caller
+          start = Time.now
+        end
         begin
           result = super
         rescue => e
-          log_exception e
+          log exception_message(e), {}, 'error'
           raise e
         ensure
-          log "END after #{(Time.now - start).round(2)} seconds"
+          log 'END', duration: (Time.now - start).round(2) unless self.class.call_logging_disabled
           result
         end
       end
 
       private
 
-      def log(message, severity = 'info')
-        Services.configuration.logger.log message, { service: self.class.to_s, id: @id }, severity
+      def log(message, meta = {}, severity = 'info')
+        Services.configuration.logger.log message, meta.merge(service: self.class.to_s, id: @id), severity
       end
 
-      def log_exception(e, cause = false)
-        log "#{'caused by: ' if cause}#{e.class}: #{e.message}"
-        if e.respond_to?(:cause) && e.cause
-          e.backtrace.take(5).each do |line|
-            log "  #{line}"
-          end
-          log_exception(e.cause, true)
-        else
-          e.backtrace.each do |line|
-            log "  #{line}"
-          end
+      def exception_message(e)
+        message = "#{e.class}: #{e.message}"
+        e.backtrace.each do |line|
+          message << "\n  #{line}"
         end
+        message << "\ncaused by: #{exception_message(e.cause)}" if e.respond_to?(:cause) && e.cause
+        message
       end
 
       def caller

data/lib/services/modules/uniqueness_checker.rb

@@ -19,7 +19,7 @@ module Services
         mod.const_set :NotUniqueError, Class.new(mod::Error)
       end
 
-      def check_uniqueness!(*args, on_error: :fail)
+      def check_uniqueness(*args, on_error: :fail)
         raise "on_error must be one of #{ON_ERROR.join(', ')}, but was #{on_error}" unless ON_ERROR.include?(on_error.to_sym)
         raise 'Service args not found.' if @service_args.nil?
         @uniqueness_args = args.empty? ? @service_args : args

data/lib/services/version.rb

@@ -1,3 +1,3 @@
 module Services
-  VERSION = '1.3.0'
+  VERSION = '2.0.0'
 end

data/spec/services/base_finder_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Services::BaseFinder do
+  it 'does not log start and end' do
+    expect { Services::Models::BaseFind.call }.to_not change { @logs }
+  end
+end

data/spec/services/modules/call_logger_spec.rb

@@ -1,54 +1,125 @@
 require 'spec_helper'
 
 describe Services::Base::CallLogger do
-  it 'logs start with args and end with duration' do
-    service = EmptyService.new
-    logs = []
-    allow(service).to receive(:log) do |message, *|
-      logs << message
+  let(:logger) { spy('logger') }
+
+  before do
+    Services.configuration.logger = logger
+    @logs = []
+    allow(logger).to receive(:log) do |message, meta, severity|
+      @logs << {
+        message:  message,
+        meta:     meta,
+        severity: severity
+      }
     end
-    service.call 'foo', 'bar'
-    expect(logs.first).to eq('START with args ["foo", "bar"]')
-    expect(logs.last).to eq('END after 0.0 seconds')
   end
 
-  it 'logs the caller' do
-    service_calling_service, called_service = ServiceCallingService.new, EmptyService.new
-    logs = []
-    allow(called_service).to receive(:log) do |message, *|
-      logs << message
+  after do
+    Services.configuration.logger = nil
+  end
+
+  context 'when call logging is enabled' do
+    it 'logs start and end' do
+      service, args = EmptyService.new, %w(foo bar)
+      service.call *args
+      caller_regex = /\A#{Regexp.escape __FILE__}:\d+\z/
+      expect(@logs.first).to match(
+        message:  "START with args: #{args}",
+        meta: {
+          caller:  a_string_matching(caller_regex),
+          service: service.class.to_s,
+          id:      an_instance_of(String)
+        },
+        severity: 'info'
+      )
+      expect(@logs.last).to match(
+        message: 'END',
+        meta: {
+          duration: 0.0,
+          service:  service.class.to_s,
+          id:       an_instance_of(String)
+        },
+        severity: 'info'
+      )
     end
 
-    # When Rails is not defined, the complete caller path should be logged
-    service_calling_service.call called_service
-    expect(logs).to include(/\ACALLED BY #{Regexp.escape PROJECT_ROOT.join(TEST_SERVICES_PATH).to_s}:\d+/)
+    describe 'logging the caller' do
+      let(:service_calling_service) { ServiceCallingService.new }
+      let(:called_service) { EmptyService.new }
+
+      it 'filters out caller paths from lib folder' do
+        require 'services/call_proxy'
+        Services::CallProxy.call(called_service, :call)
+        caller_regex = /\A#{Regexp.escape __FILE__}:\d+/
+        expect(
+          @logs.detect do |log|
+            log[:meta][:caller] =~ caller_regex
+          end
+        ).to be_present
+      end
+
+      context 'when Rails is not defined' do
+        it 'logs the complete caller path' do
+          service_calling_service.call called_service
+          caller_regex = /\A#{Regexp.escape PROJECT_ROOT.join(TEST_SERVICES_PATH).to_s}:\d+/
+          expect(
+            @logs.detect do |log|
+              log[:meta][:caller] =~ caller_regex
+            end
+          ).to be_present
+        end
+      end
+
+      context 'when Rails is defined' do
+        before do
+          class Rails
+            def self.root
+              PROJECT_ROOT
+            end
+          end
+        end
+
+        after do
+          Object.send :remove_const, :Rails
+        end
 
-    # When Rails is defined, only the caller path relative to Rails.root is logged
-    class Rails
-      def self.root; PROJECT_ROOT; end
+        it 'logs the caller path relative to `Rails.root`' do
+          service_calling_service.call called_service
+          caller_regex = /\A#{Regexp.escape TEST_SERVICES_PATH.to_s}:\d+/
+          expect(
+            @logs.detect do |log|
+              log[:meta][:caller] =~ caller_regex
+            end
+          ).to be_present
+        end
+      end
+    end
+  end
+
+  context 'when call logging is disabled' do
+    it 'does not log start and end' do
+      expect { EmptyServiceWithoutCallLogging.call }.to_not change { @logs }
+    end
+  end
+
+  it 'logs exceptions' do
+    [ErrorService, ErrorServiceWithoutCallLogging].each do |klass|
+      expect { klass.call rescue nil }.to change { @logs }
     end
-    logs = []
-    service_calling_service.call called_service
-    expect(logs).to include(/\ACALLED BY #{Regexp.escape TEST_SERVICES_PATH.to_s}:\d+/)
-    Object.send :remove_const, :Rails
-
-    # Caller paths from services lib folder should be filtered
-    require 'services/call_proxy'
-    logs = []
-    Services::CallProxy.call(called_service, :call)
-    expect(logs).to include(/\ACALLED BY #{Regexp.escape __FILE__}:\d+/)
   end
 
   if RUBY_VERSION > '2.1'
-    it 'logs exceptions and exception causes' do
+    it 'logs exception causes' do
       service = NestedExceptionService.new
-      logs = []
-      allow(service).to receive(:log) do |message, *|
-        logs << message
-      end
       expect { service.call }.to raise_error(service.class::Error)
       %w(NestedError1 NestedError2).each do |error|
-        expect(logs).to include(/\Acaused by: #{service.class}::#{error}/)
+        message_regex = /caused by: #{service.class}::#{error}/
+        expect(
+          @logs.detect do |log|
+            log[:message] =~ message_regex
+          end
+        ).to be_present
       end
     end
   end

data/spec/services/modules/exception_wrapper_spec.rb

@@ -7,7 +7,7 @@ describe Services::Base::ExceptionWrapper do
         ErrorService.call
       end.to raise_error do |error|
         expect(error).to be_a(ErrorService::Error)
-        expect(error.message).to eq('I am a service error.')
+        expect(error.message).to eq('I am a service error raised by ErrorService.')
         expect(error.cause).to be_nil
       end
 

data/spec/spec_helper.rb

@@ -29,7 +29,6 @@ sidekiq_timeout = 20
 
 Services.configure do |config|
   config.redis  = Redis.new
-  config.logger = Services::Logger::File.new(log_dir)
 end
 
 Sidekiq.configure_client do |config|

data/spec/support/test_services.rb

@@ -1,4 +1,19 @@
+require 'services/base_finder'
+
 class Model
+  class << self
+    def table_name
+      'models'
+    end
+
+    # Stub ActiveRecord methods
+    %i(select order where limit page per).each do |m|
+      define_method m do |*args|
+        self
+      end
+    end
+  end
+
   attr_reader :id
 
   def initialize(id)
@@ -27,6 +42,12 @@ end
 
 module Services
   module Models
+    class BaseFind < Services::BaseFinder
+      private def process(scope, conditions)
+        scope
+      end
+    end
+
     class Find < Services::Base
       def call(ids)
         ids.map { |id| ModelRepository.find id }.compact
@@ -52,9 +73,24 @@ class EmptyService < Services::Base
   end
 end
 
+class EmptyServiceWithoutCallLogging < Services::Base
+  disable_call_logging
+
+  def call(*args)
+  end
+end
+
 class ErrorService < Services::Base
   def call
-    raise Error.new('I am a service error.')
+    raise Error, "I am a service error raised by #{self.class}."
+  end
+end
+
+class ErrorServiceWithoutCallLogging < Services::Base
+  disable_call_logging
+
+  def call
+    raise Error, "I am a service error raised by #{self.class}."
   end
 end
 
@@ -66,14 +102,14 @@ end
 
 class UniqueService < Services::Base
   def call(on_error, sleep)
-    check_uniqueness! on_error: on_error
+    check_uniqueness on_error: on_error
     sleep 0.5 if sleep
   end
 end
 
 class UniqueWithCustomArgsService < Services::Base
   def call(uniqueness_arg1, uniqueness_arg2, ignore_arg, on_error, sleep)
-    check_uniqueness! uniqueness_arg1, uniqueness_arg2, on_error: on_error
+    check_uniqueness uniqueness_arg1, uniqueness_arg2, on_error: on_error
     sleep 0.5 if sleep
   end
 end
@@ -81,7 +117,7 @@ end
 class UniqueMultipleService < Services::Base
   def call(*args, on_error, sleep)
     args.each do |arg|
-      check_uniqueness! arg, on_error: on_error
+      check_uniqueness arg, on_error: on_error
     end
     sleep 0.5 if sleep
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: services
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Manuel Meurer
@@ -162,6 +162,7 @@ files:
 - lib/services/railtie.rb
 - lib/services/version.rb
 - services.gemspec
+- spec/services/base_finder_spec.rb
 - spec/services/base_spec.rb
 - spec/services/logger/redis_spec.rb
 - spec/services/modules/call_logger_spec.rb
@@ -199,6 +200,7 @@ signing_key:
 specification_version: 4
 summary: A nifty service layer for your Rails app
 test_files:
+- spec/services/base_finder_spec.rb
 - spec/services/base_spec.rb
 - spec/services/logger/redis_spec.rb
 - spec/services/modules/call_logger_spec.rb