popro 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 953431a63b91d3bb07e70cf638262c74dbbca5ced53020b5f6ba4b0b87b4a19f
-  data.tar.gz: 9658ac180fa9259438c95ab264c19d0588da7c959187ddbf169ea130f639296d
+  metadata.gz: 28d2afab9d53f8fa8ebf80ec36ee2d0e1529d150a6ffd2993409ba845a3f4c79
+  data.tar.gz: 858dbf273be5fe62af6f0c74fbcfe51fd34f6491b344381f40fab71a053c50a1
 SHA512:
-  metadata.gz: f04c243ad12db54726a87e17527d031adcea1f8229d8e815768c5e9416132c9c14b65e4ba324e0733bd15fb7a8773942499caa9aafa8566f97b7d39848f43091
-  data.tar.gz: a6c71eec92cc09a69742cb4c9dba2fec469595804589a12d468d5093ae8b3a7d316aad639b0091ead3f0f5fa7bea694cf6dcb996b3ded7922e79d9762ef75916
+  metadata.gz: 337b2b031a41c3ba78e438b906fac942b98eaacff1e0c489d01e4811b5f676760cc8e0b9f2d6fbab27c1ec344c5f42d6c677546ce7fb43d52a17f89d0d38ac98
+  data.tar.gz: 5d3b42ff7fb6ee26873afc35217daeb43b9f431f05e251c59e3b112ab13f14481fc0f0d108d3f3cb53f3c458a531af5ca55c5821f058d5941949bc59a0eeae51

data/CHANGELOG

@@ -1,2 +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/lib/popro.rb

@@ -7,7 +7,7 @@ module Popro
 
   require_relative 'popro/progress'
 
-  def self.new(total=0, **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

data/lib/popro/context.rb

@@ -54,7 +54,7 @@ module Popro
     def did(yielded = nil, amount = nil)
       @info.start unless @info.running?
       amount = @step if amount.nil?
-      raise TypeError('amount: expected an integer') unless amount.is_a? Integer
+      raise TypeError, "amount: expected an integer, got #{amount.class}" unless amount.is_a? Integer
 
       @info.current += amount unless amount.zero?
       @indicator.call(@info, yielded)
@@ -81,7 +81,7 @@ module Popro
 
     def _each(obj, total = nil, &block)
       total = obj.size if total.nil?
-      raise TypeError('total: expected an integer') unless total.is_a?(Integer) || total.nil?
+      raise TypeError, "total: expected an integer got #{total.class}" unless total.is_a?(Integer) || total.nil?
 
       @info.total += total if total.positive?
       # block = proc { |d| d } unless block_given?

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: popro
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - MikeSmithEU
@@ -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:
   - - ">="