diggit 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e5d600c1a153b908c21f736888189e787cd37b9dfe8b825dd2b09e6d87d3504
-  data.tar.gz: be325f5cfb4e9145e8e6d5b527c4a518f6852687849028e7c4ce06fcbb39e0e2
+  metadata.gz: c85e3eadbde6b35542b116a284a6c1b1bba40f0e92dc902c407deb3098d26c02
+  data.tar.gz: c941389bb90f76bc46ac997a574220dea844034692f080134b73db31f9e0feea
 SHA512:
-  metadata.gz: 39fca80590e7d9c00936319c5363605fd7e8b9653d200c638b082f4da3a6efa17bfd3c11e5e211a3e8392702beb3c9e4e9f7e7414df5542afcdde4e4a042b09e
-  data.tar.gz: 58660bd365187ac0d816571bd5d7078202a8a0a7401f405f4afad567e82275432334202300d52509c392e8aedcbea5dd24978d328e8c49099db1e04403dddc82
+  metadata.gz: a411fab663670f3662124714fb17eb40b8e5f5d715b6919ccafa1f257884f791c756ed03923ef01aaad67c3718c924e6efd79ee462ca38ab9d0bf3b36ec50d90
+  data.tar.gz: 50845221483a94d5a8527f532e9a951f28e991ad7497ff4ddf83e7b6002f933bb36e534daf0e1ed5ab54b654f9963817b123650c14212baf5501a08faddb180e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog of Diggit
 
+### Version 3.0.3
+* New yard analysis
+* Add code of conduct
+* Fix bug with oid being erased in .dgit/sources
+
 ### 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

data/lib/dgit/core.rb

@@ -74,6 +74,11 @@ module Diggit
 			@repository = nil
 		end
 
+		def full_url
+			return @url if @oid.eql?(DEFAULT_BRANCH)
+			"#{@url}|#{@oid}"
+		end
+
 		def id
 			@url.id
 		end
@@ -386,7 +391,7 @@ module Diggit
 		# 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) } }
+			File.open(config_path(DGIT_SOURCES), "w") { |f| @journal.sources.each { |source| f.puts(source.full_url) } }
 			Oj.to_file(config_path(DGIT_JOURNAL), @journal)
 		end
 

data/lib/dgit/version.rb

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

data/plugins/analysis/yard_dup.rb

@@ -0,0 +1,119 @@
+# 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 2018 Jean-Rémy Falleri <jr.falleri@gmail.com>
+
+require 'yaml'
+require 'yard'
+require 'levenshtein'
+require 'gruff'
+
+# List all yardoc duplications
+class YardDup < Diggit::Analysis
+	require_addons 'out'
+
+	def initialize(options)
+		super(options)
+	end
+
+	def run
+		Log.info "processing yardoc of #{@source.id}"
+		out_dir = out.out_path_for_analysis(self)
+		FileUtils.mkdir_p(out_dir)
+		doc_hash = {}
+		YARD::Registry.clear
+		YARD::Registry.load(Dir["#{source.folder}/**/*.rb"], true)
+		objects = YARD::Registry.all(:method)
+		Log.info "processing #{objects.size} documented methods"
+		objects.each do |obj|
+			insert_to_map("@main #{obj.docstring}", doc_hash, obj) unless obj.docstring.empty?
+			obj.tags.each do |tag|
+				next if tag.nil?
+				tag_tokens = []
+				tag_tokens << "@#{tag.tag_name}" unless tag.tag_name.nil?
+				tag_tokens << tag.types.join(',') unless tag.types.nil? || tag.types.empty?
+				tag_tokens << tag.text unless tag.text.nil?
+				insert_to_map(tag_tokens.join(' '), doc_hash, obj)
+			end
+		end
+		write_duplications(File.join(out_dir, "duplications.txt"), doc_hash)
+		puts_duplicated_methods(doc_hash)
+		plot_duplications(File.join(out_dir, "duplications.png"), doc_hash)
+		write_near_miss(File.join(out_dir, "near-miss.txt"), doc_hash)
+	end
+
+	def similarity(s1, s2)
+		d_norm = Levenshtein.distance(s1, s2).to_f / [s1.size.to_f, s2.size.to_f].max
+		1 - d_norm
+	end
+
+	def puts_duplicated_methods(doc_hash)
+		obj_hash = {}
+		doc_hash.each_value do |value|
+			value.each { |obj| obj_hash[obj] = true } if value.size > 2
+		end
+		Log.info "#{obj_hash.each_key.to_a.size} method involved in duplications"
+	end
+
+	def write_duplications(file, doc_hash)
+		File.open(file, 'w') do |f|
+			doc_hash.each { |key, value| f.write "#{key} (#{value.size}) #{value}\n" if value.size > 1 }
+		end
+	end
+
+	def plot_duplications(file, doc_hash)
+		dup_hash = {}
+		doc_hash.each_value do |value|
+			dup_hash[value.size] = if dup_hash.key?(value.size)
+																											dup_hash[value.size] + 1
+																										else
+																											1
+																										end
+		end
+		g = Gruff::Bar.new
+		g.hide_legend = true
+		dup_numbers = 2..dup_hash.each_key.to_a.max
+		dup_numbers.each do |dup|
+			if dup_hash.key?(dup)
+				g.data(dup, dup_hash[dup])
+			else
+				g.data(dup, 0)
+			end
+		end
+		g.write(file)
+	end
+
+	def write_near_miss(file, doc_hash)
+		keys = doc_hash.each_key.to_a
+		return if keys.size < 2
+		File.open(file, 'w') do |f|
+			(0..(keys.size - 2)).each do |i|
+				key1 = keys[i]
+				key2 = keys[i + 1]
+				sim = similarity(key1, key2)
+				f.write "(#{sim}) #{key1} || #{key2}\n" if sim > 0.8
+			end
+		end
+	end
+
+	def insert_to_map(key, hash, obj)
+		hash[key] = [] unless hash.key?(key)
+		hash[key] << "#{obj.file} #{obj.path}"
+	end
+
+	def clean
+		out.clean_analysis(self)
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diggit
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Jean-Rémy Falleri
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-27 00:00:00.000000000 Z
+date: 2018-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: formatador
@@ -211,6 +211,7 @@ files:
 - plugins/analysis/conflict_merge.rb
 - plugins/analysis/javadoc.rb
 - plugins/analysis/words.rb
+- plugins/analysis/yard_dup.rb
 - spec/cli_spec.rb
 - spec/core_spec.rb
 - spec/dgit/plugins/addon/test_addon.rb
@@ -247,7 +248,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: A Git repository analysis tool.