spinning_cursor 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6ef985becc5baa16055d3a0b4bb79ebabb96df36
+  data.tar.gz: ef9ca743d415c3d8ccf4c26ae23016ea27a9b534
+SHA512:
+  metadata.gz: 143c9030a8c4efebe615bc6872544af7a77a00fc314331999dc9ea91e5f6a521a853b3ea3c150ad52178081eb6fec62e7ec65f83e7cc5a47e6555d4c27c4c434
+  data.tar.gz: a8338b406d6f8febc5d024aaf9bfa272e0415819daadce7ef7b4883a4f86b04afe7789466a5fcc34b1b99fe4f40ccf74f54bfaaceabe840bcb474041e4f28e37

data/CHANGELOG

@@ -1,6 +1,10 @@
 CHANGELOG
 ===============================================================================
 
+v0.3.0 (2013-10-28)
+  - API changes (SpinningCursor#setup method and SpinningCursor#start renamed to SpinningCursor#run) #29
+  - Type validation of options - throws exception if validation fails #28
+
 v0.2.1 (2013-07-28)
   - Fix banner overflowing issue #19
   - Ensure cross-platform support #22 #23

data/README.md

@@ -29,7 +29,7 @@ _It's so simple it hurts!_
 ```ruby
 require 'spinning_cursor' # you'll definitely need this bit
 
-SpinningCursor.start do
+SpinningCursor.run do
   banner "An amazing task is happening"
   type :spinner
   action do
@@ -76,7 +76,7 @@ The first option is the simplest, but the second isn't so bad either.
 It's pretty simple, just do:
 
 ```ruby
-SpinningCursor.start do
+SpinningCursor.run do
   banner "Loading"
   type :dots
   message "Done"
@@ -88,7 +88,7 @@ sleep 20
 SpinningCursor.stop
 ```
 
-**Notice** the absence of the `action` option. The start method will only keep
+**Notice** the absence of the `action` option. The run method will only keep
 the cursor running if an `action` block isn't passed to it.
 
 ### I want to be able to change the finish message conditionally!
@@ -98,7 +98,7 @@ Do you? Well that's easy too (I'm starting to see a pattern here...)!
 Use the `set_message` method to change the message during the execution:
 
 ```ruby
-SpinningCursor.start do
+SpinningCursor.run do
   banner "Calculating your favour colour, please wait"
   type :dots
   action do
@@ -123,7 +123,7 @@ the banner message in the same way you would the finish message, using
 `set_banner`:
 
 ```ruby
-SpinningCursor.start do
+SpinningCursor.run do
   banner "Stealing your food"
   action do
     sleep 10

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/spinning_cursor.rb

@@ -8,20 +8,30 @@ module SpinningCursor
   include self::ConsoleHelpers
   extend  self::ConsoleHelpers
 
+  def setup(&block)
+    @parsed = Parser.new(&block)
+    @cursor = Cursor.new(@parsed)
+    @setup = true
+    self
+  end
+
+  def setup?
+    @setup
+  end
+
   #
   # Sends passed block to Parser, and starts cursor thread
   # It will execute the action block and kill the cursor
   # thread if an action block is passed.
   #
   def start(&block)
+    setup(&block) if block or not setup?
     stop if alive?
 
     save_stdout_sync_status
     capture_console
     hide_cursor
 
-    @parsed = Parser.new(&block)
-    @cursor = Cursor.new(@parsed)
     @spinner = Thread.new do
       abort_on_exception = true
       @cursor.spin
@@ -47,6 +57,8 @@ module SpinningCursor
     end
   end
 
+  alias run start
+
   #
   # Kills the cursor thread and prints the finished message
   # Returns execution time
@@ -72,6 +84,7 @@ module SpinningCursor
       # Set parsed to nil so set_message method only works
       # when cursor is actually running.
       @parsed = nil
+      @setup = false
 
       # Return execution time
       @stop_watch.stop

data/lib/spinning_cursor/parser.rb

@@ -15,7 +15,11 @@ module SpinningCursor
 
       if block_given?
         @outer_scope_object = eval("self", block.binding)
-        instance_eval &block
+        if block.arity == 1
+          yield self
+        else
+          instance_eval &block
+        end
       end
     end
 
@@ -40,11 +44,30 @@ module SpinningCursor
     #   For setting, use method with arguments
     #   e.g. `banner "my banner"`
     #
-    %w[banner type message delay output].each do |method|
+
+    methods_and_validations = {
+      :type    => Proc.new { |arg|
+        inst_methods = SpinningCursor::Cursor.public_instance_methods |
+                       SpinningCursor::Cursor.private_instance_methods |
+                       SpinningCursor::Cursor.protected_instance_methods
+        (inst_methods & [ arg, arg.to_s ]).empty? ? false : arg },
+      :delay   => Proc.new { |arg| arg.is_a?(Numeric) ? arg.to_f : false},
+      :output  => Proc.new { |arg| [:inline, :at_stop].include?(arg) ? arg : false},
+      :banner  => Proc.new { |arg| arg.respond_to?(:to_s) ? arg.to_s : false},
+      :message => Proc.new { |arg| arg.respond_to?(:to_s) ? arg.to_s : false},
+    }
+
+    methods_and_validations.each do |method, validation|
       define_method(method) do |*args|
         var = "@#{method}"
-        return instance_variable_get(var) unless args.first
-        instance_variable_set(var, args.first)
+        arg = args.first
+        if arg
+          valid_arg = validation.call(arg)
+          raise ArgumentError unless valid_arg
+          instance_variable_set(var, valid_arg)
+        else
+          instance_variable_get(var)
+        end
       end
     end
 

data/spinning_cursor.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "spinning_cursor"
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adnan Abdulhussein"]
-  s.date = "2013-07-28"
+  s.date = "2013-10-28"
   s.description = "Spinning Cursor is a flexible DSL that allows you to easily produce a customizable waiting/loading message for your Ruby command line program. Beautifully keep your users informed with what your program is doing when a more complex solution, such as a progress bar, doesn't fit your needs."
   s.email = "adnan@prydoni.us"
   s.extra_rdoc_files = [
@@ -43,11 +43,11 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/Prydonius/spinning_cursor"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
+  s.rubygems_version = "2.0.3"
   s.summary = "A DSL for adding animated loaders to your Ruby command line application."
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<highline>, ["~> 1.6.19"])

data/test/test_cursors.rb

@@ -8,7 +8,7 @@ class TestSpinningCursorCursor < Test::Unit::TestCase
     should "not clear lines above if it fits within the width of the shell" do
       # general case
       capture_stdout do |out|
-        SpinningCursor.start do
+        SpinningCursor.run do
           banner (1..cols-20).map { ('a'..'z').to_a[rand(26)] }.join
           action { sleep 0.1 }
         end
@@ -18,7 +18,7 @@ class TestSpinningCursorCursor < Test::Unit::TestCase
 
     should "not clear lines above if it fits exactly on the line (edge case)" do
       capture_stdout do |out|
-        SpinningCursor.start do
+        SpinningCursor.run do
           # spinner type takes up two characters, so minus 2 to fit exactly
           banner (1..cols-2).map { ('a'..'z').to_a[rand(26)] }.join
           action { sleep 0.1 }
@@ -29,7 +29,7 @@ class TestSpinningCursorCursor < Test::Unit::TestCase
 
     should "clear lines above if banner message overflows" do
       capture_stdout do |out|
-        SpinningCursor.start do
+        SpinningCursor.run do
           # spinner type takes up two characters, so minus 2 to fit exactly
           banner (1..400).map { ('a'..'z').to_a[rand(26)] }.join
           action { sleep 0.1 }
@@ -40,7 +40,7 @@ class TestSpinningCursorCursor < Test::Unit::TestCase
 
     should "clear lines above if banner message overflows (edge case)" do
       capture_stdout do |out|
-        SpinningCursor.start do
+        SpinningCursor.run do
           # spinner type takes up two characters, so minus 2 to fit exactly
           banner (1..cols-1).map { ('a'..'z').to_a[rand(26)] }.join
           action { sleep 0.1 }

data/test/test_parser.rb

@@ -75,4 +75,92 @@ class TestSpinningCursorParser < Test::Unit::TestCase
       assert_equal proc, @parser.action
     end
   end
+
+  context "SpinningCursor#run" do
+    context "with a block with 1 parameter (arity 1)" do
+      setup do
+        $outer_context = self
+        capture_stdout do |out|
+          SpinningCursor.run do |param|
+            $inner_context = self
+            $yielded_param = param
+          end
+        end
+      end
+
+      should "yield the Parser as parameter" do
+        assert_equal Parser, $yielded_param.class
+      end
+
+      should "outer context be available (outer self = inner self)" do
+        assert_equal $inner_context.object_id, $outer_context.object_id
+      end
+    end
+
+    context "with a block without parameters (arity 0)" do
+      setup do
+        $outer_context = self
+        capture_stdout do |out|
+          SpinningCursor.run do
+            $inner_context = self
+          end
+        end
+      end
+
+      should "instance_eval the block on Parser context" do
+        assert_equal Parser, $inner_context.class
+      end
+
+      should "outer context NOT be available (outer self != inner self)" do
+        assert_not_equal $outer_context.object_id, $inner_context.object_id
+      end
+
+    end
+  end
+
+  context "SpinningCursor::Parser method" do
+    context "'type'" do
+      should "raise ArgumentError if argument IS NOT a SpinningCursor::Cursor instance_method" do
+        assert_raise(ArgumentError) { SpinningCursor::Parser.new.type :fake_method }
+      end
+      should "NOT raise anything if argument IS a SpinningCursor::Cursor instance_method" do
+        assert_nothing_raised { SpinningCursor::Parser.new.type :dots }
+      end
+    end
+    context "'delay'" do
+      should "raise ArgumentError if argument IS NOT a Numeric" do
+        assert_raise(ArgumentError) { SpinningCursor::Parser.new.delay "Not a number" }
+      end
+      should "NOT raise anything if argument IS a Numeric" do
+        assert_nothing_raised { SpinningCursor::Parser.new.delay 10 }
+      end
+    end
+    context "'output'" do
+      should "raise ArgumentError if argument IS NOT :inline or :at_stop" do
+        assert_raise(ArgumentError) { SpinningCursor::Parser.new.output :not_inline_nor_at_stop }
+      end
+      should "NOT raise anything if argument IS :inline or :at_stop" do
+        assert_nothing_raised { SpinningCursor::Parser.new.output :inline }
+        assert_nothing_raised { SpinningCursor::Parser.new.output :at_stop }
+      end
+    end
+    context "'banner' and 'message'" do
+      class LackingToSClass
+        undef :to_s
+      end
+
+      should "raise ArgumentError if argument IS NOT a String nor respond_to :to_s (:banner)" do
+        assert_raise(ArgumentError) { SpinningCursor::Parser.new.banner LackingToSClass.new }
+      end
+      should "raise ArgumentError if argument IS NOT a String nor respond_to :to_s (:message)" do
+        assert_raise(ArgumentError) { SpinningCursor::Parser.new.message LackingToSClass.new }
+      end
+      should "NOT raise anything if argument IS a String or respond_to :to_s (:banner)" do
+        assert_nothing_raised { SpinningCursor::Parser.new.banner "A String" }
+      end
+      should "NOT raise anything if argument IS a String or respond_to :to_s (:message)" do
+        assert_nothing_raised { SpinningCursor::Parser.new.message "A String" }
+      end
+    end
+  end
 end

data/test/test_spinning_cursor.rb

@@ -5,7 +5,7 @@ class TestSpinningCursor < Test::Unit::TestCase
     should "start the cursor, run block content and kill the cursor" do
       # Hide any output
       capture_stdout do |out|
-        SpinningCursor.start do
+        SpinningCursor.run do
           action { sleep 0.1 }
         end
         # Give it some time to abort
@@ -15,7 +15,7 @@ class TestSpinningCursor < Test::Unit::TestCase
 
     should "Parser#outer_scope_object point to 'caller'" do
       capture_stdout do |out|
-        SpinningCursor.start { }
+        SpinningCursor.run { }
         parsed = SpinningCursor.instance_variable_get(:@parsed)
         assert_equal self, parsed.outer_scope_object
         SpinningCursor.stop
@@ -25,7 +25,7 @@ class TestSpinningCursor < Test::Unit::TestCase
     should "evalute the block from the calling class" do
       @num = 1
       capture_stdout do |out|
-        SpinningCursor.start do
+        SpinningCursor.run do
           action { @num += 1 }
         end
 
@@ -37,7 +37,7 @@ class TestSpinningCursor < Test::Unit::TestCase
       class SomethingWrongHappened < StandardError; end
       assert_raise SomethingWrongHappened do
         capture_stdout do |out|
-          SpinningCursor.start do
+          SpinningCursor.run do
             action { raise SomethingWrongHappened }
           end
         end
@@ -48,7 +48,7 @@ class TestSpinningCursor < Test::Unit::TestCase
   context "when an action block isn't passed it" do
     should "start the cursor, and keep it going until stop is called" do
       capture_stdout do |out|
-        SpinningCursor.start do
+        SpinningCursor.run do
           banner "no action block"
         end
         sleep 0.5
@@ -63,7 +63,7 @@ class TestSpinningCursor < Test::Unit::TestCase
   context "whilst running it" do
     should "allow you to change the end message" do
       capture_stdout do |out|
-        SpinningCursor.start do
+        SpinningCursor.run do
           action do
             SpinningCursor.set_message "Failed!"
           end
@@ -77,7 +77,7 @@ class TestSpinningCursor < Test::Unit::TestCase
     should "stop and display error if an unmanaged exception is thrown" do
       capture_stdout do |out|
         begin
-          SpinningCursor.start do
+          SpinningCursor.run do
             action do
               raise "An exception!"
             end
@@ -90,7 +90,7 @@ class TestSpinningCursor < Test::Unit::TestCase
 
     should "not stop if an exception is handled" do
       capture_stdout do |out|
-        SpinningCursor.start do
+        SpinningCursor.run do
           action do
             begin
               raise "An exception!"
@@ -106,7 +106,7 @@ class TestSpinningCursor < Test::Unit::TestCase
 
     should "allow you to change the banner" do
       capture_stdout do |out|
-        SpinningCursor.start do
+        SpinningCursor.run do
           delay 0.2
           action do
             # Have to give it time to print the banners
@@ -142,7 +142,7 @@ class TestSpinningCursor < Test::Unit::TestCase
     should "(with a block) return similar timing values" do
       capture_stdout do |out|
         result =
-        SpinningCursor.start do
+        SpinningCursor.run do
           action do
             sleep 0.2
           end
@@ -150,7 +150,7 @@ class TestSpinningCursor < Test::Unit::TestCase
         timing_1 = result[:elapsed_time]
 
         result =
-        SpinningCursor.start do
+        SpinningCursor.run do
           action do
             sleep 0.2
           end
@@ -162,4 +162,77 @@ class TestSpinningCursor < Test::Unit::TestCase
       end
     end
   end
+
+  context "SpinningCursor#run" do
+
+    context "with a block with 1 parameter (arity 1)" do
+      setup do
+        @my_inst = "outer_inst"
+        capture_stdout do |out|
+          SpinningCursor.run do |param|
+            @my_inst = "inner_inst"
+          end
+        end
+      end
+
+      should "outer instance variables be available inside" do
+        assert_equal "inner_inst", @my_inst
+      end
+    end
+
+    context "with a block without parameters (arity 0)" do
+      setup do
+        @my_inst = "outer_inst"
+        capture_stdout do |out|
+          SpinningCursor.run do
+            @my_inst = "inner_inst"
+          end
+        end
+      end
+
+      should "outer instance variables NOT be available inside" do
+        assert_equal "outer_inst", @my_inst
+      end
+    end
+  end
+
+  context "SpinningCursor#setup" do
+    setup do
+      @sc = SpinningCursor.setup do
+        banner "My Setup Banner"
+        type :dots
+        message "My Setup Message"
+        delay 0.73
+        @bl = Proc.new {}
+        action(&@bl)
+        output :at_stop
+      end
+      @parsed = @sc.instance_variable_get(:@parsed)
+    end
+
+    should "parse banner correctly" do
+      assert_equal "My Setup Banner", @parsed.banner
+    end
+
+    should "parse type correctly" do
+      assert_equal :dots, @parsed.type
+    end
+
+    should "parse message correctly" do
+      assert_equal "My Setup Message", @parsed.message
+    end
+
+    should "parse delay correctly" do
+      assert_equal 0.73, @parsed.delay
+    end
+
+    should "parse action correctly" do
+      assert_equal @parsed.instance_variable_get(:@bl), @parsed.action
+    end
+
+    should "parse output correctly" do
+      assert_equal :at_stop, @parsed.output
+    end
+  end
+
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: spinning_cursor
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Adnan Abdulhussein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-28 00:00:00.000000000 Z
+date: 2013-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,33 +69,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Spinning Cursor is a flexible DSL that allows you to easily produce a
@@ -143,29 +130,25 @@ files:
 homepage: http://github.com/Prydonius/spinning_cursor
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 699468937831844808
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A DSL for adding animated loaders to your Ruby command line application.
 test_files: []