daverooneyca / code_joy

A port of @DocOnDev's Code Joy to Python

Git Hooks for Measuring Code Joy

NOTE: This is a port of @DocOnDev's Code Joy to Python

Doc Norton created a tool that allowed developers to indicate the "joy" they felt (or didn't feel) while working in a particular piece of code. This is done by adding a rating to the message when making a commit. For background on why this is important, please read Doc's article on the topic.

The format for the commit message is:

-(rating value)- Your commit message

Example:

git commit -m "-3- Added more tests to the prepare method"

The rating is on a scale from 0 to 5:

• 0 - I may leave the software profession due to this code
• 1 - My eyes are bleeding and I don't know why this code works
• 2 - This is a tangled mess and caused physical pain while working in it
• 3 - I've seen worse, but I've seen better
• 4 - I'm pretty happy with this code
• 5 - This is the most clear, expressive and elegant code I've ever encountered

Obviously, we want to see 3's and up!

Please note that, after processing, the rating is removed from the commit message and not stored in git.

The Hooks

The commit-msg hook will reject commits that do not have a quality rating

The post-commit hook will post the accepted commit to the configured repository. Current only NOOP and HTTP repositories are available.

Installation

Common

• Ensure that Python 3.7 or higher is installed on the machine
• Copy the contents of the src directory of this repo to the .git/hooks directory in any repository for which you want to use these hooks

Linux, macOS

• Rename commit-msg.py to commit-msg
• Rename post-commit.py to post-commit
• Ensure both of those scripts are executable by running:
  • chmod +x commit-msg
  • chmod +x post-commit

Windows

• Rename commit-msg-windows.py to commit-msg
• Rename post-commit-windows.py to post-commit
• Change the first line of each of those scripts, depending on the location of the Python executable on your system
  • the default is #!%userprofile%\AppData\Local\Microsoft\WindowsApps\python.exe

Configuration

• In the .git/hooks directory, rename code_joy.cfg.sample to code_joy.cfg, and make any required changes to the settings in the file:
  • You can change the path of the file that temporarily stores the rating from the commit message to any file accessible to the code
  • You can change the repository class to be used for persisting the details of the commit. This defaults to: http_commit_repository.HttpCommitRepository, but can also be set to noop_commit_repository.NoopCommitRepository which does nothing except echo the details of the commit. This can be useful for testing.
• If you are using the HttpCommitRepository, which simply sends the commit details to an HTTP endpoint using a POST call:
  • In the .git/hooks directory, rename http_commit_repository.cfg.sample to http_commit_repository.cfg
  • Set the endpoint’s URL in http_commit_repository.cfg

Python Libraries

Runtime

CodeJoy doesn’t require any libraries outside of core Python

Development

If you wish to create a repository other than the NOOP and HTTP versions shipped with Code Joy, create a class that extends CommitRepository and implement the save method.

To run the tests, you need to install PyTest and Doubles

pip install -U pytest

pip install -U doubles

To run the tests, from the root directory of the project simply run pytest.

For all PyTest command line options, run pytest -h.