Add support for pry

[ohthatjames]

Any statements entered while inside a pry console aren't added to the console1984_commands table.

Steps to reproduce

I created a dummy repo to test this. It's a vanilla rails new on version 7.0.4.2 with pry and console1984 added.

console1984-pry-test % CONSOLE_USER=james bin/rails c

# ... console1984 setup truncated ...

Loading development environment (Rails 7.0.4.2)
irb(main):001:0> puts "Before pry"
Before pry
=> nil                                                                           
irb(main):002:0> pry
[1] pry(main)> puts "Inside pry"
Inside pry                                                                       
=> nil                                                                           
[2] pry(main)> exit                                                              
=> nil                                                                           
irb(main):003:0> puts "After pry"
After pry
=> nil                                                                           
irb(main):004:0> exit

Expected logged commands

puts "Before pry"
pry
puts "Inside pry"
exit
puts "After pry"
exit

Actual logged commands

console1984-pry-test % bin/rails runner "puts Console1984::Session.last.commands.map(&:statements)"
puts "Before pry"
pry
puts "After pry"
exit

Extra info

rails version 7.0.4.2
console1984 version 0.1.26
pry version 0.14.2

I've tried gem "pry", require: false and changing the order of gems in the Gemfile, but the result always appears to be the same.

[jorgemanrubia]

Thanks @ohthatjames. Thanks for reporting. console1984 currently only supports IRB, which is what we use at 37signals. I would be happy to welcome a PR adding support for pry too.

[dark-panda]

This is far from complete, but this will get you going:

Pry.prepend(Module.new do
  include Console1984::Freezeable

  def process_command(line, ...)
    Console1984.command_executor.execute(Array(line)) do
      super
    end
  end
end)

That will capture the history, at the very least.

[ball-hayden]

A slightly more complete Pry example:

# .pryrc

module Console1984Pry
  include Console1984::Freezeable

  def handle_line(line, ...)
    Console1984.command_executor.execute(Array(line)) do
      super
    end
  end
end

if Console1984.running_protected_environment?
  Pry.prepend(Console1984Pry)

  Pry::Commands.block_command "decrypt!", "Enter unprotected mode" do
    Console1984.shield.enable_unprotected_mode
  end

  Pry::Commands.block_command "encrypt!", "Enter protected mode" do
    Console1984.shield.enable_protected_mode
  end
end

[jamesprior]

evaluate_ruby is I working better for me with pry 0.13.1 than handle_line - I've certainly touched the sample from @ball-hayden so it may not be an equal comparison but I noticed that multi-line evaluations would write errors, but it worked as expected if I swapped it to re-define evaluate_ruby

An example of output before swapping to redefine evaluate_ruby

development [dev] [1] pry(main)> begin
(string):1:6: error: unexpected token $end
(string):1: begin
(string):1:      
development [dev] [1] pry(main)*   puts 'hi'
development [dev] [1] pry(main)* end  
(string):1:1: error: unexpected token kEND
(string):1: end
(string):1: ^~~
hi
=> nil

In digging around, it looks like the more pry-like alternative would be to implement something like:

Pry.config.hooks.add_hook(:before_eval, :console1984) do |commands, context|
  # An adaptation of Console1984::CommandExecutor.execute, minus the execution
  Console1984::CommandExecutor.run_as_system { session_logger.before_executing commands }
  Console1984::CommandExecutor.validate_command commands
end

Although that snippet is incomplete and missing some important features.

[silasb]

@jamesprior any chance you have a more complete snippet?

[jamesprior]

@jamesprior any chance you have a more complete snippet?

Yep, looks like this:

Pry.prepend(Module.new do
  include Console1984::Freezeable

  def evaluate_ruby(eval_string)
    if Console1984.running_protected_environment?
      Console1984.command_executor.execute(Array(eval_string)) do
        super
      end
    else
      super
    end
  end
end

Though that works in some cases there are still some weird edges. For example you can open additional bindings or consoles which will lose track of state and not work. Ex, binding.irb will open an irb repl where things stop working.