Ruby Gem helper for building Alfred workflow.
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
test/workflow
.gemtest
.gitignore
.rspec
.ruby-version
.travis.yml
.vclog
Gemfile
Gemfile.lock
Guardfile
History.txt
Manifest.txt
README.md
Rakefile
alfred-workflow.gemspec

README.md

alfred-workflow Build Status

DESCRIPTION:

alfred-workflow is a ruby Gem helper for building Alfred workflow.

FEATURES:

  • Use standard bundler to easily package, manage, and update ruby gems in the workflow.
  • Friendly exception and debug output to the Mac OS X Console.
  • Automate saving and loading cached feedback
  • Automate rescue feedback items to alfred when something goes wrong.
  • Functions to easily load and save user configuration (in YAML)
  • 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.

INSTALL:

gem install alfred-workflow

USAGE:

UPGRADE GUIDE

From version 1.0+ to 2.0+

  1. cached feedback are saved and closed automatically, call to put_cached_feedback is not required.

SYNOPSIS:

The Basic

require 'rubygems' unless defined? Gem
require "bundle/bundler/setup"
require "alfred"

Alfred.with_friendly_error do |alfred|
  fb = alfred.feedback

  fb.add_file_item(File.expand_path "~/Applications/")

  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.

With rescue feedback automatically generated!

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

Automate saving and loading cached feedback

require 'rubygems' unless defined? Gem
require "bundle/bundler/setup"
require "alfred"

Alfred.with_friendly_error do |alfred|
  alfred.with_rescue_feedback = true
  alfred.with_cached_feedback do
    # expire in 1 hour
    use_cache_file :expire => 3600
    # use_cache_file :file => "/path/to/your/cache_file", :expire => 3600
  end

  if fb = alfred.feedback.get_cached_feedback
    # cached feedback is valid
    puts fb.to_alfred
  else 
    fb = alfred.feedback
    # ... generate_feedback as usually
    fb.put_cached_feedback
  end
end

Customize feedback item matcher

fb = alfred.feedback
fb.add_item(:uid          => "uid"          ,
            :arg          => "arg"          ,
            :autocomplete => "autocomplete" ,
            :title        => "Title"        ,
            :subtitle     => "Subtitle"     ,
            :match?       => :all_title_match?)

fb.add_file_item(File.expand_path "~/Applications/", :match? => :all_title_match?)

:title_match? and :all_title_match? are built in.

To define your new matcher

Module Alfred
  class Feedback
    class Item
      # define new matcher function here
      def your_match?(query)
        return true
      end
    end
  end
end

Check the code in alfred/feedback/item.rb for more information.

Troubleshooting

  1. ruby crashes

One of the major reason for ruby crash is native extensions. Check the file bundle/bundler/setup.rb under the workflow folder; make sure it does not mixed up with rvm like this:

# ......
$:.unshift File.expand_path("#{path}/../../../../../../../../.rvm/gems/ruby-2.0.0-p247@global/gems/plist-3.1.0/lib")
$:.unshift File.expand_path("#{path}/../#{ruby_engine}/#{ruby_version}/gems/alfred-workflow-1.11.3/lib")
$:.unshift File.expand_path("#{path}/../../../../../../../../.rvm/gems/ruby-2.0.0-p247@global/gems/json-1.8.0/lib")

DEVELOPERS:

After checking out the source, run:

$ rake newb

This task will install any missing dependencies, run the tests/specs, and generate the RDoc.

LICENSE:

Copyright (c) 2013 Zhao Cai caizhaoff@gmail.com

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.