volatility 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ae778023e10f6f3df5d0bde8b2224190d8d38fd9894f37f3e42991aeff42d16d
+  data.tar.gz: 06ec9bedb53b835950d6594f478e87cb9d7e195a3648cd7b15bb4b5edce17119
+SHA512:
+  metadata.gz: f1c375ed4b9331daf1f991221dfc4871646761e14d557f0883b2cdab2e3d605c6e369607e1092024dd86dc14f4d1b3a523c939454a2ad063ded6d1f89de07123
+  data.tar.gz: 01c649c4038d089d1bf0ca9a3765486c27a9ff7a3e74777730523f4fe83c0be4cefa836ac693026e8b961b96b68431e7a77195024a29c8e9d9a1eec0c5f7f92c

data/.0pdd.yml

@@ -0,0 +1,9 @@
+errors:
+  - yegor256@gmail.com
+# alerts:
+#   github:
+#     - yegor256
+
+tags:
+  - pdd
+  - bug

data/.gitattributes

@@ -0,0 +1,8 @@
+# Check out all text files in UNIX format, with LF as end of line
+# Don't change this file. If you have any ideas about it, please
+# submit a separate issue about it and we'll discuss.
+
+* text=auto eol=lf
+*.java ident
+*.xml ident
+*.pdf binary

data/.gitignore

@@ -0,0 +1,11 @@
+coverage/
+Gemfile.lock
+.idea/
+*.gem
+.bundle/
+.DS_Store
+rdoc/
+*.log
+*.aux
+*.fdb_latexmk
+*.fls

data/.latexmkrc

@@ -0,0 +1,2 @@
+$latex = 'latex  %O  --shell-escape %S';
+$pdflatex = 'pdflatex  %O  --shell-escape %S';

data/.pdd

@@ -0,0 +1,7 @@
+--source=.
+--verbose
+--exclude target/**/*
+--exclude coverage/**/*
+--rule min-words:20
+--rule min-estimate:15
+--rule max-estimate:90

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  Exclude:
+    - 'assets/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Style/GlobalVars:
+  Enabled: false
+Metrics/LineLength:
+  Max: 100
+Layout/EndOfLine:
+  EnforcedStyle: lf
+Metrics/BlockLength:
+  Max: 30
+Layout/AlignParameters:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false
+

data/.rultor.yml

@@ -0,0 +1,24 @@
+assets:
+  rubygems.yml: yegor256/home#assets/rubygems.yml
+install: |
+  sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
+release:
+  script: |-
+    bundle exec rake
+    rm -rf *.gem
+    sed -i "s/0\.0\.0/${tag}/g" bin/volatility
+    sed -i "s/0\.0\.0/${tag}/g" volatility.gemspec
+    git add bin/volatility
+    git add volatility.gemspec
+    git commit -m "version set to ${tag}"
+    gem build volatility.gemspec
+    chmod 0600 ../rubygems.yml
+    gem push *.gem --config-file ../rubygems.yml
+merge:
+  script: |-
+    bundle exec rake
+    pdd -f /dev/null
+deploy:
+  script: |-
+    echo "There is nothing to deploy"
+    exit -1

data/.simplecov

@@ -0,0 +1,38 @@
+# Copyright (c) 2019-2020 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+if Gem.win_platform? then
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter
+  ]
+  SimpleCov.start do
+    add_filter "/test/"
+    add_filter "/features/"
+  end
+else
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+    [SimpleCov::Formatter::HTMLFormatter]
+  )
+  SimpleCov.start do
+    add_filter "/test/"
+    add_filter "/features/"
+    minimum_coverage 60
+  end
+end

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 2.6.0
+cache: bundler
+branches:
+  only:
+    - master
+install:
+  - gem install pdd -v 0.20.5
+  - travis_retry bundle update
+script:
+  - pdd -f /dev/null
+  - bundle exec rake
+after_success:
+  - "bash <(curl -s https://codecov.io/bash)"

data/Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2012-2020 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+source 'https://rubygems.org'
+ruby '~>2.3'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2012-2016 Yegor Bugayenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the 'Software'), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
+[![Managed by Zerocracy](https://www.0crat.com/badge/C3RFVLU72.svg)](https://www.0crat.com/p/C3RFVLU72)
+[![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/tbeaa0d4dk38xdb5?svg=true)](https://ci.appveyor.com/project/yegor256/volatility)
+[![PDD status](http://www.0pdd.com/svg?name=yegor256/volatility)](http://www.0pdd.com/p?name=yegor256/volatility)
+[![Gem Version](https://badge.fury.io/rb/volatility.svg)](http://badge.fury.io/rb/volatility)
+[![Maintainability](https://api.codeclimate.com/v1/badges/74c909f06d4afa0d8001/maintainability)](https://codeclimate.com/github/yegor256/volatility/maintainability)
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/takes/volatility/master/LICENSE.txt)
+[![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/view/github/yegor256/volatility)
+
+It's an experimental way to calculate how "volatile" is a project
+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/yegor256/volatility/raw/master/theory.pdf).
+
+You need to have Ruby 2.6+ installed. Then you install this tool:
+
+```bash
+$ gem install volatility
+```
+
+Then, you run it:
+
+```bash
+$ volatility --help
+```
+
+## How to contribute
+
+Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
+Make sure your build is green before you contribute
+your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
+[Bundler](https://bundler.io/) installed. Then:
+
+```
+$ bundle update
+$ bundle exec rake
+```
+
+If it's clean and you don't see any error messages, submit your pull request.

data/Rakefile

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-2020 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'rubygems'
+require 'rake'
+require 'rdoc'
+require 'rake/clean'
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.*')
+end
+
+def version
+  Gem::Specification.load(Dir['*.gemspec'].first).version
+end
+
+task default: %i[clean test features rubocop copyright]
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  ENV['skip_live'] = 'yes'
+  Rake::Cleaner.cleanup_files(['coverage'])
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = false
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.requires << 'rubocop-rspec'
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do
+  Rake::Cleaner.cleanup_files(['coverage'])
+end
+Cucumber::Rake::Task.new(:'features:html') do |t|
+  t.profile = 'html_report'
+end
+
+task :copyright do
+  sh "grep -q -r '2019-#{Date.today.strftime('%Y')}' \
+    --include '*.rb' \
+    --include '*.txt' \
+    --include 'Rakefile' \
+    ."
+end

data/bin/volatility

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright (c) 2019-2020 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+STDOUT.sync = true
+
+VERSION = '0.1.0'
+
+require 'slop'
+require 'backtrace'
+
+$verbose = false
+
+def put(msg)
+  puts msg if $verbose
+end
+
+begin
+  begin
+    opts = Slop.parse(ARGV, strict: true, help: true) do |o|
+      o.banner = "Usage (#{VERSION}): volatility [options]
+Options are:"
+      o.bool '--verbose', 'Print all details' do
+        $verbose = true
+      end
+      o.string '--home',
+        'The path to the repository (current dir by default)',
+        default: '.'
+      o.bool '--help', 'Read this: https://github.com/yegor256/volatility' do
+        puts o
+        exit
+      end
+    end
+  rescue Slop::Error => ex
+    raise ex.message
+  end
+  files = {}
+  home = File.expand_path(opts[:home])
+  puts "Home: #{home}"
+  `git --git-dir=#{home}/.git log --numstat`.split("\n").each do |t|
+    add, del, file = t.split("\t", 3)
+    next if file.nil?
+    files[file] = 0 if files[file].nil?
+    files[file] += add.to_i
+    files[file] += del.to_i
+  end
+  raise "No Git history found in #{home}" if files.empty?
+  put "N = #{files.count}"
+  values = files.select { |f, _| File.exist?(File.join(home, f)) }.map { |_, v| v }
+  put "M = #{values.count}"
+  min = values.min
+  put "Min = #{min}"
+  max = values.max
+  put "Max = #{max}"
+  values = values.map { |v| (v - min).to_f / (max - min) }
+  mu = values.inject(&:+) / values.count
+  put "µ = #{mu}"
+  var = values.map { |v| (v - mu)**2 }.inject(&:+).to_f / values.count
+  put "Var(X) = #{var}"
+  puts var
+rescue StandardError => ex
+  puts Backtrace.new(ex).to_s
+  exit(255)
+end

data/cucumber.yml

@@ -0,0 +1,3 @@
+default: --format pretty
+travis: --format progress
+html_report: --format progress --format html --out=features_report.html

data/features/cli.feature

@@ -0,0 +1,22 @@
+Feature: Command Line Processing
+  As a Git developer I want to calculate volatility of my repo
+
+  Scenario: Help can be printed
+    When I run bin/volatility with "--help"
+    Then Exit code is zero
+    And Stdout contains "--help"
+
+  Scenario: Volatility can be calculated
+    When I run bash with:
+    """
+    git config --global user.name "NoName"
+    git config --global user.email "noname@example.com"
+    mkdir tmp
+    cd tmp
+    git init .
+    touch test.txt
+    git add test.txt
+    git commit -am 'test'
+    """
+    Then I run bin/volatility with "--verbose --home=./tmp"
+    Then Exit code is zero

data/features/gem_package.feature

@@ -0,0 +1,24 @@
+Feature: Gem Package
+  As a source code writer I want to be able to
+  package the Gem into .gem file
+
+  Scenario: Gem can be packaged
+    Given It is Unix
+    Given I have a "execs.rb" file with content:
+    """
+    #!/usr/bin/env ruby
+    require 'rubygems'
+    spec = Gem::Specification::load('./spec.rb')
+    if spec.executables.empty?
+      fail 'no executables: ' + File.read('./spec.rb')
+    end
+    """
+    When I run bash with:
+    """
+    cd volatility
+    gem build volatility.gemspec
+    gem specification --ruby volatility-*.gem > ../spec.rb
+    cd ..
+    ruby execs.rb
+    """
+    Then Exit code is zero

data/features/step_definitions/steps.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-2020 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'nokogiri'
+require 'tmpdir'
+require 'slop'
+require 'English'
+
+Before do
+  @cwd = Dir.pwd
+  @dir = Dir.mktmpdir('test')
+  FileUtils.mkdir_p(@dir) unless File.exist?(@dir)
+  Dir.chdir(@dir)
+  @opts = Slop.parse ['-v', '-s', @dir] do |o|
+    o.bool '-v', '--verbose'
+    o.string '-s', '--source'
+  end
+end
+
+After do
+  Dir.chdir(@cwd)
+  FileUtils.rm_rf(@dir) if File.exist?(@dir)
+end
+
+Given(/^I have a "([^"]*)" file with content:$/) do |file, text|
+  FileUtils.mkdir_p(File.dirname(file)) unless File.exist?(file)
+  File.open(file, 'w') do |f|
+    f.write(text.gsub(/\\xFF/, 0xFF.chr))
+  end
+end
+
+When(%r{^I run bin/volatility with "([^"]*)"$}) do |arg|
+  home = File.join(File.dirname(__FILE__), '../..')
+  @stdout = `ruby -I#{home}/lib #{home}/bin/volatility #{arg}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+Then(/^Stdout contains "([^"]*)"$/) do |txt|
+  raise "STDOUT doesn't contain '#{txt}':\n#{@stdout}" unless @stdout.include?(txt)
+end
+
+Then(/^Stdout is empty$/) do
+  raise "STDOUT is not empty:\n#{@stdout}" unless @stdout == ''
+end
+
+Then(/^Exit code is zero$/) do
+  raise "Non-zero exit #{@exitstatus}:\n#{@stdout}" unless @exitstatus.zero?
+end
+
+Then(/^Exit code is not zero$/) do
+  raise 'Zero exit code' if @exitstatus.zero?
+end
+
+When(/^I run bash with "([^"]*)"$/) do |text|
+  FileUtils.copy_entry(@cwd, File.join(@dir, 'volatility'))
+  @stdout = `#{text}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+When(/^I run bash with:$/) do |text|
+  FileUtils.copy_entry(@cwd, File.join(@dir, 'volatility'))
+  @stdout = `#{text}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+Given(/^It is Unix$/) do
+  pending if Gem.win_platform?
+end
+
+Given(/^It is Windows$/) do
+  pending unless Gem.win_platform?
+end

data/features/support/env.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2019-2020 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'simplecov'
+# require 'aruba/cucumber'

data/theory.tex

@@ -0,0 +1,77 @@
+% Copyright (c) 2012-2020, Yegor Bugayenko
+% All rights reserved.
+%
+% Redistribution and use in source and binary forms, with or without
+% modification, are permitted provided that the following conditions
+% are met: 1) Redistributions of source code must retain the above
+% copyright notice, this list of conditions and the following
+% disclaimer. 2) Redistributions in binary form must reproduce the above
+% copyright notice, this list of conditions and the following
+% disclaimer in the documentation and/or other materials provided
+% with the distribution. 3) Neither the name of Yegor Bugayenko nor
+% the names of other contributors may be used to endorse or promote
+% products derived from this software without specific prior written
+% permission.
+%
+% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+% "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+% NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+% FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+% THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+% INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+% (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+% SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+% HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+% STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+% OF THE POSSIBILITY OF SUCH DAMAGE.
+%
+\documentclass[12pt]{article}
+\usepackage{amsmath}
+\begin{document}
+\title{Source Code Volatility (SCV)\\to Spot Dead Code}
+\author{Yegor Bugayenko}
+\maketitle
+
+\section{Introduction}
+
+Volatility of source code is an experimental metric that
+shows how big is the difference between actively and rarely changed (possibly dead)
+code. It is assumed that a big percentage of dead code is
+an indicator of maintainability problems in the project.
+
+\section{Details}
+
+First, by looking at Git history,
+it is observed how many times every source code file $i$ out of $N$ was touched
+during the lifetime of the repository:
+
+\begin{eqnarray}
+T = [t_1, t_2, \dots, t_N]
+\end{eqnarray}
+
+Then, $t$ that relate to the files already absent in the
+repository are deleted and the array $T$ is ``normalized''
+to keep all values within the $[0,1]$ range:
+
+\begin{eqnarray}
+X = [x_1, x_2, \dots, x_M],\quad \text{where}\ x_i = \frac{t_i - \hat{T}}{\check{T} - \hat{T}}
+\end{eqnarray}
+
+Then, the mean $\mu$ is calculated as:
+
+\begin{eqnarray}
+\mu = \frac{1}{M}\sum{x_i}
+\end{eqnarray}
+
+Finally, the variance is calculated as:
+
+\begin{eqnarray}
+Var(x) = \frac{1}{M}\sum{|x_i - \mu|^2}
+\end{eqnarray}
+
+The variance $Var(x)$ is the volatility of the source code. The smaller
+the volatility the more cohesive is the repository and the smaller
+the amount of the dead code inside it.
+
+\end{document}

data/volatility.gemspec

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2012-2020 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'English'
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  if s.respond_to? :required_rubygems_version=
+    s.required_rubygems_version = Gem::Requirement.new('>= 0')
+  end
+  s.rubygems_version = '2.2'
+  s.required_ruby_version = '>= 2.3'
+  s.name = 'volatility'
+  s.version = '0.1.0'
+  s.license = 'MIT'
+  s.summary = 'Source Code Volatility'
+  s.description = 'The command line tool calculates the SCV metric for a Git repo'
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor256@gmail.com'
+  s.homepage = 'http://github.com/yegor256/volatility'
+  s.files = `git ls-files`.split($RS)
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
+  s.add_runtime_dependency 'backtrace', '~> 0.3'
+  s.add_runtime_dependency 'slop', '~> 4.6'
+  s.add_development_dependency 'codecov', '0.1.10'
+  s.add_development_dependency 'cucumber', '~> 1.3.17'
+  s.add_development_dependency 'minitest', '5.5.0'
+  s.add_development_dependency 'rake', '12.0.0'
+  s.add_development_dependency 'rspec-rails', '3.1.0'
+  s.add_development_dependency 'rubocop', '0.61.0'
+  s.add_development_dependency 'rubocop-rspec', '1.31.0'
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: volatility
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yegor Bugayenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backtrace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.6'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.17
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.17
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.61.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.61.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.31.0
+description: The command line tool calculates the SCV metric for a Git repo
+email: yegor256@gmail.com
+executables:
+- volatility
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- ".0pdd.yml"
+- ".gitattributes"
+- ".gitignore"
+- ".latexmkrc"
+- ".pdd"
+- ".rubocop.yml"
+- ".rultor.yml"
+- ".simplecov"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/volatility
+- cucumber.yml
+- features/cli.feature
+- features/gem_package.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- theory.pdf
+- theory.tex
+- volatility.gemspec
+homepage: http://github.com/yegor256/volatility
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 2
+summary: Source Code Volatility
+test_files:
+- features/cli.feature
+- features/gem_package.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb