progress_monitor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ebee08ed5906ff4ba92f40d53ad0355d82e33c0
+  data.tar.gz: f83435c6cb2c46d8b1501628cb41add64b3d8e3a
+SHA512:
+  metadata.gz: e176d59cc435ba148b8b763384ae369057e26ecd9485f327ec0a34b5b36ca10c3377c9c4332c8acbac2f5d26e729b6e27ca01b9683d8703c4214f8ab61ded8f4
+  data.tar.gz: 7f71b6a7219b7d2b7509a34fa6ea25cf977f34124acd59484952e7b4571426ea33970c2f540da2b56e3f396b784320d9a90b89a6184723c7b306c464d099ecf8

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in progress_monitor.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Tobias Cohen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# ProgressMonitor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'progress_monitor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install progress_monitor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/progress_monitor/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/progress_monitor.rb

@@ -0,0 +1,12 @@
+require "observer"
+require "io/console"
+
+require "progress_monitor/version"
+
+require "progress_monitor/task"
+require "progress_monitor/display"
+require "progress_monitor/utils"
+
+module ProgressMonitor
+
+end

data/lib/progress_monitor/display.rb

@@ -0,0 +1,32 @@
+require "progress_monitor/display/task_observer"
+require "progress_monitor/display/input_loop"
+require "progress_monitor/display/message_loop"
+require "progress_monitor/display/timer_loop"
+
+require "progress_monitor/display/renderer"
+require "progress_monitor/display/progress_bar"
+
+module ProgressMonitor
+  class Display
+    attr :task, :queue
+
+    def initialize(task)
+      @task = task
+      @queue = Queue.new
+    end
+
+    def display
+      @current_task = task
+
+      @renderer = Renderer.new(task)
+      @renderer.refresh
+
+      task.add_observer TaskObserver.new(queue)
+
+      @main_thread = Thread.current
+      Thread.new { InputLoop.new(queue).perform }
+      Thread.new { TimerLoop.new(queue).perform }
+      Thread.new { MessageLoop.new(queue, @main_thread, @renderer).perform }
+    end
+  end
+end

data/lib/progress_monitor/display/input_loop.rb

@@ -0,0 +1,46 @@
+module ProgressMonitor
+  class Display
+    class InputLoop
+      attr :queue
+
+      def initialize(queue)
+        @queue = queue
+        @status = :normal
+      end
+
+      def perform
+        loop { get_key }
+      end
+
+      private
+
+      def get_key
+        key = STDIN.getch
+        case @status
+          when :normal
+            if key == "\e"
+              @status = :escape
+            else
+              send_key(key)
+            end
+          when :escape
+            if key == "["
+              @status = :special
+            else
+              send_key("\e#{key}")
+              @status = :normal
+            end
+          when :special
+            send_key("\e[#{key}")
+            @status = :normal
+        end
+      rescue => e
+        puts e.inspect
+      end
+
+      def send_key(key)
+        @queue << { type: :input, key: key }
+      end
+    end
+  end
+end

data/lib/progress_monitor/display/message_loop.rb

@@ -0,0 +1,56 @@
+module ProgressMonitor
+  class Display
+    class MessageLoop
+      attr :queue, :main_thread, :renderer
+
+      def initialize(queue, main_thread, renderer)
+        @queue = queue
+        @main_thread = main_thread
+        @renderer = renderer
+      end
+
+      def perform
+        loop do
+          message = queue.pop
+          case message[:type]
+            when :update
+              on_update(message[:task], message[:event], message[:details])
+            when :timer
+              on_timer
+            when :input
+              on_input message[:key]
+          end
+        end
+      rescue => error
+        main_thread.raise error
+      end
+
+      private
+
+      def on_update(task, event, details)
+        case event
+          when :status
+            renderer.task = task
+            renderer.refresh
+        end
+      end
+
+      def on_input(key)
+        case key
+          when ?\C-c
+            main_thread.raise Interrupt
+          when "\e[A"
+            collapse
+          when "\e[B"
+            expand
+          else
+            puts key.inspect
+        end
+      end
+
+      def on_timer
+        @renderer.refresh
+      end
+    end
+  end
+end

data/lib/progress_monitor/display/progress_bar.rb

@@ -0,0 +1,34 @@
+module ProgressMonitor
+  class Display
+    class ProgressBar
+      attr_accessor :size, :completion_percent
+
+      def initialize(size: 20, completion_percent: 0)
+        @size = size
+        @completion_percent = completion_percent
+      end
+
+      BAR_PROGRESS = "█"
+      BAR_SPACE = " "
+      BAR_PARTIAL_PROGRESS = [BAR_SPACE, '▏', '▎', '▍', '▌', '▋', '▊', '▉']
+
+      def render
+        if completion_percent == :unknown
+          '╍' * size
+        else
+          completion_float = completion_percent.to_f / 100 * size
+          completion_size = completion_float.floor
+          remainder = (completion_float % 1 * 8).floor
+          if completion_size < size
+            BAR_PROGRESS * completion_size + BAR_PARTIAL_PROGRESS[remainder] + BAR_SPACE * (size - completion_size - 1)
+          else
+            BAR_PROGRESS * size
+          end
+        end
+      rescue => e
+        puts e
+        ""
+      end
+    end
+  end
+end

data/lib/progress_monitor/display/renderer.rb

@@ -0,0 +1,53 @@
+module ProgressMonitor
+  class Display
+    class Renderer
+      attr_accessor :task
+
+      def initialize(task)
+        @task = task
+        @current_state = nil
+      end
+
+      def refresh
+        new_state = task_state
+
+        if @current_state != new_state
+          render task_state
+          @current_state = new_state
+        end
+
+      rescue => e
+        puts "\r\n", e.inspect, e.backtrace
+        nil
+      end
+
+      private
+
+      def task_state
+        {
+          name:               task.name,
+          completion_percent: task.completion_percent,
+        }
+      end
+
+      def render(state)
+        left                            = state[:name]
+        progress_bar                    = ProgressBar.new(size: 20)
+        progress_bar.completion_percent = state[:completion_percent]
+        right                           = progress_bar.render
+        spacing                         = " " * (columns - left.length - right.length)
+
+        print clear_code, left, spacing, "\e[48;5;235m\e[32m", right, "\e[0m\r\e[#{left.length}C"
+      end
+
+      def clear_code
+        "\e[1K\r"
+      end
+
+      def columns
+        STDIN.winsize[1]
+      end
+    end
+  end
+end
+

data/lib/progress_monitor/display/task_observer.rb

@@ -0,0 +1,15 @@
+module ProgressMonitor
+  class Display
+    class TaskObserver
+      attr :queue
+
+      def initialize(queue)
+        @queue = queue
+      end
+
+      def update(task, event, details)
+        @queue << {type: :update, task: task, event: event, details: details}
+      end
+    end
+  end
+end

data/lib/progress_monitor/display/timer_loop.rb

@@ -0,0 +1,18 @@
+module ProgressMonitor
+  class Display
+    class TimerLoop
+      attr :queue
+
+      def initialize(queue)
+        @queue = queue
+      end
+
+      def perform
+        loop do
+          sleep 0.1
+          queue << {type: :timer}
+        end
+      end
+    end
+  end
+end

data/lib/progress_monitor/task.rb

@@ -0,0 +1,94 @@
+require "progress_monitor/task/percentage_calculation/status"
+require "progress_monitor/task/percentage_calculation/io_position"
+require "progress_monitor/task/percentage_calculation/average_completion_of_subtasks"
+
+module ProgressMonitor
+  class Task
+    include Observable
+
+    attr :name, :parent, :subtasks, :status, :started_at, :finished_at
+    attr_accessor :io
+
+    PERCENTAGE_CALCULATORS = [
+      PercentageCalculation::Status,
+      PercentageCalculation::IoPosition,
+      PercentageCalculation::AverageCompletionOfSubtasks,
+    ]
+
+    def initialize(name, parent=nil)
+      @name = name
+      @parent = parent
+      @subtasks = []
+      @status = :new
+    end
+
+    def start
+      return unless status == :new
+
+      parent.start if parent
+      @status = :started
+      @started_at = Time.now
+      notify_status
+    end
+
+    def finish
+      return unless status == :started
+
+      parent.finish_if_subtasks_finished
+      @status = :finished
+      @finished_at = Time.now
+      notify_status
+    end
+
+    def duration
+      finished_at - started_at
+    end
+
+    def add_subtask(name)
+      Task.new(name, self).tap do |task|
+        @subtasks << task
+      end
+    end
+
+    def add_subtasks(*names)
+      names.map &method(:add_subtask)
+    end
+
+    def add_and_run_subtasks(items, name_fn, &run_fn)
+      items.map do |item|
+        [item, add_subtask(name_fn.call(item))]
+      end.each do |args|
+        run_fn.call(*args)
+      end
+    end
+
+    def completion_percent
+      PERCENTAGE_CALCULATORS.each do |calculator|
+        result = calculator.new(self).perform
+        return result if result
+      end
+      :unknown
+    rescue => e
+      puts e.inspect
+      :unknown
+    end
+
+    protected
+
+    def notify(task, event, details)
+      parent.notify task, event, details if parent
+      changed
+      notify_observers task, event, details
+    end
+
+    def finish_if_subtasks_finished
+      finish if subtasks.all?{|st| st.status == :finished}
+    end
+
+    private
+
+    def notify_status
+      notify self, :status, {status: status}
+    end
+  end
+end

data/lib/progress_monitor/task/percentage_calculation/average_completion_of_subtasks.rb

@@ -0,0 +1,21 @@
+module ProgressMonitor
+  class Task
+    module PercentageCalculation
+      class AverageCompletionOfSubtasks
+        attr :task
+
+        def initialize(task)
+          @task = task
+        end
+
+        def perform
+          if task.subtasks.any?
+            Utils.average task.subtasks.map(&:completion_percent)
+          end
+        rescue
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/progress_monitor/task/percentage_calculation/io_position.rb

@@ -0,0 +1,21 @@
+module ProgressMonitor
+  class Task
+    module PercentageCalculation
+      class IoPosition
+        attr :task
+
+        def initialize(task)
+          @task = task
+        end
+
+        def perform
+          if task.io && task.io.size > 0
+            (100.0 * task.io.pos / task.io.size).to_i
+          end
+        rescue
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/progress_monitor/task/percentage_calculation/status.rb

@@ -0,0 +1,24 @@
+module ProgressMonitor
+  class Task
+    module PercentageCalculation
+      class Status
+        attr :task
+
+        def initialize(task)
+          @task = task
+        end
+
+        def perform
+          case task.status
+            when :new
+              0
+            when :finished
+              100
+          end
+        rescue
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/progress_monitor/utils.rb

@@ -0,0 +1,11 @@
+module Utils
+  def self.average(items)
+    count = items.count
+    if count > 0
+      sum = items.reduce(:+)
+      sum / count
+    else
+      0
+    end
+  end
+end

data/lib/progress_monitor/version.rb

@@ -0,0 +1,3 @@
+module ProgressMonitor
+  VERSION = "0.0.1"
+end

data/progress_monitor.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'progress_monitor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "progress_monitor"
+  spec.version       = ProgressMonitor::VERSION
+  spec.authors       = ["Tobias Cohen"]
+  spec.email         = ["me@tobiascohen.com"]
+  spec.summary       = %q{Interactively display progress in the terminal for long running multi-step processes}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/script/example.rb

@@ -0,0 +1,93 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.load
+require 'progress_monitor'
+
+class Example
+
+  class CreateUsers
+
+    NAMES = %w(Joe Mary Steve Alexis Kate Stephanie Daniel Cassandra Keith Tyrion)
+
+    attr :task
+
+    def initialize(task)
+      @task = task
+    end
+
+    def perform
+      task.start
+      task.add_and_run_subtasks NAMES, -> (name) { "Create user #{name}" } do |name, user_task|
+        create_record, upload_photo, send_email = user_task.add_subtasks("Create user record", "Upload profile photo for #{name}", "Send welcome email")
+        CreateRecord.new(create_record).perform
+        UploadPhoto.new(name, upload_photo).perform
+        SendEmail.new(send_email).perform
+      end
+      task.finish
+    end
+
+    class CreateRecord
+      attr :task
+
+      def initialize(task)
+        @task = task
+      end
+
+      def perform
+        task.start
+        sleep 0.5
+        task.finish
+      end
+    end
+
+    class UploadPhoto
+      attr :name, :task
+
+      def initialize(name, task)
+        @name = name
+        @task = task
+      end
+
+      def perform
+        task.start
+
+        file = File.open(File.join(__dir__, 'sample.txt'))
+
+        task.io = file
+
+        until file.eof?
+          file.getc
+          sleep 0.05
+        end
+        file.close
+
+        task.finish
+      end
+    end
+
+    class SendEmail
+      attr :task
+
+      def initialize(task)
+        @task = task
+      end
+
+      def perform
+        task.start
+        sleep 1
+        task.finish
+      end
+    end
+  end
+
+  def perform
+    task = ProgressMonitor::Task.new("Initialize data")
+    ProgressMonitor::Display.new(task).display
+
+    CreateUsers.new(task.add_subtask("Create users")).perform
+  end
+
+end
+
+Example.new.perform

data/script/sample.txt

@@ -0,0 +1 @@
+The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

data/spec/progress_monitor_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ProgressMonitor do
+  it 'has a version number' do
+    expect(ProgressMonitor::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'progress_monitor'

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: progress_monitor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tobias Cohen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 
+email:
+- me@tobiascohen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/progress_monitor.rb
+- lib/progress_monitor/display.rb
+- lib/progress_monitor/display/input_loop.rb
+- lib/progress_monitor/display/message_loop.rb
+- lib/progress_monitor/display/progress_bar.rb
+- lib/progress_monitor/display/renderer.rb
+- lib/progress_monitor/display/task_observer.rb
+- lib/progress_monitor/display/timer_loop.rb
+- lib/progress_monitor/task.rb
+- lib/progress_monitor/task/percentage_calculation/average_completion_of_subtasks.rb
+- lib/progress_monitor/task/percentage_calculation/io_position.rb
+- lib/progress_monitor/task/percentage_calculation/status.rb
+- lib/progress_monitor/utils.rb
+- lib/progress_monitor/version.rb
+- progress_monitor.gemspec
+- script/example.rb
+- script/sample.txt
+- spec/progress_monitor_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Interactively display progress in the terminal for long running multi-step
+  processes
+test_files:
+- spec/progress_monitor_spec.rb
+- spec/spec_helper.rb