git-heatmap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e448107c9a8fa78501a4777c7ede303263328c407f87756720c6413f1ed5f337
+  data.tar.gz: c159c572f28d1690465974d6a2cac16f5a87067f16d9357e001887217a763a8e
+SHA512:
+  metadata.gz: 850b32bba0b3a514945cbfed0bb3376432087f7d0d6a452235665b7c552a74755ef389ab6ffeedec23bb1f382d73c7f7e107a6d8d81a1edd098157d667c90849
+  data.tar.gz: 509bdb4755f34586cb3c0224e077bcff734e46f500f3da37f1ea6e1f27f53ecb7aa2167cc5344909899084a9ae03fa07dd2c945c02ba3527f16b78b90c896774

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in git-heatmap.gemspec
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# Git::Heatmap
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/git/heatmap`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'git-heatmap'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git-heatmap
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/git-heatmap.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/git-heatmap

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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_relative '../lib/git/heatmap'
+
+begin
+	Git::Heatmap::Command.call
+rescue Interrupt
+end

data/git-heatmap.gemspec

@@ -0,0 +1,29 @@
+require_relative "lib/git/heatmap/version"
+
+Gem::Specification.new do |spec|
+	spec.name          = "git-heatmap"
+	spec.version       = Git::Heatmap::VERSION
+	spec.authors       = ["Samuel Williams"]
+	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	
+	spec.summary       = "Generate heatmap style visualisations based on git history."
+	spec.homepage      = "https://github.com/ioquatix/git-heatmap"
+	
+	# Specify which files should be added to the gem when it is released.
+	# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+	spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+		`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	end
+	
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.require_paths = ["lib"]
+	
+	spec.add_dependency "console"
+	spec.add_dependency "rugged"
+	spec.add_dependency "trenni"
+	spec.add_dependency "samovar", "~> 2.0"
+	
+	spec.add_development_dependency "bundler"
+	spec.add_development_dependency "rake", "~> 10.0"
+	spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/git/heatmap.rb

@@ -0,0 +1,22 @@
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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_relative "heatmap/version"
+require_relative "heatmap/command"

data/lib/git/heatmap/command.rb

@@ -0,0 +1,73 @@
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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_relative 'command/generate'
+
+require_relative 'version'
+
+require 'samovar'
+require 'console'
+
+module Git
+	module Heatmap
+		module Command
+			def self.call(*args)
+				Top.call(*args)
+			end
+			
+			class Top < Samovar::Command
+				self.description = "A git visualisation generator."
+				
+				options do
+					option '--verbose | --quiet', "Verbosity of output for debugging.", key: :logging
+					option '-v/--version', "Print out the application version."
+				end
+				
+				nested :command, {
+					'generate' => Generate,
+				}, default: 'generate'
+				
+				def verbose?
+					@options[:logging] == :verbose
+				end
+				
+				def quiet?
+					@options[:logging] == :quiet
+				end
+				
+				def call
+					if verbose?
+						Console.logger.debug!
+					elsif quiet?
+						Console.logger.warn!
+					else
+						Console.logger.info!
+					end
+					
+					if @options[:version]
+						puts "#{self.name} v#{VERSION}"
+					else
+						@command.call
+					end
+				end
+			end
+		end
+	end
+end

data/lib/git/heatmap/command/generate.rb

@@ -0,0 +1,88 @@
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 'samovar'
+require 'rugged'
+
+require_relative '../period'
+require_relative '../templates/series'
+
+require 'irb'
+
+module Git
+	module Heatmap
+		module Command
+			class Generate < Samovar::Command
+				self.description = "Generate the visualisation."
+				
+				PERIODS = {
+					"hourly" => Hourly,
+					"daily" => Daily,
+					"weekly" => Weekly,
+					"monthly" => Monthly,
+					"quarterly" => Quarterly,
+					"yearly" => Yearly
+				}
+				
+				options do
+					option "--template <path>", "The template file to use.", default: "series"
+					option "--period <name>", "The period to use, one of: #{PERIODS.keys.join(', ')}.", default: "daily"
+					option "--depth <integer>", "Specify the depth of aggregation (depth of top level directories).", type: Integer, default: 2
+					
+					option "--output <path>", "The output path to use."
+				end
+				
+				many :paths, "One or more repositories to visualise."
+				
+				def period
+					PERIODS[@options[:period]].new
+				end
+				
+				def title
+					@paths.map do |path|
+						File.basename(File.expand_path(path))
+					end.join(', ')
+				end
+				
+				def output_path
+					@options.fetch(:output) do
+						"#{title} #{@options[:period]}.html"
+					end
+				end
+				
+				def template(commits)
+					Templates::Series.new(commits, title: self.title)
+				end
+				
+				def call
+					commits = Commits.new(filter: self.period, depth: @options[:depth])
+					
+					@paths.each do |path|
+						repository = Rugged::Repository.discover(path)
+						
+						commits.add(repository)
+					end
+					
+					File.write(output_path, template(commits).call)
+				end
+			end
+		end
+	end
+end

data/lib/git/heatmap/commits.rb

@@ -0,0 +1,159 @@
+# Copyright, 2019, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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 'set'
+
+module Git
+	module Heatmap
+		class Aggregate
+			def initialize(filter)
+				@filter = filter
+				
+				@commits = {}
+				
+				@periods = {}
+				@earliest_commit_at = nil
+				@latest_commit_at = nil
+				
+				@maximum = 0
+			end
+			
+			attr :commits
+			attr :periods
+			
+			attr :earliest_commit_at
+			attr :latest_commit_at
+			
+			def size
+				@commits.size
+			end
+			
+			attr :maximum
+			
+			def << commit
+				return if @commits.include?(commit.oid)
+				
+				@commits[commit.oid] = commit
+				
+				author = commit.author
+				time = author[:time]
+				key = @filter.key(time)
+				commits = (@periods[key] ||= [])
+				commits << commit
+				
+				if commits.size > @maximum
+					@maximum = commits.size
+				end
+				
+				if @earliest_commit_at.nil? or time < @earliest_commit_at
+					@earliest_commit_at = time
+				end
+				
+				if @latest_commit_at.nil? or time > @latest_commit_at
+					@latest_commit_at = time
+				end
+			end
+		end
+		
+		class Commits
+			def initialize(filter: Weekly.new, depth: 4)
+				@filter = filter
+				
+				@authors = Set.new
+				@directories = Hash.new{|h,k| h[k] = Aggregate.new(filter)}
+				
+				@depth = depth
+				
+				@earliest_commit_at = nil
+				@latest_commit_at = nil
+				
+				@maximum = nil
+			end
+			
+			attr :filter
+			
+			attr :earliest_commit_at
+			attr :latest_commit_at
+			
+			def each_period(&block)
+				@filter.between(@earliest_commit_at, @latest_commit_at, &block)
+			end
+			
+			def maximum
+				@maximum ||= @directories.each_value.max_by(&:maximum).maximum
+			end
+			
+			attr :authors
+			attr :directories
+			
+			def each_directory
+				@directories.keys.sort.each do |key|
+					yield key, @directories[key]
+				end
+			end
+			
+			def << commit
+				@maximum = nil
+				
+				if parent = commit.parents.first
+					# Documentation seems to imply this shouldn't be needed.
+					diff = commit.diff(commit.parents.first.tree)
+				else
+					diff = commit.diff
+				end
+				
+				author = commit.author
+				time = author[:time]
+				@authors << author[:name]
+				
+				if @earliest_commit_at.nil? or time < @earliest_commit_at
+					@earliest_commit_at = time
+				end
+				
+				if @latest_commit_at.nil? or time > @latest_commit_at
+					@latest_commit_at = time
+				end
+				
+				diff.each_patch do |patch|
+					delta = patch.delta
+					path = delta.new_file[:path]
+					
+					parts = path.split(File::SEPARATOR)
+					parts.unshift(File.basename(commit.tree.repo.workdir))
+					parts.pop # Remove file name
+					root = parts[0...@depth]
+					
+					@directories[root] << commit
+				end
+			end
+			
+			def add(repository)
+				walker = Rugged::Walker.new(repository)
+				
+				walker.sorting(Rugged::SORT_DATE)
+				walker.push(repository.head.target.oid)
+				
+				walker.each do |commit|
+					self << commit
+				end
+			end
+		end
+	end
+end