dry-cli-ui 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 412754e986acfa5b60ce22a1d447cd470098ffe42434ec453636cf563e65a8d3
-  data.tar.gz: 23fcbd8f9cbd0cdda55e6f88883b36092b07703e3895f47f8348a11743f4f3a8
+  metadata.gz: 555aba61a68d2f480ae76f61d6851786e83e46afd0855c276e5eba01fe0d8dc8
+  data.tar.gz: 584e4a3268d121ecdb3e85f3ead9afef643e5c1a086b0c4702b418f550c1b8d7
 SHA512:
-  metadata.gz: 46f47189bba69663ef98407036a101983ff870f8daa56e02fcbd788bf4a82f83d9a8546730c2cfc61056548a26ccc84102fe2f1a64d70ff1a063d5517c8179fe
-  data.tar.gz: b83ec6dd332065f8fdc8cb346abe35773e5ddb3cc14a01cec09dd7eabcba04529194e003d837336c1891d21f140b2e344d8ef1f0fedab942b21facd4c1634b96
+  metadata.gz: 86e23d86e7eca50b4a7ed51bf7dc6d4a784c4711f7ddfc5c10fbc90ebc53d44647da0eaea7ea00296e7228ba73c08920a1dd08ff6c435cbd4d10f2b3266d4c37
+  data.tar.gz: 3b73f7e064fd7dfd35540a034ef1e721e4aed3e368d4d474ffa8ccc283fd4c06d4913bba72343b3760e8ecaf9ec8a64645c4d97f6c160bfb26cf7c7cb5021f30

data/examples/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+group :development, :test do
+  gem 'dry-cli'
+  gem 'dry-cli-autocomplete'
+  gem 'dry-cli-help'
+  gem 'prime'
+  # multi_spinner, multi_progress and status_bar live on the
+  # kig/add-multi-spinner-progress branch until it is merged; switch this
+  # back to path: "../" then.
+  gem 'dry-cli-ui', path: File.expand_path("~/.agents.worktrees/dry-cli-ui-add-multi-spinner-progress")
+end

data/examples/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: /Users/kig/.agents.worktrees/dry-cli-ui-add-multi-spinner-progress
+  specs:
+    dry-cli-ui (0.3.0)
+      concurrent-ruby (~> 1.3)
+      dry-cli (>= 1.0)
+      pastel (~> 0.8)
+      strings (~> 0.2)
+      tty-box (~> 0.7)
+      tty-cursor (~> 0.7)
+      tty-progressbar (~> 0.18)
+      tty-prompt (~> 0.23)
+      tty-screen (~> 0.8)
+      tty-spinner (~> 0.9)
+      tty-table (~> 0.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.3.8)
+    dry-cli (1.4.1)
+    dry-cli-autocomplete (0.1.3)
+      dry-cli (>= 1.0)
+      dry-inflector (>= 1.0)
+    dry-cli-help (0.2.0)
+      dry-cli (>= 1.1.1, < 2)
+      pastel (~> 0.8)
+    dry-inflector (1.3.1)
+    forwardable (1.4.0)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    prime (0.1.4)
+      forwardable
+      singleton
+    singleton (0.3.0)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
+    tty-box (0.7.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-cursor (~> 0.7)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-progressbar (0.18.3)
+      strings-ansi (~> 0.2)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      unicode-display_width (>= 1.6, < 3.0)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.2)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
+    tty-table (0.12.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-screen (~> 0.8)
+    unicode-display_width (2.6.0)
+    unicode_utils (1.4.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  arm64-darwin-25
+  ruby
+
+DEPENDENCIES
+  dry-cli
+  dry-cli-autocomplete
+  dry-cli-help
+  dry-cli-ui!
+  prime
+
+CHECKSUMS
+  bundler (4.1.0.beta1) sha256=8a2dac8ca276ff4eff5efc2c6457b0044080fc1e431534ad7c5cc6187232b800
+  concurrent-ruby (1.3.8) sha256=b2f1be836e968ccc78ccfce277ea79c72a88633f22306782c16ff23fb415d1e1
+  dry-cli (1.4.1) sha256=b8015bb76c708aa8705a36faf694973e75eeeffca39b89c8e172dc6f66a7d874
+  dry-cli-autocomplete (0.1.3) sha256=14f76447bda0000c71739b585c827dc0a0a763e30a68a8b4b2dff91f640768e4
+  dry-cli-help (0.2.0)
+  dry-cli-ui (0.3.0)
+  dry-inflector (1.3.1) sha256=7fb0c2bb04f67638f25c52e7ba39ab435d922a3a5c3cd196120f63accb682dcc
+  forwardable (1.4.0) sha256=f1cd40cc9812937980e1c76f1aa053660990a7c9b6a98fc37d945468afcce838
+  pastel (0.8.0) sha256=481da9fb7d2f6e6b1a08faf11fa10363172dc40fd47848f096ae21209f805a75
+  prime (0.1.4) sha256=4d755ebf7c2994a6f3a3fee0d072063be3fff2d4042ebff6cd5eebd4747a225e
+  singleton (0.3.0) sha256=83ea1bca5f4aa34d00305ab842a7862ea5a8a11c73d362cb52379d94e9615778
+  strings (0.2.1) sha256=933293b3c95cf85b81eb44b3cf673e3087661ba739bbadfeadf442083158d6fb
+  strings-ansi (0.2.0) sha256=90262d760ea4a94cc2ae8d58205277a343409c288cbe7c29416b1826bd511c88
+  tty-box (0.7.0) sha256=17f453a0c1df43871fdb6de461ee797b78574dacc652372fa2ae98a00785df8b
+  tty-color (0.6.0) sha256=6f9c37ca3a4e2367fb2e6d09722762647d6f455c111f05b59f35730eeb24332a
+  tty-cursor (0.7.1) sha256=79534185e6a777888d88628b14b6a1fdf5154a603f285f80b1753e1908e0bf48
+  tty-progressbar (0.18.3) sha256=6cbb4260e55e74a9180d502143eb6a467d2c8e51bf5f3c9509fb5cacc3d4a5f6
+  tty-prompt (0.23.1) sha256=fcdbce905238993f27eecfdf67597a636bc839d92192f6a0eef22b8166449ec8
+  tty-reader (0.9.0) sha256=c62972c985c0b1566f0e56743b6a7882f979d3dc32ff491ed490a076f899c2b1
+  tty-screen (0.8.2) sha256=c090652115beae764336c28802d633f204fb84da93c6a968aa5d8e319e819b50
+  tty-spinner (0.9.3) sha256=0e036f047b4ffb61f2aa45f5a770ec00b4d04130531558a94bfc5b192b570542
+  tty-table (0.12.0) sha256=fdc27a4750835c1a16efe19a0b857e3ced3652cc7aceafe6dca94908965b9939
+  unicode-display_width (2.6.0) sha256=12279874bba6d5e4d2728cef814b19197dbb10d7a7837a869bab65da943b7f5a
+  unicode_utils (1.4.0) sha256=b922d0cf2313b6b7136ada6645ce7154ffc86418ca07d53b058efe9eb72f2a40
+  wisper (2.0.1) sha256=ce17bc5c3a166f241a2e6613848b025c8146fce2defba505920c1d1f3f88fae6
+
+BUNDLED WITH
+  4.1.0.beta1

data/examples/README.md

@@ -0,0 +1,35 @@
+# Examples
+
+These examples offers two commands that are are indicative of the added behavior.
+
+But first,
+
+```bash
+bundle install
+```
+
+Then:
+
+## Help
+
+```bash
+$ bundle exec bin/mycli -h
+USAGE
+  mycli COMMAND [OPTIONS]
+
+COMMANDS
+  version, v     Print version
+  urls_progress  Fetch URLs with a progress bar each, and write them all to urls.txt
+  urls_spinner   Fetch URLs with a spinner each, and write each to its own file
+  primes         Compute closest prime to a given number in the array
+
+OPTIONS
+  -h, --help     Show help
+  -v, --version  Print version
+```
+
+## Commands to Try
+
+- primes
+- urls_progress url1 url2 ...
+- urls_spinner url1 url2 ...

data/examples/bin/mycli

@@ -0,0 +1,206 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Load the gems examples/Gemfile names, even when run as bin/mycli without
+# bundle exec; otherwise Ruby picks the newest installed dry-cli-ui instead.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
+require "bundler/setup"
+
+require "fileutils"
+require "dry/cli"
+require "dry/cli/help"
+require "dry/cli/autocomplete/command"
+require "dry/cli/ui"
+require "net/http"
+require "prime"
+
+module Foo
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Version < Dry::CLI::Command
+        desc "Print version"
+
+        def call(*)
+          puts "1.0.0"
+        end
+      end
+
+      # Shared by the two URL commands: follows redirects, and asks for the
+      # body as it is stored, so the bytes counted match Content-Length.
+      module HTTP
+        HEADERS = { "Accept-Encoding" => "identity" }.freeze
+        REDIRECTS = 5
+
+        module_function
+
+        # @return [Array(URI, Integer, nil)] where the URL ends up, and its size when the server says
+        # @raise [RuntimeError] for a response that is neither a redirect nor a success
+        def resolve(url, hops = REDIRECTS)
+          uri = URI(url)
+          response = start(uri) { |http| http.head(uri.request_uri, HEADERS) }
+          if response.is_a?(Net::HTTPRedirection) && hops.positive?
+            return resolve(URI.join(uri, response["location"]).to_s, hops - 1)
+          end
+          raise "HTTP #{response.code}" unless response.is_a?(Net::HTTPSuccess)
+
+          [uri, response.content_length]
+        end
+
+        # @yieldparam bytes [Integer] the size of each chunk as it arrives
+        # @return [String] the body
+        # @raise [RuntimeError] for a response that is not a success
+        def download(uri)
+          body = +""
+          start(uri) do |http|
+            http.request_get(uri.request_uri, HEADERS) do |response|
+              raise "HTTP #{response.code}" unless response.is_a?(Net::HTTPSuccess)
+
+              response.read_body do |chunk|
+                body << chunk
+                yield chunk.bytesize if block_given?
+              end
+            end
+          end
+          body
+        end
+
+        def start(uri, &)
+          Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https", open_timeout: 5, read_timeout: 10, &)
+        end
+      end
+
+      # One progress bar per URL, filling as bytes arrive, under a headline
+      # bar that counts every byte.
+      class FetchUrlsProgress < Dry::CLI::Command
+        include Dry::CLI::UI
+
+        desc "Fetch URLs with a progress bar each, and write them all to urls.txt"
+        argument :urls, type: :array, required: true, desc: "URLs to fetch, separated by spaces"
+
+        def call(urls:, **)
+          # A bar's total is fixed when it is declared, so ask each URL for its
+          # size first, with a HEAD request. A URL that fails here is left out.
+          found = urls.filter_map do |url|
+            [url, *HTTP.resolve(url)]
+          rescue StandardError => e
+            ui.status "#{url}: #{e.message}", level: :warn
+            nil
+          end
+          return ui.error("None of the #{urls.size} URLs could be fetched") if found.empty?
+
+          bodies = ui.multi_progress("Fetching #{found.size} URLs", concurrent: 8) do |m|
+            found.each do |url, uri, size|
+              m.progress(url, total: size || 1) do |bar|
+                sleep rand(1..4)
+                # Move the bar one byte at a time, as each chunk arrives.
+                body = HTTP.download(uri) { |bytes| bytes.times { bar.advance } if size }
+                bar.advance unless size # no Content-Length: done in one step
+                body
+              end
+            end
+          end
+
+          File.write("urls.txt", bodies.join("\n"))
+          ui.success "Wrote #{bodies.sum(&:bytesize)} bytes from #{found.size} of #{urls.size} URLs to urls.txt"
+        rescue StandardError => e
+          ui.error("Fetching failed", e.message)
+        end
+      end
+
+      # One spinner per URL, each saying what it is doing, and one file per URL.
+      class FetchUrls < Dry::CLI::Command
+        include Dry::CLI::UI
+
+        desc "Fetch URLs with a spinner each, and write each to its own file"
+        argument :urls, type: :array, required: true, desc: "URLs to fetch, separated by spaces"
+
+        def call(urls:, **)
+          bodies = ui.multi_spinner("Fetching #{urls.size} URLs", concurrent: 8) do |m|
+            urls.each do |url|
+              m.spinner(url) do |line|
+                line.detail = "resolving"
+                uri, = HTTP.resolve(url)
+                line.detail = "downloading #{uri.host}"
+                sleep rand(1..4) # slow enough to watch
+                HTTP.download(uri)
+              rescue StandardError => e
+                line.fail(e.message)
+                nil
+              end
+            end
+          end
+
+          files = urls.zip(bodies).filter_map do |url, body|
+            next unless body
+
+            "#{friendly_filename(url)}.txt".tap { |file| File.write(file, body) }
+          end
+          ui.success "Wrote #{files.size} of #{urls.size} URLs", files.join("\n")
+        end
+
+        private
+
+        def friendly_filename(url)
+          url.sub(%r{\Ahttps?://}, "").gsub(/[^\w.-]+/, "_").delete_suffix("_")
+        end
+      end
+
+      class ComputePrimes < Dry::CLI::Command
+        include Dry::CLI::UI
+
+        def self.closest_prime(n)
+          # Primes must be greater than 1
+          return 2 if n <= 2
+          return n if ::Prime.prime?(n)
+
+          distance = 1
+          loop do
+            lower = n - distance
+            upper = n + distance
+
+            primes = []
+            primes << lower if lower > 1 && ::Prime.prime?(lower)
+            primes << upper if ::Prime.prime?(upper)
+
+            # Return the prime(s) found at the shortest distance
+            return primes.size == 1 ? primes.first : primes if primes.any?
+
+            distance += 1
+          end
+        end
+
+        desc 'Compute closest prime to a given number in the array'
+        option :max, default: 100_000, desc: "Maximum integer to compute closest primes for", type: :integer
+
+        def call(max:)
+          ui.info "Computing closest primes..."
+          File.open('primes.txt', 'w') do |f|
+            integers = (1..max.to_i)
+            ui.progress("Computing Primes", total: integers.size) do |bar|
+              integers.each do |i|
+                p = ComputePrimes.closest_prime(i)
+                f.puts "closest prime to #{i} is #{p}"
+                bar.advance
+              end
+            end
+          end
+          ui.success("Computed #{max} primes, they are in the 'primes.txt' files.")
+        rescue StandardError => e
+          ui.error("Import failed", e.message)
+        end
+      end
+
+      register "version",         Version, aliases: ["v", "-v", "--version"]
+      register "urls_progress",   FetchUrlsProgress
+      register "urls_spinner",    FetchUrls
+      register "completion",      ::Dry::CLI::Autocomplete::Command[::Foo::CLI::Commands], hidden: true
+      register "primes",          ComputePrimes
+    end
+  end
+end
+
+Dry::CLI.new(Foo::CLI::Commands).call
+
+FileUtils.rm_f(Dir.glob("#{File.expand_path('../', __dir__)}/*.txt"))

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.3.0"
+      VERSION = "0.3.1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-cli-ui
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
@@ -177,6 +177,10 @@ files:
 - LICENSE.txt
 - README.md
 - SPECIFICATION.md
+- examples/Gemfile
+- examples/Gemfile.lock
+- examples/README.md
+- examples/bin/mycli
 - lib/dry-cli-ui.rb
 - lib/dry/cli/ui.rb
 - lib/dry/cli/ui/console.rb