servitium 1.2.20 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 583d111f0348dae63479a5dbb6d1dea714e17592eb03c9a8a0a07c84874af455
-  data.tar.gz: 259ab3b3110de03c89a3b50e95aa983433a6267aae0e2ee7ddaf093314dd3f1f
+  metadata.gz: fa6706af0892ab90d3f327cac1d97b5e6ed7b0c6e9fa6fa06484058d9733d78a
+  data.tar.gz: 0bf72aac0656de3572940cc6a40dbe3952eb406f7895a002994db1ad7987dc84
 SHA512:
-  metadata.gz: e240db38b1ba8c97a2fe898d77546d13474781ff8d5d2e1780eb75279bb5e45ed5afe2e4597de5e38526180a812a9eb1c7cfee90a9b923f9c994bf3dbb301f36
-  data.tar.gz: 700799659b4f0ae4106a8e22c5b9bcbacc93e01f119351fa19f5bbae9bd4af4e018185963e2451f092dd4a5f92d39e6ef2f706927f375b82721d8035a3b314b6
+  metadata.gz: 989ad0d166962653b196c3bdee84878b6f7143c8c190a2cddb9f635d65bb5f64e9555978ebc84a54d6f848f930b678f3b6e089cbceef9f60c52c62a408527d0a
+  data.tar.gz: aba51072b58ada34593d1d368f18e13d708f72d5f5cc5567cf4b1602d6750f7f52346ac4303aa3d8f7074a35a014875da8dc60f970c76a24ed06d57a70c43bf2

data/.github/workflows/gem-push.yml

@@ -0,0 +1,11 @@
+name: Rubygem Push
+on:
+  push:
+    tags:
+      - '*'
+jobs:
+  build:
+    uses: entdec/_workflows/.github/workflows/gem-push.yml@main
+    with:
+      public: true
+    secrets: inherit

data/.rubocop.yml

@@ -0,0 +1,14 @@
+# https://www.fastruby.io/blog/ruby/code-quality/how-we-use-rubocop-and-standardrb.html
+
+require:
+  - standard
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - node_modules/**/*
+    - public/**/*
+    - vendor/**/*

data/README.md

@@ -48,7 +48,69 @@ Or install it yourself as:
 
 ## Usage
 
-See tests for usage examples.
+You define a context for the service, which describes what goes in and out
+```ruby
+class ExampleContext < ApplicationContext
+  attribute :some, type: String, default: "new"
+
+  validates :some, presence: true
+end
+```
+
+You can be very explicit in what goes in our out:
+```ruby
+class ExampleContext < ApplicationContext
+  input do
+    attribute :some, type: String, default: "new"
+    validates :some, presence: true
+  end
+  output do
+    attribute :some, type: String, default: "new"
+  end
+end
+```
+
+And you define the service itself:
+```ruby
+class ExampleService < ApplicationService
+  def perform
+    context.some.reverse!
+  end
+end
+```
+
+You can also include the context in the service, for less complicated services:
+
+```ruby
+class ExampleService < ApplicationService
+  context do
+    attribute :some, type: :string, default: "new"
+  end
+  def perform
+    context.some.reverse!
+  end
+end
+```
+
+Next you use it as follows:
+```ruby
+ExampleService.perform(some: 'test').some # => tset
+```
+A service always returns it context
+
+Services can also run in the background:
+```ruby
+ExampleService.perform_later(some: 'test') # => #<ExampleContext>
+```
+
+You can use the generator to generate service code: 
+```
+❯ rails g servitium:service Example
+
+      create  app/services/example_service.rb
+      create  app/services/example_context.rb
+      create  test/services/example_service_test.rb
+```
 
 ## License
 

data/Rakefile

@@ -12,7 +12,3 @@ end
 Rake.add_rakelib 'lib/tasks'
 
 task default: :test
-
-# Adds the Auxilium semver task
-spec = Gem::Specification.find_by_name 'auxilium'
-load "#{spec.gem_dir}/lib/tasks/semver.rake"

data/lib/generators/servitium/templates/context.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class <%= name %>Context < ApplicationContext
-  attribute :some, type: :string, default: 'new'
+  attribute :some, type: String, default: 'new'
 
   validates :some, presence: true
 

data/lib/servitium/configuration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Servitium
+  class Configuration
+    attr_accessor :bg_jobs_platform
+    attr_writer :logger,
+
+    def initialize
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+
+      @bg_jobs_platform = :active_job
+    end
+
+    # logger [Object].
+    def logger
+      @logger.is_a?(Proc) ? instance_exec(&@logger) : @logger
+    end
+  end
+end

data/lib/servitium/context.rb

@@ -1,8 +1,13 @@
 # frozen_string_literal: true
 
+require 'active_model/naming'
+require 'active_model/translation'
+
 module Servitium
   class Context
     extend ActiveModel::Callbacks
+    extend ActiveModel::Naming
+    extend ActiveModel::Translation
 
     include Servitium::ContextModel
 

data/lib/servitium/service.rb

@@ -121,6 +121,14 @@ module Servitium
     end
 
     class << self
+      def perform_async(*args)
+        perform_later(*args)
+      end
+
+      def perform_sync(*args)
+        perform(*args)
+      end
+
       # Main point of entry for services, will raise in case of errors
       def perform!(*args)
         inst = new(*args)
@@ -147,10 +155,8 @@ module Servitium
       # Call the service returning the service instance
       def call(*args)
         inst = new(*args)
-
         valid_in = inst.context.valid?
         valid_in &&= inst.context.valid?(:in) if inst.context.class.inbound_scope_used
-
         if valid_in
           inst.context.instance_variable_set(:@called, true)
           inst.send(:call)
@@ -166,18 +172,53 @@ module Servitium
       # Perform this service async
       def perform_later(*args)
         inst = new(*args)
-
         valid_in = inst.context.valid?
         valid_in &&= inst.context.valid?(:in) if inst.context.class.inbound_scope_used
 
         if valid_in
           inst.context.instance_variable_set(:@called, true)
-          Servitium::ServiceJob.perform_later(name, inst.context.attributes_hash)
+
+          if Servitium.config.bg_jobs_platform == :sidekiq
+            formatted_args = JSON.load(JSON.dump(format_args(inst.context.attributes_hash)))
+            Servitium::ServiceSidekiqJob.set(queue: name.constantize.queue_name).perform_async(name, formatted_args)
+          else
+            Servitium::ServiceActiveJob.set(queue: name.constantize.queue_name).perform_later(name, inst.context.attributes_hash)
+          end
         end
 
         inst.context
       end
 
+      def format_args(hash)
+        hash.transform_values! do |v|
+          case v
+          when ActiveRecord::Base
+            v.id
+          when Hash
+            format_args(v)
+          when Array
+            format_array(v)
+          else
+            v
+          end
+        end
+      end
+
+      def format_array(array)
+        array.map do |ele|
+          case ele
+          when ActiveRecord::Base
+            ele.id
+          when Hash
+            format_args(ele)
+          when Array
+            format_array(ele)
+          else
+            ele
+          end
+        end
+      end
+
       def queue_name
         'default'
       end

data/lib/servitium/{service_job.rb → service_active_job.rb}

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
 module Servitium
-  class ServiceJob < ActiveJob::Base
-    queue_as { queue_name }
-
+  class ServiceActiveJob < ActiveJob::Base
     def perform(class_name, *args)
       service = class_name.constantize.call(*args)
 
@@ -13,9 +11,5 @@ module Servitium
         service.send(:async_failure)
       end
     end
-
-    def queue_name
-      arguments.first.constantize.queue_name
-    end
   end
 end

data/lib/servitium/service_sidekiq_job.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Servitium
+  class ServiceSidekiqJob
+    include Sidekiq::Job
+    def perform(class_name, *args)
+      service = class_name.constantize.call(*args)
+
+      if service.context.success?
+        service.send(:async_success)
+      else
+        service.send(:async_failure)
+      end
+    end
+  end
+end

data/lib/servitium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Servitium
-  VERSION = "1.2.20"
+  VERSION = "1.3.0"
 end

data/lib/servitium.rb

@@ -5,6 +5,7 @@ require 'active_attr'
 require 'active_support'
 require 'action_controller'
 require 'active_job'
+require 'sidekiq'
 
 require 'servitium/error'
 require 'servitium/context_failure'
@@ -13,8 +14,24 @@ require 'servitium/sub_contexts'
 require 'servitium/scoped_attributes'
 require 'servitium/context_model'
 require 'servitium/context'
-require 'servitium/service_job'
+require 'servitium/service_active_job'
+require 'servitium/service_sidekiq_job'
 require 'servitium/service'
 require 'servitium/version'
+require 'servitium/configuration'
 
 require 'servitium/rails' if defined?(::Rails)
+
+
+module Servitium
+  class << self
+    def setup
+      @config = Configuration.new
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

data/servitium.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'active_attr', '>= 0.15'
+  spec.add_dependency 'active_attr', '~> 0.15'
   spec.add_dependency 'activejob', '> 5.1'
   spec.add_dependency 'activemodel', '> 5.1'
   spec.add_dependency 'activerecord', '> 5.1'
@@ -40,6 +40,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-rails', '~> 0.3'
   spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rubocop', '~> 0.79'
+  spec.add_development_dependency 'rubocop', '~> 1'
+  spec.add_development_dependency 'standard', '~> 1'
   spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency 'sidekiq', '~> 7'
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: servitium
 version: !ruby/object:Gem::Version
-  version: 1.2.20
+  version: 1.3.0
 platform: ruby
 authors:
 - Tom de Grunt
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 2024-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
 - !ruby/object:Gem::Dependency
@@ -198,14 +198,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +234,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
 description: An implementation of the command pattern for Ruby
 email:
 - tom@degrunt.nl
@@ -227,7 +255,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/gem-push.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -243,6 +273,7 @@ files:
 - lib/generators/servitium/templates/service_test.rb
 - lib/servitium.rb
 - lib/servitium/capture_exceptions_mixin.rb
+- lib/servitium/configuration.rb
 - lib/servitium/context.rb
 - lib/servitium/context_failure.rb
 - lib/servitium/context_model.rb
@@ -252,7 +283,8 @@ files:
 - lib/servitium/rails/railtie.rb
 - lib/servitium/scoped_attributes.rb
 - lib/servitium/service.rb
-- lib/servitium/service_job.rb
+- lib/servitium/service_active_job.rb
+- lib/servitium/service_sidekiq_job.rb
 - lib/servitium/sub_contexts.rb
 - lib/servitium/transactional_mixin.rb
 - lib/servitium/version.rb
@@ -264,7 +296,7 @@ licenses:
 metadata:
   homepage_uri: https://entropydecelerator.com/components/servitium
   source_code_uri: https://code.entropydecelerator.com/components/servitium
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -279,8 +311,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Service objects
 test_files: []