popro 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e8aecacb06e0bfe98467ac74b74f0b5e90ddc65f57069ae4bf29bdc7073b8a
-  data.tar.gz: 6a220ecf6de03a768aeed0d4998983ada21d037859a9deafe6263b4604b201d7
+  metadata.gz: ce1a842c500f314f3ed8ba0e7e9deb5a4ece7cbf81ea11563664336cf35ddcd1
+  data.tar.gz: 3d313f96ff1b5dda33e51ec994ee592447e957201ebf059b86caef3d0d830c53
 SHA512:
-  metadata.gz: cb458d4d2a5169342ede984048be23c86d101db7546585e408e7470fe799f3344df4d2c691e42e43ff5ddd915e9af284a44ae59a7780890b06340a70a5e56419
-  data.tar.gz: 6a8fc7aef7feec2b0c39af0f1478f1cebaf4ccb8667edcc0842d119019dec709998e2d0a3930869646b51a210f4758eaa2b721894b7a1b79d554f44294996ce3
+  metadata.gz: d68080c7a53d74a50e15fdb252f7aacbc57616a9de4aeb12bff133f715c347f07cdb6c9e2643d769a48babf01c6eb127e9e2dd6bdcd3d028d460efda34068d3b
+  data.tar.gz: f699ce90d06692c3ccfa71a342e1eceda39456c0599891c535f024ff0b64cec5eb8c8a56d5d91f83d96f300d5009c8098a7f73cdcb62ccf778fbc0a7feb0b96b

data/lib/popro.rb

@@ -14,15 +14,13 @@ module Popro
     Progress.new(**options, &block)
   end
 
-  def self.each(obj, _total = nil, **options, &block)
+  def self.each(obj, total = nil, **options, &block)
+    options[:step] = 0 unless options.key? :step
     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') 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') 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/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

@@ -30,7 +30,7 @@ module Popro
 
     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

metadata

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