steps 1.0.1 → 1.1.0

data/CHANGELOG

@@ -1,2 +1,7 @@
+= 1.1.0
+  * Add debug mode to steps
+  * Add multi-line report capability
+  * Fix bug with retrieve as first step output
+
 = 1.0
   * Initial Release

data/README.md

@@ -77,6 +77,7 @@ Nested steps are supported
       # do more stuff
     end
 ```
+
 ### Getting User Feedback (highline integration)
 
 #### confirm
@@ -104,6 +105,19 @@ The retrieve function is essentially a shadow of the highline ask function, exce
     end
 ```
 
+### Print stacktraces for errors - Debug Mode
+
+To get more information while debugging you may activate the debug mode. The gem will print the stacktraces for exceptions while in debug mode.
+
+```ruby
+    step "Do something", :debug => true do
+      # ...
+    end
+```
+
+Debug mode is inherited by all nested steps.
+
+
 ### Capistrano Deployment Integration
 
 If you want to quiet down your Capistrano output and use this to provide the output, you can manually quiet the Capistrano logger and use this gem in the following way.

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/lib/steps.rb

@@ -29,7 +29,7 @@ def error_and_exit(message)
   Steps::Output.error_and_exit(message)
 end
 
-def report(message)
-  step message.bold.blue do " " end
+def report(message, color="blue", bold=true)
+  Steps::Output.report(message, color, bold)
 end
 

data/lib/steps/output.rb

@@ -11,17 +11,33 @@ module Steps
     @task_depth = 0
     @stacked_result = false
     @highline = HighLine.new
+    @debug_depth = nil
 
-    def self.step(desc, options)
+    def self.step(desc, options={}, &block)
       self.start_to desc
+
+      # Set debug depth if specified
+      if options[:debug] and @debug_depth.nil?
+        @debug_depth = @task_depth
+      end
+
       begin
-        smessage = yield
+        smessage = block.call()
         smessage = "✔" unless smessage.is_a? String
         self.success smessage
       rescue Exception => e
           message = e.message.empty? ? "X" : e.message
 
+          unless e.is_a?(SystemExit) or @debug_depth.nil?
+            if @task_depth >= @debug_depth
+              self.report message, "red", false
+              e.backtrace.each { |c| self.report("(debug) #{c}", "red") }
+              message = "X"
+            end
+          end
+
           self.error(message)
+
           if options[:vital]
             if @task_depth > 1
               raise "X"
@@ -88,6 +104,18 @@ module Steps
       self.result message.blue
     end
 
+    def self.report message, color, bold
+      message = message.to_s # try and make sure we're dealing with a string
+      message.each_line do |line|
+        unless line.empty?
+          line.strip!
+          line = line.send("bold") if bold
+          line = line.send(color) if ['red', 'blue', 'yellow', 'green'].include? color
+          self.step line do " " end
+        end
+      end
+    end
+
     def self.confirm(message, options={})
       message = message + " (y|n) > "
       message = (options[:vital] ? message.red : message.blue) + " "
@@ -119,11 +147,16 @@ module Steps
       message = message.blue + " "
       message = "├── ".yellow + message if @task_depth > 0
       @spinner.stop
+      if @task_depth > 0 and not @stacked_result
+        print "\n" + ("|   ".yellow * (@task_depth - 1))
+      end
       result = @highline.ask(message, answer_type, &block)
       if @task_depth > 0
         print "|   ".yellow * (@task_depth - 1)
         @spinner.start
       end
+
+      @stacked_result = true
       return result
     end
   end

data/steps.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "steps"
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Crowd Favorite"]
-  s.date = "2013-07-11"
+  s.date = "2013-09-30"
   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",

data/test.rb

@@ -24,7 +24,10 @@ step "Do Something else" do
     end
     step "Double! Nested Something" do
       step "Triple (and vital)! Nested Something", :vital => true do
-        report "this is something important"
+        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
@@ -35,7 +38,6 @@ step "Do Something else" do
           end
         end
         sleep 1
-        answer = retrieve "What is your favorite color?"
         step "favorite color" do
           sleep 1
           answer

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: steps
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored