spin_to_win 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4728b0bd3d8e135d747b274a2d40663869bb75d0
-  data.tar.gz: 80629e5dbac4d58bb5774561ff1a5752ee83a76b
+  metadata.gz: 7b84f4987c35b23cc49413617bdf1043c94498b3
+  data.tar.gz: e65cebf46ab31258ffe4ff7f1c7bf99487c9a6ba
 SHA512:
-  metadata.gz: 7b482c290ec777e4f8a1808bf776cceca1c8c2ee7b39f1523c65f425c490ca063ab160d11c6aad845d36d5d199a0735cc10587e364142b3070420f4759a58c67
-  data.tar.gz: 751c8e491815a5249be4135e46445b3afb1962681e5d9e6cd468cdef8885d2924184a5af161980a26eaab45275b6d0e08eb95927acb5b5fb9b67772150fbb1ef
+  metadata.gz: 10b6315dd2a62e925a2d0be6c4c8da9c344fcd0eb71efa4d365efa586b2b0b2cbcfc3e3cef229aa77c70ed122fbc28372e0c1f558a40006c29349d5f00901a6e
+  data.tar.gz: 40335c0824f51195f50e5aedf7b405493a51310d6ee3db2de606558d25cfb2bf9a487a2b3d2f929a193e62073f0ff52a18d747ab175bee6f5707f8a3fe2c303b

data/README.md

@@ -3,23 +3,23 @@
 Simple ruby spinner that allows on the fly notifications in the format of:
 
     :title :spinner :finished of :todo [:banner]
-    
-The bare bones spinner is 
 
-    SpinToWin.with_spinner { sleep 1 } 
-    
+The bare bones spinner is
+
+    SpinToWin.with_spinner { sleep 1 }
+
     \
 
-With a title is 
+With a title is
 
     SpinToWin.with_spinner('Zzzz') { sleep 1 }`
-    
+
     Zzzz \
 
 With a title and banner:
 
     SpinToWin.with_spinner('Zzzz') { |spinner| spinner.banner('sleepy'); sleep 1 }
-    
+
     Zzzz \ [sleepy]
 
 The title is persistent but the banner can be changed with calls to the yielded `spinner`
@@ -28,22 +28,54 @@ With title, banner, and todos
 
     SpinToWin.with_spinner('Zzzz') do |spinner|
         spinner.increment_todo!(3)
-        
+
         spinner.banner('snore')
         sleep 1
         spinner.increment_done!
-        
+
         spinner.banner('dream')
         sleep 1
         spinner.increment_done!
-        
+
         spinner.banner('wake up!')
         sleep 1
         spinner.increment_done!
     end
-    
+
     Zzzz \ 3 of 3 [wake up!]
 
+## Threads
+
+Spin to Win is built using [Celluloid](https://github.com/celluloid/celluloid) and was designed to be used by multiple threads.
+
+   SpinToWin.with_spinner('Dreaming about:') do |spinner|
+    futures = [
+      Celluloid::Future.new do
+        SpinToWin.add_banner('ham')
+        sleep 1
+        SpinToWin.increment_done!
+        SpinToWin.remove_banner('ham')
+      end,
+      Celluloid::Future.new do
+        SpinToWin.add_banner('sheep')
+        sleep 2
+        SpinToWin.increment_done!
+        SpinToWin.remove_banner('sheep')
+      end,
+      Celluloid::Future.new do
+        SpinToWin.add_banner('socks')
+        sleep 3
+        SpinToWin.increment_done!
+        SpinToWin.remove_banner('sock')
+      end
+    ]
+    SpinToWin.increment_todo!(futures.size)
+
+    futures.each { |f| f.value }
+   end
+
+Dreaming about: \ 0 of 3 [ham|sheep|socks]
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -61,7 +93,7 @@ Or install it yourself as:
     $ gem install spin_to_win
 
 ## Usage
-    
+
     Fancy Demo \ 1 of 3 [step 1]
 
 ## Development

data/lib/spin_to_win.rb

@@ -5,12 +5,12 @@ require 'spin_to_win/spinner'
 # Spinner
 module SpinToWin
   class << self
-    def increment_todo!
-      Celluloid::Notifications.notifier.publish('spinner_increment_todo')
+    def increment_todo!(count = 1)
+      Celluloid::Notifications.notifier.publish('spinner_increment_todo', count)
     end
 
-    def increment_done!
-      Celluloid::Notifications.notifier.publish('spinner_increment_done')
+    def increment_done!(count = 1)
+      Celluloid::Notifications.notifier.publish('spinner_increment_done', count)
     end
 
     def complete!
@@ -25,6 +25,10 @@ module SpinToWin
       Celluloid::Notifications.notifier.publish('spinner_set_banner', msg)
     end
 
+    def add_banner(msg)
+      Celluloid::Notifications.notifier.publish('spinner_add_banner', msg)
+    end
+
     def remove_banner(msg)
       Celluloid::Notifications.notifier.publish('spinner_remove_banner', msg)
     end

data/lib/spin_to_win/spinner.rb

@@ -93,14 +93,12 @@ module SpinToWin
       @banner_queue = [banner]
     end
 
-    private
-
-    def on_increment_todo(*_args)
-      increment_todo!
+    def on_increment_todo(*args)
+      increment_todo!(args[1] || 1)
     end
 
-    def on_increment_done(*_args)
-      increment_done!
+    def on_increment_done(*args)
+      increment_done!(args[1] || 1)
     end
 
     def on_output(*args)
@@ -123,6 +121,8 @@ module SpinToWin
       complete!
     end
 
+    private
+
     def init_spinner
       @run = true
       @todo_count = @done_count = 0

data/lib/spin_to_win/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module SpinToWin
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spin_to_win
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Michael Guymon