Turn down ruby support

[myk002]

If you intend to port a script, please make a comment on this bug to "claim" it so others don't start working on it too.

• ./devel/scanitemother.rb Port scanitemother from Ruby to Lua scripts#533
• ./devel/spawn-unit-helper.rb Port spawn-unit-helper from Ruby to Lua scripts#545
• ./devel/unforbidall.rb port unforbid and devel/unforbidall from ruby to lua scripts#382
• ./fix/loyaltycascade.rb Port loyaltycascade from Ruby to Lua scripts#542
• ./fix/stuckdoors.rb DFHack/dfhack#2081: port fix/stuckdoors from ruby to lua scripts#480
• ./adaptation.rb DFHack/dfhack#2081: Port adaptation and ban-cooking from Ruby to Lua scripts#479
• ./ban-cooking.rb DFHack/dfhack#2081: Port adaptation and ban-cooking from Ruby to Lua scripts#479
• ./create-items.rb remove create-items. it's covered by gui/create-item scripts#546
• ./deathcause.rb Port deathcause.rb scripts#488
• ./deteriorateclothes.rb Port deteriorate*.rb to new unified deteriorate.lua script scripts#384
• ./deterioratecorpses.rb Port deteriorate*.rb to new unified deteriorate.lua script scripts#384
• ./deterioratefood.rb Port deteriorate*.rb to new unified deteriorate.lua script scripts#384
• ./digfort.rb [removed] remove digfort scripts#332
• ./exterminate.rb Port exterminate from Ruby to Lua scripts#541
• ./growcrops.rb Port growcrops to lua scripts#487
• ./lever.rb Rewrite lever.rb in Lua scripts#515
• ./locate-ore.rb Port locate-ore for DFHack/dfhack#2081 scripts#489
• ./masspit.rb Port masspit script from Ruby to Lua scripts#531
• ./modtools/spawn-liquid.rb Port modtools spawn-liquid from Ruby to Lua scripts#540
• ./multicmd.rb Port multicmd from ruby to lua scripts#383
• ./show-unit-syndromes.rb Port show-unit-syndromes from Ruby to Lua scripts#562
• ./source.rb Port Source script from ruby to lua scripts#492
• ./startdwarf.rb startdwarf: migrate from Ruby to Lua scripts#385
• ./starvingdead.rb Port starvingdead from Ruby to Lua scripts#537
• ./stripcaged.rb Port stripcaged for DFHack/dfhack#2081 scripts#522
• ./superdwarf.rb Port superdwarf script from Ruby to lua scripts#491
• ./unforbid.rb port unforbid and devel/unforbidall from ruby to lua scripts#382

[lethosor]

has multiple external dependencies that users have to separately install on their systems

It's not supposed to. libruby is the only one I can think of - we try to provide a build that should work for everyone, but it isn't always possible. It doesn't work out of the box on some uncommon Linux situations and new versions of macOS: #1742, #1718

Edit: I see #2023 as well. Missed those replies. I guess this falls under "uncommon Linux situations"?

[myk002]

We'll need a deprecation plan to inform users that ruby is going away and give them time to rewrite any personal ruby scripts. How about we do this in stages, one stage per release:

1. port all in-repo ruby scripts to lua; print a deprecation notice to the dfhack console whenever a ruby script is run.
2. require specific action by the user to load the ruby plugin. e.g. they have to manually move the file to the plugins directory or run a specific dfhack command
3. remove the ruby plugin from the repo

[lethosor]

Removed rbsandbox.rb from the list - that was a private script of mine.

I think multicmd should be a built-in - I may have expressed this before. I'm willing to take on some of these.

[myk002]

I think multicmd should be a built-in - I may have expressed this before.

Ha, I should have read this before I did that last port. We can choose to merge that PR (or not) and make multicmd a builtin later.

[lethosor]

I guess what I really should have decided on is "not Ruby". It's pretty safe to rely on Lua being available - much more so than Ruby. String manipulation is also a bit easier/safer in Lua, as I'm sure you've found with argument parsing. Really the only risk I see is that people can edit/delete multicmd.lua, but it's not essential enough in my book that we should rewrite it.

[myk002]

I'm willing to take on some of these.

There are some that could certainly use your expertise:

• startdwarf does some direct memory manipulation that I haven't tried before
• ban-cooking comments are full of conjecture that might benefit from your knowledge
• create-items needs a decision on whether it should be replaced by the existing modtools/create-item.lua script (or the plugin? see Deduplicate scripts and plugins #1012)

[lethosor]

Looking at startdwarf now. Not a one-to-one API change, apparently

[warmist]

huh... i was sure that there was startdwarf in lua already...

Edit; seems that i failed to port it from an old many-in-one tool

[myk002]

I'm looking at superdwarf next. It looks like most of the functionality is copied from the fastdwarf plugin. I think the best way forward for this one is to move the superdwarf command to the fastdwarf plugin and just have that plugin provide both commands.

[arekatir]

I guess I'll claim stripcaged.rb as I might be halfway finished now. If anyone else has started it as well or wants to, contact me in the discord and we can share notes.

[vallode]

Claiming masspit.rb, I will take a crack at this week.

EDIT: DFHack/scripts#531

[hawkowl]

Lever is at DFHack/scripts#515

[vallode]

I took spawn-liquid.rb too, DFHack/scripts#532

[vallode]

scanitemother.rb is done over at DFHack/scripts#533

[vallode]

I will tackle starvingdead.rb and exterminate.rb this week.

starvingdead.rb ported over at DFHack/scripts#537
exterminate.rb over at DFHack/scripts#541