chieftain 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17774b03847bead6d36c230eddf5d793cacc9889b35c19e344a8be1a973b0878
+  data.tar.gz: 88f35af779073c7ba55f6907075a6ab3f58df2a2c9de05daa14e88e7555c06c6
+SHA512:
+  metadata.gz: ea95cf8bba3f6a7cfcbe1b9cb5e310b6e990421fe2ff8669d6c41338c14653a264a0de427f02b8b93c0101ddddab4b61e81b1459674265197291ba940c5941d5
+  data.tar.gz: cd99d161b3d5b651717855223c57db1d254ea0c2ecde3ab9656735a9a27ef83b978e376f761aa83887118805eb66f044d2d6d1a82a21a334cab4de1a75429440

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chieftain.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.11"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    chieftain (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  chieftain!
+  rake (~> 13.0)
+  rspec (~> 3.11)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Peter Wood
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,267 @@
+# Chieftain
+
+Chieftain is a library that provides an implementation of the Command design
+pattern that attempts to make use of the capabilities of the Ruby language to
+simplify usage. The library is heavily inspired by the
+[Mutations](https://github.com/cypriss/mutations) but also seeks to address
+a few pet peeves with that library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chieftain'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install chieftain
+
+## Usage
+
+The Command pattern encapsulates the functionality for a particular process
+allowing it to be de-couple from where that functionality is invoked and to
+allow the functionality to be test independently. With the Chieftain library
+the pattern is implemented by creating a class that derives from the
+``Chieftain::Command`` class. The example below shows and minimalistic
+command class...
+
+```ruby
+  class ExampleCommand < Chieftain::Command
+    def perform
+      # Your command functionality goes here.
+    end
+  end
+```
+
+Here the ``ExampleCommand`` class derives from the ``Chieftain::Command`` class
+and provides an implementation of the ``#perform()`` method. The ``#perform()``
+method is where you place the code that performs the work on the command. An
+example of using this class would look as follows...
+
+```ruby
+  command = ExampleCommand.new
+  result  = command.execute
+```
+
+In this case the command takes no parameters bit but see the next section to see
+how parameters are handled by the command. This example also shows how to invoke
+the command functionality by calling the ``#execute()`` method. This method will
+return a ``Chieftain::Command::Result`` instance that provides information on
+the success or failure of the command execution.
+
+Commands can fail for a number of reasons, including missing required
+parameters, parameter values failing validation or conversion or because the
+actual command perform code indicates a failure. You can check whether a
+``Result`` instance represent a successful execution by invoking the
+``#success?()`` method (or it's inverse ``#failed?()``).
+
+If a command has failed then that means it will have one or more errors
+generated during execution. You can access these directly by calling the
+``#errors()`` method on the ``Result`` object. This returns an ``Array``
+of ``Chieftain::Command::Error`` instances representing the errors for
+the command execution. If you just want error message strings then call the
+``#error_messages()`` method instead.
+
+### Parameters
+
+You can pass parameters to your command by passing a ``Hash`` containing the
+parameters to the command constructor. The keys for this ``Hash`` should be
+``Symbol``s, with the ``Symbol`` becoming the parameter name, so these will
+also have to adhere to Ruby's method naming requirements.
+
+Before you pass parameters to your command you should make the command class
+aware that the parameter is expected. When 'declaring' your parameter to your
+command class you should decide whether the parameter is mandatory or
+optional. Required parameters, as might be expected, need to have a value
+specified for them when the command is created. Optional parameters can
+appear in a parameter list but isn't required to. So, an example of how
+this may look is given below...
+
+```ruby
+  class CreatePerson < Chieftain::Command
+    required :first_name
+    required :last_name
+    optional :middle_name
+  end
+```
+
+Here the command has two parameters that must be provided when the command is
+instantiated and one that may be provided. So the following are valid ways to
+construct this command...
+
+```ruby
+  CreatePerson.new(first_name: "John", last_name: "Smith").execute
+  CreatePerson.new(first_name: "Joseph",
+                   middle_name: "Frank",
+                   last_name: "Bloggs").execute
+```
+
+The required aspect of a parameter is not checked at construction but is instead
+checked when you try to execute the command. If a required parameter is not
+present in the commands parameter set then an error noting this will be
+registered on the command, validation will fail, the ``#perform()`` method will
+not be invoked and a fail result will be returned.
+
+### Convertors
+
+When defining parameters for a command you can also provide an indication of the
+expected type for the parameter. An example of this is shown below...
+
+```ruby
+  class CreatePerson < Chieftain::Command
+    required :name, type: :string
+    optional :age, type: :integer
+  end
+```
+
+In this case the command has two parameter defined. The first is expected to
+be a string value and the second to be an integer. If the value actually
+provided for the parameter is not of this type then an attempt will be made
+to coerce to this type. If this effort fails then the command will fail
+validation and return an unsuccessful result.
+
+The Chieftain library defines the following types (and associated conversion
+functionality) - :boolean, :float, :integer and :string. It is possible to
+extend this set by defining a custom convertor class and making it available
+to your command class.
+
+Convertor classes are any class that provides an implementation for two methods
+called ``#convertible?()`` and ``#convert()``. The ``#convertible()`` method
+takes a single parameter which will be the raw value provided to the command for
+the parameter. The method should determine whether this value can be converted
+to the appropriate type, returning true if that is the case and false otherwise.
+The ``#convert()`` method takes the same parameter but should return a value of
+the appropriate type post conversion.
+
+You can make a convertor class available as a type on a command class by
+declaring it using the the ``#add_convertor()`` class method. The following
+is an example of doing this...
+
+```ruby
+  # Convertor that converts a time string to the number of seconds since the
+  # start of the day.
+  class TimeConverter
+    def convertible?(value)
+      parts = value.to_s.split(":").map(&:to_i)
+      parts.length == 3 &&
+      (parts[0] >= 0 && parts[0] < 24) &&
+      (parts[1] >= 0 && parts[1] < 60) &&
+      (parts[2] >= 0 && parts[2] < 60)
+    end
+
+    def convert(value)
+      parts = value.to_s.split(":").map(&:to_i)
+      (parts[0] * 3600) + (parts[1] * 60) + parts[2]
+    end
+  end
+
+  class ExampleCommand < Chieftain::Command
+    required :timestamp, type: :time
+
+    add_convertor :time, TimeConvertor
+  end
+```
+
+Here a ``TimeConvertor`` class is first defined. The command then declares a
+``:timestamp`` parameter and indicates it's ``type`` as ``:time``. After this
+the command 'adds' a convertor by calling the ``#add_convertor()`` class. This
+call takes two parameters. The first is the name to be associated with the new
+convertor. The second is the convertor class.
+
+One final note with regards to convertors. Custom convertors declared in a
+parent class will be available in derived classes. Note that, if your derived
+class adds a new convertor with a name that clashes with a convertor declared
+in a parent, the new convertor takes precedence and the one from the parent
+is not available.
+
+### Validations
+
+Validations are a mechanism for outlining a set of checks for a command
+parameter. The library defines a set of predefined validations that are
+available for use on every command. Additional validations can be defined
+within a command and specified as applicable to a one or more of the command
+parameters. An example of defining a validation is shown below...
+
+```ruby
+  class ExampleCommand < Chieftain::Command
+    required :code, type: :string, validations: [:length_check]
+
+    add_validator(:length_check) do |name, value|
+      if value.length != 10
+        error("The '#{name}' parameter must be exactly 10 characters in length.")
+      end
+    end
+  end
+```
+
+In this example you can see that a single parameter with the name code is
+defined for the ``ExampleCommand`` class. As part of the definition for this
+parameter we see that the ``validations`` setting has been set to an ``Array``
+containing the single ``Symbol`` ``:length_check``. This is the name of a
+validations that is expected to exist and will be applied to the parameter
+whenever validations take place.
+
+Later in the class we can see the definition of the ``:length_check`` validation
+using the ``#add_validator()`` method. This method takes a single parameter
+which is the name of the validation. This must be a ``Symbol`` and validation
+names must be unique within the context of a class.
+
+The ``#add_validator()`` method also accepts a block, with the block defining
+the functionality of the validation. This block will get executed within the
+context of the invoking command class instance (i.e. ``self`` will refer to the
+command instance). The block should also accept two parameters. The first is the
+name of the parameter being validated. The second will be the value supplied for
+the parameter.
+
+In the example given above the validation checks that the parmaeter value
+provided, which will be a string, must have a length of 10. In the case that the
+value provided does not have this length then an error is register on the
+command instance the validation was invoked by. There is another more concise
+form that can be used to achieve the same result and this is shown in the
+example below...
+
+```ruby
+  class ExampleCommand < Chieftain::Command
+    required :code, type: :string
+
+    validate(:code) do |name, value|
+      if value.length != 10
+        error("The '#{name}' parameter must be exactly 10 characters in length.")
+      end
+    end
+  end
+```
+
+Here we define a validation using the ``#validate()`` method (which is really
+just a synonym for the the ``#add_validator()`` method but is more fitting for
+this form of the code). The validations has the same name as the parameter and
+doing this will cause the command to automatically apply it to the parameter
+when it gets validated.
+
+One final note with regards to validations. Custom validations declared in a
+parent class will be available in derived classes. Note that, if your derived
+class adds a new validation with a name that clashes with a validation declared
+in a parent, the new validation takes precedence and the one from the parent
+is not available.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can
+also run `bin/console` for an interactive prompt that will allow you to
+experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chieftain.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/chieftain/command.rb

@@ -0,0 +1,394 @@
+require "ostruct"
+
+module Chieftain
+  # An implementation of the Command design pattern that aims to take some
+  # advantage of Ruby's enhanced capabilities.
+  class Command
+    # The type associated with errors that prevent a Command from executing.
+    class Error
+      def initialize(message, code=nil)
+        @code    = code
+        @message = message
+      end
+      attr_reader :code, :message
+      alias :to_s :message
+
+      def to_s
+      end
+    end
+
+    # The type returned by a Command class when it is executed.
+    class Result
+      def initialize(value, errors=[])
+        @errors = errors
+        @value  = value
+      end
+      attr_reader :errors, :value
+
+      def error_codes
+        errors.map(&:code)
+      end
+
+      def error_messages
+        errors.map(&:message)
+      end
+
+      def failed?
+        !success?
+      end
+      alias :error? :failed?
+
+      def success?
+        errors.empty?
+      end
+    end
+
+    @@convertors = {self => {}}
+    @@parameters = {self => {}}
+    @@validators = {self => {}}
+
+    def initialize(parameters={})
+      @convertors = Command.convertors_for(self.class)
+      @errors     = []
+      @parameters = {}.merge(parameters)
+      @settings   = Command.parameters(self.class)
+      @validators = Command.validators_for(self.class)
+    end
+    attr_reader :convertors, :errors, :parameters, :settings, :validators
+
+    # Test whether a given value is convertible for a named parameter. This will
+    # return true if the parameter is expected and either has no type specified
+    # or the value given can be converted to the parameters specified type.
+    def convertible?(name, value)
+      result = false
+      if expects?(name)
+        result   = true
+        settings = @settings[name]
+        if settings.type
+          result = get_convertor(settings.type).convertible?(value)
+        end
+      end
+      result
+    end
+
+    # Register an error with the execution of the current Command.
+    def error(message)
+      @errors << Error.new(message)
+    end
+
+    # Invokes the #perform() method if and only if the Command instance tests as
+    # valid. This method should be the one invoked to run a Command instance.
+    def execute
+      @errors = []
+      value   = nil
+      value = perform if valid?
+      Result.new(value, errors)
+    end
+
+    # Returns a list of the expected parameters configured for a Command
+    # instance.
+    def expected_parameter_names
+      @settings ? @settings.values.map(&:name) : []
+    end
+
+    # Tests whether a parameter name is among the parameters specified for the
+    # Command instance.
+    def expects?(parameter)
+      expected_parameter_names.include?(parameter)
+    end
+
+    # Retrieve the value for a named parameter. The value will be run through an
+    # applicable converted prior to being returned. An exception will be raised
+    # if conversion fails. If the parameter is optional and has not be specified
+    # then conversion will not be attempted and nil will be returned.
+    def get_parameter_value(name)
+      if expects?(name)
+        settings = settings_for(name)
+        if settings[:required] && !provided?(name)
+          raise ParameterError.new("A value has not been provided for the '#{name}' parameter.", name)
+        end
+
+        if settings[:required] || provided?(name)
+          value     = get_raw_parameter_value(name)
+          convertor = get_convertor(settings.type)
+          if !convertor.convertible?(value)
+            raise ParameterError.new("The value of the '#{name}' parameter cannot be converted to the '#{settings.type}' type.", name)
+          end
+          convertor.convert(value)
+        else
+          nil
+        end
+      else
+        raise ParameterError.new("Unknown parameter '#{name}' requested from a '#{self.class.name}' command instance.")
+      end
+    end
+
+    # Fetches a name convertor from the list for the Command instance, raises
+    # an exception if one cannot be found.
+    def get_convertor(type)
+      if !has_convertor?(type)
+        raise CommandError.new("Unable to locate the '#{type}' parameter convertor.")
+      end
+      @convertors[type]
+    end
+
+    # Fetches the raw, unaltered value specified for a name parameter to the
+    # Command instance. Returns nil if the specified parameter has not been
+    # given an explicit value. Raises an exception if an unknown parameter is
+    # specified.
+    def get_raw_parameter_value(name)
+      raise ParameterError.new("Unknown parameter '#{name}' requested in command.", name) if !expects?(name)
+      @parameters[name]
+    end
+
+    # This method tests whether a named convertor is available to a Command
+    # instance.
+    def has_convertor?(name)
+      @convertors.include?(name)
+    end
+
+    # An implementation of the #method_missing method for the Command class that
+    # checks whether a parameter is being requested and, if so, returns it's value
+    # or delegates handling to the parent class implementation.
+    def method_missing(name, *arguments, &block)
+      if expects?(name)
+        get_parameter_value(name)
+      else
+        super
+      end
+    end
+
+    # Returns a list of the names of the commands optional parameters.
+    def optional_parameter_names
+      settings.values.filter {|p| !p.required}.map(&:name)
+    end
+
+    # Returns a list of the names of the parameters specified to the Command
+    # instance.
+    def parameter_names
+      @settings.keys
+    end
+
+    # Derived command classes should override this method to do the work for the
+    # command. This method will only get invoked if the command is valid. This
+    # default implementation raises an exception.
+    def perform
+      raise CommandError.new("The #{self.class.name} command class has not overridden the #perform() method.")
+    end
+
+    # This method checks whether a name parameter is among those provided to a
+    # Command instance.
+    def provided?(name)
+      @parameters.include?(name)
+    end
+
+    # Returns a list of the names of the commands required parameters. Note a
+    # required parameter must have a value specified for it when the command
+    # is executed.
+    def required_parameter_names
+      settings.values.filter {|p| p.required}.map(&:name)
+    end
+
+    # Retrieves the parameter settings for a named parameter. Raises an
+    # exception if an unknown parameter is specified.
+    def settings_for(name)
+      raise ParameterError("Unknown parameter '#{name}' requested in command.", name) if !expects?(name)
+      entry = @settings.find {|entry| entry[1].name == name}
+      entry ? entry[1] : nil
+    end
+
+    # Performs validation of the parameters passed to a command. Deriving classes
+    # should ensure this method is invoked in any custom #validate method their
+    # class provides.
+    def validate
+      @settings.values.each do |parameter|
+        if provided?(parameter.name)
+          if parameter.type
+            # Check conversion.
+            if has_convertor?(parameter.type)
+              convertor = get_convertor(parameter.type)
+              if !convertor.convertible?(get_raw_parameter_value(parameter.name))
+                error("The value of the '#{parameter.name}' parameter cannot be converted to the '#{parameter.type}' type.")
+              end
+            else
+              error("Invalid type '#{parameter.type}' specified for the '#{parameter.name}' parameter.")
+            end
+          end
+
+          # Run validations.
+          if convertible?(parameter.name, get_raw_parameter_value(parameter.name))
+            value = get_parameter_value(parameter.name)
+            validations_for(parameter.name).each do |validation|
+              self.instance_exec(parameter.name, value, &validation)
+            end
+          else
+            error("The value of the '#{parameter.name}' parameter cannot be converted to the '#{parameter.type}' type.")
+          end
+        else
+          if parameter.required
+            error("No value specified for the '#{parameter.name}' required parameter.")
+          end
+        end
+      end
+    end
+
+    # Invokes the validate command and then checks that there are no errors
+    # registered for the command.
+    def valid?
+      @errors = []
+      validate
+      @errors.empty?
+    end
+
+    # Returns a list of the validators that apply to a named parameter. This
+    # will be a combination of validators explicitly declared on the parameter
+    # and class validators with the same name as the parameter. The method
+    # raises an exception if given the name of a parameter that the Command
+    # instance does not expect. It can also raise an exception if a parameter
+    # has an unknown validator specified for it.
+    def validations_for(name)
+      if !expects?(name)
+        raise ParameterError.new("Validators requested for unknown parameter '#{name}'.", name)
+      end
+      settings = @settings[name]
+      names    = []
+      names << name if @validators.include?(name)
+      names = names.concat(settings.validations) if settings.validations
+      names.uniq.map do |key|
+        if !@validators.include?(key)
+          raise ParameterError.new("Unknown validation '#{key}' requested for the '#{name}' parameter.", name)
+        end
+        @validators[key]
+      end
+    end
+
+    # Registers a convertor for a Command class. A convertor is any class that
+    # can be constructed using a default constructor and responds to the
+    # #convertible?() and #convert() methods. Both of these methods take a
+    # single parameter which is the value to undergo conversion. The
+    # #convertible?() method returns true if it's possible to convert the value
+    # to the convertors output type. The #convert() method performs the actual
+    # conversion, returning the result.
+    def self.add_convertor(name, convertor_class)
+      @@convertors[self] = {} if !@@convertors.include?(self)
+      if @@convertors[self].include?(name)
+        raise CommandError.new("Duplicate convertor '#{name}' specified for the #{self.name} class.")
+      end
+
+      @@convertors[self][name] = convertor_class
+    end
+
+    # Registers a validator for a Command class. A validator has to be registered
+    # with a block that will be invoked for the relevant parameters. This block
+    # should take 3 parameters. The first is the command object being executed.
+    # The second is the name of the parameter being validated. The third is the
+    # value of the parameter being validated. Validators can register errors by
+    # invoking the #error() method on the command they are passed.
+    def self.add_validator(name, &block)
+      @@validators[self] = {} if !@@validators.include?(self)
+      if @@validators[self].include?(name)
+        raise CommandError.new("Duplicate validator '#{name}' specified for the #{self.name} class.")
+      end
+
+      if !block
+        raise CommandError.new("No block specified for the '#{name}' validator in the #{self.name} class.")
+      end
+
+      @@validators[self][name] = block
+    end
+
+    # This method scans the class hierarchy for a Command instance and assembles
+    # a list of the registered convertors for it. Convertors registered in classes
+    # lower in the hierarchy (i.e. derived classes) override those registered in
+    # parent classes.
+    def self.convertors_for(command_class)
+      hierarchy = [command_class]
+      while !hierarchy.last.superclass.nil?
+        hierarchy << hierarchy.last.superclass
+      end
+
+      convertors = {}
+      hierarchy.reverse.each do |c|
+        convertors.merge!(@@convertors[c]) if @@convertors.include?(c)
+      end
+      convertors.inject({}) {|list, entry| list[entry[0]] = entry[1].new; list}
+    end
+
+    # Registers an optional parameter for the command. See the #parameter() method
+    # for details of the parameters this method accepts.
+    def self.optional(name, settings={}, &block)
+      parameter(name, {}.merge(settings, {required: false}), &block)
+    end
+
+    # Register a new parameter for a Command class. The first method parameter
+    # specifies the new parameters name. This can be followed by a Hash of
+    # settings value for the parameter. All keys in this Hash should be symbols
+    # and the following keys are currently recognised - :required, :types and
+    # :validators. You can also register a block for a parameter. This block
+    # will be invoked with the raw parameter value and the return value from this
+    # block will become the actual parameter value used.
+    def self.parameter(name, settings={}, &block)
+      if self.method_defined?(name)
+        raise ParameterError.new("The '#{name}' parameter clashes with an existing class method.", name)
+      end
+      @@parameters[self]       = {} if !@@parameters.include?(self)
+      @@parameters[self][name] = OpenStruct.new({}.merge(settings, {name: name, block: block}))
+    end
+
+    # Fetches the parameter list registered for a specific Command class
+    # instance.
+    def self.parameters(command_class)
+      @@parameters[command_class]
+    end
+
+    # Registers an optional parameter for the command. See the #parameter() method
+    # for details of the parameters this method accepts.
+    def self.required(name, settings={}, &block)
+      parameter(name, {}.merge(settings, {required: true}), &block)
+    end
+
+    # A synomym for the #add_validator() method that is intended for use with
+    # a validator that matches a parameter name.
+    def self.validate(name, &block)
+      add_validator(name, &block)
+    end
+
+    # This method scans the class hierarchy for a Command instance and assembles
+    # a list of the registered validators for it. Validators registered in classes
+    # lower in the hierarchy (i.e. derived classes) override those registered in
+    # parent classes.
+    def self.validators_for(command_class)
+      hierarchy = [command_class]
+      while !hierarchy.last.superclass.nil?
+        hierarchy << hierarchy.last.superclass
+      end
+
+      validators = {}
+      hierarchy.reverse.each do |c|
+        validators.merge!(@@validators[c]) if @@validators.include?(c)
+      end
+      validators
+    end
+
+    # ----------------------------------------------------------------------------
+    # Add default library validators
+    # ----------------------------------------------------------------------------
+    add_validator(:not_blank) do |name, value|
+      if [nil, ""].include?("#{value}".strip)
+        error("Blank value specified for the '#{name}' parameter.")
+      end
+    end
+
+    add_validator(:not_nil) do |name, value|
+      error("Nil value specified for the '#{name}' parameter.") if value.nil?
+    end
+
+    # ----------------------------------------------------------------------------
+    # Add default library convertors
+    # ----------------------------------------------------------------------------
+    add_convertor :boolean, Chieftain::BooleanConvertor
+    add_convertor :float, Chieftain::FloatConvertor
+    add_convertor :integer, Chieftain::IntegerConvertor
+    add_convertor :string, Chieftain::StringConvertor
+  end
+end

data/lib/chieftain/convertors.rb

@@ -0,0 +1,50 @@
+module Chieftain
+  # A convertor for boolean values.
+  class BooleanConvertor
+    VALID_TRUE_VALUES  = ["1", "on", "true", "y", "yes"]
+    VALID_FALSE_VALUES = ["0", "false", "n", "no", "off"]
+    VALID_VALUES       = VALID_FALSE_VALUES + VALID_TRUE_VALUES
+
+    def convertible?(value)
+      [FalseClass, TrueClass].include?(value.class) ||
+      VALID_VALUES.include?(value.to_s.downcase)
+    end
+
+    def convert(value)
+      VALID_TRUE_VALUES.include?(value.to_s.downcase)
+    end
+  end
+
+  # A convertor floating point values.
+  class FloatConvertor
+    def convertible?(value)
+      value.to_f.to_s == "#{value}"
+    end
+
+    def convert(value)
+      value.to_f
+    end
+  end
+
+  # A convertor for integer values.
+  class IntegerConvertor
+    def convertible?(value)
+      value.to_i.to_s == "#{value}"
+    end
+
+    def convert(value)
+      value.to_i
+    end
+  end
+
+  # A convertor for string values.
+  class StringConvertor
+    def convertible?(value)
+      true
+    end
+
+    def convert(value)
+      value.to_s
+    end
+  end
+end

data/lib/chieftain/exceptions.rb

@@ -0,0 +1,17 @@
+module Chieftain
+  # The root exception class used by the Chieftain class hierarchy.
+  class CommandError < StandardError
+    def initialize(message)
+      super(message)
+    end
+  end
+
+  # A command error class relating specifically to a parameter.
+  class ParameterError < CommandError
+    def initialize(message, parameter)
+      super(message)
+      @parameter = parameter
+    end
+    attr_reader :parameter
+  end
+end

data/lib/chieftain/version.rb

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

data/lib/chieftain.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "chieftain/version"
+require_relative "chieftain/exceptions"
+require_relative "chieftain/convertors"
+require_relative "chieftain/command"

data/sig/chieftain.rbs

@@ -0,0 +1,4 @@
+module Chieftain
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: chieftain
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Wood
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-11-14 00:00:00.000000000 Z
+dependencies: []
+description: An implementation of the command design pattern that attempts to simplify
+  usage by enchancing the offering making use of the facilities offered by the Ruby
+  language.
+email:
+- pw0470@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/chieftain.rb
+- lib/chieftain/command.rb
+- lib/chieftain/convertors.rb
+- lib/chieftain/exceptions.rb
+- lib/chieftain/version.rb
+- sig/chieftain.rbs
+homepage: https://github.com/free-beer/chieftain
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/free-beer/chieftain
+  source_code_uri: https://github.com/free-beer/chieftain
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+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: An implementation of the Command design pattern in Ruby.
+test_files: []