vcs2json 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15d7ae8091e66e7a08873392edccfcbb5a97fdd2
-  data.tar.gz: d0b611ebafc4ced7993371f8836e1f9aa81e6cbd
+  metadata.gz: 7320d73c75a5f2989baaf2789bd5809d1262da6e
+  data.tar.gz: 4e2a78f7370a848f1bf6d590d3e3b31516dab4d4
 SHA512:
-  metadata.gz: 74b531c87495036b5f7622fc58310d9a9cb81ebe1eee55e3aa2d293cd15702ec7dc46cfdbebf97c8b2843009491d78d6f1b5b5e6e16aa1ec3b69ede98bf2f18c
-  data.tar.gz: e3fa836d920cc77295a10de443419fdd11e8ddef8e901b94acf85343cb5daf6de41934df344b14ce507865952d87d78281e3b10e04206243ade963b6df3b6c7a
+  metadata.gz: c85a8e3d1aa5177349eeb3dfb0e72f0bf155d4fd9202ffdb39c630f99701d97cad527611ad1d8357e9db9cf1af6cf654b187f5a805ef5ee23f76a7a9485cbf3a
+  data.tar.gz: cb97b86a43a3006d229c8221aaabd4930c0dd9b650335926b523b313b2b2f958427f14bb2d3d3d0a5ac257fc0c409b91a4f9de41d23667b3f9094bba3015a107

data/lib/cli/main.rb

@@ -2,13 +2,15 @@ require_relative 'cli_helper'
 
 module Vcs2JsonCLI
   class Main < Thor
-    method_option :issue, :aliases => '-i', :type => :boolean, :default => false, :desc => "Attempt to extract issue ids from commit messages"
-    method_option :after, :aliases => '-a', :desc => "Only include commits after this date"
-    method_option :before, :aliases => '-b', :desc => "Only include commits before this date"
-    method_option :number, :aliases => '-n', :desc => "The number of commits to dump"
-    desc "git [options]","Make a dump of the change-history of system using git, output on stdout"
+      method_option :ignore, type: :string, desc: "Specify location of .evocignore file"
+      method_option :case_id, type: :string, desc: "Specify case identifier. Used by .evocignore etc"
+      method_option :issue, :aliases => '-i', :type => :boolean, :default => false, :desc => "Attempt to extract issue ids from commit messages"
+      method_option :after, :aliases => '-a', :desc => "Only include commits after this date"
+      method_option :before, :aliases => '-b', :desc => "Only include commits before this date"
+      method_option :number, :aliases => '-n', type: :numeric, default: 10000, :desc => "The number of commits to dump"
+      desc "git [options]","Make a dump of the change-history of system using git, output on stdout"
     def git
-          $stdout.puts Vcs2Json::Git.new(options).execute
+          Vcs2Json::Git.new(options).execute
     end
   end
 end

data/lib/vcs2json/git.rb

@@ -1,109 +1,209 @@
 require_relative '../vcs2json_helper'
 
 module Vcs2Json
-  class Git
+    class Git
+        # Generate separators between fields and commits
+        FIELD_SEP  = Digest::SHA256.hexdigest Time.new.to_s + "field_sep"
+        COMMIT_SEP = Digest::SHA256.hexdigest Time.new.to_s + "commit_sep"
+
         def initialize(opts)
-          @opts = opts
+            @opts = opts
+            self.ignore = @opts[:ignore]
+            # Create a commit hash that defaults to creating new hashes given hash[:key]
+            # so we can do 'commit[:commit][:author][:name] = .. ' without creating the :commit and :author hashes first
+            @commits = Hash.new {|h,k| h[k] = Hash.new(&h.default_proc) }
+            # place to stare empty commit ids if they are encountered
+            @empty_commits = []
+            # used to decide if we should try to search for more commits
+            @oldest_commit_in_previous_search = Time.now
         end
 
+        def execute
+            # recursively add commits as long as we have less than :number and there are still more commits to search
+            add_commits(@opts)
+            add_integer_mapping
 
-        # simply un-abbreviates the status code given by --name-status
-        def parse_status(abbreviated_status)
-          case abbreviated_status
-          when "A"
-            "added"
-          when "M"
-            "modified"
-          when "D"
-            "deleted"
-          end
+            # sort on date and prune excessive commits
+            sorted_and_pruned = @commits.sort_by {|id,commit| commit[:date]}.reverse.map {|(_,commit)| commit}.first(@opts[:number])
+
+            # print commits to stdout as json
+            $stdout.puts JSON.pretty_generate(sorted_and_pruned)
+
+            # print ids of empty commits to stderr
+            if !@empty_commits.empty?
+                STDERR.puts "EMPTY COMMITS"
+                STDERR.puts @empty_commits
+            end
+            # print additional info to stderr
+            STDERR.puts "\n\nExtracted #{sorted_and_pruned.size} commits."
         end
 
+        def ignore
+            @ignore
+        end
 
-        # attempts to parse an issue/bug id from the given commit message
-        def parse_issue(message)
-          if match = /(bug|issue) (?<id>\d+)/i.match(message)
-            return match[:id]
-          else
-            return ""
-          end
+        def ignore= path
+            default_locations = ["#{Dir.pwd}/.evocignore","~/.evocignore"]
+            paths = (path.nil? ? default_locations : [path] + default_locations)
+            file = nil
+            ignore = []
+            paths.each do |p|
+                if File.exist?(p)
+                    file = File.open(p)
+                    STDERR.puts "Loading files to ignore from #{file.path}"
+                    # return first match
+                    break
+                end
+            end
+            if file.nil?
+                STDERR.puts ".evocignore not found. Tried #{paths}. All files will be used."
+            else
+                if @opts[:case_id].nil?
+                    STDERR.puts "Id in .evocignore not specified, not ignoring any files."
+                else
+                    ignore_file = YAML.load(file)
+                    if ignore_file.key?(@opts[:case_id])
+                        ignore = ignore_file[@opts[:case_id]]
+                        if !ignore.nil?
+                            STDERR.puts "Ignoring #{ignore.size} files"
+                        end
+                    else
+                        STDERR.puts "The id: '#{@opts[:case_id]}' not found in #{file.path}"
+                    end
+                end
+            end
+            @ignore = (ignore.nil? ? [] : ignore)
+            return @ignore
+        end
+        private
+
+        def add_commits(opts)
+            add_meta_information(opts)
+            add_change_information(opts)
+
+            if @commits.size < @opts[:number]
+                oldest_commit_in_this_search = get_oldest_commit
+                if oldest_commit_in_this_search != @oldest_commit_in_previous_search
+                    # we found new commits in this search but still need more
+                    @oldest_commit_in_previous_search = oldest_commit_in_this_search
+                    add_commits(before: oldest_commit_in_this_search, number: (@opts[:number] - @commits.size)*2)
+                else
+                    STDERR.puts "\nAsked for #{@opts[:number]} commits, only found #{@commits.size} non-empty commits. Searched all the way back to #{oldest_commit_in_this_search}."
+                end
+            end
         end
 
+        def get_oldest_commit
+            oldest = nil
+            if !@commits.empty?
+                oldest = @commits.first[1][:date]
+                @commits.each do |sha,info| 
+                    if info[:date] < oldest
+                        oldest = info[:date]
+                    end
+                end
+            end
+            return oldest
+        end
 
-        def execute
-          before = @opts[:before].nil? ? '' : "--before=\"#{@opts[:before]}\""
-          after = @opts[:after].nil?   ? '' : "--after=\"#{@opts[:after]}\""
-          number = @opts[:number].nil? ? '' : "-n #{@opts[:number]}"
-          options = "#{before} #{after} #{number} --no-merges"
-
-          # Generate separators between fields and commits
-          field_sep = Digest::SHA256.hexdigest Time.new.to_s + "field_sep"
-          commit_sep = Digest::SHA256.hexdigest Time.new.to_s + "commit_sep"
-
-          # Create a new hash that defaults to creating new hashes given hash[:key]
-          # so we can do 'commit[:commit][:author][:name] = .. ' without creating the :commit and :author hashes first
-          commits = Hash.new {|h,k| h[k] = Hash.new(&h.default_proc) }
-
-          #TODO: log this =>  print "Getting metadata on the commits..\r"
-          raw_commits = `git log #{options} --pretty=format:'%H#{field_sep}%cn#{field_sep}%ce#{field_sep}%cd#{field_sep}%ad#{field_sep}%B#{commit_sep}'`
-          commits_info = raw_commits.encode('UTF-8', :invalid => :replace).split(commit_sep)
-
-          commits_info.each do |commit|
-            fields = commit.split(field_sep)
-            sha = fields[0].delete("\n") #remove astray newlines
-            commits[sha][:sha]            = sha
-            commits[sha][:name]           = fields[1]
-            commits[sha][:email]          = fields[2]
-            commits[sha][:date]           = Time.parse fields[3]
-            commits[sha][:author_date]    = Time.parse fields[4]
-            commits[sha][:message]        = fields[5]
-
-            # attempt to parse an issue id from the commit message
-            if @opts.issue?
-              commits[commit[0]][:issue] = parse_issue(commits[sha][:message])
+        def hash_2_gitoptions(opts)
+            before = opts[:before].nil? ? '' : "--before=\"#{opts[:before]}\""
+            after = opts[:after].nil?   ? '' : "--after=\"#{opts[:after]}\""
+            number = opts[:number].nil? ? '' : "-n #{opts[:number]}"
+            return "#{before} #{after} #{number} --no-merges"
+        end
+
+        def add_meta_information(opts)
+            raw_commits = `git log #{hash_2_gitoptions(opts)} --pretty=format:'%H#{FIELD_SEP}%cn#{FIELD_SEP}%ce#{FIELD_SEP}%cd#{FIELD_SEP}%ad#{FIELD_SEP}%B#{COMMIT_SEP}'`
+            commits_info = raw_commits.encode('UTF-8', :invalid => :replace).split(COMMIT_SEP)
+
+            commits_info.each do |commit|
+                fields = commit.split(FIELD_SEP)
+                sha = fields[0].delete("\n") #remove astray newlines
+                @commits[sha][:sha]            = sha
+                @commits[sha][:name]           = fields[1]
+                @commits[sha][:email]          = fields[2]
+                @commits[sha][:date]           = Time.parse fields[3]
+                @commits[sha][:author_date]    = Time.parse fields[4]
+                @commits[sha][:message]        = fields[5]
+
+                # attempt to parse an issue id from the commit message
+                if @opts[:issue]
+                    @commits[commit[0]][:issue] = parse_issue(@commits[sha][:message])
+                end
             end
-          end
-
-
-          commits_changes_type = `git log --pretty=format:'#{field_sep}%H' --name-status #{options}`.split(field_sep)
-          commits_changes_type.each do |commit|
-            if !commit.empty?
-              lines = commit.split("\n")
-              sha = lines[0]
-              commits[sha][:changes][:all] = []
-              if lines.size > 1
-                lines[1..-1].each do |line|
-                  if !line.empty?
-                    file_info = line.split("\t")
-                    file_name = file_info[1]
-                    status = file_info[0]
-                    commits[sha][:changes][:all] << file_name
-                    commits[sha][:changes][:details][file_name][:filename] = file_name
-                    commits[sha][:changes][:details][file_name][:status] = parse_status(status)
-                  end
+        end
+
+        def add_change_information(opts)
+            commits_changes_type = `git log --pretty=format:'#{FIELD_SEP}%H' --name-status #{hash_2_gitoptions(opts)}`.split(FIELD_SEP)
+            commits_changes_type.each do |commit|
+                if !commit.empty?
+                    lines = commit.split("\n")
+                    sha = lines[0]
+                    @commits[sha][:changes][:all] = []
+                    if lines.size > 1
+                        lines[1..-1].each do |line|
+                            if !line.empty?
+                                file_info = line.split("\t")
+                                file_name = file_info[1]
+                                status = file_info[0]
+                                @commits[sha][:changes][:all] << file_name
+                                @commits[sha][:changes][:details][file_name][:filename] = file_name
+                                @commits[sha][:changes][:details][file_name][:status] = parse_status(status)
+                            end
+                        end
+                    end
+                    # filter out ignored files
+                    if !self.ignore.nil?
+                        @commits[sha][:changes][:all].reject! {|i| self.ignore.include?(i)}
+                    end
+                    if @commits[sha][:changes][:all].empty?
+                        @empty_commits << sha
+                        @commits.delete(sha)
+                    end
                 end
-              end
             end
-          end
-
-          # create file_name -> integer mapping
-          mapping = Hash.new
-          index_counter = 0
-          commits.each do |sha,info|
-            integer_representation = []
-            info[:changes][:all].each do |file|
-              if mapping[file].nil?
-                mapping[file] = index_counter
-                index_counter += 1
-              end
-              integer_representation << mapping[file]
-              info[:changes][:details][file][:id] = mapping[file]
+        end
+
+        def add_integer_mapping
+            # create file_name -> integer mapping
+            mapping = Hash.new
+            index_counter = 0
+            @commits.each do |sha,info|
+                integer_representation = []
+                info[:changes][:all].each do |file|
+                    if mapping[file].nil?
+                        mapping[file] = index_counter
+                        index_counter += 1
+                    end
+                    integer_representation << mapping[file]
+                    info[:changes][:details][file][:id] = mapping[file]
+                end
+                info[:changes][:all].clear
+                info[:changes][:all] = integer_representation
             end
-            info[:changes][:all].clear
-            info[:changes][:all] = integer_representation
-          end
+        end
 
-          JSON.pretty_generate(commits.sort_by {|id,commit| commit[:date]}.reverse.map {|(sha,commit)| commit})
+        # simply un-abbreviates the status code given by --name-status
+        def parse_status(abbreviated_status)
+            case abbreviated_status
+            when "A"
+                "added"
+            when "M"
+                "modified"
+            when "D"
+                "deleted"
+            end
+        end
+
+
+        # attempts to parse an issue/bug id from the given commit message
+        def parse_issue(message)
+            if match = /(bug|issue) (?<id>\d+)/i.match(message)
+                return match[:id]
+            else
+                return ""
+            end
         end
-  end
+    end
 end

data/lib/vcs2json/version.rb

@@ -1,3 +1,3 @@
 module Vcs2json
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vcs2json
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Thomas Rolfsnes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-24 00:00:00.000000000 Z
+date: 2016-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Create JSON dumps of change history from git etc.