services 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b511fc23143b4bd0ddf9eef2574f76f3c0bf12cf
-  data.tar.gz: f34f312482dc3e0025b98d3acf0dae0c92d45275
+  metadata.gz: 497d42516b9a0d6a95bdf84cc5387fddae35c1a0
+  data.tar.gz: 25e03e9ceea6e04dadac955e5027c654d0a95dda
 SHA512:
-  metadata.gz: c7f9e9850c3435b6e525dc7708521bef50682544088b93afa8fb81554730b4b7faf9d8d92a71eb06ad56b4a2c55ef8e9a404055dd3b5161e40daa5f0e571fa54
-  data.tar.gz: ee3ec81535144e849340bc75b037c829731da0edc1bebe0ac666704dbd8c384be2fb5daf8f51c65251851e30c7222f8cd68c109cc5a8f90ef79c9be89c03c8e3
+  metadata.gz: 8ea3bb811cc4b5f55e3e8eefda6b6d64731250b46b143ea2ed1a456819d605727e58fca08417cb15a3e3e9eb37741dee8684c225af5ba4ef83d6f3162cb821d9
+  data.tar.gz: 757435307628879d21fe2a7106630e39901c1f806a7e4b024215d4fbdb98f336a85d6752fb88055b74c60863d29d508228d51275c27ebf69c75b123dbe47f1ea

data/.travis.yml

@@ -2,5 +2,6 @@ language: ruby
 rvm:
   - 2.0
   - 2.1
+  - 2.2
 services:
   - redis-server

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 2.0.0
+
+* Improve call logging
+* Implement `disable_call_logging` and `enable_call_logging` to control call logging for specific services
+* Disable call logging for `BaseFinder` by default
+* Rename `check_uniqueness!` to `check_uniqueness`
+
 ## 1.3.0
 
 * Allow only certain classes in Redis logger meta (NilClass, TrueClass, FalseClass, Symbol, String, Numeric)

data/Guardfile

@@ -1,25 +1,54 @@
-class Guard::StartRedisAndSidekiq
-  def call(guard_class, event, *args)
-    puts guard_class
-    puts event
-    puts args
-  end
-end
+# require 'guard/rspec'
 
-class Guard::StopRedisAndSidekiq
-  def call(guard_class, event, *args)
-    sleep 5
-    puts guard_class
-    puts event
-    puts args
-  end
-end
+# module ::Guard
+#   class RSpec < Plugin
+#     # Add `stop` method if not defined
+#     # so that `stop_*` callbacks work.
+#     unless instance_methods.include?(:stop)
+#       def stop; end
+#     end
+#   end
+# end
+
+# class Guard::StartRedisAndSidekiq
+#   def call(guard_class, event, *args)
+#     # Start Redis
+#     redis_options = {
+#       daemonize:  'yes',
+#       port:       redis_port,
+#       dir:        support_dir,
+#       dbfilename: 'redis.rdb',
+#       logfile:    log_dir.join('redis.log'),
+#       pidfile:    redis_pidfile
+#     }
+#     redis = support_dir.join('redis-server')
+#     system "#{redis} #{options_hash_to_string(redis_options)}"
+
+#     # Copy call proxy
+#     FileUtils.cp CALL_PROXY_SOURCE, CALL_PROXY_DESTINATION
+#   end
+# end
+
+# class Guard::StopRedisAndSidekiq
+#   def call(guard_class, event, *args)
+#     # Delete call proxy
+#     FileUtils.rm CALL_PROXY_DESTINATION
+
+#     # Stop Redis
+#     redis_cli = support_dir.join('redis-cli')
+#     system "#{redis_cli} -p #{redis_port} shutdown"
+
+#     # Truncate log files
+#     max_len = 1024 * 1024 # 1 MB
+#     Dir[File.join(log_dir, '*.log')].each do |file|
+#       File.truncate file, max_len if File.size(file) > max_len
+#     end
+#   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$))

data/README.md

@@ -9,35 +9,37 @@ Services is a collection of modules and base classes that let you implement a ni
 
 ## Motivation
 
-A lot has been written about service layers in Rails apps. There are advantages and disadvantages of course, but after using Services since 2013 in several Rails apps, I must say that in my opinion the advantages far outweigh the disadvantages.
+A lot has been written about service layers in Rails apps. There are of course advantages and disadvantages, but after using Services since 2013 in several Rails apps, I must say that in my opinion the advantages far outweigh the disadvantages.
 
-**The biggest benefit you get with a service layer is that it makes it much easier to reason about your application, find a bug, or implement new features, when all your business logic is in services, not scattered in models, controllers, helpers etc.**
+**The biggest benefit you get with a service layer is that it gets much easier to reason about your application, find a bug, or implement new features, when all your business logic is in services, not scattered in models, controllers, helpers etc.**
 
 ## Usage
 
-For disambiguation, we let's write Services with a uppercase S when we mean this gem, and services with a lowercase s when we mean, well, the plural of service.
+For disambiguation, we let's write Services with a uppercase "S" when we mean this gem, and services with a lowercase "s" when we mean, well, the plural of service.
 
 ### Basic principles
 
-Services is based on a couple of basic principles of what a service should be and do in your Rails app:
+Services is based on a couple of basic principles of what a service should be and do in your app:
 
-* a service does one thing well (Unix philosophy)
-* a service can be run synchronously (in the foreground) or asynchronously (in the background)
-* a service can be unique, meaning only one instance of it should be run at a time
-* a service logs all the things (start time, end time, caller, exceptions etc.)
-* a service has its own exception class and all exceptions that it may raise must be of that class or a subclass
-* a service can be called with one or multiple objects or one or multiple object IDs
+A service...
+
+* ...does one thing well (Unix philosophy)
+* ...can be run synchronously (in the foreground) or asynchronously (in the background)
+* ...can be unique, meaning only one instance of it should be run at a time
+* ...logs all the things (start time, end time, duration, caller, exceptions etc.)
+* ...has its own exception class(es) that all exceptions that it may raise inherit from
+* ...can be called with one or multiple objects or one or multiple object IDs
 
 Apart from these basic principles, you can implement the actual logic in a service any way you want.
 
 ### Conventions
 
-Follow these conventions that Services expects/recommends:
+Follow these conventions when using Services in your Rails app:
 
 * services inherit from `Services::Base` (or `Services::BaseFinder`)
 * services are located in `app/services/`
-* 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.
+* 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::DoStuff`) or namespace them by logical groups unrelated to models (`Services::Maintenance::CleanOldUsers`, `Services::Maintenance::SendDailySummary`, etc.)
+* some services 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
 
@@ -50,9 +52,17 @@ 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.
+#### Redis
+
+to be described...
+
+#### Sidekiq
+
+To process services in the background, Services uses [Sidekiq](https://github.com/mperham/sidekiq). Sidekiq is not required to use Services though. If it's not present when Services is loaded, a service will raise an exception when you try to enqueue it for background processing. If you use Sidekiq, make sure to load the Services gem after the Sidekiq gem.
+
+#### Postgres
 
-The SQL `Services::BaseFinder` (discussed further down) generates is optimized for Postgres. It might work with other databases but it's not guaranteed. If you're not using Postgres, don't use `Services::BaseFinder` or, even better, submit a PR that fixes it to work with your database!
+The SQL that `Services::BaseFinder` (discussed further down) generates is optimized for Postgres. It might work with other databases but it's not guaranteed. If you're not using Postgres, don't use `Services::BaseFinder` or, even better, submit a [pull request](https://github.com/krautcomputing/services/issues) that fixes it to work with your database!
 
 ### Examples
 
@@ -75,6 +85,22 @@ module Services
 end
 ```
 
+This service can be called in several ways:
+
+```ruby
+# Execute synchronously/immediately
+Services::Users::Delete.call User.find(1)                # with a user object
+Services::Users::Delete.call User.where(id: [1, 2, 3])   # with multiple user objects
+Services::Users::Delete.call 1                           # with a user ID
+Services::Users::Delete.call [1, 2, 3]                   # with multiple user IDs
+
+# Execute asynchronously/in the background
+Services::Users::Delete.perform_async 1                  # with a user ID
+Services::Users::Delete.perform_async [1, 2, 3]          # with multiple user IDs
+```
+
+As you can see, you cannot use objects when calling a service asynchronously since the arguments are serialized to Redis.
+
 As you can see, the helper `find_objects` is used to make sure you are dealing with an array of users from that point on, no matter whether `ids_or_objects` is a single user ID or user, or an array of user IDs or users.
 
 It's good practice to always return the objects a service has been operating on at the end of the service.

data/lib/services/modules/call_logger.rb

@@ -3,9 +3,17 @@ module Services
     module CallLogger
       def self.prepended(mod)
         mod.extend ClassMethods
+        mod.instance_eval do
+          def inherited(subclass)
+            subclass.extend ClassMethods
+            subclass.disable_call_logging if self.call_logging_disabled
+          end
+        end
       end
 
       module ClassMethods
+        @call_logging_disabled = false
+
         attr_accessor :call_logging_disabled
 
         def disable_call_logging

data/lib/services/version.rb

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

data/spec/services/base_finder_spec.rb

@@ -1,7 +1,10 @@
 require 'spec_helper'
 
 describe Services::BaseFinder do
-  it 'does not log start and end' do
-    expect { Services::Models::BaseFind.call }.to_not change { @logs }
+  include_context 'capture logs'
+
+  it 'has call logging disabled by default' do
+    expect(Services::Models::BaseFind.call_logging_disabled).to eq(true)
+    expect { Services::Models::BaseFind.call }.to_not change { logs }
   end
 end

data/spec/services/modules/call_logger_spec.rb

@@ -1,30 +1,14 @@
 require 'spec_helper'
 
 describe Services::Base::CallLogger do
-  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
-  end
-
-  after do
-    Services.configuration.logger = nil
-  end
+  include_context 'capture logs'
 
   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(
+      expect(logs.first).to match(
         message:  "START with args: #{args}",
         meta: {
           caller:  a_string_matching(caller_regex),
@@ -33,7 +17,7 @@ describe Services::Base::CallLogger do
         },
         severity: 'info'
       )
-      expect(@logs.last).to match(
+      expect(logs.last).to match(
         message: 'END',
         meta: {
           duration: 0.0,
@@ -53,7 +37,7 @@ describe Services::Base::CallLogger do
         Services::CallProxy.call(called_service, :call)
         caller_regex = /\A#{Regexp.escape __FILE__}:\d+/
         expect(
-          @logs.detect do |log|
+          logs.detect do |log|
             log[:meta][:caller] =~ caller_regex
           end
         ).to be_present
@@ -64,7 +48,7 @@ describe Services::Base::CallLogger 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|
+            logs.detect do |log|
               log[:meta][:caller] =~ caller_regex
             end
           ).to be_present
@@ -88,7 +72,7 @@ describe Services::Base::CallLogger do
           service_calling_service.call called_service
           caller_regex = /\A#{Regexp.escape TEST_SERVICES_PATH.to_s}:\d+/
           expect(
-            @logs.detect do |log|
+            logs.detect do |log|
               log[:meta][:caller] =~ caller_regex
             end
           ).to be_present
@@ -99,13 +83,14 @@ describe Services::Base::CallLogger do
 
   context 'when call logging is disabled' do
     it 'does not log start and end' do
-      expect { EmptyServiceWithoutCallLogging.call }.to_not change { @logs }
+      expect(EmptyServiceWithoutCallLogging.call_logging_disabled).to eq(true)
+      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 }
+      expect { klass.call rescue nil }.to change { logs }
     end
   end
 
@@ -116,7 +101,7 @@ describe Services::Base::CallLogger do
       %w(NestedError1 NestedError2).each do |error|
         message_regex = /caused by: #{service.class}::#{error}/
         expect(
-          @logs.detect do |log|
+          logs.detect do |log|
             log[:message] =~ message_regex
           end
         ).to be_present

data/spec/support/shared.rb

@@ -0,0 +1,19 @@
+shared_context 'capture logs' do
+  let(:logger) { spy('logger') }
+  let(:logs)   { [] }
+
+  before do
+    Services.configuration.logger = logger
+    allow(logger).to receive(:log) do |message, meta, severity|
+      logs << {
+        message:  message,
+        meta:     meta,
+        severity: severity
+      }
+    end
+  end
+
+  after do
+    Services.configuration.logger = nil
+  end
+end

data/spec/support/test_services.rb

@@ -43,7 +43,9 @@ end
 module Services
   module Models
     class BaseFind < Services::BaseFinder
-      private def process(scope, conditions)
+      private
+
+      def process(scope, conditions)
         scope
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: services
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-16 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -174,6 +174,7 @@ files:
 - spec/support/log/.gitkeep
 - spec/support/redis-cli
 - spec/support/redis-server
+- spec/support/shared.rb
 - spec/support/test_services.rb
 homepage: http://krautcomputing.github.io/services
 licenses:
@@ -212,5 +213,6 @@ test_files:
 - spec/support/log/.gitkeep
 - spec/support/redis-cli
 - spec/support/redis-server
+- spec/support/shared.rb
 - spec/support/test_services.rb
 has_rdoc: