volatility 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0b5ec6cb7d308ddcbdaffd0be5a523705439d2e34b4e4fcfe1735f15f5141c4
-  data.tar.gz: d10a22a734a413ffd11f891252596ed69a870f57aadb4832c7fef9e0c73cdb0c
+  metadata.gz: ec9c180b994b4c6cefec35a05422f1f42f9b1dd93c3df6e1d645ed6b03207e0a
+  data.tar.gz: 001c96313356478f3d97ec63e8602ef9645e53885b664588cb70d00562d7d23c
 SHA512:
-  metadata.gz: 610ccdf77eebbcc63f26aa05190fae5977e3798d0b6f99c81b659f7ed6fede90cf541286a5505b8d651e6a58602c59a02c9fba74922f3675d963725ee7380a75
-  data.tar.gz: a91a2ce7050c523a00357d78f91e5981d3c7740734e992348e1a6607b92d9f232ea5e61f8e74fbe6fa8659742bddb3579057d2665651dcae96da6c0f9f351624
+  metadata.gz: 1a1d834fa4643dc34c840a95d8205a83fd51659cd9721537b802fb9b6cbf879da74ff7c1693ab0804dbd52258a77eedb9e0283fdf0ec916e28dc1d6be0cde02e
+  data.tar.gz: 06f0118bba2fdcd2bc0149fee55854c443da98c21cbdb8d732e617980c1702eccbd9403aaf833282f18adc86695e2ffb4a5b2e366942a41c921323a60bc9f3e2

data/bin/volatility

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-# Copyright (c) 2019-2020 Yegor Bugayenko
+# 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
@@ -23,7 +23,7 @@
 
 STDOUT.sync = true
 
-VERSION = '0.1.2'
+VERSION = '0.2.0'
 
 require 'slop'
 require 'backtrace'
@@ -42,6 +42,7 @@ Options are:"
       o.bool '--verbose', 'Print all details' do
         $verbose = true
       end
+      o.integer '--sectors', 'Total sectors to use', default: 64
       o.string '--home',
         'The path to the repository (current dir by default)',
         default: '.'
@@ -71,10 +72,14 @@ Options are:"
   put "Min = #{min}"
   max = values.max
   put "Max = #{max}"
-  values = values.map { |v| (v - min).to_f / (max - min) }
-  mu = values.inject(&:+) / values.count
+  delta = (max - min) / opts[:sectors]
+  delta = 1 if delta.zero?
+  put "D = #{delta}"
+  s = values.group_by { |v| (v - min) / delta }.values.map(&:count).sort.reverse
+  put "S = #{s}"
+  mu = s.inject(&:+) / s.count
   put "µ = #{mu}"
-  var = values.map { |v| (v - mu)**2 }.inject(&:+).to_f / values.count
+  var = s.map { |v| (v - mu)**2 }.inject(&:+).to_f / s.count
   put "Var(X) = #{var}"
   puts format('%.8f', var)
 rescue StandardError => ex

data/features/cli.feature

@@ -9,11 +9,15 @@ Feature: Command Line Processing
   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 .
+    if git config user.email; then
+      echo Git email already set
+    else
+      git config user.name "NoName"
+      git config user.email "noname@example.com"
+    fi
     touch test.txt
     git add test.txt
     git commit -am 'test'

data/theory.tex

@@ -43,34 +43,36 @@ 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:
+it is observed how many times every source code file out of $N$ was touched
+during the lifetime of the repository (excluding the files that don't exist
+in the repository anymore):
 
 \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:
+Then, the entire interval between $\check{T}$ (the maximum value)
+and $\hat{T}$ (the minimum value) is divided to $Z$ equivalent groups:
 
-\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}
+\begin{align}
+G &= [g_1, g_2, \dots, g_{Z}] \\
+\delta &= ( \check{T} - \hat{T} ) / Z \\
+g_j &= \sum_{i=1}^N [ j(\delta-1) < t_i < j\delta ]
+\end{align}
 
 Then, the mean $\mu$ is calculated as:
 
 \begin{eqnarray}
-\mu = \frac{1}{M}\sum{x_i}
+\mu = \frac{1}{Z}\sum_{j=1}^{Z}{g_j}
 \end{eqnarray}
 
 Finally, the variance is calculated as:
 
 \begin{eqnarray}
-Var(x) = \frac{1}{M}\sum{|x_i - \mu|^2}
+Var(g) = \frac{1}{Z}\sum_{j=1}^{Z}{|g_j - \mu|^2}
 \end{eqnarray}
 
-The variance $Var(x)$ is the volatility of the source code. The smaller
+The variance $Var(g)$ 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.
 

data/volatility.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '2.2'
   s.required_ruby_version = '>= 2.3'
   s.name = 'volatility'
-  s.version = '0.1.2'
+  s.version = '0.2.0'
   s.license = 'MIT'
   s.summary = 'Source Code Volatility'
   s.description = 'The command line tool calculates the SCV metric for a Git repo'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: volatility
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Yegor Bugayenko