expandsync 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 39e3fc74b7b97e14036f6b3328faef9930813f5f
-  data.tar.gz: e0dbeeece56ba82f1f3daa38a85ff2b370f285c2
+  metadata.gz: be308f8e30b4ef9b15d13174e5809d5d2557d305
+  data.tar.gz: cc498fd31d09b9f9b74ce90d92b6fa2a540c0d08
 SHA512:
-  metadata.gz: 8bc18828f6874276b291fcfd72e8eb2d115e8d2bd92d20321ceab20db3522613b1541ee2ef1f4b3e5b0c21aab71f8a09a0d6a5323bf386b88890353e1f464678
-  data.tar.gz: 5589cfdbbecba36bea6680c5889c391426711d8f04b5be8de2cfb035dcb13462e3fb7b83ebd8d572d597bc56d81b56955b499051858e084080a94c1873e7ac0d
+  metadata.gz: 5cb449abdaa8926fa0caa0bf6a3ed9ecb77d869b83281d27b09d8794f89a14264890a74075aaf7d23c01aea9f53c003df5aed1d0ba88146f1f131551e4eb011a
+  data.tar.gz: bd78433a0d3b49b7c2ebd30f2c1ece5ee44379447fd56dcc1b553d0dcd8b1e6c55f87b7bd2ad570a3cfd746bfcb50dc3565ef16f3443da9e4fd5e1a438f19a06

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    expandsync (0.1.0)
+    expandsync (0.1.1)
       methadone (~> 1.3, >= 1.3.1)
       nokogiri (~> 1.6, >= 1.6.1)
 
@@ -41,6 +41,5 @@ PLATFORMS
 
 DEPENDENCIES
   aruba (~> 0)
-  bundler
   expandsync!
-  rake
+  rake (~> 0)

data/HISTORY.md

@@ -1,3 +1,12 @@
+# 0.1.2 (2014-03-15)
+
+* Added more documentation
+
+# 0.1.1 (2014-03-15)
+
+* Added more documentation
+* Fixed a gemspec issue
+
 # 0.1.0 (2014-03-12)
 
 * Initial release of ExpandSync

data/README.md

@@ -1,15 +1,16 @@
-ExpandSync
+ExpandSync[![Build Status](https://travis-ci.org/bachya/ExpandSync.png?branch=master)](https://travis-ci.org/bachya/ExpandSync)
 ==========
 
-A simple engine to sync aText and TextExpander iOS.
+A simple engine to sync snippets between aText and TextExpander iOS. Because these two programs don't natively sync, it becomes necessary to introduce a tool that helps grease the skids, so to speak.
 
-# Installation
+# Prerequisites
 
-    $ gem install expandsync
+* Install Ruby 1.9.3 or greater on the machine that will run ExpandSync.
+* Enable Dropbox syncing in TextExpander iOS.
 
-# Warning
+# Installation
 
-ExpandSync is still *heavily* in development; as such, expect this repository to change daily. **USE AT YOUR OWN DISCRETION.**
+    $ gem install expandsync
   
 # Usage
 
@@ -21,16 +22,15 @@ Syntax and usage can be accessed by running `expandsync --help`:
 $ expandsync --help
 Usage: expandsync [options] atext_filepath
 
-An engine for synchronizing snippets from aText on OS X and TextExpander iOS
+A command line app that synchronizes text expansion snippets between aText for OS X and TextExpander for iOS
 
-v0.1.0
+v0.1.2
 
 Options:
     -h, --help                       Show command line help
         --version                    Show help/version info
-    -a FILEPATH                      Specify an output location for aText rules (default to /Users/abach/aText-snippets.csv})
+    -a FILEPATH                      Output location for aText rules (defaults to ~/aText-snippets.csv)
     -n                               Disable backing up of Settings.textexpander (RUN AT YOUR OWN RISK!)
-    -t FILEPATH                      Specify a location for the TextExpander iOS XML file
     -v, --verbose                    Turn on verbose output
 
 Arguments:
@@ -39,7 +39,31 @@ Arguments:
         The filepath to a CSV file exported from aText
 ```
 
-# Contributing
+# Process
+
+Synchronizing these two applications follows this process:
+
+1. Export the current aText snippet list (**Data >> Backup To...**). Ensure that you export a CSV (not an aText) file.
+2. Run `expandsync /path/to/your/aText/file.csv`
+3. ExpandSync will calculate the snippets that are missing from aText and those that are missing from TextExpander iOs.
+4. Unique aText snippets will be automatically imported into TextExpander iOS via Dropbox.
+5. ExpandSync will output `aText-snippets.csv` – which contains snippets unique to TextExpander iOS – which can be imported into aText.
+
+# Caveats
+
+* Unfortunately, aText does not allow programmatic access to its snippet database; as such, there is a rather manual nature to this (you most likely won't be running this on a regular cron job).
+* Because neither aText nor TextExpander iOS tracks snippets that have been deleted, there's no way to tell both applications to simultaneously delete a snippet. I'm working on a "ask-the-user" method, but in the meantime, snippets will have to be manually deleted from both sides.
+* Currently, dynamic text – dates, etc. – are not translated between programs. I'm planning to address in a future version.
+
+# Known Issues & Future Releases
+
+Bugs, issues, and enhancement requests (my own or those submitted by others) can be found on the [Issues Page](https://github.com/bachya/ExpandSync/issues "Open Items").
+
+# Bugs and Feature Requests
+
+To report bugs with or suggest features/changes for Sifttter Redux, please use the [Issues Page](http://github.com/bachya/ExpandSync/issues).
+
+Contributions are welcome and encouraged. To contribute:
 
 1. Fork it ( http://github.com/bachya/expandsync/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/expandsync.gemspec

@@ -23,7 +23,6 @@ Gem::Specification.new do |spec|
   spec.rdoc_options     = ['--charset=UTF-8']
   spec.extra_rdoc_files = %w[README.md HISTORY.md LICENSE]
 
-  spec.add_development_dependency('bundler', '~> 0')
   spec.add_development_dependency('rake', '~> 0')
   spec.add_development_dependency('aruba', '~> 0')
   spec.add_dependency('methadone', '~> 1.3', '>= 1.3.1')

data/lib/expandsync/constants.rb

@@ -1,5 +1,5 @@
 module ExpandSync
   DESCRIPTION = 'A command line app that synchronizes text expansion snippets between aText for OS X and TextExpander for iOS'
   SUMMARY = 'An engine for synchronizing snippets from aText on OS X and TextExpander iOS'
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: expandsync
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Aaron Bach
@@ -10,20 +10,6 @@ bindir: bin
 cert_chain: []
 date: 2014-03-15 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: rake
   requirement: !ruby/object:Gem::Requirement