riker 0.1.0.pre2 → 0.1.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86f0741a4cd82edba656094d41663f3a119ee7a6e6019d2417d3f12ef459dcdc
-  data.tar.gz: b82ff16ca094921419d09c2c4e8f2888dc35b228d086916135b6977ff2138656
+  metadata.gz: b819ce3e2d6fb0f84fd16e4eb754802ca3c655810179225c9f4ba9cff3d8f068
+  data.tar.gz: ab2a5b0a1e9f3beb29c1ba8437de4b50be42f395c79cc833985c7da082c572f4
 SHA512:
-  metadata.gz: acde908c28b815b7e77d75e0a8a68cb94c2f106b03bcb56fb608dc812465de8692ffd630c080279a7eb275a90b37a414c25699e1091d77a2632dbb78c18da576
-  data.tar.gz: 21b81e7a1f99bd1236d60b4603b6614751fad3e1158eaf39fe3593536d7a21d4b81bc9b2d492beed713b4a24a4ccb256ba6b3bf53582db0dd69d1199f330dea2
+  metadata.gz: ae433f9f555ceee2b68121953086c7de1e340773ccd1dc802a254126a7bcee94f7f77d2f28427b29e89a6f2e738f9b7aeb5ec709951eb84c150de49bff58ef9c
+  data.tar.gz: 65a9c8f2be649a18223f3f97caf10b628155f6e0ac54b7891aba504616084eaa6ef85f79f7ac96ff55d7d057d18070bc3a84e527a0ba4b0faac276c80509e74b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    riker (0.1.0.pre1)
+    riker (0.1.0.pre2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -12,7 +12,7 @@ High-Performance, Dependency-Free Command Pattern For Ruby
 ### In your gemfile:
 
 ```ruby
-gem 'riker', '0.1.0.pre2'
+gem 'riker', '0.1.0.pre3'
 ```
 
 ### In your code:
@@ -23,9 +23,12 @@ class SimpleGreeting
 
   param :first_name
   param :last_name, required: false
+  param :punctuation, default: '.'
 
   execute do
-    "Hello #{first_name} #{last_name}".strip
+    return "Hello #{first_name}#{punctuation}" if last_name.nil?
+
+    "Hello #{first_name} #{last_name}#{punctuation}"
   end
 end
 ```
@@ -34,8 +37,38 @@ end
 
 ```ruby
 SimpleGreeting.run!(first_name: 'Will')
-# => "Hello Will
+# => "Hello Will."
 
 SimpleGreeting.run!(first_name: 'Will', last_name: 'Riker')
-# => "Hello Will 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

@@ -7,7 +7,7 @@ module Riker
   # track of the build of a command in your application
   #
   class Command
-    # @return [Riker::Parameters]
+    # @return [Riker::CommandParameters]
     attr_reader :parameters
 
     # @return [Proc, nil]
@@ -20,6 +20,7 @@ module Riker
     # @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)
@@ -50,5 +51,12 @@ module Riker
     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/parameter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'parameter/default_value'
+
 module Riker
   # Single Command Parameter
   #
@@ -7,11 +9,20 @@ module Riker
     # @return [Symbol]
     attr_reader :name
 
+    # @return [DefaultValue]
+    attr_reader :default
+
     # @param name [Symbol]
     # @param required [Boolean]
-    def initialize(name, required: true)
+    # @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]
@@ -32,6 +43,7 @@ module Riker
     private
 
     def fallback_default
+      return default.function_name if default.present?
       return if required?
 
       'nil'

data/lib/riker/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riker
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre2
+  version: 0.1.0.pre3
 platform: ruby
 authors:
 - Benjamin Falk
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-26 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: