runfile 1.0.0.rc3 → 1.0.0.rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87fc70007827b06c5dc191a36501383e7cbbff057ab8b237e4fd1c6ecc1cc359
-  data.tar.gz: 63a028d2937711589b69f73003ddc367326fd0dc2d4decfad10e29e3b1d44078
+  metadata.gz: ab0dde51597dac5b5f75e8c7fe4fd627d94b70251a9f7ada897fad07f32573fc
+  data.tar.gz: aa612294f0247bcfed789fa7a9704798f611ec83dbb80a55fe9c18eb85ad6d07
 SHA512:
-  metadata.gz: ebdb28b94a76ad187975256fb7e3ab9d423e3b86af833f20b52d91e74886b4b03fd2a8849bdf1f50cd97c26978742f42a3522f375bd3d6567f5bb46c675b9ac2
-  data.tar.gz: fd87911f07745dff40c82bb8c4245cf309eae294799dbee320521c7d38b50a0c9575d9ad15fde44974c18639c05c3223712cf517389c149e6a9bd97020344b02
+  metadata.gz: cc5ed99c7b6cd47d7f3a64418ac62698f46c5e5ee1e55edb3bdf18ef157e4764efadd874ab2767a0be50ee98e0592195546d63c6f988607cb25cc6ce9de03cd8
+  data.tar.gz: b6d0ff5c3e8fd53b048c2e5b35ebf180ef2a4f44e05b2a271e7defb572ad654258f140bcb40fa3048b84a999201e7ff5a3067d3db4ab4835c5f8f8f3aff1b990

data/README.md

@@ -32,9 +32,6 @@ Note that this README describes the not yet released 1.0.0 version.
 See [runfile.dannyb.co](https://runfile.dannyb.co/) for the stable release
 documentation.
 
-During the pre-release phase, the `run` executable is called `runn` instead, 
-to allow running both the stable and pre-release version side by side.
-
 ## Demo
 
 ![Runfile Demo](demo.svg "Runfile Demo")
@@ -55,8 +52,8 @@ $ vi runfile     # edit the runfile
 
 ## Example
 
-A simple `runfile` looks like this. You can get this template by running `run
-new` ()in a directory without other runfiles).
+A simple `runfile` looks like this. You can get this template by running 
+`run new` (in a directory without other runfiles).
 
 ```ruby
 title   'Greeter'
@@ -172,6 +169,12 @@ This is a cosmetic change for consistency. All generated output shows long flags
 before short flags `--force, -f` instead of `-f, --force`. Update your custom
 `usage` directives accordingly.
 
+### Examples no longer add implicit 'run'
+
+If you were using the `example` directive, it will no longer add the initial
+`run` in front of your examples. Add it yourself. This is intended to allow
+providing more elaborate examples.
+
 ### RunfileTasks
 
 The `RunfileTasks` gem is also released as a pre-release, if you are using it

data/examples/action-shortcut/runfile

@@ -0,0 +1,21 @@
+title 'Shortcut for an action'
+summary 'Providing an alias shortcut for actions'
+
+# $ run greet :
+# $ run g     : will both execute this block
+action :greet, :g do
+  say 'r`Greetings`'
+end
+
+# $ run salute
+# $ run s --red
+#
+# Notice the explicit `usage` which is required when when parameters (--red)
+# are needed. In this case, to support the shortcut you need to provide it
+# as (salute | s)
+usage '(salute | s) [--red]'
+option '--red', 'In red'
+action :salute, :s do |args|
+  color = args['--red'] ? 'r' : 'b'
+  say "#{color}`Salutations`"
+end

data/examples/full/runfile

@@ -8,6 +8,7 @@ option  '--color, -c CODE', 'One letter color code [default: g]'
 option  '--bold, -b', 'Show in bold'
 param   'MESSAGE', 'Message to say'
 env_var 'COLOR', 'Set color code (same as --color)'
+env_var 'API_KEY', 'Set API Key'
 example 'run say hello'
 example 'run say hello -cr --bold'
 action :say, :s do |args|

data/examples/shortcut/runfile

@@ -1,31 +1,12 @@
-title 'Shortcut for an action'
-summary 'Providing an alias shortcut for actions can be done in one of two ways'
+import 'server'
 
-# $ run greet :
-# $ run g     : will both execute this block
-shortcut :g
-action :greet do
-  say 'r`Greetings`'
-end
-
-# $ run salute
-# $ run s --red
-#
-# Notice the explicit `usage` which is required when when parameters (--red)
-# are needed. In this case, to support the shortcut you need to provide it
-# as (salute | s)
-usage '(salute | s) [--red]'
-option '--red', 'In red'
-shortcut :s
-action :salute do |args|
-  color = args['--red'] ? 'r' : 'b'
-  say "#{color}`Salutations`"
-end
+# Create command shortcuts
+shortcut 'sayhi', 'hello "new runfile user"'
+shortcut 's', 'server start'
 
-# $ run toast
-# $ run t
-#
-# Shortcut may also be provided as a second argument to the `action` directive
-action :toast, :t do
-  say 'Toasts'
+usage  'hello [NAME]'
+help   'Say hello'
+action 'hello' do |args|
+  name = args['NAME'] || 'You...'
+  say "Hello g`#{name}`"
 end

data/examples/shortcut/server.runfile

@@ -0,0 +1,3 @@
+action :start do
+  puts 'server is starting...'
+end

data/lib/runfile/action.rb

@@ -8,16 +8,13 @@ module Runfile
     attr_reader :name, :shortcut
     attr_accessor :block, :help, :host
 
-    def full_name
-      @full_name ||= if shortcut
-        "#{prefix} (#{name} | #{shortcut})".strip
-      else
-        "#{prefix} #{name}".strip
-      end
+    def command_string
+      result = names.join(', ')
+      result.empty? ? '(default)' : result
     end
 
     def implicit_usages
-      usages.empty? ? [full_name] : usages
+      usages.empty? ? [usage_string] : usages
     end
 
     def inspectable
@@ -49,6 +46,14 @@ module Runfile
       @shortcut = value&.to_s
     end
 
+    def usage_string
+      @usage_string ||= if shortcut
+        "#{prefix} (#{name} | #{shortcut})".strip
+      else
+        "#{prefix} #{name}".strip
+      end
+    end
+
     def usages
       @usages ||= []
     end

data/lib/runfile/concerns/dsl.rb

@@ -56,8 +56,8 @@ module Runfile
       @required_contexts ||= {}
     end
 
-    def shortcut(name)
-      current_action.shortcut = name.to_s
+    def shortcut(from, to)
+      shortcuts[from] = to
     end
 
     def summary(text = nil)
@@ -74,6 +74,7 @@ module Runfile
 
     def usage(message)
       message = "#{name} #{message}" if name
+      message = "#{host.full_name} #{message}".strip if host
       current_action.usages.push message
     end
 
@@ -105,12 +106,16 @@ module Runfile
       @helper_blocks ||= []
     end
 
+    def imports
+      @imports ||= {}
+    end
+
     def options
       @options ||= {}
     end
 
-    def imports
-      @imports ||= {}
+    def shortcuts
+      @shortcuts ||= {}
     end
 
   private

data/lib/runfile/entrypoint.rb

@@ -56,9 +56,9 @@ module Runfile
     end
 
     def rootfile
-      if File.exist? 'runfile'
+      if File.file? 'runfile'
         Userfile.new 'runfile'
-      elsif File.exist? 'Runfile'
+      elsif File.file? 'Runfile'
         Userfile.new 'Runfile'
       end
     end

data/lib/runfile/userfile.rb

@@ -24,6 +24,10 @@ module Runfile
       @code ||= File.read(path)
     end
 
+    def commands
+      actions.values.select(&:help)
+    end
+
     def eval_code
       return if evaluated?
 
@@ -36,11 +40,23 @@ module Runfile
     end
 
     def full_name
-      id.join ' '
+      @full_name ||= id.join ' '
+    end
+
+    def guests
+      @guests ||= begin
+        result = imports.map do |glob, context|
+          Dir.glob("#{glob}.runfile").sort.map do |guest_path|
+            Userfile.new guest_path, context: context, host: self
+          end
+        end
+
+        result.flatten
+      end
     end
 
     def id
-      if host
+      @id ||= if host
         (host.id + [name]).compact
       else
         [name].compact
@@ -56,12 +72,15 @@ module Runfile
     end
 
     def rootfile?
-      basename.casecmp? 'runfile'
+      @rootfile ||= basename.casecmp? 'runfile'
     end
 
     def run(argv = [])
       eval_code
+      argv = transform_argv argv if argv.any?
+
       found_guest = find_guest argv
+
       if found_guest
         found_guest.run argv
       else
@@ -69,24 +88,12 @@ module Runfile
       end
     end
 
-    def commands
-      actions.values.select(&:help)
-    end
-
-    def guests
-      @guests ||= begin
-        result = imports.map do |glob, context|
-          Dir.glob("#{glob}.runfile").sort.map do |guest_path|
-            Userfile.new guest_path, context: context, host: self
-          end
-        end
+  private
 
-        result.flatten
-      end
+    def docopt
+      @docopt ||= render 'userfile', context: self
     end
 
-  private
-
     def find_action(args)
       acts = actions.values
       acts.find { |a| args[a.name] } ||
@@ -121,8 +128,12 @@ module Runfile
       exit_code if exit_code.is_a? Integer
     end
 
-    def docopt
-      @docopt ||= render 'userfile', context: self
+    def transform_argv(argv)
+      shortcuts.each do |from, to|
+        return Shellwords.split(to) + argv[1..] if from == argv[0]
+      end
+
+      argv
     end
   end
 end

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-  VERSION = '1.0.0.rc3'
+  VERSION = '1.0.0.rc4'
 end

data/lib/runfile/views/userfile.gtx

@@ -34,7 +34,7 @@ end
 if commands.any? || guests.any?
   > Commands:
   commands.each do |action|
-    = "  nb`#{action.names.join(', ')}`"
+    = "  nb`#{action.command_string}`"
     = word_wrap "    #{action.help}"
     >
   end
@@ -78,6 +78,15 @@ if env_vars.any?
   env_vars.each do |name, help|
     = "  #{name}"
     = word_wrap "    #{help}"
+    >
+  end
+end
+
+if shortcuts.any?
+  > Shortcuts:
+  maxlen = shortcuts.keys.map(&:size).max
+  shortcuts.each do |from, to|
+    = "  nb`#{from.ljust maxlen}`   #{to}"
   end
   >
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
+  version: 1.0.0.rc4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2023-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -81,12 +81,13 @@ dependencies:
 description: Build expressive command line utilities for your projects.
 email: db@dannyben.com
 executables:
-- runn
+- run
 extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- bin/runn
+- bin/run
+- examples/action-shortcut/runfile
 - examples/default-action-2/runfile
 - examples/default-action-2/server.runfile
 - examples/default-action/runfile
@@ -107,6 +108,7 @@ files:
 - examples/require-context/runfile
 - examples/require-context/server.runfile
 - examples/shortcut/runfile
+- examples/shortcut/server.runfile
 - lib/runfile.rb
 - lib/runfile/action.rb
 - lib/runfile/concerns/dsl.rb