{"id":22980965,"url":"https://github.com/rubyworks/xdg","last_synced_at":"2025-10-17T14:39:37.772Z","repository":{"id":662222,"uuid":"305198","full_name":"rubyworks/xdg","owner":"rubyworks","description":"XDG Base Directory Standard Library for Ruby","archived":false,"fork":false,"pushed_at":"2020-08-30T20:31:45.000Z","size":974,"stargazers_count":39,"open_issues_count":4,"forks_count":14,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-10-07T22:49:16.878Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://rubyworks.github.com/xdg/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"alexspeller/emblem-rails","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rubyworks.png","metadata":{"files":{"readme":"README.md","changelog":"HISTORY.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2009-09-12T18:26:04.000Z","updated_at":"2023-09-27T19:18:38.000Z","dependencies_parsed_at":"2022-08-16T10:35:23.981Z","dependency_job_id":null,"html_url":"https://github.com/rubyworks/xdg","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/rubyworks/xdg","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fxdg","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fxdg/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fxdg/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fxdg/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rubyworks","download_url":"https://codeload.github.com/rubyworks/xdg/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rubyworks%2Fxdg/sbom","scorecard":{"id":789050,"data":{"date":"2025-08-11","repo":{"name":"github.com/rubyworks/xdg","commit":"36b4708b1c057543226b28e8fbc406ef4f4572d5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 1/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 1 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-23T06:56:25.712Z","repository_id":662222,"created_at":"2025-08-23T06:56:25.712Z","updated_at":"2025-08-23T06:56:25.712Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279362934,"owners_count":26155808,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-17T02:00:07.504Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-15T01:46:19.031Z","updated_at":"2025-10-17T14:39:37.749Z","avatar_url":"https://github.com/rubyworks.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# XDG Standards for Ruby\n\n[Homepage](http://rubyworks.github.com/xdg) |\n[Source Code](http://github.com/rubyworks/xdg) |\n[Report Issue](http://github.com/rubyworks/xdg/issues) |\n[Mailing List](http://googlegroups.com/group.rubyworks-mailinglist) |\n[Chat Room](irc://irc.freenode.net/rubyworks)\n\n[![Build Status](https://secure.travis-ci.org/rubyworks/xdg.png)](http://travis-ci.org/rubyworks/xdg)\n\n\n## Introduction\n\nXDG provides an easy to use Ruby library for working with XDG standards.\n\nPresently, it only supports the XDG Base Directory Standard.\n\nIf your program utilizes user or system-wide support files\n(e.g. configuration files), you owe it to yourself to checkout\nthe XDG base directory standard.\n\nYou can learn more about the standard at:\nhttp://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html\n\n\n## How to Use\n\nFor working with XDG base directories, XDG provides a very simple\nyet flexible interface, `XDG[]`. Let's say you want to work\nwith the $XDG_CONFIG_HOME directory. Simply use:\n\n    XDG['CONFIG_HOME']\n\nThis will give you access to a number of useful methods all tied\ninto the user's personal configuration directory. Some examples:\n\n    XDG['CONFIG_HOME'].glob(pattern)\n    XDG['CONFIG_HOME'].select(pattern){ |path| ... }\n    XDG['CONFIG_HOME'].find(pattern){ |path| ... }\n\nThe same holds true for the other base directories.\n\n    XDG['DATA_HOME']\n    XDG['DATA_DIRS']\n\n    XDG['CACHE_HOME']\n    XDG['CACHE_DIRS']\n\nBy leaving out the last qualifier, XDG will provide an interface\nthat ties into both the `HOME` and `DIRS` paths.\n\n    XDG['DATA']\n    XDG['CONFIG']\n    XDG['CACHE']\n\nIf you know XDG these are pretty much self-explanatory.\nBut see the YARD-based API documentation for further specifics.\n\n### Extended Functionality\n\nThe Ruby XDG module also provides extended functionality\nnot part of the standard specification. These extensions are\nsimply add-on functionality deemed useful, or implementations\nof  proposals being discussed for a possible future version of\nthe standard.\n\n    XDG['CONFIG_WORK']\n    XDG['CACHE_WORK']\n\nSee the API documentation to learn more. Note that the extended modules\nare subject to greater potential for change as they are still being refined.\n\n### Base Directory Mixin\n\nXDG provides a convenient base directory mixin that can provide handy a\ninterface to a classes.\n\n    class MyAppConfig\n      include XDG::BaseDir::Mixin\n\n      def subdirectory\n        'myapp'\n      end\n    end\n\n    c = MyAppConfig.new\n\n    c.config.home.to_s  #=\u003e '~/.config/myapp'\n\n\n### Legacy API\n\nVersion 2.0+ of library marks a major departure from the earlier\n\"fluid\" notation of previous releases. Where as one used to do:\n\n    XDG.data.home\n\nWith the new API one now does:\n\n    XDG['DATA_HOME']\n\nThis was done for a few reasons, but primarily because it reflects more\nclosely Ruby's interface to the environment variables themselves, e.g.\n\n    ENV['XDG_DATA_HOME']\n\nIf you prefer the older style, a compatibility layer is provided. You will\nneed to load:\n\n    require 'xdg/base_dir/legacy'\n\nHowever we STRONGLY RECOMMEND that you do not use the legacy API --use it only\nif you need to keep some old code working and don't have time to update it at\nthe moment. Sometime in the future the legacy API will be deprecated.\n\n\n## How to Install\n\nUsing RubyGems:\n\n    $ sudo gem install xdg\n\nInstalling the tarball requires Ruby Setup (see http://rubyworks.github.com/setup).\n\n    $ tar -xvzf xdg-0.5.2\n    $ cd xdg-0.5.2\n    $ sudo setup.rb all\n\n\n## Development\n\n[GitHub](http://github.com) hosts our [source code](http://github.com/rubyworks/xdg)\nand [issue ticket system](http://github.com/rubyworks/xdg/issues).\n\nTo contribute to the project please fork the repository, ideally, create a new\ntopic branch for your work, and submit a pull request.\n\n\n## Copyright \u0026 License\n\nCopyright (c) 2008 Rubyworks\n\nDistributed under the terms of the *FreeBSD* license.\n\nSee LICENSE.txt file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fxdg","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frubyworks%2Fxdg","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frubyworks%2Fxdg/lists"}