Support XDG_* #2174

hsbt · 2019-05-07T13:51:39Z

We should support XDG Base Directory Specification on the Ruby language.

I try to support the following environmental variables:

XDG_CONFIG_HOME
XDG_CACHE_HOME
XDG_DATA_HOME

lib/rdoc.rb

lib/rubygems/gemcutter_utilities.rb

lib/rubygems/config_file.rb

hsbt · 2019-09-13T01:14:23Z

@deivid-rodriguez @aycabta Can you review this branch?

I changed rubygems, bundler, rdoc, irb for XDG. I'm going to separate them for the upstream repositories after merging this.

deivid-rodriguez · 2019-09-13T09:03:49Z

Ok, I'll have a look ASAP!

aycabta

It's a good patch to merge to RDoc and IRB. I'll make another patch to Reline later.

deivid-rodriguez

The PR in general looks great to me. I only added a few minor comments. I think the backwards compatibility mechanism you used (optin if no prior config is there) should be fine 👍.

lib/rubygems/test_case.rb

test/rubygems/test_gem.rb

lib/rubygems/defaults.rb

lib/rubygems/gemcutter_utilities.rb

lib/rdoc.rb

lib/rubygems/test_case.rb

test/rubygems/test_gem_commands_build_command.rb

eregon · 2020-03-07T12:27:34Z

What's the motivation to use these XDG_* variables? Is there a request for it?
I'm not sure I know anyone using them.

nobu · 2020-03-07T16:16:32Z

XDG would be used in Freedesktop.org (and compatible environments probably).

simi · 2020-03-07T16:22:08Z

@eregon from my experience it is not common to set those manually, but those are set in your environment (Linux/GNOME on my system) on its own to unify config,cache,data application files location.

[retro@retro  ruby (master $%=)]❤ env | grep XDG
XDG_MENU_PREFIX=gnome-
XDG_SESSION_DESKTOP=gnome
XDG_SESSION_TYPE=wayland
XDG_CURRENT_DESKTOP=GNOME
XDG_SESSION_CLASS=user
XDG_RUNTIME_DIR=/run/user/1000
XDG_DATA_DIRS=/home/retro/.local/share/flatpak/exports/share/:/var/lib/flatpak/exports/share/:/usr/local/share/:/usr/share/

jonathanhefner · 2020-03-07T20:35:40Z

lib/rubygems/config_file.rb

+    credentials = File.join Gem.user_home, '.gem', 'credentials'
+    if File.exist? credentials
+      credentials
+    else
+      File.join Gem.data_home, "gem", "credentials"
+    end


This pattern of checking file existence appears to occur several times. Would it be helpful to encapsulate it in a utility method?

def find_home_file(filename) path = File.join Gem.user_home, ".gem", filename if File.exist? path path else File.join Gem.data_home, "gem", filename end end

hsbt · 2020-03-07T22:39:48Z

@eregon The modern toolchains supported XDG Base Directory. See https://wiki.archlinux.org/index.php/XDG_Base_Directory

simi · 2020-04-20T13:01:13Z

@hsbt hello, are there any news on this? Is there any plan to move this forward? If needed I can help (for exmaple move rubygems part to rubygems repo as a PR). Ping me if that would be helpful.

hsbt · 2020-04-21T12:05:03Z

@simi Thanks for your comments. I'm going to merge about RubyGems, RDoc and IRB supports in this branch in few days.

After that, I will backport to the upstream of them. Can you try it and improve them? Thanks.

lib/rdoc.rb

lib/rdoc/ri/paths.rb

test/rdoc/test_rdoc_store.rb

nobu · 2020-04-23T06:14:21Z

lib/rubygems/defaults.rb

+  #   I have HOME, USERPROFILE and HOMEDRIVE + HOMEPATH. Ruby seems
+  #   to be depending on HOME in those code samples. I propose that
+  #   it should fallback to USERPROFILE and HOMEDRIVE + HOMEPATH (at
+  #   least on Win32).


This comment is much outdated, for 1.8 era.

nobu · 2020-04-23T06:17:27Z

lib/rubygems/test_case.rb

@@ -363,6 +363,14 @@ def setup
    Dir.chdir @tempdir

    ENV['HOME'] = @userhome
+    FileUtils.mkdir_p File.join(@userhome, ".gem")


Why isn't this path reused bellow?

nobu · 2020-04-23T06:17:43Z

lib/rubygems/test_case.rb

+    FileUtils.mkdir_p File.dirname(temp_cred)
+    File.open temp_cred, 'w', 0600 do |fp|
+      fp.puts ':rubygems_api_key: 701229f217cdf23b1344c7b4b54ca97'
+    end


File.write.

…file

ruby/ruby#2174

Refs. - ruby/ruby@5c6269c - ruby/ruby#2174 - https://wiki.archlinux.org/title/XDG_Base_Directory#Supported - https://wiki.archlinux.jp/index.php/XDG_Base_Directory#.E3.82.B5.E3.83.9D.E3.83.BC.E3.83.88.E3.81.97.E3.81.A6.E3.81.84.E3.82.8B.E3.82.BD.E3.83.95.E3.83.88.E3.82.A6.E3.82.A7.E3.82.A2

nobu reviewed May 7, 2019

View reviewed changes

lib/rdoc.rb Outdated Show resolved Hide resolved

simi reviewed Jun 25, 2019

View reviewed changes

lib/rubygems/gemcutter_utilities.rb Outdated Show resolved Hide resolved

hsbt mentioned this pull request Jul 26, 2019

Make --user-install as default rubygems/rubygems#2847

Closed

4 tasks

skipkayhil reviewed Jul 29, 2019

View reviewed changes

lib/rubygems/config_file.rb Outdated Show resolved Hide resolved

k0kubun changed the base branch from trunk to master August 15, 2019 17:15

hsbt mentioned this pull request Sep 2, 2019

Respect $GEM_HOME when storing credentials rubygems/rubygems#2903

Closed

5 tasks

hsbt marked this pull request as ready for review September 13, 2019 01:13

aycabta approved these changes Sep 15, 2019

View reviewed changes

deivid-rodriguez reviewed Sep 18, 2019

View reviewed changes

jonathanhefner reviewed Mar 7, 2020

View reviewed changes

simi mentioned this pull request Apr 20, 2020

Rubygems does not comply with XDG basedir spec rubygems/rubygems#1599

Closed

5 tasks

nobu approved these changes Apr 23, 2020

View reviewed changes

hsbt added 10 commits April 23, 2020 17:35

Support XDG_CONFIG_HOME for gemrc.

0996d48

Support XDG_DATA_HOME for .gem

47d0538

Added test for XDG_DATA_HOME

cb5e35b

Do not reuse environmental variable.

c8b59b3

Unify .rdoc path to RDoc.home.

0773d0a

Support XDG_DATA_HOME for .rdoc

e18b61e

Ignore exists?

7484c0d

Extracted config_home path

09b9fde

Use XDG_CONFIG_HOME for default credential path

842454a

Fixed inconsistency location.

646dca8

hsbt added 19 commits April 23, 2020 17:40

Do not modify environmental variable on test file

52386ef

Use XDG_DATA_HOME insted of XDG_CACHE_HOME for credential file

f7ed065

stub out Gem.data_home

3fdcad9

Move dir accessor to defaults.rb file

a807704

Use XDG_DATA_HOME for signed gem features

563c06e

Use XDG_DATA_HOME for spec cache

06dff7a

Do not rely on Gem.user_home

07403b8

Gem.user_home is always exists. Don't need to use FileUitls.mkdir_p

15df10b

Bump support version to RubyGems 3.2.0+

806c92b

Removed the needless fallback configuration

4487078

Fixed the inconsistency methods that are find_config_file and config_…

fe5ee5b

…file

Use Gem.configuration.credentials_path instead of hard-coded path

7613e26

gem_path is always provided

dc2df98

Removed the duplicated code of find_home

7999c94

Also removed the duplicated code of user_home

2cefcbe

use Gem::UNTAINT instead of untaint for surpressing the warnings

8504a01

Use File.directory

1847b70

Restore XDG_DATA_HOME

6ed7bf1

Use File.write

ef2dd84

hsbt merged commit 5c6269c into ruby:master Apr 23, 2020

hsbt deleted the support-xdg branch April 23, 2020 10:16

hsbt added a commit to rubygems/rubygems that referenced this pull request Apr 24, 2020

Support XDG specification.

2e290c3

ruby/ruby#2174

hsbt mentioned this pull request Apr 24, 2020

Support XDG specification rubygems/rubygems#3545

Merged

4 tasks

hsbt added a commit to rubygems/rubygems that referenced this pull request Apr 28, 2020

Support XDG specification.

18febc1

ruby/ruby#2174

deivid-rodriguez pushed a commit to rubygems/rubygems that referenced this pull request Apr 29, 2020

Support XDG specification.

b46ddde

ruby/ruby#2174

deivid-rodriguez mentioned this pull request Jun 7, 2020

Fix ruby-head failing rubygems tests rubygems/rubygems#3694

Merged

4 tasks

pombredanne pushed a commit to nexB/univers that referenced this pull request Dec 7, 2021

Support XDG specification.

5429c26

ruby/ruby#2174

eode mentioned this pull request Jul 22, 2022

Let Cargo put data into platform-specific directories rust-lang/rfcs#1615

Closed

machupicchubeta mentioned this pull request Oct 29, 2023

Move apps config and/or data directory under XDG Base Directory machupicchubeta/dotfiles#451

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support XDG_* #2174

Support XDG_* #2174

hsbt commented May 7, 2019 •

edited

hsbt commented Sep 13, 2019

deivid-rodriguez commented Sep 13, 2019

aycabta left a comment

deivid-rodriguez left a comment

eregon commented Mar 7, 2020

nobu commented Mar 7, 2020

simi commented Mar 7, 2020

jonathanhefner Mar 7, 2020

hsbt commented Mar 7, 2020

simi commented Apr 20, 2020

hsbt commented Apr 21, 2020

nobu Apr 23, 2020

nobu Apr 23, 2020

nobu Apr 23, 2020

Support XDG_* #2174

Support XDG_* #2174

Conversation

hsbt commented May 7, 2019 • edited

hsbt commented Sep 13, 2019

deivid-rodriguez commented Sep 13, 2019

aycabta left a comment

Choose a reason for hiding this comment

deivid-rodriguez left a comment

Choose a reason for hiding this comment

eregon commented Mar 7, 2020

nobu commented Mar 7, 2020

simi commented Mar 7, 2020

jonathanhefner Mar 7, 2020

Choose a reason for hiding this comment

hsbt commented Mar 7, 2020

simi commented Apr 20, 2020

hsbt commented Apr 21, 2020

nobu Apr 23, 2020

Choose a reason for hiding this comment

nobu Apr 23, 2020

Choose a reason for hiding this comment

nobu Apr 23, 2020

Choose a reason for hiding this comment

hsbt commented May 7, 2019 •

edited