macos.rb 0.50.0

data/lib/Version.rb

@@ -0,0 +1,381 @@
+# Version.rb
+# Version
+
+# 20220213
+# 0.14.0
+
+# Description: This class is able to compare strings containing version numbers.
+
+# Changes since 0.13:
+# 1. Removed all reference to version_codes.
+
+lib_dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'Module/alias_methods'
+require 'Ordinal/Array'
+require 'Thoran/String/Capture/capture'
+
+class Version
+
+  module VERSION; STRING = '0.13.0'; end
+
+  class << self
+
+    include Enumerable
+    include Comparable
+
+    attr_accessor :version_strings
+
+    def <<(version)
+      self.version_strings ||= []
+      self.version_strings << to_version_string(version)
+    end
+    alias_methods :append, :push, :<<
+
+    def sorted(*versions)
+      versions = versions.flatten
+      return_value = versions.collect{|version| Version.new(to_version_string(version))}.sort
+      return_value = return_value.collect{|e| e.to_s} if versions.all?{|e| e.is_a?(String)}
+      return_value
+    end
+
+    def latest(*versions)
+      sorted(*versions).last
+    end
+    alias_methods :last, :most_recent, :newest, :highest, :latest
+
+    def major(version)
+      major = to_version_string(version).split('.').first
+      major = major.split('-').first if major && hyphenated_part?(version)
+      major
+    end
+    alias_methods :major_version, :major_number, :major_version_number, :major
+
+    def minor(version)
+      minor = to_version_string(version).split('.').second
+      minor = minor.split('-').first if minor && hyphenated_part?(version)
+      minor
+    end
+    alias_methods :minor_version, :minor_number, :minor_version_number, :minor
+
+    def tiny(version)
+      tiny = to_version_string(version).split('.').third
+      tiny = tiny.split('-').first if tiny && hyphenated_part?(version)
+      tiny
+    end
+    alias_methods :tiny_version, :tiny_number, :tiny_version_number, :tiny
+
+    def build(version)
+      build = to_version_string(version).split('.').fourth
+      build = build.split('-').first if build && hyphenated_part?(version)
+      build
+    end
+    alias_methods :build_version, :build_number, :build_version_number, :build
+
+    def patch(version)
+      if hyphenated_part = self.hyphenated_part(version)
+        hyphenated_part(version).capture(/^(p\d+)/) # It's unlikely that there would be a p without a number.
+      end
+    end
+    alias_methods :patch_level, :patch_version, :patch_number, :patch_version_number, :patch
+
+    def dev(version)
+      if hyphenated_part = self.hyphenated_part(version)
+        hyphenated_part(version).capture(/^(dev\d*)/)
+      end
+    end
+    alias_methods :dev_version, :dev_number, :dev_version_number, :dev
+    alias_methods :development, :development_version, :development_number, :development_version_number, :dev
+
+    def preview(version)
+      if hyphenated_part = self.hyphenated_part(version)
+        hyphenated_part.capture(/^(preview\d*)/) # It's possible that there will be a preview without a number.
+      end
+    end
+    alias_methods :preview_version, :preview_number, :preview_version_number, :preview
+
+    def release_candidate(version)
+      if hyphenated_part = self.hyphenated_part(version)
+        hyphenated_part(version).capture(/^(rc\d*)/)
+      end
+    end
+    alias_methods :release_candidate_version, :release_candidate_number, :release_candidate_version_number, :release_candidate
+    alias_methods :rc, :rc_version, :rc_number, :rc_version_number, :release_candidate
+
+    def hyphenated_part(version)
+      if to_version_string(version).match(/-/)
+        to_version_string(version).split('-').last
+      end
+    end
+
+    def <=>(version_1, version_2)
+      version_1 = Version.new(Version.to_version_string(version_1))
+      version_2 = Version.new(Version.to_version_string(version_2))
+      if version_1.has_hyphenated_part? || version_2.has_hyphenated_part?
+        if (to_a(version_1, false) <=> to_a(version_2, false)) == 0
+          if version_1.hyphenated_part == version_2.hyphenated_part
+            0
+          elsif version_1.hyphenated_part =~ /^dev/
+            case version_2.hyphenated_part
+            when /^dev/; version_1.hyphenated_part <=> version_2.hyphenated_part
+            when /^preview/; -1
+            when /^rc/; -1
+            when /^p\d+/; -1
+            else; -1
+            end
+          elsif version_1.hyphenated_part =~ /^preview/
+            case version_2.hyphenated_part
+            when /^preview/; version_1.hyphenated_part <=> version_2.hyphenated_part
+            when /^dev/; 1
+            when /^rc/; -1
+            when /^p\d+/; -1
+            else; -1
+            end
+          elsif version_1.hyphenated_part =~ /^rc/
+            case version_2.hyphenated_part
+            when /^rc/; version_1.hyphenated_part <=> version_2.hyphenated_part
+            when /^dev/; 1
+            when /^preview/; 1
+            when /^p\d+/; -1
+            else; -1
+            end
+          elsif version_1.hyphenated_part =~ /^p\d+/
+            case version_2.hyphenated_part
+            when /^p\d+/; version_1.hyphenated_part <=> version_2.hyphenated_part
+            when /^dev/; 1
+            when /^preview/; 1
+            when /^rc/; 1
+            else; -1 # This assumes that 2.1.0 != 2.1.0-p0 (ie. 2.1.0-p0 < 2.1.0) and that for all other patch levels that anything with no patch level is superior.
+            end
+          else
+            case version_2.hyphenated_part
+            when /^dev/; 1
+            when /^preview/; 1
+            when /^rc/; 1
+            when /^p\d+/; 1
+            else; 1
+            end
+          end
+        else
+          to_a(version_1, false) <=> to_a(version_2, false)
+        end
+      else
+        to_a(version_1) <=> to_a(version_2)
+      end
+    end
+
+    def ===(version_1, version_2)
+      version_1_size = to_a(version_1).size
+      version_2_size = to_a(version_2).size
+      maximum_shared_places = [version_1_size, version_2_size].min
+      if version_1_size < version_2_size
+        new_version_2 = to_a(version_2).take(maximum_shared_places).join('.')
+        self.<=>(version_1, new_version_2).zero? ? true : false
+      elsif version_1_size > version_2_size
+        new_version_1 = to_a(version_1).take(maximum_shared_places).join('.')
+        self.<=>(new_version_1, version_2).zero? ? true : false
+      else
+        self.<=>(version_1, version_2).zero? ? true : false
+      end
+    end
+
+    def each
+      version_strings.each{|version_string| yield Version.new(version_string)}
+    end
+
+    def to_a(version, include_hyphenated = true)
+      to_a = [major(version), minor(version), tiny(version), build(version)]
+      to_a = to_a + [hyphenated_part(version)] if include_hyphenated
+      to_a.compact
+    end
+
+    def to_version_string(version)
+      version.to_s
+    end
+
+    # boolean methods
+
+    def major?(version)
+      major(version) ? true : false
+    end
+    alias_methods :major_version?, :major_number?, :major_version_number?, :major?
+
+    def minor?(version)
+      minor(version) ? true : false
+    end
+    alias_methods :minor_version?, :minor_number?, :minor_version_number?, :minor?
+
+    def tiny?(version)
+      tiny(version) ? true : false
+    end
+    alias_methods :tiny_version?, :tiny_number?, :tiny_version_number?, :tiny?
+
+    def build?(version)
+      build(version) ? true : false
+    end
+    alias_methods :build_version?, :build_number?, :build_version_number?, :build?
+
+    def patch?(version)
+      patch(version) ? true : false
+    end
+    alias_methods :patch_level?, :patch_version?, :patch_number?, :patch_version_number?, :patch?
+
+    def dev?(version)
+      dev(version) ? true : false
+    end
+    alias_methods :dev_version?, :dev_number?, :dev_version_number?, :dev?
+    alias_methods :development?, :development_version?, :development_number?, :development_version_number?, :dev?
+
+    def preview?(version)
+      preview(version) ? true : false
+    end
+    alias_methods :preview_version?, :preview_number?, :preview_version_number?, :preview?
+
+    def release_candidate?(version)
+      release_candidate(version) ? true : false
+    end
+    alias_methods :release_candidate_version?, :release_candidate_number?, :release_candidate_version_number?, :release_candidate?
+    alias_methods :rc?, :rc_version?, :rc_number?, :rc_version_number?, :release_candidate?
+
+    def hyphenated_part?(version)
+      hyphenated_part(version) ? true : false
+    end
+    alias_methods :has_hyphenated_part?, :hyphenated_part?
+
+  end # class << self
+
+  include Comparable
+
+  attr_accessor :version_string
+
+  def initialize(version_string = nil)
+    @version_string = version_string.to_s
+  end
+
+  def major
+    self.class.major(version_string)
+  end
+  alias_methods :major_version, :major_number, :major_version_number, :major
+
+  def minor
+    self.class.minor(version_string)
+  end
+  alias_methods :minor_version, :minor_number, :minor_version_number, :minor
+
+  def tiny
+    self.class.tiny(version_string)
+  end
+  alias_methods :tiny_version, :tiny_number, :tiny_version_number, :tiny
+
+  def build
+    self.class.build(version_string)
+  end
+  alias_methods :build_version, :build_number, :build_version_number, :build
+
+  def patch
+    self.class.patch(version_string)
+  end
+  alias_methods :patch_level, :patch_version, :patch_number, :patch_version_number, :patch
+
+  def dev
+    self.class.dev(version_string)
+  end
+  alias_methods :dev_version, :dev_number, :dev_version_number, :dev
+  alias_methods :development, :development_version, :development_number, :development_version_number, :dev
+
+  def preview
+    self.class.preview(version_string)
+  end
+  alias_methods :preview_version, :preview_number, :preview_version_number, :patch
+
+  def release_candidate
+    self.class.release_candidate(version_string)
+  end
+  alias_methods :release_candidte_level, :release_candidate_version, :release_candidate_number, :release_candidate_version_number, :release_candidate
+  alias_methods :rc, :rc_version, :rc_number, :rc_version_number, :release_candidate
+
+  def hyphenated_part
+    patch || dev || preview || release_candidate
+  end
+
+  def <=>(other_version)
+    self.class.<=>(version_string, other_version)
+  end
+
+  def ===(other_version)
+    self.class.===(version_string, other_version)
+  end
+
+  def to_a
+    self.class.to_a(version_string)
+  end
+
+  def to_s
+    version_string
+  end
+
+  def least_significant_version_part_name
+    if patch?
+      :patch
+    elsif build?
+      :build
+    elsif tiny?
+      :tiny
+    elsif minor?
+      :minor
+    else
+      :major
+    end
+  end
+
+  # boolean methods
+
+  def major?
+    self.class.major?(version_string)
+  end
+  alias_methods :major_version?, :major_number?, :major_version_number?, :major?
+
+  def minor?
+    self.class.minor?(version_string)
+  end
+  alias_methods :minor_version?, :minor_number?, :minor_version_number?, :minor?
+
+  def tiny?
+    self.class.tiny?(version_string)
+  end
+  alias_methods :tiny_version?, :tiny_number?, :tiny_version_number?, :tiny?
+
+  def build?
+    self.class.build?(version_string)
+  end
+  alias_methods :build_version?, :build_number?, :build_version_number?, :build?
+
+  def patch?
+    self.class.patch?(version_string)
+  end
+  alias_methods :patch_level?, :patch_version?, :patch_number?, :patch_version_number?, :patch?
+
+  def dev?
+    self.class.dev?(version_string)
+  end
+  alias_methods :dev_version?, :dev_number?, :dev_version_number?, :dev?
+  alias_methods :development?, :development_version?, :development_number?, :development_version_number?, :dev?
+
+  def preview?
+    self.class.preview?(version_string) ? true : false
+  end
+  alias_methods :preview_version?, :preview_number?, :preview_version_number?, :preview?
+
+  def release_candidate?
+    self.class.release_candidate?(version_string) ? true : false
+  end
+  alias_methods :release_candidate_version?, :release_candidate_number?, :release_candidate_version_number?, :release_candidate?
+  alias_methods :rc?, :rc_version?, :rc_number?, :rc_version_number?, :release_candidate?
+
+  def hyphenated_part?
+    patch? || dev? || preview? || release_candidate?
+  end
+  alias_methods :has_hyphenated_part?, :hyphenated_part?
+
+end

data/macos.rb.gemspec

@@ -0,0 +1,59 @@
+# macos.rb.gemspec
+
+require_relative './lib/MacOS/VERSION'
+
+class Gem::Specification
+  def dependencies=(gems)
+    gems.each{|gem| add_dependency(*gem)}
+  end
+
+  def development_dependencies=(gems)
+    gems.each{|gem| add_development_dependency(*gem)}
+  end
+end
+
+Gem::Specification.new do |spec|
+  spec.name = 'macos.rb'
+  spec.version = MacOS::VERSION
+
+  spec.summary = "Work with macOS from Ruby."
+  spec.description = "Work with macOS from Ruby: network interfaces and hardware ports, the system's version, defaults, disks and disk images, USB flash drives, applications, users, voices, the keychain and launchd."
+
+  spec.author = 'thoran'
+  spec.email = 'code@thoran.com'
+  spec.homepage = 'https://github.com/thoran/macos.rb'
+  spec.license = 'MIT'
+
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/thoran/macos.rb/issues',
+    'changelog_uri' => 'https://github.com/thoran/macos.rb/blob/master/CHANGELOG',
+    'source_code_uri' => 'https://github.com/thoran/macos.rb',
+    'documentation_uri' => 'https://github.com/thoran/macos.rb/blob/master/README.md',
+  }
+
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.7'
+
+  spec.files = [
+    'macos.rb.gemspec',
+    Dir['lib/**/*.rb'],
+    Dir['test/**/*.rb'],
+    Dir['test/fixtures/*'],
+    'CHANGELOG',
+    'Gemfile',
+    'LICENSE',
+    'Rakefile',
+    'README.md',
+  ].flatten
+
+  spec.dependencies = %w{
+    CFPropertyList
+    plist
+  }
+
+  spec.development_dependencies = %w{
+    minitest
+    minitest-mock
+    rake
+  }
+end

data/test/MacOS/Apple80211_test.rb

@@ -0,0 +1,80 @@
+require_relative '../helper'
+require 'MacOS/Apple80211'
+
+describe MacOS::Apple80211 do
+  let(:wifi){fixture('system_profiler-SPAirPortDataType.txt')}
+
+  def with_sources(airport, system_profiler = fixture('system_profiler-SPAirPortDataType.txt'), &block)
+    MacOS::Apple80211.stub(:airport_i, airport) do
+      MacOS::Apple80211.stub(:system_profiler_airport, system_profiler, &block)
+    end
+  end
+
+  describe "where airport -I reports, as before macOS 14.4" do
+    it "reads its attributes" do
+      with_sources(fixture('airport-I.txt')) do
+        attributes = MacOS::Apple80211.attributes
+        _(attributes['BSSID']).must_equal('00:00:5e:00:53:20')
+        _(attributes['agrCtlRSSI']).must_equal('-52')
+        _(attributes['op mode']).must_equal('station')
+      end
+    end
+
+    it "gives the channel, SSID and link authentication" do
+      with_sources(fixture('airport-I.txt')) do
+        _(MacOS::Apple80211.channel).must_equal('36,80')
+        _(MacOS::Apple80211.ssid).must_equal('ExampleNet')
+        _(MacOS::Apple80211.link_auth).must_equal('wpa2-psk')
+      end
+    end
+  end
+
+  describe "where airport -I gives only its deprecation, as from macOS 14.4 on" do
+    it "reads the current network from system_profiler instead" do
+      with_sources(fixture('airport-I-deprecated.txt')) do
+        attributes = MacOS::Apple80211.attributes
+        _(attributes['PHY Mode']).must_equal('802.11ax')
+        _(attributes['Signal / Noise']).must_equal('-52 dBm / -94 dBm')
+        _(attributes.keys).wont_include('WARNING')
+      end
+    end
+
+    it "gives its channel and security as system_profiler gives them" do
+      with_sources(fixture('airport-I-deprecated.txt')) do
+        _(MacOS::Apple80211.channel).must_equal('36 (5GHz, 80MHz)')
+        _(MacOS::Apple80211.link_auth).must_equal('WPA2 Personal')
+      end
+    end
+
+    it "gives no SSID where macOS redacts the network's name" do
+      with_sources(fixture('airport-I-deprecated.txt')) do
+        _(MacOS::Apple80211.ssid).must_be_nil
+      end
+    end
+
+    it "gives the SSID where macOS doesn't redact it" do
+      with_sources(fixture('airport-I-deprecated.txt'), wifi.sub('            <redacted>:', '            ExampleNet:')) do
+        _(MacOS::Apple80211.ssid).must_equal('ExampleNet')
+      end
+    end
+
+    it "gives nothing where there's no current network" do
+      with_sources(fixture('airport-I-deprecated.txt'), "Wi-Fi:\n\n      Interfaces:\n        en0:\n          Status: Off\n") do
+        _(MacOS::Apple80211.attributes).must_equal({})
+        _(MacOS::Apple80211.channel).must_be_nil
+      end
+    end
+  end
+
+  describe "where airport isn't there" do
+    it "reads system_profiler" do
+      missing = ->(command){raise Errno::ENOENT, command}
+      MacOS::Apple80211.stub(:`, missing) do
+        _(MacOS::Apple80211.airport_i).must_equal('')
+      end
+      with_sources('') do
+        _(MacOS::Apple80211.channel).must_equal('36 (5GHz, 80MHz)')
+      end
+    end
+  end
+end

data/test/MacOS/Applications_test.rb

@@ -0,0 +1,82 @@
+require_relative '../helper'
+require 'fileutils'
+require 'tmpdir'
+require 'MacOS/Applications'
+
+describe MacOS::Applications do
+  let(:paths){['/System/Applications/Mail.app', '/Applications/Example App.app']}
+
+  def with_paths(&block)
+    MacOS::Applications.stub(:paths, paths, &block)
+  end
+
+  describe "finding an application" do
+    it "finds one by its name, with or without .app" do
+      with_paths do
+        _(MacOS::Applications.path_for('Mail')).must_equal('/System/Applications/Mail.app')
+        _(MacOS::Applications.path_for('Example App.app')).must_equal('/Applications/Example App.app')
+      end
+    end
+
+    it "knows whether one is installed" do
+      with_paths do
+        _(MacOS::Applications.installed?('Mail')).must_equal(true)
+        _(MacOS::Applications.installed?('Nowhere')).must_equal(false)
+      end
+    end
+  end
+
+  describe "where it looks" do
+    def by_directory(&block)
+      MacOS::Applications.stub(:in_directory, ->(directory){["#{directory}/In.app"]}) do
+        MacOS::Applications.stub(:under_directory, ->(directory){["#{directory}/Under.app"]}, &block)
+      end
+    end
+
+    it "looks in the system, local and user domains, the user's own searched all the way down" do
+      by_directory do
+        _(MacOS::Applications.paths('example')).must_equal(%w{
+          /System/Applications/In.app /System/Applications/Utilities/In.app
+          /Applications/In.app /Applications/Utilities/In.app
+          /Users/example/Applications/Under.app
+        })
+      end
+    end
+
+    it "looks in every real user's Applications" do
+      by_directory do
+        MacOS::Users.stub(:all, %w{another example}) do
+          _(MacOS::Applications.all_user_paths).must_equal(%w{/Users/another/Applications/Under.app /Users/example/Applications/Under.app})
+        end
+      end
+    end
+  end
+
+  describe "the applications in a directory" do
+    it "finds those directly in it, and those anywhere under it but not inside another application" do
+      Dir.mktmpdir do |directory|
+        %w{Top.app Sub/Nested.app Top.app/Contents/Helpers/Helper.app}.each{|path| FileUtils.mkdir_p(File.join(directory, path))}
+        _(MacOS::Applications.in_directory(directory).map{|path| File.basename(path)}).must_equal(%w{Top.app})
+        _(MacOS::Applications.under_directory(directory).map{|path| File.basename(path)}.sort).must_equal(%w{Nested.app Top.app})
+      end
+    end
+  end
+
+  describe "starting an application" do
+    it "opens it, by each of its names" do
+      with_paths do
+        commands = commands_run_by(MacOS::Applications) do
+          %i{start launch open run}.each{|method| MacOS::Applications.send(method, 'Mail')}
+        end
+        _(commands).must_equal([['open', '/System/Applications/Mail.app']] * 4)
+      end
+    end
+
+    it "does nothing for an application which isn't installed" do
+      with_paths do
+        commands = commands_run_by(MacOS::Applications){_(MacOS::Applications.start('Nowhere')).must_be_nil}
+        _(commands).must_equal([])
+      end
+    end
+  end
+end

data/test/MacOS/Defaults/ComAppleDock_test.rb

@@ -0,0 +1,66 @@
+require_relative '../../helper'
+require 'MacOS/Defaults/ComAppleDock'
+
+describe MacOS::Defaults::ComAppleDock do
+  let(:dock){MacOS::Defaults::ComAppleDock}
+
+  def with_dock(&block)
+    MacOS::Defaults::ComAppleDock.stub(:`, fixture('defaults-export-com.apple.dock.xml'), &block)
+  end
+
+  describe "writing attributes" do
+    it "marks booleans as -bool and integers as -int" do
+      _(dock.attribute_write_command('autohide', true)).must_equal('defaults write com.apple.dock autohide -bool true')
+      _(dock.attribute_write_command('tilesize', 48)).must_equal('defaults write com.apple.dock tilesize -int 48')
+      _(dock.attribute_write_command('orientation', 'left')).must_equal('defaults write com.apple.dock orientation left')
+    end
+
+    it "loads a configuration, adding each persistent app and writing each other attribute" do
+      commands = commands_run_by(dock){dock.load('persistent-apps' => ['/Applications/Example.app'], 'autohide' => true)}
+      _(commands.size).must_equal(2)
+      _(commands.first.first).must_match(%r{\Adefaults write com\.apple\.dock persistent-apps -array-add '<dict>.*file:///Applications/Example\.app}m)
+      _(commands.last).must_equal(['defaults write com.apple.dock autohide -bool true'])
+    end
+
+    it "deletes the persistent apps and others, and the recent apps" do
+      commands = commands_run_by(dock){dock.delete_all_items}
+      _(commands.flatten).must_equal(%w{persistent-apps persistent-others recent-apps}.map{|item| "defaults delete com.apple.dock #{item}"})
+    end
+  end
+
+  describe "an app's tile" do
+    it "is the app's file URL in the Dock's tile data" do
+      _(dock.urlified_app_string('/Applications/Example.app')).must_equal('file:///Applications/Example.app')
+      _(dock.app_plist_data('file:///Applications/Example.app')).must_include('<string>file:///Applications/Example.app</string>')
+    end
+  end
+
+  describe "reading" do
+    it "reads the persistent apps back as paths, a user's own with ~ for their home" do
+      with_dock do
+        _(dock.read('persistent-apps')).must_equal('persistent-apps' => ['/System/Applications/Mail.app/', '~/Applications/Example App.app'])
+      end
+    end
+
+    it "reads booleans as yes and no, and other attributes as they are" do
+      with_dock do
+        _(dock.read('autohide', 'magnification', 'tilesize', 'orientation')).must_equal(
+          'autohide' => 'yes', 'magnification' => 'no', 'tilesize' => 48, 'orientation' => 'bottom'
+        )
+      end
+    end
+
+    it "leaves out the persistent others and the recent apps" do
+      with_dock do
+        _(dock.read.keys).wont_include('recent-apps')
+        _(dock.read.keys).wont_include('persistent-others')
+      end
+    end
+
+    it "writes what it reads as YAML" do
+      with_dock do
+        _(YAML.load(dock.to_yaml)['tilesize']).must_equal(48)
+      end
+    end
+  end
+end