zen-service 1.0.0

data/lib/zen/service/plugins/plugin.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Zen
+  module Service::Plugins
+    module Plugin
+      def self.extended(plugin)
+        name = plugin.name.sub(/^.*::/, "").gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase.to_sym
+
+        Service::Plugins.register(name, plugin)
+      end
+
+      def register_as(name)
+        Service::Plugins.register(name, self)
+      end
+
+      def default_options(options)
+        config[:default_options] = options
+      end
+
+      def service_extension(extension)
+        ::Zen::Service.send(:extend, extension)
+      end
+
+      def config
+        @config ||= {}
+      end
+    end
+  end
+end

data/lib/zen/service/plugins/policies.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Zen
+  module Service::Plugins
+    module Policies
+      extend Plugin
+
+      GuardViolationError = Class.new(StandardError)
+
+      def self.used(service_class, *)
+        service_class.partials = []
+      end
+
+      private def execute!
+        partials.each_with_object({}) do |partial, permissions|
+          partial.public_methods(false).grep(/\?$/).each do |action_check|
+            key = action_check.to_s[0...-1]
+            can = partial.public_send(action_check)
+
+            permissions[key] = permissions.key?(key) ? permissions[key] && can : can
+          end
+        end
+      end
+
+      def can?(action)
+        why_cant?(action).nil?
+      end
+
+      def guard!(action)
+        reason = why_cant?(action)
+
+        return if reason.nil?
+
+        raise(reason) if (reason.is_a?(Class) ? reason : reason.class) < Exception
+
+        raise(GuardViolationError, reason)
+      end
+
+      def why_cant?(action)
+        action_check = "#{action}?"
+
+        reason =
+          partials
+          .find { |p| p.respond_to?(action_check) && !p.public_send(action_check) }
+            &.class
+            &.denial_reason
+
+        reason.is_a?(Proc) ? instance_exec(&reason) : reason
+      end
+
+      private def partials
+        @partials ||= self.class.partials.map do |klass|
+          klass.from(self)
+        end
+      end
+
+      module ClassMethods
+        attr_accessor :partials, :denial_reason
+
+        def deny_with(reason, &block)
+          partial = Class.new(self, &block)
+          partial.denial_reason = reason
+          partials << partial
+        end
+      end
+    end
+  end
+end

data/lib/zen/service/plugins/rescue.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Zen
+  module Service::Plugins
+    module Rescue
+      extend Plugin
+
+      def self.used(service_class, *)
+        service_class.use(:status) unless service_class.using?(:status)
+        service_class.add_execution_prop(:error)
+      end
+
+      def execute(**opts)
+        rezcue = opts.delete(:rescue)
+        super
+      rescue StandardError => e
+        clear_execution_state!
+        failure!(status: :error)
+        state.error = e
+        raise e unless rezcue
+
+        self
+      end
+
+      def error
+        state.error
+      end
+
+      def error?
+        status == :error
+      end
+    end
+  end
+end

data/lib/zen/service/plugins/status.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Zen
+  module Service::Plugins
+    module Status
+      extend Plugin
+
+      default_options(success: [], failure: [])
+
+      def self.used(service_class, **)
+        service_class.add_execution_prop(:status)
+
+        helpers = Module.new
+        service_class.const_set(:StatusHelpers, helpers)
+        service_class.send(:include, helpers)
+      end
+
+      def self.configure(service_class, success:, failure:)
+        service_class::StatusHelpers.module_eval do
+          success.each do |name|
+            define_method(name) do |**opts, &block|
+              success(status: name, **opts, &block)
+            end
+          end
+
+          failure.each do |name|
+            define_method(name) do |**opts, &block|
+              failure(status: name, **opts, &block)
+            end
+          end
+        end
+      end
+
+      def status
+        state.status
+      end
+
+      private def success!(status: :success, **)
+        state.status = status
+        super
+      end
+
+      private def success(status: :success, **)
+        state.status = status
+        super
+      end
+
+      private def failure!(status: :failure, **)
+        state.status = status
+        super
+      end
+
+      private def failure(status: :failure, **)
+        super.tap do
+          state.status = status
+        end
+      end
+
+      private def result_with(*)
+        super
+        state.status ||= state.success ? :success : :failure
+      end
+    end
+  end
+end

data/lib/zen/service/plugins/validation.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Zen
+  module Service::Plugins
+    module Validation
+      extend Plugin
+
+      class Errors < Hash
+        def add(key, message)
+          (self[key] ||= []).push(message)
+        end
+      end
+
+      default_options(errors_class: Errors)
+
+      def self.used(service_class, *)
+        service_class.add_execution_prop(:errors)
+      end
+
+      private def initialize(*)
+        super
+        state.errors = errors_class.new
+      end
+
+      def execute(*)
+        return super if valid?
+
+        failure!(status: :invalid)
+
+        self
+      end
+
+      def errors
+        state.errors
+      end
+
+      private def errors_class
+        self.class.plugins[:validation].options[:errors_class]
+      end
+
+      private def validate!
+        errors.clear
+        validate
+      end
+
+      def validate; end
+
+      def valid?
+        validate!
+        errors.empty?
+      end
+
+      private def clear_execution_state!
+        super
+        state.errors = errors_class.new
+      end
+    end
+  end
+end

data/lib/zen/service/spec_helpers.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Zen
+  module Service::SpecHelpers
+    def self.included(target)
+      target.extend(ClassMethods)
+    end
+
+    # Example:
+    #   stub_service(MyService)
+    #     .with_atributes(foo: 'foo')
+    #     .with_stubs(result: 'bar', success: true)
+    #     .service
+    def stub_service(service)
+      ServiceMocker.new(self).stub_service(service)
+    end
+
+    module ClassMethods
+      def service_context(&block)
+        around do |example|
+          ::Zen::Service.with_context(instance_exec(&block)) do
+            example.run
+          end
+        end
+      end
+    end
+
+    class ServiceMocker < SimpleDelegator
+      attr_reader :service_class, :service
+
+      def stub_service(service_class) # rubocop:disable Metrics/AbcSize
+        @service_class = service_class
+        @service = double(service_class.name)
+
+        allow(service_class).to receive(:new).and_return(service)
+        allow(service).to receive(:execute).and_return(service)
+        allow(service).to receive(:executed?).and_return(true)
+
+        self
+      end
+
+      def with_attributes(*attributes)
+        expect(service_class).to receive(:new).with(*attributes).and_return(service)
+
+        self
+      end
+
+      def with_stubs(stubs)
+        stubs[:success?] = !!stubs[:result] unless stubs.key?(:success)
+        stubs[:failure?] = !stubs[:success?]
+
+        stubs.each do |name, value|
+          allow(service).to receive(name).and_return(value)
+        end
+
+        self
+      end
+    end
+  end
+end

data/lib/zen/service/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Zen
+  class Service
+    VERSION = "1.0.0"
+  end
+end

data/zen-service.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/zen/service/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zen-service"
+  spec.version       = Zen::Service::VERSION
+  spec.authors       = ["Artem Kuzko"]
+  spec.email         = ["a.kuzko@gmail.com"]
+
+  spec.summary       = "Essence of service objects pattern"
+  spec.description   = "Flexible and highly extensible Services for business logic organization"
+  spec.homepage      = "https://github.com/akuzko/zen-service"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/akuzko/zen-service.git"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "rubocop", "~> 0.80"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: zen-service
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Artem Kuzko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+description: Flexible and highly extensible Services for business logic organization
+email:
+- a.kuzko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zen/service.rb
+- lib/zen/service/plugins.rb
+- lib/zen/service/plugins/assertions.rb
+- lib/zen/service/plugins/attributes.rb
+- lib/zen/service/plugins/context.rb
+- lib/zen/service/plugins/executable.rb
+- lib/zen/service/plugins/execution_cache.rb
+- lib/zen/service/plugins/pluggable.rb
+- lib/zen/service/plugins/plugin.rb
+- lib/zen/service/plugins/policies.rb
+- lib/zen/service/plugins/rescue.rb
+- lib/zen/service/plugins/status.rb
+- lib/zen/service/plugins/validation.rb
+- lib/zen/service/spec_helpers.rb
+- lib/zen/service/version.rb
+- zen-service.gemspec
+homepage: https://github.com/akuzko/zen-service
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/akuzko/zen-service
+  source_code_uri: https://github.com/akuzko/zen-service.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Essence of service objects pattern
+test_files: []