things_templates 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56793d5a794adbf6f1a21fa3c818d470b4e72943
+  data.tar.gz: bc72bf3e7a53b7c46266ff009e7abe1cc2762b6e
+SHA512:
+  metadata.gz: ec173eef6819ac02c0c635d35de9beed28825ddb49fea7b776e09b353456a0d2dcda1ea975b074b2127d4907360025c5bf6740161e7c6af6aacd40cdb78c28a7
+  data.tar.gz: e2ab2cce281f45287e380140d14c7d575227c3c0a0719a91da2f0800ae1f0356992b8d39ef4477f442c5124b2d697abc82a7b6ea3ab7c7fa404f2dc686a94d6e

data/.cane

@@ -0,0 +1,5 @@
+--no-doc
+--style-measure 100
+--abc-max 8
+--abc-glob {rakefile,Gemfile,**/*.{rb,rake}}
+--style-glob {rakefile,Gemfile,**/*.{rb,rake}}

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in things_templates.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Svenningsen
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# Things Templates
+
+An easy(?) way to save templates for Things.app. These can include projects or
+items that you often find yourself creating over and over together.
+Example: a template might include the ingredients needed for a particular
+recipe that you want to add to a grocery list.
+
+## Installation
+`$ gem install things_templates`
+
+## Usage
+`$ build_template <path to template>`
+
+## Template Format
+```
+project: 'Project Name' <optional>
+tags:
+  - 'Tag 1'
+  - 'Tag 2'
+items:
+  - 'Item 1'
+  - 'Item 2'
+```
+Tags will be applied to all items. If a project of the same name already exists,
+the existing project will be used.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Write tests (I'm using RSpec in the `spec` folder)
+5. Make sure all tests pass
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/build_template

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'things_templates'
+rescue
+  require 'rubygems'
+  require 'things_templates'
+end
+
+template = Template.new(ARGV[0])
+template.build!

data/lib/things_templates.rb

@@ -0,0 +1,7 @@
+require "things_templates/version"
+require "things_templates/template"
+require "things_templates/things_controller"
+
+module ThingsTemplates
+  # Your code goes here...
+end

data/lib/things_templates/template.rb

@@ -0,0 +1,22 @@
+require 'yaml'
+
+class Template
+  attr_reader :items, :project, :tags
+
+  def initialize(file)
+    yaml = YAML.load(File.open(file))
+    @items = yaml['items']
+    @project = yaml.fetch('project', nil)
+    @tags = yaml.fetch('tags', nil)
+  end
+
+  def build!
+    if project
+      ThingsController.add_items_to_project(project, items, tags)
+    else
+      items.each do |item|
+        ThingsController.add_item(item)
+      end
+    end
+  end
+end

data/lib/things_templates/things_controller.rb

@@ -0,0 +1,67 @@
+class ThingsController
+  class << self
+    def add_item(item)
+      command = [base_command, add_item_command(item), end_command].join("\n")
+      system(command)
+    end
+
+    def add_project(project)
+      unless project_exists?(project)
+        command_list = [base_command, add_project_command(project), end_command]
+        command = command_list.join("\n")
+        system(command)
+      end
+    end
+
+    def add_items_to_project(project, items, tags=nil)
+      add_project(project) unless project_exists?(project)
+      commands = [base_command]
+      items.each do |item|
+        commands << add_item_command(item, project, tags)
+      end
+      commands << end_command
+      command = commands.join("\n")
+      system(command)
+    end
+
+    private
+
+    def project_exists?(project)
+      command = """
+        set foundProject to project \"#{project}\"\n
+        if status of foundProject is completed then\n
+          return false\n
+        else\n
+          return true\n
+        end if\n
+      """
+      command_list = [base_command, command, end_command].join("\n")
+      response = `#{command_list}`
+      return false unless response.include?("true") || response.include?("Can't get project")
+      true
+    end
+
+    def add_item_command(item, project=nil, tags=nil)
+      base_add = "set newToDo to make new to do with properties {name:\"#{item}\" }"
+      base_add += " at beginning of project \"#{project}\"" if project
+      base_add += tags_command(tags) if tags
+      base_add
+    end
+
+    def add_project_command(project)
+      "set newProject to make new project with properties {name:\"#{project}\"}"
+    end
+
+    def base_command
+      "osascript -e 'tell application \"Things\""
+    end
+
+    def end_command
+      "end tell'"
+    end
+
+    def tags_command(tags)
+      "\nset tag names of newToDo to \"#{tags.join(', ')}\""
+    end
+  end
+end

data/lib/things_templates/version.rb

@@ -0,0 +1,3 @@
+module ThingsTemplates
+  VERSION = "0.2.0"
+end

data/spec/files/test_template.yml

@@ -0,0 +1,3 @@
+items:
+  - test_item_1
+  - test_item_2

data/spec/files/test_template_with_project.yml

@@ -0,0 +1,7 @@
+project: test_project
+tags:
+  - tag_1
+  - tag_2
+items:
+  - test_item_1
+  - test_item_2

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'things_templates'

data/spec/template_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Template do
+  let(:file_path) { 'spec/files/test_template.yml' }
+
+  subject { Template.new file_path }
+
+  describe '.initialize' do
+    let(:items) { ['test_item_1', 'test_item_2'] }
+
+    it 'loads the given file' do
+      expect(subject.items).to eq items
+    end
+  end
+
+  describe '#build' do
+    before { ThingsController.stub(:add_item) }
+
+    context 'with an item list template' do
+      before { subject.build! }
+
+      it 'adds a Things item for each item' do
+        expect(ThingsController).to have_received(:add_item).with('test_item_1')
+        expect(ThingsController).to have_received(:add_item).with('test_item_2')
+      end
+    end
+
+    context 'with a project list template with tags' do
+      let(:file_path) { 'spec/files/test_template_with_project.yml' }
+
+      before { ThingsController.stub(:add_items_to_project) }
+      before { subject.build! }
+
+      it 'creates a project' do
+        expect(ThingsController).to have_received(:add_items_to_project)
+          .with('test_project', ['test_item_1', 'test_item_2'], ['tag_1', 'tag_2'])
+      end
+
+      it 'adds a Things item for each item' do
+        expect(ThingsController).to_not have_received(:add_item)
+      end
+    end
+  end
+end

data/spec/things_controller_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe ThingsController do
+  describe '.add_item' do
+    let(:new_item) { 'new item' }
+    before { ThingsController.stub(:system) }
+    before { ThingsController.add_item(new_item) }
+
+    it 'calls the add script with the item' do
+      expect(ThingsController).to have_received(:system)
+        .with(/.*#{new_item}.*/)
+    end
+  end
+
+  describe '.add_project' do
+    let(:new_project) { 'new project' }
+
+    subject { ThingsController.add_project new_project }
+
+    before { ThingsController.stub(:system) }
+
+    context 'given the project does not exist' do
+      before { ThingsController.stub(:project_exists?).and_return(false) }
+      before { subject }
+
+      it 'creates the project' do
+        expect(ThingsController).to have_received(:system)
+          .with(/.*#{new_project}.*/)
+      end
+    end
+
+    context 'given the project already exists' do
+      before { ThingsController.stub(:project_exists?).and_return(true) }
+
+      it 'does not create the project' do
+        expect(ThingsController).to_not have_received(:system)
+      end
+    end
+  end
+
+  describe '.add_items_to_project' do
+    let(:new_item)    { 'new item' }
+    let(:new_project) { 'new project' }
+    let(:tags)        { nil }
+
+    subject { ThingsController.add_items_to_project(new_project, [new_item], tags) }
+
+    before { ThingsController.stub(:system) }
+
+    context 'given the project exists' do
+      before { ThingsController.stub(:project_exists?).and_return(true) }
+      before { subject }
+
+      it 'calls the add script with the item and project' do
+        expect(ThingsController).to have_received(:system)
+          .with(/.*#{new_item}.*#{new_project}.*/)
+      end
+
+      context 'given tags' do
+        let(:tags) { ['best', 'ever'] }
+
+        it 'calls the add script with the item, project and tags' do
+          expect(ThingsController).to have_received(:system)
+            .with(/.*#{new_item}.*#{new_project}.*#{tags.join(', ')}.*/)
+        end
+      end
+    end
+
+    context 'given the project does not exist' do
+      before { ThingsController.stub(:project_exists?).and_return(false) }
+
+      it 'creates the project and item' do
+        expect(ThingsController).to receive(:system)
+          .with(/.*#{new_project}.*/).ordered
+
+        expect(ThingsController).to receive(:system)
+          .with(/.*#{new_item}.*#{new_project}.*/).ordered
+
+        subject
+      end
+    end
+  end
+end

data/things_templates.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'things_templates/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "things_templates"
+  spec.version       = ThingsTemplates::VERSION
+  spec.authors       = ["Chris Svenningsen"]
+  spec.email         = ["crsven@gmail.com"]
+  spec.description   = "Templating for Things.app"
+  spec.summary       = "Easy(?) templating for Things.app. Create and build templates of projects, items and tags."
+  spec.homepage      = "https://github.com/crsven/things_templates"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "cane"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: things_templates
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Chris Svenningsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Templating for Things.app
+email:
+- crsven@gmail.com
+executables:
+- build_template
+extensions: []
+extra_rdoc_files: []
+files:
+- .cane
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/build_template
+- lib/things_templates.rb
+- lib/things_templates/template.rb
+- lib/things_templates/things_controller.rb
+- lib/things_templates/version.rb
+- spec/files/test_template.yml
+- spec/files/test_template_with_project.yml
+- spec/spec_helper.rb
+- spec/template_spec.rb
+- spec/things_controller_spec.rb
+- things_templates.gemspec
+homepage: https://github.com/crsven/things_templates
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.9
+signing_key: 
+specification_version: 4
+summary: Easy(?) templating for Things.app. Create and build templates of projects,
+  items and tags.
+test_files:
+- spec/files/test_template.yml
+- spec/files/test_template_with_project.yml
+- spec/spec_helper.rb
+- spec/template_spec.rb
+- spec/things_controller_spec.rb