git-recommend 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd37e6d5a0899d26e9477ae487f378b70e823f00
-  data.tar.gz: 2bf08d57c099aa33531424a8866f2a8506f78588
+  metadata.gz: 2b3bb536c881bc0b202f0abedb9a06375422634a
+  data.tar.gz: 605d94d353fb38ff29e1d4a05fd732ad82b1a1e2
 SHA512:
-  metadata.gz: d73be1af4a07f28df93d165294d75b4a5099915b0b2145941beb43b137439006fd9429c2d8b147984f01a64599308ecaa003e00b813fd8d03be5d1dbcb4040da
-  data.tar.gz: b927bed5b8af7e4c8e67504ad92cfe4a2b530cdcc72b603b4a2e890efb3e48727581768bf89e48f2ebe62a9fd7da189b1fd6cfdf57fb83cd059dfa5d880e20ad
+  metadata.gz: 055b3a5cc3a1013ce5d493429f7c97883e4b3424a5d987393f219858fc756350b788fde6296c5059bf04a86b8ff15869ce8f5283ace77ae24499d647c987b707
+  data.tar.gz: 253345f3bfe244c11be6ca1449334c226f9a4ecfe7e7715da5ad8b26f133917bebeed87cfadf85ba97764c37ff956e2068159caa29e8f88b63b842099ac61dac

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*~

data/bin/git-recommend

@@ -1,108 +1,5 @@
 #!/usr/bin/env ruby
-require 'thor'
-require 'evoc'
-require 'vcs2json'
-require 'highline'
-
-class GitRecommend < Thor
-
-  DEFAULT_HISTORY = '.history'
-  @@in_git_repo = File.exist?('.git')
-
-  default_task :change
-  # history options
-  method_option :number, :aliases => '-n', type: :numeric, default: 10000, :desc => "The number of commits to dump"
-  # recommendation options
-  method_option :query, aliases: '-q', type: :array, required: false, desc: "Space separated list of query items"
-  method_option :query_from_file, aliases: '-f', type: :string, required: false, desc: "File with new-line separated list of query items"
-  method_option :staged, aliases: '-s', type: :boolean, required: false, desc: "Use staged files to generate recommendation"
-  method_option :unstaged, aliases: '-u', type: :boolean, required: false, desc: "Use unstaged files to generate recommendation"
-  method_option :history, :aliases => '-h', :type => :string, default: DEFAULT_HISTORY, :desc => "Path to change-history"
-  method_option :algorithm, :default => 'tarmaq0', :desc => "Which algorithm to use"
-  method_option :aggregator, :default => 'cg', :desc => "Which aggregator to use"
-  method_option :measures, aliases: '-m', type: :array, default: ['support','confidence'], desc: "Order rules on the given measures, presedence from left to right"
-  method_option :max_size, type: :numeric, default: 30, desc: "The maximum size of commits that should be considered when looking for patterns"
-  method_option :model_size, type: :numeric, default: 0, desc: "How many previous commits to consider when looking for patterns"
-  desc "change", ""
-  def change
-    # Initialize query
-    q = []
-    staged = (@@in_git_repo ? `git diff --cached --name-only`.split("\n") : [])
-    unstaged = (@@in_git_repo ? `git diff --name-only`.split("\n") : [])
-    from_command_line = (options[:query].nil? ? [] : options[:query])
-    from_file = if options[:query_from_file].nil?
-                  [] 
-                else
-                  if File.exist?(options[:query_from_file])
-                    File.read(options[:query_from_file]).split("\n")
-                  else
-                    $stderr.puts "No file found at #{options[:query_from_file]}"
-                    []
-                  end
-                end
-
-    # default to locally changed files
-    if [:staged,:unstaged,:query,:query_from_file].all? {|k| options[k].nil?}
-      if @@in_git_repo
-        q =  (staged | unstaged)
-        $stderr.puts "[default] Change recommendation based on the currently changed files\n"
-      end
-    else
-      staged = (options[:staged].nil? ? [] : staged)
-      unstaged = (options[:staged].nil? ? [] : unstaged)
-      q = (staged | unstaged | from_command_line | from_file)
-    end
-
-    # Initialize history
-    if !File.exists?(options[:history])
-      exit unless HighLine.new.agree("To recommend changes, a history cache needs to be generated, do you want to generate the default cache now? Run 'git recommend help update' for more options.")
-      GitRecommend.start(["update"])
-    end
-    # could do some validation here
-    h = Evoc::HistoryStore.initialize(path: options[:history])
-    if q.size > 0
-      $stderr.puts "Generating change recommendation for #{q.size} items"
-      q_tx = Evoc::Tx.new(id: 'query',date: Time.now, items: q)
-      h.base_history << q_tx
-
-      s = Evoc::Scenario.new({query: q_tx.items,
-                              tx_index: q_tx.index,
-                              tx_id: q_tx.id,
-                              model_size: options[:model_size],
-                              algorithm: options[:algorithm],
-                              aggregator: options[:aggregator],
-                              max_size: options[:max_size],
-                              measures: options[:measures]})
-      s.call
-      s.print
-    else
-      $stderr.puts "No changed files detected. Change some files or run with --help for more options."
-    end
-  end
-
-  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"
-  method_option :fine_grained, type: :boolean, default: true, desc: "Include fine grained change information in output"
-  method_option :ignore_comments, type: :boolean, default: false, desc: "Ignore comments when calculating diffs. Only in effect for fine grained changes."
-  method_option :ignore_whitespace, type: :boolean, default: false, desc: "Ignore whitespace when calculating diffs. Only in effect for fine grained changes."
-  method_option :residuals, type: :boolean, default: true, desc: "Consider changes that happen outside of methods"
-  desc "update", "Update/Create the history used for generating recommendations"
-  def update
-    if @@in_git_repo
-      if File.exists?(DEFAULT_HISTORY)
-        exit unless HighLine.new.agree("History already exists, do you want to replace it?")
-      end
-      $stderr.puts "Generating new history cache to #{DEFAULT_HISTORY}, this may take a while."
-      old_stdout = $stdout              # backup old stdout
-      $stdout.reopen(DEFAULT_HISTORY, 'w')   # redirect stdout to file
-      Vcs2Json::Git.new(options).parse  # write history
-      $stdout = STDOUT              # restore stdout
-    else
-      $stderr.puts "Need to be in a git repository to generate history cache."
-    end
-  end
-end
+require_relative '../lib/helper.rb'
 
 GitRecommend.start(ARGV)
 

data/bin/git-test

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/helper.rb'
+
+GitTest.start(ARGV)

data/git-recommend.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'git/recommend/version'
+require_relative 'lib/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "git-recommend"
@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.bindir        = "bin"
-  spec.executables   = ["git-recommend"]
+  spec.executables   = ["git-recommend","git-test"]
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "thor"

data/lib/git_recommend.rb

@@ -0,0 +1,101 @@
+require 'helper'
+
+class GitRecommend < Thor
+
+  DEFAULT_HISTORY = '.history'
+  @@in_git_repo = File.exist?('.git')
+
+  default_task :change
+  # history options
+  method_option :number, :aliases => '-n', type: :numeric, default: 10000, :desc => "The number of commits to dump"
+  # recommendation options
+  method_option :query, aliases: '-q', type: :array, required: false, desc: "Space separated list of query items"
+  method_option :query_from_file, aliases: '-f', type: :string, required: false, desc: "File with new-line separated list of query items"
+  method_option :staged, aliases: '-s', type: :boolean, required: false, desc: "Use staged files to generate recommendation"
+  method_option :unstaged, aliases: '-u', type: :boolean, required: false, desc: "Use unstaged files to generate recommendation"
+  method_option :history, :aliases => '-h', :type => :string, default: DEFAULT_HISTORY, :desc => "Path to change-history"
+  method_option :algorithm, :default => 'tarmaq0', :desc => "Which algorithm to use"
+  method_option :aggregator, :default => 'cg', :desc => "Which aggregator to use"
+  method_option :measures, aliases: '-m', type: :array, default: ['support','confidence'], desc: "Order rules on the given measures, presedence from left to right"
+  method_option :max_size, type: :numeric, default: 30, desc: "The maximum size of commits that should be considered when looking for patterns"
+  method_option :model_size, type: :numeric, default: 0, desc: "How many previous commits to consider when looking for patterns"
+  desc "change", ""
+  def change
+    # Initialize query
+    q = []
+    staged = (@@in_git_repo ? `git diff --cached --name-only`.split("\n") : [])
+    unstaged = (@@in_git_repo ? `git diff --name-only`.split("\n") : [])
+    from_command_line = (options[:query].nil? ? [] : options[:query])
+    from_file = if options[:query_from_file].nil?
+                  [] 
+                else
+                  if File.exist?(options[:query_from_file])
+                    File.read(options[:query_from_file]).split("\n")
+                  else
+                    $stderr.puts "No file found at #{options[:query_from_file]}"
+                    []
+                  end
+                end
+
+    # default to locally changed files
+    if [:staged,:unstaged,:query,:query_from_file].all? {|k| options[k].nil?}
+      if @@in_git_repo
+        q =  (staged | unstaged)
+        $stderr.puts "[default] Change recommendation based on the currently changed files\n"
+      end
+    else
+      staged = (options[:staged].nil? ? [] : staged)
+      unstaged = (options[:staged].nil? ? [] : unstaged)
+      q = (staged | unstaged | from_command_line | from_file)
+    end
+
+    # Initialize history
+    if !File.exists?(options[:history])
+      exit unless HighLine.new.agree("To recommend changes, a history cache needs to be generated, do you want to generate the default cache now? Run 'git recommend help update' for more options.")
+      GitRecommend.start(["update"])
+    end
+    # could do some validation here
+    h = Evoc::HistoryStore.initialize(path: options[:history])
+    if q.size > 0
+      $stderr.puts "Generating change recommendation for #{q.size} items"
+      q_tx = Evoc::Tx.new(id: 'query',date: Time.now, items: q)
+      h.base_history << q_tx
+
+      s = Evoc::Scenario.new({query: q_tx.items,
+                              tx_index: q_tx.index,
+                              tx_id: q_tx.id,
+                              model_size: options[:model_size],
+                              algorithm: options[:algorithm],
+                              aggregator: options[:aggregator],
+                              max_size: options[:max_size],
+                              measures: options[:measures]})
+      s.call
+      s.print
+    else
+      $stderr.puts "No changed files detected. Change some files or run with --help for more options."
+    end
+  end
+
+  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"
+  method_option :fine_grained, type: :boolean, default: true, desc: "Include fine grained change information in output"
+  method_option :ignore_comments, type: :boolean, default: false, desc: "Ignore comments when calculating diffs. Only in effect for fine grained changes."
+  method_option :ignore_whitespace, type: :boolean, default: false, desc: "Ignore whitespace when calculating diffs. Only in effect for fine grained changes."
+  method_option :residuals, type: :boolean, default: true, desc: "Consider changes that happen outside of methods"
+  desc "update", "Update/Create the history used for generating recommendations"
+  def update
+    if @@in_git_repo
+      if File.exists?(DEFAULT_HISTORY)
+        exit unless HighLine.new.agree("History already exists, do you want to replace it?")
+      end
+      $stderr.puts "Generating new history cache to #{DEFAULT_HISTORY}, this may take a while."
+      old_stdout = $stdout              # backup old stdout
+      $stdout.reopen(DEFAULT_HISTORY, 'w')   # redirect stdout to file
+      Vcs2Json::Git.new(options).parse  # write history
+      $stdout = STDOUT              # restore stdout
+    else
+      $stderr.puts "Need to be in a git repository to generate history cache."
+    end
+  end
+end

data/lib/git_test.rb

@@ -0,0 +1,57 @@
+require 'helper'
+
+class GitTest < Thor
+  default_task :test
+
+  method_option :mapping, aliases: '-m', type: :string, required: true, desc: "Path to test<->code mapping file"
+  method_option :change_recommendation, aliases: '-c', type: :string, required: true ,desc: "Path to change recommendation"
+  method_option :output, aliases: '-o', enum: ['csv','dot'], default: 'csv', desc: "The output format of the test recommendation"
+  desc "test", ""
+  def test
+    begin
+      mapping = CSV.read(options[:mapping], headers: true)
+      change_rec = CSV.read(options[:change_recommendation], headers: true)
+    rescue CSV::MalformedCSVError => e
+      $stderr.puts "An error occured when parsing the mapping file:\n #{e}"
+    end
+
+    test_plan = Hash.new
+    covered = Set.new
+    uniq_impacted_items = change_rec.map {|row| row["rhs"]}.to_set
+
+    change_rec.each do |row|
+      lhs = row["lhs"]
+      rhs = row["rhs"]
+      support = row["support"].to_r.to_f
+      mapping.each do |mapping_row|
+        pattern = Regexp.new(mapping_row["pattern"], Regexp::IGNORECASE)
+        test = mapping_row["test"]
+        if rhs =~ pattern
+          covered << rhs
+          if test_plan[test].nil?
+            test_plan[test] = {impact: support, covers: 1}
+          else
+            test_plan[test][:impact] += support
+            test_plan[test][:covers] += 1
+          end
+        end
+      end
+    end                          
+    # print warnings to stderr if any
+    if covered.size < uniq_impacted_items.size
+      uncovered = uniq_impacted_items - covered
+      if uncovered.size < 11
+        $stderr.puts "The following potentially impacted items were not covered by at least 1 test:\n #{uncovered.to_a.join("\n")}"
+      else
+        $stderr.puts "#{uncovered.size} potentially impacted items were not covered by at least 1 test. The first 10 were: \n #{uncovered.take(10).join("\n")}"
+      end
+    end
+
+    # print testplan to stdout
+    $stdout.puts "test,impact,covers"
+    test_plan.sort_by {|k,v| -v[:impact]}.each do |test,relevance|
+      $stdout.puts "#{test},#{relevance[:impact]},#{relevance[:covers]}"
+    end
+  end
+
+end

data/lib/helper.rb

@@ -0,0 +1,9 @@
+require 'thor'
+require 'evoc'
+require 'vcs2json'
+require 'highline'
+require 'csv'
+require 'set'
+
+require 'git_recommend'
+require 'git_test'

data/lib/{git/recommend/version.rb → version.rb}

@@ -1,5 +1,5 @@
 module Git
   module Recommend
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-recommend
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Thomas Rolfsnes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-14 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -113,6 +113,7 @@ email:
 - mail@thomasrolfsnes.com
 executables:
 - git-recommend
+- git-test
 extensions: []
 extra_rdoc_files: []
 files:
@@ -126,10 +127,13 @@ files:
 - Rakefile
 - bin/console
 - bin/git-recommend
+- bin/git-test
 - bin/setup
 - git-recommend.gemspec
-- lib/git/recommend.rb
-- lib/git/recommend/version.rb
+- lib/git_recommend.rb
+- lib/git_test.rb
+- lib/helper.rb
+- lib/version.rb
 homepage: 
 licenses:
 - MIT

data/lib/git/recommend.rb

@@ -1,7 +0,0 @@
-require "git/recommend/version"
-
-module Git
-  module Recommend
-    # Your code goes here...
-  end
-end