services 8.0.1 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a698bd8da6f4a212b731789e0ac3db4fbee0e0a097c89994d2b1ec9d3ec900ea
-  data.tar.gz: 4689d6d5813efa452141b8cf4e41fcf542e94bbed9b2ad88e8ef7a8f47857fa1
+  metadata.gz: 69f65a0f459ea156e6523031658753b0128be29712385cfe4d2fc32f1c39e6b5
+  data.tar.gz: 5d0532802156ea0d3e4cbdc3c2a5189a7a16e580efeb989b7b6dec265d566cbc
 SHA512:
-  metadata.gz: 3acfbd1a4c1db551629ab7e2ec8154ad6eb11ac19d576989f700c4c7e2e97ccea38016423c614b45840874d62ae6b1d4ff291c3c091676ebdd613b700ec944de
-  data.tar.gz: f3e29cdc63402370f7f211a3bea262e807468743fa9e6bb4657cdbad5ac0867738c7693ee239f09483ee758c3d74aec0f92b777d183f156363d1c798008e7df5
+  metadata.gz: 52cf70d2876bcf2714dceebe3dba990e58fce96d2196e290667eb95513c470895a8819addaf6d7b37dd3b9973877a2251b887696aa6fbdcddda3c41eb046b6aa
+  data.tar.gz: 0523c7bb4b44635870a14caa242900ed93605ad5607bd21c93206bf06bfa6e1c911490e319c769425f1ab6d8d928d6477ef6f2dfebadb7f0ed7fa46a28a008e1

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI
+on: [push, pull_request]
+
+jobs:
+
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+
+    env:
+      RAILS_ENV: test
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+          - 3.0
+          - 2.7
+
+    services:
+
+      redis:
+        image: redis
+        options: --entrypoint redis-server
+        ports:
+          - 6379:6379
+
+    steps:
+
+      - name: Check out code
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+
+      - name: Install gems
+        run: bundle exec appraisal install
+
+      - name: Run tests
+        run: bundle exec appraisal rspec

data/Appraisals

@@ -1,7 +1,3 @@
-appraise 'rails_5.2' do
-  gem 'rails', '~> 5.2.0'
-end
-
 appraise 'rails_6.0' do
   gem 'rails', '~> 6.0.0'
 end

data/CHANGELOG.md

@@ -1,3 +1,152 @@
+## 9.0.0
+
+* Drop support for Rails 5.2 and Ruby 2.6
+* Exclude test files from release
+* Add CI via GitHub Actions
+* Make replacing ActiveRecord records in asyncable params more robust
+* When calling a service async, make args and kwargs available as ivars
+
+## 8.0.1
+
+* add missing `to_s`
+
+## 8.0.0
+
+* handle kwargs correctly
+* test with current rails versions
+
+## 7.3.3
+
+* fix typo
+* increase cache time to 30 days
+
+## 7.3.1
+
+* fix loading background processor
+
+## 7.3.0
+
+* allow using sucker_punch instead of sidekiq
+* allow setting the method arity when allowing class method to be used in queries, since scopes shadow the arity of their procs
+
+## 7.2.0
+
+* enable using class methods in queries
+
+## 7.1.2
+
+* use select instead of pluck
+
+## 7.1.1
+
+* fix typos
+
+## 7.1.0
+
+* fix joining order classes
+* refactor, formatting
+
+## 7.0.3
+
+* fix identifying call method when calling service async
+* remove gemnasium badge
+* fix "buy me a coffee" link
+* add "buy me a coffee" link to readme
+
+## 7.0.2
+
+* symbolize hash keys for arguments to call method when kwargs are used
+* dont modify args
+* fix spec
+* fix specs and readme
+
+## 7.0.1
+
+* add table name to condition
+
+## 7.0.0
+
+* add created_after and created_before as default conditions, allow overriding default conditions in query object
+
+## 6.0.5
+
+* Revert "set default order for query if it was set to nil"
+
+## 6.0.4
+
+* automatically add LEFT OUTER JOIN when trying to sort by a field on an association table
+* set default order for query if it was set to nil
+
+## 6.0.3
+
+* allow calling query service without params
+
+## 6.0.2
+
+* add id_not as special query condition
+
+## 6.0.1
+
+* allow calling query object with only arguments
+* update sidekiq dev dependency to 5.x
+* remove encoding comment
+* add missing require
+* syntax
+
+## 6.0.0
+
+* dont specify ruby patchlevels in travis config
+* use globalid to make args serializable
+* remove bulk call async method
+* remove async instance methods from services
+
+## 5.1.2
+
+* dup passed in scope in query class before using it
+* fix specs for ruby < 2.4
+* update rails 5.1 to released version
+* update travis config
+* stop supporting rails 4.0 and 4.1, add 5.1.rc1
+
+## 5.1.1
+
+* replace Fixnum with Integer to silence Ruby 2.4 warnings
+* update ruby versions in travis config
+* update travis config
+* update ruby versions in travis config
+* update travis build matrix, dont test ruby 2.4.0 with rails 4.0 or 4.1, allow ruby 2.4.0 with rails 4.2 to fail for now (until rails 4.2.8 is released with
+out json 1.x dependency)
+* increase sleep and waiting time in specs
+* require active_record explicitly
+* fix specs
+
+## 5.1.0
+
+* test with ruby 2.4.0, clarify version requirements for ruby and redis
+* update sidekiq dev dependency to ~> 4.0
+* allow passing scope to query call
+
+## 5.0.0
+
+* freeze constants
+* use #public_send instead of #send where possible
+* rename perform_* methods to call_*, closes #6
+
+## 4.3.0
+
+* update travis config
+* use pluck only on activerecord relations, from activesupport 5 on all enumerables respond to #pluck, which will call #[] on the contained objects [Manuel M
+eurer]
+* drop support for rails 3.2, add appraisal for testing
+* update readme
+* update ruby dependency in readme
+* update travis config
+
+## 4.1.4
+
+* update changelog
+* fix finding find service class
+
 ## 4.1.3
 
 * Fix finding the find service class
@@ -29,9 +178,6 @@
 ## 3.1.1
 
 * Query does not have its own error, raise ArgumentError instead
-
-## 3.1.0
-
 * Verify that query ids parameter is not nil
 
 ## 3.0.1
@@ -91,16 +237,4 @@
 
 ## 1.0.0
 
-* Added Redis logger
-* Moved file logger to separate class
-* Don't initialize file logger automatically for Rails apps anymore
-* Changed argument order for Redis and file logger, made `tags` parameter optional
-
-## 0.4.0
-
-* Renamed `service_class` helper to `object_class`
-
-## 0.3.4
-
-* Added `BaseFinder`
-* Updated uniqueness key
+* First stable version

data/Guardfile

@@ -68,9 +68,7 @@ guard 'rspec', cmd: 'bundle exec appraisal rspec' do
 
   # Specs
   watch(%r(^spec/.+_spec\.rb$))
-  watch('spec/spec_helper.rb')       { 'spec' }
-  watch(%r(^spec/support/(.+)\.rb$)) { 'spec' }
 
   # Files
-  watch(%r(^lib/(.+)\.rb$))          { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r(^lib/(.+)\.rb$)) { "spec/#{_1[1]}_spec.rb" }
 end

data/README.md

@@ -1,8 +1,7 @@
 # Services
 
 [![Gem Version](https://badge.fury.io/rb/services.png)](http://badge.fury.io/rb/services)
-[![Build Status](https://secure.travis-ci.org/manuelmeurer/services.png)](http://travis-ci.org/manuelmeurer/services)
-[![Code Climate](https://codeclimate.com/github/manuelmeurer/services.png)](https://codeclimate.com/github/manuelmeurer/services)
+[![CI](https://github.com/manuelmeurer/services/actions/workflows/ci.yml/badge.svg)](https://github.com/manuelmeurer/services/actions/workflows/ci.yml)
 
 Services is a collection of modules and base classes that let you simply add a service layer to your Rails app.
 
@@ -18,9 +17,9 @@ For disambiguation: in this README, when you read "Services" with a uppercase "S
 
 ### Requirements
 
-#### Ruby >= 2.2.5
+#### Ruby >= 2.7
 
-#### Rails >= 5.2
+#### Rails >= 6.0
 
 #### Redis >= 3.0
 

data/lib/services/asyncable.rb

@@ -33,18 +33,14 @@ module Services
     module ClassMethods
       ASYNC_METHOD_SUFFIXES.each do |async_method_suffix|
         define_method "call_#{async_method_suffix}" do |*args|
-          args = args.map do |arg|
-            arg.respond_to?(:to_global_id) ? arg.to_global_id.to_s : arg
-          end
+          args = args.map(&Services.method(:replace_records_with_global_ids))
           self.public_send "perform_#{async_method_suffix}", *args
         end
       end
     end
 
     def perform(*args)
-      args = args.map do |arg|
-        GlobalID::Locator.locate(arg) || arg
-      end
+      args = args.map(&Services.method(:replace_global_ids_with_records))
 
       call_method = method(:call)
 
@@ -60,6 +56,10 @@ module Services
         {}
       end
 
+      # Save args and kwargs in ivars so they can be used
+      # in the service, i.e. for rescheduling.
+      @_call_args, @_call_kwargs = args, kwargs
+
       call *args, **kwargs
     end
   end

data/lib/services/version.rb

@@ -1,3 +1,3 @@
 module Services
-  VERSION = '8.0.1'.freeze
+  VERSION = '9.0.0'.freeze
 end

data/lib/services.rb

@@ -14,12 +14,37 @@ module Services
     has :allowed_class_methods_in_queries, default: {}
   end
 
-  def self.redis
-    @redis ||= self.configuration.redis || (defined?(Redis.current) && Redis.current) or fail RedisNotFound, 'Redis not configured.'
-  end
+  class << self
+    def redis
+      @redis ||= configuration.redis || (defined?(Redis.current) && Redis.current) or fail RedisNotFound, 'Redis not configured.'
+    end
+
+    def allow_class_method_in_queries(klass, method, arity = nil)
+      (configuration.allowed_class_methods_in_queries[klass.to_s] ||= {})[method.to_sym] = arity
+    end
+
+    def replace_records_with_global_ids(arg)
+      method = method(__method__)
+
+      case arg
+      when Array then arg.map(&method)
+      when Hash  then arg.transform_keys(&method)
+                         .transform_values(&method)
+      else arg.respond_to?(:to_global_id) ? "_#{arg.to_global_id.to_s}" : arg
+      end
+    end
+
+    def replace_global_ids_with_records(arg)
+      method = method(__method__)
 
-  def self.allow_class_method_in_queries(klass, method, arity = nil)
-    (configuration.allowed_class_methods_in_queries[klass.to_s] ||= {})[method.to_sym] = arity
+      case arg
+      when Array  then arg.map(&method)
+      when Hash   then arg.transform_keys(&method)
+                          .transform_values(&method)
+      when String then (arg.starts_with?("_") && GlobalID::Locator.locate(arg[1..-1])) || arg
+      else arg
+      end
+    end
   end
 end
 

data/services.gemspec

@@ -1,9 +1,15 @@
 lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+unless $LOAD_PATH.include?(lib)
+  $LOAD_PATH.unshift(lib)
+end
 
 require 'services/version'
 
 Gem::Specification.new do |gem|
+  files      = `git ls-files`.split($/)
+  test_files = files.grep(%r(^spec/))
+
   gem.name                  = 'services'
   gem.version               = Services::VERSION
   gem.platform              = Gem::Platform::RUBY
@@ -11,12 +17,12 @@ Gem::Specification.new do |gem|
   gem.email                 = 'manuel@krautcomputing.com'
   gem.summary               = 'A nifty service layer for your Rails app'
   gem.description           = 'A nifty service layer for your Rails app'
-  gem.homepage              = 'http://manuelmeurer.github.io/services'
+  gem.homepage              = 'https://manuelmeurer.com/services/'
   gem.license               = 'MIT'
-  gem.required_ruby_version = '>= 2.2.5'
-  gem.files                 = `git ls-files`.split($/)
-  gem.executables           = gem.files.grep(%r(^bin/)).map { |f| File.basename(f) }
-  gem.test_files            = gem.files.grep(%r(^(test|spec|features)/))
+  gem.required_ruby_version = '>= 2.7'
+  gem.files                 = files - test_files
+  gem.executables           = gem.files.grep(%r(\Abin/)).map(&File.method(:basename))
+  gem.test_files            = test_files
   gem.require_paths         = ['lib']
 
   gem.add_development_dependency 'rake',            '>= 0.9.0'
@@ -29,6 +35,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'timecop',         '~> 0.7'
   gem.add_development_dependency 'sqlite3',         '~> 1.3'
   gem.add_development_dependency 'appraisal',       '~> 2.1'
-  gem.add_runtime_dependency     'rails',           '>= 4.2'
+  gem.add_runtime_dependency     'rails',           '>= 6.0'
   gem.add_runtime_dependency     'gem_config',      '~> 0.3'
 end

data/spec/services/modules/call_logger_spec.rb

@@ -9,7 +9,7 @@ describe Services::Base::CallLogger do
       service.call *args
       caller_regex = /\A#{Regexp.escape __FILE__}:\d+\z/
       expect(logs.first).to match(
-        message:  "START with args: #{args}",
+        message:  "START with args: #{args}, kwargs: {}",
         meta: {
           caller:  a_string_matching(caller_regex),
           service: service.class.to_s,

data/spec/services/query_spec.rb

@@ -16,7 +16,7 @@ describe Services::Query do
       {
         comment     => comment.id,
         comments    => comments.map(&:id),
-        Comment.all => Comment.all.pluck(:id)
+        Comment.all => Comment.all.map { |comment| { id: comment.id } }
       }.each do |condition_before, condition_after|
         expect { Services::Posts::FindRaiseConditions.call [], comment: condition_before }.to raise_error({ comment_id: condition_after }.to_json)
       end

data/spec/support/helpers.rb

@@ -20,15 +20,15 @@ def wait_for_all_jobs_to_finish
   end
 end
 
-def wait_for_job_to_run(job_class, *args, &block)
-  job_class.call_async(*args).tap do |jid|
+def wait_for_job_to_run(job_class, *args, **kwargs, &block)
+  job_class.call_async(*args, **kwargs).tap do |jid|
     wait_for { worker_with_jid(jid) }
     block.call if block_given?
   end
 end
 
-def wait_for_job_to_run_and_finish(job_class, *args, &block)
-  wait_for_job_to_run(job_class, *args, &block).tap do |jid|
+def wait_for_job_to_run_and_finish(job_class, *args, **kwargs, &block)
+  wait_for_job_to_run(job_class, *args, **kwargs, &block).tap do |jid|
     wait_for { worker_with_jid(jid).nil? }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: services
 version: !ruby/object:Gem::Version
-  version: 8.0.1
+  version: 9.0.0
 platform: ruby
 authors:
 - Manuel Meurer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -156,14 +156,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: gem_config
   requirement: !ruby/object:Gem::Requirement
@@ -184,8 +184,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -193,7 +194,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/rails_5.2.gemfile
 - gemfiles/rails_6.0.gemfile
 - gemfiles/rails_6.1.gemfile
 - lib/services.rb
@@ -227,7 +227,7 @@ files:
 - spec/support/redis-server
 - spec/support/shared.rb
 - spec/support/test_services.rb
-homepage: http://manuelmeurer.github.io/services
+homepage: https://manuelmeurer.com/services/
 licenses:
 - MIT
 metadata: {}
@@ -239,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.5
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.travis.yml

@@ -1,15 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-services:
-  - redis-server
-before_install:
-  - gem update --system
-  - gem update bundler
-gemfile:
-  - gemfiles/rails_4.2.gemfile
-  - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.1.gemfile

data/gemfiles/rails_5.2.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 5.2.0"
-
-gemspec path: "../"