alfredo 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODViMmFhNjU4ZmRjMGI5OGMxZDM0Yzc5NWJiOWUyMzZhMGY1NzRjNQ==
+  data.tar.gz: !binary |-
+    NzY3MTk2YzU4YTI4MTc5MjNlYzM5NjY2ZjFlYWE0NWJmNjJjYjcwNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjhiOTE0OGNhZWY2YTIwMWUwNmZmNWMxMTc1ZjUzODdjZDY5YmRmZTU4ZDNl
+    ZjBmYzg0YWExOWJmMGM0NjJmYzIzYmMyN2MzMWE0N2Q2ZWM2Zjk1ZWMxNTVi
+    ZWQ1NTQxNWM0NjllYjk0N2I5ZmMzOGNhM2QzZDRhYTIxMjg2YTQ=
+  data.tar.gz: !binary |-
+    ODY1NjU3Nzg1YTU0MjdhMzI2MjI3NjVmZTFlNjYxMDc3ZTk5MWZmMmY4ZTVj
+    Y2ZiZGNhMzk0YjViNjc5MzU0NjY3YjE2YTg5NzQ3OTFiYTMxMGVmZTM0Y2E5
+    YjlmMGRkMDgwMTM0ZGE2NjgxOGEwMDA0MGNhZDBhZDM4MTU3MDU=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alfredo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Dennis Paagman
+
+MIT License
+
+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,46 @@
+# Alfredo
+
+Alfredo is wrapper for Alfred 2's new Workflow system. It generates a
+XML response based on the work of
+[alfred2-top-workflow](https://github.com/zhaocai/alfred2-top-workflow/tree/master/top).
+I'm pretty sure Alfredo is not feature complete, so pull requests that
+fix or add features will be appreciated. 
+
+## Installation
+
+    $ gem install alfredo
+
+## Usage
+
+Using Alfredo is pretty straightforward:
+
+```ruby
+require 'alfredo'
+
+# set up the workflow
+workflow = Alfredo::Workflow.new
+
+# you can add as many items as you want like this:
+workflow << Alfredo::Item.new(...)
+
+# At the end of your script call:
+workflow.output!
+```
+
+Parameters available for `Alfredo::Item.new` are:
+
+* ``title``
+* `subtitle`
+* `arg` (argument that can be passed on to next steps in the workflow)
+* `uid`
+* `icon_path` (path of icon, relative to workflow directory)
+* `icon_type`
+* `type`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/alfredo.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alfredo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alfredo"
+  spec.version       = Alfredo::VERSION
+  spec.authors       = ["Dennis Paagman"]
+  spec.email         = ["dennispaagman@gmail.com"]
+  spec.description   = %q{Wrapper for Alfred 2's Workflows}
+  spec.summary       = %q{Easy generation of XML responses usable in Alfred 2 Workflows}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"  
+  spec.add_dependency 'nokogiri'
+end

data/lib/alfredo/item.rb

@@ -0,0 +1,36 @@
+module Alfredo
+  class Item
+    attr_accessor :title, :subtitle, :arg, :uid, :icon_path, :icon_type, :type
+
+    def initialize(attributes = {})
+      attributes.each do |attribute,value|
+        send("#{attribute}=", value) if respond_to? "#{attribute}="
+      end
+    end
+
+    def uid
+      @uid || "#{title}_#{Time.now.to_i}"
+    end
+
+    def icon_type
+      @icon_type || 'default'
+    end
+    
+    def type
+      @type || 'default'
+    end
+
+    def build_xml
+      Nokogiri::XML::Builder.new do |xml|
+        xml.item(arg: arg, uid: uid, valid: 'yes') {
+          xml.title title
+          xml.subtitle subtitle
+          xml.icon(type: icon_type) {
+            xml.text icon_path
+          }
+          xml.type type
+        }
+      end.doc.children.first
+    end
+  end
+end

data/lib/alfredo/version.rb

@@ -0,0 +1,3 @@
+module Alfredo
+  VERSION = "0.0.1"
+end

data/lib/alfredo/workflow.rb

@@ -0,0 +1,31 @@
+module Alfredo
+  class Workflow
+    attr_accessor :items
+
+    def initialize
+      @items = []
+    end
+
+    def <<(item)
+      @items << item if item.is_a? Alfredo::Item
+    end
+
+    alias_method :add, :<<
+
+    def to_xml
+      xml = Nokogiri::XML::Builder.new do |xml|
+        xml.items
+      end.doc
+
+      items.each do |item|
+        xml.xpath('/items').first.add_child(item.build_xml)
+      end
+
+      xml.to_s
+    end
+
+    def output!
+      puts to_xml
+    end
+  end
+end

data/lib/alfredo.rb

@@ -0,0 +1,4 @@
+require 'nokogiri'
+require 'alfredo/workflow'
+require 'alfredo/item'
+require 'alfredo/version'

data/spec/alfredo_spec.rb

@@ -0,0 +1 @@
+require 'alfredo'

data/spec/item_spec.rb

@@ -0,0 +1,55 @@
+require 'alfredo'
+
+describe 'Alfredo::Item' do
+  describe '#build_xml' do
+    before do
+      @item = Alfredo::Item.new(title: 'foo', subtitle: 'bar', arg: 'baz', uid: 123, icon_path: 'icon.png', icon_type: 'fileicon', type: 'file')
+
+      @xml = @item.build_xml
+    end
+
+    it 'should set title' do
+      @xml.xpath('/item/title').first.text.should eq 'foo'
+    end
+
+    it 'should set subtitle' do
+      @xml.xpath('/item/subtitle').first.text.should eq 'bar'
+    end
+
+    it 'should set arg' do
+      @xml.xpath('/item/@arg').first.text.should eq 'baz'
+    end
+
+    it 'should set uid' do
+      @xml.xpath('/item/@uid').first.text.should eq '123'
+    end
+
+    it 'should generate uid when not set' do
+      @item.uid = nil
+      @item.build_xml.xpath('/item/@uid').first.text.should match /#{@item.title}_[0-9]+/
+    end
+
+    it 'should set icon_path' do
+      @xml.xpath('/item/icon').first.text.should eq 'icon.png'
+    end
+
+    it 'should set icon_type' do
+      @xml.xpath('/item/icon/@type').first.text.should eq 'fileicon'
+    end
+
+    it 'should use default icon_type when not set' do
+      @item.icon_type = nil
+      @item.build_xml.xpath('/item/icon/@type').first.text.should eq 'default'
+    end
+
+    it 'should set type' do
+      @xml.xpath('/item/type').first.text.should eq 'file'
+    end
+
+    it 'should use default type when not set' do
+      @item.type = nil
+      @item.build_xml.xpath('/item/type').first.text.should eq 'default'
+    end
+  end
+end
+

data/spec/workflow_spec.rb

@@ -0,0 +1,57 @@
+require 'alfredo'
+
+describe 'Alfredo::Workflow' do
+  before do
+    @workflow = Alfredo::Workflow.new
+    3.times do
+      @workflow.items << Alfredo::Item.new(title: SecureRandom.hex)
+    end
+  end
+
+  describe "#<<" do
+    it "should add Alfredo::Item" do
+      item = Alfredo::Item.new
+      
+      @workflow << item
+      @workflow.items.should include(item)
+    end
+
+    it "should not add a random thing" do
+      item = 'foo'
+
+      @workflow << item
+      @workflow.items.should_not include(item)
+    end
+  end
+  
+  describe "#add" do
+    it "should be an alias for <<" do
+      @workflow.method(:add).should eq(@workflow.method(:<<))
+    end
+  end
+
+  describe "#to_xml" do
+    before do
+      @xml = Nokogiri::XML.parse(@workflow.to_xml)
+    end
+
+    it "should return valid XML" do
+      @xml.should be_an_instance_of(Nokogiri::XML::Document)
+    end
+
+    it "should have an <items> root" do
+      @xml.xpath('/items').size.should eq 1
+    end
+
+    it "should have an <item> per item in Workflow" do
+      @xml.xpath('/items/item').size.should eq @workflow.items.size 
+    end
+  end
+
+  describe "#output!" do
+    it "should output XML to the STDOUT" do
+      $stdout.should_receive(:puts).with(@workflow.to_xml)
+      @workflow.output!
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: alfredo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dennis Paagman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wrapper for Alfred 2's Workflows
+email:
+- dennispaagman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alfredo.gemspec
+- lib/alfredo.rb
+- lib/alfredo/item.rb
+- lib/alfredo/version.rb
+- lib/alfredo/workflow.rb
+- spec/alfredo_spec.rb
+- spec/item_spec.rb
+- spec/workflow_spec.rb
+homepage: ''
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Easy generation of XML responses usable in Alfred 2 Workflows
+test_files:
+- spec/alfredo_spec.rb
+- spec/item_spec.rb
+- spec/workflow_spec.rb