expandsync 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee8ddf4aacd31807cb6112c1f1b21107236acdfa
+  data.tar.gz: 91ea767a37797fe7b06a376350cc5c16b2974a1f
+SHA512:
+  metadata.gz: 95fb60d96619e13024f7d3c3213b9e4a9df03185ffdbc0972bdebf1cd6acb368e1ea593d389d9cae1d3fdf2939ab6fd9ffa9fbcc07efe9a61be50fd6474fe602
+  data.tar.gz: 68ac78ebf1423078dd62e0489fdc952bd36b9163e51e48a54076b268ccbaf7ff9980dc4ac412c47550774f921b9a0bf3e9189fad37a429c5d7b6ad5b0c016339

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+results.html
+pkg
+html

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    expandsync (0.1.0)
+      methadone (~> 1.3.1)
+      nokogiri (~> 1.6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.4)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.5.1)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.3.11)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.5)
+    ffi (1.9.3)
+    gherkin (2.12.2)
+      multi_json (~> 1.3)
+    json (1.8.1)
+    methadone (1.3.2)
+      bundler
+    mini_portile (0.5.2)
+    multi_json (1.9.0)
+    multi_test (0.0.3)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    nori (2.3.0)
+    rake (0.9.6)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler (~> 1.5)
+  expandsync!
+  nori
+  rake (~> 0.9.2)
+  rdoc

data/HISTORY.md

@@ -0,0 +1,3 @@
+# 0.1.0 (2014-03-12)
+
+* Initial release of ExpandSync

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Aaron Bach
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aaron Bach
+
+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,32 @@
+ExpandSync
+==========
+
+A simple engine to sync aText and TextExpander iOS.
+
+# Installation
+
+    $ gem install expandsync
+
+# Usage
+
+TODO: Write usage instructions here
+
+# Contributing
+
+1. Fork it ( http://github.com/bachya/expandsync/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+# License
+
+(The MIT License)
+
+Copyright © 2014 Aaron Bach bachya1208@gmail.com
+
+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.rdoc

@@ -0,0 +1,19 @@
+= expandsync - DESCRIBE YOUR GEM
+
+Author::  YOUR NAME (YOUR EMAIL)
+Copyright:: Copyright (c) 2014 YOUR NAME
+
+
+DESCRIBE YOUR GEM HERE
+
+== Links
+
+* {Source on Github}[LINK TO GITHUB]
+* RDoc[LINK TO RDOC.INFO]
+
+== Install
+
+== Examples
+
+== Contributing
+

data/Rakefile

@@ -0,0 +1,61 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+require 'rake/testtask'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/tc_*.rb'
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+  
+  rd.main = "README.rdoc"
+  
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+task :default => [:test,:features]
+

data/bin/expandsync

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+
+require 'csv'
+require 'expandsync'
+require 'methadone'
+require 'nokogiri'
+require 'optparse'
+
+class App
+  include Methadone::Main
+  include Methadone::CLILogging
+  
+  main do |atext_filepath|
+    begin
+      # Collect snippets from both aText and TextExpander and create an
+      # array with the unique entries of both.
+      atext = AText.new(atext_filepath)
+      textexpander = TextExpander.new(options[:t] || ExpandSync::DEFAULT_TE_SNIPPET_PATH)
+      combined_snippets = (atext.snippets + textexpander.snippets).uniq { |s| s[0] }
+      
+      # Next, create file content (CSV for aText, XML for TextExpander)
+      # that contains the correct data:
+      #   1. aText CSV should contain any new TextExpander snippets.
+      #   2. TextExpander XML should contain original snippets *and*
+      #      any new aText snippets.
+      new_at_csv = atext.construct_data(combined_snippets - atext.snippets)
+      new_te_xml = textexpander.construct_data(combined_snippets - textexpander.snippets)
+      
+      # Save new aText snippets 
+      File.open(options[:a] || ExpandSync::DEFAULT_AT_OUTPUT_PATH, 'w') {|f| f.write(new_at_csv) }
+      
+      # Backup the original TextExpander file and output the new one.
+      FileUtils.cp(ExpandSync::DEFAULT_TE_SNIPPET_PATH, ExpandSync::DEFAULT_TE_SNIPPET_PATH + '.bak')
+      File.open(ExpandSync::DEFAULT_TE_SNIPPET_PATH, 'w') {|f| f.write(new_te_xml) }
+      
+      # This has to be here so that my Cucumber Aruba tests work. Don't ask why.
+      leak_exceptions(true)
+    rescue StandardError => e
+      ExpandSync::CLIMessage.error(e, false)
+    end
+  end
+
+  description ExpandSync::DESCRIPTION
+  version ExpandSync::VERSION
+  
+  # Flags & Switches
+  on('-a FILEPATH', "Specify an output location for aText rules (default to...})")
+  on('-n', )
+  on('-t FILEPATH', 'Specify a location for the TextExpander iOS XML file')
+  on('-v', '--verbose', 'Turn on verbose output')
+  
+  # Arguments
+  arg :atext_filepath, 'The filepath to a CSV file exported from aText'
+
+  go!
+end

data/expandsync.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'expandsync/constants'
+
+Gem::Specification.new do |spec|
+  spec.name             = 'expandsync'
+  spec.version          = ExpandSync::VERSION
+  spec.authors          = ['Aaron Bach']
+  spec.email            = ['bachya1208@googlemail.com']
+  spec.summary          = ExpandSync::DESCRIPTION
+  spec.description      = 'A command line app that synchronizes text expansion snippets between aText for OS X and TextExpander for iOS'
+  spec.homepage         = 'https://github.com/bachya/ExpandSync'
+  spec.license          = 'MIT'
+  spec.platform         = Gem::Platform::RUBY
+                        
+  spec.files            = `git ls-files -z`.split("\x0")
+  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.license          = 'MIT'
+  spec.rdoc_options     = ['--charset=UTF-8']
+  spec.extra_rdoc_files = %w[README.md HISTORY.md LICENSE.txt]
+
+  spec.add_development_dependency('bundler', '~> 0')
+  spec.add_development_dependency('rake', '~> 0')
+  spec.add_development_dependency('rdoc', '~> 0')
+  spec.add_development_dependency('aruba', '~> 0')
+  spec.add_development_dependency('nori', '~> 0')
+  spec.add_dependency('methadone', '~> 1.3', '>= 1.3.1')
+  spec.add_dependency('nokogiri', '~> 1.6', '>= 1.6.1')
+end

data/features/1.ui.feature

@@ -0,0 +1,18 @@
+Feature: UI
+  When the user asks for help, he should be presented
+  with instructions on how to run the app.
+
+  Scenario: Display help instructions
+    When I get help for "expandsync"
+    Then the exit status should be 0
+      And the banner should be present
+      And the banner should include the version
+      And the banner should document that this app takes options
+      And the banner should document that this app's arguments are:
+        | atext_file | which is required |
+      And the following options should be documented:
+            | -a        |
+            | -n        |
+            | -t        |
+            | -v        |
+            | --verbose |

data/features/2.run.feature

@@ -0,0 +1,10 @@
+Feature: Run
+  The user runs the app and it outputs
+  the correct files in the correct locations
+      
+  Scenario: Run with no flags
+    Given an aText CSV file at "/tmp/atext.csv"
+    When I successfully run `expandsync /tmp/atext.csv`
+    Then "~/aText-snippets.csv" should exist
+      And "~/Dropbox/TextExpander/Settings.textexpander" should exist
+      And "~/Dropbox/TextExpander/Settings.textexpander.bak" should exist

data/features/step_definitions/expandsync_steps.rb

@@ -0,0 +1,20 @@
+require 'nori'
+
+Given(/^an aText CSV file at "(.*?)"$/) do |atext_input|
+  Dir.chdir(File.dirname(atext_input)) do
+    FileUtils.cp(File.join(TMP_DIR, 'atext.csv'), 'atext.csv')
+    FileUtils.cp(File.join(TMP_DIR, 'expected-new-textexpander.xml'), 'expected-new-textexpander.xml')
+    FileUtils.cp(File.join(TMP_DIR, 'Settings.textexpander'), '/tmp/expandsync/Dropbox/TextExpander/Settings.textexpander')
+  end
+end
+
+Then(/^"(.*?)" should exist$/) do |file|
+  expect(File).to exist(File.expand_path(file)) 
+end
+
+Then(/^"(.*?)" should be the same as "(.*?)"$/) do |file1, file2|
+  parser = Nori.new
+  file1_xml = parser.parse(File.read(File.expand_path(file1)))
+  file2_xml = parser.parse(File.read(File.expand_path(file2)))
+  expect(file1_xml).to eq(file2_xml)
+end

data/features/support/env.rb

@@ -0,0 +1,23 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+TMP_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','tmp')
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+  @original_home = ENV['HOME']
+  ENV['HOME'] = "/tmp/expandsync"
+  FileUtils.rm_rf "/tmp/expandsync"
+  FileUtils.mkdir "/tmp/expandsync"
+  FileUtils.mkdir_p "/tmp/expandsync/Dropbox/TextExpander"
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+  ENV['HOME'] = @original_home
+end

data/lib/expandsync/atext.rb

@@ -0,0 +1,35 @@
+#  ======================================================
+#  AText Class
+#  ======================================================
+class AText
+  attr_accessor :filepath, :snippets
+
+  #  ====================================================
+  #  Methods
+  #  ====================================================
+  #  ----------------------------------------------------
+  #  initialize method
+  #
+  #  @param csv_filepath The filepath to the aText CSV
+  #  @return Void
+  #  ----------------------------------------------------
+  def initialize(csv_filepath)
+    begin
+      @filepath = csv_filepath
+      @snippets = CSV.read(csv_filepath)
+    rescue 
+      fail "Invalid aText CSV file: #{ csv_filepath }"
+    end
+  end
+  
+  #  ----------------------------------------------------
+  #  construct_data method
+  #
+  #  Outputs a CSV listing of the supplied snippets
+  #  @param new_snippets The snippet array to use
+  #  @return String
+  #  ----------------------------------------------------
+  def construct_data(new_snippets)
+    CSV.generate { |csv| new_snippets.each { |s| csv << [s[0], s[1]] } }
+  end
+end

data/lib/expandsync/cli_message.rb

@@ -0,0 +1,215 @@
+module ExpandSync
+  #  ======================================================
+  #  CliManager Module
+  #  Singleton to manage common CLI interfacing
+  #  ======================================================
+  module CLIMessage
+    #  ====================================================
+    #  Methods
+    #  ====================================================
+    #  ----------------------------------------------------
+    #  error method
+    #
+    #  Outputs a formatted-red error message.
+    #  @param m The message to output
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.error(m, log = true)
+      Methadone::CLILogging.error(m) if log
+      puts "---> ERROR: #{ m }".red
+    end
+
+    #  ----------------------------------------------------
+    #  info method
+    #
+    #  Outputs a formatted-blue informational message.
+    #  @param m The message to output
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.info(m, log = true)
+      Methadone::CLILogging.info(m) if log
+      puts "---> INFO: #{ m }".blue
+    end
+
+    #  ----------------------------------------------------
+    #  info_block method
+    #
+    #  Wraps a block in an opening and closing info message.
+    #  @param m1 The opening message to output
+    #  @param m2 The closing message to output
+    #  @param multiline Whether the message should be multiline
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.info_block(m1, m2 = 'Done.', multiline = false, log = true)
+      if block_given?
+        if multiline
+          info(m1, log)
+        else
+          print "---> INFO: #{ m1 }".blue
+        end
+
+        yield
+
+        if multiline
+          info(m2, log)
+        else
+          puts m2.blue
+        end
+      else
+        error = 'Did not specify a valid block'
+        Methadone::CLILogging.error(error) if log
+        fail ArgumentError, error
+      end
+    end
+
+    #  ----------------------------------------------------
+    #  prompt method
+    #
+    #  Outputs a prompt, collects the user's response, and
+    #  returns it.
+    #  @param prompt The prompt to output
+    #  @param default The default option
+    #  @return String
+    #  ----------------------------------------------------
+    def self.prompt(prompt, default = nil, log = true)
+      print "#{ prompt } #{ default.nil? ? '' : "[default: #{ default }]:" } ".blue
+      choice = $stdin.gets.chomp
+      if choice.empty?
+        r = default
+      else
+        r = choice
+      end
+
+      Methadone::CLILogging.info("Answer to '#{ prompt }': #{r}") if log
+      r
+    end
+
+    #  ----------------------------------------------------
+    #  section method
+    #
+    #  Outputs a formatted-orange section message.
+    #  @param m The message to output
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.section(m, log = true)
+      Methadone::CLILogging.info(m) if log
+      puts "#### #{ m }".purple
+    end
+
+    #  ----------------------------------------------------
+    #  section_block method
+    #
+    #  Wraps a block in an opening and closing section
+    #  message.
+    #  @param m1 The opening message to output
+    #  @param m2 The closing message to output
+    #  @param multiline A multiline message or not
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.section_block(m, multiline = true, log = true)
+      if block_given?
+        if multiline
+          section(m, log)
+        else
+          print "#### #{ m }".purple
+        end
+
+        yield
+      else
+        error = 'Did not specify a valid block'
+        Methadone::CLILogging.error(error) if log
+        fail ArgumentError, error
+      end
+    end
+
+    #  ----------------------------------------------------
+    #  success method
+    #
+    #  Outputs a formatted-green success message.
+    #  @param m The message to output
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.success(m, log = true)
+      Methadone::CLILogging.info(m) if log
+      puts "---> SUCCESS: #{ m }".green
+    end
+
+    #  ----------------------------------------------------
+    #  warning method
+    #
+    #  Outputs a formatted-yellow warning message.
+    #  @param m The message to output
+    #  @return Void
+    #  ----------------------------------------------------
+    def self.warning(m, log = true)
+      Methadone::CLILogging.warn(m) if log
+      puts "---> WARNING: #{ m }".yellow
+    end
+  end
+end
+
+#  ======================================================
+#  String Class
+#  ======================================================
+class String
+  #  ----------------------------------------------------
+  #  colorize method
+  #
+  #  Outputs a string in a formatted color.
+  #  @param color_code The code to use
+  #  @return Void
+  #  ----------------------------------------------------
+  def colorize(color_code)
+    "\e[#{ color_code }m#{ self }\e[0m"
+  end
+
+  #  ----------------------------------------------------
+  #  blue method
+  #
+  #  Convenience method to output a blue string
+  #  @return Void
+  #  ----------------------------------------------------
+  def blue
+    colorize(34)
+  end
+
+  #  ----------------------------------------------------
+  #  green method
+  #
+  #  Convenience method to output a green string
+  #  @return Void
+  #  ----------------------------------------------------
+  def green
+    colorize(32)
+  end
+
+  #  ----------------------------------------------------
+  #  purple method
+  #
+  #  Convenience method to output a purple string
+  #  @return Void
+  #  ----------------------------------------------------
+  def purple
+    colorize(35)
+  end
+
+  #  ----------------------------------------------------
+  #  red method
+  #
+  #  Convenience method to output a red string
+  #  @return Void
+  #  ----------------------------------------------------
+  def red
+    colorize(31)
+  end
+
+  #  ----------------------------------------------------
+  #  yellow method
+  #
+  #  Convenience method to output a yellow string
+  #  @return Void
+  #  ----------------------------------------------------
+  def yellow
+    colorize(33)
+  end
+end

data/lib/expandsync/constants.rb

@@ -0,0 +1,9 @@
+module ExpandSync
+  # App Info
+  DESCRIPTION = 'An engine for synchronizing snippets from aText on OS X and TextExpander iOS'
+  VERSION = '0.1.0'
+  
+  # Filepaths
+  DEFAULT_AT_OUTPUT_PATH = File.join(ENV['HOME'], 'aText-snippets.csv')
+  DEFAULT_TE_SNIPPET_PATH = File.join(ENV['HOME'], 'Dropbox', 'TextExpander', 'Settings.textexpander')
+end

data/lib/expandsync/exceptions.rb

@@ -0,0 +1,5 @@
+module Exceptions
+  class InvalidFileError < StandardError; end
+  class InvalidCSVError < InvalidFileError; end
+  class InvalidXMLError < InvalidFileError; end
+end