diggit 2.0.0 → 2.0.1

data/lib/dgit/log.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+#
+# This file is part of Diggit.
+#
+# Diggit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Diggit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Diggit.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
+#
+
+require 'formatador'
+
+class Formatador
+	@level = :normal
+
+	class << self
+		attr_accessor :level
+	end
+
+	def self.info(str)
+		Formatador.display_line(str) if visible(__method__)
+	end
+
+	def self.debug(str)
+		Formatador.display_line(str) if visible(__method__)
+	end
+
+	def self.ok(str)
+		Formatador.display_line("[green]#{str}[/]") if visible(__method__)
+	end
+
+	def self.warn(str)
+		Formatador.display_line("[yellow]#{str}[/]") if visible(__method__)
+	end
+
+	def self.error(str)
+		Formatador.display_line("[red]#{str}[/]") if visible(__method__)
+	end
+
+	def self.visible(method)
+		target  = method.to_sym
+		if target == :ok || target == :error || target == :info
+			true
+		elsif (target == :warn || target == :debug) && level == :fine
+			true
+		else
+			false
+		end
+	end
+end
+
+Log = Formatador

data/lib/dgit/plugins.rb

@@ -1,8 +1,31 @@
 # encoding: utf-8
+#
+# This file is part of Diggit.
+#
+# Diggit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Diggit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Diggit.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
+#
 
 require_relative 'core'
 
 module Diggit
+	# Base class for plugins. They have associated options.
+	#
+	# @abstract Abstract superclass for all plugins.
+	# @!attribute [r] options
+	# 	@return [Hash<String, Object>] the hash of options.
 	class Plugin
 		attr_reader :options
 
@@ -25,6 +48,15 @@ module Diggit
 		end
 	end
 
+	# Base class for analyses and joins. Runnables can be runned or cleaned.
+	# These methods have to be implemented in the subclasses.
+	# Addons can be made available to a runnable through a call to {.require\_addons}.
+	# Addons can be accessed through the addons attribute, and they contain
+	# automatically methods that has names of their addons.
+	# @see Addon
+	# @abstract Abstract superclass for analysis and joins.
+	# @!attribute [r] addons
+	# 	@return [Hash<String, Addon>] the hash of addons.
 	class Runnable < Plugin
 		attr_reader :addons
 
@@ -35,22 +67,57 @@ module Diggit
 			@addons.each_key { |a| self.class.class_eval { define_method(a) { return @addons[a] } } }
 		end
 
+		# Run the runnable.
+		# @abstract This method must be overrided.
+		# @return [void]
 		def run
 		end
 
+		# Clean the runnable.
+		# @abstract This method must be overrided.
+		# @return [void]
 		def clean
 		end
 
+		# Add an addon as a required addon.
+		#
+		# @param names Array<String> the names of addons to require.
+		# 	They correspond to the name of their class with underscore case.
+		# @return [void]
+		def self.require_addons(*names)
+			@required_addons = names
+		end
+
 		def self.required_addons
 			return [] if @required_addons.nil?
 			@required_addons
 		end
-
-		def self.require_addons(*names)
-			@required_addons = names
-		end
 	end
 
+	# Base class for joins. Joins are applied on each source that has been:
+	# 1. succesfully cloned,
+	# 2. has been analyzed by the required analyses.
+	# Required analyses are added with a call to {.require\_analyses}.
+	# They can access addons through the addons attribute or with a method having the addon name.
+	# @see Runnable
+	# @abstract Subclass and override run and clean to implement a custom join class.
+	# @!attribute [rw] sources
+	# 	@return [Array<Source>] the sources to be joined.
+	# @example A sample join using an addon.
+	# 	class JoinWithAddon < Diggit::Join
+	# 		require_addons "db"
+	#
+	# 		def run
+	# 			db.do_something
+	# 			puts @options
+	# 			puts @sources
+	# 			puts "Runned!"
+	# 		end
+	#
+	# 		def clean
+	# 			puts "Cleaned!"
+	# 		end
+	# 	end
 	class Join < Runnable
 		attr_accessor :sources
 
@@ -59,16 +126,42 @@ module Diggit
 			@sources = []
 		end
 
+		# Add an analysis as a required analysis.
+		#
+		# @param names Array<String> the names of analyses to require.
+		# 	They correspond to the name of their class with underscore case.
+		# @return [void]
+		def self.require_analyses(*names)
+			@required_analyses = names
+		end
+
 		def self.required_analyses
 			return [] if @required_analyses.nil?
 			@required_analyses
 		end
-
-		def self.require_analyses(*names)
-			@required_analyses = names
-		end
 	end
 
+	# Base class for analyses. Diggit analyses are applied on each source that has been succesfully cloned.
+	# They can access the Diggit addons through the addons attribute.
+	# @see Runnable
+	# @abstract Subclass and override run and clean to implement a custom analysis class.
+	# @!attribute [rw] source
+	# 	@return [Source] the source to be analyzed.
+	# @example A sample analysis using an addon
+	# 	class AnalysisWithAddon < Diggit::Analysis
+	# 		require_addons "db"
+	#
+	# 		def run
+	# 			db.do_something
+	# 			puts @options
+	# 			puts @source
+	# 			puts "Runned!"
+	# 		end
+	#
+	# 		def clean
+	# 			puts "Cleaned!"
+	# 		end
+	# 	end
 	class Analysis < Runnable
 		attr_accessor :source
 

data/lib/dgit/version.rb

@@ -1,5 +1,23 @@
 # encoding: utf-8
+#
+# This file is part of Diggit.
+#
+# Diggit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Diggit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Diggit.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
+#
 
 module Diggit
-	VERSION = "2.0.0"
+	VERSION = "2.0.1"
 end

data/plugins/addon/db.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+#
+# This file is part of Diggit.
+#
+# Diggit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Diggit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Diggit.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
+#
+
+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.
+class Db < Diggit::Addon
+	DEFAULT_URL = 'mongodb://127.0.0.1:27017/diggit'
+
+	attr_reader :client
+
+	def initialize(*args)
+		super
+		url = DEFAULT_URL
+		url = @options[:mongo][:url] if @options.key?(:mongo) && @options[:mongo].key?(:url)
+		@client = Mongo::Client.new(url)
+	end
+end

data/plugins/addon/out.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+#
+# This file is part of Diggit.
+#
+# Diggit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Diggit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Diggit.  If not, see <http://www.gnu.org/licenses/>.
+#
+# 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
+# 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.
+# @!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.
+class Out < Diggit::Addon
+	attr_reader :out, :tmp
+
+	DEFAULT_OUT = 'out'
+	DEFAULT_TMP = 'tmp'
+
+	def initialize(*args)
+		super
+
+		out = DEFAULT_OUT
+		out = @options[:output][:out] if @options.key?(:output) && @options[:output].key?(:out)
+		tmp = DEFAULT_TMP
+		tmp = @options[:output][:tmp] if @options.key?(:output) && @options[:output].key?(:tmp)
+
+		@out = File.absolute_path(out)
+		@tmp = File.absolute_path(tmp)
+
+		FileUtils.mkdir_p(@out) unless File.exist?(@out)
+		FileUtils.mkdir_p(@tmp) unless File.exist?(@tmp)
+	end
+end

data/plugins/addon/r.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+#
+# This file is part of Diggit.
+#
+# Diggit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Diggit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Diggit.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
+# Copyright 2015 Matthieu Foucault <foucaultmatthieu@gmail.com>
+#
+
+R = nil # fixing SIGPIPE error in some cases. See http://hfeild-software.blogspot.fr/2013/01/rinruby-woes.html
+
+require "rinruby"
+
+class R < Diggit::Addon
+	def initialize(*args)
+		super(args)
+		@r = RinRuby.new({ interactive: false, echo: true })
+	end
+
+	def method_missing(meth, *args, &block)
+		@r.send meth, *args, &block
+	end
+end

data/plugins/analysis/cloc.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+#
+# This file is part of Diggit.
+#
+# Diggit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Diggit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Diggit.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
+#
+
+require 'yaml'
+
+class Cloc < Diggit::Analysis
+	require_addons 'db'
+
+	def initialize(options)
+		super(options)
+	end
+
+	def run
+		cloc = `cloc . --progress-rate=0 --quiet --yaml`
+		return if cloc.empty?
+		yaml = YAML.load(cloc.lines[2..-1].join)
+		yaml.delete('header')
+		output = { source: @source.url, cloc: yaml }
+		db.client['cloc'].insert_one(output)
+	end
+
+	def clean
+		db.client['cloc'].find({ source: @source.url }).delete_one
+	end
+end

data/spec/core_spec.rb

@@ -1,4 +1,22 @@
 # encoding: utf-8
+#
+# This file is part of Diggit.
+#
+# Diggit is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Diggit is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Diggit.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Copyright 2015 Jean-Rémy Falleri <jr.falleri@gmail.com>
+#
 
 require 'spec_helper'
 require 'fileutils'
@@ -39,6 +57,16 @@ RSpec.describe Diggit::Dig do
 		expect(analysis_instance.test_addon.foo).to eq("Foo.")
 	end
 
+	it "should load an analysis enlosed in a module" do
+		analysis = Diggit::Dig.it.plugin_loader.load_plugin("other_analysis", :analysis)
+		expect(analysis.to_s).to eq('MyModule::OtherAnalysis')
+	end
+
+	it "should emit a warning in case of ambiguous analysis name" do
+		expect(Diggit::Dig.it.plugin_loader).to receive(:warn).with(/Ambiguous plugin name/)
+		Diggit::Dig.it.plugin_loader.load_plugin("duplicate_analysis", :analysis)
+	end
+
 	it "should load a join" do
 		join = Diggit::Dig.it.plugin_loader.load_plugin("test_join", :join)
 		expect(join.to_s).to eq('TestJoin')
@@ -80,21 +108,23 @@ RSpec.describe Diggit::Dig do
 		expect(Diggit::Dig.it.journal.sources_by_ids(0)[0].url).to eq TEST_URL
 	end
 
-	it "should perform analyses" do
+	it "should perform analyses in order" do
 		Diggit::Dig.it.config.add_analysis("test_analysis")
+		Diggit::Dig.it.config.add_analysis("test_analysis_with_addon")
 		Diggit::Dig.it.analyze
 		# expect(TestAnalysis.state).to eq("runned")
-		expect(Diggit::Dig.it.journal.sources_by_ids(0)[0].analysis?('test_analysis')).to be true
+		expect(Diggit::Dig.it.journal.sources_by_ids(0)[0].all_analyses).to eq(%w(test_analysis test_analysis_with_addon))
 		Diggit::Dig.init("spec/dgit")
-		expect(Diggit::Dig.it.journal.sources_by_ids(0)[0].analysis?('test_analysis')).to be true
+		expect(Diggit::Dig.it.journal.sources_by_ids(0)[0].all_analyses).to eq(%w(test_analysis test_analysis_with_addon))
 	end
 
 	it "should handle analyses with error" do
 		Diggit::Dig.it.config.add_analysis("test_analysis_with_error")
 		Diggit::Dig.it.analyze
-		expect(Diggit::Dig.it.journal.sources_by_ids(0)[0].analysis?('test_analysis')).to be true
-		expect(Diggit::Dig.it.journal.sources_by_ids(0)[0].error?).to be true
-		expect(Diggit::Dig.it.journal.sources_by_ids(0)[0].error[:message]).to eq("Error!")
+		src = Diggit::Dig.it.journal.sources_by_ids(0)[0]
+		expect(src.all_analyses).to include("test_analysis")
+		expect(src.error?).to be true
+		expect(src.error[:message]).to eq("Error!")
 	end
 
 	it "should perform joins" do