osxsub 0.1.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "rake"

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    osxsub (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rake (10.0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  osxsub!
+  rake

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2013 Mark Wunsch
+
+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,59 @@
+`osxsub`
+
+A command line utility for using the OS X Text Substitution System Preferences in a unix pipeline. Like `sed` but for Mac users who are taking advantage of a mostly hidden system preference.
+
+Basic usage is like this:
+
+    $ echo "Copyright (c) 2013 Mark Wunsch" | osxsub
+      Copyright © 2013 Mark Wunsch
+
+Text Substitutions are available for a handful of Mac applications, and can be set up by going to `System Preferences -> Language & Text` and selecting the `Text` tab.
+
+Read more about OS X Text Substitution:
+
++ [_How to use text substitution in Snow Leopard_ -- Macworld](http://www.macworld.com/article/1142708/slsubstitutions.html)
++ [_Mac 101: Making Text Replacement Work_ -- TUAW](http://www.tuaw.com/2009/12/31/mac-101-making-text-replacement-work/)
++ [_Do Yourself a Favor: Set Up Mountain Lion’s Built-in Text Expansion with These Shortcuts_ -- Lifehacker](http://lifehacker.com/5931337/do-yourself-a-favor-set-up-mountain-lions-built+in-text-expansion-with-these-shortcuts)
+
+The goals for this program are:
+
++ Backup your text substitution preferences, along with the ability to
++ Load new preferences, so that you can
++ Share substitution preferences across machines, and
++ Have access to them in a greater set of applications, by
++ Allowing Text Substitutions to be a part of your command line toolkit.
+
+Some more options can be given to the tool to make managing your Preferences easy:
+
+    $ osxsub --print
+    ## Print a plist of your substition preferences
+
+    $ osxsub --merge PATH_TO_PLIST
+    ## Merge another plist into your preferences.
+
+    $ osxsub --add REPLACE,WITH
+    ## Add a new pair of substitutions (they're turned on by default).
+
+    $ osxsub --clear
+    ## Clear all your preferences.
+
+    $ osxsub --repl
+    ## Start an interactive session to test out substitutions.
+
+## Installation
+
+A Homebrew Formula is available, but has yet to be moved to the master Homebrew repo: https://gist.github.com/4657560
+
+Alternatively, `osxsub` is available as a Rubygem.
+
+    $ gem install osxsub
+
+Or clone the repository and put the `bin` directory somewhere on your `$PATH`.
+
+## TODO
+
++ Manpages
++ Documentation
++ Tests
+
+Copyright © 2013 Mark Wunsch.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/osxsub

@@ -0,0 +1,94 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+libdir = File.expand_path File.join(File.dirname(__FILE__), "/../lib")
+$:.unshift libdir unless $:.include? libdir
+require 'osxsub'
+
+options = ARGV.options do |opts|
+  opts.banner = <<-BANNER
+osxsub: OS X Text Substitution Preferences on the command line
+
+Usage: Run STDIN through Text Substitions set in System Preferences -> Language & Text
+
+  echo "Copyright (c) 2013 Mark Wunsch" | osxsub
+  #=> Copyright © 2013 Mark Wunsch
+
+  BANNER
+  opts.version = OsxSub::VERSION
+
+  opts.on('-p', '--print', "Print an XML Plist of the Text Substitution Preferences") do
+    puts OsxSub::NSUserReplacementItems.from_plist_buddy.to_plist
+    exit
+  end
+
+  opts.on('-m', '--merge [PATH]', "Merge an XML Plist (from either PATH or STDIN) into the Preferences") do |path|
+    xml = if path && !path.empty?
+      full_path = File.expand_path(path)
+      opts.abort("Plist file does not exist!") unless File.exists? full_path
+      IO.read(full_path)
+    elsif !STDIN.tty?
+      STDIN.read
+    else
+      opts.abort("Must give either a PATH or a Plist in STDIN")
+    end
+    subs = OsxSub::NSUserReplacementItems.from_xml(xml)
+    subs.merge!
+    puts subs.to_plist
+    exit
+  end
+
+  opts.on('-a', '--add REPLACE,WITH', Array, "Add a new pair of substitions to the list") do |list|
+    opts.abort "REPLACE,WITH must have a pair and they can't be the same" if list.first == list.last
+    sub = OsxSub::Substitution.new(list.first, list.last)
+    replacement_item = OsxSub::NSUserReplacementItems.new([sub])
+    replacement_item.merge!
+    puts replacement_item.to_plist
+    exit
+  end
+
+  opts.on('-r', '--repl', "Start a REPL (read-eval-print loop)") do
+    opts.abort("Can't start REPL unless STDIN is a tty") unless STDIN.tty?
+    opts.warn("Send an EOT signal (Ctrl-D) to end")
+    print ">> "
+    while STDIN.gets
+      puts " => " + OsxSub::NSUserReplacementItems.from_plist_buddy.sub($_)
+      print ">> "
+    end
+    puts ""
+    exit
+  end
+
+  opts.on('-c', '--clear', "Clear out the set of substitution preferences") do
+    plist_buddy = OsxSub::PlistBuddy.instance
+    begin
+      plist_buddy.delete
+      plist_buddy.add
+    rescue OsxSub::PlistBuddyError => e
+      plist_buddy.add unless e.exists?
+    end
+    puts plist_buddy.print
+    exit
+  end
+
+  opts.separator ""
+
+  opts.on_tail('-h', '--help') { puts opts ; exit }
+  opts.on_tail('--version', "Print version information and exit") { puts opts.version ; exit }
+  begin
+    opts.parse!
+  rescue OptionParser::ParseError
+    opts.warn $!
+  end
+  opts
+end
+
+if !STDIN.tty?
+  STDIN.each_line do |line|
+    STDOUT.write OsxSub::NSUserReplacementItems.from_plist_buddy.sub(line)
+  end
+  exit
+end
+
+abort options.help
+

data/lib/osxsub/ns_user_replacement_items.rb

@@ -0,0 +1,107 @@
+require 'rexml/document'
+
+module OsxSub
+  class NSUserReplacementItems
+    PLIST_TEMPLATE = <<-PLIST
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<array>
+  <% substitutions.each do |substitution| %>
+	<dict>
+    <% if substitution.on? %>
+		<key>on</key>
+		<integer>1</integer>
+    <% end %>
+		<key>replace</key>
+		<string><%= substitution.replace %></string>
+		<key>with</key>
+		<string><%= substitution.with %></string>
+	</dict>
+  <% end %>
+</array>
+</plist>
+    PLIST
+
+    def self.from_plist_buddy
+      plist_buddy = PlistBuddy.instance
+      self.from_xml plist_buddy.print
+    rescue PlistBuddyError => e
+      unless e.exists?
+        warn("#{e}Adding and Merging default preferences")
+        plist_buddy.add
+        self.defaults.merge!
+        retry
+      end
+    end
+
+    def self.from_xml(xml)
+      doc = REXML::Document.new(xml, :ignore_whitespace_nodes => :all)
+      plist = doc.elements['plist/array'].map do |dict|
+        tuple = dict.each.select {|node| node.has_name?("key") }.map do |key|
+          [key.text, key.next_element.text]
+        end
+        Hash[tuple]
+      end
+      self.new plist.map {|dict| Substitution.new(dict['replace'], dict['with'], dict['on']) }
+    end
+
+    def self.defaults
+      default_substitutions = [
+        Substitution.new("(c)", "\xC2\xA9"),
+        Substitution.new("(r)", "\xC2\xAE"),
+        Substitution.new("(p)", "\xE2\x84\x97"),
+        Substitution.new("TM", "\xE2\x84\xA2"),
+        Substitution.new("c/o", "\xE2\x84\x85"),
+        Substitution.new("...", "\xE2\x80\xA6"),
+        Substitution.new("1/2", "\xC2\xBD", false),
+        Substitution.new("1/3", "\xE2\x85\x93", false),
+        Substitution.new("2/3", "\xE2\x85\x94", false),
+        Substitution.new("1/4", "\xC2\xBC", false),
+        Substitution.new("3/4", "\xC2\xBE", false),
+        Substitution.new("1/8", "\xE2\x85\x9B", false),
+        Substitution.new("3/8", "\xE2\x85\x9C", false),
+        Substitution.new("5/8", "\xE2\x85\x9D", false),
+        Substitution.new("7/8", "\xE2\x85\x9E", false)
+      ]
+      self.new(default_substitutions)
+    end
+
+    attr_reader :substitutions
+
+    def initialize(substitutions)
+      @substitutions = substitutions
+    end
+
+    def sub(text)
+      substitutions.select(&:on?).inject(text) {|memo, obj| obj.sub(memo) }
+    end
+
+    def to_plist
+      require 'erb'
+      template = ERB.new(PLIST_TEMPLATE)
+      template.result(binding)
+    end
+
+    def merge!
+      tmp_file = temp_plist_file
+      PlistBuddy.instance.merge tmp_file.path
+    ensure
+      if tmp_file
+        tmp_file.close
+        tmp_file.unlink
+      end
+    end
+
+  private
+
+    def temp_plist_file
+      require 'tempfile'
+      tmp_file = Tempfile.new("nsuser_replacement_items_plist")
+      tmp_file.write to_plist
+      tmp_file.rewind
+      tmp_file
+    end
+  end
+end
+

data/lib/osxsub/plist_buddy.rb

@@ -0,0 +1,50 @@
+module OsxSub
+  class PlistBuddyError < StandardError
+    def exists?
+      !message.match(/Does Not Exist$/)
+    end
+  end
+
+  class PlistBuddy
+    require 'singleton'
+
+    include Singleton
+
+    PLIST_BUDDY = '/usr/libexec/PlistBuddy'
+    GLOBAL_PREFERENCES_PLIST = File.expand_path('~/Library/Preferences/.GlobalPreferences.plist')
+    NSUSER_REPLACEMENT_ITEMS = 'NSUserReplacementItems'
+
+    def print
+      execute plist_buddy(:print)
+    end
+
+    def delete
+      execute plist_buddy(:delete)
+    end
+
+    def add
+      execute plist_buddy(:add, "array")
+    end
+
+    def merge(path)
+      execute plist_buddy("Merge #{path}")
+    end
+
+    def plist_buddy(command, *extras)
+      %Q[#{PLIST_BUDDY} -x -c "#{command.to_s.capitalize} #{NSUSER_REPLACEMENT_ITEMS} #{extras.join(' ')}" #{GLOBAL_PREFERENCES_PLIST}]
+    end
+
+    def execute(command)
+      require 'stringio'
+      require 'open3'
+
+      out, err = ::StringIO.new, ::StringIO.new
+      ::Open3.popen3(command) do |stdin, stdout, stderr|
+        out.write stdout.read
+        err.write stderr.read
+      end
+      raise PlistBuddyError, err.string unless err.string.empty?
+      out.string
+    end
+  end
+end

data/lib/osxsub/substitution.rb

@@ -0,0 +1,20 @@
+module OsxSub
+  class Substitution
+    attr_reader :replace, :with
+
+    def initialize(replace, with, on = true)
+      @replace = replace
+      @with = with
+      @on = on
+    end
+
+    def on?
+      return false if @on.is_a? String and @on.to_i <= 0
+      true & @on
+    end
+
+    def sub(string)
+      string.gsub(replace, with)
+    end
+  end
+end

data/lib/osxsub/version.rb

@@ -0,0 +1,3 @@
+module OsxSub
+  VERSION = "0.1.0"
+end

data/lib/osxsub.rb

@@ -0,0 +1,6 @@
+module OsxSub
+  require 'osxsub/version'
+  require 'osxsub/substitution'
+  require 'osxsub/plist_buddy'
+  require 'osxsub/ns_user_replacement_items'
+end

data/osxsub.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/osxsub/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mark Wunsch"]
+  gem.email         = ["mark@markwunsch.com"]
+  gem.description   = %q{Command line utility for OS X Text Substition Preferences.}
+  gem.summary       = %q{Command line utility for OS X Text Substition Preferences.}
+  gem.homepage      = %q{http://github.com/mwunsch/osxsub}
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "osxsub"
+  gem.require_paths = ["lib"]
+  gem.version       = OsxSub::VERSION
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: osxsub
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark Wunsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-01-28 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: Command line utility for OS X Text Substition Preferences.
+email: 
+- mark@markwunsch.com
+executables: 
+- osxsub
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/osxsub
+- lib/osxsub.rb
+- lib/osxsub/ns_user_replacement_items.rb
+- lib/osxsub/plist_buddy.rb
+- lib/osxsub/substitution.rb
+- lib/osxsub/version.rb
+- osxsub.gemspec
+has_rdoc: true
+homepage: http://github.com/mwunsch/osxsub
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Command line utility for OS X Text Substition Preferences.
+test_files: []
+