libtmux-workspace 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67f1d8ae912d503b3f05aa72b9740ab8610899bf110ff6c9def7a491e2ab1467
-  data.tar.gz: b508046883150482276d3647766aa3beedd7d63e658662eb8643a8667262a355
+  metadata.gz: 81a6e6bcb2e2b40052ea69a7ac812919bc40c061eff86d8f1ed24d74db1bdd89
+  data.tar.gz: bed554f76a48119e57294fa4199479ce7d9ce1e9864d9a3189224daa11979be7
 SHA512:
-  metadata.gz: d2a319893795e19c71a96ef8060f5468fbbd9218bd566ded215872e057064da62c53cd6c0883f98191ead6f7b7d7ff8cf2c3682eca7d6c8d2a5af56d46fdede5
-  data.tar.gz: e725e40e92e6515ea0cb8d49c5b7051e0e7a89499a97c7cd9c4254d19d0a865a9b8621a0381cca32d008e164f062974437ab78dc1abea8849800fd317cc652bd
+  metadata.gz: 42b471a92bea5e05bfea43e6005c0373df57aa5606e00c1e72af64960e33b0de755edfb48d6b4f6b07b665b8d59c9ef45b71a0e62cca087bbe82b50d12117b02
+  data.tar.gz: 37069ac56ea23c718a2e1cf7029297151ca5672a96ca1d4420aeef4b3fbba99e6ead871aebe999e1dc0a828d3d75a9361549f52f20ca6b451c9d4f9300fbbe1e

data/CHANGELOG.md

@@ -0,0 +1,51 @@
+# Changelog
+
+Notable changes to `libtmux-workspace`.
+
+Releases are numbered `0.1.N`, and each release increments `N`. The API is not
+settled: pin an exact version to avoid a break.
+
+The gems are released together at one version, so every release has a section
+here. Changes that span gems, such as documentation, CI and release tooling, are
+in the [main changelog](../../CHANGELOG.md).
+
+## 0.1.3 (unreleased)
+
+## 0.1.2 (2026-11-04)
+
+No entries for `libtmux-workspace`.
+
+## 0.1.1 (2026-10-31)
+
+- **Behavior change:** `libtmux-workspace load` and `plan --live` no longer
+  need `--socket`. Without it they use the same choice as `Server.new`, so a
+  command that failed with status 2 for a missing socket now acts on the
+  server tmux would pick. (#71)
+
+## 0.1.0 (2026-10-25)
+
+No entries for `libtmux-workspace`.
+
+## 0.1.0.alpha.3 (2026-10-24)
+
+No entries for `libtmux-workspace`.
+
+## 0.1.0.alpha.2 (2026-10-18)
+
+No entries for `libtmux-workspace`.
+
+## 0.1.0.alpha.1 (2026-09-20)
+
+### libtmux-workspace
+
+- Load YAML or JSON with `LibTmux::Workspace.load` or `.parse`, inspect a
+  creation plan, then apply it explicitly. Supports the documented subset of
+  tmuxp-style configuration. [Workspace example](../../examples/workspace_apply.rb).
+- Validate, plan and load from the `libtmux-workspace` CLI; optionally attach
+  or switch an explicit client after creation. `--version` reports the
+  installed gem version without reading a configuration or contacting tmux.
+  [CLI guide](../../gems/libtmux-workspace/README.md#script-it).
+- Inspect partial application through `ApplyError#result`. Optional
+  compensation removes only a positively identified new session after
+  checking that its windows and panes belong to the apply operation.
+  [Failure results](../../gems/libtmux-workspace/README.md#recover-from-a-failed-apply).

data/README.md

@@ -185,26 +185,47 @@ and never reconciles an existing one.
 [`Workspace.load`][workspace-load] reads the file,
 [`workspace.plan`][workspace-plan-method] plans it against a snapshot, and
 `apply` creates the session. Calling `apply` authorizes the configuration's
-shell commands:
+shell commands.
+
+[The example file](../../examples/api/workspace_apply.rb) writes the same
+document to a temporary `workspace.yaml` before loading it, so it runs saved on
+its own:
 
 <!-- example: api_workspace_apply/main -->
 ```ruby
 require "libtmux"
 require "libtmux/workspace"
-
-LibTmux::Server.start do |server|
-  workspace = LibTmux::Workspace.load(File.expand_path("../workspace.yaml", __dir__))
-  plan = workspace.plan(snapshot: server.snapshot)
-  puts "planned steps: #{plan.steps.length}"
-  result = plan.apply(server: server)
-  puts "applied: #{result.success?}"
-  puts "sessions: #{server.list_sessions.map { |session| session.snapshot.name }.join(', ')}"
+require "tmpdir"
+
+document = <<~'YAML'
+  session_name: work
+  environment:
+    PROJECT_MODE: development
+  windows:
+    - window_name: editor
+      window_index: 1
+      layout: tiled
+      panes:
+        - shell_command: printf 'editor ready\n'
+        - {}
+YAML
+
+Dir.mktmpdir("workspace-") do |directory|
+  path = File.join(directory, "workspace.yaml")
+  File.write(path, document)
+  LibTmux::Server.start do |server|
+    workspace = LibTmux::Workspace.load(path)
+    plan = workspace.plan(snapshot: server.snapshot)
+    puts "planned steps: #{plan.steps.length}"
+    result = plan.apply(server: server)
+    puts "applied: #{result.success?}"
+    puts "sessions: #{server.list_sessions.map { |session| session.snapshot.name }.join(', ')}"
+  end
 end
 ```
 <!-- /example -->
 
-The program runs next to the `workspace.yaml` above, on a private server, and
-prints:
+The program runs on a private server and prints:
 
 ```text
 planned steps: 11
@@ -379,7 +400,10 @@ values by design.
 
 Releases are numbered `0.1.N`, and each release increments `N`. The API is not
 settled: any release may change or remove exported identifiers, and the
-changelog marks each break. Pin an exact version to avoid one.
+changelogs mark each break. Pin an exact version to avoid one.
+See the [changelog](CHANGELOG.md), and the [main
+changelog](https://github.com/libtmux/libtmux-ruby/blob/master/CHANGELOG.md)
+for changes that span gems.
 
 - **Ruby 3.3 or newer.** The gem depends on the same version of `libtmux`,
   JSON 3.0 and Psych 5.5.

data/lib/libtmux/workspace/version.rb

@@ -2,6 +2,6 @@
 
 module LibTmux
   class Workspace
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: libtmux-workspace
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - libtmux contributors
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +58,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
 - assets/logo.png
@@ -76,7 +77,8 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/libtmux/libtmux-ruby
-  documentation_uri: https://libtmux.org/en/ruby/v0.1.1/workspace/
+  changelog_uri: https://github.com/libtmux/libtmux-ruby/blob/master/gems/libtmux-workspace/CHANGELOG.md
+  documentation_uri: https://libtmux.org/en/ruby/v0.1.2/workspace/
 rdoc_options: []
 require_paths:
 - lib