terminal-progress 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32e8754fe2c67746573adb545e22c71981f695c5f2b7466a3aa2ea51e411219e
+  data.tar.gz: 75a64bf6b8e27f9b7a74d61cecf7fc70f733d0afadb8a5ce28a43e8cafbff182
+SHA512:
+  metadata.gz: a246a923a0ad593c3186a0fb76ad08dc186d162dc104723926cbe89bd2d29781af058f9f58b32eb1299bcc1258de9de08eeb6d09d568aee0182c7d499439728c
+  data.tar.gz: 2513d8249d45f48676a8bbe499258d6f458e12e287c65dba38b5dbb02ad2ac58d88a2a0a3605561dcc08dc2b2069fdd9fc5f22128f6757a000c18e6a281956d5

data/lib/terminal_progress.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'curses'
+require 'colorize'
+
+##
+# Class for managing progress bars in the terminal
+class TerminalProgress
+  # Initialize a TermProg instance with a maximum value.
+  #
+  # @param max [Integer] The maximum value of the progress bar.
+  def initialize(max)
+    Curses.raw
+    instance_variable_set(:@cycle, '⣷⣯⣟⡿⢿⣻⣽⣾'.split(//).cycle)
+    instance_variable_set(:@i, 0)
+    instance_variable_set(:@max, max)
+    instance_variable_set(:@stop, '⣾')
+    instance_variable_set(:@loop, loop_thread)
+  end
+
+  def loop_thread
+    Thread.new do
+      loop do
+        instance_variable_set(:@stop, @cycle.next)
+        printf "  #{@stop}\r"
+        sleep 0.0625
+      end
+    end
+  end
+
+  ##
+  # Increment the progress bar and print a message if present.
+  #
+  # @param message [String, nil] Optional message to display above the progress bar.
+  def print_progress(message = nil)
+    instance_variable_set(:@i, @max) if @i > @max
+    printf "#{' ' * Curses.cols}\r#{message}\r\n" unless message.nil?
+    print_line
+    instance_variable_set(:@i, @i + 1)
+  end
+
+  ##
+  # Print a single line of the progress bar.
+  def print_line
+    printf "#{prefix}#{'='.light_cyan * width}#{' ' * blank}#{suffix}\r"
+  end
+
+  ##
+  # This is the last call to terminate the progress loop and finish rendering the bar.
+  def print_complete
+    printf "    #{@max}/#{@max}: [#{'='.light_yellow * width}#{suffix}\r\n"
+    kill
+  end
+
+  # Terminate the progress loop.
+  def kill
+    Thread.kill @loop
+  end
+
+  # Check if the progress loop is still alive.
+  #
+  # @return [Boolean] Returns true if the progress loop is alive, otherwise false.
+  def alive?
+    @loop.alive?
+  end
+
+  private
+
+  # Generate the prefix of the progress bar.
+  def prefix
+    "  #{@stop} #{@i.to_s.rjust(@max.to_s.length)}/#{@max}: ["
+  end
+
+  # Calculate the maximum width for the progress bar.
+  def max_width
+    Curses.cols - prefix.length - suffix.length
+  end
+
+  # Calculate the current width of the progress bar.
+  def width
+    ((@i / @max.to_f) * max_width).to_i
+  end
+
+  # Calculate the number of blank spaces in the progress bar.
+  def blank
+    max_width - width
+  end
+
+  # Define the suffix of the progress bar.
+  def suffix
+    ']'
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: terminal-progress
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lee Whittaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: curses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.20.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.56.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.56.3
+- !ruby/object:Gem::Dependency
+  name: stringio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+description: |2
+      Terminal Progress is a progress bar manager for Ruby applications. It
+      provides a simple way to display progress updates in the terminal, making
+      it ideal for tasks like seed data eneration, file processing, or any
+      operation where progress tracking is ideal.
+email: whittakerlee81@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/terminal_progress.rb
+homepage: https://github.com/Okomikeruko/terminal-progress
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: terminal-progress - Simplify progress tracking in your Ruby applications
+  with this simple progress bar manager.
+test_files: []