diggit 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fa14be04009f4668ce08541bcc05aa050308de7
-  data.tar.gz: 2f956728d1a7d6e2ea999a0d2aa59d60ecbad58a
+  metadata.gz: 60e58099916b06eceaa99f9bad1f18822ac74106
+  data.tar.gz: 5568fc8c3a6bd36f09f25d7ceeb9233da126ffea
 SHA512:
-  metadata.gz: 53da80f0affd555bb133b5b36129772d1a915fb5d04661f1d5b7a7c94d00a1cf347d092d5775f05372bd7b434ee28a21e6b3c0822d4a84485e4d94c4e2c20d7c
-  data.tar.gz: 44488dca2f0ad7d39b788012e73c1ee17c608d958bde77be62cdb1cd6d20c5f84f11a6ac022e0e8663d0ad054a63f6bd89ce730e0a8d16d760ef477adbb82d90
+  metadata.gz: 84dd036f313699556b0fafc8604d56b45ceb7441dc7f4530061c98816973f6bb0c71406245b3569dcfa9cf244caab20d96702ba16e9f802dafce94994f6ea2e5
+  data.tar.gz: d82cc5a83c57e774af69f367df32dc695b72cb2807963e687502f3de309d7bf4ea784b4fa7bad6216484feab48e2c1e675f3120fefb99af444784e92c98217b3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog of Diggit
 
+### Version 2.1.1
+* Fixed small bugs in the CLI
+* Fixed source error not showing up in case of clone error
+* Now urls can have a trailing |id to enable checkout a tag, branch or commit with a specific id
+* Out addon have more utility methods
+
 ### Version 2.1.0
 * Now repositories are reseted to master by default
 * Journal infrastructure has been vastly improved

data/README.md

@@ -8,9 +8,20 @@ A ruby tool to analyze Git repositories
 
 Just run `gem install diggit`.
 
-## From the source
+## From the source, with bundler
 
-Clone diggit using the following command: `git clone https://github.com/jrfaller/diggit.git`. The `dgit` tool is in the `bin` folder.
+Install diggit using the following commands:
+```
+git clone https://github.com/jrfaller/diggit.git
+cd diggit
+gem install bundler --user-install
+bundler install
+```
+Beware, the gem bin directory must be in your path. Also, the `dgit` command is in the `bin` folder of diggit.
+
+## From the source, with vagrant
+
+You can automatically get a working VM with all required dependencies with only one command, how cool is that? For this, just install [vagrant](https://www.vagrantup.com/) and [virtualbox](https://www.virtualbox.org/), and `vagrant up` in a freshly cloned diggit folder (see previous section). Beware, this magic only works on Mac OS and Linux because it uses NFS shared folders.
 
 # Usage
 
@@ -26,15 +37,15 @@ You can add some repositories to be analyzed with the following command: `dgit s
 
 ### Using addons
 
-Addons add features the the diggit tool: for instance capability of writing to a MongoDB database, etc. To enable addons for your current diggit folder you can use the following command: `dgit addons add TestAddon`.
+Addons add features the the diggit tool: for instance capability of writing to a MongoDB database, etc. To enable addons for your current diggit folder you can use the following command: `dgit addons add test_addon`.
 
 ### Setting-up analyses
 
-An analysis is applied to each repository. You can configure the analyses to be performed with the following command: `dgit analyses add TestAnalysis`. Analyses are performed in the order they have been added.
+An analysis is applied to each repository. You can configure the analyses to be performed with the following command: `dgit analyses add test_analysis`. Analyses are performed in the order they have been added.
 
 ### Setting-up joins
 
-A join is performed after all analyses of all repositories have been performed. You can configure the joins to be performed with the following command: `dgit joins add TestJoin`. Joins are performed in the order they have been added.
+A join is performed after all analyses of all repositories have been performed. You can configure the joins to be performed with the following command: `dgit joins add test_join`. Joins are performed in the order they have been added.
 
 ## Running analyses
 

data/bin/dgit

@@ -49,8 +49,8 @@ module Diggit
 		c.action do |_global_options, _options, _args|
 			Log.info "Config"
 			Log.info "======"
-			Log.info "- Analyses: #{Diggit::Dig.it.config.get_analyses.join(', ')}"
-			Log.info "- Joins: #{Diggit::Dig.it.config.get_joins.join(', ')}"
+			Log.info "- Analyses: #{Diggit::Dig.it.config.get_analyses.map(&:name).join(', ')}"
+			Log.info "- Joins: #{Diggit::Dig.it.config.get_joins.map(&:name).join(', ')}"
 			Log.info ""
 			Log.info "Journal"
 			Log.info "======="
@@ -64,6 +64,20 @@ module Diggit
 				Log.ok "* Ok: #{Diggit::Dig.it.journal.sources_by_state(:cloned).size}"
 				Log.error "* Error: #{Diggit::Dig.it.journal.sources_by_state(:cloned, true).size}"
 			end
+			Log.info "- Performed joins:" unless Diggit::Dig.it.journal.workspace.performed.empty?
+			Diggit::Dig.it.journal.workspace.performed.each do |e|
+				Log.indent { Log.info "#{e.name}, time: #{e.duration}" }
+			end
+			Log.info "- Canceled joins:" unless Diggit::Dig.it.journal.workspace.canceled.empty?
+			Diggit::Dig.it.journal.workspace.canceled.each do |e|
+				Log.indent do
+					Log.info "#{e.name}, time: #{e.duration}"
+					Log.indent do
+						Log.error e.error.message
+						Log.error e.error.backtrace.join("\n")
+					end
+				end
+			end
 		end
 	end
 
@@ -74,7 +88,7 @@ module Diggit
 			list.action do |_global_options, _options, _args|
 				sources = Diggit::Dig.it.journal.sources
 				sources.each_index do |idx|
-					msg = "#{idx}	#{sources[idx].url} (#{sources[idx].state})"
+					msg = "#{idx}	#{sources[idx].url} (#{sources[idx].entry.state})"
 					sources[idx].entry.error? ? Log.error(msg) : Log.ok(msg)
 				end
 			end
@@ -86,11 +100,18 @@ module Diggit
 				Diggit::Dig.it.journal.add_source args[0]
 			end
 		end
+		c.desc 'Delete a source.'
+		c.arg_name 'id'
+		c.command :del do |del|
+			del.action do |_global_options, _options, args|
+				Diggit::Dig.it.journal.del_source args[0]
+			end
+		end
 		c.desc 'Import sources from a file.'
 		c.arg_name 'file'
 		c.command :import do |import|
 			import.action do |_global_options, _options, args|
-				File.open(args[0]).each { |line| Diggit::Dig.it.journal.add_source(line) }
+				File.open(args[0]).each { |line| Diggit::Dig.it.journal.add_source(line.strip) }
 			end
 		end
 		c.desc 'Display all sources in error.'
@@ -110,11 +131,13 @@ module Diggit
 				src = Diggit::Dig.it.journal.sources_by_ids(args[0].to_i)[0]
 				Log.info "URL: #{src.url}"
 				Log.info "State: #{src.entry.state}"
+				unless src.entry.error.nil?
+					Log.error src.entry.error.message
+					Log.error src.entry.error.backtrace.join("\n")
+				end
 				Log.info "Performed analyses:" unless src.entry.performed.empty?
 				src.entry.performed.each do |e|
-					Log.indent do
-						Log.info "#{e.name}, time: #{e.duration}"
-					end
+					Log.indent { Log.info "#{e.name}, time: #{e.duration}" }
 				end
 				Log.info "Canceled analyses:" unless src.entry.canceled.empty?
 				src.entry.canceled.each do |e|

data/lib/dgit/core.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # encoding: utf-8
 #
 # This file is part of Diggit.
@@ -28,8 +29,7 @@ class String
 	# Returns a underscore cased version of the string.
 	# @return [String]
 	def underscore
-		gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-				.gsub(/([a-z\d])([A-Z])/, '\1_\2'). tr("-", "_").downcase
+		gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').gsub(/([a-z\d])([A-Z])/, '\1_\2'). tr("-", "_").downcase
 	end
 
 	# Returns a camel cased version of the string.
@@ -57,10 +57,14 @@ end
 
 module Diggit
 	class Source
-		attr_reader :url, :repository, :entry
+		DEFAULT_BRANCH = "origin/master".freeze
+
+		attr_reader :url, :repository, :entry, :oid
 
 		def initialize(url)
-			@url = url
+			infos = url.split(/\|/)
+			@url = infos[0]
+			@oid = infos.size > 1 ? infos[1] : DEFAULT_BRANCH
 			@entry = SourceEntry.new
 			@repository = nil
 		end
@@ -75,21 +79,19 @@ module Diggit
 
 		def clone
 			@entry.error = nil
-			if File.exist?(folder)
-				Rugged::Repository.new(folder)
-			else
-				Rugged::Repository.clone_at(url, folder)
-			end
+			@repository = File.exist?(folder) ? Rugged::Repository.new(folder) : Rugged::Repository.clone_at(url, folder)
+			@repository.checkout(@oid, { strategy: :force })
 			@entry.state = :cloned
 		rescue => e
-			Log.error "Error cloning #{url}."
+			Log.error "Error cloning #{url}: #{e}"
+			e.backtrace.each { |l| Log.debug(l) }
 			@entry.error = e
 		end
 
 		def load_repository
-			fail "Source not cloned #{url}." if @entry.new?
+			raise "Source not cloned #{url}." if @entry.new?
 			@repository = Rugged::Repository.new(folder)
-			@repository.checkout("origin/master")
+			@repository.checkout(@oid, { strategy: :force })
 		end
 	end
 
@@ -114,7 +116,7 @@ module Diggit
 			source_array = sources
 			result = []
 			ids.each do |id|
-				fail "No such source index #{id}." if id >= source_array.length
+				raise "No such source index #{id}." if id >= source_array.length
 				result << source_array[id]
 			end
 			result
@@ -125,7 +127,14 @@ module Diggit
 		end
 
 		def add_source(url)
-			@sources[url] = Source.new(url) unless @sources.key?(url)
+			key = url.split(/\|/)[0]
+			@sources[key] = Source.new(url) unless @sources.key?(key)
+			Dig.it.save_journal
+		end
+
+		def del_source(id)
+			source = sources_by_ids(id).first
+			@sources.delete(source.url)
 			Dig.it.save_journal
 		end
 	end
@@ -207,7 +216,7 @@ module Diggit
 	class PluginLoader
 		include Singleton
 
-		PLUGINS_TYPES = [:addon, :analysis, :join]
+		PLUGINS_TYPES = [:addon, :analysis, :join].freeze
 
 		# Load the plugin with the given name and type.
 		# @param name [String] the name of the plugin
@@ -216,15 +225,9 @@ module Diggit
 		# @return [Plugin, Class] the instance or class of the plugin.
 		def load_plugin(name, type, instance = false)
 			plugin = search_plugin(name, type)
-			if plugin
-				if instance
-					return plugin.new(Dig.it.options)
-				else
-					return plugin
-				end
-			else
-				fail "Plugin #{name} not found."
-			end
+			raise "Plugin #{name} not found." unless plugin
+			return plugin.new(Dig.it.options) if instance
+			plugin
 		end
 
 		def self.plugin_paths(name, type, root)
@@ -241,13 +244,13 @@ module Diggit
 
 		def search_plugin(name, type)
 			return @plugins[name] if @plugins.key?(name)
-			fail "Unknown plugin type #{type}." unless PLUGINS_TYPES.include?(type)
-			fail "File #{name}.rb in #{type} directories not found." unless load_file(name, type)
+			raise "Unknown plugin type #{type}." unless PLUGINS_TYPES.include?(type)
+			raise "File #{name}.rb in #{type} directories not found." unless load_file(name, type)
 
 			base_class = Object.const_get("Diggit::#{type.to_s.camel_case}")
 			plugins = ObjectSpace.each_object(Class).select { |c| c < base_class && c.simple_name == name }
 
-			fail "No plugin #{name} of kind #{type} found." if plugins.empty?
+			raise "No plugin #{name} of kind #{type} found." if plugins.empty?
 			warn "Ambiguous plugin name: several plugins of kind #{type} named #{name} were found." if plugins.size > 1
 
 			@plugins[name] = plugins[0]
@@ -291,11 +294,11 @@ module Diggit
 	# @!attribute [r] plugin_loader
 	# 	@return [PluginLoader] utility classes to load plugins.
 	class Dig
-		DGIT_FOLDER = ".dgit"
-		DGIT_SOURCES = "sources"
-		DGIT_CONFIG = "config"
-		DGIT_OPTIONS = "options"
-		DGIT_JOURNAL = "journal"
+		DGIT_FOLDER = ".dgit".freeze
+		DGIT_SOURCES = "sources".freeze
+		DGIT_CONFIG = "config".freeze
+		DGIT_OPTIONS = "options".freeze
+		DGIT_JOURNAL = "journal".freeze
 
 		private_constant :DGIT_SOURCES, :DGIT_CONFIG, :DGIT_OPTIONS, :DGIT_JOURNAL
 
@@ -306,7 +309,7 @@ module Diggit
 		# Returns the diggit instance.
 		# @return [Dig] the instance.
 		def self.it
-			fail "Diggit has not been initialized." if @diggit.nil?
+			raise "Diggit has not been initialized." if @diggit.nil?
 			@diggit
 		end
 
@@ -338,12 +341,11 @@ module Diggit
 				Oj.to_file(File.expand_path(DGIT_JOURNAL, dgit_folder), Journal.new)
 			end
 			FileUtils.mkdir(File.expand_path('sources', folder)) unless File.exist?(File.expand_path('sources', folder))
-			unless File.exist?(File.expand_path("plugins", folder))
-				FileUtils.mkdir_p(File.expand_path("plugins", folder))
-				FileUtils.mkdir_p(File.expand_path("plugins/analysis", folder))
-				FileUtils.mkdir_p(File.expand_path("plugins/addon", folder))
-				FileUtils.mkdir_p(File.expand_path("plugins/join", folder))
-			end
+			return if File.exist?(File.expand_path("plugins", folder))
+			FileUtils.mkdir_p(File.expand_path("plugins", folder))
+			FileUtils.mkdir_p(File.expand_path("plugins/analysis", folder))
+			FileUtils.mkdir_p(File.expand_path("plugins/addon", folder))
+			FileUtils.mkdir_p(File.expand_path("plugins/join", folder))
 		end
 
 		# Return the path of the given config file
@@ -364,7 +366,7 @@ module Diggit
 		# Use {.init} and {.it} instead.
 		# @return [Dig] a diggit object.
 		def initialize(folder)
-			fail "Folder #{folder} is not a diggit folder." unless File.exist?(File.expand_path(DGIT_FOLDER, folder))
+			raise "Folder #{folder} is not a diggit folder." unless File.exist?(File.expand_path(DGIT_FOLDER, folder))
 			@plugin_loader = PluginLoader.instance
 			@folder = folder
 		end
@@ -474,7 +476,8 @@ module Diggit
 				entry.toc
 				entry.error = e
 				placeholder.canceled << entry
-				Log.error "Error cleaning #{runnable.name}"
+				Log.error "Error cleaning #{runnable.name}: #{e}"
+				e.backtrace.each { |l| Log.debug(l) }
 			ensure
 				save_journal
 			end
@@ -488,7 +491,8 @@ module Diggit
 				entry.toc
 				entry.error = e
 				placeholder.canceled << entry
-				Log.error "Error running #{runnable.name}"
+				Log.error "Error running #{runnable.name}: #{e}"
+				e.backtrace.each { |l| Log.debug(l) }
 			else
 				entry.toc
 				placeholder.performed << entry

data/lib/dgit/entries.rb

@@ -29,11 +29,7 @@ module Diggit
 		# @param e [Exception, nil] the error, to indicate an absence of error, pass +nil+.
 		# @return [void]
 		def error=(e)
-			if e.nil?
-				@error = nil
-			else
-				@error = ErrorEntry.new(e)
-			end
+			@error = e.nil? ? nil : ErrorEntry.new(e)
 		end
 	end
 
@@ -54,7 +50,7 @@ module Diggit
 		# Error status of the element.
 		# @return [Boolean]
 		def error?
-			@canceled.size > 0
+			!@canceled.empty?
 		end
 
 		# Check if a runnable has been performed or canceled.
@@ -63,13 +59,9 @@ module Diggit
 		# @return [Boolean]
 		def has?(runnable_or_string, state = :all)
 			name = retrieve_name(runnable_or_string)
-			if state == :performed
-				return @performed.count { |e| e.name == name } > 0
-			elsif state == :canceled
-				return @canceled.count { |e| e.name == name } > 0
-			elsif state == :all
-				return (@performed + @canceled).count { |e| e.name == name } > 0
-			end
+			return @performed.count { |e| e.name == name } > 0 if state == :performed
+			return @canceled.count { |e| e.name == name } > 0 if state == :canceled
+			return (@performed + @canceled).count { |e| e.name == name } > 0 if state == :all
 		end
 
 		# Remove a runnable from all the entries.
@@ -84,11 +76,8 @@ module Diggit
 			private
 
 		def retrieve_name(runnable_or_string)
-			if runnable_or_string.is_a? String
-				return runnable_or_string
-			else
-				return runnable_or_string.name
-			end
+			return runnable_or_string if runnable_or_string.is_a? String
+			runnable_or_string.name
 		end
 	end
 

data/lib/dgit/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # encoding: utf-8
 #
 # This file is part of Diggit.
@@ -18,5 +19,5 @@
 # Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
 
 module Diggit
-	VERSION = '2.1.0'
+	VERSION = '2.1.1'.freeze
 end

data/plugins/addon/db.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # encoding: utf-8
 #
 # This file is part of Diggit.
@@ -25,8 +26,8 @@ require 'mongo'
 # @!attribute [r] db
 # 	@return [Mongo::DB] the mongo database object.
 class Db < Diggit::Addon
-	DEFAULT_SERVER = '127.0.0.1:27017'
-	DEFAULT_DB = 'diggit'
+	DEFAULT_SERVER = '127.0.0.1:27017'.freeze
+	DEFAULT_DB = 'diggit'.freeze
 
 	attr_reader :client
 

data/plugins/addon/out.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # encoding: utf-8
 #
 # This file is part of Diggit.
@@ -17,7 +18,7 @@
 #
 # Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
 
-# A output addon for Diggit. The name of the addon is :output, and can be reached in the
+# An output addon for Diggit. The name of the addon is :output, and can be reached in the
 # addons hash. This addon might use an :output hash in the global options. In this hash, the
 # :out key allows to configure the name of the output folder and :tmp the name of the temporary output
 # folder.
@@ -28,8 +29,8 @@
 class Out < Diggit::Addon
 	attr_reader :out, :tmp
 
-	DEFAULT_OUT = 'out'
-	DEFAULT_TMP = 'tmp'
+	DEFAULT_OUT = 'out'.freeze
+	DEFAULT_TMP = 'tmp'.freeze
 
 	def initialize(*args)
 		super
@@ -45,4 +46,25 @@ class Out < Diggit::Addon
 		FileUtils.mkdir_p(@out) unless File.exist?(@out)
 		FileUtils.mkdir_p(@tmp) unless File.exist?(@tmp)
 	end
+
+	# Get an output path for a file/directory.
+	# @param paths [Array<String>] the different folders of the path.
+	# @return [String] the absolute path.
+	def out_path(*paths)
+		File.join(@out, *paths)
+	end
+
+	# Get a temporary path for a file/directory.
+	# @param paths [Array<String>] the different folders of the path.
+	# @return [String] the absolute path.
+	def tmp_path(*paths)
+		File.join(@tmp, *paths)
+	end
+
+	# Clean the output and temporary folders.
+	# @return [void]
+	def clean
+		FileUtils.rm_rf(@out)
+		FileUtils.rm_rf(@tmp)
+	end
 end