alfredlite 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+##### 0.1.0 (July 02, 2013) #####
+- initial release

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+group :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'coveralls'
+end

data/README.md

@@ -0,0 +1,76 @@
+[![Build Status](https://travis-ci.org/cjlucas/ruby-alfredlite.png?branch=master)](https://travis-ci.org/cjlucas/ruby-alfredlite)
+[![Build Status](https://travis-ci.org/cjlucas/ruby-alfredlite.png?branch=develop)](https://travis-ci.org/cjlucas/ruby-alfredlite)
+[![Gem Version](https://badge.fury.io/rb/alfredlite.png)](http://badge.fury.io/rb/alfredlite)
+
+AlfredLite is a lightweight modular framework for creating 
+[Alfred](http://www.alfredapp.com/) workflows.
+
+## Features ##
+ - Modular design
+   - Only load the modules your workflow uses
+   - Faster load times (execution speed is an underappreciated feature of any workflow)
+   - Less bundeled dependencies
+ - Subclassable workflows
+   - `Alfred::Workflow` is designed to be subclassed, the possibilities are endless!
+
+## Synopsis ##
+Here's a trivial example of a workflow that utilizes Alfred's feedback system:
+```ruby
+require 'alfredlite' # this loads the workflow module
+require 'alfredlite/feedback' # all submodules have to be loaded explicitly
+
+class ExampleWorkflow < Alfred::Workflow
+  BUNDLE_ID = 'net.cjlucas.alfred.example'
+
+  def intitialize
+    super(BUNDLE_ID)
+  end
+
+  def query(input)
+    # parse the user's input
+    data_array = get_imaginary_data(input)
+
+    # add new feedback items to array
+    data_array.each do |data|
+      # Alfred::Workflow#feedback_items and Alfred::Feedback::Item
+      # become available when the feedback module is loaded
+      feedback_items << Alfred::Feedback::Item.new.tap do |item|
+        item.title = data.info
+        item.subtitle = data.more_info
+        item.icon = '/path/to/icon.png'
+      end
+    end
+
+    # send our feedback_items to Alfred to be processed and displayed
+    puts feedback_items.to_xml
+  end
+end
+```
+
+Then we add a simple script for our Alfred workflow action
+```ruby
+require 'example_workflow'
+
+ExampleWorkflow.new.query("{query}")
+```
+
+
+## Requirements ##
+AlfredLite is tested against the following verions of Ruby:
+  - 1.8.7 (preinstalled on OS X Mountain Lion)
+  - 1.9.3
+  - 2.0.0 (preinstalled on OS X Mavericks)
+
+### Module-level dependencies ###
+- Workflow module
+  - None
+- Feedback module
+  - [REXML](http://www.germane-software.com/software/rexml/) (included with all versions of Ruby)
+
+## Contributing ##
+- Bug Fixes
+  - Reporting bugs is encouraged and greatly appreciated, send them [here](https://github.com/cjlucas/ruby-alfredlite/issues).
+  - If you're contributing a bug fix, please make sure you're committing your fixes on the `develop` branch 
+    (bonus points for creating a dedicated bug fix branch).
+- Feature Requests
+  - Have an idea that will help make writing your workflows easier? Then submit it [here](https://github.com/cjlucas/ruby-alfredlite/issues).

data/Rakefile

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+#require 'rubygems'
+#require 'bundler/setup'
+
+require 'rspec/core/rake_task'
+
+require 'alfredlite/version'
+
+task :default => [:spec]
+
+task :spec do
+  RSpec::Core::RakeTask.new do |task|
+    task.verbose = false
+    task.rspec_opts = '--color'
+  end
+end
+
+
+task :build do
+  system 'gem build alfredlite.gemspec'
+end
+
+task :release => :build do
+  system "gem push alfredlite-#{Alfred::VERSION}.gem"
+end
+
+task :clean do
+  system 'rm -f *.gem'
+end

data/alfredlite.gemspec

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+require 'alfredlite/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'alfredlite'
+  s.version     = Alfred::VERSION
+  s.summary     = 'AlfredLite is a lightweight modular framework for creating Alfred workflows.'
+  s.authors     = ['Chris Lucas']
+  s.email       = ['chris@chrisjlucas.com']
+  s.homepage    = 'https://github.com/cjlucas/ruby-alfredlite'
+  s.license     = 'MIT'
+  s.files       = `git ls-files | egrep '^[^\.]'`.split(/\r?\n/)
+  s.test_files  = s.files.select { |f| f.match(/^spec\/.*\.rb$/) }
+  s.platform    = Gem::Platform::RUBY
+end

data/lib/alfredlite.rb

@@ -0,0 +1 @@
+require 'alfredlite/workflow'

data/lib/alfredlite/feedback.rb

@@ -0,0 +1,115 @@
+require 'rexml/document'
+
+module Alfred
+  class Workflow
+    def feedback_items
+      @feedback_items ||= []
+    end
+
+    def feedback_xml
+      doc = REXML::Document.new
+      doc << REXML::Element.new('items')
+      feedback_items.each { |item| doc.root << item.to_xml }
+
+      doc
+    end
+  end
+end
+
+module Alfred
+  module Feedback
+    class Item
+      # Compatibility Note:
+      #   In Ruby 1.8, Object#type is defined, to workaround this the type 
+      #   attribute can be accessed via #item_type
+      ATTRIBUTES  = [:uid, :arg, :valid, :autocomplete, :item_type]
+      ATTRIBUTES_XML_MAP = {
+        :item_type => :type,
+      }
+      CHILD_NODES = {
+        :title => [], 
+        :subtitle  => [], 
+        :icon => [:type],
+      }
+
+      def initialize
+        @item_type = 'file'
+      end
+
+      def valid=(valid)
+        @valid = valid ? 'true' : 'false'
+      end
+
+      def to_xml
+        item_node = REXML::Element.new('item')
+        ATTRIBUTES.each do |attrib|
+          value = method(attrib).call
+          xml_attrib = ATTRIBUTES_XML_MAP.fetch(attrib, attrib)
+          #item_node[xml_attrib.to_s] = value unless value.nil?
+          item_node.add_attribute(xml_attrib.to_s, value) unless value.nil?
+        end
+
+        CHILD_NODES.each do |node_name, node_attribs|
+          value = method(node_name).call
+          unless value.nil?
+            item_node << REXML::Element.new(node_name.to_s).tap do |child|
+              child.text = value
+
+              node_attribs.each do |attrib|
+                attr = self.class.child_attribute_name(node_name, attrib)
+                value = method(attr).call
+                child.add_attribute(attr, value) unless value.nil?
+              end
+            end
+          end
+        end
+
+        item_node
+      end
+
+      private
+
+      # generate getters and setters
+      
+      def self.instance_method_exists?(method)
+        # In Ruby 1.8, Object.instance_methods returns and array of strings
+        # In Ruby 1.9+, it returns an array of symbols
+        method = RUBY_VERSION < '1.9' ? method.to_s : method.to_sym
+
+        instance_methods.include?(method)
+      end
+      
+      def self.child_attribute_name(child_node, attribute)
+        "#{child_node}_#{attribute}"
+      end
+
+      def self.getter_unless_exists(attr)
+        getter = attr.to_sym
+        attr_reader attr unless instance_method_exists?(getter)
+      end
+      
+      def self.setter_unless_exists(attr)
+        setter = "#{attr}=".to_sym
+        attr_writer attr unless instance_method_exists?(setter)
+      end
+
+      ATTRIBUTES.each do |attrib|
+        getter_unless_exists(attrib)
+        setter_unless_exists(attrib)
+      end
+
+      CHILD_NODES.each do |name, attribs|
+        getter_unless_exists(name)
+        setter_unless_exists(name)
+        
+        attribs.each do |attrib|
+          child_attribute_name(name, attrib).tap do |attr|
+            getter_unless_exists(attr)
+            setter_unless_exists(attr)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/alfredlite/version.rb

@@ -0,0 +1,10 @@
+module Alfred
+  class Version
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+  end
+ 
+  VERSION = [Version::MAJOR, Version::MINOR, Version::TINY].join('.')
+ 
+end

data/lib/alfredlite/workflow.rb

@@ -0,0 +1,34 @@
+require 'fileutils'
+
+module Alfred
+  class Workflow
+    CACHE_DIR = '/Library/Caches/com.runningwithcrayons.Alfred-2/Workflow Data'
+    DATA_DIR = '/Library/Application Support/Alfred 2/Workflow Data' 
+    attr_reader :bundle_id
+    
+    def initialize(bundle_id)
+      @bundle_id = bundle_id
+    end
+
+    def storage_path
+      @storage_path ||= File.join(ENV['HOME'], DATA_DIR, bundle_id)
+      self.class.mkdir(@storage_path)
+      @storage_path
+    end
+
+    def volatile_storage_path
+      @volatile_storage_path ||= File.join(ENV['HOME'], CACHE_DIR, bundle_id)
+      self.class.mkdir(@volatile_storage_path)
+      @volatile_storage_path
+    end
+
+    def query(input)
+    end
+
+    private
+    
+    def self.mkdir(path)
+      FileUtils.mkdir_p(path) unless File.exists?(path)
+    end
+  end
+end

data/spec/feedback_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+Item = Alfred::Feedback::Item
+
+describe Item do
+  it 'adds attributes and child nodes properly' do
+    item = Item.new.tap do |item|
+      item.title        = 'this is the title'
+      item.subtitle     = 'this is the subtitle'
+      item.arg          = 'this is the arg'
+      item.valid        = false
+      item.uid          = 'alfredlite-43223'
+      item.autocomplete = 'autocompleter'
+      item.icon         = '/path/to/icon.png'
+      item.icon_type    = 'fileicon'
+    end
+    xml = item.to_xml
+    
+    # check attributes
+    Item::ATTRIBUTES.each do |attrib|
+      xml_attrib = Item::ATTRIBUTES_XML_MAP.fetch(attrib, attrib)
+      xml.attributes[xml_attrib.to_s].should eq(item.method(attrib).call)
+    end
+
+    # child nodes
+    Item::CHILD_NODES.keys do |node_name|
+      nodes = xml.children.select {|child| child.name.eql?(node_name.to_s)}
+      nodes.count.should eq(1)
+      nodes.first.name.should eq(node_name)
+    end
+  end
+
+  #it "Doesn't add attributes and nodes that are nil" do
+    #item = Item.new
+  #end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+
+require 'rspec'
+require 'coveralls'
+
+require 'alfredlite'
+require 'alfredlite/feedback'
+
+Coveralls.wear!

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: alfredlite
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Lucas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-07-02 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+- chris@chrisjlucas.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- alfredlite.gemspec
+- lib/alfredlite.rb
+- lib/alfredlite/feedback.rb
+- lib/alfredlite/version.rb
+- lib/alfredlite/workflow.rb
+- spec/feedback_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/cjlucas/ruby-alfredlite
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: AlfredLite is a lightweight modular framework for creating Alfred workflows.
+test_files: 
+- spec/feedback_spec.rb
+- spec/spec_helper.rb