steps 1.1.1 → 1.1.3

data/CHANGELOG

@@ -1,3 +1,11 @@
+= 1.1.3
+  * fix 1.1.2 breaking the gem build
+
+= 1.1.2
+  * Add Unit Testing
+  * Move away from Jeweler
+  * Move to instance providing singleton method for Output class
+
 = 1.1.1
   * Fix breaking issues with debug mode
 

data/Gemfile

@@ -1,11 +1,3 @@
 source "https://rubygems.org"
 
-gem "colored", ">= 1.2"
-gem "highline", ">= 1.6"
-
-group :development do
-  gem "rspec", "~> 2.11"
-  gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 1.8"
-  gem "simplecov", ">= 0"
-end
+gemspec

data/README.md

@@ -1,5 +1,7 @@
 # steps
 
+[![Build Status](https://travis-ci.org/crowdfavorite/gem-steps.png?branch=master,develop)](https://travis-ci.org/crowdfavorite/gem-steps)
+
 ## General
 
 A gem that produces simple user feedback in scripting environments.
@@ -12,22 +14,14 @@ Integrates with:
 
 ## Installation
 
-### Github
+    gem install steps
 
-Add this to your Gemfile to install and use directly from github.
+## Usage
 
 ```ruby
-  gem "steps", :git => 'git://github.com/crowdfavorite/gem-steps.git'
+require 'steps'
 ```
 
-### RubyGems.org
-
-This gem is available as 'steps' from rubygems.org
-
-    gem install steps
-
-## Usage
-
 To define a "step" in your scripting process simply surround the grouping of operations like this.
 
 ```ruby
@@ -147,3 +141,9 @@ If you want to quiet down your Capistrano output and use this to provide the out
   before "deploy:restart"           do start_to "Restart" end
   after "deploy:restart"            do success end
 ```
+
+### Development
+
+    rake
+    rake install
+

data/Rakefile

@@ -1,7 +1,12 @@
 # encoding: utf-8
-
-require 'rubygems'
 require 'bundler'
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'rake/clean'
+
+CLOBBER.include 'pkg/*'
+CLEAN.include 'pkg/*'
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -9,22 +14,11 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "steps"
-  gem.homepage = "http://github.com/crowdfavorite/gem-steps"
-  gem.license = "Apache 2.0"
-  gem.summary = %Q{Scripting output helper}
-  gem.description = <<-EOF.gsub(/^ {4}/, '')
-    A way to simplify the output of shell scripting written in ruby.
 
-    Integrates with Capistrano and Rake tasks.
-  EOF
-  gem.authors = ["Crowd Favorite"]
-  # dependencies defined in Gemfile
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['specs/*_spec.rb']
+  t.verbose = true
 end
-Jeweler::RubygemsDotOrgTasks.new
 
+task :default => [:test, :clobber, :build]

data/example.rb

@@ -0,0 +1,77 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'steps'
+
+report "This is an example of 'steps' output"
+
+step "Single Level Task" do
+  sleep 1
+end
+
+step "Custom Success Message" do
+  sleep 1
+  "Yay!"
+end
+
+step "Task with an error" do
+  sleep 1
+  raise
+end
+
+step "Custom Error Message" do
+  sleep 1
+  raise "There was a problem"
+end
+
+step "Debug Mode", :debug => true do
+  sleep 1
+  raise "There was a problem"
+end
+
+step "Progress Messages" do
+  sleep 0.5
+  report "Progress 1"
+  sleep 0.5
+  report "Progress 2"
+  true
+end
+
+step "User Input" do
+  sleep 0.5
+  color = retrieve "What is your favorite color?"
+  sleep 0.5
+  if confirm "Are you sure?"
+    report "Favorite color is #{color}"
+  else
+    report "Favorite color is not #{color}"
+  end
+  sleep 0.5
+end
+
+step "Vital Questions" do
+  sleep 0.5
+  confirm "This question is vital?", :vital => true
+  report "You answered yes."
+  sleep 0.5
+end
+
+step "Nested Steps" do
+  sleep 0.5
+  step "Nested Step Level 1" do
+    sleep 0.5
+    step "Nested Step Level 2" do
+      sleep 0.5
+    end
+  end
+end
+
+step "Nested Steps" do
+  sleep 0.5
+  step "Nested Step Level 1" do
+    sleep 0.5
+    step "Vital Step Level 2", :vital => true do
+      sleep 0.5
+      raise "Oooops"
+    end
+    report "This shouldn't be shown"
+  end
+end

data/lib/steps.rb

@@ -2,34 +2,34 @@
 require 'steps/output'
 
 def step(desc, options={}, &block)
-  Steps::Output.step(desc, options, &block)
+  Steps::Output.singleton.step(desc, options, &block)
 end
 
 def confirm(message, options={})
-  Steps::Output.confirm(message, options)
+  Steps::Output.singleton.confirm(message, options)
 end
 
 def retrieve(message, answer_type = String, &block)
-  Steps::Output.retrieve(message, answer_type, &block)
+  Steps::Output.singleton.retrieve(message, answer_type, &block)
 end
 
 def start_to(message)
-  Steps::Output.start_to(message)
+  Steps::Output.singleton.start_to(message)
 end
 
 def success(message = "✔")
-  Steps::Output.success(message)
+  Steps::Output.singleton.success(message)
 end
 
 def error(message = "X")
-  Steps::Output.error(message)
+  Steps::Output.singleton.error(message)
 end
 
 def error_and_exit(message)
-  Steps::Output.error_and_exit(message)
+  Steps::Output.singleton.error_and_exit(message)
 end
 
 def report(message, color="blue", bold=true)
-  Steps::Output.report(message, color, bold)
+  Steps::Output.singleton.report(message, color, bold)
 end
 

data/lib/steps/output.rb

@@ -7,13 +7,20 @@ require 'steps/spinner'
 module Steps
   class Output
 
-    @spinner = Steps::Spinner.new
-    @task_depth = 0
-    @stacked_result = false
-    @highline = HighLine.new
-    @debug_depth = nil
+    @@singleton = nil
+    def self.singleton
+      @@singleton ||= Output.new
+    end
+
+    def initialize
+      @spinner = Steps::Spinner.new
+      @task_depth = 0
+      @stacked_result = false
+      @highline = HighLine.new
+      @debug_depth = nil
+    end
 
-    def self.step(desc, options={}, &block)
+    def step(desc, options={}, &block)
       self.start_to desc
 
       # Set debug depth if specified
@@ -48,7 +55,7 @@ module Steps
       end
     end
 
-    def self.start_to message
+    def start_to message
       lead_str = ""
       if @spinner.running?
         @spinner.stop
@@ -69,7 +76,7 @@ module Steps
       @stacked_result = false
     end
 
-    def self.result message
+    def result message
       @spinner.stop
 
       puts message
@@ -85,27 +92,27 @@ module Steps
       @stacked_result = true
     end
 
-    def self.error message
+    def error message
       if @spinner.running?
         @spinner.stop
       end
       self.result message.red
     end
 
-    def self.error_and_exit message
+    def error_and_exit message
       self.error message
       exit
     end
 
-    def self.success message
+    def success message
       self.result message.green
     end
 
-    def self.info message
+    def info message
       self.result message.blue
     end
 
-    def self.report message, color, bold = true
+    def report message, color, bold = true
       message = message.to_s # try and make sure we're dealing with a string
       message.each_line do |line|
         unless line.empty?
@@ -117,7 +124,7 @@ module Steps
       end
     end
 
-    def self.confirm(message, options={})
+    def confirm(message, options={})
       message = message + " (y|n) > "
       message = (options[:vital] ? message.red : message.blue) + " "
       message = "├── ".yellow + message if @task_depth > 0
@@ -143,7 +150,7 @@ module Steps
       return result
     end
 
-    def self.retrieve(message, answer_type, &block)
+    def retrieve(message, answer_type, &block)
       message = message + " > "
       message = message.blue + " "
       message = "├── ".yellow + message if @task_depth > 0

data/lib/steps/spinner.rb

@@ -13,24 +13,24 @@ module Steps
       @running
     end
 
-    def start()
-      if (!@running)
-        @running = true
-        @spinner_thread = Thread.new do
-          while @running do
-            print @chars.push(@chars.shift).first
-            sleep(0.1)
-            print "\b \b"
-          end
+    def start
+      return if @running
+
+      @running = true
+      @spinner_thread = Thread.new do
+        while @running do
+          print @chars.push(@chars.shift).first
+          sleep 0.1
+          print "\b \b"
         end
       end
     end
 
-    def stop()
-      if @running
-        @running = false
-        @spinner_thread.join
-      end
+    def stop
+      return unless @running
+
+      @running = false
+      @spinner_thread.join
     end
 
   end

data/lib/steps/version.rb

@@ -1,4 +1,4 @@
 module Steps
-  VERSION = '1.1.1'
+  VERSION = '1.1.3'
 end
 

data/specs/output_spec.rb

@@ -0,0 +1,114 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'steps/output'
+
+describe Steps::Output do
+
+  after do
+    $stdin = STDIN
+  end
+
+  it "should produce a valid singleton" do
+    output = Steps::Output.singleton
+    output.must_be_same_as Steps::Output.singleton
+    output.wont_be_same_as Steps::Output.new
+  end
+
+  it "should continue parent step if nested step is not vital and fails" do
+    output = Steps::Output.new
+    value = false
+    output.step "outer" do
+      output.instance_variable_get(:@task_depth).must_equal 1
+      output.step "non-vital inner" do
+        raise "Ooooops"
+      end
+      value = true
+    end
+    value.must_equal true
+  end
+
+  it "should fail parent step if nested step is vital and fails" do
+    output = Steps::Output.new
+    value = false
+    output.step "outer" do
+      output.instance_variable_get(:@task_depth).must_equal 1
+      output.step "vital inner", :vital => true do
+        raise "Ooooops"
+      end
+      value = true
+    end
+    value.must_equal false
+  end
+
+  it "should continue parent step if nested step is vital and passes" do
+    output = Steps::Output.new
+    value = false
+    output.step "outer" do
+      output.instance_variable_get(:@task_depth).must_equal 1
+      output.step "vital inner", :vital => true do
+        "Vital Success"
+      end
+      value = true
+    end
+    value.must_equal true
+  end
+
+  it "should continue execution of step if negative response to non-vital confirm" do
+    $stdin = StringIO.new("n\r\n")
+    value = false
+    output = Steps::Output.new
+    output.step "Non-vital Confirm" do
+      output.confirm "This is a regular confirm?"
+      value = true
+    end
+    value.must_equal true
+  end
+
+  it "should continue execution of step if positive response to vital confirm" do
+    $stdin = StringIO.new("y\r\n")
+    value = false
+    output = Steps::Output.new
+    output.step "Vital Confirm" do
+      output.confirm "This is a vital question?", :vital => true
+      value = true
+    end
+    value.must_equal true
+  end
+
+  it "should stop execution of step if negative response to vital confirm" do
+    $stdin = StringIO.new("n\r\n")
+    value = false
+    output = Steps::Output.new
+    output.step "Vital Confirm" do
+      output.confirm "This is a vital question?", :vital => true
+      value = true
+    end
+    value.must_equal false
+  end
+
+  it "should increase task_depth with every nested step" do
+    output = Steps::Output.new
+    output.step "Level 1" do
+      output.instance_variable_get(:@task_depth).must_equal 1
+      output.step "Level 2" do
+        output.instance_variable_get(:@task_depth).must_equal 2
+        output.step "Level 3" do
+          output.instance_variable_get(:@task_depth).must_equal 3
+        end
+      end
+    end
+  end
+
+  it "should decrease task_depth with every step completion" do
+    output = Steps::Output.new
+    output.step "Level 1" do
+      output.step "Level 2" do
+        output.step "Level 3" do
+          output.instance_variable_get(:@task_depth).must_equal 3
+        end
+        output.instance_variable_get(:@task_depth).must_equal 2
+      end
+      output.instance_variable_get(:@task_depth).must_equal 1
+    end
+  end
+end

data/specs/spinner_spec.rb

@@ -0,0 +1,26 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'steps/spinner'
+
+describe Steps::Spinner do
+
+  before do
+    @spinner = Steps::Spinner.new
+  end
+
+  after do
+    @spinner = nil
+  end
+
+  it "should be initialized in a stopped state" do
+    @spinner.running?.must_equal false
+  end
+
+  it "reports running? status correctly" do
+    @spinner.start
+    @spinner.running?.must_equal true
+    @spinner.stop
+    @spinner.running?.must_equal false
+  end
+
+end

data/steps.gemspec

@@ -1,66 +1,24 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'steps/version'
+require 'date'
 
 Gem::Specification.new do |s|
-  s.name = "steps"
-  s.version = "1.1.1"
+  s.name        = "steps"
+  s.version     = Steps::VERSION
+  s.authors     = ["Crowd Favorite"]
+  s.date        = Date.today.to_s
+  s.summary     = %q{Ruby scripting output helper}
+  s.description = %q{A way to simplify the output of shell scripting written in ruby.  Integrates with Capistrano and Rake tasks.}
+  s.files       = Dir['[A-Z]*', 'steps.gemspec', 'lib/**/*', 'example.rb', 'specs/**/*']
+  s.homepage    = "http://github.com/crowdfavorite/gem-steps"
+  s.licenses    = ["Apache 2.0"]
+  s.required_ruby_version = '>= 1.9.3'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Crowd Favorite"]
-  s.date = "2013-10-06"
-  s.description = "A way to simplify the output of shell scripting written in ruby.\n\nIntegrates with Capistrano and Rake tasks.\n"
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    "CHANGELOG",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "lib/steps.rb",
-    "lib/steps/output.rb",
-    "lib/steps/spinner.rb",
-    "lib/steps/version.rb",
-    "steps.gemspec",
-    "test.rb"
-  ]
-  s.homepage = "http://github.com/crowdfavorite/gem-steps"
-  s.licenses = ["Apache 2.0"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
-  s.summary = "Scripting output helper"
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<colored>, [">= 1.2"])
-      s.add_runtime_dependency(%q<highline>, [">= 1.6"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.11"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8"])
-      s.add_development_dependency(%q<simplecov>, [">= 0"])
-    else
-      s.add_dependency(%q<colored>, [">= 1.2"])
-      s.add_dependency(%q<highline>, [">= 1.6"])
-      s.add_dependency(%q<rspec>, ["~> 2.11"])
-      s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8"])
-      s.add_dependency(%q<simplecov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<colored>, [">= 1.2"])
-    s.add_dependency(%q<highline>, [">= 1.6"])
-    s.add_dependency(%q<rspec>, ["~> 2.11"])
-    s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8"])
-    s.add_dependency(%q<simplecov>, [">= 0"])
-  end
+  s.add_dependency "colored", ">= 1.2"
+  s.add_dependency "highline", ">= 1.6"
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake", "~> 10.1.0"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steps
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
@@ -43,22 +43,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -74,15 +58,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,49 +74,27 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  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: ! 'A way to simplify the output of shell scripting written in ruby.
-
-
-  Integrates with Capistrano and Rake tasks.
-
-'
+        version: 10.1.0
+description: A way to simplify the output of shell scripting written in ruby.  Integrates
+  with Capistrano and Rake tasks.
 email: 
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.txt
-- README.md
+extra_rdoc_files: []
 files:
 - CHANGELOG
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
-- README.md
 - Rakefile
-- VERSION
-- lib/steps.rb
+- README.md
+- steps.gemspec
 - lib/steps/output.rb
 - lib/steps/spinner.rb
 - lib/steps/version.rb
-- steps.gemspec
-- test.rb
+- lib/steps.rb
+- example.rb
+- specs/output_spec.rb
+- specs/spinner_spec.rb
 homepage: http://github.com/crowdfavorite/gem-steps
 licenses:
 - Apache 2.0
@@ -145,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -157,5 +119,5 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Scripting output helper
+summary: Ruby scripting output helper
 test_files: []

data/Gemfile.lock

@@ -1,40 +0,0 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    colored (1.2)
-    diff-lcs (1.2.4)
-    git (1.2.5)
-    highline (1.6.19)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
-    json (1.8.0)
-    multi_json (1.7.7)
-    rake (10.0.4)
-    rdoc (4.0.1)
-      json (~> 1.4)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0)
-  colored (>= 1.2)
-  highline (>= 1.6)
-  jeweler (~> 1.8)
-  rspec (~> 2.11)
-  simplecov

data/VERSION

@@ -1 +0,0 @@
-1.1.1

data/test.rb

@@ -1,57 +0,0 @@
-$:.push File.expand_path("../lib", __FILE__)
-require 'steps'
-
-confirm "This is not a vital question, right?"
-
-step "Update Something" do
-  sleep 1
-end
-
-confirm "Is this a vital question?", :vital => true
-
-step "Do Something else" do
-  confirm "Is this a vital question?", :vital => true
-  sleep 1
-  step "Nested Something" do
-    sleep 1
-    step "Double! Again" do
-      report "Something you probably want to know"
-      sleep 1
-    end
-    step "Double! Again", :debug => true do
-      sleep 1
-      raise "Problem"
-      report "Something you probably want to know"
-    end
-    step "Double! Nested Something" do
-      step "Triple (and vital)! Nested Something", :vital => true do
-        answer = retrieve "What is your favorite color?"
-        report "this is something important
-Another Line
-A third line"
-        report "Something else important"
-        step "Quad! Nested Something" do
-          sleep 1
-          if confirm "Is this a vital question?", :vital => true
-            step "resolution" do
-              sleep 1
-            end
-          end
-        end
-        sleep 1
-        step "favorite color" do
-          sleep 1
-          answer
-        end
-      end
-      step "Another Triple" do
-        sleep 1
-      end
-      sleep 1
-    end
-    sleep 1
-  end
-
-  sleep 1
-  raise
-end