nucleus-core 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc1a3b1d1596531ada1d8537243b467070363b551133d8daa5e44503323a104f
-  data.tar.gz: 95251212007f9bf1ee7d2f6df738c4389a885323d85bf2e861cd6260ca8c2be7
+  metadata.gz: 16856ef31bb784d60c0245dc2b64688edffafedc629346e4b0aa5ad85c67f03b
+  data.tar.gz: 6132356105d16688ba22fcb6ab4827727584660867ffd07b37f2c559d6a365c8
 SHA512:
-  metadata.gz: 8325af67543e7de1f5519483a34b90adc0b98ca84a0610604d3e76592410da63fb82fd4eda685518490bc7652dd90ee13038d5f6703039c3e0bdbf03ffe3f59e
-  data.tar.gz: a5e5d5d640253499f4f961aeabc135149522b4b59b2bd42f0fbddac089bc5b184ea4b65c46574f8769720b3cecf655eae8986f351bcb744607a31d815010a9fc
+  metadata.gz: 9d77daf39dac0313f1fae986f124394e3f1af56fb1c0a8324a2054398d9c43715df25513a3cc568150ae5eed87bdabd8def043f6542fccce443334b2ee5fdc8b
+  data.tar.gz: 7a233128785f6359cd01c351c6fc3633de18af631ea022aa42e73e978c37a59fecab0eaa770d482257ee6c4042182555f94a3ecc3058819df769b2ec2a12bc25

data/README.md

@@ -4,26 +4,28 @@
 [![Circle](https://circleci.com/gh/dodgerogers/nucleus-core/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/dodgerogers/nucleus-core?branch=main)
 [![Code Climate](https://codeclimate.com/github/dodgerogers/nucleus-core/badges/gpa.svg)](https://codeclimate.com/github/dodgerogers/nucleus-core)
 
-NucleusCore Core is a framework to express and orchestrate business logic in a way that is agnostic to the framework.
+NucleusCore Core is a set of components which express and orchestrate business logic separatley to the framework.
 
-## This gem is still very much in development. A `nucleus-rails` gem will handle the adaptation of NucleusCore::View objects to the rails rendering methods.
+## This gem is still very much in development. See `nucleus-rails` for Rails usage.
 
 Here are the classes NucleusCore exposes, they have preordained responsibilities, can be composed together, and tested simply in isolation from the framework.
 
-- Policy (Authorization) - Can this user perform this process?
-- Operation (Services) - Executes a single unit of business logic, or side effect (ScheduleAppointment, CancelOrder, UpdateAddress).
-- Workflow (Service Orchestration) - Excecutes multiple units of work, and side effects (ApproveLoan, TakePayment, CancelFulfillments).
-- View (Presentation) - A presentation object which can render to multiple formats.
-- Repository (Data access) - Interacts with data sources to hide the implementation details to callers, and return Aggregates. Data sources could be an API, ActiveRecord, SQL, a local file, etc.
-- Aggregate (Domain/business Object) - Maps data from the data source to an object the aplication defines, known as an anti corruption layer.
+- **Policy (Authorization)** - Can this user perform this process?
+- **Operation (Services)** - Executes a single unit of business logic, or side effect (ScheduleAppointment, CancelOrder, UpdateAddress).
+- **Workflow (Service Orchestration)** - Excecutes multiple units of work, and side effects (ApproveLoan, TakePayment, CancelFulfillments).
+- **View (Presentation)** - A presentation object which can render to multiple formats.
+- **Repository (Data access)** - Interacts with data sources to hide the implementation details to callers, and return Aggregates. Data sources could be an API, ActiveRecord, SQL, a local file, etc.
+- **Aggregate (Domain/business Object)** - Maps data from the data source to an object the aplication defines, known as an anti corruption layer.
 
 Below is an example using NucleusCore Core with Rails:
 
 ```ruby
 # controllers/payments_controller.rb
 class PaymentsController < ApplicationController
+  include NucleusCore::Responder
+
   def create
-    NucleusCore::Responder.handle_response do
+    handle_response do
       policy.enforce!(:can_write?)
 
       context, _process = HandleCheckoutWorkflow.call(invoice_params)
@@ -104,6 +106,7 @@ class ShoppingCartRepository < NucleusCore::Repository
   end
 end
 
+# app/models/shopping_cart.rb
 class ShoppingCart < ActiveRecord::Base
   # ...
 end

data/lib/nucleus_core/extensions/utils.rb

@@ -0,0 +1,88 @@
+# Rack::Utils patch for status code
+class Utils
+  HTTP_STATUS_CODES = {
+    100 => "Continue",
+    101 => "Switching Protocols",
+    102 => "Processing",
+    103 => "Early Hints",
+    200 => "OK",
+    201 => "Created",
+    202 => "Accepted",
+    203 => "Non-Authoritative Information",
+    204 => "No Content",
+    205 => "Reset Content",
+    206 => "Partial Content",
+    207 => "Multi-Status",
+    208 => "Already Reported",
+    226 => "IM Used",
+    300 => "Multiple Choices",
+    301 => "Moved Permanently",
+    302 => "Found",
+    303 => "See Other",
+    304 => "Not Modified",
+    305 => "Use Proxy",
+    306 => "(Unused)",
+    307 => "Temporary Redirect",
+    308 => "Permanent Redirect",
+    400 => "Bad Request",
+    401 => "Unauthorized",
+    402 => "Payment Required",
+    403 => "Forbidden",
+    404 => "Not Found",
+    405 => "Method Not Allowed",
+    406 => "Not Acceptable",
+    407 => "Proxy Authentication Required",
+    408 => "Request Timeout",
+    409 => "Conflict",
+    410 => "Gone",
+    411 => "Length Required",
+    412 => "Precondition Failed",
+    413 => "Payload Too Large",
+    414 => "URI Too Long",
+    415 => "Unsupported Media Type",
+    416 => "Range Not Satisfiable",
+    417 => "Expectation Failed",
+    421 => "Misdirected Request",
+    422 => "Unprocessable Entity",
+    423 => "Locked",
+    424 => "Failed Dependency",
+    425 => "Too Early",
+    426 => "Upgrade Required",
+    428 => "Precondition Required",
+    429 => "Too Many Requests",
+    431 => "Request Header Fields Too Large",
+    451 => "Unavailable for Legal Reasons",
+    500 => "Internal Server Error",
+    501 => "Not Implemented",
+    502 => "Bad Gateway",
+    503 => "Service Unavailable",
+    504 => "Gateway Timeout",
+    505 => "HTTP Version Not Supported",
+    506 => "Variant Also Negotiates",
+    507 => "Insufficient Storage",
+    508 => "Loop Detected",
+    509 => "Bandwidth Limit Exceeded",
+    510 => "Not Extended",
+    511 => "Network Authentication Required"
+  }.freeze
+
+  SYMBOL_TO_STATUS_CODE = Hash[*HTTP_STATUS_CODES.map do |code, message|
+    [message.downcase.gsub(/\s|-|'/, "_").to_sym, code]
+  end.flatten]
+
+  def self.status_code(status)
+    if status.is_a?(Symbol)
+      return SYMBOL_TO_STATUS_CODE.fetch(status) do
+        raise ArgumentError, "Unrecognized status code #{status.inspect}"
+      end
+    end
+
+    status.to_i
+  end
+
+  def self.wrap(object)
+    return [] if object.nil?
+
+    object.is_a?(Array) ? object : [object]
+  end
+end

data/lib/nucleus_core/policy.rb

@@ -11,7 +11,7 @@ module NucleusCore
       policy_methods.each do |policy_method_and_args|
         next if send(*policy_method_and_args)
 
-        name = Array.wrap(policy_method_and_args).first
+        name = Utils.wrap(policy_method_and_args).first
         message = "You do not have access to: #{name}"
 
         raise NucleusCore::NotAuthorized, message

data/lib/nucleus_core/responder.rb

@@ -2,13 +2,22 @@ require "set"
 
 module NucleusCore
   module Responder
+    attr_reader :request_format, :response_adapter
+
+    def init_responder(request_format: nil, response_adapter: nil)
+      set_request_format(request_format)
+      set_response_adapter(response_adapter)
+    end
+
     def set_request_format(request=nil)
-      @request_format = request&.format&.to_sym || :json
+      @request_format = request&.to_sym || NucleusCore.configuration.default_response_format
     end
 
-    def request_format
-      @request_format ||= set_request_format
+    # rubocop:disable Naming/AccessorMethodName
+    def set_response_adapter(response_adapter)
+      @response_adapter = response_adapter || NucleusCore.configuration.response_adapter
     end
+    # rubocop:enable Naming/AccessorMethodName
 
     # rubocop:disable Lint/RescueException:
     def handle_response(&block)
@@ -70,7 +79,7 @@ module NucleusCore
     def render_response(entity)
       render_headers(entity.headers)
 
-      render_method = {
+      method_name = {
         NucleusCore::JsonResponse => :render_json,
         NucleusCore::XmlResponse => :render_xml,
         NucleusCore::PdfResponse => :render_pdf,
@@ -79,7 +88,7 @@ module NucleusCore
         NucleusCore::NoResponse => :render_nothing
       }.fetch(entity.class, nil)
 
-      response_adapter&.send(render_method, entity)
+      response_adapter&.send(method_name, entity)
     end
 
     def render_headers(headers={})
@@ -92,18 +101,16 @@ module NucleusCore
 
     # rubocop:disable Lint/DuplicateBranch
     def exception_to_status(exception)
-      config = exception_map
-
       case exception
-      when NucleusCore::NotFound, *config.not_found
+      when NucleusCore::NotFound, *exceptions.not_found
         :not_found
-      when NucleusCore::BadRequest, *config.bad_request
+      when NucleusCore::BadRequest, *exceptions.bad_request
         :bad_request
-      when NucleusCore::NotAuthorized, *config.forbidden
+      when NucleusCore::NotAuthorized, *exceptions.forbidden
         :forbidden
-      when NucleusCore::Unprocessable, *config.unprocessable
+      when NucleusCore::Unprocessable, *exceptions.unprocessable
         :unprocessable_entity
-      when NucleusCore::BaseException, *config.server_error
+      when NucleusCore::BaseException, *exceptions.server_error
         :internal_server_error
       else
         :internal_server_error
@@ -116,15 +123,11 @@ module NucleusCore
     end
 
     def logger(object, log_level=:info)
-      NucleusCore.configuration.logger&.send(log_level, object)
-    end
-
-    def exception_map
-      NucleusCore.configuration.exceptions_map
+      NucleusCore.configuration&.logger&.send(log_level, object)
     end
 
-    def response_adapter
-      NucleusCore.configuration.response_adapter
+    def exceptions
+      NucleusCore.configuration.exceptions
     end
   end
 end

data/lib/nucleus_core/response_adapter.rb

@@ -17,7 +17,7 @@ class NucleusCore::ResponseAdapter < NucleusCore::BasicObject
   end
 
   def status_code(status=nil)
-    status = NucleusCore::Rack::Utils.status_code(status)
+    status = Utils.status_code(status)
     default_status = 200
 
     status.zero? ? default_status : status

data/lib/nucleus_core/version.rb

@@ -1,3 +1,3 @@
 module NucleusCore
-  VERSION = "0.1.3".freeze
+  VERSION = "0.1.5".freeze
 end

data/lib/nucleus_core.rb

@@ -24,21 +24,21 @@ module NucleusCore
   class BadRequest < BaseException; end
 
   class Configuration
-    attr_reader :exceptions_map, :response_adapter
-    attr_accessor :logger
+    attr_accessor :response_adapter, :default_response_format, :logger
+    attr_reader :exceptions
+
+    RESPONSE_ADAPTER_METHODS = %i[
+      render_json render_xml render_text render_pdf render_csv render_nothing set_header
+    ].freeze
 
     def initialize
       @logger = nil
-      @response_adapter = nil
-      @exceptions_map = nil
-    end
-
-    def exceptions_map=(args={})
-      @exceptions_map = format_exceptions(args)
+      @exceptions = format_exceptions
+      @default_response_format = :json
     end
 
-    def response_adapter=(adapter)
-      @response_adapter = format_adapter(adapter)
+    def exceptions=(args={})
+      @exceptions = format_exceptions(args)
     end
 
     private
@@ -51,35 +51,13 @@ module NucleusCore
 
     def format_exceptions(exceptions={})
       exception_defaults = ERROR_STATUSES.reduce({}) { |acc, ex| acc.merge(ex => nil) }
+      exceptions = (exceptions || exception_defaults)
+        .slice(*exception_defaults.keys)
+        .reduce({}) do |acc, (key, value)|
+          acc.merge(key => Utils.wrap(value))
+        end
 
-      objectify(
-        (exceptions || exception_defaults)
-            .slice(*exception_defaults.keys)
-            .reduce({}) do |acc, (key, value)|
-              acc.merge(key => Array.wrap(value))
-            end
-      )
-    end
-
-    def format_adapter(adapter={})
-      adapter.tap do |a|
-        verify_adapter!(a)
-      end
-    end
-
-    ADAPTER_METHODS = %i[
-      render_json render_xml render_text render_pdf render_csv render_nothing set_header
-    ].freeze
-
-    def verify_adapter!(adapter)
-      # current_adapter_methods = Set[*(adapter.methods - Object.methods)]
-      # required_adapter_methods = ADAPTER_METHODS.to_set
-
-      # return if current_adapter_methods == required_adapter_methods
-
-      # missing = current_adapter_methods.subtract(required_adapter_methods)
-
-      # raise ArgumentError, "responder.adapter must implement: #{missing}"
+      objectify(exceptions)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nucleus-core
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - dodgerogers
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-01 00:00:00.000000000 Z
+date: 2023-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.43.0
+        version: 1.44.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.43.0
+        version: 1.44.1
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.26.1
+        version: 0.27.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.26.1
+        version: 0.27.0
 - !ruby/object:Gem::Dependency
   name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
@@ -151,8 +151,7 @@ files:
 - lib/nucleus_core/aggregate.rb
 - lib/nucleus_core/basic_object.rb
 - lib/nucleus_core/cli.rb
-- lib/nucleus_core/extensions/array.rb
-- lib/nucleus_core/extensions/rack.rb
+- lib/nucleus_core/extensions/utils.rb
 - lib/nucleus_core/operation.rb
 - lib/nucleus_core/policy.rb
 - lib/nucleus_core/repository.rb

data/lib/nucleus_core/extensions/array.rb

@@ -1,11 +0,0 @@
-class Array
-  def self.wrap(object)
-    if object.nil?
-      []
-    elsif object.respond_to?(:to_ary)
-      object.to_ary || [object]
-    else
-      [object]
-    end
-  end
-end

data/lib/nucleus_core/extensions/rack.rb

@@ -1,86 +0,0 @@
-# Rack::Utils patch for status code
-module NucleusCore
-  module Rack
-    class Utils
-      HTTP_STATUS_CODES = {
-        100 => "Continue",
-        101 => "Switching Protocols",
-        102 => "Processing",
-        103 => "Early Hints",
-        200 => "OK",
-        201 => "Created",
-        202 => "Accepted",
-        203 => "Non-Authoritative Information",
-        204 => "No Content",
-        205 => "Reset Content",
-        206 => "Partial Content",
-        207 => "Multi-Status",
-        208 => "Already Reported",
-        226 => "IM Used",
-        300 => "Multiple Choices",
-        301 => "Moved Permanently",
-        302 => "Found",
-        303 => "See Other",
-        304 => "Not Modified",
-        305 => "Use Proxy",
-        306 => "(Unused)",
-        307 => "Temporary Redirect",
-        308 => "Permanent Redirect",
-        400 => "Bad Request",
-        401 => "Unauthorized",
-        402 => "Payment Required",
-        403 => "Forbidden",
-        404 => "Not Found",
-        405 => "Method Not Allowed",
-        406 => "Not Acceptable",
-        407 => "Proxy Authentication Required",
-        408 => "Request Timeout",
-        409 => "Conflict",
-        410 => "Gone",
-        411 => "Length Required",
-        412 => "Precondition Failed",
-        413 => "Payload Too Large",
-        414 => "URI Too Long",
-        415 => "Unsupported Media Type",
-        416 => "Range Not Satisfiable",
-        417 => "Expectation Failed",
-        421 => "Misdirected Request",
-        422 => "Unprocessable Entity",
-        423 => "Locked",
-        424 => "Failed Dependency",
-        425 => "Too Early",
-        426 => "Upgrade Required",
-        428 => "Precondition Required",
-        429 => "Too Many Requests",
-        431 => "Request Header Fields Too Large",
-        451 => "Unavailable for Legal Reasons",
-        500 => "Internal Server Error",
-        501 => "Not Implemented",
-        502 => "Bad Gateway",
-        503 => "Service Unavailable",
-        504 => "Gateway Timeout",
-        505 => "HTTP Version Not Supported",
-        506 => "Variant Also Negotiates",
-        507 => "Insufficient Storage",
-        508 => "Loop Detected",
-        509 => "Bandwidth Limit Exceeded",
-        510 => "Not Extended",
-        511 => "Network Authentication Required"
-      }.freeze
-
-      SYMBOL_TO_STATUS_CODE = Hash[*HTTP_STATUS_CODES.map do |code, message|
-        [message.downcase.gsub(/\s|-|'/, "_").to_sym, code]
-      end.flatten]
-
-      def self.status_code(status)
-        if status.is_a?(Symbol)
-          return SYMBOL_TO_STATUS_CODE.fetch(status) do
-            raise ArgumentError, "Unrecognized status code #{status.inspect}"
-          end
-        end
-
-        status.to_i
-      end
-    end
-  end
-end