on_strum-service 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 696f119acc51ed572b6d30d377e94fd6c403682f0b0b70f3e9f6d6c7c28d56a1
+  data.tar.gz: c3b13982bb28f3b082e3a0d28fbcb63999f6997ccd10a9a03d76eabcfc3d8902
+SHA512:
+  metadata.gz: 5251dc7e864e3c73e68d1bcb3dbadc2d7e6ad67b70edf1e758d2f97b0a0ff9426e54c0bf41cb4824c2a1106ecc3ad120c882617b7b070783af9649e68fc2f26a
+  data.tar.gz: 5cddb35de5cd273d962396edce2e7b95f7c09074452dacb6de19b7fc60833fe14d77be8a9a3013f4f3fbc99bb2aa1e2401e273bac0c9abc52818db7539a88276

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 onStrum and friends
+
+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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'on_strum/service'
+
+# 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/on_strum/service/class_methods.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Service
+    module ClassMethods
+      def call(ctx, **args, &block)
+        new(ctx, **args).execute(&block)
+      end
+    end
+  end
+end

data/lib/on_strum/service/core.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Service
+    module Error
+      require_relative 'error/runtime'
+    end
+
+    require_relative 'version'
+    require_relative 'class_methods'
+    require_relative 'instance_methods'
+    require_relative '../service'
+  end
+end

data/lib/on_strum/service/error/runtime.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Service
+    module Error
+      class Runtime < ::RuntimeError
+        NOT_IMPLEMENTED = 'call method must be implemented'
+      end
+    end
+  end
+end

data/lib/on_strum/service/instance_methods.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Service
+    module InstanceMethods
+      COERCIVE_METHODS = %i[add_error add_errors any required sliced sliced_list].freeze
+      DEFAULT_CTX_KEY = :default
+
+      def initialize(ctx, **args)
+        self.errors = ::Hash.new { |hash, key| hash[key] = [] }
+        self.handlers = { on: {}, success: {}, failure: {} }
+        self.outputs = {}
+        self.inputs = args.merge(OnStrum::Service::InstanceMethods::DEFAULT_CTX_KEY => ctx)
+        self.inputs_snapshot = inputs.dup.freeze
+        init_default_proc
+      end
+
+      def execute
+        catch(:exit) do
+          yield(self) if block_given?
+          audit
+          call if valid?
+        end
+        valid? ? valid_result : invalid_result
+      end
+
+      def hook(name, data = self)
+        handlers_on_name = handlers.dig(:on, name)
+        handlers_on_name.is_a?(::Proc) && handlers_on_name.call(data)
+      end
+
+      def valid?
+        errors.empty?
+      end
+
+      def on(direction, &block)
+        handlers[:on][direction] = block
+      end
+
+      def success(direction = nil, &block)
+        handlers[:success][direction] = block
+      end
+
+      def failure(direction = nil, &block)
+        handlers[:failure][direction] = block
+      end
+
+      def method_missing(method_name, *_args, &_block)
+        if from_input?(method_name)
+          input[method_name]
+        elsif from_inputs?(method_name)
+          inputs[method_name]
+        else
+          super
+        end
+      end
+
+      def respond_to_missing?(method_name, include_private = false)
+        from_input?(method_name) || from_inputs?(method_name) || super
+      end
+
+      protected
+
+      attr_accessor :inputs, :inputs_snapshot, :errors, :outputs, :handlers
+
+      def input
+        inputs[OnStrum::Service::InstanceMethods::DEFAULT_CTX_KEY]
+      end
+
+      def input=(value)
+        inputs[OnStrum::Service::InstanceMethods::DEFAULT_CTX_KEY] = value
+      end
+
+      def input_snapshot
+        inputs_snapshot[OnStrum::Service::InstanceMethods::DEFAULT_CTX_KEY]
+      end
+
+      def args
+        inputs.slice(*inputs.keys - [OnStrum::Service::InstanceMethods::DEFAULT_CTX_KEY])
+      end
+
+      def output_value(key = OnStrum::Service::InstanceMethods::DEFAULT_CTX_KEY)
+        @outputs[key]
+      end
+
+      def output(key = OnStrum::Service::InstanceMethods::DEFAULT_CTX_KEY, value) # rubocop:disable Style/OptionalArguments
+        @outputs[key] = value
+      end
+
+      def add_error(field, value)
+        errors[field] += Array(value)
+      end
+
+      def add_errors(errors)
+        errors.each { |field, value| add_error(field, value) }
+      end
+
+      def required(*keys)
+        return add_error(:input, :must_be_hash) unless input_hash?
+
+        (keys - service_keys).each { |key| add_error(key, :field_must_exist) }
+      end
+
+      def any(*keys)
+        return add_error(:input, :must_be_hash) unless input_hash?
+
+        add_error(:input, :any_field_must_exist) if (keys & service_keys).empty?
+      end
+
+      def sliced(*keys)
+        return add_error(:input, :must_be_hash) unless input_hash?
+
+        self.input = input.merge(args).slice(*keys)
+      end
+
+      def sliced_list(*keys)
+        add_error(:input, :must_be_array) && return unless input.is_a?(::Array)
+        add_error(:input_subitem, :must_be_hash) && return unless input.all?(::Hash)
+
+        self.input = input.map { |item| item.slice(*keys) }
+      end
+
+      def service_keys
+        input.keys | args.keys
+      end
+
+      OnStrum::Service::InstanceMethods::COERCIVE_METHODS.each do |method_name|
+        define_method(:"#{method_name}!") do |*args, **kwargs, &block|
+          send(method_name, *args, **kwargs, &block)
+          throw :exit unless valid?
+        end
+      end
+
+      private
+
+      def method_s_sym(method_name)
+        [method_name.to_s, method_name.to_sym]
+      end
+
+      def from_input?(method_name)
+        method_key, method_sym = method_s_sym(method_name)
+        args.empty? && input_hash? && (input.key?(method_key) || input.key?(method_sym))
+      end
+
+      def from_inputs?(method_name)
+        method_key, method_sym = method_s_sym(method_name)
+        inputs.key?(method_key) || inputs.key?(method_sym)
+      end
+
+      def input_hash?
+        input.is_a?(::Hash)
+      end
+
+      def default_proc
+        proc do |hash, key| # string lookup in case accessing to hash by symbol
+          key = key.to_s
+          hash.key?(key) ? hash[key] : nil
+        end
+      end
+
+      def init_default_proc
+        inputs.default_proc = default_proc
+        input.default_proc = default_proc if input_hash?
+      end
+
+      def handler_key
+        ((outputs.keys << nil) & handlers[:success].keys).first
+      end
+
+      def valid_result
+        result = outputs[handler_key] || outputs[OnStrum::Service::InstanceMethods::DEFAULT_CTX_KEY]
+        handler = handlers[:success][handler_key]
+        return result unless handler.is_a?(::Proc)
+
+        handler.call(result)
+      end
+
+      def invalid_result
+        handlers_failure = handlers[:failure]
+        handler = handlers_failure[((errors.values.flatten << nil) & handlers_failure.keys).first]
+        handler.call(errors) if handler.is_a?(::Proc)
+      end
+    end
+  end
+end

data/lib/on_strum/service/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Service
+    VERSION = '1.0.0'
+  end
+end

data/lib/on_strum/service.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Service
+    def self.included(base)
+      base.extend(OnStrum::Service::ClassMethods)
+      base.prepend(OnStrum::Service::InstanceMethods)
+    end
+
+    def audit; end
+
+    def call
+      raise OnStrum::Service::Error::Runtime, OnStrum::Service::Error::Runtime::NOT_IMPLEMENTED
+    end
+  end
+end

data/lib/on_strum.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OnStrum
+  module Service
+    require_relative 'on_strum/service/core'
+  end
+end

data/on_strum-service.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/on_strum/service/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'on_strum-service'
+  spec.version     = OnStrum::Service::VERSION
+  spec.authors     = ['Serhiy Nazarov']
+  spec.email       = %w[admin@on-strum.org]
+
+  spec.summary     = %(on_strum-service)
+  spec.description = %(Abstract class for service object scaffolding)
+
+  spec.homepage    = 'https://github.com/on-strum/ruby-on-strum-service'
+  spec.license     = 'MIT'
+
+  spec.metadata    = {
+    'homepage_uri'      => 'https://github.com/on-strum/ruby-on-strum-service',
+    'changelog_uri'     => 'https://github.com/on-strum/ruby-on-strum-service/blob/master/CHANGELOG.md',
+    'source_code_uri'   => 'https://github.com/on-strum/ruby-on-strum-service',
+    'documentation_uri' => 'https://github.com/on-strum/ruby-on-strum-service/blob/master/README.md',
+    'bug_tracker_uri'   => 'https://github.com/on-strum/ruby-on-strum-service/issues'
+  }
+
+  spec.required_ruby_version = '>= 2.5.0'
+  spec.files = `git ls-files -z`.split("\x0").select { |f| f.match(%r{^(bin|lib)/|.ruby-version|on_strum-service.gemspec|LICENSE}) }
+  spec.require_paths = %w[lib]
+
+  spec.add_development_dependency 'ffaker', '~> 2.21'
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: on_strum-service
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Serhiy Nazarov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.21'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: Abstract class for service object scaffolding
+email:
+- admin@on-strum.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- LICENSE.txt
+- bin/console
+- bin/setup
+- lib/on_strum.rb
+- lib/on_strum/service.rb
+- lib/on_strum/service/class_methods.rb
+- lib/on_strum/service/core.rb
+- lib/on_strum/service/error/runtime.rb
+- lib/on_strum/service/instance_methods.rb
+- lib/on_strum/service/version.rb
+- on_strum-service.gemspec
+homepage: https://github.com/on-strum/ruby-on-strum-service
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/on-strum/ruby-on-strum-service
+  changelog_uri: https://github.com/on-strum/ruby-on-strum-service/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/on-strum/ruby-on-strum-service
+  documentation_uri: https://github.com/on-strum/ruby-on-strum-service/blob/master/README.md
+  bug_tracker_uri: https://github.com/on-strum/ruby-on-strum-service/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: on_strum-service
+test_files: []