riker 0.1.0.pre1 → 0.1.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 118d01c238106a4db76b383d058edba59999634dd378d5e3242286f16cab4d8d
-  data.tar.gz: 119108e45c1c61f4180d9e449faf3e63f54a7b6d9459b2b50a83e6fa12ee38ab
+  metadata.gz: b819ce3e2d6fb0f84fd16e4eb754802ca3c655810179225c9f4ba9cff3d8f068
+  data.tar.gz: ab2a5b0a1e9f3beb29c1ba8437de4b50be42f395c79cc833985c7da082c572f4
 SHA512:
-  metadata.gz: 4f561a760b96120969cedf5e8d1012031595bc90f77da8388be858309a4cfa8e5469881b864698491eab016fdbdd92fc056ce603e0c899ce40120d6b42634a0f
-  data.tar.gz: 4ec66c575a6c3fc4999d0ac3a835e225ed74a23dc4f7a5da27feaf2bf35fc7908772088b6bd8570eca868b7c1a0698b413499265e96b4707f66a97ce3b9e0218
+  metadata.gz: ae433f9f555ceee2b68121953086c7de1e340773ccd1dc802a254126a7bcee94f7f77d2f28427b29e89a6f2e738f9b7aeb5ec709951eb84c150de49bff58ef9c
+  data.tar.gz: 65a9c8f2be649a18223f3f97caf10b628155f6e0ac54b7891aba504616084eaa6ef85f79f7ac96ff55d7d057d18070bc3a84e527a0ba4b0faac276c80509e74b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    riker (0.1.0)
+    riker (0.1.0.pre2)
 
 GEM
   remote: https://rubygems.org/
@@ -46,6 +46,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   rake (~> 13.0)

data/README.md

@@ -1,5 +1,74 @@
 # Riker
 
+[![Version](https://img.shields.io/gem/v/riker.svg?style=flat-square)](https://rubygems.org/gems/riker)
+[![Test](https://img.shields.io/github/workflow/status/benfalk/riker/Test?label=Test&style=flat-square)](https://github.com/benfalk/riker/actions?query=workflow%3ATest)
+
 <img src="./assets/commander-riker.jpeg" />
 
 High-Performance, Dependency-Free Command Pattern For Ruby
+
+## Simple Usage
+
+### In your gemfile:
+
+```ruby
+gem 'riker', '0.1.0.pre3'
+```
+
+### In your code:
+
+```ruby
+class SimpleGreeting
+  extend Riker
+
+  param :first_name
+  param :last_name, required: false
+  param :punctuation, default: '.'
+
+  execute do
+    return "Hello #{first_name}#{punctuation}" if last_name.nil?
+
+    "Hello #{first_name} #{last_name}#{punctuation}"
+  end
+end
+```
+
+### In use:
+
+```ruby
+SimpleGreeting.run!(first_name: 'Will')
+# => "Hello Will."
+
+SimpleGreeting.run!(first_name: 'Will', last_name: 'Riker')
+# => "Hello Will Riker."
+
+SimpleGreeting.run!(first_name: 'Will', last_name: 'Riker', punctuation: '!')
+# => "Hello Will Riker!"
+```
+
+## Default Procs
+
+### In your code:
+
+```ruby
+class CaptainsLog
+  extend Riker
+
+  param :stardate, default: -> { Time.now.to_f }
+  param :message
+
+  execute do
+    "Captain's Log; Stardate: #{stardate}\n\n#{message}"
+  end
+end
+```
+
+### In use:
+
+```ruby
+CaptainsLog.run!(message: "The Borg are attacking!")
+# => "Captain's Log; Stardate: 1664393978.915553\n\nThe Borg are attacking!"
+
+CaptainsLog.run(message: "We've traveled back in time!", stardate: 42.1337)
+# => "Captain's Log; Stardate: 42.1337\n\nWe've traveled back in time!"
+```

data/lib/riker/command.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Riker
+  # Command Builder
+  #
+  # This is responsible for orchestrating and keeping
+  # track of the build of a command in your application
+  #
+  class Command
+    # @return [Riker::CommandParameters]
+    attr_reader :parameters
+
+    # @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
+    end
+  end
+end

data/lib/riker/command_parameters.rb

@@ -0,0 +1,52 @@
+# 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

data/lib/riker/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Riker
+  class Error < StandardError; end
+end

data/lib/riker/parameter.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'parameter/default_value'
+
+module Riker
+  # Single Command Parameter
+  #
+  class Parameter
+    # @return [Symbol]
+    attr_reader :name
+
+    # @return [DefaultValue]
+    attr_reader :default
+
+    # @param name [Symbol]
+    # @param required [Boolean]
+    # @param default [Object, Proc]
+    def initialize(
+      name,
+      required: true,
+      default: DefaultValue.no_value
+    )
+      @name = name
+      @required = required
+      @default = DefaultValue.new(name, default)
+    end
+
+    # @return [Boolean]
+    def required?
+      @required
+    end
+
+    # @return [String]
+    def ctor_arg
+      @ctor_arg ||= "#{name}: #{fallback_default}"
+    end
+
+    # @return [String]
+    def variable_set
+      @variable_set ||= "@#{name} = #{name}"
+    end
+
+    private
+
+    def fallback_default
+      return default.function_name if default.present?
+      return if required?
+
+      'nil'
+    end
+  end
+end

data/lib/riker/version.rb

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

data/lib/riker.rb

@@ -1,8 +1,31 @@
 # frozen_string_literal: true
 
 require_relative 'riker/version'
+require_relative 'riker/error'
+require_relative 'riker/command'
+require_relative 'riker/command_parameters'
+require_relative 'riker/parameter'
 
+# The Commander of the USS Enterprise
 module Riker
-  class Error < StandardError; end
-  # Your code goes here...
+  # @param klass [Class]
+  def self.extended(klass)
+    klass.instance_variable_set(:@command, Command.new)
+  end
+
+  # @return [Riker::Command]
+  attr_reader :command
+
+  # @param name [Symbol]
+  def param(name, **options)
+    command.parameters.add(name, **options)
+  end
+
+  # @block the logic of the command
+  def execute(&block)
+    raise Error, "execute block already called for #{self}!" if command.execute_block
+
+    command.execute_block = block
+    command.build!(self)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riker
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre1
+  version: 0.1.0.pre3
 platform: ruby
 authors:
 - Benjamin Falk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2022-09-28 00:00:00.000000000 Z
 dependencies: []
 description: High-Performance, Dependency-Free Command Pattern For Ruby
 email:
@@ -28,6 +28,10 @@ files:
 - bin/console
 - bin/setup
 - lib/riker.rb
+- lib/riker/command.rb
+- lib/riker/command_parameters.rb
+- lib/riker/error.rb
+- lib/riker/parameter.rb
 - lib/riker/version.rb
 - sig/riker.rbs
 homepage: