chaperone 0.0.1 → 0.0.2

data/README.md

@@ -94,6 +94,15 @@ a user can update in another terminal and confirm the change is recognized.
       p.code     = 'rvm use 1.9.3'
       p.question = 'Using the right version?'
     end
+    
+    # Output:
+    Ruby Version Check
+    Required: ruby 1.9.3[Any Patch Level]
+    Current: ruby 1.9.3p194 (2012-04-20 revision 35410) [x86_64-darwin12.2.0]
+
+    rvm use 1.9.3
+
+    Using the right version? [c]ontinue, [r]etry, e[x]it
 
 To see a full guide example, see the [`deploy.rb`](https://github.com/mwerner/chaperone/blob/master/examples/deploy.rb) file in the repository's `examples` dir
 

data/examples/deploy.rb

@@ -17,7 +17,7 @@ class Deploy < Chaperone::Guide
     version = CommandLine.new('ruby', '-v').run.gsub("\n",'')
 
     prompt do |p|
-      p.title   = 'Ruby Version Check'
+      p.title   = '==> Ruby Version Check'
       p.needs   = 'ruby 1.9.3[Any Patch Level]'
       p.current = version
       p.code    = 'rvm use 1.9.3'
@@ -26,11 +26,9 @@ class Deploy < Chaperone::Guide
 
   def execute_capistrano
     prompt do |p|
-      p.title   = 'Run capistrano task'
+      p.title   = '==> Run capistrano task'
       p.code    = 'bundle exec cap production deploy'
-      p.notes = %{
-        The script can be found in config/deploy/production.rb
-      }
+      p.notes   = "The script can be found in config/deploy/production.rb"
     end
   end
 
@@ -38,7 +36,7 @@ class Deploy < Chaperone::Guide
     latest = CommandLine.new('git describe --abbrev=0 --tags').run.gsub("\n",'') rescue 'Unable to determine'
 
     prompt(question: false) do |p|
-      p.title = 'Tagging the release'
+      p.title = '==> Tagging the release'
       p.notes = %{
         - This should be the next unreleased tag in the current Changelog.md
         Latest Deployed Version: #{status(latest)}

data/lib/chaperone/guide.rb

@@ -4,7 +4,7 @@ module Chaperone
     include Output
     include HighlineConfig
 
-    attr_accessor :steps, :current_step, :iteration, :url
+    attr_accessor :steps, :current_step, :iteration, :url, :debug
 
     STEPS = ['no_steps_defined']
     URL   = 'https://github.com/mwerner/chaperone'
@@ -17,31 +17,22 @@ module Chaperone
     end
 
     def start
-      welcome!
+      welcome
       
       (0..steps.length-1).each do |step|
         @iteration = step
-
-        if current_step > iteration
-          skip_step!
-          next
-        end
-
+        skip_step! and next if current_step > iteration
         break unless execute_step(steps[iteration].to_sym)
         complete_step!
       end
-
-      complete!
     end
 
-    protected
-
-    def no_steps_defined
-      prompt(question: false) do |p|
-        p.title = "No Steps are defined for #{self.class.to_s}"
-      end
+    def debug?
+      self.debug == true
     end
 
+    private
+
     def execute_step(step, proceed=true)
       unless self.respond_to?(step)
         output "WARNING: #{step} is not defined"
@@ -49,9 +40,15 @@ module Chaperone
       end
 
       loop do
-        case send(step)
+        result = send(step)
+        @debug = false
+
+        case result
         when 'r'; next
-        when 'x'; proceed = false
+        when 'd'
+          @debug = true
+          next
+        when 'x', 'q'; proceed = false
         end
 
         break
@@ -60,29 +57,28 @@ module Chaperone
       proceed
     end
 
-    private
+    def no_steps_defined
+      prompt(question: false) do |p|
+        p.title = "No Steps are defined for #{self.class.to_s}"
+      end
+    end
 
     def prompt(opts={}, &config)
-      Prompt.new(opts, &config).render
+      Prompt.new(opts, self, &config).render
     end
 
-    def welcome!
-      output '==> Begin'
+    def welcome
       output "==> Reference: #{url}" if url
     end
 
     def complete_step!
       @current_step += 1
-      output notice("==> [#{iteration}] Completed Step")
+      #output notice("==> [#{iteration}] Completed Step")
     end
 
     def skip_step!
       output notice("==> Skipping [#{iteration}] #{steps[iteration].gsub('_',' ')}")
     end
 
-    def complete!
-      output "==> Finished"
-    end
-
   end
 end

data/lib/chaperone/prompt.rb

@@ -3,17 +3,19 @@ module Chaperone
     include Output
     include HighlineConfig
 
-    attr_accessor :title, :notes, :needs, :current, :code, :question, :config
+    attr_accessor :guide, :title, :notes, :needs, :current, :code, :question, :config, :debug
 
-    def initialize(config={})
-      @config = {padding: true, question: true}.merge(config)
+    def initialize(config={}, guide=nil)
+      @guide  = guide || Guide.new
+      @config = {padding: false, question: true}.merge(config)
       yield(self) if block_given?
     end
 
     def render
-      output body
+      output(guide.debug? ? debugging : body)
+
       return unless has_question?
-      ask strong("#{question} [c]ontinue, [r]etry, e[x]it".squeeze(' '))
+      ask strong("\n#{question}[C]ontinue, #{'[d]ebug, ' if debug}[r]etry, e[x]it")
     end
 
     def lines
@@ -22,14 +24,24 @@ module Chaperone
       sections << notes                                  if notes
       sections << "#{requirement('Required:')} #{needs}" if needs
       sections << "#{status('Current:')} #{current}"     if current
-      sections << direction("\n #{code}")                if code
+      sections << direction("#{code}")                   if code
       sections
     end
 
     def body
-      text = lines.join("\n ")
+      text = lines.map{|t| t.gsub(/^#{t.scan(/^\s*/).min_by{|l|l.length}}/, "") }.join("\n")
+      text = "\n#{text}\n\n" if has_padding?
+      text
+    end
+
+    def debugging
+      sections = []
+      sections << action( "DEBUG: #{title}" ) if title
+      sections << debug                       if debug
+
+      text = sections.map{|t| t.gsub(/^#{t.scan(/^\s*/).min_by{|l|l.length}}/, "") }.join("\n")
       text = "\n#{text}\n\n" if has_padding?
-      text.squeeze(' ')
+      text
     end
 
     def has_padding?

data/lib/chaperone/version.rb

@@ -1,3 +1,3 @@
 module Chaperone
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/chaperone.rb

@@ -31,8 +31,4 @@ end
 module Chaperone
   autoload :Prompt,    'chaperone/prompt'
   autoload :Guide,     'chaperone/guide'
-
-  module Guides
-    autoload :Brew,    'chaperone/guides/brew'
-  end
 end

data/spec/models/guide_spec.rb

@@ -17,9 +17,8 @@ describe Guide do
   context '#start' do
     let(:guide){Guide.new}
 
-    it 'calls welcome and complete' do
-      Guide.any_instance.expects(:welcome!).once
-      Guide.any_instance.expects(:complete!).once
+    it 'calls welcome' do
+      Guide.any_instance.expects(:welcome).once
       guide.start
     end
 

data/spec/models/prompt_spec.rb

@@ -1,14 +1,15 @@
 require 'spec_helper'
 
-describe Guide do
+describe Prompt do
   let(:attrs){%w(title notes needs current code)}
+  let(:guide){ Guide.new }
   context '#initialize' do
     it 'defaults config' do
-      Prompt.new.config.should eq({padding: true, question: true})
+      Prompt.new.config.should eq({padding: false, question: true})
     end
 
     it 'allows config' do
-      params = {padding: false, question: false}
+      params = {padding: true, question: false}
       Prompt.new(params).config.should eq(params)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chaperone
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-02 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -158,18 +158,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1260887828363319748
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1260887828363319748
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24