bar-of-progress 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86e98d04262c8491ed88097371ecdd752c51c366
-  data.tar.gz: e19e795fc5a466a1cea901892b7d514d7e9556cf
+  metadata.gz: a00863ba7e6db13e1bbe7790910a334363a45926
+  data.tar.gz: e3797c6dc2e946614f8586ac517d6d2c45b28710
 SHA512:
-  metadata.gz: e68d1c2e0ddec2e343f2864cd4f6840d03ad5790b57c19df690913e5dbaec4e8fb817655e8dc474d29557dd1dbe19a15221993ed3a54e7493736c969c5f5387c
-  data.tar.gz: 025d5d3f511d4d0099dfb4517262a840c083f949b70e740224b8d4d589b20e70be9d04198495f2db288a3a1ca1734a512ff8ffc2210e14757570d87e4d7fc08b
+  metadata.gz: 2aa5d021eb62a147844782eb370cacede39cab87f902be562fbaa3e1c1df893d5027486ee8ee27f5d963149a53e42c698a20ca95b9034ad00e685e76a1432769
+  data.tar.gz: d99025534b7856ac55cff2e20cdee7bc7b5f8479194c5f94cd38cb27a2e3d9805bf2e655fb36084959c7da5816db2f4f9623f72247e643a0292cfe46dc4c430c

data/README.md

@@ -6,7 +6,7 @@ Everyone knows that progress bars are one of the hard, unsolved problems of comp
 
 ## API
 
-Boring, normal progress bars:
+### Default progress bars
 
 ``` ruby
 bar = BarOfProgress.new #=> defaults to completeness == "100"  
@@ -17,3 +17,20 @@ bar.progress(50) #=> "[●●●●●◌◌◌◌◌]"
 
 bar.progress(49) #=> "[●●●●◍◌◌◌◌◌]"
 ```
+
+### Custom progress bars
+
+``` ruby
+bar = BarOfProgress.new(
+  :total => 115.5,              #=> default (will be converted to BigDecimal): 100
+  :length => 14,                #=> default (will be converted to Fixnum): 10
+  :braces => %w{( )},           #=> default: ["[", "]"]
+  :complete_indicator => "■",   #=> default: "●"
+  :partial_indicator => "▤",    #=> default: "◍"
+  :incomplete_indicator => "□", #=> default: "◌"
+  :precision => 18              #=> default (determines what is considered 'partial'): 20
+)
+
+bar.progress(30) #=> "(■■■▤□□□□□□□□□□)"
+
+```

data/lib/bar-of-progress.rb

@@ -1,21 +1,38 @@
 require "bar_of_progress/version"
 
+require 'bigdecimal'
+require 'bigdecimal/util'
+
 class BarOfProgress
-  def initialize
-    @complete = 100.0
+  DEFAULTS = {
+    :total => 100,
+    :length => 10,
+    :braces => %w{[ ]},
+    :complete_indicator => "●",
+    :partial_indicator => "◍",
+    :incomplete_indicator => "◌",
+    :precision => 20
+  }
+
+  def initialize(options = {})
+    @options = DEFAULTS.merge(options)
+
+    #massage data because eww.
+    @options[:total] = @options[:total].to_d
+    @options[:length] = @options[:length].to_i
   end
 
   def progress(amount = 0)
-    bubbles = betwixt(((amount / @complete) * 10), 0, 10)
+    bubbles = clamp(((amount.to_d / @options[:total]) * @options[:length]), 0, @options[:length]).to_d
     full_bubbles = bubbles.floor
-    partial_bubbles = bubbles % 1 == 0 ? 0 : 1
-    "[#{chars('●', full_bubbles)}#{chars('◍', partial_bubbles)}#{chars('◌', (10 - full_bubbles - partial_bubbles))}]"
+    partial_bubbles = bubbles.truncate(@options[:precision]) % 1 == 0 ? 0 : 1
+    "#{@options[:braces][0]}#{chars(@options[:complete_indicator], full_bubbles)}#{chars(@options[:partial_indicator], partial_bubbles)}#{chars(@options[:incomplete_indicator], (@options[:length] - full_bubbles - partial_bubbles))}#{@options[:braces][1]}"
   end
 
 private
 
   # This method is amazing.
-  def betwixt(n, min, max)
+  def clamp(n, min, max)
     [[n, min].max, max].min
   end
 

data/lib/bar_of_progress/version.rb

@@ -1,3 +1,3 @@
 class BarOfProgress
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/lib/bar_of_progress_spec.rb

@@ -12,4 +12,20 @@ describe BarOfProgress do
     Then { subject.progress(100) == "[●●●●●●●●●●]" }
     Then { subject.progress(101) == "[●●●●●●●●●●]" }
   end
+
+  context "awesome bejazzled custom progress bar" do
+    subject { BarOfProgress.new(
+      :total => 115.5,
+      :length => 14,
+      :braces => %w{( )},
+      :complete_indicator => "■",
+      :partial_indicator => "▤",
+      :incomplete_indicator => "□"
+    ) }
+
+    Then { subject.progress == "(□□□□□□□□□□□□□□)" }
+    Then { subject.progress(30) == "(■■■▤□□□□□□□□□□)" }
+    Then { subject.progress(33) == "(■■■■□□□□□□□□□□)" }
+    Then { subject.progress(115.5) == "(■■■■■■■■■■■■■■)" }
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bar-of-progress
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Justin Searls