ruby off

yegor256 · Jun 15, 2019 · 92352cd · 92352cd
1 parent d643659
commit 92352cd
Show file tree

Hide file tree

Showing 21 changed files with 15 additions and 829 deletions.
diff --git a/.rubocop.yml b/.rubocop.yml
diff --git a/.rultor.yml b/.rultor.yml
diff --git a/Gemfile b/Gemfile
diff --git a/README.md b/README.md
@@ -1,16 +1,10 @@
-[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/volatility)](http://www.rultor.com/p/yegor256/volatility)
-[![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
-
 [![Build Status](https://travis-ci.org/yegor256/volatility.svg)](https://travis-ci.org/yegor256/volatility)
-[![Build status](https://ci.appveyor.com/api/projects/status/3i9r5lak77mmfbr0?svg=true)](https://ci.appveyor.com/project/yegor256/volatility-1rwvv)
-
-[![Gem Version](https://badge.fury.io/rb/volatility.svg)](http://badge.fury.io/rb/volatility)
 [![Code Climate](http://img.shields.io/codeclimate/github/yegor256/volatility.svg)](https://codeclimate.com/github/yegor256/volatility)
-[![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/volatility.svg)](https://codecov.io/github/yegor256/volatility?branch=master)
 [![Hits-of-Code](https://hitsofcode.com/github/yegor256/volatility)](https://hitsofcode.com/github/yegor256/volatility)
 
 It's an experimental way to calculate how "volatile" is a project
-source code repository. More or less detailed theoretical summary
+source code repository, by comparing the amount of dead code (rarely touched)
+with the amount of actively modified one. More or less detailed theoretical summary
 is in [theory.pdf](https://github.com/downloads/yegor256/volatility/theory.pdf).
 
 Prerequisites:
@@ -26,15 +20,24 @@ Prerequisites:
 First, collect lines-of-code data (we assume that your source code
 has been already checked-out/cloned into `PROJECT` directory):
 
-> $ ./cloc-1.56.pl --xml --quiet --progress-rate=0 PROJECT > cloc.xml
+```bash
+$ ./cloc-1.56.pl --xml --quiet --progress-rate=0 PROJECT > cloc.xml
+```
 
 Next, calculate the volatility, using our custom PHP script. For Git
 repository:
 
-> $ git --git-dir PROJECT/.git log --reverse --format=short --stat=1000 --stat-name-width=950 | php volatility.php --git > vol.json
+```
+$ git --git-dir PROJECT/.git log --reverse --format=short --stat=1000 --stat-name-width=950 | \
+  php volatility.php --git > vol.json
+```
+
+For a Subversion repository:
 
-for Subversion repository:
+```
+$ svn log -r1:HEAD -v PROJECT | php volatility.php --svn > vol.json
+```
 
-> $ svn log -r1:HEAD -v PROJECT | php volatility.php --svn > vol.json
+The `vol.json` file will contain the metrics collected.
 
 That's it.
diff --git a/Rakefile b/Rakefile
diff --git a/bin/volatility b/bin/volatility
diff --git a/cucumber.yml b/cucumber.yml
diff --git a/features/cli.feature b/features/cli.feature
diff --git a/features/gem_package.feature b/features/gem_package.feature
diff --git a/features/git_basics.feature b/features/git_basics.feature
diff --git a/features/step_definitions/steps.rb b/features/step_definitions/steps.rb