codespicuous 0.0.1

data/spec/repositories_spec.rb

@@ -0,0 +1,29 @@
+
+require 'codespicuous.rb'
+
+describe "The repositories that we are examining" do
+
+  it "can comparing two repositories and they are the same" do
+    repo1 = Repository.new("repo", "url")
+    repo2 = Repository.new("repo", "url")
+
+    expect(repo1).to eq(repo2)
+  end
+
+  it "can comparing two repositories that aren't the same" do
+    repo1 = Repository.new("repo1", "url")
+    repo2 = Repository.new("repo2", "url")
+
+    expect(repo1).not_to eq(repo2)
+  end
+
+  it "can comparing two repositories of which one has commits will throw an exception" do
+    repo1 = Repository.new("repo1", "url")
+    repo2 = Repository.new("repo1", "url")
+
+    repo1.add_commit(Commit.new)
+
+    expect{repo1 == repo2}.to raise_error(SameRepositoriesWithDifferentCommitsError)
+  end
+end
+

data/spec/svn_client_spec.rb

@@ -0,0 +1,16 @@
+
+describe "Interface towards the command line svn" do
+
+  it "Should be able to retrieve an xml log" do
+    svn = SVNClient.new
+    xmllog = double(:xmllog)
+
+    now = DateTime.new(1978)
+
+    expect(AttemptTo).to receive(:attempt_to).with('svn log: "Heh"', 5).and_yield
+    expect(CommandRunner).to receive(:run).with("svn log Heh -r{1977-01-01}:{1978-01-01} --xml").and_return(xmllog)
+
+    svn.repository("Heh")
+    expect(svn.log_xml(now.prev_year, now)).to eq(xmllog)
+  end
+end

data/spec/svn_data_collector_spec.rb

@@ -0,0 +1,93 @@
+
+describe "Collecting data from SVN" do
+
+  subject { SVNDataCollector.new(CodespicuousConfig.new) }
+
+  before (:each) do
+    @heh_repository = Repository.new("heh", "https://heh")
+    @xmllog = double(:xmllog)
+  end
+
+  it "should get the xml log from the svn client" do
+    svnclient = double(:svnclient)
+
+    expect(SVNClient).to receive(:new).and_return(svnclient)
+    expect(DateTime).to receive(:now).and_return(DateTime.new(2001))
+
+    expect(svnclient).to receive(:repository).with(@heh_repository.url)
+    expect(svnclient).to receive(:log_xml).with(DateTime.new(2000), DateTime.new(2001)).and_return(@xmllog)
+
+    expect(subject.retrieve_svn_log_from(@heh_repository)).to eq @xmllog
+  end
+
+  it "should get the xml log from file when offline" do
+    subject.config.offline = true
+    expect(File).to receive(:read).with("svnlog/heh.log").and_return(@xmllog)
+    expect(subject.retrieve_svn_log_from(@heh_repository)).to eq @xmllog
+  end
+
+  it "should parse the xml log that was retrieved from the svn client" do
+
+    svnxmlparser = double(:parser)
+    commits = Commits.new
+
+    expect(SVNLogParser).to receive(:new).and_return(svnxmlparser)
+    expect(svnxmlparser).to receive(:parse).with(@xmllog)
+    expect(svnxmlparser).to receive(:commits).and_return(commits)
+
+    expect(subject.retrieve_commits_from_log(@xmllog)).to eq commits
+  end
+
+  it "Should collect the log for one repository" do
+
+    commit = Commit.new
+    commits = Commits.new
+    commits.add(commit)
+
+    expect(subject).to receive(:puts).with("Getting svn log from repository: heh")
+    expect(subject).to receive(:retrieve_svn_log_from).with(@heh_repository).and_return(@xmllog)
+    expect(subject).to receive(:save_svn_log).with(@heh_repository, @xmllog)
+    expect(subject).to receive(:retrieve_commits_from_log).with(@xmllog).and_return(commits)
+
+    expect(subject.collect_commits_for_repository(@heh_repository)).to eq (commits)
+    expect(commit.repository).to eq @heh_repository
+  end
+
+  def create_commits_with_one_commit_in_repository repository
+    commit = Commit.new
+    commit.repository = repository
+    commits = Commits.new
+    commits.add(commit)
+    commits
+  end
+
+  it "Should collect the log for each repository and add the commits" do
+    repositories  = Repositories.new
+    wow_repository = Repository.new("wow", "https://wow")
+    repositories.add(@heh_repository)
+    repositories.add(wow_repository)
+
+    heh_commits = create_commits_with_one_commit_in_repository(@heh_repository)
+    wow_commits = create_commits_with_one_commit_in_repository(wow_repository)
+
+    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))
+  end
+
+  it "Should write the svn logs to the svnlog directory" do
+    expect(Dir).to receive(:exists?).with("svnlog").and_return(true)
+    expect(File).to receive(:write).with("svnlog/heh.log", "xmllog")
+
+    subject.save_svn_log(@heh_repository, "xmllog")
+  end
+
+  it "Should write the svn logs to the svnlog directory which must be created first" do
+    expect(Dir).to receive(:exists?).with("svnlog").and_return(false)
+    expect(Dir).to receive(:mkdir).with("svnlog")
+    expect(File).to receive(:write)
+
+    subject.save_svn_log(@heh_repository, "xmllog")
+  end
+end

data/spec/svn_log_parser_spec.rb

@@ -0,0 +1,141 @@
+
+describe "parsing the SVN logs" do
+
+  def log(text)
+    '<?xml version="1.0" encoding="UTF-8"?><log>' + text + '</log>'
+  end
+
+  def logentry(revision, author, date, message, additional_tags, paths)
+    "<logentry revision=\"#{revision}\"><author>#{author}</author><date>#{date}</date>#{additional_tags} <paths>" + paths + "</paths><msg>#{message}</msg></logentry>"
+  end
+
+  def path(action, propmods, textmods, kind, file)
+    "<path action=\"#{action}\" prop-mods=\"#{propmods}\" text-mods=\"#{textmods}\" kind=\"#{kind}\">#{file}</path>"
+  end
+
+  def log_with_default_logentry(additional_tags, paths)
+    log(logentry(1, "someone", "2017-01-01", "message", additional_tags, paths))
+  end
+
+  def log_with_paths(paths)
+    log_with_default_logentry("", paths)
+  end
+
+  subject { SVNLogParser.new }
+
+  context "SVN Log with 2 commits and 3 modified files" do
+    before(:each) do
+
+      svn_log_xml = log(
+        logentry(10, "basvodde", "2016-01-04T01:59:13", "Summary:optimize implementation.", "",
+                 path("M", true, true, "file", "/trunk/header.hpp")) +
+        logentry(5, "daniel", "2016-01-04T04:37:03.111034Z", "Exciting message", "",
+                 path("A", false, true, "file", "/trunk/otherheader.hpp") +
+                 path("M", false, true, "file", "/trunk/implementation.cpp")))
+
+      subject.xml_to_parse(svn_log_xml)
+    end
+
+    it "parses SVN log files" do
+      subject.parse
+      commits = subject.commits
+      expect(commits.amount).to eq 2
+    end
+
+    it "knows Bas had one commit" do
+      subject.parse
+      expect(subject.commits.find_by_committer("basvodde").amount).to eq 1
+    end
+
+    it "knows Bas modified properties" do
+      subject.parse
+      expect(subject.commits.find_commit(nil, "10").changes[0].changed_property?).to be true
+    end
+
+    it "knows all the details of the commit" do
+      subject.parse
+      commit = subject.commits.find_commit(nil, "10")
+      expect(commit.message).to eq "Summary:optimize implementation."
+      expect(commit.author).to eq "basvodde"
+      expect(commit.date).to eq DateTime.new(2016,1,4,1,59,13)
+    end
+
+    it "knows which files were changed in the commit" do
+      commit = subject.parse.commits.find_commit(nil, "5")
+      expect(commit.changes.size).to eq 2
+      expect(commit.changes[0].type).to eq :added
+      expect(commit.changes[1].type).to eq :modified
+      expect(commit.changes[1].file).to eq "/trunk/implementation.cpp"
+    end
+  end
+
+  context "Warn for XML elements that aren't implemented yet :)" do
+
+    it "Warns on non-log entries" do
+      expect{subject.parse(log('<notlogentry></notlogentry>'))}.to raise_error("Unexpected log entry: notlogentry")
+    end
+
+    it "Warns on unexpected attributes to logentry" do
+      expect{subject.parse(log('<logentry shouldntbehere="10"></logentry>'))}.to raise_error("Unexpected attributes log entry: shouldntbehere")
+    end
+
+    it "Warns on unexpected elements to logentry" do
+      expect{subject.parse(log_with_default_logentry('<huh></huh>', ""))}.to raise_error("Unexpected element in log entry: huh")
+    end
+
+    it "Warns on unexpected elements in path" do
+      expect{subject.parse(log_with_default_logentry("", '<path><uhm></uhm></path>'))}.to raise_error("Unexpected element in path: uhm")
+    end
+
+    it "Warns on unexpected attributes in path" do
+      expect{subject.parse(log_with_default_logentry("", '<path bleh="10"></path>'))}.to raise_error("Unexpected attributes in path: bleh")
+    end
+
+    it "Warns if attributes in path have unexpected values" do
+      expect{subject.parse(log_with_paths('<path action="T"></path>'))}.to raise_error("Unexpected value to attribute action in path: T")
+      expect{subject.parse(log_with_paths('<path action="M" prop-mods="false" text-mods="true" kind="space"></path>'))}.to raise_error("Unexpected value to attribute kind in path: space")
+    end
+
+    it "Warns by printing output on strange text-mods value. Needs to be checked what to do with it." do
+      expect(subject).to receive(:puts).with('Unexpected value to attribute text-mods in path: false')
+      subject.parse(log_with_paths('<path action="M" prop-mods="false" text-mods="false" kind="file"></path>'))
+    end
+  end
+
+  context "Less common svn log elements" do
+
+    it "Can deal with copyfrom-path" do
+      xmllog = log_with_paths('<path action="A" prop-mods="false" text-mods="true" kind="file" copyfrom-path="originalfile.cpp" copyfrom-rev="18">newfile</path>')
+      subject.parse(xmllog)
+      expect(subject.commits[0].changes[0].copyfrom).to eq "originalfile.cpp"
+      expect(subject.commits[0].changes[0].copyrev).to eq "18"
+    end
+
+    it "Can deal with deleted files" do
+      xmllog = log_with_paths(path("D", false, true, "file", "/trunk/header.hpp"))
+      subject.parse(xmllog)
+      expect(subject.commits[0].changes[0].type).to eq :deleted
+    end
+
+    it "Can deal with renames files" do
+      xmllog = log_with_paths(path("R", false, false, "file", "/trunk/header.hpp"))
+      subject.parse(xmllog)
+      expect(subject.commits[0].changes[0].type).to eq :renamed
+    end
+
+    it "text-mods can be false when the file is deleted" do
+      xmllog = log_with_paths(path("D", false, false, "file", "/trunk/header.hpp"))
+      subject.parse(xmllog)
+
+      # No exception
+    end
+
+    it "can add directories" do
+      xmllog = log_with_paths(path("A", false, false, "dir", "/trunk"))
+      subject.parse(xmllog)
+      expect(subject.commits[0].changes[0].kind).to eq :dir
+    end
+
+  end
+
+end

data/spec/teams_spec.rb

@@ -0,0 +1,16 @@
+
+describe "teams" do
+
+  it "spec_name" do
+    team = Team.new("team")
+    bas = Committer.create_committer("basv", "Bas", "Vodde", "basv@wow.com", team)
+    team.add_member(bas)
+
+    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
+  end
+
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: codespicuous
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bas Vodde
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: attempt_to
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+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: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/codespicuous
+- bin/filezilla/codespicuous.yaml
+- bin/filezilla/committers.csv
+- bin/filezilla/svnlog/filezilla.log
+- bin/filezilla/svnlog/python.log
+- bin/filezilla/svnlog/xiph.log
+- codespicuous.gemspec
+- lib/codespicuous.rb
+- lib/codespicuous/codespicuous.rb
+- lib/codespicuous/codespicuous_config.rb
+- lib/codespicuous/codespicuousconfigurator.rb
+- lib/codespicuous/commandrunner.rb
+- lib/codespicuous/commithistory.rb
+- lib/codespicuous/commithistory_builder.rb
+- lib/codespicuous/commits.rb
+- lib/codespicuous/commitstatistics.rb
+- lib/codespicuous/committer.rb
+- lib/codespicuous/danielparser.rb
+- lib/codespicuous/dateutil.rb
+- lib/codespicuous/metrics_generator.rb
+- lib/codespicuous/metrics_generator_csv.rb
+- lib/codespicuous/metrics_generator_daniel.rb
+- lib/codespicuous/participantsparser_from_csv.rb
+- lib/codespicuous/repositories.rb
+- lib/codespicuous/repository_lister.rb
+- lib/codespicuous/svn_client.rb
+- lib/codespicuous/svn_data_collector.rb
+- lib/codespicuous/svn_log_parser.rb
+- lib/codespicuous/teams.rb
+- lib/codespicuous/version.rb
+- spec/codespicuous_spec.rb
+- spec/codespicuousconfigurator_spec.rb
+- spec/commithistories_data.rb
+- spec/commithistory_spec.rb
+- spec/commits_spec.rb
+- spec/committers_spec.rb
+- spec/danielparser_spec.rb
+- spec/integration_filezilla_spec.rb
+- spec/metrics_generator_csv_spec.rb
+- spec/metrics_generator_daniel_spec.rb
+- spec/metrics_generator_spec.rb
+- spec/repositories_spec.rb
+- spec/svn_client_spec.rb
+- spec/svn_data_collector_spec.rb
+- spec/svn_log_parser_spec.rb
+- spec/teams_spec.rb
+homepage: https://github.com/basvodde/codespicuous
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Codespicuous is a tool for generating team based metrics from code
+test_files: []