services 2.2.6 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1400e6ff9c2b46562e08881c6d094a0bb5de1459
-  data.tar.gz: 5e7b0018546aadd2b51d8e319cc2c5a551d7c893
+  metadata.gz: d53cbcc74506968392685a47758d817de8567d05
+  data.tar.gz: 40e349518171bac33c11e2ff5ade10e823236c21
 SHA512:
-  metadata.gz: e0bd521415d59a379fb9f3dce599d18631df2e6255239d559d12b52d6e92d235bac4f10234e959257ca44ab0c235c7e4f0ffc565682555247c249167487dbffe
-  data.tar.gz: d9af93a2ce8ad3c855bde9e30b9681a2ec0a877758acf5297c0828bddf95524d7926f23a699e2179b18dfa7b2e0e55deaa25922d9c51edc652165205994f5ad9
+  metadata.gz: e2c5f4c9db7cac2dea8ffc1ddfd202cd35a67fea3e5f21185a303a862cc30013ba962a8659fa2850a964497268b1c4a355b339b05243c60153b4ec0f298d6de0
+  data.tar.gz: d822b34fe0db413a3b310bd4560cc7d14bd0d6f6da92693cc2cb007e2335103fa7754be76efd9d26eebd09c7fa94a40aa3d3183087890b1bf2a5bb4134bbfa55

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 3.0.0
+
+* Rename `BaseFinder` to `Query`
+* `Query` doesn't inherit from `Base` anymore
+* Only use SQL subquery in `Query` if a JOIN is used
+
 ## 2.2.4
 
 * Increase TTL for Redis keys for uniqueness and error count to one day

data/README.md

@@ -33,7 +33,7 @@ To process services in the background, Services uses [Sidekiq](https://github.co
 
 #### Postgres
 
-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!
+The SQL that `Services::Query` (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::Query` or, even better, submit a [pull request](https://github.com/krautcomputing/services/issues) that fixes it to work with your database!
 
 ### Basic principles
 
@@ -54,7 +54,7 @@ Apart from these basic principles, you can implement the actual logic in a servi
 
 Follow these conventions when using Services in your Rails app:
 
-* services inherit from `Services::Base` (or `Services::BaseFinder`)
+* services inherit from `Services::Base` (or `Services::Query`)
 * 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::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.
@@ -121,12 +121,12 @@ As you can see, the helper `find_objects` is used to make sure you are dealing w
 
 It's good practice to always return the objects a service has been operating on at the end of the service.
 
-Another example, this time using `Services::BaseFinder`:
+Another example, this time using `Services::Query`:
 
 ```ruby
 module Services
   module Users
-    class Find < Services::BaseFinder
+    class Find < Services::Query
       private def process(scope, conditions)
         conditions.each do |k, v|
           case k
@@ -147,11 +147,11 @@ module Services
 end
 ```
 
-Since you will create services to find objects for pretty much every model you have and they all look very similar, i.e. process the find conditions and return a `ActiveRecord::Relation`, you can let those services inherit from `Services::BaseFinder` to remove some of the boilerplate.
+Since you will create services to find objects for pretty much every model you have and they all look very similar, i.e. process the find conditions and return a `ActiveRecord::Relation`, you can let those services inherit from `Services::Query` to remove some of the boilerplate.
 
-`Services::BaseFinder` inherits from `Services::Base` and takes an array of IDs and a hash of conditions as parameters. It then extracts some special conditions (:order, :limit, :page, :per_page) that are handled separately and passes a `ActiveRecord::Relation` and the remaining conditions to the `process` method that the inheriting class must define. This method should handle all the conditions, extend the scope and return it.
+`Services::Query` inherits from `Services::Base` and takes an array of IDs and a hash of conditions as parameters. It then extracts some special conditions (:order, :limit, :page, :per_page) that are handled separately and passes a `ActiveRecord::Relation` and the remaining conditions to the `process` method that the inheriting class must define. This method should handle all the conditions, extend the scope and return it.
 
-Check out [the source of `Services::BaseFinder`](lib/services/base_finder.rb) to understand what it does in more detail.
+Check out [the source of `Services::Query`](lib/services/base_finder.rb) to understand what it does in more detail.
 
 ### Helpers
 

data/lib/services.rb

@@ -21,6 +21,8 @@ rescue Services::BackgroundProcessorNotFound
 end
 require_relative 'services/modules/call_logger'
 require_relative 'services/modules/exception_wrapper'
+require_relative 'services/modules/object_class'
 require_relative 'services/modules/uniqueness_checker'
 require_relative 'services/base'
+require_relative 'services/query'
 require_relative 'services/railtie' if defined?(Rails)

data/lib/services/base.rb

@@ -4,6 +4,8 @@ require 'digest'
 
 module Services
   class Base
+    include ObjectClass
+
     class << self
       def inherited(subclass)
         subclass.const_set :Error, Class.new(StandardError)
@@ -65,12 +67,6 @@ module Services
       end
     end
 
-    def object_class
-      self.class.to_s[/Services::([^:]+)/, 1].singularize.constantize
-    rescue
-      raise "Could not determine service class from #{self.class}"
-    end
-
     def controller
       @controller ||= begin
         raise 'Please configure host.' if Services.configuration.host.nil?

data/lib/services/modules/object_class.rb

@@ -0,0 +1,9 @@
+module Services
+  module ObjectClass
+    private def object_class
+      self.class.to_s[/\AServices::([^:]+)/, 1].singularize.constantize
+    rescue
+      raise "Could not determine service class from #{self.class}."
+    end
+  end
+end

data/lib/services/{base_finder.rb → query.rb}

@@ -1,6 +1,10 @@
 module Services
-  class BaseFinder < Services::Base
-    disable_call_logging
+  class Query
+    include ObjectClass
+
+    class << self
+      delegate :call, to: :new
+    end
 
     def call(ids = [], conditions = {})
       ids, conditions = Array(ids), conditions.symbolize_keys
@@ -14,7 +18,10 @@ module Services
 
       unless conditions.empty?
         scope = process(scope, conditions)
-        scope = object_class.where(id: scope.select("DISTINCT #{object_table_id}"))
+        # If a JOIN is involved, use a subquery to make sure we're getting DISTINCT records.
+        if scope.to_sql =~ / join /i
+          scope = object_class.where(id: scope.select("DISTINCT #{object_table_id}"))
+        end
       end
 
       special_conditions.each do |k, v|

data/lib/services/railtie.rb

@@ -1,9 +1,9 @@
 module Services
   class Railtie < Rails::Railtie
-    # Require the base finder here since it relies
-    # on Rails.application to be present
-    initializer 'services.load_base_finder' do
-      require 'services/base_finder'
+    # Require `Services::Query` here since it relies
+    # on Rails.application to be present.
+    initializer 'services.load_services_query' do
+      require 'services/query'
     end
   end
 end

data/lib/services/version.rb

@@ -1,3 +1,3 @@
 module Services
-  VERSION = '2.2.6'
+  VERSION = '3.0.0'
 end

data/spec/services/{base_finder_spec.rb → query_spec.rb}

@@ -1,12 +1,12 @@
 require 'spec_helper'
 
-describe Services::BaseFinder do
+describe Services::Query do
   include_context 'capture logs'
 
   let(:base_find) { Services::Models::BaseFind }
 
   it 'has call logging disabled by default' do
-    pending 'Rails has to be loaded to call BaseFinder'
+    pending 'Rails has to be loaded to call Query'
     expect(base_find.call_logging_disabled).to eq(true)
     expect { base_find.call }.to_not change { logs }
   end

data/spec/support/test_services.rb

@@ -1,4 +1,4 @@
-require 'services/base_finder'
+require 'services/query'
 
 class Model
   class << self
@@ -42,7 +42,7 @@ end
 
 module Services
   module Models
-    class BaseFind < Services::BaseFinder
+    class Query < Services::Query
       private
 
       def process(scope, conditions)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: services
 version: !ruby/object:Gem::Version
-  version: 2.2.6
+  version: 3.0.0
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2014-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -153,21 +153,22 @@ files:
 - lib/services.rb
 - lib/services/asyncable.rb
 - lib/services/base.rb
-- lib/services/base_finder.rb
 - lib/services/logger/file.rb
 - lib/services/logger/redis.rb
 - lib/services/modules/call_logger.rb
 - lib/services/modules/exception_wrapper.rb
+- lib/services/modules/object_class.rb
 - lib/services/modules/uniqueness_checker.rb
+- lib/services/query.rb
 - 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
 - spec/services/modules/exception_wrapper_spec.rb
 - spec/services/modules/uniqueness_checker_spec.rb
+- spec/services/query_spec.rb
 - spec/spec_helper.rb
 - spec/support/call_proxy.rb
 - spec/support/helpers.rb
@@ -201,12 +202,12 @@ 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
 - spec/services/modules/exception_wrapper_spec.rb
 - spec/services/modules/uniqueness_checker_spec.rb
+- spec/services/query_spec.rb
 - spec/spec_helper.rb
 - spec/support/call_proxy.rb
 - spec/support/helpers.rb