plister 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff894223164c3b13e6fe143912b533c2b629bab0
+  data.tar.gz: 09848e3721c574e6997cb2363c1524cb8a13b7d2
+SHA512:
+  metadata.gz: 840ff9a88f9518500b0d820ebb41c84c8739bb91aa0351ac689823ea5e11aad12ba5dd3b7cd9fc3a0413a44ecbbf354e63147bb4ea4d65fcd42de8d22f908b08
+  data.tar.gz: 965a450fa0c8c86212d26ce672391420ca5d118a0662245aac253347e2ac8484c558944213e3d5868d1c0787351d7e4d52f7e6f16d1906858f55a9700d49d54f

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/LineLength:
+  Enabled: false
+  
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2
+cache: bundler
+sudo: false
+script: script/cibuild

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ben Balter
+
+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,87 @@
+# Plister
+
+*A utility for programmatically setting OS X plist file preferences*
+
+## What it does
+
+Most dotfile setups have a string of cryptic `defaults write com.apple...`-type commands. Plister simplifies that process by allowing you to store your OS X preferences in a single YAML file (likily in your home directory or within your dotfiles repostiory), and exposes a single `plister` command line tool to set your saved preferences.
+
+## Usage
+
+1. Install the Gem (`gem install plister`)
+2. Create a preference file as `~/.osx.yml` (see below)
+3. Run `plister` command to set the desired preferences
+
+### The command line tool
+
+`$ plister [path-to-your-preferences.yml]`
+
+If no preference file is passed, Plister will default to `~/.osx.yml`.
+
+### Creating a preference file
+
+1. Create a file in your home directory called `.osx.yml` (or symlink it from elsewhere)
+.
+2. Add your OS X preferences to the `.osx.yml` file, following the instructions below.
+
+### Describing preferences
+
+OS X has several different ways of storing preferences, each with their own domain (e.g., `com.apple.safari`). If you're copying your preferences from a tutorial or someone else's dotfiles, you can tell the domain and type by the command used to set it.
+
+```
+defaults write -someFlag com.apple.safari key value
+COMMAND        FLAG      DOMAIN           SETTING
+```
+
+#### User preferences
+
+User preferences are specific to a user and live in `~/Library/Preferences`. They are the default and have no flag. Example: `defaults write com.apple.safari someSetting -int 0`.
+
+#### System preferences
+
+System preferences are system wide and live in `/Library/Preferenences`. These are often passed as absolute paths, and require `sudo`. Example: `sudo defaults write /Library/Preferences/com.apple.safari.plist someSetting -int 0`.
+
+#### Global preferences
+
+Global preferences are not application specific and have a domain of `NSGlobalDomain`. This may be omitted in favor of the `-g` or `-globalDomain` flag. Global preference can be either user or system preferences and should be stored with a key of `.GlobalPreferences` in your config file. Example: `defaults write NSGlobalDomain someSetting -int 0`.
+
+#### Host preferences
+
+Host preferences live in `~/Library/Preferences/byHost` and are identified by the `-currentHost` flag. Example: `defaults write -currentHost com.apple.safari someSetting -int 0`.
+
+### The `.osx.yml` file
+
+Settings are group by type and domain within your `.osx.yml` file.
+
+```yml
+user:
+  com.apple.safari:
+    someSetting: 0
+    anotherSetting: my-value
+
+  com.apple.dock:
+    autohide: true
+
+  # NSGlobalDomain preferences
+  .GlobalPreferences:
+    WebKitDeveloperExtras: true
+
+system:
+  com.apple.SoftwareUpdate:
+    AutomaticCheckEnabled: true
+
+host:
+  com.apple.ScreenSaver.iLifeSlideShows:
+    styleKey: VintagePrints
+```
+
+The above would be equivalent to:
+
+```
+defaults write com.apple.safari someSetting -int 0
+defaults write com.apple.safari anotherSetting my-value
+defaults write com.apple.dock autohide -bool true
+defaults write NSGlobalDomain WebKitDeveloperExtras -bool true
+sudo defaults write com.apple.SoftwareUpdate AutomaticCheckEnabled -bool true
+default write -currentHost com.apple.ScreenSaver.iLifeSlideShows styleKey VintagePrints
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/plister

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/plister'
+
+preferences = Plister.preferences(ARGV[0])
+
+puts "Using preference file #{preferences.path}"
+puts "Found preferences for #{preferences.domains.count} applications"
+
+preferences.set!(verbose: true)
+
+puts 'Preferences set!'

data/lib/plister/plist.rb

@@ -0,0 +1,68 @@
+module Plister
+  class Plist
+    attr_accessor :domain, :type
+    TYPES = %w(user system host).freeze
+
+    def initialize(domain, type: 'user')
+      @domain = domain
+      @type   = type.to_s
+      fail ArgumentError, 'Invalid type' unless valid_type?
+    end
+
+    def preferences
+      @preferences ||= CFPropertyList.native_types(list.value)
+    end
+
+    def preferences=(prefs)
+      list.value = CFPropertyList.guess(prefs, convert_unknown_to_string: true)
+      @preferenes = nil
+      preferences
+    end
+
+    def merge(prefs)
+      self.preferences = preferences.deep_merge(prefs)
+    end
+
+    def write
+      fail IOError, "#{path} is not writable by #{Plister.user}" unless writable?
+      list.save
+    end
+
+    private
+
+    def path
+      @path ||= begin
+        case type
+        when 'system'
+          "/Library/Preferences/#{domain}.plist"
+        when 'user'
+          "/Users/#{Plister.user}/Library/Preferences/#{domain}.plist"
+        when 'host'
+          "/Users/#{Plister.user}/Library/preferences/ByHost/#{domain}.#{Plister.uuid}.plist"
+        end
+      end
+    end
+
+    def list
+      fail IOError, "#{path} does not exist" unless exists?
+      fail IOError, "#{path} is not readable by #{Plister.user}" unless readable?
+      @list ||= CFPropertyList::List.new file: path
+    end
+
+    def exists?
+      File.exist?(path)
+    end
+
+    def writable?
+      File.writable?(path)
+    end
+
+    def readable?
+      File.readable?(path)
+    end
+
+    def valid_type?
+      TYPES.include?(type)
+    end
+  end
+end

data/lib/plister/preferences.rb

@@ -0,0 +1,34 @@
+module Plister
+  class Preferences
+    attr_reader :path
+
+    def initialize(path = nil)
+      @path = path || "/Users/#{Plister.user}/.osx.yml"
+    end
+
+    def set!(verbose: false)
+      data.each do |type, domains|
+        domains.each do |domain, prefs|
+          puts "Setting #{type} preferences for #{domain}" if verbose
+          plist = Plist.new(domain, type: type)
+          plist.merge(prefs)
+          plist.write
+        end
+      end
+    end
+
+    def domains
+      @domains ||= data.map { |_k, v| v.keys }.flatten
+    end
+
+    private
+
+    def data
+      @data ||= YAML.load(contents)
+    end
+
+    def contents
+      @contents ||= File.open(path).read
+    end
+  end
+end

data/lib/plister/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Plister
+  VERSION = '0.1.0'.freeze
+end

data/lib/plister.rb

@@ -0,0 +1,27 @@
+require 'CFPropertyList'
+require 'deep_merge'
+require 'yaml'
+
+require_relative 'plister/version'
+require_relative 'plister/plist'
+require_relative 'plister/preferences'
+
+module Plister
+  class << self
+    def preferences(path = nil)
+      Plister::Preferences.new(path)
+    end
+
+    def user
+      @user ||= `logname`.strip
+    end
+
+    def uuid
+      @uuid ||= begin
+        uuid = `ioreg -rd1 -c IOPlatformExpertDevice`
+        matches = uuid.match(/"IOPlatformUUID" = "([0-9A-F-]{36})"/)
+        matches[1] if matches
+      end
+    end
+  end
+end

data/plister.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plister/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'plister'
+  spec.version       = Plister::VERSION
+  spec.authors       = ['Ben Balter']
+  spec.email         = ['ben.balter@github.com']
+
+  spec.summary       = 'A utility for programmatically setting OS X plist file preferences'
+  spec.homepage      = 'https://github.com/benbalter/plister'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'CFPropertyList', '~> 2.3'
+  spec.add_dependency 'deep_merge', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rubocop', '~> 0.36'
+end

data/script/bootstrap

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/script/cibuild

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -ex
+
+bundle exec rake spec
+bundle exec rubocop
+bundle exec gem build plister.gemspec

data/script/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'plister'
+require 'pry'
+Pry.start

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: plister
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Balter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: CFPropertyList
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+description: 
+email:
+- ben.balter@github.com
+executables:
+- plister
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/plister
+- lib/plister.rb
+- lib/plister/plist.rb
+- lib/plister/preferences.rb
+- lib/plister/version.rb
+- plister.gemspec
+- script/bootstrap
+- script/cibuild
+- script/console
+homepage: https://github.com/benbalter/plister
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A utility for programmatically setting OS X plist file preferences
+test_files: []
+has_rdoc: