svn_log 0.0.1 → 0.0.2

data/.gitignore

@@ -1,4 +1,3 @@
 *.gem
 .bundle
-Gemfile.lock
 pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.2@svn_log
+rvm use 1.9.3-head@svn_log

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    svn_log (0.0.1)
+      nokogiri
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    nokogiri (1.5.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  svn_log!

data/README.md

@@ -0,0 +1,10 @@
+Based upon the idea of Michael Feathers - that we should gather data from our
+code repositories.
+
+Also written to continue to learn Ruby and making Gems.
+
+It simply uses svn log to get data from the repository and then parses it into
+data objects which could then be consumed by other applications for graphing
+trends etc.
+
+

data/Rakefile

@@ -5,11 +5,5 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = ['--format', 'progress' ]
 end
 
-desc "Run all specs with RCov"
-RSpec::Core::RakeTask.new(:rcov) do |t|
-  t.rcov = true
-  t.rcov_opts = ['--text-report', '--save', 'coverage.info', '--exclude', 'spec_helper', '--exclude', '^/']
-end
-
 task :default => [:spec]
 

data/TODO.md

@@ -0,0 +1,17 @@
+	/* vim: set filetype=markdown : */ 
+
+* DONE Change to parsing XML - needed to do good job of getting list of files
+* figure out here doc so i can properly test newline problem i struggled with.
+* DONE parse svn log output into some sort of object thingie
+ * DONE revision
+ * DONE user
+ * DONE date and time
+ * DONE files 
+ * DONE files (and the type of change (add, modify, delete)
+ * DONE comments
+* make logevent inspect a generated output instead of hardcoding all attributes
+* collate said data along different axis:
+ * user
+ * date
+ * file
+ * file collections

data/bin/svn_log

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.dirname(__FILE__) + '/../lib/'
+
+location = ARGV[0]
+
+require 'svn_log'
+
+raw_log = SvnLog::Raw.log location
+
+puts LogParser.new(raw_log).events.inspect
+
+

data/lib/svn_log.rb

@@ -2,4 +2,6 @@ require "svn_log/version"
 
 module SvnLog
   require 'svn_log/raw'
+  require 'svn_log/log_parser'
+  require 'svn_log/log_event'
 end

data/lib/svn_log/log_event.rb

@@ -0,0 +1,21 @@
+require 'date'
+require 'svn_log/modification'
+
+class LogEvent
+  attr_reader :revision
+  attr_reader :user
+  attr_reader :timestamp
+  attr_reader :change_list
+  attr_reader :message
+
+  def initialize(log_event)
+    @revision = log_event.attribute('revision').value
+    @user = log_event.xpath('author').text
+    @timestamp = DateTime.parse(log_event.xpath('date').text)
+    @message = log_event.xpath('msg').text
+    @change_list = log_event.xpath('paths/path').collect do |path|
+      Modification.parse(path)
+    end
+  end
+
+end

data/lib/svn_log/log_parser.rb

@@ -0,0 +1,14 @@
+require 'svn_log/log_event'
+require 'nokogiri'
+
+class LogParser
+  attr_reader :events
+
+  def initialize(log)
+    doc = Nokogiri::XML(log).xpath('log/logentry')
+    @events = doc.collect do |e|
+      LogEvent.new e
+    end
+  end
+end
+

data/lib/svn_log/modification.rb

@@ -0,0 +1,25 @@
+require 'nokogiri'
+
+class Modification
+  ADD='A'
+  DELETE='D'
+  MODIFY='M'
+
+  attr_reader :type
+  attr_reader :path
+
+  def initialize(type, path)
+    @type=type
+    @path=path
+  end
+
+  def self.parse(path)
+    Modification.new(path.attribute('action').value, path.text)
+  end
+
+  def ==(other)
+    @type == other.type &&
+      @path == other.path
+  end
+
+end

data/lib/svn_log/raw.rb

@@ -1,5 +1,7 @@
 module SvnLog
-  def raw_log
-    `svn log -vq | grep -ve '^---\|^Changed path'`
+  class Raw
+    def self.log(file_or_directory)
+      `svn log --xml -v #{file_or_directory}`
+    end
   end
 end

data/lib/svn_log/version.rb

@@ -1,3 +1,3 @@
 module SvnLog
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/log_event_spec.rb

@@ -0,0 +1,32 @@
+require 'svn_log/log_event'
+require 'nokogiri'
+
+describe LogEvent do
+  let(:log) do
+    Nokogiri::XML('
+	    <logentry revision="266">
+	      <author>verdammelt</author>
+	      <date>2008-12-30T18:04:50.418516Z</date>
+	      <paths>
+	        <path
+	          kind=""
+	          copyfrom-path="/trunk"
+	          copyfrom-rev="265"
+	          action="A">/branches/tnef2.dev</path>
+	      </paths>
+	      <msg>creating new branch for v2 rewrite
+and some other stuff</msg>
+	    </logentry>
+                  ').children.first
+  end
+
+  subject { LogEvent.new(log) }
+
+  its(:revision) { should == '266' }
+  its(:user) { should == 'verdammelt' }
+  its(:timestamp) { should == DateTime.parse('2008-12-30T18:04:50.418516Z') }
+  its(:message) { should == "creating new branch for v2 rewrite\nand some other stuff" }
+  its(:change_list) {
+    should == [Modification.new('A', '/branches/tnef2.dev')]
+  }
+end

data/spec/log_parser_spec.rb

@@ -0,0 +1,45 @@
+require 'svn_log/log_parser'
+
+describe LogParser do
+  let(:log) { '<?xml version="1.0" encoding="UTF-8"?>
+<log>
+<logentry
+   revision="266">
+<author>verdammelt</author>
+<date>2008-12-30T18:04:50.418516Z</date>
+<paths>
+<path
+   kind=""
+   copyfrom-path="/trunk"
+   copyfrom-rev="265"
+   action="A">/branches/tnef2.dev</path>
+</paths>
+<msg>creating new branch for v2 rewrite</msg>
+</logentry>
+<logentry
+   revision="265">
+<author>verdammelt</author>
+<date>2008-12-30T17:47:35.535656Z</date>
+<paths>
+<path
+   kind=""
+   action="D">/branches/tnef-13-branch</path>
+</paths>
+<msg>deleting obsolete tnef-13-branch branch</msg>
+</logentry>
+</log>' }
+
+  it "separates out the individual logs" do
+    LogParser.new(log).events.should have(2).items
+  end
+
+  it "revisions can be gleaned" do
+    LogParser.new(log).events.collect { |e| e.revision }.should == ['266', '265']
+  end
+
+  it "can see the date of the event" do
+    first_time = DateTime.parse('2008-12-30T18:04:50.418516Z')
+    second_time = DateTime.parse('2008-12-30T17:47:35.535656Z')
+    LogParser.new(log).events.collect { |e| e.timestamp }.should == [ first_time, second_time ]
+  end
+end

data/spec/modification_spec.rb

@@ -0,0 +1,39 @@
+require 'svn_log/modification'
+
+describe Modification do
+  context "basic parsing" do
+    subject {
+      Modification.parse (
+        Nokogiri::XML('<path action="A">/branches/tnef2.dev</path>').
+        children.
+        first)
+    }
+
+    its(:type) { should == Modification::ADD }
+    its(:path) { should == '/branches/tnef2.dev' }
+   end
+
+  context "specific types" do
+    it "knows add" do
+      subjectWithAction('A').type.should == Modification::ADD
+    end
+    it "modify" do
+      subjectWithAction('M').type.should == Modification::MODIFY
+    end
+    it "delete" do
+      subjectWithAction('D').type.should == Modification::DELETE
+    end
+
+    def subjectWithAction(action)
+      Modification.parse(
+        Nokogiri::XML("<path action=\"#{action}\"></path>").children.first
+      )
+    end
+  end
+
+  it "modifications can be compared with equality" do
+    Modification.new('A', 'a path').should == Modification.new('A', 'a path')
+    Modification.new('A', 'a path').should_not == Modification.new('A', 'another path')
+  end
+
+end

data/svn_log.gemspec

@@ -18,7 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency "nokogiri"
+
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"
-  s.add_development_dependency "rcov"
+  s.add_development_dependency "rake"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svn_log
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-22 00:00:00.000000000Z
+date: 2012-02-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2151930800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2151930800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2153830260 !ruby/object:Gem::Requirement
+  requirement: &2151930140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153830260
+  version_requirements: *2151930140
 - !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &2153829840 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &2151929480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,22 +43,33 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153829840
+  version_requirements: *2151929480
 description: Gather info from an SVN repository from the svn log command.
 email:
 - verdammelt@gmail.com
-executables: []
+executables:
+- svn_log
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .rvmrc
 - Gemfile
-- README
+- Gemfile.lock
+- README.md
 - Rakefile
+- TODO.md
+- bin/svn_log
 - lib/svn_log.rb
+- lib/svn_log/log_event.rb
+- lib/svn_log/log_parser.rb
+- lib/svn_log/modification.rb
 - lib/svn_log/raw.rb
 - lib/svn_log/version.rb
+- spec/log_event_spec.rb
+- spec/log_parser_spec.rb
+- spec/modification_spec.rb
 - svn_log.gemspec
 homepage: ''
 licenses: []
@@ -69,8 +91,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: svn_log
-rubygems_version: 1.8.10
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: Gather info from an SVN repository.
-test_files: []
+test_files:
+- spec/log_event_spec.rb
+- spec/log_parser_spec.rb
+- spec/modification_spec.rb