popro 0.1.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0ed84ff76f7db2ab74b649ef29f62dab630f3b12dc0e2a8cf011382814d9396
-  data.tar.gz: ff292d589ecdfd671fe1136079611bc45ccbec5c262c2b831baef59799732de9
+  metadata.gz: fc8a91c38e9a66e7b5de492fe92f5def2d044fc118a3dfc25ef826ccadc8692c
+  data.tar.gz: 00fc035091657744a3bc7110b91f1cfb49192d07afce1a0866e20745b038c368
 SHA512:
-  metadata.gz: 810c7e4925421c86e3585d429a948f50de6ea913042b9c3edc6d13a63557286e9ca83f2d6c973700388d5934aff9097071b78db7c6b0c3eb162e6fba6666e566
-  data.tar.gz: ffab387b8fbed5b19e88d58d97a3001cff0f7855b9154754acd114c6bdd53bb846085d47fb04f7ed7c3a3972315f400a71dbbb6e28519a45b30243df39180f4a
+  metadata.gz: f0c02a15ce252052573de441631e8665f8c2fde13e27162287a01739df908283514f8fa0eb98056e179c2d6ac139aac89bb4a603abd45ae1d9333d960f2de5e4
+  data.tar.gz: 989554d6b7dcf42c8db7a0a1b240b440acf07fd1b965e861486361fe7627fe4c65d37ae8df951daeae37445d689239397613a34f1e6231d11e5addbccdaf586a

data/CHANGELOG

@@ -1 +1,5 @@
+0.2.3 add support for `Popro.silenced`
+0.2.2 add gonna and each_gonna, add Callback Indicator
+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,9 @@ module Popro
 
   require_relative 'popro/progress'
 
-  def self.new(total, **options, &block)
+  @_is_silenced = false
+
+  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
@@ -15,7 +17,6 @@ module Popro
   end
 
   def self.each(obj, total = nil, **options, &block)
-    options[:step] = 0 unless options.key? :step
     new(0, **options).each(obj, total, &block).done
   end
 
@@ -23,6 +24,21 @@ module Popro
     new(0, **options).each_will(obj, titler, total, &block).done
   end
 
+  def self.each_gonna(obj, titler, total = nil, **options, &block)
+    new(0, **options).each_gonna(obj, titler, total, &block).done
+  end
+
+  def self.silenced
+    prev_silenced = @_is_silenced
+    @_is_silenced = true
+    yield
+    @_is_silenced = prev_silenced
+  end
+
+  def self.silenced?
+    @_is_silenced
+  end
+
   def self.command_line(*_args)
     raise 'TODO: implement a `ps` style progress indicator for command line'
   end

data/lib/popro/context.rb

@@ -6,11 +6,13 @@ module Popro
   WILL_CHECK_MARKS ||= ' ✔'
 
   class Context
+    require_relative 'indicator'
+
     def initialize(progress:, info:, indicator:, step: 1)
       @progress = progress
-      @indicator = indicator
       @info = info
       @step = step
+      @_indicator = indicator
     end
 
     def each(obj, total = nil, &block)
@@ -39,31 +41,44 @@ module Popro
       raise OutOfSyncError, 'done while not started' unless @info.running?
 
       @info.finish
-      @indicator.finish if @indicator.respond_to? :finish
+      indicator.finish if indicator.respond_to? :finish
     end
 
     def formatter(&block)
-      unless @indicator.respond_to?(:formatter=)
-        raise ConfigError, "seems formatter is not available for #{@indicator.class}"
+      unless @_indicator.respond_to?(:formatter=)
+        raise ConfigError, "seems formatter is not available for #{@_indicator.class}"
       end
 
-      @indicator.formatter = block
+      @_indicator.formatter = block
       block
     end
 
     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)
+      indicator.call(@info, yielded)
+
+      self
+    end
 
+    def gonna(title)
+      @info.start unless @info.running?
+      indicator.call(@info, title)
       self
     end
 
+    def each_gonna(obj, titler, total = nil, &block)
+      _each(obj, total) do |*args|
+        gonna(titler.call(*args))
+        block.call(*args, progress: @info)
+      end
+    end
+
     def will(title = nil, step = nil, &block)
-      did "#{WILL_CHECK_MARKS[0]} #{title}", 0
+      gonna "#{WILL_CHECK_MARKS[0]} #{title}"
 
       return self unless block_given?
 
@@ -79,9 +94,15 @@ module Popro
 
     private
 
+    def indicator
+      return Indicator::Null if Popro.silenced?
+
+      @_indicator
+    end
+
     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

@@ -1,9 +1,25 @@
 # frozen_string_literal: true
 
+require 'popro'
+
 module Popro
   module Indicator
     require_relative 'formatter'
 
+    class Null
+      def self.new
+        self
+      end
+
+      def self.initialize
+        self
+      end
+
+      def self.call(*_args); end
+
+      def self.finish; end
+    end
+
     class Aggregate
       def initialize(*indicators)
         @indicators = indicators
@@ -27,7 +43,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 +61,27 @@ module Popro
       end
     end
 
-    def self.default_formatter
+    class Callback
+      def initialize(finish = nil, &block)
+        @finish = finish
+        @callback = block
+      end
+
+      def call(*args)
+        @callback.call(*args)
+      end
+
+      def finish
+        @finish&.call
+      end
+    end
+
+    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 +90,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/progress.rb

@@ -9,21 +9,21 @@ module Popro
     DEFAULT_OPTIONS ||= {
       total: 0,
       current: 0,
+      indicator: Indicator.default
     }.freeze
 
     attr_reader :context
 
     def initialize(**options)
-      options.merge!(DEFAULT_OPTIONS)
-
       @started = false
 
-      @info = Info.new(total: options.delete(:total), current: options.delete(:current))
+      options = DEFAULT_OPTIONS
+                .merge(step: block_given? ? 0 : 1)
+                .merge(options)
 
-      options[:step] ||= (block_given? ? 0 : 1)
-      indicator = Indicator.default unless options.key? :indicator
+      @info = Info.new(total: options.delete(:total), current: options.delete(:current))
 
-      options.merge!(progress: self, info: @info, indicator: indicator)
+      options.merge!(progress: self, info: @info)
       @context = Context.new(**options)
 
       register_aliases
@@ -43,7 +43,7 @@ module Popro
 
     def register_aliases
       class << self
-        %i[each each_will to_proc did will formatter start done].each do |method_name|
+        %i[each each_will each_gonna to_proc gonna will did formatter start done].each do |method_name|
           define_method method_name do |*args, &block|
             @context.public_send(method_name, *args, &block)
           end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: popro
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.3
 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: []