simple_xdg 0.0.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4f34a91f90dc6979b1a8ea2a35e8149597f1c7ae9d2678489fe2e04fc006d0f
-  data.tar.gz: d20e1f3ee1d333b20b1d207136a9a6e1fa80e6657bae72ac0e4c25d4f5d9011f
+  metadata.gz: 8db25c3801d49ace447881c87f3dbdd9fb2ca4ff2df955adbf7554f5af69928b
+  data.tar.gz: b9ad844c2bab45f09c856025d9458a60955fd9d6966c01b52d68920eb0b78915
 SHA512:
-  metadata.gz: 337ae3a242bc0d9ce1fd950d6420a45698440560531ae7d70c41c02ab69e53e15c4e362ee9884552baab5a1b8d09d25450ad285bfbf02280bd66c6e752e6a1a2
-  data.tar.gz: cab22396d72ad43aa62048dae0c39eb18572734182e1635e8a89458cffa31e914b15c74cc3af2e7367360734cd81721d0df3db3404e12261240e2d2b0a60d3ef
+  metadata.gz: 0f249d40422399854b4f2f40e73be9a40087a022a27fd62d199160a744ccf5495a556fa971a7085d3098f25376f10d7222571159e2dd3dbd96b8db59be1e2dc5
+  data.tar.gz: 6e48291c6b2c2b684f88ba660d7298c2540202143f8bfb87e0838d738b8d018a133aaa6992f82fec9aba1c17b080567065c6e662433c0753f9333f97e81f09d4

data/.yardopts

@@ -0,0 +1,11 @@
+--no-private
+--title=SimpleXDG
+--markup=markdown
+--markup-provider redcarpet
+--main=README.md
+./lib/simple_xdg/**/*.rb
+./lib/simple_xdg.rb
+-
+README.md
+LICENSE.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Release History
+
+### v0.1.1 / 2026-05-04
+
+* DOCS: Fixed reference documentation generation
+
+### v0.1.0 / 2026-05-03
+
+* ADDED: Initial extraction from toys-core

data/LICENSE.md

@@ -0,0 +1,21 @@
+# License
+
+Copyright 2026 Daniel Azuma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

data/README.md

@@ -1,9 +1,68 @@
-# Placeholder for simple_xdg
+# SimpleXDG
 
-This is a placeholder gem, which was generated on 2026-05-02 to
-reserve the gem "simple_xdg".
-The actual gem is planned for release in the near future.
+`SimpleXDG` is a no-frills Ruby class implementing the XDG Base Directory
+Specification. This spech defines where certain user-specific application
+files, such as configuration, cache, and saved state, should live on the user's
+file system. It specifies environment variables that contain this information,
+and defaults that should be used if those environment variables are unset. The
+spec itself is at https://specifications.freedesktop.org/basedir/latest/
 
-If this is a problem, or if the actual gem has not been released
-in a timely manner, you can contact the owner at
-`dazuma@gmail.com`.
+## Getting started
+
+Install `SimpleXDG` via the
+[simple_xdg gem](https://rubygems.org/gems/simple_xdg).
+
+```sh
+% gem install simple_xdg
+```
+
+or add it to your Gemfile:
+
+```ruby
+gem "simple_xdg"
+```
+
+To use the service, instantiate `SimpleXDG`, and call methods to obtain the
+directory paths:
+
+```ruby
+require "simple_xdg"
+xdg = SimpleXDG.new
+my_config_file_path = xdg.lookup_config("my_app_config.toml")
+```
+
+## Contributing
+
+Development is done in GitHub at https://github.com/dazuma/simple_xdg.
+
+ *  To file issues: https://github.com/dazuma/simple_xdg/issues.
+ *  For questions and discussion, please do not file an issue. Instead, use the
+    discussions feature: https://github.com/dazuma/simple_xdg/discussions.
+ *  Pull requests are welcome, but in general please open an issue first before
+    contributing significant changes.
+
+The library uses [toys](https://dazuma.github.io/toys) for testing and CI. To
+run the test suite, `gem install toys` and then run `toys ci`. You can also run
+unit tests, rubocop, and build tests independently.
+
+## License
+
+Copyright 2026 Daniel Azuma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

data/lib/simple_xdg/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class SimpleXDG
+  ##
+  # Version of the simple_xdg gem
+  # @return [String]
+  #
+  VERSION = "0.1.1"
+end

data/lib/simple_xdg.rb

@@ -1,8 +1,409 @@
+# frozen_string_literal: true
+
+##
+# A class that provides tools for working with the XDG Base Directory
+# Specification.
 #
-# This is a placeholder Ruby file for gem "simple_xdg".
-# It was generated on 2026-05-02 to reserve the gem name.
-# The actual gem is planned for release in the near future.
-# If this is a problem, or if the actual gem has not been
-# released in a timely manner, you can contact the owner at
-# dazuma@gmail.com
+# This class provides utility methods that locate base directories and
+# search paths for application state, configuration, caches, and other
+# data, according to the [XDG Base Directory Spec version
+# 0.8](https://specifications.freedesktop.org/basedir/0.8/).
 #
+# ### Example
+#
+#     require "simple_xdg"
+#
+#     xdg = SimpleXDG.new
+#
+#     # Get config file paths, in order from most to least important
+#     config_files = xdg.lookup_config("my-config.toml")
+#     config_files.each { |path| read_my_config(path) }
+#
+# ### Windows operation
+#
+# The Spec assumes a unix-like environment, and cannot be applied directly
+# to Windows without modification. In general, this class will function on
+# Windows, but with the following caveats:
+#
+#  *  All file paths must use Windows-style absolute paths, beginning with
+#     the drive letter.
+#  *  Environment variables that can contain multiple paths (`XDG_*_DIRS`)
+#     use the Windows path delimiter (`;`) rather than the unix path
+#     delimiter (`:`).
+#  *  Defaults for home directories (`XDG_*_HOME`) will follow unix
+#     conventions, using subdirectories under the user's profile directory
+#     rather than the Windows known folder paths.
+#  *  Defaults for search paths (`XDG_*_DIRS`) will be empty and will not
+#     use the Windows known folder paths.
+#
+class SimpleXDG
+  ##
+  # An error raised in certain cases when a lookup fails.
+  #
+  class Error < ::StandardError
+  end
+
+  ##
+  # Create an instance of XDG.
+  #
+  # @param env [Hash{String=>String}] the environment variables. Normally,
+  #     you can omit this argument, as it will default to `::ENV`.
+  #
+  def initialize(env: ::ENV)
+    require "fileutils"
+    @env = env
+  end
+
+  ##
+  # Returns the absolute path to the current user's home directory.
+  #
+  # @return [String]
+  #
+  def home_dir
+    @home_dir ||= validate_dir_env("HOME") || ::Dir.home
+  end
+
+  ##
+  # Returns the absolute path to the single base directory relative to
+  # which user-specific data files should be written.
+  #
+  # Corresponds to the value of the `$XDG_DATA_HOME` environment variable
+  # and its defaults according to the XDG Base Directory Spec.
+  #
+  # @return [String]
+  #
+  def data_home
+    @data_home ||= validate_dir_env("XDG_DATA_HOME") || ::File.join(home_dir, ".local", "share")
+  end
+
+  ##
+  # Returns the absolute path to the single base directory relative to
+  # which user-specific configuration files should be written.
+  #
+  # Corresponds to the value of the `$XDG_CONFIG_HOME` environment variable
+  # and its defaults according to the XDG Base Directory Spec.
+  #
+  # @return [String]
+  #
+  def config_home
+    @config_home ||= validate_dir_env("XDG_CONFIG_HOME") || ::File.join(home_dir, ".config")
+  end
+
+  ##
+  # Returns the absolute path to the single base directory relative to
+  # which user-specific state files should be written.
+  #
+  # Corresponds to the value of the `$XDG_STATE_HOME` environment variable
+  # and its defaults according to the XDG Base Directory Spec.
+  #
+  # @return [String]
+  #
+  def state_home
+    @state_home ||= validate_dir_env("XDG_STATE_HOME") || ::File.join(home_dir, ".local", "state")
+  end
+
+  ##
+  # Returns the absolute path to the single base directory relative to
+  # which user-specific non-essential (cached) data should be written.
+  #
+  # Corresponds to the value of the `$XDG_CACHE_HOME` environment variable
+  # and its defaults according to the XDG Base Directory Spec.
+  #
+  # @return [String]
+  #
+  def cache_home
+    @cache_home ||= validate_dir_env("XDG_CACHE_HOME") || ::File.join(home_dir, ".cache")
+  end
+
+  ##
+  # Returns the absolute path to the single base directory relative to
+  # which user-specific executable files may be written.
+  #
+  # Returns the value of `$HOME/.local/bin` as specified by the XDG Base
+  # Directory Spec.
+  #
+  # @return [String]
+  #
+  def executable_home
+    @executable_home ||= ::File.join(home_dir, ".local", "bin")
+  end
+
+  ##
+  # Returns the set of preference ordered base directories relative to
+  # which data files should be searched, as an array of absolute paths.
+  # The array is ordered from most to least important, and does _not_
+  # include the data home directory.
+  #
+  # Corresponds to the value of the `$XDG_DATA_DIRS` environment variable
+  # and its defaults according to the XDG Base Directory Spec.
+  #
+  # @return [Array<String>]
+  #
+  def data_dirs
+    @data_dirs ||= validate_dirs_env("XDG_DATA_DIRS") ||
+                   validate_dirs(["/usr/local/share", "/usr/share"])
+  end
+
+  ##
+  # Returns the set of preference ordered base directories relative to
+  # which configuration files should be searched, as an array of absolute
+  # paths. The array is ordered from most to least important, and does
+  # _not_ include the config home directory.
+  #
+  # Corresponds to the value of the `$XDG_CONFIG_DIRS` environment variable
+  # and its defaults according to the XDG Base Directory Spec.
+  #
+  # @return [Array<String>]
+  #
+  def config_dirs
+    @config_dirs ||= validate_dirs_env("XDG_CONFIG_DIRS") ||
+                     validate_dirs(["/etc/xdg"])
+  end
+
+  ##
+  # Returns the absolute path to the single base directory relative to
+  # which user-specific runtime files and other file objects should be
+  # placed.
+  #
+  # Corresponds to the value of the `$XDG_RUNTIME_DIR` environment variable
+  # according to the XDG Base Directory Spec.
+  #
+  # **Important:** Returns `nil` if the `$XDG_RUNTIME_DIR` environment
+  # variable is unset or invalid. In such a case, it is the caller's
+  # responsibility to determine a fallback strategy, as this library cannot
+  # by itself implement a compliant fallback without OS help.
+  #
+  # @return [String,nil]
+  #
+  def runtime_dir
+    @runtime_dir = validate_dir_env("XDG_RUNTIME_DIR") unless defined? @runtime_dir
+    @runtime_dir
+  end
+
+  ##
+  # Returns the absolute path to the single base directory relative to
+  # which user-specific runtime files and other file objects should be
+  # placed.
+  #
+  # Corresponds to the value of the `$XDG_RUNTIME_DIR` environment variable
+  # according to the XDG Base Directory Spec.
+  #
+  # Raises {SimpleXDG::Error} if the `$XDG_RUNTIME_DIR` environment
+  # variable is unset or invalid. Unlike {#runtime_dir}, does not return
+  # nil.
+  #
+  # @return [String]
+  #
+  def runtime_dir!
+    runtime_dir || raise(::SimpleXDG::Error, "XDG_RUNTIME_DIR is unset or invalid")
+  end
+
+  ##
+  # Searches the data directories for an object with the given relative
+  # path, and returns an array of absolute paths to all objects found in
+  # all data directories (i.e. {#data_home} and {#data_dirs}), in order
+  # from most to least important. Returns the empty array if no suitable
+  # objects are found.
+  #
+  # If multiple objects are found, the caller should implement its own
+  # logic to resolve them. For example, it can select the first (most
+  # important) object, or implement logic to combine the contents.
+  #
+  # @param path [String] Relative path of the object to search for
+  # @param type [String,Symbol,Array<String,Symbol>] The type(s) of objects
+  #     to find. You can specify any of the types defined by
+  #     [File::Stat#ftype](https://ruby-doc.org/core/File/Stat.html#method-i-ftype),
+  #     such as `file` or `directory`, or the special type `any`. Types can
+  #     be specified as strings or the  corresponding symbols. If this
+  #     argument is not provided, the default of `file` is used.
+  # @return [Array<String>]
+  #
+  def lookup_data(path, type: :file)
+    lookup_internal([data_home] + data_dirs, path, type)
+  end
+
+  ##
+  # Searches the config directories for an object with the given relative
+  # path, and returns an array of absolute paths to all objects found in
+  # all config directories (i.e. {#config_home} and {#config_dirs}), in
+  # order from most to least important. Returns the empty array if no
+  # suitable objects are found.
+  #
+  # If multiple objects are found, the caller should implement its own
+  # logic to resolve them. For example, it can select the first (most
+  # important) object, or implement logic to combine the contents.
+  #
+  # @param path [String] Relative path of the object to search for
+  # @param type [String,Symbol,Array<String,Symbol>] The type(s) of objects
+  #     to find. You can specify any of the types defined by
+  #     [File::Stat#ftype](https://ruby-doc.org/core/File/Stat.html#method-i-ftype),
+  #     such as `file` or `directory`, or the special type `any`. Types can
+  #     be specified as strings or the  corresponding symbols. If this
+  #     argument is not provided, the default of `file` is used.
+  # @return [Array<String>]
+  #
+  def lookup_config(path, type: :file)
+    lookup_internal([config_home] + config_dirs, path, type)
+  end
+
+  ##
+  # Searches the state directory ({#state_home}) for an object with the
+  # given relative path, and returns an array of zero or one absolute paths
+  # to any found object. Because the XDG basedir spec does not provide for
+  # a list of fallback directories for state files (i.e. there is no
+  # `XDG_STATE_DIRS` variable or list of default paths), this will return a
+  # maximum of one result. However, it returns an array for consistency
+  # with the {#lookup_data} and {#lookup_config} methods.
+  #
+  # @param path [String] Relative path of the object to search for
+  # @param type [String,Symbol,Array<String,Symbol>] The type(s) of objects
+  #     to find. You can specify any of the types defined by
+  #     [File::Stat#ftype](https://ruby-doc.org/core/File/Stat.html#method-i-ftype),
+  #     such as `file` or `directory`, or the special type `any`. Types can
+  #     be specified as strings or the  corresponding symbols. If this
+  #     argument is not provided, the default of `file` is used.
+  # @return [Array<String>]
+  #
+  def lookup_state(path, type: :file)
+    lookup_internal([state_home], path, type)
+  end
+
+  ##
+  # Searches the cache directory ({#cache_home}) for an object with the
+  # given relative path, and returns an array of zero or one absolute paths
+  # to any found object. Because the XDG basedir spec does not provide for
+  # a list of fallback directories for cache files (i.e. there is no
+  # `XDG_CACHE_DIRS` variable or list of default paths), this will return a
+  # maximum of one result. However, it returns an array for consistency
+  # with the {#lookup_data} and {#lookup_config} methods.
+  #
+  # @param path [String] Relative path of the object to search for
+  # @param type [String,Symbol,Array<String,Symbol>] The type(s) of objects
+  #     to find. You can specify any of the types defined by
+  #     [File::Stat#ftype](https://ruby-doc.org/core/File/Stat.html#method-i-ftype),
+  #     such as `file` or `directory`, or the special type `any`. Types can
+  #     be specified as strings or the  corresponding symbols. If this
+  #     argument is not provided, the default of `file` is used.
+  # @return [Array<String>]
+  #
+  def lookup_cache(path, type: :file)
+    lookup_internal([cache_home], path, type)
+  end
+
+  ##
+  # Returns the absolute path to a directory under {#data_home}, creating
+  # it if it doesn't already exist.
+  #
+  # @param path [String] The relative path to the subdir within the base
+  #     data directory.
+  # @return [String] The absolute path to the subdir.
+  # @raise [SystemCallError] If a non-directory already exists there. It is
+  #     unspecified which specific error will be raised; it typically could
+  #     be `Errno::EEXIST` or `Errno::ENOTDIR`.
+  #
+  def ensure_data_subdir(path)
+    ensure_subdir_internal(data_home, path)
+  end
+
+  ##
+  # Returns the absolute path to a directory under {#config_home}, creating
+  # it if it doesn't already exist.
+  #
+  # @param path [String] The relative path to the subdir within the base
+  #     config directory.
+  # @return [String] The absolute path to the subdir.
+  # @raise [SystemCallError] If a non-directory already exists there. It is
+  #     unspecified which specific error will be raised; it typically could
+  #     be `Errno::EEXIST` or `Errno::ENOTDIR`.
+  #
+  def ensure_config_subdir(path)
+    ensure_subdir_internal(config_home, path)
+  end
+
+  ##
+  # Returns the absolute path to a directory under {#state_home}, creating
+  # it if it doesn't already exist.
+  #
+  # @param path [String] The relative path to the subdir within the base
+  #     state directory.
+  # @return [String] The absolute path to the subdir.
+  # @raise [SystemCallError] If a non-directory already exists there. It is
+  #     unspecified which specific error will be raised; it typically could
+  #     be `Errno::EEXIST` or `Errno::ENOTDIR`.
+  #
+  def ensure_state_subdir(path)
+    ensure_subdir_internal(state_home, path)
+  end
+
+  ##
+  # Returns the absolute path to a directory under {#cache_home}, creating
+  # it if it doesn't already exist.
+  #
+  # @param path [String] The relative path to the subdir within the base
+  #     cache directory.
+  # @return [String] The absolute path to the subdir.
+  # @raise [SystemCallError] If a non-directory already exists there. It is
+  #     unspecified which specific error will be raised; it typically could
+  #     be `Errno::EEXIST` or `Errno::ENOTDIR`.
+  #
+  def ensure_cache_subdir(path)
+    ensure_subdir_internal(cache_home, path)
+  end
+
+  private
+
+  ##
+  # Given an environment variable name, returns the value if it is a legal
+  # absolute path, otherwise returns nil. Used to interpret `XDG_*_HOME`
+  # variables.
+  #
+  def validate_dir_env(name)
+    path = @env[name].to_s
+    ::File.absolute_path?(path) ? path : nil
+  end
+
+  ##
+  # Given an environment variable name, returns nil if unset or empty,
+  # otherwise returns a (possibly empty) array of the valid paths.
+  #
+  def validate_dirs_env(name)
+    raw_value = @env[name].to_s
+    return nil if raw_value.empty?
+    validate_dirs(raw_value.split(::File::PATH_SEPARATOR))
+  end
+
+  ##
+  # Given an array of paths, returns a (possibly empty) array of which ones
+  # are valid absolute paths.
+  #
+  def validate_dirs(paths)
+    paths.find_all { |path| ::File.absolute_path?(path) }
+  end
+
+  ##
+  # Given an array of directories, a relative path, and an array of types,
+  # find and return all objects found as absolute paths.
+  #
+  def lookup_internal(dirs, path, types)
+    results = []
+    types = Array(types).map(&:to_s)
+    any_type = types.include?("any")
+    dirs.each do |dir|
+      to_check = ::File.join(dir, path)
+      stat = ::File.stat(to_check) rescue nil # rubocop:disable Style/RescueModifier
+      if stat&.readable? && (any_type || types.include?(stat.ftype))
+        results << to_check
+      end
+    end
+    results
+  end
+
+  ##
+  # Ensure directory exists, and return its absolute path.
+  #
+  def ensure_subdir_internal(base_dir, path)
+    path = ::File.join(base_dir, path)
+    ::FileUtils.mkdir_p(path, mode: 0o700)
+    path
+  end
+end

metadata

@@ -1,26 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: simple_xdg
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.1
 platform: ruby
 authors:
-- dazuma@gmail.com
+- Daniel Azuma
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
-description: This is a placeholder gem, which was generated on 2026-05-02 to reserve
-  the gem simple_xdg. The actual gem is planned for release in the near future. If
-  this is a problem, or if the actual gem has not been released in a timely manner,
-  you can contact the owner at dazuma@gmail.com.
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This class provides a simple no-frills implementation of the XDG Base
+  Directory Specification, which defines where certain user-specific application files,
+  such as configuration, cache, and saved state, should live on the user's file system.
+  It specifies environment variables that contain this information, and defaults that
+  should be used if those environment variables are unset. The spec itself is at https://specifications.freedesktop.org/basedir/latest/
+email:
+- dazuma@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.md
 - README.md
 - lib/simple_xdg.rb
-licenses: []
-metadata: {}
+- lib/simple_xdg/version.rb
+homepage: https://github.com/dazuma/simple_xdg
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/dazuma/simple_xdg/issues
+  changelog_uri: https://rubydoc.info/gems/simple_xdg/0.1.1/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/simple_xdg/0.1.1
+  homepage_uri: https://github.com/dazuma/simple_xdg
 rdoc_options: []
 require_paths:
 - lib
@@ -28,7 +55,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -37,5 +64,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.6
 specification_version: 4
-summary: Placeholder gem
+summary: A simple implementation of the XDG Base Directory Specification.
 test_files: []