popro 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce1a842c500f314f3ed8ba0e7e9deb5a4ece7cbf81ea11563664336cf35ddcd1
-  data.tar.gz: 3d313f96ff1b5dda33e51ec994ee592447e957201ebf059b86caef3d0d830c53
+  metadata.gz: c0ed84ff76f7db2ab74b649ef29f62dab630f3b12dc0e2a8cf011382814d9396
+  data.tar.gz: ff292d589ecdfd671fe1136079611bc45ccbec5c262c2b831baef59799732de9
 SHA512:
-  metadata.gz: d68080c7a53d74a50e15fdb252f7aacbc57616a9de4aeb12bff133f715c347f07cdb6c9e2643d769a48babf01c6eb127e9e2dd6bdcd3d028d460efda34068d3b
-  data.tar.gz: f699ce90d06692c3ccfa71a342e1eceda39456c0599891c535f024ff0b64cec5eb8c8a56d5d91f83d96f300d5009c8098a7f73cdcb62ccf778fbc0a7feb0b96b
+  metadata.gz: 810c7e4925421c86e3585d429a948f50de6ea913042b9c3edc6d13a63557286e9ca83f2d6c973700388d5934aff9097071b78db7c6b0c3eb162e6fba6666e566
+  data.tar.gz: ffab387b8fbed5b19e88d58d97a3001cff0f7855b9154754acd114c6bdd53bb846085d47fb04f7ed7c3a3972315f400a71dbbb6e28519a45b30243df39180f4a

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/progress.rb

@@ -6,17 +6,24 @@ module Popro
     require_relative 'info'
     require_relative 'indicator'
 
+    DEFAULT_OPTIONS ||= {
+      total: 0,
+      current: 0,
+    }.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[:step] ||= (block_given? ? 0 : 1)
-      options[:progress] = self
-      options[:info] = @info
-      options[:indicator] = Indicator.default unless options.key? :indicator
+      indicator = Indicator.default unless options.key? :indicator
 
+      options.merge!(progress: self, info: @info, indicator: indicator)
       @context = Context.new(**options)
 
       register_aliases
@@ -26,6 +33,12 @@ module Popro
       done
     end
 
+    # increase the total
+    def add(amount)
+      @info.total += amount
+      self
+    end
+
     private
 
     def register_aliases
@@ -35,6 +48,12 @@ module Popro
             @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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: popro
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - MikeSmithEU