makwa 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1efddd0368efae3bf02af1759d3923729f39414c2d728c3567aa911ec2bd5892
-  data.tar.gz: ff81e0decb31353995008f0a4c3d69c14f741d45a30a72fa7015f8149b377ca3
+  metadata.gz: 2da52aacefd38c1922e5e8b48277fca8106997a068b682d93698bd9e444da41f
+  data.tar.gz: a506c6b8ae75f3d093afdf455b84733f0d0984843561dde099bbbb9ffddc7e91
 SHA512:
-  metadata.gz: ca622d29e65ddd191fcaa8dad747e4a7ed7ca1fb3fba11cf2749276f61ab38706e88d36a4ed6d531fcadebc7a28fb9c767932039684bd40b706df081ac37201f
-  data.tar.gz: f84ceb0ed0e479c2aa18ab58a9ee3504591c3b3df0e444eb4c111aa09c204fdef198f3b49073d297127622e9027b6d8a719a055ddf9aafbc6c81075a59430375
+  metadata.gz: 8784e825031765550dce4b56c82aae5a872d403cf14f444cdb0a2afb00fd2603e14f28910a92f3415b60df351820a17f738264eb6bf3bacd050f3ac21ee79c43
+  data.tar.gz: ea5dde94eca0a95abda600e4bd8f129dc63413a855cdf3ffb9ee5f15176ee7f1edcd368216265aff272def00ca4795b647f7667bd6bbe58ec3a742ab361274bd

data/.gitignore

@@ -2,7 +2,9 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/
+
+Gemfile.lock
+.byebug_history

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2021-10-27
+
+- Adds implementation
+- Updates ReturningInteraction to copy errors and values to returned object on invalid inputs
+
 ## [0.1.0] - 2021-09-23
 
 - Initial release

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Jo Hund
+Copyright (c) 2021 Animikii
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,4 +1,13 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-task default: %i[]
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/doc/how_to_release_new_version.md

@@ -0,0 +1,14 @@
+# How to release a new version
+
+* Make changes to the code
+  * Update tests as needed
+  * Update CHANGELOG.md
+  * Commit changes
+* Prepare new release
+  * Bump version via one of
+    * `gem bump --tag --version major`
+    * `gem bump --tag --version minor`
+    * `gem bump --tag --version patch`
+  * The bump command will commit the new version and tag the commit.
+* Distribute new release
+  * `gem release` - This will push the new release to rubygems.org.

data/lib/makwa/interaction.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Makwa
+  class Interaction < ::ActiveInteraction::Base
+    class Interrupt < Object.const_get("::ActiveInteraction::Interrupt")
+    end
+
+    #
+    # Safely checking for errors
+    #
+
+    # Use this instead of `outcome.invalid?` (which is destructive and clears errors)
+    delegate :any?, to: :errors, prefix: true # def errors_any?
+    # Use this instead of `outcome.valid?` (which is destructive and clears errors)
+    delegate :empty?, to: :errors, prefix: true # def errors_empty?
+
+    #
+    # Halting of execution
+    #
+
+    # Exits early if there are any errors.
+    def return_if_errors!
+      raise(Interrupt, errors) if errors_any?
+    end
+
+    #
+    # Logging interaction execution
+    #
+
+    # Log execution of interaction, caller, and inputs
+    set_callback :type_check, :before, ->(interaction) {
+      debug("Executing interaction #{interaction.class.name} #{interaction.id_marker}")
+      calling_interaction = interaction.calling_interaction
+      debug(" ↳ called from #{calling_interaction} #{interaction.id_marker}") if calling_interaction.present?
+      # The next two lines offer two ways of printing inputs: Either truncated, or full. Adjust as needed.
+      # truncated_inputs = interaction.inputs.inspect.truncate_in_the_middle(2000, omission: "\n... [inputs truncated] ...\n")
+      truncated_inputs = interaction.inputs.inspect
+      debug(" ↳ inputs: #{truncated_inputs} #{interaction.id_marker}")
+    }
+
+    # Log interaction's outcome and errors if any.
+    set_callback :execute, :after, ->(interaction) {
+      if interaction.errors_empty?
+        debug(" ↳ outcome: succeeded (id##{interaction.object_id})")
+      else
+        debug(" ↳ outcome: failed (id##{interaction.object_id})")
+        debug(" ↳ errors: #{interaction.errors.details} (id##{interaction.object_id})")
+      end
+    }
+
+    # @return [Array<String>] the callstack containing interactions only, starting with the immediate caller.
+    def calling_interactions
+      @calling_interactions ||= caller.find_all { |e|
+        e.index("/app/interactions/") && !e.index(__FILE__) && !e.index("/returning_interaction.rb")
+      }
+    end
+
+    # @return [String] the backtrace entry for the immediately calling interaction (first item in calling_interactions).
+    def calling_interaction
+      @calling_interaction ||= calling_interactions.first&.split("/interactions/")&.last || ""
+    end
+
+    # The standard method for all logging output. Turn this on for detailed interaction logging.
+    def debug(txt)
+      # puts indent + txt
+    end
+
+    # @return [String] a marker that identifies an interaction instance by its Ruby object_id. This is helpful
+    #   when following an execution log with nested or interleaved interaction log lines.
+    def id_marker
+      "(id##{object_id})"
+    end
+
+    # @return [String] a prefix that indents each debug line according to the level of interactions nesting.
+    def indent
+      lvl = [0, calling_interactions.count].max
+      "  " * lvl
+    end
+  end
+end

data/lib/makwa/returning_interaction.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Makwa
+  # @abstract Override {#execute_returning} and call {#returning} in the class body, passing in the symbol
+  #   of the input you want returned. Guaranteed to return the returning input, with interaction errors
+  #   merged into it.
+  class ReturningInteraction < ::Makwa::Interaction
+    class ReturnFilterInexistent < StandardError; end
+
+    class ReturningFilterNotSpecified < StandardError; end
+
+    class NotActiveModelErrorable < StandardError; end
+
+    define_callbacks(:execute_returning)
+
+    class << self
+      # @param (see ActiveInteraction::Runnable#initialize)
+      #
+      # @return (see ReturningInteraction#run_returning!)
+      def run_returning!(*args)
+        new(*args).send(:run_returning!)
+      end
+
+      # @param return_filter [Symbol] Name of the input filter to be returned
+      def returning(return_filter)
+        @return_filter = return_filter
+      end
+    end
+
+    # @abstract
+    #
+    # @raise [NotImplementedError]
+    def execute_returning
+      raise NotImplementedError, "You need to implemented the method #execute_returning in your interaction."
+    end
+
+    private
+
+    # @return [Object]
+    def run_returning!
+      @_interaction_result = return_input # {#result=} has side-effects
+      raise ReturningFilterNotSpecified unless self.class.instance_variable_defined?(:@return_filter)
+      raise ReturnFilterInexistent unless result
+      raise NotActiveModelErrorable unless result.respond_to?(:errors) && result.errors.respond_to?(:merge!)
+
+      # Run validations (explicitly, don't rely on #valid?)
+      validate
+      if errors_any?
+        # Add errors and values to the result object (so that the form can render them) and return the result object
+        return result
+            .tap { |r| r.errors.merge!(errors) }
+            .tap { |r| r.assign_attributes(inputs.except(@return_filter)) }
+      end
+
+      # Otherwise run the body of the interaction (along with any callbacks) ...
+      run_callbacks(:execute_returning) do
+        execute_returning
+      rescue ::Makwa::Interaction::Interrupt
+        # Do nothing
+      end
+
+      # ... and return the result, merging in any errors added in the body of the interaction that are not duplicates.
+      # Duplicates would occur if, for example, the body of the interaction calls
+      # `errors.merge!(<returning_filter>.errors)` as is often done in non-returning interactions.
+      result.tap do |r|
+        errors.each do |e|
+          r.errors.add(e.attribute, e.message) unless r.errors.added?(e.attribute, e.message)
+        end
+      end
+    end
+
+    # @return [Object]
+    def return_input
+      @return_input ||= inputs[self.class.instance_variable_get(:@return_filter)]
+    end
+
+    # @param other [Class] The other interaction.
+    #
+    # @return (see #result)
+    def compose(other, *args)
+      @_interaction_result = other.run_returning!(*args)
+
+      if block_given?
+        errors.merge!(@_interaction_result.errors)
+        yield @_interaction_result
+      end
+
+      @_interaction_result
+    rescue NotImplementedError
+      super(other, *args)
+    end
+  end
+end

data/lib/makwa/version.rb

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

data/lib/makwa.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "makwa/version"
+require "active_interaction"
 
 module Makwa
-  class Error < StandardError; end
-  # Your code goes here...
 end
+
+# Dependency boundary
+
+require "makwa/interaction"
+require "makwa/returning_interaction"
+require "makwa/version"

data/makwa.gemspec

@@ -3,14 +3,18 @@
 require_relative "lib/makwa/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "makwa"
-  spec.version       = Makwa::VERSION
-  spec.authors       = ["Jo Hund"]
-  spec.email         = ["jhund@clearcove.ca"]
-
-  spec.summary       = "Interactions for Ruby on Rails apps."
-  spec.homepage      = "https://github.com/animikii/makwa"
-  spec.license       = "MIT"
+  spec.name = "makwa"
+  spec.version = Makwa::VERSION
+  {
+    "Jo Hund" => "jo@animikii.com",
+    "Fabio Papa" => "fabio.papa@animikii.com"
+  }.tap do |hash|
+    spec.authors = hash.keys
+    spec.email = hash.values
+  end
+  spec.summary = "Interactions for Ruby on Rails apps."
+  spec.homepage = "https://github.com/animikii/makwa"
+  spec.license = "MIT"
   spec.required_ruby_version = ">= 2.4.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
@@ -22,13 +26,10 @@ Gem::Specification.new do |spec|
   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"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "active_interaction", "~> 4.0"
 
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "byebug"
 end

metadata

@@ -1,18 +1,62 @@
 --- !ruby/object:Gem::Specification
 name: makwa
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jo Hund
+- Fabio Papa
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-09-23 00:00:00.000000000 Z
-dependencies: []
+date: 2021-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_interaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  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: byebug
+  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'
 description: 
 email:
-- jhund@clearcove.ca
+- jo@animikii.com
+- fabio.papa@animikii.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -25,7 +69,10 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- doc/how_to_release_new_version.md
 - lib/makwa.rb
+- lib/makwa/interaction.rb
+- lib/makwa/returning_interaction.rb
 - lib/makwa/version.rb
 - makwa.gemspec
 homepage: https://github.com/animikii/makwa