Canuby

Travis Appveyor GitHub Downloads GitHub repo size in bytes

Rubygems Version Rubygems Downloads GitHub Version GitHub Downloads

CodeFactor AwesomeCode Status Codecov Inline docs

WIP

How to run

  • gem install canuby
  • canuby

Note

Some rake task have longer descriptions and are only complettly readable if you use rake -T | cat or rake -D

On Windows version older than 10 (like Windows 7 or Windows 8) you may need to install the win32console gem to show colors correctly. To do that run: gem install win32console.

Version scheme

Canuby uses this MAJOR.MINOR.PATCH version scheme. It is based of https://semver.org/ version scheme.

How to run from source

To use canuby from source run these command inside your cloned repository. On Windows it may be necessary to use an elevated command prompt to install all gems correctly.

  • gem install bundler
  • ruby bin/setup
  • ruby exe/canuby or rake -f exe\canuby or rake thirdparty

To get a full list of all arguments invoke canuby with the -h flag.

Environment variables Canuby makes use of:

  • CI=true force CI environment
  • DEBUG=true show debug information
  • linux=true force linux environment

Contributing

Code Style

  • This projects uses rubocop. Get it with gem install rubocop and then run rubocop inside the git repo. PR's without rubocop applied are not being merged.

Rubocop Style Reference: https://rubocop.readthedocs.io/en/latest/cops_style/

  • Fasterer is a tool that will suggest speed improvements for your ruby code. It is highly recommended to use on bigger changes to keep the Canuby code fast. Get it with gem install fasterer and then run fasterer inside the git repo to get the code flash fast.

Testing

To run the Canuby tests use rake test in the root directory.

Documenting

Canuby uses yardoc to generate the docs. They are available here GitHub Downloads. To update the documentation run rake yard.

Usefull Links