alfredo 0.0.1 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODViMmFhNjU4ZmRjMGI5OGMxZDM0Yzc5NWJiOWUyMzZhMGY1NzRjNQ==
+    ODdiNzA4YzAzYTgyZTRiNGJiZGQ1NjQ5ZWY0MWIwNmY4ZTU1NWZkMQ==
   data.tar.gz: !binary |-
-    NzY3MTk2YzU4YTI4MTc5MjNlYzM5NjY2ZjFlYWE0NWJmNjJjYjcwNg==
+    YjBhNGFmODViYTFmZmUzY2MyMmE2YTA3NmRhNWUwN2QyMzE5NThkMg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MjhiOTE0OGNhZWY2YTIwMWUwNmZmNWMxMTc1ZjUzODdjZDY5YmRmZTU4ZDNl
-    ZjBmYzg0YWExOWJmMGM0NjJmYzIzYmMyN2MzMWE0N2Q2ZWM2Zjk1ZWMxNTVi
-    ZWQ1NTQxNWM0NjllYjk0N2I5ZmMzOGNhM2QzZDRhYTIxMjg2YTQ=
+    Yjc5YjZjNGY3MDQ1ODc2ZjZjMTc2Yzc0NDhhMWRjNzBlMTY5NzcyODMxYmNj
+    Y2UzY2E0OWYzNGFhNjdiOWY3MDQ2MTVkZDBmYjRjZjEzNDBhY2MxYTQwNzQ1
+    YTMyMmI2NjM0MjljYzMyOTQ5NGM3YzJlOTc1ZTljMTZmOTliYTY=
   data.tar.gz: !binary |-
-    ODY1NjU3Nzg1YTU0MjdhMzI2MjI3NjVmZTFlNjYxMDc3ZTk5MWZmMmY4ZTVj
-    Y2ZiZGNhMzk0YjViNjc5MzU0NjY3YjE2YTg5NzQ3OTFiYTMxMGVmZTM0Y2E5
-    YjlmMGRkMDgwMTM0ZGE2NjgxOGEwMDA0MGNhZDBhZDM4MTU3MDU=
+    ODA1ZTk2ODZiYjAxOWNiZWNkMTdhNjEyNTAwNjQ2NDlmM2ZhOGI1NjI0ODFj
+    ZjBkYzdlMjRjYzVkZWNjMDk2MjE4MmI2ZmVlNmIyOWE0NzNiZTcxM2EwOTFk
+    ODViZjZiOWU2NzNlMTMyYzA2N2YxOWEzZjU4ZWIwMzVlNDVmOGI=

data/README.md

@@ -1,10 +1,8 @@
 # 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. 
+XML response based on the information in the [Alfred
+Forums](http://www.alfredforum.com/topic/5-generating-feedback-in-workflows/).
 
 ## Installation
 
@@ -29,13 +27,18 @@ workflow.output!
 
 Parameters available for `Alfredo::Item.new` are:
 
-* ``title``
-* `subtitle`
+* `title` (shown in large text in the results)
+* `subtitle` (shown under the title in smaller text)
 * `arg` (argument that can be passed on to next steps in the workflow)
-* `uid`
-* `icon_path` (path of icon, relative to workflow directory)
+* `uid` (value that Alfred uses to learn about your usage)
+* `icon_path` (path of icon or file, relative to workflow directory)
 * `icon_type`
-* `type`
+  *  `fileicon` (uses the icon associated with a file)
+  *  `filetype` (uses the icon associated with the type of a file)
+* `type` (when `file` allows result action for files)
+
+More info is available at the [Alfred
+Forums](http://www.alfredforum.com/topic/5-generating-feedback-in-workflows/).
 
 ## Contributing
 

data/lib/alfredo/item.rb

@@ -1,6 +1,6 @@
 module Alfredo
   class Item
-    attr_accessor :title, :subtitle, :arg, :uid, :icon_path, :icon_type, :type
+    attr_accessor :title, :subtitle, :arg, :uid, :icon_path, :icon_type, :type, :valid, :autocomplete
 
     def initialize(attributes = {})
       attributes.each do |attribute,value|
@@ -9,26 +9,44 @@ module Alfredo
     end
 
     def uid
-      @uid || "#{title}_#{Time.now.to_i}"
+      @uid || title
     end
 
     def icon_type
-      @icon_type || 'default'
+      @icon_type if %w{fileicon filetype}.include? @icon_type
     end
     
+    def valid
+      if @valid == false
+        'no'
+      else
+        'yes'
+      end
+    end
+
+    def autocomplete
+      @autocomplete || title
+    end
+
     def type
-      @type || 'default'
+      @type if @type == 'file'
     end
 
     def build_xml
       Nokogiri::XML::Builder.new do |xml|
-        xml.item(arg: arg, uid: uid, valid: 'yes') {
+        xml.item(arg: arg, uid: uid, valid: valid, autocomplete: autocomplete) {
           xml.title title
           xml.subtitle subtitle
-          xml.icon(type: icon_type) {
-            xml.text icon_path
-          }
-          xml.type type
+          if icon_path
+            if icon_type
+              xml.icon(type: icon_type) {
+                xml.text icon_path
+              }
+            else
+              xml.icon icon_path
+            end
+          end
+          xml.type type if type
         }
       end.doc.children.first
     end

data/lib/alfredo/version.rb

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

data/spec/item_spec.rb

@@ -3,7 +3,7 @@ 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')
+      @item = Alfredo::Item.new(title: 'foo', subtitle: 'bar', arg: 'baz', uid: 123, icon_path: 'icon.png', icon_type: 'fileicon', type: 'file', autocomplete: 'moo')
 
       @xml = @item.build_xml
     end
@@ -24,31 +24,54 @@ describe 'Alfredo::Item' do
       @xml.xpath('/item/@uid').first.text.should eq '123'
     end
 
-    it 'should generate uid when not set' do
+    it 'should set uid to title when uid not set' do
       @item.uid = nil
-      @item.build_xml.xpath('/item/@uid').first.text.should match /#{@item.title}_[0-9]+/
+      @item.build_xml.xpath('/item/@uid').first.text.should eq @item.title
     end
 
-    it 'should set icon_path' do
+    it 'should set icon to icon_path' do
       @xml.xpath('/item/icon').first.text.should eq 'icon.png'
     end
 
-    it 'should set icon_type' do
+    it 'should not set icon when no icon_path not present' do
+      @item.icon_path = nil
+      @item.build_xml.xpath('/item/icon').size.should eq 0
+    end
+
+    it 'should set icon_type for fileicon' do
       @xml.xpath('/item/icon/@type').first.text.should eq 'fileicon'
     end
 
-    it 'should use default icon_type when not set' do
+    it 'should set icon_type for filetype' do
+      @item.icon_type = 'filetype'
+      @item.build_xml.xpath('/item/icon/@type').first.text.should eq 'filetype'
+    end
+
+    it 'should not set icon_type when invalid' do
       @item.icon_type = nil
-      @item.build_xml.xpath('/item/icon/@type').first.text.should eq 'default'
+      @item.build_xml.xpath('/item/icon/@type').size.should eq 0
     end
 
-    it 'should set type' do
+    it 'should set type only when its file' 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'
+    it 'should not set type when its invalid' do
+      @item.type = 'foo'
+      @item.build_xml.xpath('/item/type').size.should eq 0
+    end
+
+    it 'should set valid to yes by default' do
+      @xml.xpath('/item/@valid').first.text.should eq 'yes'
+    end
+
+    it 'should set valid to no if its false' do
+      @item.valid = false
+      @item.build_xml.xpath('/item/@valid').first.text.should eq 'no'
+    end
+
+    it 'should set autocomplete' do
+      @xml.xpath('/item/@autocomplete').first.text.should eq 'moo'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alfredo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Dennis Paagman