LibTmux::Workspace

Members

ApplyError

Cclass libtmux-workspace [source] ¶

Discussed in Ownership and errors

ApplyResult

Cclass libtmux-workspace [source] ¶

CLI

Cclass libtmux-workspace [source] ¶

ConfigError

Cclass libtmux-workspace [source] ¶

ConflictError

Cclass libtmux-workspace [source] ¶

Plan

Cclass libtmux-workspace [source] ¶

def inspect: () -> ::String

mmethod libtmux-workspace [source] ¶

Behavior: Workspace parsing.

Description#

Behavior contract: Workspace parsing.

def plan: ( ?snapshot: ::LibTmux::Snapshot? ) -> ::LibTmux::Workspace::Plan

mmethod libtmux-workspace [source] ¶

Behavior: Workspace parsing.

Description#

Behavior contract: Workspace parsing.

Examples#

Load the example workspace file, plan it against a snapshot, and apply the plan to an empty server. Use Ruby 4.0.7, Bundler, Git and tmux 3.3a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout d8ce4bbee0ca7748a81929f81f7d8d07f8c51267

Save this dependency file as Gemfile:

source "https://rubygems.org"

gem "libtmux-workspace", path: "libtmux-source/gems/libtmux-workspace"

Save this complete program as workspace_apply.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error. View source

# frozen_string_literal: true

begin
  # docs:begin main
  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(', ')}"
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

Install the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:

$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby workspace_apply.rb

Expected output:

planned steps: 11
applied: true
sessions: work

Parameters

• snapshot (::LibTmux::Snapshot?) #

Discussed in tmux workspace manager for Ruby , load , plan · Workspace guide

def to_h: () -> ::Hash[::String, untyped]

mmethod libtmux-workspace [source] ¶

Behavior: Workspace parsing.

Description#

Behavior contract: Workspace parsing.

def self.load: ( ::String, ?format: :yaml | :json | nil, ?expand_environment: bool, ?environment: ::Hash[::String, ::String], **::Integer ) -> ::LibTmux::Workspace

mmethod libtmux-workspace static [source] ¶

Behavior: Workspace parsing.

Description#

Behavior contract: Workspace parsing.

Examples#

Load the example workspace file, plan it against a snapshot, and apply the plan to an empty server. Use Ruby 4.0.7, Bundler, Git and tmux 3.3a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout d8ce4bbee0ca7748a81929f81f7d8d07f8c51267

Save this dependency file as Gemfile:

source "https://rubygems.org"

gem "libtmux-workspace", path: "libtmux-source/gems/libtmux-workspace"

Save this complete program as workspace_apply.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error. View source

# frozen_string_literal: true

begin
  # docs:begin main
  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(', ')}"
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

Install the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:

$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby workspace_apply.rb

Expected output:

planned steps: 11
applied: true
sessions: work

Parameters

• arg1 (::String) #

• format (:yaml | :json | nil) #

• expand_environment (bool) #

• environment (::Hash[::String, ::String]) #

• kwargs (::Integer) #

Discussed in tmux workspace manager for Ruby , load , Ruby workspace examples , Ruby workspace guides · Workspace guide

def self.parse: ( ::String, format: :yaml | :json, base_directory: ::String, ?expand_environment: bool, ?environment: ::Hash[::String, ::String], **::Integer ) -> ::LibTmux::Workspace

mmethod libtmux-workspace static [source] ¶

Behavior: Workspace parsing.

Description#

Behavior contract: Workspace parsing.

Examples#

Apply a workspace whose panes cannot fit with compensate: true. The failed split is reported, the created session is removed, and the borrowed session stays. Use Ruby 4.0.7, Bundler, Git and tmux 3.3a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout d8ce4bbee0ca7748a81929f81f7d8d07f8c51267

Save this dependency file as Gemfile:

source "https://rubygems.org"

gem "libtmux-workspace", path: "libtmux-source/gems/libtmux-workspace"

Save this complete program as workspace_failure.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error. View source

# frozen_string_literal: true

begin
  # docs:begin main
  require "json"
  require "libtmux"
  require "libtmux/workspace"

  LibTmux::Server.start do |server|
    server.new_session(name: "borrowed", command: ["/bin/cat"])
    crowded = LibTmux::Workspace.parse(
      JSON.generate({session_name: "crowded", windows: [{window_name: "small", panes: Array.new(40) { {} }}]}),
      format: :json, base_directory: __dir__
    )
    begin
      crowded.plan.apply(server: server, compensate: true)
    rescue LibTmux::Workspace::ApplyError => error
      puts "failed action: #{error.result.failed_action}"
      puts "created a session: #{error.result.created_refs.key?('session')}"
      puts "compensation: #{error.result.compensation}"
    end
    puts "sessions: #{server.list_sessions.map { |session| session.snapshot.name }.join(', ')}"
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end

Install the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:

$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby workspace_failure.rb

Expected output:

failed action: split_pane
created a session: true
compensation: completed
sessions: borrowed

Parameters

• arg1 (::String) #

• format (:yaml | :json) #

• base_directory (::String) #

• expand_environment (bool) #

• environment (::Hash[::String, ::String]) #

• kwargs (::Integer) #

Discussed in Workspace guide