Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DRAFT] - Add copy command #1044

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions lib/irb/command/copy.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# frozen_string_literal: true

require 'mkmf'

module IRB
module Command
class Copy < Base
category "TODO"
description "TODO"

help_message(<<~HELP)
Usage: copy (input)
HELP

def execute(arg)
output = irb_context.workspace.binding.eval(arg)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to apply the output inspection method here so the copied output will be closer to what the users may expect.

For example, the output here by default will be the to_s result of the evaluation result, but IRB's default output inspector pretty prints the result inspect.

Additionally, we need to make sure colorizing is NOT applied to the copied value.

Copy link
Author

@Prajjwal Prajjwal Dec 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem with using the pretty printer is that colorizing output is hardcoded into it, and I don't think we want it in our clipboard.

Unless there's a pretty printer that I've missed, the options are:

  1. Grab colorized output, strip color before copying. Least invasive, and will respect the currently configured inspector.
  2. Install a new pretty printer analogous to the default color printer that does basically the same thing but doesn't colorize output. Don't like this one because we're conflating two concepts and hardcoding a command to use a specific kind of inspection method.
  3. Like above, color_printer.rb to accept a parameter that turns colorizing on / off. Most invasive.

I like 1, but will defer.


if clipboard_available?
copy_to_clipboard(output)
puts "Copied to system clipboard"
else
temp_file = write_to_tempfile(output)
puts "Wrote: #{temp_file}"
end
rescue StandardError => e
warn "Error: #{e}"
end

private

def copy_to_clipboard(text)
IO.popen(clipboard, 'w') do |io|
io.write(text)
end

raise "IOError" unless $? == 0
end

def write_to_tempfile(text)
file = Tempfile.new
file.write(text)
file.close
file.path
end

def clipboard
case RbConfig::CONFIG['host_os']
when /darwin/
# This is the most reliable method, but we could probably also offload this
# to the shell to avoid MkMf logs
MakeMakefile.find_executable('pbcopy')
when /linux/
MakeMakefile.find_executable('xclip').tap do |path|
path << '-selection clipboard'
end
when /mswin|mingw/
'clip' # => todo verify this works
else
nil
end
end

def clipboard_available?
!!clipboard
end
end
end
end
4 changes: 4 additions & 0 deletions lib/irb/default_commands.rb
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
require_relative "command/chws"
require_relative "command/context"
require_relative "command/continue"
require_relative "command/copy"
require_relative "command/debug"
require_relative "command/delete"
require_relative "command/disable_irb"
Expand Down Expand Up @@ -200,6 +201,9 @@ def load_command(command)
_register_with_aliases(:irb_continue, Command::Continue,
[:continue, NO_OVERRIDE]
)
_register_with_aliases(:irb_copy, Command::Copy,
[:copy, NO_OVERRIDE]
)
_register_with_aliases(:irb_finish, Command::Finish,
[:finish, NO_OVERRIDE]
)
Expand Down
Loading