dry-cli-ui 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d1ad3344ddfd395caef9b2ec0128f05cda8248a98afa864b1b61ed1d1db0b5e
-  data.tar.gz: d55f3256373ec25c1201dd0c39525eeb49b50f16989806740f720ed3e59f0f13
+  metadata.gz: 7b4b7ae4869fa6a7623aafc109ef5c26af41436021cc62e4efd5ba87602c64a3
+  data.tar.gz: ecbc221a29f2a9be94a4041fd4642ac5367af9bd4b1e7cc4bff828da20e871c5
 SHA512:
-  metadata.gz: fe5bb8356f594b5a8670ee7c8b9a5cdc0ec87e2480bea892f0e98389a8d43218fd2de162f77de9444990e3d197e7679352995f1da3eb234094df68a5ea5c2d25
-  data.tar.gz: b982df4a36156203f92f39b3b3c8da0e9b5fe8672092333c09d7dd70e48759f0470fc82060dea4a16bdbc9daca3e219361ca0c7f95f114961b740b20354e2105
+  metadata.gz: d46a4ec8716f6aaea3f17d8e2eda6ba29f90272516d812270b77ba604ff372e6327c840cbcc54b9ac7511eabd78dcf709c8c6072932927e6ff72ff6c35a5931d
+  data.tar.gz: 0ce772edc045b9deca09aca086de303d7f01cc2ce7ff5ca912077eeb3a5753cd397bc9cdfc8c1b4704d0c125c67f8077176266fc693df6dcbe97a06a9f971850

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.6.0]
+
+- `m.spinner(label)` inside `ui.multi_progress` declares a row with a spinner in place of a bar, for a phase whose size is never known, so one widget can show phases of known and unknown size together. The row shows its `Line`'s detail while it runs and ends `[✓] label`; it counts as a job and as no units on the headline.
+
 ## [0.5.1]
 
 - `ui.stoppable { |stop| ... }` makes Ctrl-C ask for a stop instead of interrupting, and `ui.multi_spinner` and `ui.multi_progress` take `stop:`. Once it is set, the jobs running finish, the rest are skipped, and the headline says `stopping`, then ends skipped. A second Ctrl-C interrupts. `Dry::CLI::UI::Stop` is the object behind it.

data/README.md

@@ -399,6 +399,31 @@ Downloading...
 
 Any other `count:`, or a `total:` that is not a non-negative Integer, raises `ArgumentError`.
 
+A phase whose size is never known goes on a row of its own with `m.spinner(label)`, beside the bars. Its row turns and shows the detail its `Line` is given, as in `multi_spinner`, with no bar, and it ends `[✓] label (0.1s)`, or `[𝘅] label: reason` after `line.fail`. It counts as a job and as no units, so `count: :jobs` suits a headline over phases run one at a time:
+
+```ruby
+ui.multi_progress("Generating text", concurrent: false, count: :jobs) do |m|
+  m.spinner("Finding PDFs") { |line| pdfs = find_pdfs { |dir| line.detail = dir } }
+  m.progress("Extracting", total: nil) do |bar|
+    bar.total = pdfs.size
+    pdfs.each { |pdf| extract(pdf) && bar.advance }
+  end
+  m.spinner("Indexing") { index }
+end
+```
+
+Piped:
+
+```text
+Generating text...
+  [✓] Finding PDFs (0.0s)
+  [✓] Extracting 3/3 (0.0s)
+  [✓] Indexing (0.0s)
+✓ Generating text 3/3 (0.0s)
+```
+
+`m.spinner` without a block raises `ArgumentError`.
+
 Piped:
 
 ```text

data/examples/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    dry-cli-ui (0.5.0)
+    dry-cli-ui (0.6.0)
       concurrent-ruby (~> 1.3)
       dry-cli (>= 1.0)
       pastel (~> 0.8)
@@ -84,7 +84,7 @@ CHECKSUMS
   dry-cli (1.4.1) sha256=b8015bb76c708aa8705a36faf694973e75eeeffca39b89c8e172dc6f66a7d874
   dry-cli-autocomplete (0.1.3) sha256=14f76447bda0000c71739b585c827dc0a0a763e30a68a8b4b2dff91f640768e4
   dry-cli-help (0.2.1) sha256=eaaaf6edb787ffe810425b4e4bb1a675d89397ccc759102d70b5b26e7bc692da
-  dry-cli-ui (0.5.0)
+  dry-cli-ui (0.6.0)
   dry-inflector (1.3.1) sha256=7fb0c2bb04f67638f25c52e7ba39ab435d922a3a5c3cd196120f63accb682dcc
   forwardable (1.4.0) sha256=f1cd40cc9812937980e1c76f1aa053660990a7c9b6a98fc37d945468afcce838
   pastel (0.8.0) sha256=481da9fb7d2f6e6b1a08faf11fa10363172dc40fd47848f096ae21209f805a75

data/lib/dry/cli/ui/version.rb

@@ -11,7 +11,7 @@ module Dry
     # Presentation helpers for Dry::CLI commands.
     module UI
       # The gem version.
-      VERSION = "0.5.1"
+      VERSION = "0.6.0"
     end
   end
 end

data/lib/dry/cli/ui/widgets/multi_progress.rb

@@ -11,6 +11,12 @@ module Dry
         # runs, and is replaced by `✓ label 120/120 (1.1s)` when it ends. The
         # bar's characters come from {Configuration#bar_format}.
         #
+        # A job declared with `spinner` instead has no bar: its row turns and
+        # shows its {Line}'s detail, as in {MultiSpinner}, and ends
+        # `✓ label (0.4s)`. It suits a phase whose size is never known, among
+        # phases whose size is. It counts as a job and as no units, so a
+        # headline over such rows reads best with `count: :jobs`.
+        #
         # @example
         #   ui.multi_progress("Downloading") do |m|
         #     files.each do |file|
@@ -20,6 +26,13 @@ module Dry
         #     end
         #   end
         #
+        # @example Phases, one at a time, some of known size
+        #   ui.multi_progress("Generating", concurrent: false, count: :jobs) do |m|
+        #     m.spinner("Finding") { |line| found = find { |dir| line.detail = dir } }
+        #     m.progress("Extracting", total: nil) { |bar| bar.total = found.size; found.each { extract(it) && bar.advance } }
+        #     m.spinner("Indexing") { index }
+        #   end
+        #
         # See {Multi} for how the jobs run and how the rows are drawn.
         class MultiProgress < Multi
           # What the declaration block is given.
@@ -48,6 +61,20 @@ module Dry
               @jobs << Multi::Job.new(label, work, Progress::Handle.new(total, nil, color: Progress.color(color)))
               self
             end
+
+            # Declares a job with a spinner in place of a bar, for work whose
+            # size is never known.
+            #
+            # @param label [String]
+            # @yieldparam line [Line] reports on the work while it runs
+            # @return [self]
+            # @raise [ArgumentError] without a block
+            def spinner(label, &work)
+              raise ArgumentError, "spinner #{label.inspect} needs a block" unless work
+
+              @jobs << Multi::Job.new(label, work, Line.new)
+              self
+            end
           end
 
           # What the headline bar can count.
@@ -78,19 +105,37 @@ module Dry
           private
 
           # @param job [Job]
-          # @return [Progress::Handle]
-          def progress_of(job) = job.handle
+          # @return [Boolean] whether the job was declared with `spinner`
+          def spinner?(job) = job.handle.is_a?(Line)
+
+          # @param job [Job]
+          # @return [Object]
+          def call(job) = spinner?(job) ? Line.call(job.work, job.handle) : super
+
+          # @param job [Job]
+          # @return [Boolean]
+          def reported_failure?(job) = spinner?(job) && job.handle.failed?
+
+          # @param job [Job]
+          # @return [Progress::Handle, nil] nil for a spinner, which has no progress
+          def progress_of(job) = spinner?(job) ? nil : job.handle
 
           # @param job [Job]
           # @param width [Integer]
           # @return [String]
           def running(job, width)
+            return [job.label, job.handle.detail].reject(&:empty?).join(" ") if spinner?(job)
+
             "#{job.label.ljust(width)} #{meter(job.handle.current, job.handle.total, job.started, job.handle.color)}"
           end
 
           # @param job [Job]
           # @return [String]
-          def summary(job) = "#{job.label} #{job.handle.current}/#{job.handle.total || '?'}"
+          def summary(job)
+            return job.handle.summary(job.label) if spinner?(job)
+
+            "#{job.label} #{job.handle.current}/#{job.handle.total || '?'}"
+          end
 
           # @param width [Integer]
           # @return [String]
@@ -105,7 +150,7 @@ module Dry
           def current
             return jobs.count(&:seconds) if @count == :jobs
 
-            jobs.sum { |job| job.handle.current }
+            bars.sum { |job| job.handle.current }
           end
 
           # @return [Integer] the total given; or units across every job,
@@ -114,9 +159,12 @@ module Dry
             return @total if @total
             return jobs.size if @count == :jobs
 
-            jobs.sum { |job| job.handle.total || job.handle.current }
+            bars.sum { |job| job.handle.total || job.handle.current }
           end
 
+          # @return [Array<Job>] the jobs that have a bar
+          def bars = jobs.reject { spinner?(it) }
+
           # `[◼◼◼   ] 48%  96/200  ETA 3.1s`, with the count right-aligned to
           # the widest any row can show, so every count ends in one column.
           #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-cli-ui
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -229,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.20
+rubygems_version: 4.0.22
 specification_version: 4
 summary: 'Runtime terminal UI for dry-cli commands: spinners, progress, boxes, task
   trees, tables, prompts'