riker 0.1.0.pre3 → 0.1.0.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b819ce3e2d6fb0f84fd16e4eb754802ca3c655810179225c9f4ba9cff3d8f068
-  data.tar.gz: ab2a5b0a1e9f3beb29c1ba8437de4b50be42f395c79cc833985c7da082c572f4
+  metadata.gz: fd3f7e1ef08e3dd6db6362747a86a4adbff4acd42a90bd251bbde583c01d5eca
+  data.tar.gz: 57c823093ded9ae1ec66fa7dcb6741385fd450072aa59eac0cf962ed0e32b74e
 SHA512:
-  metadata.gz: ae433f9f555ceee2b68121953086c7de1e340773ccd1dc802a254126a7bcee94f7f77d2f28427b29e89a6f2e738f9b7aeb5ec709951eb84c150de49bff58ef9c
-  data.tar.gz: 65a9c8f2be649a18223f3f97caf10b628155f6e0ac54b7891aba504616084eaa6ef85f79f7ac96ff55d7d057d18070bc3a84e527a0ba4b0faac276c80509e74b
+  metadata.gz: 92ae6575db90c03567fac3aa2b31d7350c1f616c011dc77c4a17c1cbb4cabc7ab2d630ac7a2311a8f6e341e08ec9fc1c26f162db047034f5122407bf0455185c
+  data.tar.gz: 90d6f23aa9224096af1b06a7aaa53a2290e4f125076fedcc58a685829b05e75b68e3d46218842e7ea1d337db01583a149d4f4363a1f7271fec115cbf5ea79f65

data/Gemfile

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in riker.gemspec
 gemspec
 
+gem 'pry', '~> 0.14'
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'rubocop'

data/Gemfile.lock

@@ -1,17 +1,22 @@
 PATH
   remote: .
   specs:
-    riker (0.1.0.pre2)
+    riker (0.1.0.pre5)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    coderay (1.1.3)
     diff-lcs (1.5.0)
     json (2.6.2)
+    method_source (1.0.0)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.5.0)
@@ -49,6 +54,7 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
+  pry (~> 0.14)
   rake (~> 13.0)
   riker!
   rspec (~> 3.0)

data/README.md

@@ -12,7 +12,7 @@ High-Performance, Dependency-Free Command Pattern For Ruby
 ### In your gemfile:
 
 ```ruby
-gem 'riker', '0.1.0.pre3'
+gem 'riker', '0.1.0.pre5'
 ```
 
 ### In your code:
@@ -26,6 +26,11 @@ class SimpleGreeting
   param :punctuation, default: '.'
 
   execute do
+    if first_name == 'Voldemort'
+      errors.add(:first_name, 'He who shall not be named!')
+      return
+    end
+
     return "Hello #{first_name}#{punctuation}" if last_name.nil?
 
     "Hello #{first_name} #{last_name}#{punctuation}"
@@ -44,6 +49,24 @@ SimpleGreeting.run!(first_name: 'Will', last_name: 'Riker')
 
 SimpleGreeting.run!(first_name: 'Will', last_name: 'Riker', punctuation: '!')
 # => "Hello Will Riker!"
+
+SimpleGreeting.run!(first_name: 'Voldemort')
+# => Riker::Outcome::ExecutionError => e
+# =>   e.errors.messages == ['He who shall not be named!']
+
+outcome = SimpleGreeting.run(first_name: 'Will')
+outcome.valid?
+# => true
+outcome.result
+# => "Hello Will."
+
+outcome = SimpleGreeting.run(first_name: 'Voldemort')
+outcome.invalid?
+# => true
+outcome.result
+# => nil
+outcome.errors.messages
+# => ['He who shall not be named!']
 ```
 
 ## Default Procs

data/lib/riker/command/fallible_methods.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Riker
+  class Command
+    # Fallible Methods
+    #
+    # Every command has fallible functionality.  This is
+    # how you can convey something has gone wrong to the
+    # caller of your command.
+    #
+    module FallibleMethods
+      # @return [Riker::Outcome::Errors]
+      def errors
+        @errors ||= Riker::Outcome::Errors.new
+      end
+
+      # @return [Boolean]
+      def errored?
+        defined?(@errors) && @errors.any?
+      end
+    end
+  end
+end

data/lib/riker/command/function.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Riker
+  class Command
+    # Individual Function
+    #
+    # Repsonible for debugging and writing out functions
+    # for a command to provide the needed functionality
+    # that is setup for it.
+    #
+    class Function
+      # @param command [Riker::Command]
+      def initialize(command)
+        @command = command
+      end
+
+      # @return [Symbol]
+      def name
+        raise NotImplementedError
+      end
+
+      # @return [Riker::Command::FunctionDetails]
+      def details
+        raise NotImplementedError
+      end
+
+      private
+
+      # @return [Riker::Command]
+      attr_reader :command
+    end
+  end
+end

data/lib/riker/command/function_details.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Riker
+  class Command
+    # Function Detail Data
+    #
+    # Holds information needed to write a function to a class
+    # with `class_eval` on a class object.
+    #
+    class FunctionDetails
+      # @return [String]
+      attr_reader :code
+
+      # @return [String]
+      attr_reader :file
+
+      # @return [Integer]
+      attr_reader :line
+
+      def initialize(code, file, line)
+        @code = code
+        @file = file
+        @line = line
+      end
+    end
+  end
+end

data/lib/riker/command/function_writer.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative 'run_bang_function'
+require_relative 'initialize_function'
+require_relative 'run_function'
+
+module Riker
+  class Command
+    # Function Writer
+    #
+    # This is responsible for creating the functions that
+    # are needed to create a command pattern class.
+    #
+    class FunctionWriter
+      DEFAULT_FUNCTIONS = [
+        RunBangFunction,
+        RunFunction,
+        InitializeFunction
+      ].freeze
+
+      INSTANCE_METHOD_MODULES = [
+        FallibleMethods
+      ].freeze
+
+      # @return [Riker::Command]
+      attr_reader :command
+
+      # @return [Array<Riker::Command::Function>]
+      attr_reader :functions
+
+      # @param command [Riker::Command]
+      def initialize(command)
+        @command = command
+        @functions = DEFAULT_FUNCTIONS.map { |func| func.new(command) }
+      end
+
+      # @param klass [Class]
+      def write!(klass)
+        klass.define_method(:execute, &command.execute_block)
+        define_default_setters!(klass)
+        define_attr_readers!(klass)
+        write_functions!(klass)
+        include_instance_methods!(klass)
+      end
+
+      private
+
+      # @param klass [Class]
+      def write_functions!(klass)
+        functions.each do |function|
+          details = function.details
+          klass.class_eval(details.code, details.file, details.line)
+        end
+      end
+
+      # @param klass [Class]
+      def define_attr_readers!(klass)
+        klass.attr_reader(*command.parameters.map(&:name))
+      end
+
+      # @param klass [Class]
+      def define_default_setters!(klass)
+        command.parameters.each do |param|
+          param.default.build_default_function!(klass)
+        end
+      end
+
+      # @param klass [Class]
+      def include_instance_methods!(klass)
+        INSTANCE_METHOD_MODULES.each do |mod|
+          klass.include(mod)
+        end
+      end
+    end
+  end
+end

data/lib/riker/command/initialize_function.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Riker
+  class Command
+    # Run!
+    #
+    # Represents the `initialize` method for your command
+    #
+    class InitializeFunction < Function
+      # @return [Symbol]
+      def name
+        :initialize
+      end
+
+      # @return [Riker::Command::FunctionDetails]
+      def details
+        FunctionDetails.new(<<~RUBY, __FILE__, __LINE__ + 1)
+          def initialize(#{command.parameters.ctor_args})  # def initialize(foo:)
+            #{command.parameters.variable_sets}            #   @foo = foo
+          end                                              # end
+        RUBY
+      end
+    end
+  end
+end

data/lib/riker/command/parameters.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Riker
+  class Command
+    # Command Parameters
+    #
+    # This is responsible for keeping track of the command's
+    # parameters. This includes how they are used and applied
+    # to the construction of a command.
+    #
+    class Parameters
+      include Enumerable
+      class ParamNameTaken < ::Riker::Error; end
+      class InvalidParamName < ::Riker::Error; end
+      class ReservedAttributeName < ::Riker::Error; end
+
+      RESERVED_ATTR_NAMES = %i[
+        errors
+      ].to_set.freeze
+
+      def initialize
+        # @var [Hash<Symbol, Parameter>]
+        @params = {}
+      end
+
+      # @param name [Symbol]
+      # @return [Parameters]
+      #
+      def add(name, **options)
+        validate_name!(name)
+        @params[name] = Parameter.new(name, **options)
+
+        self
+      end
+
+      # @return [String]
+      def ctor_args
+        map(&:ctor_arg).join(', ')
+      end
+
+      # @return [String]
+      def variable_sets
+        map(&:variable_set).join("\n")
+      end
+
+      # @yield [Parameter]
+      def each(&block)
+        @params.values.each(&block)
+      end
+
+      private
+
+      def validate_name!(name)
+        raise InvalidParamName unless name.is_a?(Symbol)
+        raise ReservedAttributeName if RESERVED_ATTR_NAMES.include?(name)
+        raise ParamNameTaken if @params.key?(name)
+      end
+    end
+  end
+end

data/lib/riker/command/run_bang_function.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Riker
+  class Command
+    # Run!
+    #
+    # Represents the `run!` static method for your command
+    #
+    class RunBangFunction < Function
+      # @return [Symbol]
+      def name
+        :run!
+      end
+
+      # @return [Riker::Command::FunctionDetails]
+      def details
+        FunctionDetails.new(<<~RUBY, __FILE__, __LINE__ + 1)
+          def self.run!(**arguments)          # def self.run!(**arguments)
+            command = new(**arguments)        #   command = new(**arguments)
+            result = command.execute          #   result = command.execute
+            if command.errored?               #   if command.errored?
+              command.errors.raise!           #     command.errors.raise!
+            end                               #   end
+            result                            #   result
+          end                                 # end
+        RUBY
+      end
+    end
+  end
+end

data/lib/riker/command/run_function.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Riker
+  class Command
+    # Run!
+    #
+    # Represents the `run!` static method for your command
+    #
+    class RunFunction < Function
+      # @return [Symbol]
+      def name
+        :run
+      end
+
+      # @return [Riker::Command::FunctionDetails]
+      def details
+        FunctionDetails.new(<<~RUBY, __FILE__, __LINE__ + 1)
+          def self.run(**arguments)                   # def self.run!(**arguments)
+            command = new(**arguments)                #   command = new(**arguments)
+            result = command.execute                  #   result = command.execute
+            if command.errored?                       #   if command.errored?
+              Riker::Outcome.invalid(command.errors)  #     Riker::Outcome.invalid(command.errors)
+            else                                      #   else
+              Riker::Outcome.valid(result)            #     Riker::Outcome.valid(result)
+            end                                       #   end
+          end                                         # end
+        RUBY
+      end
+    end
+  end
+end

data/lib/riker/command.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require_relative 'command/parameters'
+require_relative 'command/fallible_methods'
+require_relative 'command/function'
+require_relative 'command/function_details'
+require_relative 'command/function_writer'
+
 module Riker
   # Command Builder
   #
@@ -7,56 +13,18 @@ module Riker
   # track of the build of a command in your application
   #
   class Command
-    # @return [Riker::CommandParameters]
+    # @return [Riker::Command::Parameters]
     attr_reader :parameters
 
+    # @return [Riker::Command::FunctionWriter]
+    attr_reader :function_writer
+
     # @return [Proc, nil]
     attr_accessor :execute_block
 
     def initialize
-      @parameters = CommandParameters.new
-    end
-
-    # @param klass [Class]
-    def build!(klass)
-      klass.define_method(:execute, &execute_block)
-      define_default_setters!(klass)
-      define_init!(klass)
-      define_run_bang!(klass)
-      define_attr_readers!(klass)
-    end
-
-    private
-
-    # @param klass [Class]
-    def define_init!(klass)
-      klass.class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
-        def initialize(#{parameters.ctor_args})  # def initialize(foo:)
-          #{parameters.variable_sets}            #   @foo = foo
-        end                                      # end
-      RUBY
-    end
-
-    # @param klass [Class]
-    def define_run_bang!(klass)
-      klass.class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
-        def self.run!(**arguments)    # def initialize(**arguments)
-          command = new(**arguments)  #   command = new(**arguments)
-          command.execute             #   command.execute
-        end                           # end
-      RUBY
-    end
-
-    # @param klass [Class]
-    def define_attr_readers!(klass)
-      klass.attr_reader(*parameters.map(&:name))
-    end
-
-    # @param klass [Class]
-    def define_default_setters!(klass)
-      parameters.each do |param|
-        param.default.build_default_function!(klass)
-      end
+      @parameters = Parameters.new
+      @function_writer = FunctionWriter.new(self)
     end
   end
 end

data/lib/riker/outcome/errors.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Riker
+  class Outcome
+    # Outcome Errors
+    #
+    # A wrapper to keep track of and report on errors
+    # that happened during the execution of a command.
+    #
+    class Errors
+      # @!method any?
+      #   @return [Boolean]
+      # @!method none?
+      #   @return [Boolean]
+      extend Forwardable
+      def_delegators :@errors, :any?, :none?
+
+      def initialize
+        @errors = Hash.new { |hash, key| hash[key] = [] }
+      end
+
+      # @param key [Symbol]
+      # @param error [String]
+      # @return [void]
+      def add(key, error)
+        @errors[key] << error
+
+        nil
+      end
+
+      # @return [Array<String>]
+      def messages
+        @errors.values.flatten!
+      end
+
+      # @raise [Riker::ExecutionError]
+      def raise!
+        raise as_execution_error
+      end
+
+      private
+
+      def as_execution_error
+        Riker::Outcome::ExecutionError.new(self)
+      end
+    end
+  end
+end

data/lib/riker/outcome/execution_error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Riker
+  class Outcome
+    # Execution Error
+    #
+    # This exception is raised when a problem has happened
+    # with your command.  It is the result normall of having
+    # errors.
+    #
+    # @see Riker::Command::FallibleMethods
+    #
+    class ExecutionError < Error
+      # @return [Riker::Outcome::Errors]
+      attr_reader :errors
+
+      # @param errors [Riker::Outcome::Errors]
+      def initialize(errors)
+        super()
+        @errors = errors
+      end
+    end
+  end
+end

data/lib/riker/outcome.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative 'outcome/errors'
+require_relative 'outcome/execution_error'
+
+module Riker
+  # Wrapped Outcome of a Command
+  #
+  # Commands may be fallible; and in that case
+  # they return an outcome that will either detail
+  # the errors that came up during execution or the
+  # expected data if it was success.
+  #
+  class Outcome
+    # @return [Object]
+    attr_reader :result
+
+    class << self
+      # @param result [Object]
+      # @return [Riker::Outcome]
+      def valid(result)
+        new(:valid, result)
+      end
+
+      def invalid(errors)
+        new(:invalid, errors)
+      end
+
+      private :new
+    end
+
+    # @param state [:valid, :invalid]
+    # @data [Object, Riker::Outcome::Errors]
+    def initialize(state, data)
+      if state == :valid
+        @result = data
+      else
+        @errors = data
+      end
+    end
+
+    # @return [Boolean]
+    def valid?
+      return true unless defined?(@errors)
+
+      @errors.none?
+    end
+
+    # @return [Boolean]
+    def invalid?
+      return false unless defined?(@errors)
+
+      @errors.any?
+    end
+
+    # @return [Riker::Outcome::Errors]
+    def errors
+      @errors ||= Errors.new
+    end
+  end
+end

data/lib/riker/parameter/default_value.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Riker
+  class Parameter
+    # Default Parameter Value
+    #
+    # Sometimes we want to have parameters default to sensible
+    # defaults.  This class's responsibility is to keep track
+    # this and set's up work to ensure defaults setup properly.
+    #
+    class DefaultValue
+      # @return [Symbol]
+      attr_reader :name
+
+      # @return [BasicObject]
+      def self.no_value
+        :__no_default__
+      end
+
+      # @param name [Symbol]
+      # @param value [Object, Proc]
+      def initialize(name, value)
+        @name = name
+        @present = value != :__no_default__
+        @value_proc = value.is_a?(Proc) ? value : -> { value }
+      end
+
+      # @return [Boolean]
+      def present?
+        @present
+      end
+
+      # @return [Symbol, nil]
+      def function_name
+        return unless present?
+
+        @function_name ||= :"default_value_for_#{name}"
+      end
+
+      def build_default_function!(klass)
+        return unless present?
+
+        klass.define_method(function_name, &@value_proc)
+        klass.send(:private, function_name)
+      end
+    end
+  end
+end

data/lib/riker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Riker
-  VERSION = '0.1.0.pre3'
+  VERSION = '0.1.0.pre5'
 end

data/lib/riker.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
+require 'forwardable'
+require 'set'
+
 require_relative 'riker/version'
 require_relative 'riker/error'
 require_relative 'riker/command'
-require_relative 'riker/command_parameters'
 require_relative 'riker/parameter'
+require_relative 'riker/outcome'
 
 # The Commander of the USS Enterprise
 module Riker
@@ -26,6 +29,6 @@ module Riker
     raise Error, "execute block already called for #{self}!" if command.execute_block
 
     command.execute_block = block
-    command.build!(self)
+    command.function_writer.write!(self)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riker
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre3
+  version: 0.1.0.pre5
 platform: ruby
 authors:
 - Benjamin Falk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies: []
 description: High-Performance, Dependency-Free Command Pattern For Ruby
 email:
@@ -29,9 +29,20 @@ files:
 - bin/setup
 - lib/riker.rb
 - lib/riker/command.rb
-- lib/riker/command_parameters.rb
+- lib/riker/command/fallible_methods.rb
+- lib/riker/command/function.rb
+- lib/riker/command/function_details.rb
+- lib/riker/command/function_writer.rb
+- lib/riker/command/initialize_function.rb
+- lib/riker/command/parameters.rb
+- lib/riker/command/run_bang_function.rb
+- lib/riker/command/run_function.rb
 - lib/riker/error.rb
+- lib/riker/outcome.rb
+- lib/riker/outcome/errors.rb
+- lib/riker/outcome/execution_error.rb
 - lib/riker/parameter.rb
+- lib/riker/parameter/default_value.rb
 - lib/riker/version.rb
 - sig/riker.rbs
 homepage:
@@ -55,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: High-Performance, Dependency-Free Command Pattern For Ruby

data/lib/riker/command_parameters.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module Riker
-  # Command Parameters
-  #
-  # This is responsible for keeping track of the command's
-  # parameters. This includes how they are used and applied
-  # to the construction of a command.
-  #
-  class CommandParameters
-    include Enumerable
-    class ParamNameTaken < ::Riker::Error; end
-    class InvalidParamName < ::Riker::Error; end
-
-    def initialize
-      # @var [Hash<Symbol, Parameter>]
-      @params = {}
-    end
-
-    # @param name [Symbol]
-    # @return [Parameters]
-    #
-    def add(name, **options)
-      validate_name!(name)
-      @params[name] = Parameter.new(name, **options)
-
-      self
-    end
-
-    # @return [String]
-    def ctor_args
-      map(&:ctor_arg).join(', ')
-    end
-
-    # @return [String]
-    def variable_sets
-      map(&:variable_set).join("\n")
-    end
-
-    # @yield [Parameter]
-    def each(&block)
-      @params.values.each(&block)
-    end
-
-    private
-
-    def validate_name!(name)
-      raise InvalidParamName unless name.is_a?(Symbol)
-      raise ParamNameTaken if @params.key?(name)
-    end
-  end
-end