diggit 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5e2ef36de4b3c3a37f0bf01be4b1d5b8d48b71e6
-  data.tar.gz: 188b76a064ca36ba8e63eee8480776e73afb8ed8
+SHA256:
+  metadata.gz: 923c33e8ad605d0ce6a4213cc65b733d39e5a022bc316ce5274a5cead3a793a1
+  data.tar.gz: 835b774912312f59d93049e237259b73d51a022bd8ec2268be9c0391986e215f
 SHA512:
-  metadata.gz: 49ed2415530c6fc23cd824db22fc2b869384e55de0ffe59494a9413aafb0a7e3524db9a4a923b704babbb41773e050755a5cfafe90cb64adc69efd3b78a91b96
-  data.tar.gz: 96d9503d93ab9f90d6069673e9e3ca0d410b9705b9c9fd860a45e22fb028ac2757aa88d3734f8bec3c6fc718d0468057aa8e3773d1ac8036469ccdaaa2bf445e
+  metadata.gz: 90e82684cdea177aab66ba4a32d31a82a25a00dd358840b1139572bb5da9d9857957f10331d4ffb5cc7e96b28d96d064a8558bfe7734dd25aee470111ca0774c
+  data.tar.gz: 5bb52f527c746f2666f272460a80ade1e5f4558e3cabdab27c824c131200a200b31907b688fa275fb2e753ad4e67730b5f930d8e28c33a9748048e7254204fab

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog of Diggit
 
+### Version 3.0.1
+* Verbose option now used
+* Improved gemspec
+* Use new OJ upstream
+* Improve help messages
+
+### Version 3.0.0 (Cod)
+* Compatible with new Oj version
+* Cleaner docker image
+* Updated conflict_merge analysis
+* Fix dependencies vulnerabilities
+
 ### Version 2.1.2
 * Improve documentation
 * Fix bug of `sources del`

data/README.md

@@ -1,18 +1,23 @@
-# Diggit [![Build Status](https://travis-ci.org/jrfaller/diggit.svg?branch=master)](https://travis-ci.org/jrfaller/diggit) [![Coverage Status](https://coveralls.io/repos/jrfaller/diggit/badge.svg?branch=master)](https://coveralls.io/r/jrfaller/diggit?branch=master) [![Inline docs](http://inch-ci.org/github/jrfaller/diggit.svg?branch=master)](http://inch-ci.org/github/jrfaller/diggit) [![Dependency Status](https://gemnasium.com/jrfaller/diggit.svg)](https://gemnasium.com/jrfaller/diggit)
+# Diggit
 
-A ruby tool to analyze Git repositories
+An agile tool to analyze Git repositories
 
-# Installation
+## State
 
-## Prerequisites
+* Develop branch: [![Build Status](https://travis-ci.org/jrfaller/diggit.svg?branch=develop)](https://travis-ci.org/jrfaller/diggit) [![Coverage Status](https://coveralls.io/repos/jrfaller/diggit/badge.svg?branch=develop)](https://coveralls.io/r/jrfaller/diggit?branch=develop) [![Inline docs](http://inch-ci.org/github/jrfaller/diggit.svg?branch=develop)](http://inch-ci.org/github/jrfaller/diggit)
+* Master branch: [![Build Status](https://travis-ci.org/jrfaller/diggit.svg?branch=master)](https://travis-ci.org/jrfaller/diggit) [![Coverage Status](https://coveralls.io/repos/jrfaller/diggit/badge.svg?branch=master)](https://coveralls.io/r/jrfaller/diggit?branch=develop) [![Inline docs](http://inch-ci.org/github/jrfaller/diggit.svg?branch=master)](http://inch-ci.org/github/jrfaller/diggit)
+
+## Installation
+
+### Prerequisites
 
 In order for Ruby's libgit binding, [rugged](Pre-requisites), to work, you need to install several native libraries. To build the libgit version shipped with rugged's gem, you need `pkg-config` and `cmake` installed. If you want rugged to be able to clone ssh or https repositories, you need several additional depenc as listed on [libgit website](https://github.com/libgit2/libgit2#optional-dependencies).
 
-## From a gem
+### From a gem
 
 Just run `gem install diggit`.
 
-## From the sources, with bundler
+### From the sources, with bundler
 
 Install diggit using the following commands:
 ```
@@ -23,35 +28,35 @@ 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 sources, with vagrant
+### From the sources, 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. Note that if you use this method, you don't care about the prerequisites.
 
-# Usage
+## Usage
 
 Don't forget that dgit binary has an associated help that can be consulted using `dgit help`. Additionally, if you have installed Diggit from the sources, you can generate the documentation by running `yard doc` in the cloned folder.
 
-## Configuration
+### Configuration
 
 The diggit tool is designed to help you analyze software repositories. Firstly you have to create a new folder in which you launch the `dgit init` command. This way, the folder becomes a diggit folder in which you can configure repositories and analyses.
 
-### Setting-up the repositories
+#### Setting-up the repositories
 
 You can add some repositories to be analyzed with the following command: `dgit sources add https://github.com/jrfaller/diggit.git`.
 
-### Setting-up analyses
+#### 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 test_analysis`. Analyses are performed in the order they have been added. Analyses are provided in the `plugins/analysis` folder (from the diggit installation or in any initialized diggit folder). The filename of an analysis is the underscore cased name of the class where it is defined (which is camel cased). Analyses classes must extend the `Diggit::Analysis` class.
 
-### Setting-up joins
+#### 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 test_join`. Joins are performed in the order they have been added. Similarly to analyses, joins are provided in the `plugins/join` folder (from the diggit installation or in any initialized diggit folder). The filename of a join is the underscore cased name of the class where it is defined (which is camel cased). Joins must provide constraints on the analyses that must have been performed on the sources by using `require_analyses` in the class defining the join. For instance, to require the `test_analysis` analysisn, you need to use the statement `require_analyses test_analysis`. Joins classes must extend the `Diggit::Join` class.
 
-### Using addons
+#### Using addons
 
 Addons add features to analyses or joins: for instance the capability of writing to a MongoDB database, etc. To enable addons for an analysis or a join you need to use `require_addons` in an analysis or join class. For instance, to use the filesytem addon you need the following statement: `require_addons out`
 
-## Cloning, analysing and joining
+### Cloning, analysing and joining
 
 Once diggit is configured you can perform the analyses. First, you have to clone the repositories by using `dgit clones perform`. Then you can launch the analyses by using `dgit analyses perform`. Finally, the joins are executed via the command `dgit joins perform`. You can use the `mode` option to handle the cleaning of joins or analyses (e.g. `dgit analyses perform -m rerun`).
 

data/bin/dgit

@@ -24,7 +24,7 @@ module Diggit
 	include GLI::App
 
 	extend self
-	program_desc 'A git repository analysis tool.'
+	program_desc 'The agile git repository analysis tool.'
 
 	switch %i[v verbose], default_value: false, negatable: false, desc: "Indicates if the debug information are visible."
 	flag %i[f folder], default_value: ".", desc: "Path to the diggit folder. Default: current folder."
@@ -92,22 +92,23 @@ module Diggit
 				end
 			end
 		end
+		c.desc 'The source URL.'
+		c.arg_name '<url>'
 		c.desc 'Add a source.'
-		c.arg_name 'url'
 		c.command :add do |add|
 			add.action do |_global_options, _options, args|
 				Diggit::Dig.it.journal.add_source args[0]
 			end
 		end
 		c.desc 'Delete a source.'
-		c.arg_name 'id'
+		c.arg_name '<id>'
 		c.command :del do |del|
 			del.action do |_global_options, _options, args|
 				Diggit::Dig.it.journal.del_source args[0].to_i
 			end
 		end
 		c.desc 'Import sources from a file.'
-		c.arg_name '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.strip) }
@@ -124,7 +125,7 @@ module Diggit
 			end
 		end
 		c.desc 'Display information on a source'
-		c.arg_name 'id'
+		c.arg_name '<id>'
 		c.command :info do |info|
 			info.action do |_global_options, _options, args|
 				src = Diggit::Dig.it.journal.sources_by_ids(args[0].to_i)[0]
@@ -162,14 +163,14 @@ module Diggit
 			end
 		end
 		c.desc 'Add a join.'
-		c.arg_name 'name'
+		c.arg_name '<name>'
 		c.command :add do |add|
 			add.action do |_global_options, _options, args|
 				Diggit::Dig.it.config.add_join args[0]
 			end
 		end
 		c.desc 'Delete a join.'
-		c.arg_name 'name'
+		c.arg_name '<name>'
 		c.command :del do |del|
 			del.action do |_global_options, _options, args|
 				Diggit::Dig.it.config.del_join args[0]
@@ -177,9 +178,9 @@ module Diggit
 		end
 		c.desc 'Perform joins.'
 		c.command :perform do |perform|
-			perform.flag %i[s sources], desc: "list of sources", type: Array, default_value: []
+			perform.flag %i[s sources], desc: "list of sources id", type: Array, default_value: []
 			perform.flag %i[a analyses], desc: "list of analyses", type: Array, default_value: []
-			perform.flag %i[m mode], desc: "running mode",
+			perform.flag %i[m mode], desc: "running mode: run, clean or rerun",
 			must_match: { "run" => :run, "clean" => :clean, "rerun" => :rerun }, default_value: :run
 			perform.action do |_global_options, options, _args|
 				Diggit::Dig.it.join(options[:s], options[:a], options[:m])
@@ -197,14 +198,14 @@ module Diggit
 			end
 		end
 		c.desc 'Add an analysis.'
-		c.arg_name 'name'
+		c.arg_name '<name>'
 		c.command :add do |add|
 			add.action do |_global_options, _options, args|
 				Diggit::Dig.it.config.add_analysis args[0]
 			end
 		end
 		c.desc 'Delete an analysis.'
-		c.arg_name 'name'
+		c.arg_name '<name>'
 		c.command :del do |del|
 			del.action do |_global_options, _options, args|
 				Diggit::Dig.it.config.del_analysis args[0]
@@ -212,9 +213,9 @@ module Diggit
 		end
 		c.desc 'Perform analyses.'
 		c.command :perform do |perform|
-			perform.flag %i[s sources], desc: "list of sources", type: Array, default_value: []
+			perform.flag %i[s sources], desc: "list of sources id", type: Array, default_value: []
 			perform.flag %i[a analyses], desc: "list of analyses", type: Array, default_value: []
-			perform.flag %i[m mode], desc: "running mode",
+			perform.flag %i[m mode], desc: "running mode: run, clean or rerun",
 			must_match: { "run" => :run, "clean" => :clean, "rerun" => :rerun }, default_value: :run
 			perform.action do |_global_options, options, _args|
 				Diggit::Dig.it.analyze(options[:s], options[:a], options[:m])

data/lib/dgit/core.rb

@@ -28,7 +28,12 @@ class Dummy
 	end
 end
 
-Oj.default_options = Oj.default_options.merge(mode: :object, auto_define: true, circular: true)
+Oj.default_options = Oj.default_options.merge(
+		mode: :object,
+		indent: 2,
+		auto_define: true,
+		circular: true
+)
 Oj.register_odd(Rugged::Repository, Dummy, :new, :to_s)
 
 class String
@@ -148,11 +153,11 @@ module Diggit
 	class Config
 		attr_reader :analyses, :joins
 
-		def initialize(hash)
+		def initialize(config_hash)
 			@analyses = []
 			@joins = []
-			hash[:analyses].each { |a| load_analysis(a) }
-			hash[:joins].each { |j| load_join(j) }
+			config_hash[:analyses].each { |a| load_analysis(a) }
+			config_hash[:joins].each { |j| load_join(j) }
 		end
 
 		def to_hash
@@ -267,9 +272,6 @@ module Diggit
 			f_glob = PluginLoader.plugin_paths(name, type, File.expand_path('../..', __dir__))
 			f_home = PluginLoader.plugin_paths(name, type, File.join(Dir.home, Dig::DGIT_FOLDER))
 			f_local = PluginLoader.plugin_paths(name, type, Dig.it.folder)
-			Log.debug "Plugin files in global: #{f_glob}."
-			Log.debug "Plugin files in home: #{f_home}."
-			Log.debug "Plugin files in local directory: #{f_local}."
 			found = true
 			if !f_local.empty?
 				f_local.each { |f| require File.expand_path(f) }
@@ -391,7 +393,7 @@ module Diggit
 		# @return [void]
 		def save_journal
 			File.open(config_path(DGIT_SOURCES), "w") { |f| @journal.sources.each { |source| f.puts(source.url) } }
-			Oj.to_file(config_path(DGIT_JOURNAL), @journal, indent: 2)
+			Oj.to_file(config_path(DGIT_JOURNAL), @journal)
 		end
 
 		# Load the options from `.dgit/options`
@@ -423,7 +425,10 @@ module Diggit
 		# @param source_ids [Array<Integer>] the ids of the sources.
 		# @return [void]
 		def clone(*source_ids)
-			@journal.sources_by_ids(*source_ids).select { |s| s.entry.new? }.each(&:clone)
+			@journal.sources_by_ids(*source_ids).select { |s| s.entry.new? }.each do |s|
+				Log.fine("cloning  #{s.url} (#{s.oid})")
+				s.clone
+			end
 		ensure
 			save_journal
 		end
@@ -436,6 +441,7 @@ module Diggit
 		def analyze(source_ids = [], analyses = [], mode = :run)
 			@journal.sources_by_ids(*source_ids).select { |s| s.entry.cloned? }.each do |s|
 				@config.get_analyses(*analyses).each do |klass|
+					Log.fine("Performing analysis #{klass} (#{mode}) on #{s.url}")
 					a = klass.new(@options)
 					s.load_repository
 					a.source = s
@@ -452,6 +458,7 @@ module Diggit
 		# @return [void]
 		def join(source_ids = [], joins = [], mode = :run)
 			@config.get_joins(*joins).each do |klass|
+				Log.fine("Performing join #{klass}")
 				j = klass.new(@options)
 				clean(j, @journal.workspace) if clean_mode?(mode) && @journal.workspace.has?(j)
 				source_array = @journal.sources_by_ids(*source_ids).select do |s|

data/lib/dgit/log.rb

@@ -24,22 +24,26 @@ class Formatador
 		attr_accessor :level
 	end
 
-	def self.info(str)
-		Formatador.display_line(str) if visible(__method__)
+	def self.fine(str)
+		Formatador.display_line("[blue]#{str}[/]") if visible(__method__)
 	end
 
-	def self.debug(str)
-		Formatador.display_line(str) if visible(__method__)
+	def self.info(str)
+		Formatador.display_line("[purple]#{str}[/]") if visible(__method__)
 	end
 
 	def self.ok(str)
 		Formatador.display_line("[green]#{str}[/]") if visible(__method__)
 	end
 
-	def self.warn(str)
+	def self.debug(str)
 		Formatador.display_line("[yellow]#{str}[/]") if visible(__method__)
 	end
 
+	def self.warn(str)
+		Formatador.display_line("[orange]#{str}[/]") if visible(__method__)
+	end
+
 	def self.error(str)
 		Formatador.display_line("[red]#{str}[/]") if visible(__method__)
 	end
@@ -48,7 +52,7 @@ class Formatador
 		target = method.to_sym
 		if %i[ok error info].include?(target)
 			true
-		elsif (target == :warn || target == :debug) && level == :fine
+		elsif %i[warn debug fine].include?(target) && level == :fine
 			true
 		else
 			false

data/lib/dgit/version.rb

@@ -16,5 +16,5 @@
 # Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
 
 module Diggit
-	VERSION = '3.0.0'.freeze
+	VERSION = '3.0.1'.freeze
 end

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: diggit
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Jean-Rémy Falleri
+- Floréal Morandat
 - Matthieu Foucault
+- Mohamed Oumaziz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-22 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: formatador
@@ -142,6 +144,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.49.0
   type: :development
@@ -149,6 +154,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.49.0
 - !ruby/object:Gem::Dependency
@@ -156,6 +164,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.11
   type: :development
@@ -163,10 +174,12 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.11
-description: "The Diggit repository analysis tool is a neat swiss knife to enable\\\n\t\tthe
-  analysis of many Git repositories."
+description: Diggit is an agile tool that allows you to analyze git repositories.
 email: jr.falleri@gmail.com
 executables:
 - dgit
@@ -228,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A Git repository analysis tool.