action_processor 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4771896f3d4045a45c5b2913c6eecb27f17d9814f027ac6faa343fba0fb3cc04
+  data.tar.gz: 3212b5d960508dc66eb1ddfeb7b1f1bec9617d3bedfffda59e8332454af002e8
+SHA512:
+  metadata.gz: b277de0643b7abff6121730e1e44fe5a556bc5e0d303c3408c0b39fcffaa5365ff9505632a67a37495662acc386484b8d96f6bdaa50d721d7076bd53ad89bd41
+  data.tar.gz: c3ed077263b9ab97812052e99d4288de3236b02182f19b98a396375b6eb35760f38c75fe64bea59ba99a57673c92ab4287f7cf9add4c25b54c23e449f69615d4

data/lib/action_processor/base.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/indifferent_access"
+require "active_record"
+
+module ActionProcessor 
+  class Base
+    attr_reader :params, :errors
+
+    def self.run(params = {})
+      inst = new(params)
+      inst.run
+      inst
+    end
+
+    def initialize(params = {})
+      @params = if params.class.name == 'Hash'
+                  params.with_indifferent_access
+                else
+                  params
+                end
+      @errors = ActionProcessor::Errors.new
+      @steps_stack = []
+      @transaction_level = ActiveRecord::Base.connection.open_transactions
+    rescue ActiveRecord::ConnectionNotEstablished
+      @transaction_level = nil
+    end
+
+    def run
+      raise 'Error: method "run" should be overridden to implement business logic!'
+    end
+
+    def errors?
+      @errors.all.any?
+    end
+
+    def success?
+      @errors.all.empty?
+    end
+
+    def json_outcome
+      errors? ? failed_json : successful_json
+    end
+
+    # in most cases should be overriden to provide relevant data
+    def successful_json
+      { success: true }
+    end
+
+    # could be overriden to provide some specifics/advices/etc.
+    def failed_json
+      { success: false, errors: errors.grouped_by_attribute }
+    end
+
+    def step(step_method, **options)
+      return if errors? # skip it if there are errors
+
+      step_always(step_method, **options)
+    end
+
+    def step_always(step_method, **options)
+      @steps_stack << (@current_step || :not_specified)
+      @current_step = step_method
+      # performs even if there are errors
+      # useful for: 
+      #  - validation steps to return list of all errors
+      #  - errors reporting and making decisions at the end of processing
+      send step_method, **options
+      @current_step = @steps_stack.pop
+    end
+
+    # As an "errs" params we could pass several types:
+    # - String with error description
+    # - array of Strings (error messages)
+    # - ActiveRecord model (invalid) - its errors will be copied
+    def fail!(errs, attr = :not_specified)
+      if errs.class.ancestors.map(&:to_s).include?("ActiveRecord::Base")
+        fail_active_record!(errs)
+      else
+        @errors.add(errs, @current_step, attr)
+      end
+
+      raise ActiveRecord::Rollback if in_transaction?
+    end
+
+    private
+
+    # simple params presence validation
+    # will initiate errors for each absent params
+    def required_params(*list)
+      list.flatten!
+      @list_of_allowed_params ||= []
+      @list_of_allowed_params += list.map(&:to_s)
+      list.map(&:to_s).each do |param|
+        next if params[param].present?
+
+        fail! "Parameter :#{param} should be present", param
+      end
+    end
+
+    # allowed params (in addition to required_params)
+    # if allowed_params present method called, all params
+    # provided to Processor which are not included in
+    # lists specified for required_params and allowed_params
+    # will cause validation error
+    def allowed_params(*list)
+      list.flatten!
+      @list_of_allowed_params ||= []
+      @list_of_allowed_params += list.map(&:to_s)
+
+      params.each do |key, value|
+        next if @list_of_allowed_params.index(key.to_s).present?
+
+        fail! "Parameter :#{key} is not allowed", key.to_sym
+      end
+    end
+
+    def fail_active_record!(record)
+      record.errors.each do |err|
+        fail! "#{err.attribute.to_s.humanize} #{err.message}", err.attribute
+      end
+    end
+
+    def in_transaction?
+      return false if @transaction_level.nil?
+
+      ActiveRecord::Base.connection.open_transactions > @transaction_level
+    end
+  end
+end

data/lib/action_processor/errors.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/indifferent_access"
+
+module ActionProcessor
+  class Errors
+    attr_reader :all
+
+    def initialize
+      @all = []
+    end
+
+    def add(messages, step = :not_specified, attribute = :not_specified)
+      step ||= :not_specified # in case we will receive explicit nil as step parameter
+      @all << { messages: [messages].flatten, step: step.to_sym, attribute: attribute.to_sym }
+    end
+
+    # returns array of strings with user friendly error messages
+    def messages
+      all_messages = []
+      @all.each do |e|
+        all_messages += e[:messages]
+      end
+      all_messages
+    end
+
+    alias full_messages messages  # for compatibility with ActiveRecord::Errors
+
+    def for_attribute(attr)
+      @grouped_by_attribute[attr] 
+    end
+
+    def grouped_by_attribute
+      return @grouped_by_attribute if @grouped_by_attribute.present?
+
+      # we assume that all errors will be present 
+      # at the time when this method called first time
+      @grouped_by_attribute = {}.with_indifferent_access
+      @all.each do |err|
+        @grouped_by_attribute[err.attribute] ||= []
+        @grouped_by_attribute[err.attribute] += err[:messages]
+      end
+      @grouped_by_attribute
+    end  
+  end
+end

data/lib/action_processor.rb

@@ -0,0 +1,2 @@
+require_relative "./action_processor/errors.rb"
+require_relative "./action_processor/base.rb"

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: action_processor
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- Ghennadii Mirosnicenco
+- Pavel Mirosnicenco
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: action_processor
+email: linkator7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/action_processor.rb
+- lib/action_processor/base.rb
+- lib/action_processor/errors.rb
+homepage: https://github.com/GhennadiiMir/action_processor
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Group each of your complex multy-model manipulations in dedicated ActionProcessor
+test_files: []