git_survey 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9027ae943fb7beb7a9032eaa5c83e2398de62c33
+  data.tar.gz: e80051924dbca0d3f09b6e84bc39fd300517d9c3
+SHA512:
+  metadata.gz: 6e2ba6525da6fdd24d8792dad2ed375ad10a1c7405a22212a03c02c7def9b40bdb9088550f283c31d7d2f6e1550b711e513c0dbef0395937b6c3661bde11e244
+  data.tar.gz: ef3d4018695e307988fc3b768cf29a4cf9ae62d6c76a5e5f00d0687e5723381086d9acc4b676e3cbfcdadf003805ad4ad8f3d3e81344e8143d4a60aab1981387

data/bin/git-survey

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'git_survey'
+
+::GitSurvey.main(ARGV)

data/lib/git_survey.rb

@@ -0,0 +1,57 @@
+require 'time'
+require 'json'
+require 'digest'
+
+require 'git_survey/version'
+require 'git_survey/arguments_parser.rb'
+require 'git_survey/shell_adapter.rb'
+
+EXECUTABLE_NAME = 'git-survey'.freeze
+
+# Generates a report on a git project's history
+module GitSurvey
+  def self.executable_hash(options)
+    {
+      'date' => options.scan_date,
+      'anonymized' => options.anonymize,
+      'branch' => options.git_branch,
+      'hotFiles' => options.number_of_hotfiles
+    }
+  end
+  private_class_method :executable_hash
+
+  def self.repo_hash(options)
+    {
+      'name' => ShellAdapter.repo_name(options.anonymize, options.input_directory),
+      'dateOfInit' => ShellAdapter.init_date(options.input_directory),
+      'dateOfLastCommit' => ShellAdapter.latest_activity_date(options.input_directory),
+      'yearsWorkedOn' => ShellAdapter.activity_interval(options.input_directory),
+      'numberOfFiles' => ShellAdapter.number_of_files(options.input_directory),
+      'numberOfCommits' => ShellAdapter.number_of_commits(options.input_directory,
+                                                          options.git_branch),
+      'numberOfBranches' => ShellAdapter.number_of_branches(options.input_directory)
+    }
+  end
+  private_class_method :repo_hash
+
+  def self.main(_argv)
+    options = Parser.parse(ARGV)
+
+    # Google JSON Style Guide (camel case for keys)
+    # https://google.github.io/styleguide/jsoncstyleguide.xml
+
+    result = {
+      EXECUTABLE_NAME => executable_hash(options),
+      'repo' => repo_hash(options),
+      'hotFiles' => ShellAdapter.hot_files(options.anonymize,
+                                           options.input_directory,
+                                           options.number_of_hotfiles),
+      'authors' => ShellAdapter.authors(options.anonymize,
+                                        options.input_directory)
+    }
+
+    puts JSON.pretty_generate(result)
+
+    exit 0
+  end
+end

data/lib/git_survey/arguments_parser.rb

@@ -0,0 +1,81 @@
+require 'optparse'
+
+# https://docs.ruby-lang.org/en/2.1.0/OptionParser.html
+Options = Struct.new(:anonymize,
+                     :git_branch,
+                     :input_directory,
+                     :number_of_hotfiles,
+                     :scan_date)
+
+# Parses command line arguments
+class Parser
+  def self.default_options
+    result = Options.new
+    result.anonymize = false
+    result.git_branch = 'master'
+    result.number_of_hotfiles = 10
+    result.scan_date = Time.now.iso8601(3)
+    result.input_directory = '.'
+    result
+  end
+  private_class_method :default_options
+
+  def self.parse(argv)
+    # If no arguments supplied, print help
+    argv << '-h' if argv.empty?
+
+    result = default_options
+
+    options_parser = OptionParser.new do |o|
+      o.banner = 'Usage: git-survey.rb [options] [input directory]'
+
+      o.on('-a',
+           '--anonymize',
+           "Anonymizes the output (#{result.anonymize})") do |v|
+        result.anonymize = v
+      end
+
+      o.on('-bBRANCH',
+           '--branch=BRANCH',
+           "Git branch (#{result.git_branch})") do |v|
+        result.git_branch = v
+      end
+
+      o.on('-nNUMBER',
+           '--number=NUMBER',
+           "Number of hot files to display (#{result.number_of_hotfiles})") do |v|
+        result.number_of_hotfiles = v
+      end
+
+      o.on('-tTODAY',
+           '--today=TODAY',
+           "Today's date for testing purposes (string)") do |v|
+        result.scan_date = v
+      end
+
+      o.on('-h',
+           '--help',
+           'Prints this help') do
+        puts options_parser
+        exit 0
+      end
+    end
+
+    begin
+      options_parser.parse!(argv)
+    rescue StandardError => exception
+      puts exception
+      puts options_parser
+      exit 1
+    end
+
+    result.input_directory = argv.pop
+    if result.input_directory.nil? || !Dir.exist?(result.input_directory)
+      puts 'Can\'t find directory ' + result.input_directory
+      Parser.parse %w[--help]
+      exit 0
+    end
+
+    result
+  end
+end

data/lib/git_survey/helpers.rb

@@ -0,0 +1,10 @@
+# Convenience utilities.
+class Helpers
+  def self.anonymized(anonymize, string)
+    if anonymize
+      Digest::MD5.hexdigest(string)[0...10]
+    else
+      string
+    end
+  end
+end

data/lib/git_survey/shell_adapter.rb

@@ -0,0 +1,101 @@
+require_relative 'helpers'
+
+COMMAND_REPO_NAME = 'basename `git rev-parse --show-toplevel`'.freeze
+COMMAND_REPO_INIT_DATE = 'git log --date=iso8601-strict --reverse |head -3 ' +
+                         '|grep "Date"'.freeze
+COMMAND_LATEST_ACTIVITY_DATE = 'git log --date=iso8601-strict |head -3 ' +
+                               '|grep "Date"'.freeze
+COMMAND_COMMITS_NUMBER = 'git rev-list --count '.freeze
+COMMAND_FILES_NUMBER = 'git ls-files | wc -l'.freeze
+COMMAND_BRANCHES_NUMBER = 'git branch | wc -l'.freeze
+COMMAND_AUTHORS = 'git shortlog -s -n'.freeze
+COMMAND_FILES_HOT = 'git log --pretty=format: --name-only | sort | uniq -c | ' +
+                    'sort -rg | head -'.freeze
+
+# Adapter which handles shell access.
+class ShellAdapter
+  def self.run_shell_command(directory, cmd)
+    result = `cd #{directory}; #{cmd}`
+    result
+  end
+  private_class_method :run_shell_command
+
+  def self.date_at_the_end_of_line(string)
+    string.split(' ').last
+  end
+  private_class_method :date_at_the_end_of_line
+
+  def self.hash_from_line_with_delimiter(anonymized,
+                                         directory,
+                                         command,
+                                         delimiter)
+
+    list = run_shell_command(directory, command)
+           .split("\n")
+    empty = 'empty' # git outputs empty lines too, they should be removed.
+
+    result = {}
+    list.each do |line|
+      parts = line.split(delimiter)
+      value = parts.first
+      key = parts.last == value ? empty : Helpers.anonymized(anonymized, parts.last)
+
+      result[key] = value.to_i
+    end
+    result.reject { |key, _value| key.to_s.match(empty) }
+  end
+  private_class_method :hash_from_line_with_delimiter
+
+  # basename `git rev-parse --show-toplevel`
+  def self.repo_name(anonimize, directory)
+    name = run_shell_command(directory, COMMAND_REPO_NAME).strip
+    Helpers.anonymized(anonimize, name)
+  end
+
+  # git log --date=iso8601-strict --reverse |head -3 |grep "Date"
+  def self.init_date(directory)
+    string = run_shell_command(directory, COMMAND_REPO_INIT_DATE)
+    Time.iso8601(date_at_the_end_of_line(string))
+  end
+
+  # git log --date=iso8601-strict |head -3 |grep "Date"
+  def self.latest_activity_date(directory)
+    string = run_shell_command(directory, COMMAND_LATEST_ACTIVITY_DATE)
+    Time.iso8601(date_at_the_end_of_line(string))
+  end
+
+  def self.activity_interval(directory)
+    earliest = init_date(directory).to_f
+    latest = latest_activity_date(directory).to_f
+
+    diff = latest - earliest
+    (diff / (365 * 24 * 60 * 60)).round(2)
+  end
+
+  # git rev-list --count <revision>
+  def self.number_of_commits(directory, branch)
+    run_shell_command(directory, COMMAND_COMMITS_NUMBER + branch).to_i
+  end
+
+  #  git ls-files | wc -l
+  def self.number_of_files(directory)
+    run_shell_command(directory, COMMAND_FILES_NUMBER).to_i
+  end
+
+  # git branch | wc -l
+  def self.number_of_branches(directory)
+    run_shell_command(directory, COMMAND_BRANCHES_NUMBER).to_i
+  end
+
+  # git shortlog -s -n
+  def self.authors(anonymized, directory)
+    hash_from_line_with_delimiter(anonymized, directory, COMMAND_AUTHORS, "\t")
+  end
+
+  # git log --pretty=format: --name-only | sort | uniq -c | sort -rg | head -10
+  def self.hot_files(anonymized, directory, number)
+    number_with_empty_lines = number.to_i + 1
+    command = COMMAND_FILES_HOT + number_with_empty_lines.to_s
+    hash_from_line_with_delimiter(anonymized, directory, command, ' ')
+  end
+end

data/lib/git_survey/version.rb

@@ -0,0 +1,3 @@
+module GitSurvey
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: git_survey
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrei Nagy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Analyzes the git history and outputs to console.
+email:
+- nagy.andrei@gmail.com
+executables:
+- git-survey
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/git-survey
+- lib/git_survey.rb
+- lib/git_survey/arguments_parser.rb
+- lib/git_survey/helpers.rb
+- lib/git_survey/shell_adapter.rb
+- lib/git_survey/version.rb
+homepage: https://github.com/andreinagy/git-survey
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.3
+signing_key: 
+specification_version: 4
+summary: Script that displays a project's git history.
+test_files: []