servitium 1.2.20

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tom@degrunt.nl. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+git_source(:entdec) { |repo_name| "git@github.com:#{repo_name}.git" }
+
+# Specify your gem's dependencies in servitium.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tom de Grunt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Servitium
+
+An implementation of the command pattern for Ruby
+
+## Features
+
+- Context validation
+- Callbacks
+
+  Context:
+
+  - before_validation
+  - after_validation
+
+  Services:
+
+  - before_perform
+  - around_perform
+  - after_perform
+
+- Transations
+  By default transactions are disabled, but you can include the following in your ApplicationService
+
+  ```ruby
+  transactional true
+  ```
+
+  In case transactions are enabled after_commit will triger after after_peform
+
+- Asynchronous execution
+  Instead of calling perform you can use perform_later to execute a service asynchronously, this uses ActiveJob.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'servitium'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install servitium
+
+## Usage
+
+See tests for usage examples.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Servitium project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/servitium/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'servitium'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/generators/servitium/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generates a service and context
+
+Example:
+    rails generate service Thing
+
+    This will create:
+        app/services/your_service.rb
+        app/services/your_context.rb

data/lib/generators/servitium/service_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Servitium
+  class ServiceGenerator < ::Rails::Generators::NamedBase
+    desc 'Generates a service and context'
+
+    source_root File.expand_path('templates', __dir__)
+
+    def copy_initializer_file
+      template 'service.rb', "app/services/#{file_name}_service.rb"
+      template 'context.rb', "app/services/#{file_name}_context.rb"
+      template 'service_test.rb', "test/services/#{file_name}_service_test.rb"
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class <%= name %>Context < ApplicationContext
+  attribute :some, type: :string, default: 'new'
+
+  validates :some, presence: true
+
+  before_validation do
+  end
+
+  after_validation do
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class <%= name %>Service < ApplicationService
+  before_perform do
+  end
+
+  after_perform do
+  end
+
+  def perform
+    context.some.reverse!
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class <%= name %>ServiceTest < ActiveSupport::TestCase
+  test 'service context result is success' do
+    context = <%=name%>Service.perform(some: 'some')
+    assert context.success?
+    assert_equal 'emos', context.some
+  end
+end

data/lib/servitium/capture_exceptions_mixin.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Servitium
+  module CaptureExceptionsMixin
+    class << self
+      def included(base)
+        base.extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def capture_exceptions(value = nil)
+        @capture_exceptions = value if value
+        @capture_exceptions = nil unless defined?(@capture_exceptions)
+        if @capture_exceptions.nil?
+          @capture_exceptions = if superclass < Servitium::Service
+                                  superclass.capture_exceptions
+                                else
+                                  false
+                                end
+        end
+        @capture_exceptions
+      end
+    end
+  end
+end

data/lib/servitium/context.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Servitium
+  class Context
+    extend ActiveModel::Callbacks
+
+    include Servitium::ContextModel
+
+    define_model_callbacks :initialize
+
+    attr_reader :errors
+
+    define_callbacks :perform
+
+    def initialize(*args)
+      @success     = true
+      @called      = false
+      @errors      = ActiveModel::Errors.new(self)
+      @subcontexts = {}
+
+      run_callbacks :initialize do
+        super(*args)
+      end
+    end
+
+    def success?
+      @called && @success
+    end
+
+    def failure?
+      !success?
+    end
+
+    alias fail? failure?
+    alias failed? failure?
+
+    def fail!(attr, message = :invalid, options = {})
+      @success = false
+      merge_errors!(attr, message, options)
+      raise ContextFailure, self
+    end
+
+    private
+
+    def merge_errors!(attr, message = :invalid, options = {})
+      return unless attr
+
+      if attr.is_a? String
+        errors.add(:base, attr)
+      elsif attr.is_a? ActiveModel::Errors
+        errors.merge!(attr)
+      elsif attr.is_a? Symbol
+        errors.add(attr, message, **options)
+      end
+    end
+
+    class << self
+      include Servitium::I18n
+
+      def human_attribute_name(attribute, options = {})
+        t(".#{attribute}", default: super)
+      end
+    end
+  end
+end

data/lib/servitium/context_failure.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Servitium
+  class ContextFailure < Servitium::Error
+    attr_reader :context
+
+    def initialize(context)
+      @context = context
+      super(context.errors.full_messages.join(', '))
+    end
+  end
+end

data/lib/servitium/context_model.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Servitium
+  module ContextModel
+    extend ActiveSupport::Concern
+
+    class_methods do
+      include Servitium::SubContexts
+    end
+
+    included do
+      include ActiveAttr::Model
+      include Servitium::I18n
+
+      delegate :input_attributes, :output_attributes, :other_attributes, to: :class
+
+      validate :validate_subcontexts
+      attr_accessor :supercontext
+
+      def initialize(*args)
+        @errors = ActiveModel::Errors.new(self)
+        @subcontexts = {}
+        super(*args)
+      end
+
+      def inspect
+        message = super
+        message += " (success: #{success?}, valid: #{@errors.size.zero?}, errors: #{@errors.full_messages.join(', ')})"
+        message
+      end
+
+      remove_method :model_name
+
+      def model_name
+        @model_name ||= ActiveModel::Name.new(self.class, nil, self.class.name.gsub('Context', ''))
+      end
+
+      def id
+        SecureRandom.uuid
+      end
+
+      # Convert the context model's attributes into a Hash, including the values of the subcontexts
+      # @return [Hash]
+      def attributes_hash
+        attributes.map do |key, value|
+          if value.is_a?(ContextModel)
+            [key, value.attributes_hash]
+          elsif value.is_a?(Array) && value.first.is_a?(ContextModel)
+            [key, value.map(&:attributes_hash)]
+          else
+            [key, value]
+          end
+        end.to_h
+      end
+
+      def _destroy; end
+
+      private
+
+      def validate_subcontexts
+        @subcontexts.each do |key, value|
+          errors.add(key, 'invalid') unless [*value].find_all { |v| v.respond_to?(:invalid?) && v.invalid? }.empty?
+        end
+      end
+
+      class << self
+        attr_reader :inbound_scope_used, :outbound_scope_used
+
+        def input(&block)
+          @inbound_scope_used = true
+          Servitium::ScopedAttributes.new(self, input_attributes, :in).call(block)
+        end
+
+        def output(&block)
+          @outbound_scope_used = true
+          Servitium::ScopedAttributes.new(self, output_attributes, :out).call(block)
+        end
+
+        def input_attributes
+          @input_attributes ||= []
+        end
+
+        def output_attributes
+          @output_attributes ||= []
+        end
+
+        def other_attributes
+          @other_attributes ||= attributes.keys - (input_attributes + output_attributes)
+        end
+      end
+    end
+  end
+end

data/lib/servitium/error.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Servitium
+  class Error < StandardError
+  end
+end

data/lib/servitium/i18n.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Servitium
+  module I18n
+    def t(key, passed_options = {})
+      @service_scope ||= nil
+
+      unless @service_scope.present?
+        parts = (is_a?(Class) ? self : self.class).to_s.underscore.gsub('/', '.').split('.')
+        parts[-1] = "#{parts.last.gsub('_service', '').pluralize}.service" if parts.last.end_with?('_service')
+        parts[-1] = "#{parts.last.gsub('_context', '').pluralize}.context" if parts.last.end_with?('_context')
+        @service_scope = parts.compact.join('.')
+      end
+
+      options = { scope: @service_scope }
+      options[:default] = ::I18n.t(key) unless key.start_with?('.')
+
+      ::I18n.t(key, **options.merge(passed_options))
+    end
+  end
+end

data/lib/servitium/rails/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rails'
+
+module Servitium
+  module Rails
+    class Railtie < ::Rails::Railtie
+      # config.eager_load_namespaces << Servitium
+    end
+  end
+end

data/lib/servitium/rails.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'servitium'
+require 'servitium/rails/railtie'

data/lib/servitium/scoped_attributes.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Servitium
+  class ScopedAttributes
+    attr_reader :context, :store, :validation_context
+
+    def initialize(context, store, validation_context = nil)
+      @context = context
+      @store = store
+      @validation_context = validation_context
+    end
+
+    def attribute(name, *args)
+      store << name.to_s
+      context.send(:attribute, name, *args)
+    end
+
+    def validates(name, options = {})
+      options[:on] ||= validation_context if validation_context
+      context.send(:validates, name, options)
+    end
+
+    def validate(name, options = {}, &block)
+      options[:on] ||= validation_context if validation_context
+      context.send(:validate, name, options, &block)
+    end
+
+    def call(block)
+      instance_exec(&block)
+    end
+  end
+end