codespicuous 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c9e7658c0084a439e6c7a6762410a263eafef15
-  data.tar.gz: 2153cbf4df876dc4ddf7f697b6f67b9f396517ce
+  metadata.gz: 2f6aa844f077caec750d39a33e9c748daca60eed
+  data.tar.gz: 66f2b73f5bfe77d9bee7f12c20fbf0916eb46138
 SHA512:
-  metadata.gz: 29678e91eb3a64c31c28fd764eb8c4c27a6dfd4ab3cbf3a2697255671e4823bc3ce13e7c9615fadedb546f8e655593eca3ff961f130a6a9f7f659a6e84e70bb0
-  data.tar.gz: 01c4e1d04c671d7059f300339a264400525da87d51fbd9932e3f07d9db398cbda80495ea316e17d430ea6236a04b28260d44c5c8df5bc3f7a555b987d997e902
+  metadata.gz: 6fb02298619c7efe10bb65731cf6023d92ed9e7e2fd59042e01f9f90a8f1cfc4a330898569565badf7ecab0c05293b04b7c34b83696d66e6d2b6b7b8a63fae01
+  data.tar.gz: f880b34a43da171ee189fd8ba3e3d6ad66c6c466702902e23ecd2df0f1c505fc4fbff2629996e3cd19c9417d3278885b49aa59e7db0c1c9d330d9df40aef7262

data/codespicuous.gemspec

@@ -6,6 +6,7 @@ Gem::Specification.new do |gem|
   gem.version = Codespicuous::VERSION
   gem.date    = Date.today.to_s
   gem.license = "MIT"
+  gem.executables = [ "codespicuous" ]
 
   gem.summary = "Codespicuous is a tool for generating team based metrics from code"
   gem.description = "Codespicuous is a tool for generating several different metrics from codebases to gain insight in how the teams are working."

data/lib/codespicuous/codespicuous.rb

@@ -7,6 +7,7 @@ class Codespicuous
 
   def initialize
     @config = CodespicuousConfig.new
+    @commit_history = CommitHistory.new
   end
 
   def run(argv)
@@ -31,16 +32,14 @@ class Codespicuous
     configurator = CodespicuousConfigurator.new(@config)
     return false unless configurator.configure(argv)
 
-    @repositories = configurator.repositories
-    @committers = configurator.committers
-    @teams = configurator.teams
+    @commit_history.configure(configurator.teams, configurator.repositories)
 
     true
   end
 
   def collect
-    collector = SVNDataCollector.new(config)
-    @commit_history = collector.collect_commit_history(repositories)
+    collector = SVNDataCollector.new(config, @commit_history)
+    collector.collect_commit_history(@commit_history.repositories)
   end
 
   def generate_output

data/lib/codespicuous/codespicuousconfigurator.rb

@@ -3,7 +3,7 @@ require 'yaml'
 class CodespicuousConfigurator
 
 
-  attr_reader :repositories, :repositories_to_check, :committers, :teams, :config
+  attr_reader :repositories, :repositories_to_check, :teams, :config
 
   def initialize(config)
 
@@ -12,7 +12,6 @@ class CodespicuousConfigurator
     @repositories = Repositories.new
     @repositories_to_check = Repositories.new
 
-    @committers = Committers.new
     @teams = Teams.new
   end
 
@@ -63,7 +62,7 @@ class CodespicuousConfigurator
     puts "** Configuring options with \"#{config.path_to_configuration_file}\""
     yaml_content = YAML::load(File.read(config.path_to_configuration_file))
     config.offline = yaml_content["offline"] if yaml_content["offline"]
-    #{@filezilla_path#{@filezilla_path}}yaml_content
+    yaml_content
   end
 
   def postprocess_yaml_configuration_repositories(yaml_content)
@@ -102,35 +101,37 @@ class CodespicuousConfigurator
   end
 
   def postprocess_yaml_configuration_committers(yaml_content)
-    teams = yaml_content["teams"] || []
+    teams_yaml = yaml_content["teams"] || []
 
-    teams.each { |team_name, team_members|
-      new_team = Team.new(team_name)
+    teams_yaml.each do |team_name, team_members|
+
+      committers = Committers.new
       team_members.each { |person|
-        committer = Committer.create_committer(person["Login"], person["First Name"], person["Last Name"], person["Email"], new_team)
-        new_team.add_member(committer)
-        @committers.add(committer)
-        @teams.add(new_team)
+        committers.add(Committer.create_committer(person["Login"], person["First Name"], person["Last Name"], person["Email"]))
       }
-    }
+
+      unless committers.empty?
+        new_team = Team.new(team_name)
+        new_team.add_members(committers)
+        @teams.add(new_team)
+      end
+    end
   end
 
   def find_alternative_configuration_files_for_committers
-    return unless committers.empty?
+    return unless teams.empty?
     return unless File.exist?("committers.csv")
 
     puts '** Configuring committers with "committers.csv"'
 
-    @committers = Committers.new
     @teams = Teams.new
 
     CSV.parse(File.read("committers.csv"), headers: true) { |row|
-      team = @teams.team(row["Team"])
-      committer = Committer.create_committer(row["Login"], row["First Name"], row["Last Name"], row["Email"], team)
+      committer = Committer.create_committer(row["Login"], row["First Name"], row["Last Name"], row["Email"])
+
+      team = @teams.team(row["Team"] || "")
       team.add_member(committer)
-      @committers.add(committer)
     }
-    @committers
   end
 
 end

data/lib/codespicuous/commithistory.rb

@@ -4,12 +4,17 @@ class CommitHistory
 
   attr_reader :commits, :teams, :repositories, :committers
 
-  def initialize(commits = Commits.new)
+  def initialize
     @commits = Commits.new
-    @committers = Committers.new
     @teams = Teams.new
+    @committers = teams.committers
     @repositories = Repositories.new
-    add_commits(commits)
+  end
+
+  def configure(teams, repositories)
+    @teams = teams
+    @committers = teams.committers
+    @repositories = repositories
   end
 
   def add_commit(commit)

data/lib/codespicuous/committer.rb

@@ -9,12 +9,11 @@ class Committer
     @commits = Commits.new
   end
 
-  def self.create_committer(login, firstname, lastname, email, team)
+  def self.create_committer(login, firstname, lastname, email)
     committer = Committer.new(login)
     committer.first_name = firstname
     committer.last_name = lastname
     committer.email = email
-    committer.team = team
     committer
   end
 
@@ -47,6 +46,14 @@ class Committer
     @commits.amount_of_commits_to_repository_in_week(name, week_start)
   end
 
+  def committed_repositories
+    repositories = []
+    commits.each do |commit|
+      repositories.push(commit.repository)
+    end
+    repositories.uniq
+  end
+
   def ==(committer)
     username == committer.username &&
     first_name == committer.first_name &&
@@ -77,6 +84,12 @@ class Committers
     @committers[name] ||= Committer.new(name)
   end
 
+  def each
+    @committers.values.each do |committer|
+      yield committer
+    end
+  end
+
   def amount
     @committers.size
   end

data/lib/codespicuous/repository_lister.rb

@@ -4,5 +4,32 @@ class RepositoryLister
 
   def list(commit_history)
 
+    teams_and_repositories = collect_teams_and_repositories_they_committed_to(commit_history)
+
+    if teams_and_repositories.empty?
+      puts "No teams committed in any of the repositories"
+      return
+    end
+
+    print_teams_commit_to_which_repository(teams_and_repositories)
+  end
+
+  def collect_teams_and_repositories_they_committed_to(commit_history)
+    teams_and_repositories = {}
+    commit_history.teams.each do |team|
+      repositories = team.committed_repositories
+      teams_and_repositories[team.name] = repositories unless repositories.empty?
+    end
+    teams_and_repositories
+  end
+
+  def print_teams_commit_to_which_repository(teams_and_repositories)
+    teams_and_repositories.each do |team, repositories|
+      repositories_string = ""
+      repositories.each do |repository|
+        repositories_string += "  " + repository.name + "\n"
+      end
+      puts "Team \"#{team}\" committed in:\n" + repositories_string
+    end
   end
 end

data/lib/codespicuous/svn_data_collector.rb

@@ -4,7 +4,8 @@ class SVNDataCollector
 
   attr_reader :config
 
-  def initialize(config)
+  def initialize(config, commit_history = CommitHistory.new)
+    @commit_history = commit_history
     @config = config
   end
 
@@ -40,11 +41,10 @@ class SVNDataCollector
   end
 
   def collect_commit_history(repositories)
-    commit_history = CommitHistory.new
     repositories.each { | repository|
-      commit_history.add_commits(collect_commits_for_repository(repository))
+      @commit_history.add_commits(collect_commits_for_repository(repository))
     }
-    commit_history
+    @commit_history
   end
 
 end

data/lib/codespicuous/teams.rb

@@ -13,6 +13,10 @@ class Team
     member.team = self
   end
 
+  def add_members(members)
+    members.each { |member| add_member(member) }
+  end
+
   def members
     @members.values
   end
@@ -38,6 +42,16 @@ class Team
   def ==(team)
     name == team.name && members == team.members
   end
+
+  def committed_repositories
+
+    repositories = []
+
+    each_member do |member|
+      repositories += member.committed_repositories
+    end
+    repositories.uniq
+  end
 end
 
 class Teams
@@ -62,6 +76,16 @@ class Teams
     }
   end
 
+  def committers
+    committers = Committers.new
+    each_member { |team, committer| committers.add(committer) }
+    committers
+  end
+
+  def empty?
+    @teams.empty?
+  end
+
   def map(&block)
     @teams.values.map(&block)
   end

data/lib/codespicuous/version.rb

@@ -1,4 +1,4 @@
 
 module Codespicuous
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/codespicuous_spec.rb

@@ -37,27 +37,23 @@ describe "Codespicuous command line" do
   it "configures the config data" do
     configurator = CodespicuousConfigurator.new(subject.config)
     repositories = Repositories.new
-    committers = Committers.new
     teams = Teams.new
 
     expect(CodespicuousConfigurator).to receive(:new).and_return(configurator)
     expect(configurator).to receive(:configure).with(["argv"]).and_return(true)
 
     expect(configurator).to receive(:repositories).and_return(repositories)
-    expect(configurator).to receive(:committers).and_return(committers)
     expect(configurator).to receive(:teams).and_return(teams)
+    expect(subject.commit_history).to receive(:configure).with(teams, repositories)
 
     subject.configure(["argv"])
-    expect(subject.committers).to be committers
-    expect(subject.repositories).to be repositories
-    expect(subject.teams).to be teams
   end
 
   it "collects the input data" do
     collector = SVNDataCollector.new(subject.config)
     commit_history = CommitHistory.new
     expect(SVNDataCollector).to receive(:new).and_return(collector)
-    expect(collector).to receive(:collect_commit_history).with(subject.repositories).and_return(commit_history)
+    expect(collector).to receive(:collect_commit_history).with(commit_history.repositories).and_return(commit_history)
 
     subject.collect
 

data/spec/codespicuousconfigurator_spec.rb

@@ -130,14 +130,14 @@ describe "CodepicuousConfigurator reads all the config files and provides the da
   context "Parsing the teams and committers" do
 
     before (:each) do
+      @committer_bas = Committer.create_committer("basvodde", "Bas", "Vodde", "basv@wow.com")
       @team_wine = Team.new("Wine")
-      @committer_bas = Committer.create_committer("basvodde", "Bas", "Vodde", "basv@wow.com", @team_wine)
+      @team_wine.add_member(@committer_bas)
     end
 
     it "can have no committers and teams. Just empty then" do
       subject.postprocess_yaml_configuration_committers({})
 
-      expect(subject.committers).to eq Committers.new
       expect(subject.teams).to eq Teams.new
     end
 
@@ -160,15 +160,17 @@ describe "CodepicuousConfigurator reads all the config files and provides the da
       teams = Teams.new
       teams.add(@team_wine)
 
-      expect(subject.committers).to eq committers
       expect(subject.teams).to eq teams
 
     end
 
     it "will not bother checking the CSV file when it found committers already" do
-      committers = Committers.new
-      committers.add(@committer_bas)
-      expect(subject).to receive(:committers).and_return(committers)
+      teams = Teams.new
+      team = Team.new("Wine")
+      team.add_member(@committer_bas)
+      teams.add(team)
+
+      expect(subject).to receive(:teams).and_return(teams)
       expect(File).not_to receive(:exist?)
 
       subject.find_alternative_configuration_files_for_committers
@@ -179,7 +181,7 @@ describe "CodepicuousConfigurator reads all the config files and provides the da
 
       subject.find_alternative_configuration_files_for_committers
 
-      expect(subject.committers).to eq Committers.new
+      expect(subject.teams).to eq Teams.new
     end
 
     it "will read the CSV file when it exists" do
@@ -190,10 +192,12 @@ describe "CodepicuousConfigurator reads all the config files and provides the da
 
       subject.find_alternative_configuration_files_for_committers
 
-      committers = Committers.new
-      committers.add(@committer_bas)
+      teams = Teams.new
+      team = Team.new("Wine")
+      team.add_member(@committer_bas)
+      teams.add(team)
 
-      expect(subject.committers).to eq committers
+      expect(subject.teams).to eq teams
     end
 
   end

data/spec/committers_spec.rb

@@ -8,19 +8,20 @@ describe "The committers and the teams that we're examining" do
     @committers = Committers.new
     @teams = Teams.new
 
-    wine = Team.new("Wine")
-    cheese = Team.new("Cheese")
 
-    bas = Committer.create_committer("basvodde", "Bas", "Vodde", "basv@wow.com", wine)
-    janne = Committer.create_committer("janne", "Janne", "Yeah", "janne@yeah.com", cheese)
-    daniel = Committer.create_committer("daniel", "Daniel", "Hum", "daniel@hum.com", wine)
+    bas = Committer.create_committer("basvodde", "Bas", "Vodde", "basv@wow.com")
+    janne = Committer.create_committer("janne", "Janne", "Yeah", "janne@yeah.com")
+    daniel = Committer.create_committer("daniel", "Daniel", "Hum", "daniel@hum.com")
 
     @committers.add(bas)
     @committers.add(daniel)
     @committers.add(janne)
 
+    wine = Team.new("Wine")
     wine.add_member(bas)
     wine.add_member(daniel)
+
+    cheese = Team.new("Cheese")
     cheese.add_member(janne)
 
     @teams.add(wine)
@@ -48,18 +49,23 @@ describe "The committers and the teams that we're examining" do
   end
 
   it "can compare two committers" do
+    bas = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com")
+    dobbel_bas = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com")
+
     team = Team.new("team")
-    bas = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com", team)
-    dobbel_bas = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com", team)
+    team.add_member(bas)
+    team.add_member(dobbel_bas)
 
     expect(bas).to eq dobbel_bas
   end
 
   it "can compare two committers that aren't equal" do
-    team = Team.new("team")
-    bas = Committer.create_committer("basv", "Bas", "Fake", "basv@wow.com", team)
-    dobbel_bas = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com", team)
+    bas = Committer.create_committer("basv", "Bas", "Fake", "basv@wow.com")
+    dobbel_bas = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com")
 
+    team = Team.new("team")
+    team.add_member(bas)
+    team.add_member(dobbel_bas)
     expect(bas).not_to eq dobbel_bas
   end
 end

data/spec/integration_filezilla_spec.rb

@@ -35,6 +35,7 @@ describe "Integration tests using offline logs from the filezilla project" do
     expect($stdout).to receive(:puts).with("Getting svn log from repository: filezilla")
     expect($stdout).to receive(:puts).with("Getting svn log from repository: xiph")
     expect($stdout).to receive(:puts).with("Stage 3: Listing repositories committed to")
+    expect($stdout).to receive(:puts).with("Team \"wine\" committed in:\n  filezilla\n")
 
     load @codespicuous_script
   end

data/spec/repository_lister_spec.rb

@@ -0,0 +1,23 @@
+
+describe "listing which repositories the team committed to" do
+
+  subject { RepositoryLister.new }
+
+  it "informs that the team didn't commit to any of the repositories" do
+
+    expect(subject).to receive(:puts).with("No teams committed in any of the repositories")
+    subject.list(CommitHistory.new)
+  end
+
+  it "informs that one team has committed in one repository" do
+    commit_history = CommitHistoryBuilder.new.
+      in_repository("repo").
+        commits_of("basvodde").of_team("Wine").
+        at("2016-04-18").times(2).
+     build
+
+    expect(subject).to receive(:puts).with("Team \"Wine\" committed in:\n  repo\n")
+    subject.list(commit_history)
+  end
+
+end

data/spec/svn_data_collector_spec.rb

@@ -73,7 +73,9 @@ describe "Collecting data from SVN" do
     expect(subject).to receive(:collect_commits_for_repository).with(@heh_repository).and_return(heh_commits)
     expect(subject).to receive(:collect_commits_for_repository).with(wow_repository).and_return(wow_commits)
 
-    expect(subject.collect_commit_history(repositories)).to eq (CommitHistory.new(heh_commits + wow_commits))
+    commit_history = CommitHistory.new
+    commit_history.add_commits(heh_commits + wow_commits)
+    expect(subject.collect_commit_history(repositories)).to eq (commit_history)
   end
 
   it "Should write the svn logs to the svnlog directory" do

data/spec/teams_spec.rb

@@ -2,12 +2,13 @@
 describe "teams" do
 
   it "spec_name" do
+    bas = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com")
+
     team = Team.new("team")
-    bas = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com", team)
     team.add_member(bas)
 
+    bas_dobbel = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com")
     team_dobbel = Team.new("team")
-    bas_dobbel = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com", team)
     team_dobbel.add_member(bas_dobbel)
 
     expect(team).to eq team_dobbel

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codespicuous
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Bas Vodde
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2017-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -61,7 +61,8 @@ dependencies:
 description: Codespicuous is a tool for generating several different metrics from
   codebases to gain insight in how the teams are working.
 email: basv@odd-e.com
-executables: []
+executables:
+- codespicuous
 extensions: []
 extra_rdoc_files: []
 files:
@@ -111,6 +112,7 @@ files:
 - spec/metrics_generator_daniel_spec.rb
 - spec/metrics_generator_spec.rb
 - spec/repositories_spec.rb
+- spec/repository_lister_spec.rb
 - spec/svn_client_spec.rb
 - spec/svn_data_collector_spec.rb
 - spec/svn_log_parser_spec.rb