austb-tty-spinner 0.5.0

data/lib/tty/spinner/formats.rb

@@ -0,0 +1,127 @@
+# coding: utf-8
+
+module TTY
+  module Formats
+    FORMATS = {
+      classic: {
+        interval: 10,
+        frames: %w{| / - \\}
+      },
+      spin: {
+        interval: 10,
+        frames: %w{◴ ◷ ◶ ◵ }
+      },
+      spin_2: {
+        interval: 10,
+        frames: %w{◐ ◓ ◑ ◒ }
+      },
+      spin_3: {
+        interval: 10,
+        frames: %w{◰ ◳ ◲ ◱}
+      },
+      spin_4: {
+        inteval: 10,
+        frames: %w{╫ ╪'}
+      },
+      pulse: {
+        interval: 10,
+        frames: %w{⎺ ⎻ ⎼ ⎽ ⎼ ⎻}
+      },
+      pulse_2: {
+        interval: 15,
+        frames: %w{▁ ▃ ▅ ▆ ▇ █ ▇ ▆ ▅ ▃ }
+      },
+      pulse_3: {
+        interval: 20,
+        frames: '▉▊▋▌▍▎▏▎▍▌▋▊▉'
+      },
+      dots: {
+        interval: 10,
+        frames: [ "⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏" ]
+      },
+      arrow: {
+        interval: 10,
+        frames: %w{← ↖ ↑ ↗ → ↘ ↓ ↙ }
+      },
+      arrow_pulse: {
+        interval: 10,
+        frames: [
+          "▹▹▹▹▹",
+          "▸▹▹▹▹",
+          "▹▸▹▹▹",
+          "▹▹▸▹▹",
+          "▹▹▹▸▹",
+          "▹▹▹▹▸"
+        ]
+      },
+      triangle: {
+        interval: 10,
+        frames: %w{◢ ◣ ◤ ◥}
+      },
+      arc: {
+        interval: 10,
+        frames: %w{ ◜ ◠ ◝ ◞ ◡ ◟ }
+      },
+      pipe: {
+        interval: 10,
+        frames: %w{ ┤ ┘ ┴ └ ├ ┌ ┬ ┐ }
+      },
+      bouncing: {
+        interval: 10,
+        frames: [
+          "[    ]",
+          "[   =]",
+          "[  ==]",
+          "[ ===]",
+          "[====]",
+          "[=== ]",
+          "[==  ]",
+          "[=   ]"
+        ]
+      },
+      bouncing_ball: {
+        interval: 10,
+        frames: [
+          "( ●    )",
+          "(  ●   )",
+          "(   ●  )",
+          "(    ● )",
+          "(     ●)",
+          "(    ● )",
+          "(   ●  )",
+          "(  ●   )",
+          "( ●    )",
+          "(●     )"
+        ]
+      },
+      box_bounce: {
+        interval: 10,
+        frames: %w{ ▌ ▀ ▐ ▄  }
+      },
+      box_bounce_2: {
+        interval: 10,
+        frames: %w{ ▖ ▘ ▝ ▗ }
+      },
+      star: {
+        interval: 10,
+        frames: %w{ ✶ ✸ ✹ ✺ ✹ ✷ }
+      },
+      toggle: {
+        interval: 10,
+        frames: %w{ ■ □ ▪ ▫ }
+      },
+      balloon: {
+        interval: 10,
+        frames: %w{ . o O @ * }
+      },
+      balloon_2: {
+        interval: 10,
+        frames: %w{. o O ° O o . }
+      },
+      flip: {
+        interval: 10,
+        frames: '-◡⊙-◠'.freeze
+      }
+    }
+  end # Formats
+end # TTY

data/lib/tty/spinner/multi.rb

@@ -0,0 +1,259 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require_relative '../spinner'
+
+module TTY
+  class Spinner
+    # Used for managing multiple terminal spinners
+    #
+    # @api public
+    class Multi
+      include Enumerable
+
+      extend Forwardable
+
+      def_delegators :@spinners, :each, :empty?, :length
+
+      DEFAULT_INSET = {
+        top:    Gem.win_platform? ? '+ '   : "\u250c ",
+        middle: Gem.win_platform? ? '|-- ' : "\u251c\u2500\u2500",
+        bottom: Gem.win_platform? ? '|__ ' : "\u2514\u2500\u2500"
+      }.freeze
+
+      # Initialize a multispinner
+      #
+      # @example
+      #   spinner = TTY::Spinner::Multi.new
+      #
+      # @param [String] message
+      #   the optional message to print in front of the top level spinner
+      #
+      # @param [Hash] options
+      # @option options [Hash] :style
+      #   keys :top :middle and :bottom can contain Strings that are used to
+      #   indent the spinners. Ignored if message is blank
+      # @option options [Object] :output
+      #   the object that responds to print call defaulting to stderr
+      # @option options [Boolean] :hide_cursor
+      #   display or hide cursor
+      # @option options [Boolean] :clear
+      #   clear ouptut when finished
+      # @option options [Float] :interval
+      #   the interval for auto spinning
+      #
+      # @api public
+      def initialize(*args)
+        @options = args.last.is_a?(::Hash) ? args.pop : {}
+        message = args.empty? ? nil : args.pop
+        @inset_opts = @options.delete(:style) { DEFAULT_INSET }
+        @create_spinner_lock = Mutex.new
+        @spinners    = []
+        @top_spinner = nil
+        @top_spinner = register(message) unless message.nil?
+
+        @callbacks = {
+          success: [],
+          error:   [],
+          done:    []
+        }
+      end
+
+      # Register a new spinner
+      #
+      # @param [String] pattern
+      #   the pattern used for creating spinner
+      #
+      # @api public
+      def register(pattern, options = {}, &job)
+        spinner = TTY::Spinner.new(pattern, @options.merge(options))
+
+        @create_spinner_lock.synchronize do
+          spinner.add_multispinner(self, @spinners.length)
+          spinner.job(&job) if block_given?
+          observe_events(spinner) if @top_spinner
+          @spinners << spinner
+          if @top_spinner
+            @spinners.each { |sp| sp.redraw_indent if sp.spinning? || sp.done? }
+          end
+        end
+
+        spinner
+      end
+
+      # Observe all child events to notify top spinner of current state
+      #
+      # @param [TTY::Spinner] spinner
+      #   the spinner to listen to for events
+      #
+      # @api private
+      def observe_events(spinner)
+        spinner.on(:success) { @top_spinner.success if success? }
+               .on(:error)   { @top_spinner.error if error? }
+               .on(:done)    { @top_spinner.stop if done? && !success? && !error? }
+      end
+
+      # Get the top level spinner if it exists
+      #
+      # @return [TTY::Spinner] the top level spinner
+      #
+      # @api public
+      def top_spinner
+        raise "No top level spinner" if @top_spinner.nil?
+
+        @top_spinner
+      end
+
+      # Auto spin the top level spinner & all child spinners
+      # that have scheduled jobs
+      #
+      # @api public
+      def auto_spin
+        raise "No top level spinner" if @top_spinner.nil?
+
+        @top_spinner.auto_spin
+        jobs = []
+        @spinners.each do |spinner|
+          if spinner.job?
+            spinner.auto_spin
+            jobs << Thread.new { spinner.instance_eval(&spinner.job) }
+          end
+        end
+        jobs.each(&:join)
+      end
+
+      # Pause all spinners
+      #
+      # @api public
+      def pause
+        @spinners.dup.each(&:pause)
+      end
+
+      # Resume all spinners
+      #
+      # @api public
+      def resume
+        @spinners.dup.each(&:resume)
+      end
+
+      # Find relative offset position to which to move the current cursor
+      #
+      # The position is found among the registered spinners given the current
+      # position the spinner is at provided its index
+      #
+      # @param [Integer] index
+      #   the position to search from
+      #
+      # @return [Integer]
+      #   the current position
+      #
+      # @api public
+      def count_line_offset(index)
+        Array(@spinners[index..-1]).reduce(0) do |acc, spinner|
+          if spinner.spinning? || spinner.done?
+            acc += 1
+          end
+          acc
+        end
+      end
+
+      # Find the number of characters to move into the line
+      # before printing the spinner
+      #
+      # @param [TTY::Spinner] spinner
+      #   the spinner for which line inset is calculated
+      #
+      # @return [String]
+      #   the inset
+      #
+      # @api public
+      def line_inset(spinner)
+        return '' if @top_spinner.nil?
+
+        case spinner
+        when @top_spinner
+          @inset_opts[:top]
+        when @spinners.last
+          @inset_opts[:bottom]
+        else
+          @inset_opts[:middle]
+        end
+      end
+
+      # Check if all spinners are done
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def done?
+        (@spinners - [@top_spinner]).all?(&:done?)
+      end
+
+      # Check if all spinners succeeded
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def success?
+        (@spinners - [@top_spinner]).all?(&:success?)
+      end
+
+      # Check if any spinner errored
+      #
+      # @return [Boolean]
+      #
+      # @api public
+      def error?
+        (@spinners - [@top_spinner]).any?(&:error?)
+      end
+
+      # Stop all spinners
+      #
+      # @api public
+      def stop
+        @spinners.dup.each(&:stop)
+        emit :done
+      end
+
+      # Stop all spinners with success status
+      #
+      # @api public
+      def success
+        @top_spinner.success if @top_spinner
+        @spinners.dup.each(&:success)
+        emit :success
+      end
+
+      # Stop all spinners with error status
+      #
+      # @api public
+      def error
+        @top_spinner.error if @top_spinner
+        @spinners.dup.each(&:error)
+        emit :error
+      end
+
+      # Listen on event
+      #
+      # @api public
+      def on(key, &callback)
+        unless @callbacks.key?(key)
+          raise ArgumentError, "The event #{key} does not exist. "\
+                               " Use :success, :error, or :done instead"
+        end
+        @callbacks[key] << callback
+        self
+      end
+
+      private
+
+      def emit(key, *args)
+        @callbacks[key].each do |block|
+          block.call(*args)
+        end
+      end
+    end # MultiSpinner
+  end # Spinner
+end # TTY

data/lib/tty/spinner/version.rb

@@ -0,0 +1,7 @@
+# coding: utf-8
+
+module TTY
+  class Spinner
+    VERSION = "0.5.0"
+  end # Spinner
+end # TTY

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: austb-tty-spinner
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Piotr Murach
+- Austin Blatt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-cursor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: A terminal spinner for tasks that have non-deterministic time frame.
+email:
+- austinblatt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/tty-spinner.rb
+- lib/tty/spinner.rb
+- lib/tty/spinner/formats.rb
+- lib/tty/spinner/multi.rb
+- lib/tty/spinner/version.rb
+homepage: https://github.com/austb/tty-spinner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A terminal spinner for tasks that have non-deterministic time frame.
+test_files: []
+has_rdoc: