mojones 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0e3e1098a30a3cb361430de99a97ede30f422ed06c4778d20f140bd313c7a3d
+  data.tar.gz: addc8a5acded5a911a9fd214a1983aeac71258a3d55e66f34e59f2ad7b18afba
+SHA512:
+  metadata.gz: 1705669f6ef6e3084bbe785385ebe343a8217825532255e0b48338eff104f6a2d1ba4e77e7dbd70666e43648030626833ffad5b45cc48e2c039a10f04bfdef91
+  data.tar.gz: 9907b26c7a0af8ccb7233a7f8c6830ae89ac4a806f963c21c41d88a652effa073b505769bacb480ab97448b950911a15b5c85612d77623184681fe375cc00bf0

data/lib/generators/mojones/service_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Mojones
+  module Generators
+    class ServiceGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_service_file
+        template "service.rb.tt", File.join("app/services", class_path, "#{file_name}.rb")
+      end
+    end
+  end
+end

data/lib/mojones/base.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module Mojones
+  class Base
+    include Dry::Monads[:result, :do]
+
+    module Errors
+      class NoHandlerMatched < StandardError
+        def initialize(value)
+          super
+          @value = value
+        end
+
+        def message = "No handler matched for #{@value.inspect}"
+      end
+
+      class ServiceReturnedNonResult < StandardError
+        def initialize(service, value)
+          super(value)
+          @service_name = service.class.inspect.sub(/^Mojones::/, "")
+          @value = value
+        end
+
+        def message
+          "Service #{@service_name} returned non-Result value (#{@value.inspect} : #{@value.class})"
+        end
+      end
+    end
+
+    class ReturnedValue
+      def initialize(value)
+        @value = value
+      end
+
+      def value!
+        @value
+      end
+
+      def fmap
+        yield @value
+      end
+
+      def success?
+        @value.success?
+      end
+
+      def failure?
+        @value.failure?
+      end
+
+      def original
+        @value.either(:itself.to_proc, :itself.to_proc)
+      end
+
+      def no_matches!
+        raise Errors::NoHandlerMatched, @value
+      end
+    end
+
+    class InitializerReturnedValue < ReturnedValue
+      def success? = true
+      def failure? = true
+      def original = @value
+
+      def assert_call_returned_result_monad_or_raised!
+        self
+      end
+    end
+
+    class CallReturnedValue < ReturnedValue
+      def initialize(service, value)
+        super(value)
+        @service = service
+        @value = value
+      end
+
+      def assert_call_returned_result_monad_or_raised!
+        return self if @value.is_a?(Dry::Monads::Result)
+
+        raise Errors::ServiceReturnedNonResult.new(@service, @value)
+      end
+    end
+
+    class RaisedError
+      def initialize(error)
+        @error = error
+      end
+
+      def success? = false
+      def failure? = true
+
+      def value!
+        raise @error
+      end
+
+      def original
+        @error
+      end
+
+      def fmap
+        self
+      end
+
+      def no_matches!
+        raise @error
+      end
+
+      def assert_call_returned_result_monad_or_raised!
+        self
+      end
+    end
+
+    def self.call(*args, **kwargs, &)
+      result = (
+        begin
+          InitializerReturnedValue.new(new(*args, **kwargs))
+        rescue StandardError => e
+          RaisedError.new(e)
+        end
+      ).fmap do |service_object|
+        CallReturnedValue.new(service_object, service_object.call)
+      rescue StandardError => e
+        RaisedError.new(e)
+      end.assert_call_returned_result_monad_or_raised!
+
+      return result.value! unless block_given?
+
+      Matcher.new(result, self, &).result
+    end
+  end
+end

data/lib/mojones/matcher.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module Mojones
+  class Matcher
+    class Match
+      attr_reader :matched, :result
+
+      def initialize(matched:, result:)
+        @matched = matched
+        @result = result
+      end
+
+      class Success < self; end
+      class Failure < self; end
+    end
+
+    def initialize(service_result, service)
+      @service = service
+      @service_result = service_result
+      @matches = []
+      yield(self) if block_given?
+    end
+
+    def result
+      return @service_result.no_matches! if @matches.empty?
+
+      @matches.last.result.tap do |chosen|
+        if @matches.size > 1
+          logger.debug <<~WARNING
+            #{service.name} matched multiple handlers; returning last result (#{chosen})
+          WARNING
+        end
+      end
+    end
+
+    def success(*match_values, &block)
+      return unless @service_result.success?
+
+      value = @service_result.original
+
+      return unless match_values.empty? || match_values.any? { _1 === value } # rubocop:disable Style/CaseEquality
+
+      @matches << Match::Success.new(
+        matched: value,
+        result: block.call(value)
+      )
+    end
+
+    def failure(*match_errors, &block)
+      return unless @service_result.failure?
+
+      error = @service_result.original
+
+      return unless match_errors.empty? || match_errors.any? { _1 === error } # rubocop:disable Style/CaseEquality
+
+      translated = translate_error(error)
+
+      @matches << Match::Failure.new(
+        matched: error,
+        result: block.arity == 2 ? block.call(error, translated) : block.call(translated)
+      )
+    end
+
+    private
+
+    attr_reader :service
+
+    def logger
+      @logger ||= defined?(Rails) ? Rails.logger : Logger.new($stdout)
+    end
+
+    def service_name_lookup
+      @service_name_lookup ||= service.name.gsub("::", ".").underscore
+    end
+
+    def translate_error(error)
+      return error.to_s unless defined?(I18n)
+
+      key =
+        case error
+        when Symbol
+          error
+        when StandardError
+          error.class.name.gsub("::", ".").underscore
+        end
+
+      default =
+        case error
+        when Symbol then error.to_s.humanize
+        when StandardError then error.message
+        end
+
+      I18n.t("#{service_name_lookup}.#{key}", default: default)
+    end
+  end
+end

data/lib/mojones/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Mojones
+  VERSION = "0.1.0"
+end

data/lib/mojones.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "dry/monads"
+require "dry/monads/do"
+
+require_relative "mojones/base"
+require_relative "mojones/matcher"
+require_relative "mojones/version"

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: mojones
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Phil Brockwell
+- Habib Alamin
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: A lightweight framework for Ruby service objects using Dry::Monads with
+  enforced result types and matching.
+email:
+- phil@trueflux.agency
+- habib@trueflux.agency
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generators/mojones/service_generator.rb
+- lib/mojones.rb
+- lib/mojones/base.rb
+- lib/mojones/matcher.rb
+- lib/mojones/version.rb
+homepage: https://trueflux.agency
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Service objects with monadic result handling
+test_files: []