SSHKit::DSL breaks RSpec feature specs

[damselem]

After adding the sshkit gem in a Rails project Gemfile and running RSpec feature specs, I get really strange errors.

group :test do
  gem 'sshkit'
end

If I comment the following line https://github.com/leehambley/sshkit/blob/master/lib/sshkit/dsl.rb#L19 and use the non-dsl API then everything starts working again. I imagine that somehow, the on method overrides some other classes/modules on method.

Here the error when running the specs:

An error occurred in an after hook
  ActionView::Template::Error: no block given
  occurred at /Users/damselem/.rvm/gems/ruby-2.0.0-p247/gems/sshkit-0.0.34/lib/sshkit/backends/netssh.rb:42:in `instance_exec'`

[leehambley]

group :test do
  gem 'sshkit', require: false
end

[leehambley]

You can't import the DSL to some global scope without some expectation that on() would collide, the DSL is solely designed for use in isolated places, such as Rakefiles, or inside Capistrano tasks.

[leehambley]

Best always to use the canonical SSHKit::Coordinator.new()... syntax (see the "without the DSL ")

[damselem]

That's exactly what I did before, but eventually you still need to require sshkit somehow, and probably you don't want to list all the required files on your own. What I am trying to point is that you probably want lib/sshkit.rb not to require lib/sshkit/dsl.rb by default, and instead rely on the user adding it if he wants to. Wdyt?

[leehambley]

That's probably true, and I'm a bit surprised if lib/sshkit really requires the dsl.

[damselem]

It does:

module SSHKit
  .....
end

require_relative 'sshkit/all'

https://github.com/leehambley/sshkit/blob/master/lib/sshkit.rb#L32

and lib/sshkit/all:

require_relative '../core_ext/array'
require_relative '../core_ext/hash'

require_relative 'dsl'
require_relative 'host'

require_relative 'command'
.....

https://github.com/leehambley/sshkit/blob/master/lib/sshkit/all.rb#L4

So, in case you agree on modifying this behaviour, should I send a pr?

[leehambley]

Yes, please. That's a simple mistake on our part, the dsl shouldn't be in all. Rake made that mistake 5 years ago, and it took until last christmas to fix it!