runfile 1.0.0.rc4 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab0dde51597dac5b5f75e8c7fe4fd627d94b70251a9f7ada897fad07f32573fc
-  data.tar.gz: aa612294f0247bcfed789fa7a9704798f611ec83dbb80a55fe9c18eb85ad6d07
+  metadata.gz: b5a340ad5324cc9b24104fc460c171300cc2ab9690bb8bdfa2b38442b3ddf81a
+  data.tar.gz: e3f0fe2e7c4ba4fca9058d10f5caffc2daa76d5f0810aa5a63d646d2a23347d4
 SHA512:
-  metadata.gz: cc5ed99c7b6cd47d7f3a64418ac62698f46c5e5ee1e55edb3bdf18ef157e4764efadd874ab2767a0be50ee98e0592195546d63c6f988607cb25cc6ce9de03cd8
-  data.tar.gz: b6d0ff5c3e8fd53b048c2e5b35ebf180ef2a4f44e05b2a271e7defb572ad654258f140bcb40fa3048b84a999201e7ff5a3067d3db4ab4835c5f8f8f3aff1b990
+  metadata.gz: 0f94f10d4feda0300878584b68c1af769bc1a81392ee52f7716d89d0d7fe376cf9d20cc2cbb8bc0ef35d5574b469de038df67e99dbaa0a077ca4fed7a7cb548c
+  data.tar.gz: 5983f010e720484acdb6b013248c32f4ed104180e7fc05218c93abfaf1a3eea7775b95e7e6e7cbe2c0871316056fe4d99c27b7e1b93b13524782015199a66a8a

data/README.md

@@ -9,15 +9,16 @@
 
 ---
 
-A beautiful command line application framework  
-Rake-inspired - Docopt inside
+A beautiful command line utility builder  
+Rake-inspired ✦ Docopt inside  
+**[runfile.dannyb.co](https://runfile.dannyb.co)**
 
 ---
 
 </div>
 
-**Runfile** lets you create command line applications in a way similar 
-to [Rake](https://github.com/ruby/rake), but with the full power of 
+**Runfile** lets you create command line tools in a way similar to
+[Rake](https://github.com/ruby/rake), but with the full power of 
 [Docopt](http://docopt.org/) command line options.
 
 You create a `runfile`, and execute commands with 
@@ -26,15 +27,9 @@ You create a `runfile`, and execute commands with
 Runfile is designed primarily for Ruby developers, but if you need to add a 
 command line "toolbelt" for your projects, you can use it regardless.
 
-## Pre-release Notice
-
-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.
-
 ## Demo
 
-![Runfile Demo](demo.svg "Runfile Demo")
+![Runfile Demo](support/cast.gif "Runfile Demo")
 
 ## Install
 
@@ -110,7 +105,7 @@ Options:
     Show this message
 ```
 
-## Examples
+### More Examples
 
 You can learn almost everything there is to know about runfile from the
 [examples](https://github.com/DannyBen/runfile/tree/master/examples#readme).
@@ -129,56 +124,67 @@ Note that the current user guide is for the stable version 0.12.0.
 
 ## Breaking Changes in 1.0.0
 
-If you are using a version earlier than 1.0, note that the upcoming release
-1.0.0 includes some breaking changes. You can read more about them in[this Pull
-Request](https://github.com/DannyBen/runfile/pull/50).
+If you are using a version earlier than 1.0, note that version 1.0.0 includes
+some breaking changes. You can read more about them in
+[this Pull Request](https://github.com/DannyBen/runfile/pull/50).
 
 ### Upgrading to 1.0.0
 
-### No more `.runfile` config
+<details>
+  <summary>Show section</summary>
+
+  ### No more `.runfile` config
+
+  If you have used the multi-runfile config file, this no longer exists.
+  Use a standard `runfile` instead, along with the `import` directive.
+
+  ### No more `action :global`
+
+  If you have used the `action :global do` notation, this is replaced with the
+  simpler use `action do` instead. Also, there is no more need for
+  empty `usage ''`, just delete it if you have it in your runfiles.
+
+  ### No more `execute` directive
 
-If you have used the multi-runfile config file, this no longer exists.
-Use a standard `runfile` instead, along with the `import` directive.
+  If you have used it to cross-call other actions, it is no longer available. As
+  an alternative, you can define common code in separate classes and `require`
+  them, or use the new `helpers` directive to define functions that will be
+  available to all actions.
 
-### No more `action :global`
+  ### Code outside of actions should be inside `helpers`
 
-If you have used the `action :global do` notation, this is replaced with the
-simpler use `action do` instead. Also, there is no more need for
-empty `usage ''`, just delete it if you have it in your runfiles.
+  If your runfiles include other ruby code, especially `def method`, you should
+  now use the new `helpers` block and tuck this code inside it.
 
-### No more `execute` directive
+  ### No more need for `trap(:INT)`
 
-If you have used it to cross-call other actions, it is no longer available. As
-an alternative, you can define common code in separate classes and `require`
-them, or use the new `helpers` directive to define functions that will be
-available to all actions.
+  If your old runfiles trap the `Interrupt` signal, there is no longer a need to
+  do so, as it is trapped by default.
 
-### No more need for `trap(:INT)`
+  ### Colsole is included
 
-If your old runfiles trap the `Interrupt` signal, there i no longer a need to
-do so, as it is trapped by default.
+  If your runfiles `required` and `include` Colsole, there is no longer a need to 
+  do it. Colsole is bundled and available in actions.
 
-### Colsole is included
+  ### Long flags before short flags
 
-If your runfiles `required` and `include` Colsole, there is no longer a need to 
-do it. Colsole is bundled and available in actions.
+  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.
 
-### Long flags before short flags
+  ### Examples no longer add implicit 'run'
 
-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.
+  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.
 
-### Examples no longer add implicit 'run'
+  ### RunfileTasks
 
-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.
+  The `RunfileTasks` gem is also released as a pre-release, if you are using it
+  make sure to install the latest release candidate.
 
-### RunfileTasks
+</details>
 
-The `RunfileTasks` gem is also released as a pre-release, if you are using it
-make sure to install the latest release candidate.
 
 ## Contributing / Support
 

data/lib/runfile/action.rb

@@ -1,7 +1,7 @@
 module Runfile
   # Represents a single action inside a {Userfile} and executes its block
   # on demand. Properties of this class are populated by the {DSL} module when
-  # running a {Userfile}.
+  # the runfile is executed.
   class Action
     include Inspectable
 
@@ -26,7 +26,7 @@ module Runfile
 
       instance_eval do
         host.helpers.each { |b| b.call args }
-        block.call args
+        block.call args if block
       end
     end
 
@@ -34,10 +34,6 @@ module Runfile
       @name = value&.to_s
     end
 
-    def names
-      name ? [name, shortcut].compact : ['(default)']
-    end
-
     def prefix
       host&.full_name
     end
@@ -58,6 +54,12 @@ module Runfile
       @usages ||= []
     end
 
+  private
+
+    def names
+      name.empty? ? [] : [name, shortcut].compact
+    end
+
     def validate_context
       host.required_contexts.each do |varname, default|
         next if host.context[varname]

data/lib/runfile/concerns/dsl.rb

@@ -2,8 +2,6 @@ module Runfile
   module DSL
     # Commands
 
-    attr_reader :default_action
-
     def action(name = nil, shortcut = nil, &block)
       current_action.block = block
       current_action.name = name.to_s
@@ -123,7 +121,6 @@ module Runfile
     def finalize_current_action(name)
       key = name.empty? ? :default : name
       actions[key] = current_action
-      @default_action = current_action unless name
       @current_action = nil
     end
 

data/lib/runfile/exceptions.rb

@@ -10,4 +10,5 @@ module Runfile
   class ActionNotFound < UserError; end
   class GemNotFound < UserError; end
   class SyntaxError < UserError; end
+  class DocoptError < SyntaxError; end
 end

data/lib/runfile/gem_finder.rb

@@ -1,6 +1,6 @@
 module Runfile
   # Finds the path of an installed or bundled gem
-  # Adapted from Rubocop <https://github.com/rubocop/rubocop/blob/master/lib/rubocop/config_loader_resolver.rb#L268>
+  # Adapted from [Rubocop](https://github.com/rubocop/rubocop/blob/master/lib/rubocop/config_loader_resolver.rb#L268)
   class GemFinder
     class << self
       def find(gem_name, file = nil)

data/lib/runfile/runner.rb

@@ -11,9 +11,11 @@ module Runfile
     private
 
       def call_docopt(docopt, version: nil, argv: nil)
-        Docopt.docopt docopt, argv: argv, version: version
-      rescue Docopt::Exit => e
+        DocoptNG.docopt docopt, argv: argv, version: version
+      rescue DocoptNG::Exit => e
         raise ExitWithUsage, e.message
+      rescue DocoptNG::DocoptLanguageError => e
+        raise DocoptError, "There is an error in your runfile:\nnb`#{e.message}`"
       end
     end
   end

data/lib/runfile/userfile.rb

@@ -77,9 +77,11 @@ module Runfile
 
     def run(argv = [])
       eval_code
-      argv = transform_argv argv if argv.any?
 
-      found_guest = find_guest argv
+      if argv.any?
+        argv = expand_shortcuts argv
+        found_guest = find_guest argv
+      end
 
       if found_guest
         found_guest.run argv
@@ -128,9 +130,19 @@ module Runfile
       exit_code if exit_code.is_a? Integer
     end
 
-    def transform_argv(argv)
+    # Shortcuts will always appear after the name, so we split argv to
+    # name (array), shortcut wannabe (string), rest of the args (array).
+    # Then, if the shortcut wannabe is a match, we stitch the new argv back
+    # together, with its expansion.
+    def expand_shortcuts(argv)
+      size = id.size
+
+      p1 = argv[0...size]
+      p2 = argv[size]
+      p3 = argv[(size + 1)..]
+
       shortcuts.each do |from, to|
-        return Shellwords.split(to) + argv[1..] if from == argv[0]
+        return p1 + Shellwords.split(to) + p3 if from == p2
       end
 
       argv

data/lib/runfile/version.rb

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

data/lib/runfile.rb

@@ -1,13 +1,8 @@
 require 'gtx'
-require 'docopt'
+require 'docopt_ng'
 require 'colsole'
 require 'requires'
 
 requires 'runfile/exceptions'
 requires 'runfile/concerns'
 requires 'runfile'
-
-if ENV['BYEBUG']
-  require 'byebug'
-  require 'lp'
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc4
+  version: 1.0.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-28 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -31,19 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: docopt
+  name: docopt_ng
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: gtx
   requirement: !ruby/object:Gem::Requirement
@@ -144,11 +144,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: Local command line for your projects