dockedit 1.0.0

data/lib/dockedit/tile_factory.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module DockEdit
+  # Factory for creating Dock tile elements.
+  #
+  # These helpers construct the REXML structures that represent apps,
+  # folders, and spacer tiles inside the Dock plist.
+  class TileFactory
+    # Create a spacer tile element.
+    #
+    # @param small [Boolean] When +true+, create a half-size spacer.
+    # @return [REXML::Element] Newly created tile `<dict>` element.
+    def self.create_spacer_tile(small: false)
+      tile_type = small ? 'small-spacer-tile' : 'spacer-tile'
+
+      spacer = REXML::Element.new('dict')
+
+      key1 = REXML::Element.new('key')
+      key1.text = 'tile-data'
+      spacer.add(key1)
+
+      tile_data = REXML::Element.new('dict')
+      label_key = REXML::Element.new('key')
+      label_key.text = 'file-label'
+      tile_data.add(label_key)
+      label_string = REXML::Element.new('string')
+      label_string.text = ''
+      tile_data.add(label_string)
+      spacer.add(tile_data)
+
+      key2 = REXML::Element.new('key')
+      key2.text = 'tile-type'
+      spacer.add(key2)
+
+      type_string = REXML::Element.new('string')
+      type_string.text = tile_type
+      spacer.add(type_string)
+
+      spacer
+    end
+
+    # Create an app tile element.
+    #
+    # @param app_path [String] Absolute path to the `.app` bundle.
+    # @param app_info [Hash] Parsed plist info from {PlistReader.read_app_info}.
+    # @return [REXML::Element] Newly created tile `<dict>` element.
+    def self.create_app_tile(app_path, app_info)
+      app_dict = REXML::Element.new('dict')
+
+      # tile-data key
+      td_key = REXML::Element.new('key')
+      td_key.text = 'tile-data'
+      app_dict.add(td_key)
+
+      # tile-data dict
+      tile_data = REXML::Element.new('dict')
+
+      # bundle-identifier
+      add_plist_key_value(tile_data, 'bundle-identifier', 'string', app_info['CFBundleIdentifier'])
+
+      # dock-extra
+      add_plist_key_value(tile_data, 'dock-extra', 'false', nil)
+
+      # file-data dict
+      fd_key = REXML::Element.new('key')
+      fd_key.text = 'file-data'
+      tile_data.add(fd_key)
+
+      file_data = REXML::Element.new('dict')
+      add_plist_key_value(file_data, '_CFURLString', 'string', "file://#{URI.encode_www_form_component(app_path).gsub('%2F', '/')}/")
+      add_plist_key_value(file_data, '_CFURLStringType', 'integer', '15')
+      tile_data.add(file_data)
+
+      # file-label
+      label = app_info['CFBundleName'] || app_info['CFBundleDisplayName'] || File.basename(app_path, '.app')
+      add_plist_key_value(tile_data, 'file-label', 'string', label)
+
+      # file-mod-date
+      add_plist_key_value(tile_data, 'file-mod-date', 'integer', '0')
+
+      # file-type
+      add_plist_key_value(tile_data, 'file-type', 'integer', '41')
+
+      # is-beta
+      add_plist_key_value(tile_data, 'is-beta', 'false', nil)
+
+      # parent-mod-date
+      add_plist_key_value(tile_data, 'parent-mod-date', 'integer', '0')
+
+      app_dict.add(tile_data)
+
+      # tile-type key
+      tt_key = REXML::Element.new('key')
+      tt_key.text = 'tile-type'
+      app_dict.add(tt_key)
+
+      tt_value = REXML::Element.new('string')
+      tt_value.text = 'file-tile'
+      app_dict.add(tt_value)
+
+      app_dict
+    end
+
+    # Create a folder tile element.
+    #
+    # @param folder_path [String] Absolute path to the folder.
+    # @param show_as [Integer] Show-as value (1=fan, 2=grid, 3=list, 4=auto).
+    # @param display_as [Integer] Display-as value (0=stack, 1=folder).
+    # @return [REXML::Element] Newly created folder tile `<dict>` element.
+    def self.create_folder_tile(folder_path, show_as: 4, display_as: 1)
+      folder_dict = REXML::Element.new('dict')
+
+      # tile-data key
+      td_key = REXML::Element.new('key')
+      td_key.text = 'tile-data'
+      folder_dict.add(td_key)
+
+      # tile-data dict
+      tile_data = REXML::Element.new('dict')
+
+      # arrangement (0 = by name)
+      add_plist_key_value(tile_data, 'arrangement', 'integer', '0')
+
+      # displayas (0 = stack, 1 = folder)
+      add_plist_key_value(tile_data, 'displayas', 'integer', display_as.to_s)
+
+      # file-data dict
+      fd_key = REXML::Element.new('key')
+      fd_key.text = 'file-data'
+      tile_data.add(fd_key)
+
+      file_data = REXML::Element.new('dict')
+      encoded_path = URI.encode_www_form_component(folder_path).gsub('%2F', '/')
+      add_plist_key_value(file_data, '_CFURLString', 'string', "file://#{encoded_path}/")
+      add_plist_key_value(file_data, '_CFURLStringType', 'integer', '15')
+      tile_data.add(file_data)
+
+      # file-label
+      label = File.basename(folder_path)
+      add_plist_key_value(tile_data, 'file-label', 'string', label)
+
+      # file-mod-date
+      add_plist_key_value(tile_data, 'file-mod-date', 'integer', '0')
+
+      # file-type
+      add_plist_key_value(tile_data, 'file-type', 'integer', '2')
+
+      # parent-mod-date
+      add_plist_key_value(tile_data, 'parent-mod-date', 'integer', '0')
+
+      # preferreditemsize (-1 = default)
+      add_plist_key_value(tile_data, 'preferreditemsize', 'integer', '-1')
+
+      # showas (1=fan, 2=grid, 3=list, 4=auto)
+      add_plist_key_value(tile_data, 'showas', 'integer', show_as.to_s)
+
+      folder_dict.add(tile_data)
+
+      # tile-type key
+      tt_key = REXML::Element.new('key')
+      tt_key.text = 'tile-type'
+      folder_dict.add(tt_key)
+
+      tt_value = REXML::Element.new('string')
+      tt_value.text = 'directory-tile'
+      folder_dict.add(tt_value)
+
+      folder_dict
+    end
+
+    # Helper to add a key/value pair to a plist `<dict>` element.
+    #
+    # @param dict [REXML::Element] Target `<dict>` element.
+    # @param key_name [String] Key to add.
+    # @param value_type [String] Name of the value element type (e.g. "string").
+    # @param value [String, nil] Optional text value for the element.
+    # @return [void]
+    def self.add_plist_key_value(dict, key_name, value_type, value)
+      key = REXML::Element.new('key')
+      key.text = key_name
+      dict.add(key)
+
+      val_elem = REXML::Element.new(value_type)
+      val_elem.text = value if value
+      dict.add(val_elem)
+    end
+  end
+end
+

data/lib/dockedit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module DockEdit
+  # Current dockedit gem version.
+  VERSION = '1.0.0'
+end
+

data/lib/dockedit.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# dockedit - A script to edit the macOS Dock
+# Usage: dockedit <subcommand> [options] [args]
+
+require 'rexml/document'
+require 'fileutils'
+require 'optparse'
+require 'uri'
+require 'stringio'
+
+require_relative 'dockedit/version'
+require_relative 'dockedit/constants'
+require_relative 'dockedit/matcher'
+require_relative 'dockedit/path_utils'
+require_relative 'dockedit/plist_reader'
+require_relative 'dockedit/plist_writer'
+require_relative 'dockedit/app_finder'
+require_relative 'dockedit/tile_factory'
+require_relative 'dockedit/folder_updater'
+require_relative 'dockedit/parsers'
+require_relative 'dockedit/dock'
+require_relative 'dockedit/commands'
+require_relative 'dockedit/cli'
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: dockedit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Brett Terpstra
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: dockedit allows you to add, remove, move, and manage apps and folders
+  in your macOS Dock from the command line
+email:
+- github@brettterpstra.com
+executables:
+- dockedit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/dockedit
+- build_standalone.rb
+- dockedit
+- lib/dockedit.rb
+- lib/dockedit/app_finder.rb
+- lib/dockedit/cli.rb
+- lib/dockedit/commands.rb
+- lib/dockedit/constants.rb
+- lib/dockedit/dock.rb
+- lib/dockedit/folder_updater.rb
+- lib/dockedit/matcher.rb
+- lib/dockedit/parsers.rb
+- lib/dockedit/path_utils.rb
+- lib/dockedit/plist_reader.rb
+- lib/dockedit/plist_writer.rb
+- lib/dockedit/tile_factory.rb
+- lib/dockedit/version.rb
+homepage: https://github.com/ttscoff/dockedit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ttscoff/dockedit
+  source_code_uri: https://github.com/ttscoff/dockedit
+  changelog_uri: https://github.com/ttscoff/dockedit/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: A command-line tool to edit the macOS Dock
+test_files: []