alphred 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77df5b167e6b68eefafefb3f08dcdbd46e8c85f1
+  data.tar.gz: 2d49a6168923b37774912de965d24a83c2bee14e
+SHA512:
+  metadata.gz: 43dcc97756b74b7e1bd4d0db36a5f100871484f2ac20199b01df16b853d31d82e534c435dbeeca8cfdf6c53528dc78829130beb533c894e7079a6353ca482e7d
+  data.tar.gz: ac1a78c4642b4cbb625160e3a27e7a4d089cc80f2af36470642e3b9664dbf63c0490a65575bc4bf690a7d8dd47514b19694d409182e2fa3c78c724c18bfb77a2

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alphred.gemspec
+gemspec
+
+group :development do
+  gem "guard"
+  gem "guard-minitest"
+  gem "pry"
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Alpha Chen
+
+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/README.md

@@ -0,0 +1,123 @@
+# Alphred
+
+Alphred is a library for making Alfred workflows in Ruby. It's designed
+specifically for how I work, so assumes that you manage dependencies with
+[Bundler][bundler] and Rubies with [chruby][chruby].
+
+[bundler]: http://bundler.io/
+[chruby]: https://github.com/postmodern/chruby
+
+## Usage
+
+The [example script filter][scriptfilter] would look like this using Alphred:
+
+[scriptfilter]: https://www.alfredapp.com/help/workflows/inputs/script-filter/
+
+``` ruby
+items = Alphred::Items.new(
+  Alphred::Item.new(uid: "desktop",
+                    arg: "~/Desktop",
+                    valid: true,
+                    autocomplete: "Desktop",
+                    type: :file,
+                    title: "Desktop",
+                    subtitle: "~/Desktop",
+                    icon: { value: "~/Desktop", type: :fileicon }),
+  Alphred::Item.new(uid: "flickr",
+                    valid: false,
+                    autocomplete: "flickr",
+                    title: "Flickr",
+                    icon: "flickr.png"),
+  Alphred::Item.new(uid: "image",
+                    autocomplete: "My holiday photo",
+                    type: :file,
+                    title: "My holiday photo",
+                    subtitle: "~/Pictures/My holiday photo.jpg",
+                    icon: { value: "public.jpeg", type: :filetype }),
+  Alphred::Item.new(uid: "home",
+                    arg: "~/",
+                    valid: true,
+                    autocomplete: "Home",
+                    type: :file,
+                    title: "Home Folder",
+                    subtitle: "Home folder ~/",
+                    icon: { value: "~/", type: :fileicon },
+                    mods: { shift: "Subtext when shift is pressed",
+                            fn: "Subtext when fn is pressed",
+                            ctrl: "Subtext when ctrl is pressed",
+                            alt: "Subtext when alt is pressed",
+                            cmd: "Subtext when cmd is pressed" },
+                    text: { copy: "Text when copying",
+                            largetype: "Text for LargeType" }))
+items.to_xml
+```
+
+This produces the following XML:
+
+``` xml
+<?xml version="1.0" encoding="UTF-8"?>
+<items>
+  <item uid="desktop" arg="~/Desktop" autocomplete="Desktop" type="file" valid="yes">
+    <title>Desktop</title>
+    <subtitle>~/Desktop</subtitle>
+    <icon type="fileicon">~/Desktop</icon>
+  </item>
+  <item uid="flickr" autocomplete="flickr" valid="no">
+    <title>Flickr</title>
+    <icon>flickr.png</icon>
+  </item>
+  <item uid="image" autocomplete="My holiday photo" type="file">
+    <title>My holiday photo</title>
+    <subtitle>~/Pictures/My holiday photo.jpg</subtitle>
+    <icon type="filetype">public.jpeg</icon>
+  </item>
+  <item uid="home" arg="~/" autocomplete="Home" type="file" valid="yes">
+    <title>Home Folder</title>
+    <subtitle>Home folder ~/</subtitle>
+    <icon type="fileicon">~/</icon>
+    <subtitle mod="shift">Subtext when shift is pressed</subtitle>
+    <subtitle mod="fn">Subtext when fn is pressed</subtitle>
+    <subtitle mod="ctrl">Subtext when ctrl is pressed</subtitle>
+    <subtitle mod="alt">Subtext when alt is pressed</subtitle>
+    <subtitle mod="cmd">Subtext when cmd is pressed</subtitle>
+    <text type="copy">Text when copying</text>
+    <text type="largetype">Text for LargeType</text>
+  </item>
+</items>
+```
+
+### Releasing
+
+Including `alphred/tasks` in your `Rakefile` will allow access to Alphred's
+Rake tasks for releasing a workflow. `release` will tag the current commit with
+the provided version and create a .alfredworkflow package with vendored gem
+dependencies.
+
+## TODO
+
+- Make workflow configuration easier.
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+Then, run `rake test` to run the tests. You can also run `rake console` for an
+interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/kejadlen/alphred. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,17 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task :console do
+  require "bundler/setup"
+  require "alphred"
+
+  require "pry"
+  Pry.start
+end
+
+task :default => :test

data/alphred.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "alphred/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "alphred"
+  spec.version       = Alphred::VERSION
+  spec.authors       = ["Alpha Chen"]
+  spec.email         = ["alpha.chen@gmail.com"]
+
+  spec.summary       = %q{Helper utilities for making Alfred workflows.}
+  spec.homepage      = "https://github.com/kejadlen/alph"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "builder", "~> 3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/alphred.rb

@@ -0,0 +1,9 @@
+require "builder"
+
+require_relative "alphred/version"
+
+require_relative "alphred/icon"
+require_relative "alphred/item"
+require_relative "alphred/items"
+require_relative "alphred/mods"
+require_relative "alphred/text"

data/lib/alphred/icon.rb

@@ -0,0 +1,39 @@
+require "builder"
+
+module Alphred
+  class Icon
+    VALID_TYPES = %i[ fileicon filetype ]
+
+    attr_accessor *%i[ value type ]
+
+    def initialize(**kwargs)
+      raise ArgumentError.new("missing keyword: value") unless kwargs.has_key?(:value)
+
+      @value = kwargs[:value]
+      self.type = kwargs[:type] if kwargs.has_key?(:type)
+    end
+
+    def type=(type)
+      raise ArgumentError.new("`type` must be one of #{VALID_TYPES}") unless type.nil? || VALID_TYPES.include?(type)
+
+      @type = type
+    end
+
+    def to_xml(xml=nil)
+      xml ||= Builder::XmlMarkup.new(indent: 2)
+      attrs = {}
+      attrs[:type] = self.type unless self.type.nil?
+      xml.icon self.value, attrs
+    end
+  end
+end
+
+module Kernel
+  def Icon(value)
+    case value
+    when Alphred::Icon then value
+    when String        then Alphred::Icon.new(value: value)
+    when Hash          then Alphred::Icon.new(**value)
+    end
+  end
+end

data/lib/alphred/item.rb

@@ -0,0 +1,59 @@
+require "builder"
+
+require_relative "mods"
+require_relative "text"
+
+module Alphred
+  class Item
+    VALID_TYPES = %i[ default file file_skipcheck ]
+
+    attr_accessor *%i[ uid arg valid autocomplete title subtitle mods icon text ]
+
+    def initialize(**kwargs)
+      raise ArgumentError.new("missing keyword: title") unless kwargs.has_key?(:title)
+
+      @title = kwargs[:title]
+
+      %i[ uid arg valid autocomplete subtitle ].each do |attr|
+        self.instance_variable_set("@#{attr}", kwargs[attr]) if kwargs.has_key?(attr)
+      end
+
+      @icon = Icon(kwargs[:icon]) if kwargs.has_key?(:icon)
+      @text = Text.new(kwargs[:text]) if kwargs.has_key?(:text)
+      @mods = Mods.new(kwargs[:mods]) if kwargs.has_key?(:mods)
+
+      self.type = kwargs[:type] if kwargs.has_key?(:type)
+    end
+
+    def type=(type)
+      raise ArgumentError.new("`type` must be one of #{VALID_TYPES}") unless type.nil? || VALID_TYPES.include?(type)
+
+      @type = type
+    end
+
+    def type
+      @type && @type.to_s.gsub(?_, ?:)
+    end
+
+    def to_xml(xml=nil)
+      xml ||= Builder::XmlMarkup.new(indent: 2)
+      xml.item self.attrs do
+        xml.title self.title
+        xml.subtitle self.subtitle unless self.subtitle.nil?
+        self.icon.to_xml(xml) unless self.icon.nil?
+        self.mods.to_xml(xml) unless self.mods.nil?
+        self.text.to_xml(xml) unless self.text.nil?
+      end
+    end
+
+    def attrs
+      attrs = {}
+      %i[ uid arg autocomplete type ].each do |attr|
+        value = self.send(attr)
+        attrs[attr] = value unless value.nil?
+      end
+      attrs[:valid] = (self.valid) ? "yes" : "no" unless self.valid.nil?
+      attrs
+    end
+  end
+end

data/lib/alphred/items.rb

@@ -0,0 +1,22 @@
+require "builder"
+
+module Alphred
+  class Items < DelegateClass(Array)
+    attr_reader :items
+
+    def initialize(*items)
+      @items = items
+      super(@items)
+    end
+
+    def to_xml
+      xml = Builder::XmlMarkup.new(indent: 2)
+      xml.instruct! :xml
+      xml.items do
+        self.items.each do |item|
+          item.to_xml(xml)
+        end
+      end
+    end
+  end
+end

data/lib/alphred/mods.rb

@@ -0,0 +1,22 @@
+require "builder"
+
+module Alphred
+  class Mods
+    MODS = %i[ shift fn ctrl alt cmd ]
+
+    attr_accessor *MODS
+
+    def initialize(**kwargs)
+      MODS.each do |mod|
+        self.instance_variable_set("@#{mod}", kwargs[mod]) if kwargs.has_key?(mod)
+      end
+    end
+
+    def to_xml(xml)
+      MODS.each do |mod|
+        value = self.send(mod)
+        xml.subtitle value, mod: mod unless value.nil?
+      end
+    end
+  end
+end

data/lib/alphred/tasks.rb

@@ -0,0 +1,40 @@
+require "rake"
+
+namespace :alphred do
+  desc "Prepare a release, named after the directory"
+  task :release, [:version] => [:tag, :package]
+
+  desc "Tag the current commit in git with VERSION"
+  task :tag, [:version] do |t, args|
+    version = args[:version]
+
+    git_status = `git status --porcelain`
+    fail <<-FAIL unless git_status.empty?
+Can't tag #{version}: dirty working directory.
+    FAIL
+
+    sh "git tag #{version}"
+  end
+
+  desc "Create an alfredworkflow package with vendored dependencies"
+  task :package do
+    restore_bundler_config do
+      cmd = "bundle install --standalone --path vendor/bundle --without development test"
+      sh "chruby-exec 2.0.0 -- #{cmd}"
+    end
+    sh "zip -r #{application_dir.pathmap("%n.alfredworkflow")} *"
+    rm_rf "vendor"
+  end
+
+  def application_dir
+    Rake.application.original_dir
+  end
+
+  def restore_bundler_config
+    path = File.join(application_dir, ".bundle", "config")
+    config = File.read(path)
+    yield
+  ensure
+    File.write(path, config, mode: ?w)
+  end
+end

data/lib/alphred/text.rb

@@ -0,0 +1,17 @@
+require "builder"
+
+module Alphred
+  class Text
+    attr_accessor *%i[ copy largetype ]
+
+    def initialize(copy: nil, largetype: nil)
+      @copy = copy
+      @largetype = largetype
+    end
+
+    def to_xml(xml)
+      xml.text copy, type: :copy unless self.copy.nil?
+      xml.text largetype, type: :largetype unless self.largetype.nil?
+    end
+  end
+end

data/lib/alphred/version.rb

@@ -0,0 +1,3 @@
+module Alphred
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: alphred
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alpha Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- alpha.chen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alphred.gemspec
+- lib/alphred.rb
+- lib/alphred/icon.rb
+- lib/alphred/item.rb
+- lib/alphred/items.rb
+- lib/alphred/mods.rb
+- lib/alphred/tasks.rb
+- lib/alphred/text.rb
+- lib/alphred/version.rb
+homepage: https://github.com/kejadlen/alph
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Helper utilities for making Alfred workflows.
+test_files: []