Move adapter dependency to gollum

[gerwitz]

I'm using the Rugged adapter for an internal project, and it's going well.

But the gemspec hardcodes the default adapter as a dependency, which means bundler insists on installing the grit adapter, which in turn requires charlock_holmes, which is a PITA to deploy to Heroku.

I'd love to move the grit_adapter dependency to Gollum's Gemfile.

[bartkamphorst]

which in turn requires charlock_holmes, which is a PITA to deploy to Heroku.

Having encountered charlock_holmes issues many times myself, I feel your pain.

I'd love to move the grit_adapter dependency to Gollum's Gemfile.

The problem with that is that it prevents gollum from working out of the box with gem install gollum. We do plan on swapping the default adapter at some point, but for that to happen we need to be more confident that the rugged adapter performs well enough. @jhominal is doing some excellent work currently to help us get there, but any help testing and/or patching the rugged adapter is very welcome!

[gerwitz]

I've been testing it and am completely satisfied with the rugged adapter. So much that I'm considering removing my dependency on gollum-lib and using only the adapter directly!

This is one situation I can't monkey-patch my way out of. Unless there's a magic Gemfile configuration I haven't discovered, the best solution is maybe a temporary fork of the gollum-lib gem?

[bartkamphorst]

Sorry for the long wait. Yes, a temporary fork is probably best for now. Development is slow at the moment, so I wouldn't want you waiting any longer on this change. We'll keep this issue open as a request to change the default adapter to rugged instead of removing it altogether, if that's okay with you.

[gerwitz]

If the intention of the dependency is to ensure gem install gollum works, perhaps the adapter should be referenced not by gollum's Gemfile (as I suggested) but by its gemspec?

[bartkamphorst]

This is currently blocked on gollum/rugged_adapter#15.

[gerwitz]

I agree with the sentiment over there that the rugged adapter isn't ready to become the default.

But I'm going to keep beating my drum of "as a gollum-lib user I shouldn't have a dependency on grit only because the flagship user, gollum, requires it."

[dometto]

@gerwitz, ideally we would indeed chuck the grit dependency. But as far as I can see there's no way of doing that which still makes it possible to gem install gollum and get a working installation, so that's a dealbreaker. The gem system makes it really difficult to do something like this, since there just is no way to specify dependencies on a per-platform basis (there is in Gemfiles, but those aren't consulted by rubygems when calculating dependencies).

[bartkamphorst]

@dometto The suggestion is not to remove the dependency, but rather to move the adapter dependency away from gollum-lib and to gollum itself. Do you see any reason why that couldn't work, given that we would use the same sort of gemspec trickery as we now have in gollum-lib?

[dometto]

Ah, that's an option. In that case we would have to release a separate Java version of gollum as well as of gollum-lib, but I think that could work.

[KHN190]

Hi. How to set gollum-lib to use rugged? This worked for gollum but not gollum-lib:

Parameters: {"utf8"=>"✓", "authenticity_token"=>"mMo/h/NxDKCywgYaBp1zaIlNkx5AEgVe9XJfCIC8Dfwd+8ue9U3XXUlsVZYt4/kuguYaurIhYYs0qoeg6nGWNA==", "wiki"=>{"name"=>"中文页面", "raw_data"=>"中文页面"}, "commit"=>"save"}

I appended the module to application.rb's end:

# application.rb
module Gollum
  Gollum::GIT_ADAPTER = "rugged"
end

And in console checked:

rails console
> Gollum::GIT_ADAPTER
=> "rugged"

But in logger it still shows it's using grit:

Encoding::CompatibilityError - incompatible character encodings: UTF-8 and ASCII-8BIT:
  gitlab-grit (2.7.3) lib/grit/index.rb:176:in `block in write_tree'
  gitlab-grit (2.7.3) lib/grit/index.rb:171:in `write_tree'
  gitlab-grit (2.7.3) lib/grit/index.rb:123:in `commit'
# ...

[KHN190]

@gerwitz Hi guys, I updated gollum-lib to use rugged as default:

• https://github.com/KHN190/gollum-lib/blob/master/lib/gollum-lib.rb#L8
• https://github.com/KHN190/gollum-lib/blob/master/gollum-lib.gemspec#L3

In Gemfile require it:

gem 'gollum-lib', :git => 'https://github.com/KHN190/gollum-lib'

Worked for me. Have a check, if you had similar problem.

But seemed gollum still not ready to accept rugged as default?

[gerwitz]

@KHN190: In my private fork for deployment I simply removed the dependancy from the gemspec. Very blunt and simple, but cannot be pulled into this repo until gollum proper handles it.