The Ruby Toolbox library catalog
Clone or download
colszowka Merge pull request #168 from gettalong/patch-2
Add HexaPDF to the "PDF Processing" category
Latest commit f774e39 Oct 9, 2018
Permalink
Failed to load latest commit information.
build Improve 'landing page' info Oct 18, 2017
catalog Merge pull request #168 from gettalong/patch-2 Oct 9, 2018
lib catalog.rb: Avoiding p as a local name [ci skip] Feb 8, 2018
spec Actually also take prerelease-only gems into account Sep 27, 2018
.editorconfig Add ruby and tooling: RSpec, Rubocop, Overcommit, Guard, .gitignore, Oct 8, 2017
.gitignore Add export of catalog as json to build directory Oct 18, 2017
.overcommit.yml Add ruby and tooling: RSpec, Rubocop, Overcommit, Guard, .gitignore, Oct 8, 2017
.rspec Add ruby and tooling: RSpec, Rubocop, Overcommit, Guard, .gitignore, Oct 8, 2017
.rubocop Add ruby and tooling: RSpec, Rubocop, Overcommit, Guard, .gitignore, Oct 8, 2017
.rubocop.yml An error message, only on CI. One google result. In Japanese. Fixes t… Sep 27, 2018
.ruby-version Add a PR template (and sneakily update ruby) Feb 22, 2018
.simplecov Add ruby and tooling: RSpec, Rubocop, Overcommit, Guard, .gitignore, Oct 8, 2017
.travis.yml Fix some rubocop offenses, actually run it on CI (-‸ლ) Sep 27, 2018
CODE_OF_CONDUCT.md Add contributor-covenant.org as code of conduct Oct 3, 2017
Gemfile Add pry Sep 27, 2018
Gemfile.lock Update rubocop-rspec to version 1.30.0 Oct 8, 2018
Guardfile Add ruby and tooling: RSpec, Rubocop, Overcommit, Guard, .gitignore, Oct 8, 2017
MIT-LICENSE Add MIT license Oct 18, 2017
PULL_REQUEST_TEMPLATE.md Make TODOs in PR-template an actual todo list as shown in #122 May 11, 2018
README.md Fix minor typo Feb 21, 2018
Rakefile Add export of catalog as json to build directory Oct 18, 2017
json-schema.yml Move schema to a separate (yml) file Oct 18, 2017

README.md

Ruby Toolbox Catalog Build Status

Welcome to the Ruby Toolbox catalog!

This repository contains the mapping of category groups, categories and ruby open source projects and is based on a database dump of the old Ruby Toolbox site.

You can find the current exported catalog at https://rubytoolbox.github.io/catalog

Contributing

Help wanted! Feel free to send pull requests against this repo to add or moderate existing categories.

If you plan on bigger changes, please consider:

  • splitting your changes into multiple separate PRs to avoid merge conflicts
  • if your changes could need discussion, please create an issue on the main repo up-front for further discussion.

Structure

You can find the catalog in catalog. The structure is validated at build time against the JSON schema.

The folder structure is as follows:

catalog/
  CATEGORY_GROUP_1_PERMALINK/
    _meta.yml # Allows to add metadata about category group
    category_1_permalink.yml # Definition of category and its projects
    ...
  ...

Each category group contains a _meta.yml, which currently only defines the name key, which should be the human display name of that category.

Each category.yml currently contains:

  • name (string, required): Human display name of the category name
  • description (string, optional): A (markdown-formatted) category description
  • projects (array of strings in alphabetical order, required): The list of projects to list in that category. For rubygems, this is the plain gem name, for github repos it's the full repo slug (github_user/repo_name). Projects can be listed in multiple categories.