alphred 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10082ff7a1c31db5ad28cab456c3e7137548cf11
-  data.tar.gz: ee77fca7bd2179bfa450d5008076939d6bbbd5d2
+  metadata.gz: 6e16e15e9c29efb59e1db59f3c521e7434a72792
+  data.tar.gz: e9e42358283d6f3b43f89c7a5e93e658de747bdf
 SHA512:
-  metadata.gz: 25214cc2776cb407ca5a8d531045f66fbdbb7153e0a77240ab1fedc17432c4e92779498c744b0bc666dd3adad8761576fdfa87de8c95fa8bbf16926ebad97a8a
-  data.tar.gz: 88bad2ca507218e07f7c4ef74cd2386b399ac49730373645ed38a8d5c6ecd38283164d5ea435659acd7b229d99d42c2d29f694aa288db77e591dd19af44790de
+  metadata.gz: 5fc789dedf8233a24917d2084f4c8340525b97df36932036acccd1a9223299dd0fad05ec258c85cd5ecaa394c75c6ed5746b6df2ce9728d15eef64f0c0df64a0
+  data.tar.gz: b9bac5f7129ebf6f67488c318c5b8a200ed0cb2a819ffd87afa71786440482fac4b0a157f7a3040becfdf69365f0e1ff8e5b578a7af2232fbdde1d56de261300

data/Gemfile

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

data/README.md

@@ -86,34 +86,6 @@ 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

data/alphred.gemspec

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

data/lib/alphred.rb

@@ -1,11 +1,5 @@
-require "builder"
+require_relative 'alphred/version'
 
-require_relative "alphred/version"
-
-require_relative "alphred/config"
-require_relative "alphred/error"
-require_relative "alphred/icon"
-require_relative "alphred/item"
-require_relative "alphred/items"
-require_relative "alphred/mods"
-require_relative "alphred/text"
+require_relative 'alphred/error'
+require_relative 'alphred/item'
+require_relative 'alphred/items'

data/lib/alphred/error.rb

@@ -1,14 +1,16 @@
-require_relative "item"
-require_relative "items"
+require_relative 'item'
+require_relative 'items'
+
+require 'json'
 
 module Alphred
   class Error < StandardError
-    ASSETS = File.expand_path("../../../assets", __FILE__)
+    ASSETS = File.expand_path('../../../assets', __FILE__)
 
     def self.try
       yield
     rescue Exception => e
-      puts self.new(e).to_xml
+      print self.new(e).to_json
     end
 
     attr_reader :error
@@ -17,30 +19,32 @@ module Alphred
       @error = error
     end
 
+    def to_json(options=nil)
+      to_items.to_json(options)
+    end
+
     def to_items
-      icon = File.join(ASSETS, "close.png")
+      icon = File.join(ASSETS, 'close.png')
       items = [ Alphred::Item.new(title: "#{self.error.class}: #{self.error}",
                                   icon: icon) ]
       items.concat(self.backtrace_items)
-      Alphred::Items.new(*items)
-    end
-
-    def to_xml
-      self.to_items.to_xml
+      Items[*items]
     end
 
     def backtrace_items
-      icon = File.join(ASSETS, "more.png")
+      icon = File.join(ASSETS, 'more.png')
 
-      base_dirs = $LOAD_PATH + [ENV["alfred_preferences"]]
+      base_dirs = $LOAD_PATH + [ENV['alfred_preferences']]
       to_delete = /^#{base_dirs.join(?|)}/
 
-      self.error.backtrace.map {|line|
-        title = line.sub(to_delete, "...")
-        Alphred::Item.new(title: title,
-                          subtitle: line,
-                          arg: line,
-                          icon: icon)
+      self.error.backtrace.map { |line|
+        title = line.sub(to_delete, '...')
+        Item.new(
+          title: title,
+          subtitle: line,
+          arg: line,
+          icon: icon,
+        )
       }
     end
   end

data/lib/alphred/item.rb

@@ -1,59 +1,53 @@
-require "builder"
-
-require_relative "mods"
-require_relative "text"
+require_relative 'struct'
 
 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
+  class Item < Struct
+    attribute :valid, coerce: ->(x) { !!x }
+    attribute :uid
+    attribute :type,
+      coerce: ->(x) { x.to_s.gsub(?_, ?:) },
+      enum: %w[ default file file:skipcheck ]
+    attribute :title, required: true
+    attribute :subtitle
+    attribute :arg
+    attribute :autocomplete
+    attribute :icon, coerce: ->(x) { Icon(x) }
+    attribute :quicklookurl
+    attribute :mods, coerce: ->(x) { Mods.new(x) }
+    attribute :text, coerce: ->(x) { Text.new(x) }
+  end
 
-    def type=(type)
-      raise ArgumentError.new("`type` must be one of #{VALID_TYPES}") unless type.nil? || VALID_TYPES.include?(type)
+  class Icon < Struct
+    attribute :type, enum: %i[ fileicon filetype ]
+    attribute :path, required: true
+  end
 
-      @type = type
-    end
+  class Mod < Struct
+    attribute :valid, coerce: ->(x) { !!x }
+    attribute :arg
+    attribute :subtitle
+  end
 
-    def type
-      @type && @type.to_s.gsub(?_, ?:)
-    end
+  class Mods < Struct
+    attribute :ctrl, coerce: ->(x) { Mod.new(x) }
+    attribute :alt, coerce: ->(x) { Mod.new(x) }
+    attribute :cmd, coerce: ->(x) { Mod.new(x) }
+    attribute :fn, coerce: ->(x) { Mod.new(x) }
+    attribute :shift, coerce: ->(x) { Mod.new(x) }
+  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
+  class Text < Struct
+    attribute :copy
+    attribute :largetype
+  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
+module Kernel
+  def Icon(arg)
+    case arg
+    when Alphred::Icon then arg
+    when String        then Alphred::Icon.new(path: arg)
+    when Hash          then Alphred::Icon.new(**arg)
     end
   end
 end

data/lib/alphred/items.rb

@@ -1,8 +1,13 @@
-require "builder"
-require "delegate"
+require 'delegate'
+
+require 'json'
 
 module Alphred
   class Items < DelegateClass(Array)
+    def self.[](*args)
+      new(*args)
+    end
+
     attr_reader :items
 
     def initialize(*items)
@@ -10,14 +15,8 @@ module Alphred
       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
+    def to_json(options=nil)
+      { items: items }.to_json(options)
     end
   end
 end

data/lib/alphred/struct.rb

@@ -0,0 +1,71 @@
+require 'json'
+
+module Alphred
+  class Struct
+    class RequiredAttributeError < StandardError; end
+    class InvalidEnumError < StandardError; end
+    class InvalidAttributeError < StandardError; end
+
+    def self.attribute(name, **options)
+      attributes << Attribute.new(name, **options)
+
+      define_method(name) do
+        attributes[name]
+      end
+    end
+
+    def self.attributes
+      return @attributes if defined?(@attributes)
+      @attributes = []
+    end
+
+    attr_reader :attributes
+
+    def initialize(**input)
+      validate_input(input)
+
+      @attributes = self.class.attributes.select { |attr|
+        attr.required? || input.keys.include?(attr.name)
+      }.reduce({}) { |hash, attr|
+        hash.merge(attr.value_from(input))
+      }
+    end
+
+    def to_json(options=nil)
+      attributes.to_json(options)
+    end
+
+    private
+
+    def validate_input(input)
+      attribute_names = self.class.attributes.map(&:name)
+      invalid_keys = input.keys.reject {|key| attribute_names.include?(key) }
+      unless invalid_keys.empty?
+        msg = "Invalid attribute(s): #{invalid_keys.join(', ')}"
+        raise InvalidAttributeError.new(msg)
+      end
+    end
+
+    class Attribute
+      attr_reader :name, :coerce, :enum
+
+      def initialize(name, **options)
+        @name = name
+        @required = options.fetch(:required, false)
+        @coerce = options.fetch(:coerce, ->(x) { x })
+        @enum = options[:enum]
+      end
+
+      def required?
+        !!@required
+      end
+
+      def value_from(hash)
+        uncoerced = hash.fetch(name) { raise RequiredAttributeError.new(name) }
+        coerced = coerce.call(uncoerced)
+        raise InvalidEnumError.new(coerced) if enum && !enum.include?(coerced)
+        { name => coerced }
+      end
+    end
+  end
+end

data/lib/alphred/version.rb

@@ -1,3 +1,3 @@
 module Alphred
-  VERSION = '1.2.2'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alphred
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Alpha Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -52,6 +52,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -87,16 +101,13 @@ files:
 - assets/close.png
 - assets/more.png
 - lib/alphred.rb
-- lib/alphred/config.rb
 - lib/alphred/error.rb
-- lib/alphred/icon.rb
 - lib/alphred/item.rb
 - lib/alphred/items.rb
-- lib/alphred/mods.rb
+- lib/alphred/struct.rb
 - lib/alphred/tasks.rb
-- lib/alphred/text.rb
 - lib/alphred/version.rb
-homepage: https://github.com/kejadlen/alph
+homepage: https://github.com/kejadlen/alphred
 licenses:
 - MIT
 metadata: {}

data/lib/alphred/config.rb

@@ -1,59 +0,0 @@
-require 'fileutils'
-require 'json'
-
-module Alphred
-  class Config
-    def self.load(**defaults)
-      config = 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!
-      return unless File.exist?(path)
-      data.merge!(JSON.load(File.open(path)))
-    end
-
-    def update!(json)
-      data = self.data.merge(JSON.load(json))
-      FileUtils.mkdir_p(File.dirname(path))
-      File.write(path, JSON.dump(data), mode: ?w)
-    end
-
-    def [](key)
-      data[key.to_s]
-    end
-
-    def filter_xml(filter=nil)
-      filter ||= ''
-
-      items = 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
-
-    private
-
-    def path
-      File.join(ENV['alfred_workflow_data'], 'config.json')
-    end
-  end
-end

data/lib/alphred/icon.rb

@@ -1,39 +0,0 @@
-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/mods.rb

@@ -1,22 +0,0 @@
-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/text.rb

@@ -1,17 +0,0 @@
-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