alphred 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77df5b167e6b68eefafefb3f08dcdbd46e8c85f1
-  data.tar.gz: 2d49a6168923b37774912de965d24a83c2bee14e
+  metadata.gz: 795eb675cd111730b33cab166f6e9787971eee70
+  data.tar.gz: 688aa2fc538532b9e545fe51618a42e3af931da9
 SHA512:
-  metadata.gz: 43dcc97756b74b7e1bd4d0db36a5f100871484f2ac20199b01df16b853d31d82e534c435dbeeca8cfdf6c53528dc78829130beb533c894e7079a6353ca482e7d
-  data.tar.gz: ac1a78c4642b4cbb625160e3a27e7a4d089cc80f2af36470642e3b9664dbf63c0490a65575bc4bf690a7d8dd47514b19694d409182e2fa3c78c724c18bfb77a2
+  metadata.gz: b8f23d077d9e757647dcd9f159b3affaf4b44fe874d80244293f8aa62a440f56a0e399fc5a51531e02150700033058c13ef1005aaccf64e535f9a2c4fa8e2391
+  data.tar.gz: 143b5a4a6ebf396baeeac8f4eed372236efbd2896b0e457740dbb32c8b278e5f0438ed0edac14d1d422a638f735e3aedf3447d52c2c57a66985ae6cf1d9cfd76

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## Unreleased
+
+## [1.1.0] - 2015-11-01
+
+### Added
+- `Config` class for handling persistent configuration across workflow updates.
+- CHANGELOG
+
+## [1.0.0] - 2015-10-31
+
+### Added
+- Library for making Alfred workflows.

data/README.md

@@ -86,6 +86,34 @@ This produces the following XML:
 </items>
 ```
 
+### Workflow Configuration
+
+`Alphred::Config` provides some helpers for managing configuration that should
+persist when updating the workflow. This configuration is stored in an JSON
+file in the workflow data directory.
+
+``` ruby
+# config.rb
+
+module Workflow
+  defaults = { foo: "bar" }
+  Config = Alphred::Config.new(**defaults)
+```
+
+The corresponding Script Filter input and Run Action output then look like this:
+
+``` shell
+# script filter
+
+ruby -r./config -e'puts Workflow::Config.filter_xml("{query}")'
+```
+
+``` shell
+# run action
+
+ruby -r./config -e'Forecast::Config.update!("{query}")'
+```
+
 ### Releasing
 
 Including `alphred/tasks` in your `Rakefile` will allow access to Alphred's
@@ -95,7 +123,7 @@ dependencies.
 
 ## TODO
 
-- Make workflow configuration easier.
+- Add development mode for easier debugging. (Nicer errors, etc.)
 
 ## Development
 

data/lib/alphred.rb

@@ -2,6 +2,7 @@ require "builder"
 
 require_relative "alphred/version"
 
+require_relative "alphred/config"
 require_relative "alphred/icon"
 require_relative "alphred/item"
 require_relative "alphred/items"

data/lib/alphred/config.rb

@@ -0,0 +1,52 @@
+require "json"
+
+module Alphred
+  class Config
+    PATH = File.join(ENV["alfred_workflow_data"], 'config.json')
+
+    def self.load(**defaults)
+      config = self.new(**defaults)
+      config.load!
+      config
+    end
+
+    attr_reader :data
+
+    def initialize(**defaults)
+      @data = Hash[defaults.map {|k,v| [k.to_s, v.to_s] }]
+    end
+
+    def load!
+      self.data.merge!(JSON.load(File.open(PATH)))
+    end
+
+    def update!(json)
+      data = self.data.merge(JSON.load(json))
+      File.write(PATH, JSON.dump(data), mode: ?w)
+    end
+
+    def [](key)
+      self.data[key.to_s]
+    end
+
+    def filter_xml(filter=nil)
+      filter ||= ""
+
+      items = self.data.map do |key, value|
+        title = if filter.empty?
+                  "Unset #{key}"
+                else
+                  "Set #{key} to #{filter}"
+                end
+        Item.new(
+          uid: key,
+          arg: JSON.dump(key => filter),
+          title: title,
+          subtitle: self[key]
+        )
+      end
+
+      Items.new(*items).to_xml
+    end
+  end
+end

data/lib/alphred/items.rb

@@ -1,4 +1,5 @@
 require "builder"
+require "delegate"
 
 module Alphred
   class Items < DelegateClass(Array)

data/lib/alphred/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alphred
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alpha Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-31 00:00:00.000000000 Z
+date: 2015-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -83,6 +84,7 @@ files:
 - Rakefile
 - alphred.gemspec
 - lib/alphred.rb
+- lib/alphred/config.rb
 - lib/alphred/icon.rb
 - lib/alphred/item.rb
 - lib/alphred/items.rb