diggit 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03b553461539e07d43eefe6c94a760b44bdf8940
-  data.tar.gz: a0d58fbe18d396043c68242b916d4d76ca43e45c
+  metadata.gz: bdc49eaf85ab5ea705046d562d66d05aec279b07
+  data.tar.gz: 8046df957be6fcc9a9296256c9bee91562f8ee7e
 SHA512:
-  metadata.gz: cc71247842cc94ee9f4cfbab0399e0a49c47503f0b2bc964a7d2216a1fef26fb8798f38d5b2dd6a6ba1a4ef5bc90c82e3e2eddfde17673c6536949ef86cb456e
-  data.tar.gz: 4eea49b3b12d22ea172942431a4e38a057aa75ea61264d1edb70002e150fb6fe71ec90fbfbbd36c2dc7127c23fd2484b4c058a060488bcf97761dc3243bb35f4
+  metadata.gz: 6b42a77ecfb10bc8f95e952d58f1a8bae42395b017038fea82fd5240a2f238645ec9007172dfdc54671e945674bc90bcc96946fadae62238a2781cc9a39c7d52
+  data.tar.gz: f2626d93e3f2e1179d10f16f5cfcb3ddfcb292f99614518925e60349e1c5814bdf721beed37cb6851822ddba08ba6e5595de7a0fd50855f62f5faa3d48cc7247

data/README.md

@@ -4,13 +4,13 @@ A ruby tool to analyse Git repositories
 
 # Installation
 
-Clone diggit using the following command.
+## From a gem
 
-```
-git clone https://github.com/jrfaller/diggit.git
-```
+Just run `gem install diggit`.
 
-The diggit tool is in the lib folder. Don't hesitate to create a link to diggit.rb to be able to launch it in any repository.
+## From the source
+
+Clone diggit using the following command: `git clone https://github.com/jrfaller/diggit.git`. The `dgit` tool is in the `bin` folder.
 
 # Usage
 
@@ -24,7 +24,7 @@ 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 mondodb 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 TestAddon`.
 
 ### Setting-up analyses
 
@@ -36,10 +36,10 @@ A join is performed after all analyses of all repositories have been performed.
 
 ## Running analyses
 
-Once diggit is configured you can perform the analyses. First you have to perform the clone by using `dgit perform clones`. Then you can launch the analyses by using `dgit perform analyses`. Finally, the joins are executed via the command `dgit perform joins`.
+Once diggit is configured you can perform the analyses. First, you have to clone the repositories by using `dgit perform clones`. Then you can launch the analyses by using `dgit perform analyses`. Finally, the joins are executed via the command `dgit perform joins`.
 
 At all time, you can check the status of your diggit folder by using `dgit status`. If you want more info on the status of a given repository, you can use the `dgit sources info https://github.com/jrfaller/diggit.git` command.
 
 ## Cleaning up
 
-If something is going error, you can always delete the results of the joins by using the command `dgit clean joins` and of the analysis with the command `dgit clean analyses`.
+If something is going wrong, you can always delete the results of the joins by using the command `dgit clean joins` and of the analysis with the command `dgit clean analyses`.

data/includes/addons/sources_options.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+class SourcesOptions < Diggit::Addon
+
+	SOURCES_OPTIONS_FILE = ".dgitsources-options"
+
+	def initialize(*args)
+		super
+		@sources_options = {}
+		@sources_options = Oj.load_file(SOURCES_OPTIONS_FILE) if File.exists? SOURCES_OPTIONS_FILE
+	end
+
+	def name
+		:sources_options
+	end
+
+	def method_missing(meth, *args, &block)
+		@sources_options.send meth, *args, &block
+	end
+
+end

data/includes/analyses/cloc.rb

@@ -20,3 +20,32 @@ class ClocAnalysis < Diggit::Analysis
 	end
 
 end
+
+
+class ClocPerFileAnalysis < Diggit::Analysis
+
+	def run
+		commit_oid = "HEAD"
+		commit_oid = @addons[:sources_options][@source]["cloc-commit-id"] if @addons.has_key?(:sources_options) && @addons[:sources_options].has_key?(@source) && @addons[:sources_options][@source].has_key?("cloc-commit-id")
+		@repo.checkout(commit_oid, {:strategy=>[:force,:remove_untracked]})
+		cloc = `cloc . --progress-rate=0 --quiet --by-file --yaml --script-lang=Python,python`
+		unless cloc.empty?
+			yaml = YAML.load(cloc.lines[2..-1].join)
+			yaml.delete('header')
+			yaml.delete('SUM')
+			cloc_a = []
+			yaml.each do |key, value|
+				# transform the hash so the filenames are not keys anymore (as they may contain a '.' it is incompatible with mongo)
+				path = key.gsub(/^\.\//, '') # remove the './' at the start of filenames
+				cloc_a << value.merge({:path => path})
+			end
+			output = { source: @source, commit_oid: commit_oid.to_s, cloc: cloc_a }
+			col = @addons[:db].db['cloc-file']
+			col.insert(output)
+		end
+	end
+
+	def clean
+		@addons[:db].db['cloc-file'].remove({source: @source})
+	end
+end

data/lib/diggit_cli.rb

@@ -7,6 +7,11 @@ module Diggit
 
 	module Utils
 
+		DONE = '[done]'
+		WARNING = '[warning]'
+		ERROR = '[error]'
+		INFO = '[info]'
+
 		def diggit
 			@diggit = Diggit.new if @diggit.nil?
 			return @diggit
@@ -32,22 +37,29 @@ module Diggit
 		end
 
 		def status_color(status)
-			if status == Cli::DONE
+			if status == DONE
 				return :green
 			else
 				return :red
 			end
 		end
 
+		def say_error(msg)
+			say_status(ERROR, msg, :red)
+		end
+
+		def say_info(msg)
+			say_status(INFO, msg, :blue)
+		end
+
+		def say_done(msg)
+			say_status(DONE, msg, :green)
+		end
+
 	end
 
 	module Cli
 
-		DONE = '[done]'
-		WARNING = '[warning]'
-		ERROR = '[error]'
-		INFO = '[info]'
-
 		class SourcesCli < Thor
 			include Thor::Actions
 			include Utils
@@ -70,7 +82,7 @@ module Diggit
 				say_status("[#{s[:log][:state]}]", "#{s[:url]}", source_color(s))
 				say_status('[folder]', "#{s[:folder]}", :blue)
 				unless s[:log][:error].empty?
-					say_status(ERROR, "#{s[:log][:error][:name]}", :red)
+					say_error("#{s[:log][:error][:name]}")
 					say_status('[message]', "#{s[:log][:error][:message]}", :red)
 					say_status('[backtrace]', "", :red)
 					say(s[:log][:error][:backtrace].join("\n"))
@@ -108,7 +120,7 @@ module Diggit
 					if plugin_ok?(a, Addon)
 						diggit.config.add_addon(a)
 					else
-						say_status(ERROR, "error loading addon #{a}", :red)
+						say_error("error loading addon #{a}")
 					end
 				end
 			end
@@ -130,7 +142,7 @@ module Diggit
 					if plugin_ok?(j, Join)
 						diggit.config.add_join(j)
 					else
-						say_status(ERROR, "error loading join #{j}", :red)
+						say_error("error loading join #{j}")
 					end
 				end
 			end
@@ -152,7 +164,7 @@ module Diggit
 					if plugin_ok?(a, Analysis)
 						diggit.config.add_analysis(a)
 					else
-						say_status(ERROR, "error loading analysis #{a}", :red)
+						say_error("error loading analysis #{a}")
 					end
 				end
 			end
@@ -175,15 +187,22 @@ module Diggit
 						if File.exist?(s[:folder])
 							Rugged::Repository::new(s[:folder])
 						else
-							Rugged::Repository::clone_at(s[:url], s[:folder])
+							Rugged::Repository::clone_at(s[:url], s[:folder], {
+  								transfer_progress: lambda { |total_objects, indexed_objects, received_objects, local_objects, total_deltas, indexed_deltas, received_bytes|
+    								msg = "Clone of #{s[:url]} in progress : #{received_objects}/#{total_objects} objects received.\r"
+    								$stderr.print msg
+    								@last_message_length = msg.length
+							  }
+							})
+							print " " * @last_message_length + "\r" # clean the line used to output transfer progress
 						end
 					rescue => e
 						s[:log][:error] = dump_error(e)
-						say_status(ERROR, "error cloning #{s[:url]}", :red)
+						say_error("error cloning #{s[:url]}")
 					else
 						s[:log][:state] = :cloned
 						s[:log][:error] = {}
-						say_status(DONE, "#{s[:url]} cloned", :blue)
+						say_done("#{s[:url]} cloned")
 					ensure
 						diggit.sources.update(s)
 					end
@@ -206,12 +225,12 @@ module Diggit
 					rescue => e
 						s[:log][:error] = dump_error(e)
 						s[:log][:analyses] = performed_analyses[1..-2]
-						say_status(ERROR, "error performing #{performed_analyses.last} on #{s[:url]}", :red)
+						say_error("error performing #{performed_analyses.last} on #{s[:url]}")
 					else
 						s[:log][:analyses] = performed_analyses
 						s[:log][:state] = :finished
 						s[:log][:error] = {}
-						say_status(DONE, "source #{s[:url]} analyzed", :blue)
+						say_done("source #{s[:url]} analyzed")
 					ensure
 						FileUtils.cd(diggit.root)
 						diggit.sources.update(s)
@@ -224,7 +243,7 @@ module Diggit
 				addons = diggit.config.load_addons
 				globs = {}
 				diggit.config.load_joins(diggit.sources.get_all([], {state: :finished, error: false}), addons, globs).each{ |j| j.run }
-				say_status(DONE, "joins performed", :blue)
+				say_done("joins performed")
 			end
 
 		end
@@ -243,7 +262,7 @@ module Diggit
 					s[:log][:analyses] = []
 					s[:log][:error] = {}
 					diggit.sources.update(s)
-					say_status(DONE, "cleaned analyses on #{s[:url]}", :blue)
+					say_done("cleaned analyses on #{s[:url]}")
 				end
 			end
 
@@ -265,7 +284,7 @@ module Diggit
 				cmd = args[2][:current_command].name
 				unless 'init'.eql?(cmd) || 'help'.eql?(cmd)
 					unless File.exist?(DIGGIT_RC)
-						say_status(ERROR, "this is not a diggit directory", :red)
+						say_error("this is not a diggit directory")
 					else
 						diggit
 					end
@@ -277,7 +296,7 @@ module Diggit
 				FileUtils.touch(DIGGIT_SOURCES)
 				Oj.to_file(DIGGIT_LOG, {})
 				Oj.to_file(DIGGIT_RC, { addons: [], analyses: [], joins: [], options: {} })
-				say_status(DONE, "folder initialized")
+				say_done("Diggit folder successfully initialized")
 			end
 
 			desc 'status', "Display the status of the current diggit folder."

data/lib/diggit_core.rb

@@ -240,7 +240,7 @@ module Diggit
 			if source_defs.nil? || source_defs.empty?
 				sources = hashes
 			else
-				sources = source_defs.map{ |d| hash(d) }
+				sources = source_defs.map{ |d| get(d) }
 			end
 			sources = sources.select{ |s| s[:log][:state] == filter[:state] } if (filter.has_key?(:state))
 			sources = sources.select{ |s| s[:log][:error].empty? != filter[:error] } if (filter.has_key?(:error))

data/spec/diggit_spec.rb

@@ -14,7 +14,7 @@ RSpec.describe Diggit::Cli::DiggitCli do
 
 	it "should init a diggit folder" do
 		result = capture(:stdout) { Diggit::Cli::DiggitCli.start(["init"]) }
-		expect(result).to include("folder initialized")
+		expect(result).to include("folder successfully initialized")
 		expect(sources).to be_empty
 		expect(log).to be_empty
 		expect(config).to eq({analyses: [], addons: [], joins: [],  options: {}})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diggit
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Jean-Rémy Falleri
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-01 00:00:00.000000000 Z
+date: 2015-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -67,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rinruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,7 @@ files:
 - bin/dgit
 - includes/addons/db.rb
 - includes/addons/output.rb
+- includes/addons/sources_options.rb
 - includes/addons/test.rb
 - includes/analyses/authors.rb
 - includes/analyses/cloc.rb
@@ -141,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A Git repository analysis tool.