* example to automate rescue feedback

Author: zhaocai

.ruby-version

@@ -0,0 +1 @@
+system

README.md

@@ -4,16 +4,18 @@ A template for Ruby-based Alfred 2 workflow development.
 
 ## Example Projects
 
-* [alfred2_top_workflow]( https://github.com/zhaocai/alfred2-top-workflow )
+* [alfred2-top-workflow]( https://github.com/zhaocai/alfred2-top-workflow )
 
 
 ## Main features:
 
 * Use standard [bundler][gembundler] to easily package, manage, and update ruby gems in the workflow.
 * Friendly exception and debug output to the Mac OS X Console
+* Automate rescue feedback items to alfred when something goes wrong.
 
-Alfred workflow and feedback related functions are located in a separate [alfred-workflow gem]( https://github.com/zhaocai/alfred-workflow ) which can be easily installed by adding `gem "alfred-workflow", "~>1.0.4"` in the Gemfile.
+> Alfred workflow and feedback related functions are located in a separate [alfred-workflow gem]( https://github.com/zhaocai/alfred-workflow ) which can be easily installed by adding `gem "alfred-workflow"` in the Gemfile.
 
+* Functions for smart case query filter of feedback results.
 * Functions for finding the bundle ID, cache and storage paths, and query arguments.
 * Functions for reading and writing plist files.
 * Functions to simplify generating feedback XML for Alfred.
@@ -23,7 +25,7 @@ Alfred workflow and feedback related functions are located in a separate [alfred
 ## Quick Example
 
 ```ruby
-require 'rubygems' unless defined? Gem # rubygems is only needed in 1.8
+require 'rubygems' unless defined? Gem
 require "bundle/bundler/setup"
 require "alfred"
 
@@ -32,19 +34,40 @@ Alfred.with_friendly_error do |alfred|
 
   fb.add_file_item(File.expand_path "~/Applications/")
 
-  puts fb.to_xml
+  puts fb.to_alfred(ARGV)
 end
 ```
 
-Code are wrapped in `Alfred.with_friendly_error` block. Exceptions and debug messages are logged to Console log file **~/Library/Logs/Alfred-Workflow.log**.
+Main code are wrapped in `Alfred.with_friendly_error` block. Exceptions and debug messages are logged to Console log file **~/Library/Logs/Alfred-Workflow.log**.
 
+One more example with rescue feedback automatically generated!
 
+```ruby
+require 'rubygems' unless defined? Gem
+require "bundle/bundler/setup"
+require "alfred"
 
+def my_code_with_something_goes_wrong
+  true
+end
+
+Alfred.with_friendly_error do |alfred|
+  alfred.with_rescue_feedback = true
+
+  fb = alfred.feedback
+
+  if my_code_with_something_goes_wrong
+    raise Alfred::NoBundleIDError, "Wrong Bundle ID Test!"
+  end
+end
+```
 
 
 
 ## Quick Start Guide
 
+You may directly download the [alfred2-ruby-template]( https://github.com/zhaocai/alfred2-ruby-template/raw/master/alfred2-ruby-template.alfredworkflow ) here, install, and play with the keywords: `test feedback` and `test rescue feedback`.
+
 ### Step 1: Clone
 
 Clone or fork this repo to your local directory: https://github.com/zhaocai/alfred2-ruby-template.git
@@ -53,9 +76,10 @@ Clone or fork this repo to your local directory: https://github.com/zhaocai/alfr
 Update **domain** and **id** in the `config.yml` file.
 
 ```yaml
+# bundle_id = "domain.id"
+# path is the relative path to the workflow in the project root
 ---
 path: workflow
-# bundle_id = "domain.id"
 domain: your.domain
 id: alfred2-ruby-template
 ```
@@ -74,19 +98,23 @@ source "https://rubygems.org"
 
 gem "plist"
 gem "logging"
-gem "alfred-workflow", "~>1.0.4"
+gem "alfred-workflow"
 ```
 
-Run `rake bundle_install` to pull the gems into **workflow/bundle/** folder.
+Run `rake bundle:install` to pull the gems into **workflow/bundle/** folder.
 
 ### Step 5: Your Code
 
 Now you are good to add your own code based on the previous example.
 
 
-## Todo
+## Troubleshooting
+
+1. System bundler version is too old.
+
+> `sudo gem install bundler`
+
 
-1. Start with rescue feedback if something goes wrong
 
 ## Reference
 

Rakefile

@@ -24,17 +24,17 @@ task :chdir => [:config] do
 end
 
 desc "Install Gems"
-task :bundle_install => [:chdir] do
-  sh %Q{bundle install --standalone} do |ok, res|
+task "bundle:install" => [:chdir] do
+  sh %Q{bundle install --standalone --clean} do |ok, res|
     if ! ok
       puts "fail to install gems (status = #{res.exitstatus})"
     end
   end
 end
 
 desc "Update Gems"
-task :bundle_update => [:chdir] do
-  sh %Q{bundle update} do |ok, res|
+task "bundle:update" => [:chdir] do
+  sh %Q{bundle update && bundle install --standalone --clean} do |ok, res|
     if ! ok
       puts "fail to update gems (status = #{res.exitstatus})"
     end
@@ -43,16 +43,23 @@ end
 
 desc "Install to Alfred"
 task :install => [:config] do
-  ln_sf File.realpath($config["path"]), File.join(workflow_home, $config["bundleid"])
+  ln_sf File.expand_path($config["path"]), File.join(workflow_home, $config["bundleid"])
 end
 
 desc "Unlink from Alfred"
 task :uninstall => [:config] do
   rm File.join(workflow_home, $config["bundleid"])
 end
 
+
+
+
+desc "Clean up all the extras"
+task :clean => [:config] do
+end
+
 desc "Remove any generated file"
-task :clobber => [:config] do
+task :clobber => [:clean] do
   rmtree File.join($config["path"], ".bundle")
   rmtree File.join($config["path"], "bundle")
 end

alfred2-ruby-template.alfredworkflow

@@ -1,6 +1,7 @@
+# bundle_id = "domain.id"
+# path is the relative path to the workflow in the project root
 ---
 path: workflow
-# bundle id = domain.id
 domain: me.zhaowu
 id: alfred2-ruby-template
 

config.yml

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    alfred-workflow (1.1.1)
+    alfred-workflow (1.2.6)
       logging (~> 1.8.0)
       plist (~> 3.1.0)
     little-plugger (1.1.3)
@@ -15,6 +15,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  alfred-workflow (>= 1.0.1)
+  alfred-workflow (>= 1.1.1)
   logging
   plist

workflow/Gemfile.lock

@@ -17,6 +17,17 @@
 				<string></string>
 			</dict>
 		</array>
+		<key>BA17BE41-176A-4E9A-B958-A3F0BEA36829</key>
+		<array>
+			<dict>
+				<key>destinationuid</key>
+				<string>42D05639-3F0F-4760-8214-317167E4173D</string>
+				<key>modifiers</key>
+				<integer>0</integer>
+				<key>modifiersubtext</key>
+				<string></string>
+			</dict>
+		</array>
 	</dict>
 	<key>createdby</key>
 	<string>Zhao Cai</string>
@@ -36,15 +47,15 @@
 				<key>escaping</key>
 				<integer>62</integer>
 				<key>keyword</key>
-				<string>atest</string>
+				<string>test feedback</string>
 				<key>runningsubtext</key>
 				<string>working...</string>
 				<key>script</key>
 				<string>/usr/bin/ruby ./main.rb {query}</string>
 				<key>subtext</key>
-				<string>Test Feedback</string>
-				<key>title</key>
 				<string>Ruby Based Workflow Template</string>
+				<key>title</key>
+				<string>Test Alfred Feedback</string>
 				<key>type</key>
 				<integer>0</integer>
 				<key>withspace</key>
@@ -78,6 +89,33 @@
 			<key>uid</key>
 			<string>42D05639-3F0F-4760-8214-317167E4173D</string>
 		</dict>
+		<dict>
+			<key>config</key>
+			<dict>
+				<key>argumenttype</key>
+				<integer>2</integer>
+				<key>escaping</key>
+				<integer>63</integer>
+				<key>keyword</key>
+				<string>test rescue feedback</string>
+				<key>runningsubtext</key>
+				<string>...</string>
+				<key>script</key>
+				<string>/usr/bin/ruby ./main_with_rescue_feedback.rb {query}</string>
+				<key>subtext</key>
+				<string>Ruby Based Workflow Template</string>
+				<key>title</key>
+				<string>Test Alfred Rescue Feedback</string>
+				<key>type</key>
+				<integer>0</integer>
+				<key>withspace</key>
+				<false/>
+			</dict>
+			<key>type</key>
+			<string>alfred.workflow.input.scriptfilter</string>
+			<key>uid</key>
+			<string>BA17BE41-176A-4E9A-B958-A3F0BEA36829</string>
+		</dict>
 	</array>
 	<key>readme</key>
 	<string></string>
@@ -93,6 +131,11 @@
 			<key>ypos</key>
 			<real>140</real>
 		</dict>
+		<key>BA17BE41-176A-4E9A-B958-A3F0BEA36829</key>
+		<dict>
+			<key>ypos</key>
+			<real>370</real>
+		</dict>
 	</dict>
 	<key>webaddress</key>
 	<string>http://github.com/zhaocai/alfred2-ruby-template</string>

workflow/info.plist

@@ -5,6 +5,9 @@
 require "bundle/bundler/setup"
 require "alfred"
 
+
+
+
 Alfred.with_friendly_error do |alfred|
   fb = alfred.feedback
 
@@ -19,7 +22,21 @@
     :arg      => "A test feedback Item" ,
     :valid    => "yes"                  ,
   })
+  
+  # add an feedback to test rescue feedback
+  fb.add_item({
+    :uid          => ""                     ,
+    :title        => "Rescue Feedback Test" ,
+    :subtitle     => "rescue feedback item" ,
+    :arg          => ""                     ,
+    :autocomplete => "failed"               ,
+    :valid        => "no"                   ,
+  })
 
+  if ARGV[0].eql? "failed"
+    alfred.with_rescue_feedback = true
+    raise Alfred::NoBundleIDError, "Wrong Bundle ID Test!"
+  end
 
   puts fb.to_xml(ARGV)
 end

workflow/main.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+
+require 'rubygems' unless defined? Gem
+require "bundle/bundler/setup"
+require "alfred"
+
+
+def something_goes_wrong
+  true
+end
+
+Alfred.with_friendly_error do |alfred|
+  alfred.with_rescue_feedback = true
+
+  fb = alfred.feedback
+
+  if something_goes_wrong
+    raise Alfred::NoBundleIDError, "Wrong Bundle ID Test!"
+  end
+end
+
+
+