Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/calavera/mcclimate
https://github.com/calavera/mcclimate
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/calavera/mcclimate
- Owner: calavera
- Created: 2014-05-09T17:02:03.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-02-19T23:50:09.000Z (almost 9 years ago)
- Last Synced: 2024-04-14T09:16:02.415Z (9 months ago)
- Language: Ruby
- Size: 48.8 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# McClimate
McClimate complexity is an algorithm that measures the complexity of mathematical formulas inside Ruby method definitions.
- The minimum score that a method can have is 1.
- For every use of the four main arithmatic operators (+, -, * and /), the algorithm adds 1 to the score.
- For every literal number, the algorithm adds 1 to the score.
## Installation
McClimate uses Rugged to interact with git repositories. Unfortunately, there has not been any release in 10 months.
Rugged's development branch has a lot of improvements that have not been released yet.
The scripts in this repository use Bundler to make sure the Rugged and LibGit2 versions are correct.
If you want to install McClimate as a gem, you'll need to make sure the versions for those two dependencies are properly installed.
## Usage
### Calculating complexity
The script `bin/complexity` calculates the McClimate score for a given git project. It also accepts a second argument to indicate
the git SHA referencing the tree that we want to analize.
Example:
```
$ bin/complexity path/to/git/repo
```
```
$ bin/complexity path/to/git/repo SHA
```
#### Displaying Results
`bin/complexity` shows you a warning message for every method with complexity higher than 10.
Methods with score lower than 10 are not displayed, but they are still stored in the [cache](#caching-results) for future references.
### Caching results
`bin/complexity` caches its results inside temporal files. Those files store serialized data with the score for every method found.
The cache is stored in the global temporal directory defined by your operating system, but it can be overrided setting the environment variable `MCCLIMATE_CACHE`.
### Comparing results
`bin/compare` can compare the results for two different shas for the same repository. This script takes three arguments, the repository path, to know which cache to
use, the old sha and the new sha:
```
$ bin/compare path/repo old_sha new_sha
```
If you're like me, and never remember the SHAs that have been computed already, you can use the next script to see a list of SHAs in the cache.
### Inspecting the cache
`bin/inspect-cache` gives you a list of SHAs in the cache directory for a given repo. Each SHA has associated a number that's the count of the files inside:
```
$ bin/inspect-cache path/repo
```
## Benchmarks
The folder `bench` includes several benchmarks used to measure the performance of the complexity algorithm.
These benchmarks don't produce any output, they use the basic reporter that doesn't print to stdout.
Eeach benchmark is a self executed script, that you can run like this:
```
$ bench/bench_self_score
```
## License
MIT