popro 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a790befdf497a693172bb0faf40561c1d7fd6e287a3b5c379f7ddd9496f33509
-  data.tar.gz: a015de37abef0c5769a5d786182319fb891e874124daa5503a7feb9b411438fe
+  metadata.gz: fc8a91c38e9a66e7b5de492fe92f5def2d044fc118a3dfc25ef826ccadc8692c
+  data.tar.gz: 00fc035091657744a3bc7110b91f1cfb49192d07afce1a0866e20745b038c368
 SHA512:
-  metadata.gz: 0a2b3c066fe0a666537e40a2d63b81442e463c4b421a29d67722ad364453695fe17ea247a66c8d2e695e389b1482b56788dc03efff8836821a63f61d0592a5dd
-  data.tar.gz: 87151aae4f7c3ac0650960e5fdf646d4a373742dec759e3872fb8ea3be96c5b64b585401e6b6897c57ed7c86ed23987f1d33f426ffafbabf8e50558348046d3f
+  metadata.gz: f0c02a15ce252052573de441631e8665f8c2fde13e27162287a01739df908283514f8fa0eb98056e179c2d6ac139aac89bb4a603abd45ae1d9333d960f2de5e4
+  data.tar.gz: 989554d6b7dcf42c8db7a0a1b240b440acf07fd1b965e861486361fe7627fe4c65d37ae8df951daeae37445d689239397613a34f1e6231d11e5addbccdaf586a

data/CHANGELOG

@@ -1,3 +1,4 @@
+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

data/lib/popro.rb

@@ -7,6 +7,8 @@ module Popro
 
   require_relative 'popro/progress'
 
+  @_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)
 
@@ -26,6 +28,17 @@ module Popro
     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,15 +41,15 @@ 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
 
@@ -57,20 +59,21 @@ module Popro
       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)
-      @indicator.call(@info, 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) if block_given?
+        block.call(*args, progress: @info)
       end
     end
 
@@ -91,6 +94,12 @@ 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 got #{total.class}" unless total.is_a?(Integer) || total.nil?

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: popro
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - MikeSmithEU