alfred-workflow 1.0.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2013-03-21
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/alfred.rb
+lib/alfred/version.rb

data/README.txt

@@ -0,0 +1,64 @@
+= alfred-workflow
+
+* https://github.com/zhaocai/alfred-workflow
+
+== DESCRIPTION:
+
+Ruby Gem helper for building Alfred workflow (http://www.alfredapp.com).
+
+== FEATURES/PROBLEMS:
+
+* Functions for finding your bundle ID, cache and storage paths, and query arguments.
+* Functions for reading and writing plist files.
+* Shows exceptions and debug output in the Mac OS X Console
+* A class to simplify generating feedback XML for Alfred.
+* Adds ruby gems repositories to the workflow bundle so you can package gems with your workflow.
+* A class to simplify saving and retrieving settings.
+
+
+== SYNOPSIS:
+
+
+== REQUIREMENTS:
+
+
+== INSTALL:
+
+* gem install alfred-workflow
+
+== USAGE:
+
+
+== 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:
+
+(The MIT License)
+
+Copyright (c) 2013, Zhao Cai
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,30 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+# Hoe.plugin :bundler
+# Hoe.plugin :compiler
+# Hoe.plugin :email
+# Hoe.plugin :gem_prelude_sucks
+Hoe.plugin :gemspec
+Hoe.plugin :git
+# Hoe.plugin :inline
+# Hoe.plugin :manualgen
+# Hoe.plugin :minitest
+# Hoe.plugin :perforce
+# Hoe.plugin :racc
+# Hoe.plugin :rcov
+# Hoe.plugin :rubyforge
+# Hoe.plugin :rubygems
+# Hoe.plugin :seattlerb
+
+Hoe.spec 'alfred-workflow' do
+
+  developer('Zhao Cai', 'caizhaoff@gmail.com')
+
+  extra_deps << ['plist', '~> 3.1.0']
+  extra_deps << ['logging', '~> 1.8.0']
+end
+
+# vim: syntax=ruby

data/lib/alfred.rb

@@ -0,0 +1,200 @@
+require 'rubygems' unless defined? Gem # rubygems is only needed in 1.8
+
+require 'plist'
+require 'fileutils'
+require 'logging'
+require "rexml/document"
+
+require 'alfred/version'
+
+module Alfred
+
+  class AlfredError < RuntimeError
+    def self.status_code(code)
+      define_method(:status_code) { code }
+    end
+  end
+
+  class ObjCError           < AlfredError; status_code(1) ; end
+  class NoBundleIDError     < AlfredError; status_code(2) ; end
+  class NoMethodError       < AlfredError; status_code(13) ; end
+  class PathError           < AlfredError; status_code(14) ; end
+
+  class << self
+
+    def with_friendly_error(alfred = Alfred::Core.new, &blk)
+      begin
+        yield alfred
+      rescue AlfredError => e
+        alfred.ui.error e.message
+        alfred.ui.debug e.backtrace.join("\n")
+        exit e.status_code
+      rescue Interrupt => e
+        alfred.ui.error "\nQuitting..."
+        alfred.ui.debug e.backtrace.join("\n")
+        exit 1
+      rescue SystemExit => e
+        exit e.status
+      rescue Exception => e
+        alfred.ui.error(
+          "Unfortunately, a fatal error has occurred. Please seek help in the Alfred Forum or raise an issue in \n" \
+          "github. Thanks!\n  #{e.inspect} #{e.backtrace.join("\n")}\n")
+        raise e
+      end
+    end
+  end
+
+
+  class Core
+    attr_reader :query
+
+    def initialize
+    end
+
+    def ui
+      raise NoBundleIDError unless bundle_id
+      @ui ||= Logger.new(bundle_id)
+    end
+
+    def feedback
+      raise NoBundleIDError unless bundle_id
+      @feedback ||= Feedback.new
+    end
+
+    def info_plist_path
+      path = File.join(File.dirname(__FILE__), '../info.plist')
+      raise PathError unless File.exist?(path)
+      path
+    end
+
+    def info_plist
+      @info_plist ||= Plist::parse_xml(info_plist_path)
+    end
+
+    # Returns nil if not set.
+    def bundle_id
+      info_plist['bundleid'] unless info_plist['bundleid'].empty?
+    end
+
+    def volatile_storage_path
+      raise NoBundleIDError unless bundle_id
+      path = "#{ENV['HOME']}/Library/Caches/com.runningwithcrayons.Alfred-2/Workflow Data/#{bundle_id}"
+      unless Dir.exist?(path)
+        FileUtils.makdir_p(path)
+      end
+      path
+    end
+
+    # Non-volatile storage directory for this bundle
+    def storage_path
+      raise NoBundleIDError unless bundle_id
+      path = "#{ENV['HOME']}/Library/Application Support/Alfred 2/Workflow Data/#{bundle_id}"
+      unless Dir.exist?(path)
+        FileUtils.makdir_p(path)
+      end
+      path
+    end
+
+  end
+
+
+
+
+
+
+  class Logger
+    def initialize(id)
+      @id = id
+    end
+
+    def info(msg)
+      logger.info msg
+    end
+    def warn(msg)
+      logger.warn msg
+    end
+    def debug(msg)
+      logger.debug msg
+    end
+    def error(msg)
+      logger.error msg
+    end
+    def fatal(msg)
+      logger.fatal msg
+    end
+
+    def logger
+      @logger ||= init_log
+    end
+
+    private
+
+    def init_log
+      @logger = Logging.logger[@id]
+      logger_file = File.expand_path("~/Library/Logs/Alfred-Workflow.log")
+      @logger.level = :debug
+      @logger.add_appenders(
+        Logging.appenders.file(logger_file)
+      )
+      @logger
+    end
+  end
+
+
+
+
+
+
+  class Feedback
+    attr_accessor :items
+
+    def initialize
+      @items = []
+    end
+
+    def add_item(opts = {})
+      opts[:subtitle] ||= ""
+      opts[:icon] ||= {:type => "default", :name => "icon.png"}
+      if opts[:uid].nil?
+        opts[:uid] = ''
+      end
+      opts[:arg] ||= opts[:title]
+      opts[:valid] ||= "yes"
+      opts[:autocomplete] ||= opts[:title]
+      opts[:type] ||= "default"
+
+      @items << opts unless opts[:title].nil?
+    end
+
+    def to_xml(items = @items)
+      document = REXML::Element.new("items")
+      items.each do |item|
+        new_item = REXML::Element.new('item')
+        new_item.add_attributes({
+          'uid'          => item[:uid],
+          'arg'          => item[:arg],
+          'valid'        => item[:valid],
+          'autocomplete' => item[:autocomplete]
+        })
+        new_item.add_attributes('type' => 'file') if item[:type] == "file"
+
+        REXML::Element.new("title", new_item).text    = item[:title]
+        REXML::Element.new("subtitle", new_item).text = item[:subtitle]
+
+        icon = REXML::Element.new("icon", new_item)
+        icon.text = item[:icon][:name]
+        icon.add_attributes('type' => 'fileicon') if item[:icon][:type] == "fileicon"
+
+        document << new_item
+      end
+
+      document.to_s
+    end
+  end
+
+
+
+
+
+end
+

data/lib/alfred/version.rb

@@ -0,0 +1,3 @@
+module Alfred
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: alfred-workflow
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Zhao Cai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Ruby Gem helper for building Alfred workflow (http://www.alfredapp.com).
+email:
+- caizhaoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+files:
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/alfred.rb
+- lib/alfred/version.rb
+- .gemtest
+homepage: https://github.com/zhaocai/alfred-workflow
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: alfred-workflow
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby Gem helper for building Alfred workflow (http://www.alfredapp.com).
+test_files: []