diggit 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 923c33e8ad605d0ce6a4213cc65b733d39e5a022bc316ce5274a5cead3a793a1
-  data.tar.gz: 835b774912312f59d93049e237259b73d51a022bd8ec2268be9c0391986e215f
+  metadata.gz: 2e5d600c1a153b908c21f736888189e787cd37b9dfe8b825dd2b09e6d87d3504
+  data.tar.gz: be325f5cfb4e9145e8e6d5b527c4a518f6852687849028e7c4ce06fcbb39e0e2
 SHA512:
-  metadata.gz: 90e82684cdea177aab66ba4a32d31a82a25a00dd358840b1139572bb5da9d9857957f10331d4ffb5cc7e96b28d96d064a8558bfe7734dd25aee470111ca0774c
-  data.tar.gz: 5bb52f527c746f2666f272460a80ade1e5f4558e3cabdab27c824c131200a200b31907b688fa275fb2e753ad4e67730b5f930d8e28c33a9748048e7254204fab
+  metadata.gz: 39fca80590e7d9c00936319c5363605fd7e8b9653d200c638b082f4da3a6efa17bfd3c11e5e211a3e8392702beb3c9e4e9f7e7414df5542afcdde4e4a042b09e
+  data.tar.gz: 58660bd365187ac0d816571bd5d7078202a8a0a7401f405f4afad567e82275432334202300d52509c392e8aedcbea5dd24978d328e8c49099db1e04403dddc82

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog of Diggit
 
+### Version 3.0.2
+* Added version command
+* `out` plugin is now able to furnish and clean folder dedicated for an analysis bound to a source
+* New command to handle options
+* Use ignore option of Oj to avoid weird serialization
+
 ### Version 3.0.1
 * Verbose option now used
 * Improved gemspec

data/bin/dgit

@@ -30,10 +30,44 @@ module Diggit
 	flag %i[f folder], default_value: ".", desc: "Path to the diggit folder. Default: current folder."
 
 	version Diggit::VERSION
-
 	subcommand_option_handling :normal
 	arguments :strict
 
+	accept(Hash) do |value|
+		result = {}
+		value.split(/,/).each do |pair|
+			k, v = pair.split(/=/)
+			i = v.split(/\|/)
+			result[k] = i
+		end
+		result
+	end
+
+	pre do |globals, _command, _options, _args|
+		Diggit::Dig.init globals[:f]
+		Log.level = :fine if globals[:v]
+		true
+	end
+
+	post do |_global, _command, _options, _args|
+			# Post logic here, skips_post to skip commands
+	end
+
+	on_error do |exception|
+		Log.error "Error running diggit."
+		Log.error exception.message
+		Log.info exception.backtrace.join("\n")
+		false
+	end
+
+	desc "Prints diggit version"
+	skips_pre
+	command :version do |c|
+		c.action do |_globals, _options, _args|
+			Log.ok "Diggit version #{Diggit::VERSION}"
+		end
+	end
+
 	desc 'Init a diggit folder.'
 	skips_pre
 	command :init do |c|
@@ -43,6 +77,25 @@ module Diggit
 		end
 	end
 
+	desc 'Manage the options of the diggit folder.'
+	command :options do |c|
+		c.desc 'Set an option'
+		c.command :set do |set|
+			set.flag %i[h hash], desc: "hash to store (format: 'foo=bar,baz=val1|val2')", type: Hash, default_value: {}
+			set.action do |_global_options, options, _args|
+				Diggit::Dig.it.options.merge!(options[:h])
+				Diggit::Dig.it.save_options
+			end
+		end
+		c.desc 'Display the options'
+		c.command :show do |show|
+			show.action do |_global_options, _options, _args|
+				Log.info Diggit::Dig.it.options
+			end
+		end
+		c.default_command :show
+	end
+
 	desc 'Display the status of the diggit folder.'
 	command :status do |c|
 		c.action do |_global_options, _options, _args|
@@ -235,22 +288,6 @@ module Diggit
 		end
 		c.default_command :perform
 	end
-	pre do |globals, _command, _options, _args|
-		Diggit::Dig.init globals[:f]
-		Log.level = :fine if globals[:v]
-		true
-	end
-
-	post do |_global, _command, _options, _args|
-			# Post logic here, skips_post to skip commands
-	end
-
-	on_error do |exception|
-		Log.error "Error running diggit."
-		Log.error exception.message
-		Log.info exception.backtrace.join("\n")
-		false
-	end
 
 	exit run(ARGV)
 end

data/lib/dgit/core.rb

@@ -22,19 +22,13 @@ require 'singleton'
 require_relative 'log'
 require_relative 'entries'
 
-class Dummy
-	def initialize(_)
-		Object.new
-	end
-end
-
 Oj.default_options = Oj.default_options.merge(
 		mode: :object,
 		indent: 2,
 		auto_define: true,
+		ignore: [Rugged::Repository],
 		circular: true
 )
-Oj.register_odd(Rugged::Repository, Dummy, :new, :to_s)
 
 class String
 	# Returns a underscore cased version of the string.

data/lib/dgit/version.rb

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

data/plugins/addon/out.rb

@@ -50,6 +50,13 @@ class Out < Diggit::Addon
 		File.join(@out, *paths)
 	end
 
+	# Get an output path for an analysis bound to a source.
+	# @param analysis [Analysis] an analysis object.
+	# @return [String] the absolute path.
+	def out_path_for_analysis(analysis, *paths)
+		out_path(analysis.name, analysis.source.id, *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.
@@ -57,10 +64,22 @@ class Out < Diggit::Addon
 		File.join(@tmp, *paths)
 	end
 
+	# Get a temporary path for an analysis bound to a source.
+	# @param analysis [Analysis] an analysis object.
+	# @return [String] the absolute path.
+	def tmp_path_for_analysis(analysis, *paths)
+		tmp_path(analysis.name, analysis.source.id, *paths)
+	end
+
 	# Clean the output and temporary folders.
 	# @return [void]
-	def clean
+	def clean_all
 		FileUtils.rm_rf(@out)
 		FileUtils.rm_rf(@tmp)
 	end
+
+	def clean_analysis(analysis)
+		FileUtils.rm_rf(out_path_for_analysis(analysis))
+		FileUtils.rm_rf(tmp_path_for_analysis(analysis))
+	end
 end

data/plugins/analysis/conflict_merge.rb

@@ -36,7 +36,7 @@ class ConflictMerge < Diggit::Analysis
 		walker.sorting(Rugged::SORT_TOPO | Rugged::SORT_REVERSE)
 		walker.push(repo.head.name)
 		walker.each do |commit|
-			out_dir = out.out_path(source.id, commit.oid)
+			out_dir = out.out_path_for_analysis(self, commit.oid)
 			parents = commit.parents
 			next unless parents.size > 1
 			left = parents[0]
@@ -114,6 +114,6 @@ class ConflictMerge < Diggit::Analysis
 	end
 
 	def clean
-		out.clean
+		out.clean_analysis(self)
 	end
 end

data/plugins/analysis/javadoc.rb

@@ -32,6 +32,7 @@ class Javadoc < Diggit::Analysis
 	end
 
 	def run
+		FileUtils.mkdir_p(out.out_path_for_analysis(self))
 		files = Dir["#{@source.folder}/src/main/java/**/*.java"]
 		puts "#{files.length} files to process"
 		db = {}
@@ -43,7 +44,7 @@ class Javadoc < Diggit::Analysis
 			db[f] = index_methods(doc)
 		end
 
-		Oj.to_file("#{out.out}/#{@source.id}.json", db)
+		Oj.to_file(file, db)
 	end
 
 	def index_methods(doc)
@@ -176,6 +177,10 @@ class Javadoc < Diggit::Analysis
 	end
 
 	def clean
-		out.clean
+		out.clean_analysis(self)
+	end
+
+	def file
+		out.out_path_for_analysis(self, "javadoc.json")
 	end
 end

data/plugins/analysis/{tex.rb → words.rb}

@@ -17,29 +17,35 @@
 
 require 'fileutils'
 
-class Tex < Diggit::Analysis
+class Words < Diggit::Analysis
 	require_addons 'out'
 
 	def initialize(options)
 		super(options)
+		@extensions = options[name]
 	end
 
 	def run
+		FileUtils.mkdir_p(out.out_path_for_analysis(self))
 		walker = Rugged::Walker.new(repo)
 		walker.sorting(Rugged::SORT_TOPO | Rugged::SORT_REVERSE)
 		walker.push(repo.head.name)
 		walker.each do |c|
 			repo.checkout(c.oid, { strategy: %i[force remove_untracked] })
-			words = Dir["**/*.tex"].reduce(0) { |acc, elem| acc + `cat "#{elem}" | wc -w`.to_i }
+			words = words_files.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
 
+	def words_files
+		@extensions.reduce([]) { |acc, elem| acc + Dir["**/*.#{elem}"] }
+	end
+
 	def clean
-		out.clean
+		out.clean_analysis(self)
 	end
 
 	def file
-		"#{out.out}/words.csv"
+		out.out_path_for_analysis(self, "words.csv")
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diggit
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Jean-Rémy Falleri
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-23 00:00:00.000000000 Z
+date: 2018-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: formatador
@@ -47,14 +47,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rugged
   requirement: !ruby/object:Gem::Requirement
@@ -204,7 +210,7 @@ files:
 - plugins/analysis/cloc_per_file.rb
 - plugins/analysis/conflict_merge.rb
 - plugins/analysis/javadoc.rb
-- plugins/analysis/tex.rb
+- plugins/analysis/words.rb
 - spec/cli_spec.rb
 - spec/core_spec.rb
 - spec/dgit/plugins/addon/test_addon.rb