Home

Welcome to the dsu wiki.

Install

gem install dsu

Help

After installation (gem install dsu), the first thing you may want to do is run the dsu help:

Displaying Help

$ dsu or $ dsu help

#=>
Commands:
  dsu add|a [OPTIONS] DESCRIPTION  # Adds a DSU entry...
  dsu browse|b SUBCOMMAND          # Browse DSU entries...
  dsu config|c SUBCOMMAND          # Manage configuration...
  dsu delete|d SUBCOMMAND          # Delete DSU entries...
  dsu edit|e SUBCOMMAND            # Edit DSU entries...
  dsu export|x SUBCOMMAND          # Export DSU entries...
  dsu help [COMMAND]               # Describe available...
  dsu import|m SUBCOMMAND          # Imports DSU entries...
  dsu info|i                       # Displays information...
  dsu list|l SUBCOMMAND            # Displays DSU entries...
  dsu theme|t SUBCOMMAND           # Manage DSU themes...
  dsu version|-v|v                 # Displays this gem version

Options:
  [--debug], [--no-debug]

Dates

These notes apply to anywhere DATE is used...

DATE may be any date string that can be parsed using Time.parse. Consequently, you may omit the year if the date you want to display is the current year (e.g. /, or 1/31). For example: require 'time'; Time.parse('2023/01/02'); Time.parse('1/2/2023'); Time.parse('1/2') ## etc.

Mnemonics

These notes apply to anywhere MNEMONIC is used...

A mnemonic may be any of the following: n|today|t|tomorrow|y|yesterday|+n|-n.

Where n, t, y are aliases for today, tomorrow, and yesterday, respectively.

Where +n, -n are relative date mnemonics (RDMs). Generally speaking, RDMs are relative to the current date. For example, a RDM of +1 would be equal to Time.now + 1.day (or tomorrow), and a RDM of -1 would be equal to Time.now - 1.day (or yesterday).

NOTE: In some cases the behavior RDMs have on some commands are context dependent; in such cases the behavior will be noted in the help appropriate to the command, for example see the following dsu command help: dsu list help date and dsu list help dates.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/gangelo/dsu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Dsu project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.