dockedit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e0f5c8c02becb27646e58e86489ffaa4b577ee7a44095afc03ef61a005ca592b
+  data.tar.gz: a3bbd0cf87acb76213674a15ff5c4b24c3227c02821c24365fe2d3e0bc66a6e7
+SHA512:
+  metadata.gz: 14174fbb8eff9f09c4c6196bdb270572e0d87504ee305fd63314e01d195a2a8de7f2e2e0af4586b29f056359078aa3322d61f0ec40de64847ab895caf8141b62
+  data.tar.gz: a7a61f7fb7aa5bf175d817e0f96e540dfed0fdd05c2d31f00bc1e296b62ffb463d8af9c0e875f756327c15b58a438ff5370e74760e83c3676173f34e3c7e44be

data/.rspec

@@ -0,0 +1,4 @@
+--require spec_helper
+--format documentation
+
+

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### 1.0.0
+
+2025-12-17 07:21
+
+#### NEW
+
+- Add standalone (non-gem) version and script to generate
+

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dockedit.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rspec', '~> 3.12'
+  gem 'rake', '~> 13.2'
+end
+

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    dockedit (1.0.0)
+      rexml (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.6.2)
+    rake (13.3.1)
+    rexml (3.4.4)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.7)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.6)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  dockedit!
+  rake (~> 13.2)
+  rspec (~> 3.12)
+
+BUNDLED WITH
+   2.7.2

data/README.md

@@ -0,0 +1,262 @@
+## dockedit
+
+`dockedit` is a command‑line tool for editing the macOS Dock. It lets you add, remove, move, and manage apps and folders (including inserting spacer tiles) without touching System Settings.
+
+### Installation
+
+- **From RubyGems**:
+
+```bash
+gem install dockedit
+```
+
+- **From source (local clone)**:
+
+```bash
+bundle install
+bundle exec rake test
+```
+
+This installs the `dockedit` executable.
+
+- **Standalone file** (no gem install required):
+
+The repository includes a standalone `dockedit` file in the root directory that can be used directly without installing the gem. To regenerate this file after making changes to library files, run:
+
+```bash
+ruby build_standalone.rb
+```
+
+**Note**: If you add new library files, you must include them in the `FILE_ORDER` array in `build_standalone.rb` before running the script.
+
+### Basic usage
+
+```bash
+dockedit <subcommand> [options] [args]
+```
+
+Global behavior:
+
+- **`dockedit --help`**: Show top‑level help and subcommand list.
+- **`dockedit help <subcommand>`**: Show detailed help for a subcommand (`add`, `move`, `remove`, `space`).
+- **`dockedit -v` / `dockedit --version`**: Print the current version.
+
+Subcommands:
+
+- `add`   – add apps and/or folders to the Dock.
+- `remove` – remove apps and/or folders from the Dock.
+- `move` – move an existing Dock item after another item.
+- `space` – insert one or more spacer tiles in the apps section.
+
+Folder shortcuts you can use instead of full paths:
+
+- `desktop`, `downloads`, `home`/`~`, `library`, `documents`, `applications`/`apps`, `sites`.
+
+---
+
+## Subcommands
+
+### `add` – add apps and folders
+
+**Usage**:
+
+```bash
+dockedit add [options] <app_or_folder> [...]
+```
+
+You can pass any mix of:
+
+- App names (e.g. `Safari`, `Terminal`, `Notes`) – resolved via Spotlight-style search.
+- Explicit app paths (e.g. `/Applications/Safari.app`).
+- Folder paths (e.g. `~/Downloads`, `~/Sites`), including the folder shortcuts above.
+
+If a folder already exists in the Dock, `dockedit add` will update its view/style if you pass `--show` or `--display` rather than adding a duplicate.
+
+**Options**:
+
+- **`-a`, `--after ITEM`**
+  Insert the new item(s) after the specified Dock item (app or folder).
+  `ITEM` is matched fuzzily by name (e.g. `Safari`, `Terminal`, or a folder name).
+
+- **`--show TYPE`, `--view TYPE`** (folders only)
+  Set the folder view mode. `TYPE` accepts:
+  - `fan` / `f`
+  - `grid` / `g`
+  - `list` / `l`
+  - `auto` / `a` (default)
+
+- **`--display TYPE`** (folders only)
+  Set the folder style/appearance. `TYPE` accepts:
+  - `folder` / `f` – shows the folder icon
+  - `stack` / `s` – shows a stack of contents
+
+**Examples**:
+
+```bash
+# Add apps to the end of the apps section
+dockedit add Safari Terminal
+
+# Add Downloads folder as a grid-style stack
+dockedit add ~/Downloads --show grid --display stack
+
+# Add Notes after Safari
+dockedit add --after Safari Notes
+
+# Add Sites folder with folder icon and grid view
+dockedit add ~/Sites --display folder --show grid
+```
+
+---
+
+### `remove` – remove apps and folders
+
+**Usage**:
+
+```bash
+dockedit remove <app_or_folder> [...]
+```
+
+You can pass:
+
+- App names or bundle identifiers (e.g. `Safari`, `com.apple.Safari`).
+- Folder paths or folder names (including the defined shortcuts).
+
+If an item can’t be found, `dockedit` prints a warning and continues with the remaining items.
+
+**Examples**:
+
+```bash
+# Remove multiple apps
+dockedit remove Safari Terminal
+
+# Remove Downloads folder
+dockedit remove ~/Downloads
+```
+
+To see help for this subcommand:
+
+```bash
+dockedit help remove
+```
+
+---
+
+### `move` – move a Dock item after another
+
+**Usage**:
+
+```bash
+dockedit move --after <target> <item_to_move>
+# or
+dockedit move <item_to_move> --after <target>
+```
+
+`move` lets you reorder existing Dock items relative to another item. Both items must already be in the Dock, and they must be in the same section (apps or folders) — moving between sections is not allowed.
+
+**Options**:
+
+- **`-a`, `--after ITEM`** (required)
+  The target item after which `item_to_move` should be placed. Fuzzy‑matched by name.
+
+**Rules and behavior**:
+
+- If either the target or the item to move is not found, `dockedit` exits with an error.
+- You cannot move an item after itself.
+- You cannot move items between the apps section and the folders section.
+
+**Examples**:
+
+```bash
+# Explicit: move Safari after Terminal
+dockedit move --after Terminal Safari
+
+# Alternative order: same effect
+dockedit move Safari --after Terminal
+```
+
+To see help for this subcommand:
+
+```bash
+dockedit help move
+```
+
+---
+
+### `space` – insert spacer tiles
+
+**Usage**:
+
+```bash
+dockedit space [options]
+```
+
+`space` inserts one or more spacer tiles in the apps section of the Dock. You can add a space at the end of the apps list, or after specific apps.
+
+**Options**:
+
+- **`-s`, `--small`, `--half`**
+  Insert a small/half-size space instead of a full-size spacer.
+
+- **`-a`, `--after APP`** (repeatable)
+  Insert a space after the specified app. You can use this option multiple times to insert several spaces in different locations in one command. Each `APP` is fuzzy‑matched by name.
+
+**Behavior**:
+
+- With no `--after` options, a single space (small or full) is added at the end of the apps section.
+- With one or more `--after` options, a space is inserted after each referenced app, one by one.
+- If an `APP` is not found, `dockedit` exits with an error.
+
+**Examples**:
+
+```bash
+# Add a full-size space at the end of the apps section
+dockedit space
+
+# Add a single small space at the end
+dockedit space --small
+
+# Add a full-size space after Safari
+dockedit space --after Safari
+
+# Add small spaces after Terminal and Safari (in that order)
+dockedit space --small --after Terminal --after Safari
+```
+
+To see help for this subcommand:
+
+```bash
+dockedit help space
+```
+
+---
+
+### Global help and version
+
+**Top-level help**:
+
+```bash
+dockedit --help
+dockedit help
+```
+
+Shows the main usage, subcommand list, folder shortcuts, and examples.
+
+**Subcommand help**:
+
+```bash
+dockedit help add
+dockedit help move
+dockedit help remove
+dockedit help space
+```
+
+**Version**:
+
+```bash
+dockedit -v
+dockedit --version
+```
+
+Prints the current `dockedit` version (from `DockEdit::VERSION`).
+
+

data/Rakefile

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+require_relative 'lib/dockedit/version'
+
+# Load the gemspec
+Gem::Specification.load('dockedit.gemspec')
+
+namespace :version do
+  desc 'Bump version: major, minor, or patch'
+  task :bump, [:level] do |_t, args|
+    level = (args[:level] || 'patch').to_sym
+    version_file = 'lib/dockedit/version.rb'
+
+    current_version = DockEdit::VERSION
+    parts = current_version.split('.').map(&:to_i)
+
+    case level
+    when :major
+      parts[0] += 1
+      parts[1] = 0
+      parts[2] = 0
+    when :minor
+      parts[1] += 1
+      parts[2] = 0
+    when :patch
+      parts[2] += 1
+    else
+      raise "Invalid version level: #{level}. Use major, minor, or patch"
+    end
+
+    new_version = parts.join('.')
+
+    # Read the version file
+    content = File.read(version_file)
+    # Replace the version
+    content.gsub!(/VERSION = ['"][\d.]+['"]/, "VERSION = '#{new_version}'")
+
+    # Write it back
+    File.write(version_file, content)
+
+    puts "Version bumped from #{current_version} to #{new_version}"
+    puts "Don't forget to commit and tag:"
+    puts "  git add #{version_file}"
+    puts "  git commit -m 'Bump version to #{new_version}'"
+    puts "  git tag -a v#{new_version} -m 'Version #{new_version}'"
+    puts '  git push && git push --tags'
+  end
+
+  desc 'Show current version'
+  task :show do
+    puts DockEdit::VERSION
+  end
+end
+
+desc 'Remove generated files'
+task :clobber do
+  require 'fileutils'
+  FileUtils.rm_rf('pkg')
+  puts 'Removed pkg directory'
+end
+
+desc 'Build the gem'
+task :build do
+  require 'rubygems/package'
+  require 'fileutils'
+
+  FileUtils.mkdir_p('pkg')
+
+  sh 'gem build dockedit.gemspec'
+  FileUtils.mv("dockedit-#{DockEdit::VERSION}.gem", "pkg/dockedit-#{DockEdit::VERSION}.gem")
+  puts "Built gem: pkg/dockedit-#{DockEdit::VERSION}.gem"
+end
+
+desc 'Run the test suite (RSpec)'
+RSpec::Core::RakeTask.new(:test) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+desc 'Generate RDoc documentation'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "dockedit #{DockEdit::VERSION}"
+  rdoc.options  = ['--line-numbers', '--inline-source']
+  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+end
+
+desc 'Package the gem (build and place in pkg/)'
+task package: %i[clobber build]
+
+desc 'Install the gem locally'
+task :install do
+  sh "gem install pkg/dockedit-#{DockEdit::VERSION}.gem"
+end

data/bin/dockedit

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# dockedit - A script to edit the macOS Dock
+# Usage: dockedit <subcommand> [options] [args]
+
+require 'dockedit'
+
+DockEdit::CLI.run
+

data/build_standalone.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Script to build a standalone, single-file version of dockedit
+
+require 'fileutils'
+
+LIB_DIR = File.join(__dir__, 'lib', 'dockedit')
+OUTPUT_FILE = File.join(__dir__, 'dockedit')
+
+# File order based on dependency order in lib/dockedit.rb
+FILE_ORDER = %w[
+  version.rb
+  constants.rb
+  matcher.rb
+  path_utils.rb
+  plist_reader.rb
+  plist_writer.rb
+  app_finder.rb
+  tile_factory.rb
+  folder_updater.rb
+  parsers.rb
+  dock.rb
+  commands.rb
+  cli.rb
+].freeze
+
+# Standard library requires from lib/dockedit.rb
+STANDARD_REQUIRES = <<~RUBY
+#!/usr/bin/env ruby
+# 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'
+RUBY
+
+def remove_require_statements(content)
+  # Remove require_relative statements (they're not needed in a single file)
+  content.lines.reject { |line| line.strip.start_with?('require_relative') }.join
+end
+
+def build_standalone_file
+  output = String.new
+  output << STANDARD_REQUIRES
+  output << "\n"
+
+  FILE_ORDER.each do |filename|
+    filepath = File.join(LIB_DIR, filename)
+    unless File.exist?(filepath)
+      warn "Warning: File #{filepath} not found"
+      next
+    end
+
+    content = File.read(filepath)
+    content = remove_require_statements(content)
+    output << content
+    output << "\n" unless content.end_with?("\n")
+    output << "\n"
+  end
+
+  # Add main execution block
+  output << <<~RUBY
+
+if __FILE__ == $0
+  DockEdit::CLI.run
+end
+RUBY
+
+  output
+end
+
+def main
+  standalone_content = build_standalone_file
+
+  File.write(OUTPUT_FILE, standalone_content)
+  FileUtils.chmod('+x', OUTPUT_FILE)
+
+  puts "Standalone file generated: #{OUTPUT_FILE}"
+  puts "File size: #{File.size(OUTPUT_FILE)} bytes"
+end
+
+main if __FILE__ == $0