infopark-user_io 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39d30f92b42ed2149337706f32322f71832689c3
-  data.tar.gz: f3eb6d817c52e53f46ba1dec4cc415567f8d338b
+  metadata.gz: a15ce6d28285af37873131efa6a552e1171dc387
+  data.tar.gz: 2a4db190e4f9006fe8243fd31c4708a63bbff4d4
 SHA512:
-  metadata.gz: 9c5da88e52369a968929f62c5c905c3e127d8cb61333563c98a1e44b59863f44010bee1627102ff5578f25995d29d7bc0cff79f9594d4b72d0baeb57f3f2983b
-  data.tar.gz: 99c9f21e6354bd58fec634460fedb79105f4c901ccbab5750bb71473fadf0685ff6b3310e807fafa921f5b916b8db88c943a59dc2b112be034e6ba89e8b12ff2
+  metadata.gz: f167e78f28d95e5926003ee9397717613bb24c0ecf8f1d5d52f0e49c64ea544d4b0861ab59f13b5144c63d4a1303d0bb0613cff7738067ff5918a22eea466afe
+  data.tar.gz: 5124a94caedb71bfd0404a3f352f6bc2b9d8513158426a6fa4aeae38a6d481d13f97d923f99f4997e6fbc4b5f3b49bdb1265670e519813e544aa704f5d573225

data/.gitignore

@@ -1,2 +1,3 @@
 /pkg
 /spec/examples.txt
+Gemfile.lock

data/lib/infopark/user_io/version.rb

@@ -1,5 +1,5 @@
 module Infopark
   class UserIO
-    VERSION = "0.2.1"
+    VERSION = "1.0.0"
   end
 end

data/lib/infopark/user_io.rb

@@ -16,30 +16,44 @@ class UserIO
     def initialize(label, user_io)
       @label = label
       @user_io = user_io
+      @spinner = "-\\|/"
     end
 
     def start
       unless @started
         user_io.tell("#{label} ", newline: false)
         @started = true
+        reset_spinner
       end
     end
 
     def increment
       raise ImplementationError, "progress not started yet" unless @started
       user_io.tell(".", newline: false)
+      reset_spinner
     end
 
     def finish
       if @started
         user_io.tell("… ", newline: false)
         user_io.tell("OK", color: :green, bright: true)
+        @started = false
       end
     end
 
+    def spin
+      raise ImplementationError, "progress not started yet" unless @started
+      user_io.tell("#{@spinner[@spin_pos % @spinner.size]}\b", newline: false)
+      @spin_pos += 1
+    end
+
     private
 
     attr_reader :label, :user_io
+
+    def reset_spinner
+      @spin_pos = 0
+    end
   end
 
   class << self

data/spec/progress_spec.rb

@@ -0,0 +1,157 @@
+module Infopark
+
+RSpec.describe UserIO::Progress do
+  COLOR_BRIGHT_GREEN = "\e[1;32m"
+  COLOR_NORMAL = "\e[22;39m"
+
+  let(:user_io) { UserIO.new }
+
+  subject(:progress) { UserIO::Progress.new("the label", user_io) }
+
+  before { allow($stdout).to receive(:write) }
+
+  describe "#start" do
+    subject(:start) { progress.start }
+
+    it "starts the progress" do
+      expect($stdout).to receive(:write).with("the label ")
+      start
+    end
+
+    context "if already started" do
+      before { progress.start }
+
+      it "does nothing" do
+        expect($stdout).to_not receive(:write)
+        start
+      end
+    end
+  end
+
+  describe "#increment" do
+    subject(:increment) { progress.increment }
+
+    context "on a started progress" do
+      before { progress.start }
+
+      it "increments" do
+        expect($stdout).to receive(:write).with(".")
+        increment
+      end
+    end
+
+    context "on a not started progress" do
+      it "fails" do
+        expect { increment }.to raise_error(/not started/)
+      end
+    end
+
+    context "on a finished progress" do
+      before do
+        progress.start
+        progress.finish
+      end
+
+      it "fails" do
+        expect { increment }.to raise_error(/not started/)
+      end
+    end
+  end
+
+  describe "#spin" do
+    subject(:spin) { progress.spin }
+
+
+    context "on a started progress" do
+      before { progress.start }
+
+      it "spins" do
+        expect($stdout).to receive(:write).with("-\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("\\\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("|\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("/\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("-\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("\\\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("|\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("/\b").ordered
+        progress.spin
+      end
+
+      it "starts spinning from begin when interrupted by an increment" do
+        expect($stdout).to receive(:write).with("-\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("\\\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with(".").ordered
+        progress.increment
+        expect($stdout).to receive(:write).with("-\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("\\\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("|\b").ordered
+        progress.spin
+        expect($stdout).to receive(:write).with("/\b").ordered
+        progress.spin
+      end
+    end
+
+    context "on a not started progress" do
+      it "fails" do
+        expect { spin }.to raise_error(/not started/)
+      end
+    end
+
+    context "on a finished progress" do
+      before do
+        progress.start
+        progress.finish
+      end
+
+      it "fails" do
+        expect { spin }.to raise_error(/not started/)
+      end
+    end
+  end
+
+  describe "#finish" do
+    subject(:finish) { progress.finish }
+
+    context "on a started progress" do
+      before { progress.start }
+
+      it "finishes" do
+        expect($stdout).to receive(:write).with("… ")
+        expect($stdout).to receive(:write).with("#{COLOR_BRIGHT_GREEN}OK#{COLOR_NORMAL}\n")
+        finish
+      end
+    end
+
+    context "on a not started progress" do
+      it "does nothing" do
+        expect($stdout).to_not receive(:write)
+        finish
+      end
+    end
+
+    context "on a finished progress" do
+      before do
+        progress.start
+        progress.finish
+      end
+
+      it "does nothing" do
+        expect($stdout).to_not receive(:write)
+        finish
+      end
+    end
+  end
+end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infopark-user_io
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Tilo Prütz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2018-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,7 @@ files:
 - lib/infopark/user_io.rb
 - lib/infopark/user_io/global.rb
 - lib/infopark/user_io/version.rb
+- spec/progress_spec.rb
 - spec/spec_helper.rb
 - spec/user_io/global_spec.rb
 - spec/user_io_spec.rb
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A utility lib to interact with the user on the command line.