alfred-workflow 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
-SHA1: 
-  metadata.gz: 8b3c5fffe416e05c99f4baad880f92456cc10fd8
-  data.tar.gz: 55a135c15ccf8448be4ffdd421537dfd05d6f6c9
 SHA512: 
-  metadata.gz: e82a150c2e4d388fbcbe4f60436777fb70091810f4c7188592bcf73f62cf3e391f58565ba7584ed466ef60c1067579cda5dd1c9f5667dd305d4c9690a3b959e5
-  data.tar.gz: 1d23f9683615bcc24164e2e039eb719ec56cba0348d3ab2d50dfe8161aa02552c3f352cb87baf5dc6b72fbb25517c0861aab131b93ef7bdfb440bab61fd97b57
+  data.tar.gz: 23623140489e12203cca05b87d40364423b37f3e01ade13d1df9909566feaf9a5304e1e3d5803228787791114ba1402f0e8b5654e5e4cb4f9ea14f59059fe844
+  metadata.gz: 32d00acc1222bc5d87b257a8304e3055a3e2b87bfa1ed6bb150cc8c6ad5e48c51ae92bae30625cf7c59c90e3b87656b3fcb78d9580e568217ed2b3eabcbbfcc4
+SHA1: 
+  data.tar.gz: eefe1cd9415f97fa9130ec19d2fa22776a432ca4
+  metadata.gz: 51f3ad55e83b3a4e16f90ec9f956b0391bf8267c

data/README.md

@@ -15,13 +15,13 @@ alfred-workflow is a ruby Gem helper for building [Alfred](http://www.alfredapp.
 
 * Use standard [bundler][gembundler] 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.
-* Functions to simplify saving and retrieving settings.
 
 ## SYNOPSIS:
 

data/lib/alfred.rb

@@ -81,6 +81,10 @@ module Alfred
       @setting ||= Setting.new(self)
     end
 
+    def with_cached_feedback(&blk)
+      @feedback = CachedFeedback.new(self, &blk)
+    end
+
     def feedback
       raise NoBundleIDError unless bundle_id
       @feedback ||= Feedback.new
@@ -115,7 +119,6 @@ module Alfred
     end
 
 
-
     def rescue_feedback(opts = {})
       default_opts = {
         :title    => "Failed Query!",

data/lib/alfred/feedback.rb

@@ -33,15 +33,45 @@ module Alfred
 
 
     # serialize
-    def dump(fbfile)
-      File.open(fbfile, "wb") { |f| Marshal.dump(self, f) }
+    def dump(to_file)
+      File.open(to_file, "wb") { |f| Marshal.dump(self, f) }
     end
 
     class << self
-      def load(fbfile)
-        File.open(fbfile, "rb") { |f| Marshal.load(f) }
+      def load(from_file)
+        File.open(from_file, "rb") { |f| Marshal.load(f) }
       end
     end
   end
 
+
+  class CachedFeedback < Feedback
+    def initialize(alfred, &blk)
+      super()
+      @core = alfred
+
+      instance_eval(&blk) if block_given?
+    end
+
+    def use_cache_file(opts = {})
+      @cf_file = opts[:file] if opts[:file]
+      @cf_file_valid_time = opts[:expire] if opts[:expire]
+    end
+
+    def cache_file
+      @cf_file ||= File.join(@core.volatile_storage_path, "cached_feedback")
+    end
+    def get_cached_feedback
+      return nil unless File.exist?(cache_file)
+      if @cf_file_valid_time
+        return nil if Time.now - File.ctime(cache_file) > @cf_file_valid_time
+      end
+      Feedback.load(@cf_file)
+    end
+
+    def put_cached_feedback
+      dump(cache_file)
+    end
+  end
+
 end

data/lib/alfred/version.rb

@@ -1,3 +1,3 @@
 module Alfred
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/spec/feedback_spec.rb

@@ -8,6 +8,7 @@ describe "Feedback" do
     @item_elements = %w{title subtitle icon}
     @item_attributes = %w{uid arg autocomplete}
   end
+
   it "should create a basic XML response" do
     @feedback.add_item(:uid          => "uid"          ,
                        :arg          => "arg"          ,
@@ -26,19 +27,7 @@ describe "Feedback" do
       </items>
     END
 
-    expected_xml = REXML::Document.new(xml_data)
-    feedback_xml = REXML::Document.new(@feedback.to_xml)
-
-    expected_item = expected_xml.get_elements('/items/item')[0]
-    feedback_item = feedback_xml.get_elements('/items/item')[0]
-
-    @item_elements.each { |i|
-      expected_item.elements[i].text.should == feedback_item.elements[i].text
-    }
-    @item_attributes.each { |i|
-      expected_item.attributes[i].should == feedback_item.attributes[i]
-    }
-
+    compare_xml(xml_data, @feedback.to_xml).should == true
   end
 
 end

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require "rspec"
+require 'awesome_print'
+require 'zucker/debug'
+
 require "alfred"
 
 RSpec.configure do |c|
@@ -20,3 +23,27 @@ class String
     gsub(/^[ \t]{#{indent}}/, '')
   end
 end
+
+
+def compare_xml(expected_xml_data, feedback_xml_data)
+  item_elements = %w{title subtitle icon}
+  item_attributes = %w{uid arg autocomplete}
+
+  expected_xml = REXML::Document.new(expected_xml_data)
+  feedback_xml = REXML::Document.new(feedback_xml_data)
+
+  expected_item = expected_xml.get_elements('/items/item')[0]
+  feedback_item = feedback_xml.get_elements('/items/item')[0]
+
+  item_elements.each { |i|
+    unless expected_item.elements[i].text.eql? feedback_item.elements[i].text
+      return false
+    end
+  }
+  item_attributes.each { |i|
+    unless expected_item.attributes[i].eql? feedback_item.attributes[i]
+      return false
+    end
+  }
+  true
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: alfred-workflow
 version: !ruby/object:Gem::Version 
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors: 
 - Zhao Cai