diggit 2.1.1 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60e58099916b06eceaa99f9bad1f18822ac74106
-  data.tar.gz: 5568fc8c3a6bd36f09f25d7ceeb9233da126ffea
+  metadata.gz: 5cac2786446fa6926083f231b569214be1e40f0a
+  data.tar.gz: 29a9bd41ae8706f127b8f537e3158c8b1e5641bb
 SHA512:
-  metadata.gz: 84dd036f313699556b0fafc8604d56b45ceb7441dc7f4530061c98816973f6bb0c71406245b3569dcfa9cf244caab20d96702ba16e9f802dafce94994f6ea2e5
-  data.tar.gz: d82cc5a83c57e774af69f367df32dc695b72cb2807963e687502f3de309d7bf4ea784b4fa7bad6216484feab48e2c1e675f3120fefb99af444784e92c98217b3
+  metadata.gz: c52e0b3028901e59002dd18dec88e307fd0b9b586e1a2da2e5643ed706ff7aaa2f45f5fa2d3f7618e8ef451510bdedc6d768978ef52307ac94b87e26fd4f827a
+  data.tar.gz: 955253ceb5e4f142d9571b943ed852c40cf0ab476a3ae9958e80be5f22cbb0e2ccfc1bd79bb42e03eed14fa963c4be19e58580aae626d69e14ff76a77e7246fa

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 # Changelog of Diggit
 
+### Version 2.1.2
+* Improve documentation
+* Fix bug of `sources del`
+
 ### 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
+* 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

data/README.md

@@ -4,11 +4,15 @@ A ruby tool to analyze Git repositories
 
 # 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
 
 Just run `gem install diggit`.
 
-## From the source, with bundler
+## From the sources, with bundler
 
 Install diggit using the following commands:
 ```
@@ -19,13 +23,13 @@ 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
+## 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.
+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
 
-Don't forget that dgit binary has an associated help that can be consulted using `dgit help`.
+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
 
@@ -35,20 +39,20 @@ The diggit tool is designed to help you analyze software repositories. Firstly y
 
 You can add some repositories to be analyzed with the following command: `dgit sources add https://github.com/jrfaller/diggit.git`.
 
-### 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 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 test_analysis`. 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. 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
 
-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.
+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
+
+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`
 
-## Running analyses
+## 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.
+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`).
 
 At all time, you can check the status of your diggit folder by using `dgit status`.

data/bin/dgit

@@ -104,7 +104,7 @@ module Diggit
 		c.arg_name 'id'
 		c.command :del do |del|
 			del.action do |_global_options, _options, args|
-				Diggit::Dig.it.journal.del_source args[0]
+				Diggit::Dig.it.journal.del_source args[0].to_i
 			end
 		end
 		c.desc 'Import sources from a file.'

data/lib/dgit/core.rb

@@ -208,7 +208,7 @@ module Diggit
 
 	# Class to handle loading of diggit plugins.
 	# Diggit plugins are defined in camel cased classes derived from Plugin.
-	# Their name is the underscore cased version of the class name (example +MyPlugin+ becomes +my_plugin+).
+	# Their name is the underscore cased version of the class name (example `MyPlugin` becomes `my_plugin`).
 	# It uses a singleton pattern, so you have to create an instance like that:
 	# @example
 	# 	PluginLoader.instance
@@ -220,8 +220,8 @@ module Diggit
 
 		# Load the plugin with the given name and type.
 		# @param name [String] the name of the plugin
-		# @param type [Symbol] the type of the plugin: +:addon+, +:analysis+ or +:join+.
-		# @param instance [Boolean] +true+ for retrieving an instance or +false+ for retrieving the class.
+		# @param type [Symbol] the type of the plugin: `:addon`, `:analysis` or `:join`.
+		# @param instance [Boolean] `true` for retrieving an instance or `false` for retrieving the class.
 		# @return [Plugin, Class] the instance or class of the plugin.
 		def load_plugin(name, type, instance = false)
 			plugin = search_plugin(name, type)
@@ -279,7 +279,7 @@ module Diggit
 	end
 
 	# Main diggit class.
-	# It must be runned in a folder containing a +.dgit+ folder with a proper configuration.
+	# It must be runned in a folder containing a `.dgit folder with a proper configuration.
 	# Access configuration, options, sources and journal from this object.
 	# It implements the singleton pattern.
 	# You can initialize it via {.init} and retrieve the instance via {.it}.
@@ -325,10 +325,9 @@ module Diggit
 		end
 
 		# Initialize a folder to be a diggit folder by creating an empty configuration.
-		# It creates a +.dgit+ folder containing a +journal+, +config+, +options+ files.
-		# It creates a +sources+ folder.
-		# It creates a +plugins+ folder.
-		# Directory creation is skipped if folder already exist.
+		# It creates a `.dgit` folder containing a `journal`, `config`, `options` files.
+		# It also creates an empty `sources` folder and an empty `plugins` folder.
+		# Directory creation is skipped if the `.dgit` folder already exists.
 		# @param folder [String] the path to the folder.
 		# @return [void]
 		def self.init_dir(folder = '.')
@@ -371,7 +370,7 @@ module Diggit
 			@folder = folder
 		end
 
-		# Load the journal from +.dgit/journal+
+		# Load the journal from `.dgit/journal`
 		# @return [void]
 		def load_journal
 			url_array = []
@@ -382,32 +381,32 @@ module Diggit
 			end
 		end
 
-		# Save the journal to +.dgit/journal+
+		# Save the journal to `.dgit/journal`
 		# @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)
 		end
 
-		# Load the options from +.dgit/options+
+		# Load the options from `.dgit/options`
 		# @return [void]
 		def load_options
 			@options = Oj.load_file(config_path(DGIT_OPTIONS))
 		end
 
-		# Save the options to +.dgit/options+
+		# Save the options to `.dgit/options`
 		# @return [void]
 		def save_options
 			Oj.to_file(config_path(DGIT_OPTIONS), options)
 		end
 
-		# Load the config from +.dgit/config+
+		# Load the config from `.dgit/config`
 		# @return [void]
 		def load_config
 			@config = Config.new(Oj.load_file(config_path(DGIT_CONFIG)))
 		end
 
-		# Save the config to +.dgit/config+
+		# Save the config to `.dgit/config`
 		# @return [void]
 		def save_config
 			config_hash = @config.to_hash
@@ -426,7 +425,7 @@ module Diggit
 		# Perform the given analyses on sources with the given ids using the given mode.
 		# @param source_ids [Array<Integer>] the ids of the sources.
 		# @param analyses [Array<String>] the names of the analyses.
-		# @param mode [Symbol] the mode: +:run+, +:rerun+ or +:clean+.
+		# @param mode [Symbol] the mode: `:run`, `:rerun` or `:clean`.
 		# @return [void]
 		def analyze(source_ids = [], analyses = [], mode = :run)
 			@journal.sources_by_ids(*source_ids).select { |s| s.entry.cloned? }.each do |s|
@@ -443,7 +442,7 @@ module Diggit
 		# Perform the given joins on sources with the given ids using the given mode.
 		# @param source_ids [Array<Integer>] the ids of the sources.
 		# @param joins [Array<String>] the names of the analyses.
-		# @param mode [Symbol] the mode: +:run+, +:rerun+ or +:clean+.
+		# @param mode [Symbol] the mode: `:run`, `:rerun` or `:clean`.
 		# @return [void]
 		def join(source_ids = [], joins = [], mode = :run)
 			@config.get_joins(*joins).each do |klass|

data/lib/dgit/entries.rb

@@ -55,7 +55,7 @@ module Diggit
 
 		# Check if a runnable has been performed or canceled.
 		# @param runnable_or_string [Runnable, String] the runnable or the name of the runnable.
-		# @param state [Symbol] the status of the runnable: +:performed+, +:canceled+ or +:all+.
+		# @param state [Symbol] the status of the runnable: `:performed`, `:canceled` or `:all`.
 		# @return [Boolean]
 		def has?(runnable_or_string, state = :all)
 			name = retrieve_name(runnable_or_string)

data/lib/dgit/plugins.rb

@@ -85,14 +85,12 @@ module Diggit
 		# Run the runnable.
 		# @abstract This method must be overrided.
 		# @return [void]
-		def run
-		end
+		def run; end
 
 		# Clean the runnable.
 		# @abstract This method must be overrided.
 		# @return [void]
-		def clean
-		end
+		def clean; end
 
 		# Add an addon as a required addon.
 		#

data/lib/dgit/version.rb

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

data/plugins/addon/db.rb

@@ -20,11 +20,10 @@
 
 require 'mongo'
 
-# A MongoDB addon for Diggit. The name of this addon is :db.
-# This addon might use an :mongo hash in the global options. In this
-# hash, the :database key allows to configure the name of the database.
-# @!attribute [r] db
-# 	@return [Mongo::DB] the mongo database object.
+# A MongoDB addon for Diggit. This addon might use a `:mongo` hash in the global options. In this
+# hash, the `:database` key allows to configure the name of the database.
+# @!attribute [r] client
+# 	@return [Mongo::Client] the mongodb client object.
 class Db < Diggit::Addon
 	DEFAULT_SERVER = '127.0.0.1:27017'.freeze
 	DEFAULT_DB = 'diggit'.freeze

data/plugins/addon/out.rb

@@ -18,14 +18,13 @@
 #
 # Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
 
-# 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
+# A filesystem addon for Diggit. This addon might use an :output hash in the global options. In this hash, the
+# `:out` key allows to configure the path of the output folder and ``:tmp` the path of the temporary output
 # folder.
 # @!attribute [r] out
 # 	@return [String] the absolute path of the output folder.
 # @!attribute [r] tmp
-# 	@return [String] the absolute path of the temporary output folder.
+# 	@return [String] the absolute path of the temporary folder.
 class Out < Diggit::Addon
 	attr_reader :out, :tmp
 

data/plugins/addon/r.rb

@@ -22,7 +22,12 @@ R = nil # fixing SIGPIPE error in some cases. See http://hfeild-software.blogspo
 
 require "rinruby"
 
+# A R addon for Diggit implemented thanks to RinRuby.
+# @!attribute [r] r
+# 	@return [RinRuby] the RinRuby object.
 class R < Diggit::Addon
+	attr_reader :r
+
 	def initialize(*args)
 		super(args)
 		@r = RinRuby.new({ interactive: false, echo: true })

data/plugins/addon/src_opt.rb

@@ -19,7 +19,15 @@
 # Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
 # Copyright 2015 Matthieu Foucault <foucaultmatthieu@gmail.com>
 
-# Manages options that are specific to a given source
+# An addon to manage options specific to sources. To use it, you need to create a `.dgit/sources_options` file.
+# This file must contain a Json object where the source URLs are the keys, and the values will be given to in
+# return to the call of {[]} with the corresponding source. Example:
+# ```
+# "https://github.com/jrfaller/diggit": {
+#   "name": "An option object for the diggit source.",
+#   "useful": true
+# }
+# ```
 class SrcOpt < Diggit::Addon
 	SOURCES_OPTIONS_FILE = 'sources_options'.freeze
 
@@ -30,6 +38,9 @@ class SrcOpt < Diggit::Addon
 		@sources_options = Oj.load_file(sources_options_path) if File.exist? sources_options_path
 	end
 
+	# Return the option object for the source.
+	# @param source [Source].
+	# @return [Hash] the option object.
 	def [](source)
 		@sources_options[source.url]
 	end

data/plugins/analysis/tex.rb

@@ -32,7 +32,7 @@ class Tex < Diggit::Analysis
 		walker.push(repo.head.name)
 		walker.each do |c|
 			repo.checkout(c.oid, { strategy: [:force, :remove_untracked] })
-			words = Dir["**/*.tex"].reduce(0) { |a, e| a + `cat "#{e}" | wc -w`.to_i }
+			words = Dir["**/*.tex"].reduce(0) { |acc, elem| acc + `cat "#{elem}" | wc -w`.to_i }
 			File.open(file, 'a') { |f| f.puts("#{source.url};#{c.oid};#{words}\n") }
 		end
 	end

data/spec/dgit/plugins/analysis/duplicate_analysis.rb

@@ -19,9 +19,7 @@
 # Copyright 2015 Matthieu Foucault <foucaultmatthieu@gmail.com>
 
 class DuplicateAnalysis < Diggit::Analysis
-	def run
-	end
+	def run; end
 
-	def clean
-	end
+	def clean; end
 end

data/spec/dgit/plugins/analysis/my_module/duplicate_analysis.rb

@@ -20,10 +20,8 @@
 
 module MyModule
 	class DuplicateAnalysis < Diggit::Analysis
-		def run
-		end
+		def run; end
 
-		def clean
-		end
+		def clean; end
 	end
 end

data/spec/dgit/plugins/analysis/my_module/other_analysis.rb

@@ -20,10 +20,8 @@
 
 module MyModule
 	class OtherAnalysis < Diggit::Analysis
-		def run
-		end
+		def run; end
 
-		def clean
-		end
+		def clean; end
 	end
 end

data/spec/dgit/plugins/analysis/test_analysis.rb

@@ -18,9 +18,7 @@
 # Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
 
 class TestAnalysis < Diggit::Analysis
-	def run
-	end
+	def run; end
 
-	def clean
-	end
+	def clean; end
 end

data/spec/dgit/plugins/analysis/test_analysis_with_clean_error.rb

@@ -18,8 +18,7 @@
 # Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
 
 class TestAnalysisWithCleanError < Diggit::Analysis
-	def run
-	end
+	def run; end
 
 	def clean
 		raise "Error!"

data/spec/dgit/plugins/analysis/test_analysis_with_error.rb

@@ -22,6 +22,5 @@ class TestAnalysisWithError < Diggit::Analysis
 		raise "Error!"
 	end
 
-	def clean
-	end
+	def clean; end
 end

data/spec/dgit/plugins/analysis/test_analysis_with_sources_options.rb

@@ -29,6 +29,5 @@ class TestAnalysisWithSourcesOptions < Diggit::Analysis
 		puts src_opt[@source]["myOption"]
 	end
 
-	def clean
-	end
+	def clean; end
 end

data/spec/dgit/plugins/join/test_join.rb

@@ -20,9 +20,7 @@
 class TestJoin < Diggit::Join
 	require_analyses 'test_analysis'
 
-	def run
-	end
+	def run; end
 
-	def clean
-	end
+	def clean; end
 end

data/spec/dgit/plugins/join/test_join_with_addon.rb

@@ -21,9 +21,7 @@ class TestJoinWithAddon < Diggit::Join
 	require_addons 'test_addon'
 	require_analyses 'test_analysis_with_error'
 
-	def run
-	end
+	def run; end
 
-	def clean
-	end
+	def clean; end
 end

data/spec/dgit/plugins/join/test_join_with_clean_error.rb

@@ -20,8 +20,7 @@
 class TestJoinWithCleanError < Diggit::Join
 	require_analyses 'test_analysis'
 
-	def run
-	end
+	def run; end
 
 	def clean
 		raise "Error!"

data/spec/dgit/plugins/join/test_join_with_error.rb

@@ -24,6 +24,5 @@ class TestJoinWithError < Diggit::Join
 		raise "Error!"
 	end
 
-	def clean
-	end
+	def clean; end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diggit
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.1.2
 platform: ruby
 authors:
 - Jean-Rémy Falleri
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-24 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -95,6 +95,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -151,10 +165,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: 'The Diggit repository analysis tool is a neat swiss knife to enable
-  the analysis of many Git repositories.
-
-'
+description: |
+  The Diggit repository analysis tool is a neat swiss knife to enable the analysis of many Git repositories.
 email: jr.falleri@gmail.com
 executables:
 - dgit
@@ -216,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Git repository analysis tool.