runfile 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5a340ad5324cc9b24104fc460c171300cc2ab9690bb8bdfa2b38442b3ddf81a
-  data.tar.gz: e3f0fe2e7c4ba4fca9058d10f5caffc2daa76d5f0810aa5a63d646d2a23347d4
+  metadata.gz: 41aa2631882de8a7c759aa386aa9a2f1e6ddd69446af65e49bc7b30f274c1d49
+  data.tar.gz: 0cc7a2ccbcd5095acc00cc5b1484b3e5122061141f7db0b9b9e18bbe469622b7
 SHA512:
-  metadata.gz: 0f94f10d4feda0300878584b68c1af769bc1a81392ee52f7716d89d0d7fe376cf9d20cc2cbb8bc0ef35d5574b469de038df67e99dbaa0a077ca4fed7a7cb548c
-  data.tar.gz: 5983f010e720484acdb6b013248c32f4ed104180e7fc05218c93abfaf1a3eea7775b95e7e6e7cbe2c0871316056fe4d99c27b7e1b93b13524782015199a66a8a
+  metadata.gz: 3911f5c10a4883572618e19cdfda6dfedb17502bd0fd9cb090d09c48622d0924eab21590832a24d8a050af860b34cb64361bc56f604e23c27088cdbd12b06ded
+  data.tar.gz: a16d11d7e4d574540bc850192c86ae972118ab383c681ca0a1fe51eda75520cdb033253f1e8b7bd57597f886c2bfb22f9c9d9a16a1e636a4bd8b6856a001481b

data/README.md

@@ -120,68 +120,69 @@ $ run example --help
 
 For a more formal documentation, see the [User Guide](https://runfile.dannyb.co/).
 
-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 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
-
 <details>
   <summary>Show section</summary>
 
-  ### No more `.runfile` config
+  ---
+
+  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
 
   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`
+  #### 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
+  #### No more `execute` 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.
 
-  ### Code outside of actions should be inside `helpers`
+  #### Code outside of actions should be inside `helpers`
 
   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 need for `trap(:INT)`
+  #### No more need for `trap(:INT)`
 
   If your old runfiles trap the `Interrupt` signal, there is no longer a need to
   do so, as it is trapped by default.
 
-  ### Colsole is included
+  #### Colsole is included
 
   If your runfiles `required` and `include` Colsole, there is no longer a need to 
   do it. Colsole is bundled and available in actions.
 
-  ### Long flags before short flags
+  #### Long flags before short flags
 
   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'
+  #### 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
+  #### RunfileTasks
 
-  The `RunfileTasks` gem is also released as a pre-release, if you are using it
-  make sure to install the latest release candidate.
+  The [runfile-tasks gem](https://github.com/dannyben/runfile-tasks) is also
+  updated to 1.x, with a modified syntax. If you are using it, make sure to
+  upgrade it as well.
 
 </details>
 

data/examples/helpers/runfile

@@ -3,7 +3,7 @@ require 'json'
 # Define helper methods
 helpers do
   def files
-    Dir['*'].sort
+    Dir['*']
   end
 end
 

data/lib/runfile/entrypoint.rb

@@ -27,7 +27,7 @@ module Runfile
       run
     rescue Runfile::ExitWithUsage => e
       say e.message
-      1
+      e.exit_code
     rescue Runfile::UserError => e
       allow_debug e
       say! "mib` #{e.class} `"
@@ -38,9 +38,7 @@ module Runfile
       1
     rescue => e
       allow_debug e
-      origin = e.backtrace_locations.first
-      location = "#{origin.path}:#{origin.lineno}"
-      say! "rib` #{e.class} ` in nu`#{location}`"
+      say! "rib` #{e.class} ` in nu`#{origin(e)}`"
       say! e.message
       say! "\nPrefix with nu`DEBUG=1` for full backtrace" unless ENV['DEBUG']
       1
@@ -55,6 +53,11 @@ module Runfile
       say! '---'
     end
 
+    def origin(e)
+      (e.backtrace_locations&.first.to_s || e.backtrace&.first || 'unknown')
+        .tr '`', "'"
+    end
+
     def rootfile
       if File.file? 'runfile'
         Userfile.new 'runfile'

data/lib/runfile/exceptions.rb

@@ -5,7 +5,15 @@ module Runfile
 
   class Error < StandardError; end
   class UserError < Error; end
-  class ExitWithUsage < Error; end
+
+  class ExitWithUsage < Error
+    attr_reader :exit_code
+
+    def initialize(message = '', exit_code: nil)
+      @exit_code = exit_code || 1
+      super message
+    end
+  end
 
   class ActionNotFound < UserError; end
   class GemNotFound < UserError; end

data/lib/runfile/runner.rb

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

data/lib/runfile/userfile.rb

@@ -46,7 +46,7 @@ module Runfile
     def guests
       @guests ||= begin
         result = imports.map do |glob, context|
-          Dir.glob("#{glob}.runfile").sort.map do |guest_path|
+          Dir.glob("#{glob}.runfile").map do |guest_path|
             Userfile.new guest_path, context: context, host: self
           end
         end

data/lib/runfile/version.rb

@@ -1,3 +1,3 @@
 module Runfile
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-09 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -37,6 +37,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,6 +47,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: gtx
   requirement: !ruby/object:Gem::Requirement
@@ -133,7 +139,7 @@ metadata:
   source_code_uri: https://github.com/DannyBen/runfile
   bug_tracker_uri: https://github.com/DannyBen/runfile/issues
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,15 +147,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Local command line for your projects
 test_files: []