plister 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2001bfebfa14b94a467d18dbe2592dabcf3a17fc
-  data.tar.gz: e1b0e8c8d0ca47e7101ab8da0cf9572144c872e3
+  metadata.gz: 4c89854e921ebac0cc2eec17810ce5e00d1e23d8
+  data.tar.gz: 1ea06e262ee6a703ca8b4a3981830ce7a402b458
 SHA512:
-  metadata.gz: 19bd90e4181f2c8810220197702ddde9fa0eebb59d1085d20d1fd5abf7e0b8a134c20547bded8e82608aac1c035366158ceb720a0ce3e5cd2377a8e439a816ed
-  data.tar.gz: c64ba64d3d675d46ac3a6256a2280df0907c947d0f67c5d06dfe3f5227cc14e23f1f56b5935e6ae321b20e3b5ef46e38fea62c3137e72f5d396a8eeb530c0a4a
+  metadata.gz: 86719f7a5f784db7db17cc179d2310933e24d9abe04d15ce5915eac7093aff95bc6d077c263b402195053ed985ad1661cc22a641b8bb8a294bc0466698eb2c18
+  data.tar.gz: f0815ed9fb79f949cdded58b47080139aacfff698f39f6449fa243c4a5b979f8f1ae1611023524dfd400e69283c94689b3df6d5161d518704fedecbcb511679b

data/.travis.yml

@@ -1,6 +1,5 @@
+os: osx
 language: ruby
-rvm:
-  - 2.3.0
 before_install: gem install bundler -v 1.11.2
 cache: bundler
 sudo: false

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in plister.gemspec
 gemspec
+
+gem 'pry', github: 'pry/pry'

data/README.md

@@ -6,7 +6,9 @@
 
 ## 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.
+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 (likely in your home directory or within your dotfiles repostiory), and exposes a single `plister` command line tool to set your saved preferences.
+
+See [@benbalter's dotfiles for an example](https://github.com/benbalter/dotfiles/blob/master/.osx.yml).
 
 ## Usage
 
@@ -16,7 +18,7 @@ Most dotfile setups have a string of cryptic `defaults write com.apple...`-type
 
 ### The command line tool
 
-`$ plister [path-to-your-preferences.yml]`
+`$ plister [path-to-your-preferences.yml] [options]`
 
 If no preference file is passed, Plister will default to `~/.osx.yml`.
 
@@ -26,6 +28,10 @@ If no preference file is passed, Plister will default to `~/.osx.yml`.
 .
 2. Add your OS X preferences to the `.osx.yml` file, following the instructions below.
 
+### Dumping existing preferences
+
+To dump all your existing preferences, run `plister [path-to-your-preferences.yml] --dump`. This will output all your existing preferences as a YAML file at the specified path, defaulting to `~/.osx.yml` if none is given. You can also pass the `--stdout` flag to dump preferences to STDOUT.
+
 ### 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.
@@ -87,3 +93,13 @@ defaults write NSGlobalDomain WebKitDeveloperExtras -bool true
 sudo defaults write com.apple.SoftwareUpdate AutomaticCheckEnabled -bool true
 default write -currentHost com.apple.ScreenSaver.iLifeSlideShows styleKey VintagePrints
 ```
+
+## Not writable errors
+
+If you get an error that looks like:
+
+```
+/Library/Preferences/[DOMAIN].plist is not writable by [USER] (IOError)
+```
+
+You'll need to preface the `plister` command with `sudo` so that Ruby can write the system-wide preference.

data/bin/plister

@@ -1,12 +1,33 @@
 #!/usr/bin/env ruby
 
+require 'slop'
 require_relative '../lib/plister'
 
-preferences = Plister.preferences(ARGV[0])
+opts = Slop.parse do |o|
+  o.banner = 'usage: plister [file] [options]'
+  o.bool '-h', '--help',    'display usage information'
+  o.bool '-d', '--dump',    'dump preferences to YAML'
+  o.bool '-s', '--stdout',  'dump preferences to STDOUT'
+  o.on   '-v', '--version', 'print the version' do
+    puts Plister::VERSION
+    exit
+  end
+end
 
-puts "Using preference file #{preferences.path}"
-puts "Found preferences for #{preferences.domains.count} applications"
-
-preferences.set!(verbose: true)
-
-puts 'Preferences set!'
+if opts.help?
+  puts opts
+  exit 1
+elsif opts.dump?
+  exporter = Plister::Exporter.new(opts.arguments.first)
+  puts "Dumping preferences to #{exporter.path}"
+  exporter.export
+elsif opts.stdout?
+  exporter = Plister::Exporter.new(opts.arguments.first)
+  puts exporter.to_s
+else
+  preferences = Plister.preferences(opts.arguments.first)
+  puts "Using preference file #{preferences.path}"
+  puts "Found preferences for #{preferences.domains.count} applications"
+  preferences.set!(verbose: true)
+  puts 'Preferences set!'
+end

data/lib/plister.rb

@@ -1,10 +1,11 @@
 require 'cfpropertylist'
 require 'deep_merge'
-require 'yaml'
+require 'psych'
 
 require_relative 'plister/version'
 require_relative 'plister/plist'
 require_relative 'plister/preferences'
+require_relative 'plister/exporter'
 
 module Plister
   class << self
@@ -13,7 +14,11 @@ module Plister
     end
 
     def user
-      @user ||= `logname`.strip
+      @user ||= begin
+        user = `whoami`.strip
+        return user unless user == 'root'
+        `logname`.strip
+      end
     end
 
     def uuid

data/lib/plister/exporter.rb

@@ -0,0 +1,43 @@
+module Plister
+  class Exporter
+    attr_reader :path
+
+    def initialize(path = nil)
+      @path = path || "/Users/#{Plister.user}/.osx.yml"
+    end
+
+    def export
+      File.write path, to_s
+    end
+
+    def to_s
+      Psych.dump(preferences)
+    end
+
+    private
+
+    def types
+      @types ||= {
+        system: '/Library/Preferences',
+        user:   "/Users/#{Plister.user}/Library/Preferences",
+        host:   "/Users/#{Plister.user}/Library/preferences/ByHost"
+      }
+    end
+
+    def paths
+      @paths ||= types.map { |type, path| [type, Dir["#{path}/*.plist"]] }.to_h
+    end
+
+    def preferences
+      @preferences ||= begin
+        output = {}
+        paths.each do |type, plist_paths|
+          plists = plist_paths.map { |domain| Plist.new domain, type: type }
+          plists.select!(&:readable?)
+          output[type.to_s] = plists.map { |p| [p.domain, p.to_h] }.to_h
+        end
+        output
+      end
+    end
+  end
+end

data/lib/plister/plist.rb

@@ -4,14 +4,17 @@ module Plister
     TYPES = %w(user system host).freeze
 
     def initialize(domain, type: 'user')
-      @domain = domain
+      @domain = normalize_domain(domain)
       @type   = type.to_s
-      fail ArgumentError, 'Invalid type' unless valid_type?
+      raise ArgumentError, 'Invalid type' unless valid_type?
     end
 
     def preferences
       @preferences ||= CFPropertyList.native_types(list.value)
+    rescue CFFormatError
+      {}
     end
+    alias to_h preferences
 
     def preferences=(prefs)
       list.value = CFPropertyList.guess(prefs, convert_unknown_to_string: true)
@@ -24,10 +27,22 @@ module Plister
     end
 
     def write
-      fail IOError, "#{path} is not writable by #{Plister.user}" unless writable?
+      raise IOError, "#{path} is not writable by #{Plister.user}" unless writable?
       list.save
     end
 
+    def exists?
+      File.exist?(path)
+    end
+
+    def writable?
+      File.writable?(path)
+    end
+
+    def readable?
+      File.readable?(path)
+    end
+
     private
 
     def path
@@ -44,25 +59,20 @@ module Plister
     end
 
     def list
-      fail IOError, "#{path} does not exist" unless exists?
-      fail IOError, "#{path} is not readable by #{Plister.user}" unless readable?
+      raise IOError, "#{path} does not exist" unless exists?
+      raise 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
+
+    def normalize_domain(domain)
+      domain = File.basename(domain)
+      domain = domain.sub(/\.plist\z/, '')
+      domain = domain.sub(/\.#{Plister.uuid}\z/, '')
+      domain
+    end
   end
 end

data/lib/plister/preferences.rb

@@ -24,7 +24,7 @@ module Plister
     private
 
     def data
-      @data ||= YAML.load(contents)
+      @data ||= Psych.load(contents) || {}
     end
 
     def contents

data/lib/plister/version.rb

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

data/plister.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'CFPropertyList', '~> 2.3'
   spec.add_dependency 'deep_merge', '~> 1.0'
+  spec.add_dependency 'slop', '~> 4.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plister
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: CFPropertyList
@@ -39,61 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: slop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
+        version: '4.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +126,7 @@ files:
 - Rakefile
 - bin/plister
 - lib/plister.rb
+- lib/plister/exporter.rb
 - lib/plister/plist.rb
 - lib/plister/preferences.rb
 - lib/plister/version.rb
@@ -153,9 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A utility for programmatically setting OS X plist file preferences
 test_files: []
-has_rdoc: