cli_spinnable 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b57d77c25a5bb808706cb92487a5877fa2c32121
-  data.tar.gz: f59c00a22d6b5958b6a2183f10fbd6a1728ffa11
+  metadata.gz: bb9427d5e29feac4435264fc98494a1ec200a5f8
+  data.tar.gz: 88d98f350933a6fe8f4fc9e5e1e27f8090af2e41
 SHA512:
-  metadata.gz: 64cd82f07433483e87807de0268ceec2cb175f129b5adacad2d4bea007c09b8d4c72230b0434d312361db7de0a5bd2085337e1d8a496a5d3d454b78080bb03d8
-  data.tar.gz: 0b77ed47dde390e9977b9549c9ee200eb9b7a2c4c924e698366e36ccb07943437e2103fe12d236cd0421d095901eefb7cb1a6c7681a6ec53404e7e84c0565cf6
+  metadata.gz: c190c8978e80063e623dafa4d5113af7f094ee5a28d40f31ff95299f54cfe4efbe23289c52694c2b841d457107a3be81d224ff5c3cdd51dcfb329eb13b245bb3
+  data.tar.gz: 4354df4d30830b93081820d8c07acd8fc228326995750d7628b4509f9d264870a1ec4abd546d137a81bf7a683fb836ccbe0d7ff985c67428d7c012ccfb4c8825

data/examples/example1.rb

@@ -1,34 +1,40 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
+## This example shows different ways of accessing the `.with_spinner` method.
+
 require 'cli_spinnable'
 
-class Foo
+# 1. Use `CliSpinnable.with_spinner` directly.
+CliSpinnable.with_spinner do |cli|
+  cli.print 'Downloading something'
+  sleep 1
+  cli.tick
+end
+
+# 2. Create own module and extend it with CliSpinnable.
+#    This way you will have own namespace for `.with_spinner` method.
+module Foo
+  extend CliSpinnable
+end
+
+Foo.with_spinner do |cli|
+  cli.print 'Downloading something'
+  sleep 1
+  cli.tick
+end
+
+# 3. Include CliSpinnable module in own class.
+#    This way you can access `with_spinner` method within that class.
+class Bar
   include CliSpinnable
 
   def call
-    puts 'HAPPY RUN (ending with success):'
     with_spinner do |cli|
       cli.print 'Downloading something'
       sleep 1
-      cli.print '...downloaded 1MB'
-      cli.tick
-      cli.print 'Processing data'
-      sleep 1
-      cli.tick
-    end
-
-    puts 'SAD RUN (ending with fail):'
-    with_spinner do |cli|
-      cli.print 'Downloading something'
-      sleep 1
-      cli.print '...downloaded 1MB'
-      cli.tick
-      cli.print 'Processing data'
-      sleep 1
-      1 / 0
       cli.tick
     end
   end
 end
 
-Foo.new.call
+Bar.new.call

data/examples/example2.rb

@@ -2,12 +2,12 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'cli_spinnable'
 
-module Foo
+module Cli
   extend CliSpinnable
 end
 
-puts 'HAPPY RUN (ending with success):'
-Foo.with_spinner do |cli|
+puts 'HAPPY RUN (should succeed):'
+Cli.with_spinner do |cli|
   cli.print 'Downloading something'
   sleep 1
   cli.print '...downloaded 1MB'
@@ -17,14 +17,14 @@ Foo.with_spinner do |cli|
   cli.tick
 end
 
-puts 'SAD RUN (ending with fail):'
-Foo.with_spinner do |cli|
+puts 'SAD RUN (should fail):'
+Cli.with_spinner do |cli|
   cli.print 'Downloading something'
   sleep 1
   cli.print '...downloaded 1MB'
   cli.tick
   cli.print 'Processing data'
   sleep 1
-  1 / 0
-  cli.tick
+  1 / 0    # produces exception
+  cli.tick # this will not be reached
 end

data/examples/example3.rb

@@ -2,27 +2,38 @@ $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'cli_spinnable'
 
-include CliSpinnable
+module Cli
+  extend CliSpinnable
+end
+
+# Close the block before reading from input.
 
-puts 'HAPPY RUN (ending with success):'
-with_spinner do |cli|
+# Good:
+Cli.with_spinner do |cli|
   cli.print 'Downloading something'
   sleep 1
-  cli.print '...downloaded 1MB'
   cli.tick
-  cli.print 'Processing data'
+end
+
+print 'Enter name: '
+name = gets.chomp
+
+Cli.with_spinner do |cli|
+  cli.print "Doing something with name #{name}"
   sleep 1
   cli.tick
 end
 
-puts 'SAD RUN (ending with fail):'
-with_spinner do |cli|
+# Bad:
+Cli.with_spinner do |cli|
   cli.print 'Downloading something'
   sleep 1
-  cli.print '...downloaded 1MB'
   cli.tick
-  cli.print 'Processing data'
+
+  print 'Enter name: '
+  name = gets.chomp
+
+  cli.print "Doing something with name #{name}"
   sleep 1
-  1 / 0
   cli.tick
 end

data/examples/example4.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'cli_spinnable'
+
+module Cli
+  extend CliSpinnable
+end
+
+# Don't print multiline strings inside `with_spinner` block.
+
+# Good:
+Cli.with_spinner do |cli|
+  cli.print 'Downloading something'
+  sleep 1
+  cli.tick
+end
+
+print "Multiline\nstring"
+
+# Bad:
+Cli.with_spinner do |cli|
+  cli.print 'Downloading something'
+  sleep 1
+  cli.tick
+  print "Multiline\nstring"
+end
+s
+# Bad:
+
+Cli.with_spinner do |cli|
+  cli.print 'Downloading something'
+  sleep 1
+  cli.tick
+  cli.print "Multiline\nstring"
+end

data/lib/cli_spinnable.rb

@@ -6,16 +6,24 @@ require 'cli_spinnable/line'
 require 'cli_spinnable/writer'
 
 module CliSpinnable
-  def with_spinner
-    writer = Writer.new(STDOUT, Line.new)
-    yield writer
-    writer.finalize
-    self
-  rescue CliSpinnableError => e
-    raise e
-  rescue StandardError => e
-    writer.failure
-    writer.finalize
-    raise e
+  module Methods
+    def with_spinner
+      writer = Writer.new(STDOUT, Line.new)
+      yield writer
+      writer.finalize
+      self
+    rescue CliSpinnableError => e
+      raise e
+    rescue StandardError => e
+      writer.failure
+      writer.finalize
+      raise e
+    end
+  end
+
+  include Methods
+
+  class << self
+    include Methods
   end
 end

data/lib/cli_spinnable/version.rb

@@ -1,3 +1,3 @@
 module CliSpinnable
-  VERSION = '0.1'.freeze
+  VERSION = '0.2'.freeze
 end

data/lib/cli_spinnable/writer.rb

@@ -27,12 +27,12 @@ module CliSpinnable
     def failure
       push(:sign=, :fail)
       push(:newline=, true)
+      push(:str=, '')
       self
     end
 
     def finalize
       push(:sign=, :blank)
-      push(:str=, '')
       finalize_session
       self
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli_spinnable
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Krzysztof Maicher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-17 00:00:00.000000000 Z
+date: 2016-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,7 @@ files:
 - examples/example1.rb
 - examples/example2.rb
 - examples/example3.rb
+- examples/example4.rb
 - lib/cli_spinnable.rb
 - lib/cli_spinnable/cli_spinnable_error.rb
 - lib/cli_spinnable/line.rb
@@ -159,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: CliSpinnable, a module that enriches ruby command line interface with rotating