easy_monad 0.0.9 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78550feeca682ba33f20b7050071d3842eeccd847b3b319c90a86ec4bd429ebb
-  data.tar.gz: dae5536d6035f67546136f12ffe1fc52d602bdffc8dd5eeba120fec2313c4cd7
+  metadata.gz: 6f1c4f41cf83d60e4fc8ce5cfb32fe96045049f1a30a93bdcc977c1dcfd2323b
+  data.tar.gz: faec7d0b656d2d0d4c82a2156788c791ca3432a1cd4c0b8b3639f237c2b58abc
 SHA512:
-  metadata.gz: 4df38565173d60444699897fd5326c30464fd9bfa23de7c9025cce0ece5a8a9416ce68674a57dd534f3484dd7c1b2195285c8a6802660267f2cb97cec20294b1
-  data.tar.gz: 8cf8d948c812075b068479e25737a0d43999831f2dea87a018d6d62fe8c1049d96bb27076f88173ed91d4bd4ae1939669d768402ee9e8ce8e5c215c14014d909
+  metadata.gz: 63f5ff5e17720c96320463956fd12f4b92d5017d8034280303537958db0ea05583320d5f5a89ea859fbc762d38e261fb741a2d494ddd57d3d7a3137bbe904815
+  data.tar.gz: 4f4b2e8e3ac21a33a092ddd949a0358b26a585f903f6a39383843658cc3c0974fc8db516907f993513c9ac9d381d8f7186421d28eaf1a3961c2799dfd2663a7c

data/lib/configuration.rb

@@ -0,0 +1,30 @@
+module EasyMonad
+  class Configuration
+    class << self
+      attr_accessor :logger,
+                    :using_modules,
+                    :filter_parameters,
+                    :rails_environment,
+                    :configured
+
+      def set_defaults
+        require 'logger'
+
+        @logger = ::Logger.new(STDOUT)
+        @using_modules = [:params_sanitizer, :logging, :i18n]
+        @filter_parameters = %w[
+          password
+          password_confirmation
+          secret
+          password_salt
+        ]
+      end
+
+      def configure
+        yield self
+
+        @configured = true
+      end
+    end
+  end
+end

data/lib/easy_monad.rb

@@ -0,0 +1,23 @@
+require_relative 'configuration'
+
+require_relative 'modules/params_sanitizer'
+require_relative 'modules/i18n'
+require_relative 'modules/logging'
+
+require_relative 'operation'
+require_relative 'errors'
+
+module EasyMonad
+  def self.str_to_const(str)
+    eval(str.split('_').map(&:capitalize).unshift('Modules::').join)
+  end
+
+  Configuration.rails_environment = !!defined?(Rails)
+  Configuration.set_defaults unless Configuration.configured
+
+  Configuration.using_modules.each do |mod|
+    raise ArgumentError, 'Included Module must be a Symbol!' unless mod.is_a?(Symbol)
+
+    Operation.include str_to_const(mod.to_s)
+  end
+end

data/lib/errors.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module EasyMonad
+  class Errors < Hash
+    def add(key, value)
+      self[key] ||= value
+    end
+
+    def to_a
+      map { |key, val| "#{key}: #{val}" }
+    end
+
+    def to_s
+      to_a.join(', ')
+    end
+
+    def only_messages
+      values.flatten.map { _1.delete(':') }
+    end
+  end
+end

data/lib/modules/i18n.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module EasyMonad
+  module Modules
+    module I18n
+      def desc(error)
+        ::I18n.t("operations.#{self.class.name.underscore.gsub('/', '.')}.#{error}")
+      end
+    end
+  end
+end

data/lib/modules/logging.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative 'params_sanitizer'
+
+module EasyMonad
+  module Modules
+    module Logging
+      def self.included(base)
+        base.singleton_class.prepend(ClassMethods)
+      end
+
+      module ClassMethods
+        def call(*, **)
+          operation = new(*, **)
+
+          operation.within_early_exit_block do
+            operation.memoize_start_time
+            operation.log_start(operation)
+            operation.call
+            operation.log_end(operation)
+
+            operation
+          end
+        end
+      end
+
+      def log_start(operation)
+        logger.info "Operation #{operation.class.name} starts params: #{operation.params_for_logging(operation.params)}"
+      end
+
+      def log_end(operation)
+        logger.info "Operation #{operation.class.name} ends. Took: #{duration_from_start_in_secs} sec, params: #{operation.params_for_logging(operation.params)}"
+      end
+
+      def log_critical_error(operation)
+        logger.error "Operation #{operation.class.name} ends with error. Took: #{duration_from_start_in_secs} sec, params: #{operation.params_for_logging(operation.params)}, errors: #{operation.errors.to_a}"
+      end
+
+      def log_error(operation)
+        logger.error "Operation #{operation.class.name} has errors: #{operation.errors.to_a} params: #{operation.params_for_logging(operation.params)}"
+      end
+
+      def memoize_start_time
+        @start_time = cpu_clock_now
+      end
+
+      private
+
+      def duration_from_start_in_secs
+        (cpu_clock_now - @start_time).floor(2)
+      end
+
+      def logger
+        @logger ||= Configuration.logger
+      end
+
+      def cpu_clock_now
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+  end
+end

data/lib/modules/params_sanitizer.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module EasyMonad
+  module Modules
+    module ParamsSanitizer
+      def params_for_logging(params)
+        regex = /(#{filter_parameters.join('|')})":"([^"]*)"/
+        hashed_params(params).inspect.gsub(regex, '\1":"[FILTERED]"')
+      end
+
+      private
+
+      def hashed_params(params)
+        if Configuration.rails_environment
+          params.is_a?(ActionController::Parameters) ? params.to_unsafe_h : params.to_h
+        else
+          params.to_h
+        end
+      end
+
+      def filter_parameters
+        if Configuration.rails_environment
+          Rails.configuration.filter_parameters += Configuration.filter_parameters
+        else
+          Configuration.filter_parameters
+        end
+      end
+    end
+  end
+end

data/lib/operation.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module EasyMonad
+  class Operation
+    attr_reader :params
+    attr_accessor :result, :errors
+
+    def initialize(params, errors = Errors.new)
+      @params = params
+      @errors = errors
+    end
+
+    class << self
+      def call(*, **)
+        operation = new(*, **)
+
+        operation.within_early_exit_block do
+          operation.call
+
+          operation
+        end
+      end
+
+      alias [] call
+    end
+
+    def result!
+      return result if success?
+
+      raise ProcessError, self
+    end
+
+    def failure?
+      errors.any?
+    end
+
+    def success?
+      errors.empty?
+    end
+
+    def within_early_exit_block(&)
+      catch(:critical, &)
+    end
+
+    def call
+      raise NotImplementedError, "You must implement #call by yourself!"
+    end
+
+    protected
+
+    def join(other)
+      other.errors.each do |error, description|
+        error(error, description)
+      end
+
+      other
+    end
+
+    def strict_join!(other)
+      other.errors.each do |error, description|
+        critical_error!(error, description)
+      end
+
+      other
+    end
+
+    # stubs for Logging and ParamsSanitizer mudules
+    def log_error(_) = nil
+    def log_critical_error(_) = nil
+    def params_for_logging(params) = params
+
+    private
+
+    def error(error, description = nil)
+      errors.add(error, description || 'Something went wrong')
+      log_error(self)
+    end
+
+    def critical_error!(error, description = nil)
+      errors.add(error, description || 'Something went wrong')
+      log_critical_error(self)
+      throw(:critical, self)
+    end
+  end
+
+  class ProcessError < StandardError
+    attr_reader :operation, :message
+
+    def initialize(operation)
+      super
+      @operation = operation
+      @message = "#{operation.class} Process Error"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easy_monad
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - T.Zhuk
@@ -15,7 +15,14 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/configuration.rb
+- lib/easy_monad.rb
+- lib/errors.rb
+- lib/modules/i18n.rb
+- lib/modules/logging.rb
+- lib/modules/params_sanitizer.rb
+- lib/operation.rb
 licenses:
 - MIT
 metadata: