run_kit 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4f28d8c9977c242536eb737cdde4f7723df1cdaf7b094efcf724562c2fd0f1e
-  data.tar.gz: fe8f3c3a1479f61483137e0ae96a72b2adc0e78b0ccb611130c0d13afbcdd627
+  metadata.gz: 6dabac9fceff597dbc18cca5e813a37c784bce2ed1148425ad5fd82264a2e3bd
+  data.tar.gz: f544b871ca35c2da4fd965b017a9e2b11c052f99d755c92b6110e4113ec25a4f
 SHA512:
-  metadata.gz: 176389146afcdc0646319c3911024ff6903dcfb4836ac54f86e6f0d7ca9557c71b3a00e3d4295f7ea53c6e5751dcc8f55eb45713da71e6d32083fcbd9feb7b9e
-  data.tar.gz: 784fc1c1c4702adca3504ca13ea1c713172df14791adfb355755dd97ea9e89d570f8f664d28cdd7b8bfcdf08a18d9c520b43dc2e6219a3a9df5285d8cea0877f
+  metadata.gz: 2e56df9f10755fec5eadc44396f368c0f6ebadd9987b2cf317373129902264c2e40073000198dba0511e142082780c0176a677461cd4fac083cd18d9dd8c2e29
+  data.tar.gz: b9dbdf57d9ec47c482f1dcdf23b237287564fe6b5c3568b2cdd1185d6ea893aee37b48634bd507e773d6deeb75d1234f54c522f9250e0ed8f348d8e17c9c424f

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source "https://rubygems.org", cooldown: 7
 gemspec
 
 group :development, :test do

data/README.md

@@ -30,6 +30,15 @@ Automatic `--help` for the above. Uses color and wraps to terminal:
 
 <img width="379" height="108" alt="image" src="https://github.com/user-attachments/assets/3d11c8ca-6b57-4dec-9c11-28bf23162ded" />
 
+Flags can also read from ENV:
+
+```ruby
+o.bool "--force", env: true              # ENV["FORCE"]
+o.str "--token", env: "API_TOKEN"        # ENV["API_TOKEN"]
+```
+
+Configured variables appear in `--help`. Command-line values override ENV, which overrides defaults. Boolean ENV values accept `true/1/yes/on` and `false/0/no/off/empty`, ignoring case.
+
 ## RunKit::Shell
 
 `RunKit::Shell` is a mixin with many helpers for bin scripts:
@@ -102,6 +111,14 @@ Note: There has been some effort to get the Pathname helpers into Ruby itself, w
 
 ### Changelog
 
-#### 0.1.0 (unreleased)
+#### 0.1.2 (Sep 2026)
+
+- allow options to read from ENV
+
+#### 0.1.1 Sep 2026
+
+- add title to progressbar default
+
+#### 0.1.0
 
 - first

data/lib/run_kit/core_ext.rb

@@ -35,7 +35,7 @@ module RunKit
     module Enumerator
       def with_progressbar(options = {}, &block)
         defaults = {
-          format: "%j%% %B #{RunKit::Term.paint_ansi("%c/%u %e", RunKit::Term.ansi256_fg(242))}",
+          format: "%t: %j%% %B #{RunKit::Term.paint_ansi("%c/%u %e", RunKit::Term.ansi256_fg(242))}",
           progress_mark: RunKit::Term.paint_ansi("━", RunKit::Term.ansi256_fg(46)),
           remainder_mark: RunKit::Term.paint_ansi("━", RunKit::Term.ansi256_fg(237)),
           output: $stdout.isatty ? $stdout : $stderr,

data/lib/run_kit/options/config.rb

@@ -37,28 +37,28 @@ module RunKit
       # flags
       #
 
-      def bool(*opts, default: nil, required: false)
-        add_flag(Flag.new(:bool, opts, default:, required:))
+      def bool(*opts, default: nil, required: false, env: nil)
+        add_flag(Flag.new(:bool, opts, default:, required:, env:))
       end
 
-      def float(*opts, default: nil, required: false, choices: nil)
-        add_flag(Flag.new(:float, opts, default:, required:, choices:))
+      def float(*opts, default: nil, required: false, choices: nil, env: nil)
+        add_flag(Flag.new(:float, opts, default:, required:, choices:, env:))
       end
 
-      def int(*opts, default: nil, required: false, choices: nil)
-        add_flag(Flag.new(:int, opts, default:, required:, choices:))
+      def int(*opts, default: nil, required: false, choices: nil, env: nil)
+        add_flag(Flag.new(:int, opts, default:, required:, choices:, env:))
       end
 
-      def path(*opts, default: nil, required: false, choices: nil)
-        add_flag(Flag.new(:path, opts, default:, required:, choices:))
+      def path(*opts, default: nil, required: false, choices: nil, env: nil)
+        add_flag(Flag.new(:path, opts, default:, required:, choices:, env:))
       end
 
-      def str(*opts, default: nil, required: false, choices: nil)
-        add_flag(Flag.new(:str, opts, default:, required:, choices:))
+      def str(*opts, default: nil, required: false, choices: nil, env: nil)
+        add_flag(Flag.new(:str, opts, default:, required:, choices:, env:))
       end
 
-      def sym(*opts, default: nil, required: false, choices: nil)
-        add_flag(Flag.new(:sym, opts, default:, required:, choices:))
+      def sym(*opts, default: nil, required: false, choices: nil, env: nil)
+        add_flag(Flag.new(:sym, opts, default:, required:, choices:, env:))
       end
 
       # long-form aliases

data/lib/run_kit/options/flag.rb

@@ -12,12 +12,14 @@ module RunKit
       # --no-foo
       NEGATE_RE = /\A--no-(\w[\w-]*)\z/
 
+      TRUE_ENV = %w[1 true yes on]
+      FALSE_ENV = ["", "0", "false", "no", "off"]
       KINDS = %i[bool float int path str sym]
 
-      attr_reader :choices, :default, :help, :kind, :meta, :required, :switches
+      attr_reader(*%i[choices default env help kind meta required switches])
 
       # ctor
-      def initialize(kind, opts, default: nil, required: false, choices: nil)
+      def initialize(kind, opts, default: nil, required: false, choices: nil, env: nil)
         @choices, @kind, @required = choices, kind, required
 
         # extract @help from last string
@@ -28,6 +30,7 @@ module RunKit
 
         # Extract meta from the final switch, if written as `--port <int>`.
         @meta = build_meta
+        @env = (env == true) ? key.to_s.upcase : env
 
         # default, with some special handling for bool
         @default = default
@@ -50,22 +53,21 @@ module RunKit
         end
 
         raise Error, "option '#{switch}' requires a value" if !param
-        parsed = begin
-          case kind
-          when :float then Float(param)
-          when :int then Integer(param, 10)
-          when :path then Pathname.new(param)
-          when :str then param
-          when :sym then param.to_sym
-          end
-        rescue ArgumentError
-          raise Error, "invalid value '#{param}' for option '#{switch}'"
-        end
+        parse_value(param, "option '#{switch}'")
+      end
 
-        if choices && !choices.include?(parsed)
-          raise Error, "invalid value '#{parsed}' for option '#{switch}', must be one of #{choices.join(", ")}"
+      # Parse a value supplied by ENV[$SOMETHING]
+      def parse_env(param)
+        source = "environment variable '#{env}'"
+
+        # special handling for bools
+        if bool?
+          return true if TRUE_ENV.include?(param.downcase)
+          return false if FALSE_ENV.include?(param.downcase)
+          raise Error, "invalid value '#{param}' for #{source}"
         end
-        parsed
+
+        parse_value(param, source)
       end
 
       # one-liners
@@ -96,6 +98,7 @@ module RunKit
         raise ArgumentError, "required must be true or false" unless required == true || required == false
         raise ArgumentError, "required flags cannot have defaults" if required && default != nil
         raise ArgumentError, "invalid default #{default.inspect} for #{kind}" if default != nil && !allowed?(default)
+        raise ArgumentError, "env must be true or a string" unless env.nil? || env.is_a?(String)
 
         # choices
         if choices
@@ -130,6 +133,25 @@ module RunKit
         when :sym then candidate.is_a?(Symbol)
         end
       end
+
+      def parse_value(param, source)
+        parsed = begin
+          case kind
+          when :float then Float(param)
+          when :int then Integer(param, 10)
+          when :path then Pathname.new(param)
+          when :str then param
+          when :sym then param.to_sym
+          end
+        rescue ArgumentError
+          raise Error, "invalid value '#{param}' for #{source}"
+        end
+
+        if choices && !choices.include?(parsed)
+          raise Error, "invalid value '#{parsed}' for #{source}, must be one of #{choices.join(", ")}"
+        end
+        parsed
+      end
     end
   end
 end

data/lib/run_kit/options/help.rb

@@ -36,10 +36,15 @@ module RunKit
           buf << label
 
           # right
-          if flag.help
+          help = flag.help
+          if flag.env
+            env_help = "[env: #{flag.env}]"
+            help = help ? "#{help} #{env_help}" : env_help
+          end
+          if help
             buf << " " * (label_width - Term.width(label) + 2)
             indent = INDENT + label_width + 2
-            buf << Term.wrap(flag.help, width - indent).gsub("\n", "\n#{" " * indent}")
+            buf << Term.wrap(help, width - indent).gsub("\n", "\n#{" " * indent}")
           end
           buf << "\n"
         end

data/lib/run_kit/options/parser.rb

@@ -14,7 +14,10 @@ module RunKit
 
       # Reset transient state, parse argv, and assemble the result.
       def parse(argv)
-        @options, @queue = config.defaults, argv.dup
+        env = build_env
+        raise NakedRequested if config.naked? && argv.empty? && env.empty?
+
+        @options, @queue = config.defaults.merge(env), argv.dup
         parse_queue
         validate!
         options
@@ -27,8 +30,6 @@ module RunKit
       #
 
       def parse_queue
-        raise NakedRequested if config.naked? && queue.empty?
-
         # any non-flags we find below
         operands = []
 
@@ -117,6 +118,13 @@ module RunKit
       # helpers
       #
 
+      def build_env
+        config.flags.filter_map do
+          next unless _1.env && ENV.key?(_1.env)
+          [_1.key, _1.parse_env(ENV.fetch(_1.env))]
+        end.to_h
+      end
+
       def builtin!(flag)
         raise HelpRequested if flag == config.help_flag
         raise VersionRequested if flag == config.version_flag

data/run_kit.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "run_kit"
-  s.version = "0.1.0"
+  s.version = "0.1.2"
   s.authors = ["Adam Doppelt"]
   s.email = "amd@gurge.com"
   s.summary = "Run kit."

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: run_kit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Adam Doppelt
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Run kit.
 test_files: []