cli_progress_bar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 399a70e89cbbf1b0185cd00850c4522f4bbe568f73cae6b05e1717ecb41d729d
+  data.tar.gz: 38fe781cb8198a0afdd6f2a5760cb7b323957f8446ca938ab23b549316c7b3ea
+SHA512:
+  metadata.gz: 11e2e671777899f3100a43a8d1a5350c60b3e288c5932bb27dbea21c4d48bbf4d8a994ebf44821e6ca41fa5c921289400ad8eec44d41616ecd51b74f53501a7a
+  data.tar.gz: ec3ed2e3b4de76cecb6798d5cc908b8ccc063195cec1f10c6e5f69584df07d37dd48d4789bd85bc5641b041d1df88618444db1b9d2205ca29ba77b51c40fda57

data/lib/cli_progress_bar/item_progress_bar.rb

@@ -0,0 +1,49 @@
+
+# Progress bar for items, where you increment or set the current progress
+# as an item count against a total, from which the percentage is calculated.
+# e.g. max_items: 10, num_items: 5 == 50% output on the progress bar.
+module CLIProgressBar
+  class ItemProgressBar < ProgressBar
+    attr_reader :max_items
+
+    def initialize(
+      max_items,
+      of: "", log_at: LOG_AT_ALL_PERCENTS, bar_length: BAR_LENGTH,
+      line_char: LINE_CHAR, prefix: "", suffix: "", stream: STD_OUT
+    )
+      raise "max_items must be positive" unless max_items.positive?
+
+      of = "#{max_items} #{of.strip}" unless of.empty?
+
+      super(of:, log_at:, bar_length:, line_char:, prefix:, suffix:, stream:)
+
+      @max_items = max_items
+      @current_items = 0
+    end
+
+    def increment(by: 1, prefix: nil, suffix: nil)
+      raise "Invalid by: value" unless (@current_items + by).between?(1, @max_items)
+
+      @current_items += by
+      update_progress(prefix:, suffix:)
+    end
+
+    def update(num_items, prefix: nil, suffix: nil)
+      raise "Invalid num_items value" unless num_items.between?(1, @max_items)
+
+      @current_items = num_items
+      update_progress(prefix:, suffix:)
+    end
+
+    private
+
+    def update_progress(prefix: nil, suffix: nil)
+      @progress = percentage(@current_items, @max_items)
+      write_to_stream(prefix:, suffix:, items: @current_items)
+    end
+
+    def percentage(num_items, max_items)
+      num_items * 100 / max_items
+    end
+  end
+end

data/lib/cli_progress_bar/percent_progress_bar.rb

@@ -0,0 +1,27 @@
+
+# Progress bar for percentages, where you increment or set the current progress
+# as a percentage and specify which percentages are to be logged to the stream.
+module CLIProgressBar
+  class PercentProgressBar < ProgressBar
+    def initialize(
+      of: "", log_at: LOG_AT_TEN_PERCENTS, bar_length: BAR_LENGTH,
+      line_char: LINE_CHAR, prefix: "", suffix: "", stream: STD_OUT
+    )
+      super
+    end
+
+    def increment(by: 1, prefix: nil, suffix: nil)
+      raise "Invalid by: value" unless (@progress + by).between?(1, 100)
+
+      @progress += by
+      write_to_stream(prefix:, suffix:)
+    end
+
+    def update(percent, prefix: nil, suffix: nil)
+      raise "Invalid percent value" unless percent.between?(1, 100)
+
+      @progress = percent
+      write_to_stream(prefix:, suffix:)
+    end
+  end
+end

data/lib/cli_progress_bar/progress_bar.rb

@@ -0,0 +1,59 @@
+
+# Parent progress bar class to be inherited from only.
+class CLIProgressBar::ProgressBar
+  attr_reader :progress
+
+  def initialize(
+    of: "", log_at: LOG_AT_TEN_PERCENTS, bar_length: BAR_LENGTH,
+    line_char: LINE_CHAR, prefix: "", suffix: "", stream: STD_OUT
+  )
+    raise "bar_length: must be positive and even" unless bar_length.positive? && bar_length.even?
+    raise "stream: must respond to #puts" unless stream.respond_to?(:puts)
+
+    @progress = 0
+    @of = of.to_s
+    @log_at = log_at
+    @bar_length = bar_length
+    @line_char = line_char
+    @prefix = prefix
+    @suffix = suffix
+    @stream = stream
+  end
+
+  private
+
+  # Writes a single line to stream, something like:
+  #
+  # Percent: [------------------->       ]  70% of 2.3 MiB
+  # - or -
+  # Item:    [------------------>        ]  8 of 12 repos (66%)
+  def write_to_stream(prefix: nil, suffix: nil, items: nil)
+    raise "Invalid progress value" unless @progress.between?(1, 100)
+
+    return unless @log_at.include?(@progress)
+
+    completed_length = (@bar_length * @progress / 100).to_i
+    remaining_length = @bar_length - completed_length
+    remaining_length -= 1 if remaining_length == @bar_length
+
+    # Ensure non negative number and remove a char for the >
+    completed_length = completed_length < 1 ? 0 : completed_length - 1
+
+    prefix ||= @prefix
+    prefix = prefix.empty? ? "" : "#{prefix.strip}  "
+    suffix ||= @suffix
+    suffix = suffix.empty? ? "" : " #{suffix.strip}"
+    of_str = @of.empty? ? "" : " of #{@of.strip}"
+    totals = if items
+               "#{items}#{of_str} (#{@progress}%)"
+             else
+               "#{@progress}%#{of_str}"
+             end
+
+    line = "%s[%s>%s]  %s%s" % [
+      prefix, @line_char * completed_length, " " * remaining_length, totals, suffix
+    ]
+
+    @stream.puts(line)
+  end
+end

data/lib/cli_progress_bar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CLIProgressBar
+  VERSION = "0.1.0"
+end

data/lib/cli_progress_bar.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "cli_progress_bar/version"
+require_relative "cli_progress_bar/progress_bar"
+require_relative "cli_progress_bar/percent_progress_bar"
+require_relative "cli_progress_bar/item_progress_bar"
+
+module CLIProgressBar
+  LOG_AT_ALL_PERCENTS = (1..100).to_a.freeze
+  LOG_AT_FIVE_PERCENTS = [5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100].freeze
+  LOG_AT_TEN_PERCENTS = [10, 20, 30, 40, 50, 60, 70, 80, 90, 100].freeze
+  LOG_AT_QUARTER_PERCENTS = [25, 50, 75, 100].freeze
+  BAR_LENGTH = 60.freeze
+  LINE_CHAR = "-".freeze
+  STD_OUT = $stdout
+
+  def self.new(*args, **kwargs)
+    new_percent_bar(*args, **kwargs)
+  end
+
+  def self.new_percent_bar(*args, **kwargs)
+    PercentProgressBar.new(*args, **kwargs)
+  end
+
+  def self.new_item_bar(*args, **kwargs)
+    ItemProgressBar.new(*args, **kwargs)
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: cli_progress_bar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Telford
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: A simple and customizable command line progress bar for Ruby applications
+email:
+- michael.telford@live.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cli_progress_bar.rb
+- lib/cli_progress_bar/item_progress_bar.rb
+- lib/cli_progress_bar/percent_progress_bar.rb
+- lib/cli_progress_bar/progress_bar.rb
+- lib/cli_progress_bar/version.rb
+homepage: https://github.com/michaeltelford/cli_progress_bar
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/michaeltelford/cli_progress_bar
+  source_code_uri: https://github.com/michaeltelford/cli_progress_bar
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A simple CLI progress bar for Ruby applications
+test_files: []