popro 0.0.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e8aecacb06e0bfe98467ac74b74f0b5e90ddc65f57069ae4bf29bdc7073b8a
-  data.tar.gz: 6a220ecf6de03a768aeed0d4998983ada21d037859a9deafe6263b4604b201d7
+  metadata.gz: 28d2afab9d53f8fa8ebf80ec36ee2d0e1529d150a6ffd2993409ba845a3f4c79
+  data.tar.gz: 858dbf273be5fe62af6f0c74fbcfe51fd34f6491b344381f40fab71a053c50a1
 SHA512:
-  metadata.gz: cb458d4d2a5169342ede984048be23c86d101db7546585e408e7470fe799f3344df4d2c691e42e43ff5ddd915e9af284a44ae59a7780890b06340a70a5e56419
-  data.tar.gz: 6a8fc7aef7feec2b0c39af0f1478f1cebaf4ccb8667edcc0842d119019dec709998e2d0a3930869646b51a210f4758eaa2b721894b7a1b79d554f44294996ce3
+  metadata.gz: 337b2b031a41c3ba78e438b906fac942b98eaacff1e0c489d01e4811b5f676760cc8e0b9f2d6fbab27c1ec344c5f42d6c677546ce7fb43d52a17f89d0d38ac98
+  data.tar.gz: 5d3b42ff7fb6ee26873afc35217daeb43b9f431f05e251c59e3b112ab13f14481fc0f0d108d3f3cb53f3c458a531af5ca55c5821f058d5941949bc59a0eeae51

data/CHANGELOG

@@ -1 +1,3 @@
+0.2.1 add support for estimation and re-use of default indicator with added concatted formatters
+0.2.0 various fixes and added unit tests
 0.0.1 initial version

data/README.md

@@ -1,13 +1,20 @@
 # Po'Pro: The Poor-Man's Progress Indicator
 
+[![Version](https://badge.fury.io/rb/popro.svg)](https://badge.fury.io/rb/popro) 
+[![Tests](https://github.com/MikeSmithEU/PoPro/workflows/Code%20quality%20&%20unit%20tests/badge.svg)](https://github.com/MikeSmithEU/PoPro/actions?query=workflow%3A%22Code+quality+%26+unit+tests%22)
+
+## Current TODOs
+
+ - [ ] properly update documentation
+ - [ ] simplify some stuff (each0?)
+ - [ ] 100% code coverage
+
 ## Why?
 
 Easier and cleaner progress indication.
 
 ## How?
 
-TODO: properly update documentation, simplify some stuff. 100% code coverage
-
 ### Basic usage
 
 The invocation `Popro#did(yielded)` is used to signify that one step in progress has been finished.
@@ -263,11 +270,11 @@ end
 ## Formatters
 
 You can set your own formatters using `Popro#formatter(&block)`. Each formatter can be a `Proc`, `block` or
-class implementing the `call` method (e.g. the `PoproFormatter::*` classes).
+class implementing the `call` method (e.g. the `Popro::Formatter::*` classes).
 
 The formatter will be invoked with 2 arguments:
 
-  1. `info`, an instance of `PoproInfo` containing e.g. `current` and `total`.
+  1. `info`, an instance of `Popro::Info` containing e.g. `current` and `total`.
   2. `yielded`, whatever was passed to the `Popro#did` method.
 
 It can also be used inside blocks.
@@ -315,7 +322,7 @@ would output:
 
 Indicator classes are responsible for communicating the progress (or not, as the case may be).
 
-It is possible to provide your own "indicators" or use one of the provided ones (see `PoproIndicator` module).
+It is possible to provide your own "indicators" or use one of the provided ones (see `Popro::Indicator` module).
 
-The default `PoproIndicator` class is `PoproIndicator.default` (which returns an instance of `PoproIndicator::Stream`), which outputs the progress to STDOUT each time `Popro#did` or `Popro#will` is called.
+The default `Popro::Indicator` class is `Popro::Indicator.default` (which returns an instance of `Popro::Indicator::Stream`), which outputs the progress to STDOUT each time `Popro#did` or `Popro#will` is called.
 

data/lib/popro.rb

@@ -7,22 +7,19 @@ module Popro
 
   require_relative 'popro/progress'
 
-  def self.new(total, **options, &block)
+  def self.new(total = 0, **options, &block)
     raise ConfigError, 'using :total is not supported in new' if options.key?(:total) && (options[:total] != total)
 
     options[:total] = total
     Progress.new(**options, &block)
   end
 
-  def self.each(obj, _total = nil, **options, &block)
+  def self.each(obj, total = nil, **options, &block)
     new(0, **options).each(obj, total, &block).done
   end
 
-  def self.each0(obj, **options, &block)
-    raise ConfigError, 'using :step is not supported in each0' if options.key?(:step)
-
-    options[:step] = 0
-    each(obj, 0, **options, &block)
+  def self.each_will(obj, titler, total = nil, **options, &block)
+    new(0, **options).each_will(obj, titler, total, &block).done
   end
 
   def self.command_line(*_args)

data/lib/popro/context.rb

@@ -3,7 +3,7 @@
 module Popro
   # the progress context passed as first argument to blocks (or named argument for `Progress#each` and `Popro.each`)
 
-  WILL_CHECK_MARKS ||= '☐☑'
+  WILL_CHECK_MARKS ||= ' ✔'
 
   class Context
     def initialize(progress:, info:, indicator:, step: 1)
@@ -14,25 +14,17 @@ module Popro
     end
 
     def each(obj, total = nil, &block)
-      total = obj.size if total.nil?
-      @info.total += total if total.positive?
-      block = proc { |d| d } unless block_given?
-
-      obj.each do |*args|
-        did block.call(*args, progress: self)
+      _each(obj, total) do |*args|
+        did block.call(*args, progress: @info)
       end
-
-      self
     end
 
-    def each0(obj, &block)
-      each(obj, 0, &block)
-    end
-
-    def each_will(obj, titler, total = nil)
-      each(obj, total) do |*args, **kwargs|
-        kwargs[:progress].will titler.call(*args) do
-          yield(*args, **kwargs)
+    def each_will(obj, titler, total = nil, &block)
+      _each(obj, total) do |*args|
+        title = titler.call(*args)
+        will(title) do
+          block.call(*args, progress: @info)
+          nil
         end
       end
     end
@@ -59,25 +51,25 @@ module Popro
       block
     end
 
-    def did(yielded = nil, amount = 1)
+    def did(yielded = nil, amount = nil)
       @info.start unless @info.running?
-      inc amount, yielded
+      amount = @step if amount.nil?
+      raise TypeError, "amount: expected an integer, got #{amount.class}" unless amount.is_a? Integer
+
+      @info.current += amount unless amount.zero?
+      @indicator.call(@info, yielded)
 
       self
     end
 
-    def will(title = nil, use_block_result_as_title = nil, step = nil)
-      @info.start unless @info.running?
-      inc 0, "#{WILL_CHECK_MARKS[0]} #{title}"
+    def will(title = nil, step = nil, &block)
+      did "#{WILL_CHECK_MARKS[0]} #{title}", 0
 
       return self unless block_given?
 
-      step = @step if step.nil?
-      yielded = yield @context
-      yielded = "#{WILL_CHECK_MARKS[1]} #{title}" unless title.nil? || use_block_result_as_title
-
-      # no need to communicate to Indicator if we are not advancing (avoid double calls)
-      did yielded, step unless step.zero?
+      block.call
+      yielded = "#{WILL_CHECK_MARKS[1]} #{title}"
+      did(yielded, step || @step)
       yielded
     end
 
@@ -87,11 +79,18 @@ module Popro
 
     private
 
-    def inc(amount, yielded = nil)
-      raise TypeError('expected an integer') unless amount.is_a? Integer
+    def _each(obj, total = nil, &block)
+      total = obj.size if total.nil?
+      raise TypeError, "total: expected an integer got #{total.class}" unless total.is_a?(Integer) || total.nil?
 
-      @info.current += amount unless amount.zero?
-      @indicator.call(@info, yielded)
+      @info.total += total if total.positive?
+      # block = proc { |d| d } unless block_given?
+
+      obj.each do |*args, **kwargs|
+        block.call(*args, **kwargs)
+      end
+
+      self
     end
   end
 end

data/lib/popro/formatter.rb

@@ -30,7 +30,7 @@ module Popro
       def call(info, *args)
         result = @formatter.call(info, *args)
         @longest = [@longest, result.size].max
-        "\r" + result.ljust(@longest, ' ')
+        "\r#{result.ljust(@longest, ' ')}"
       end
     end
 
@@ -43,6 +43,53 @@ module Popro
       end
     end
 
+    class Estimate
+      # TODO: cleaner implementation/formatstring
+      attr_reader :info
+
+      def initialize
+        @start_time = current_time
+        @info = nil
+      end
+
+      def call(info, *_args)
+        @info = info
+
+        [
+          "estimated time left: #{format_duration(estimated_left)}",
+          "[#{format_duration(elapsed)}/#{format_duration(estimated_total)}]"
+        ].join(', ')
+      end
+
+      private
+
+      def elapsed
+        current_time - @start_time
+      end
+
+      def estimated_total
+        return nil if info.current.zero? || info.total.zero?
+
+        elapsed + (info.total / info.current) * elapsed
+      end
+
+      def estimated_left
+        return nil if info.current.zero? || info.total.zero?
+
+        (info.total / info.current) * elapsed
+      end
+
+      def format_duration(secs)
+        return '??d??h??m??s' if secs.nil?
+
+        format('%02dd%02dh%02dm%02ds', secs / 86_400, secs / 3600 % 24, secs / 60 % 60, secs % 60)
+      end
+
+      def current_time
+        Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
+    end
+
     class Sprintf
       def initialize(format_string = nil)
         @format_string = format_string

data/lib/popro/indicator.rb

@@ -27,7 +27,7 @@ module Popro
         formatter = self.class.default_formatter(formatter) if formatter.nil? || formatter.is_a?(String)
 
         @formatter = formatter
-        @stream = stream || STDOUT
+        @stream = stream || $stdout
       end
 
       def call(*args)
@@ -45,11 +45,12 @@ module Popro
       end
     end
 
-    def self.default_formatter
+    def self.default_formatter(*extra_formatters)
       ::Popro::Formatter::RewriteLine.new(
         ::Popro::Formatter::Concat.new(
           ::Popro::Formatter::Spinner.new(:dots, bounce: true),
           ::Popro::Formatter::Sprintf.new,
+          *extra_formatters,
           (proc do |_, yielded = nil|
             yielded if yielded.is_a?(String) || yielded.is_a?(Numeric)
           end),
@@ -58,8 +59,8 @@ module Popro
       )
     end
 
-    def self.default
-      Stream.new(formatter: default_formatter)
+    def self.default(*extra_formatters)
+      Stream.new(formatter: default_formatter(*extra_formatters))
     end
   end
 end

data/lib/popro/info.rb

@@ -57,7 +57,6 @@ module Popro
 
     def to_h
       {
-        started: @started,
         pct: pct,
         pct_formatted: pct_formatted,
         current: @current,

data/lib/popro/progress.rb

@@ -6,17 +6,24 @@ module Popro
     require_relative 'info'
     require_relative 'indicator'
 
+    DEFAULT_OPTIONS ||= {
+      total: 0,
+      current: 0,
+      indicator: Indicator.default
+    }.freeze
+
     attr_reader :context
 
     def initialize(**options)
       @started = false
-      @info = Info.new(total: options.delete(:total), current: options.delete(:current))
 
-      options[:step] ||= (block_given? ? 0 : 1)
-      options[:progress] = self
-      options[:info] = @info
-      options[:indicator] = Indicator.default unless options.key? :indicator
+      options = DEFAULT_OPTIONS
+                .merge(step: block_given? ? 0 : 1)
+                .merge(options)
 
+      @info = Info.new(total: options.delete(:total), current: options.delete(:current))
+
+      options.merge!(progress: self, info: @info)
       @context = Context.new(**options)
 
       register_aliases
@@ -26,15 +33,27 @@ module Popro
       done
     end
 
+    # increase the total
+    def add(amount)
+      @info.total += amount
+      self
+    end
+
     private
 
     def register_aliases
       class << self
-        %i[each each0 each_will to_proc did will formatter start done].each do |method_name|
+        %i[each each_will to_proc did will formatter start done].each do |method_name|
           define_method method_name do |*args, &block|
             @context.public_send(method_name, *args, &block)
           end
         end
+
+        %i[current total].each do |method_name|
+          define_method method_name do
+            @info.public_send(method_name)
+          end
+        end
       end
     end
   end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: popro
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.1
 platform: ruby
 authors:
 - MikeSmithEU
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-01 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies: []
 description: The Poor-Man's Progress Indicator
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -31,7 +31,7 @@ homepage: https://rubygems.org/gems/popro
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -39,7 +39,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Po'Pro
 test_files: []