spin_to_win 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96f8ff8cb310c0730e9667869904c3d3827a6d48
-  data.tar.gz: 46d7c9f2e1d52b8a508637278c8a67cb7b1f3305
+  metadata.gz: 4728b0bd3d8e135d747b274a2d40663869bb75d0
+  data.tar.gz: 80629e5dbac4d58bb5774561ff1a5752ee83a76b
 SHA512:
-  metadata.gz: dc02d9e6f7aff1f7c4faca22a690d51704a7e03d0be356abd5b999d31ea35e15ba3bb9f92ce14c38afbdee632d1fa556e49bbb94aaa568e0b80962280a874fba
-  data.tar.gz: 2b11c28e70f7753932955e3d63792221cbbe68f2ceab3880375672e36f1aa5d1080623f99b6b026e4e58bbd403600f426dcf852b13f520f91441b095ed881f68
+  metadata.gz: 7b482c290ec777e4f8a1808bf776cceca1c8c2ee7b39f1523c65f425c490ca063ab160d11c6aad845d36d5d199a0735cc10587e364142b3070420f4759a58c67
+  data.tar.gz: 751c8e491815a5249be4135e46445b3afb1962681e5d9e6cd468cdef8885d2924184a5af161980a26eaab45275b6d0e08eb95927acb5b5fb9b67772150fbb1ef

data/README.md

@@ -3,6 +3,46 @@
 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 } 
+    
+    \
+
+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`
+
+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!]
 
 ## Installation
 
@@ -21,15 +61,6 @@ Or install it yourself as:
     $ gem install spin_to_win
 
 ## Usage
-
-![](https://raw.githubusercontent.com/mguymon/spin_to_win/master/examples/demo.gif)
-
-    SpinToWin.with_spinner('Fancy Demo') do |spinner|
-      spinner.banner 'step 1'
-      sleep 1
-      spinner.banner 'step 2'
-      sleep 1
-    end
     
     Fancy Demo \ 1 of 3 [step 1]
 

data/lib/spin_to_win/spinner.rb

@@ -9,12 +9,22 @@ module SpinToWin
     include Celluloid
     include Celluloid::Notifications
 
-    SPIN_CHARS = %w(| / - \\).freeze
+    LINE_CHARS = %w(| / - \\).freeze
+    BRAILLE_CHARS = %w(⣾ ⣽ ⣻ ⢿ ⡿ ⣟ ⣯ ⣷).freeze
+    BAR_CHARS = %w(┤ ┘ ┴ └ ├ ┌ ┬ ┐).freeze
+    CIRCLE_CHAR = %w(◐ ◓ ◑ ◒).freeze
+
+    SPIN_CHARSET = {
+      line: LINE_CHARS,
+      braille: BRAILLE_CHARS,
+      bar: BAR_CHARS,
+      circle: CIRCLE_CHAR
+    }.freeze
 
     class << self
       # rubocop:disable UnusedMethodArgument
-      def with_spinner(title = nil, &blk)
-        spinner = Spinner.new(title)
+      def with_spinner(title = nil, charset: :line, &blk)
+        spinner = Spinner.new(title, charset: charset)
         the_spin = spinner.future.spin
         result = yield(spinner)
         spinner.complete!
@@ -26,8 +36,9 @@ module SpinToWin
       # rubocop:enable UnusedMethodArgument
     end
 
-    def initialize(title = nil)
+    def initialize(title = nil, charset: :line)
       @title = title
+      @charset = SPIN_CHARSET[charset.to_sym]
 
       subscribe('spinner_increment_todo', :on_increment_todo)
       subscribe('spinner_increment_done', :on_increment_done)
@@ -40,7 +51,7 @@ module SpinToWin
 
     def spin(fps = 12)
       delay = 1.0 / fps
-      iter = previous_msg_size = 0
+      iteration = previous_msg_size = 0
 
       init_spinner
 
@@ -48,7 +59,7 @@ module SpinToWin
       while @run
         output_log
 
-        msg = build_message(iter += 1)
+        msg = build_message(iteration += 1)
         previous_msg_size = print_message(msg, previous_msg_size, delay)
       end
 
@@ -56,18 +67,18 @@ module SpinToWin
         puts "WARNING: spinner completed with pending jobs #{@done_count} of #{@todo_count}"
       end
 
-      $stderr.print build_message(iter)
+      $stderr.print build_message(iteration)
       $stderr.puts ''
 
-      iter
+      iteration
     end
 
-    def increment_todo!
-      @todo_count += 1
+    def increment_todo!(count = 1)
+      @todo_count += count
     end
 
-    def increment_done!
-      @done_count += 1
+    def increment_done!(count = 1)
+      @done_count += count
     end
 
     def complete!
@@ -126,7 +137,7 @@ module SpinToWin
     end
 
     def build_message(position)
-      msg = "#{@title} #{SPIN_CHARS[position % SPIN_CHARS.length]}"
+      msg = "#{@title} #{@charset[position % @charset.length]}"
       msg << " #{@done_count} of #{@todo_count}" if @todo_count > 0
       msg << " [#{@banner_queue.join('|')}]" unless @banner_queue.empty?
       msg

data/lib/spin_to_win/version.rb

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

data/lib/spin_to_win.rb

@@ -29,8 +29,8 @@ module SpinToWin
       Celluloid::Notifications.notifier.publish('spinner_remove_banner', msg)
     end
 
-    def with_spinner(title = nil, &blk)
-      SpinToWin::Spinner.with_spinner(title, &blk)
+    def with_spinner(title = nil, charset: :line, &blk)
+      SpinToWin::Spinner.with_spinner(title, charset: charset, &blk)
     end
   end
 end

data/spin_to_win.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'celluloid'
+  spec.add_dependency 'celluloid', '~> 0.17'
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "pry"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spin_to_win
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Guymon
@@ -14,16 +14,16 @@ dependencies:
   name: celluloid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement