header-inserter 1.0.1

data/features/step_definitions/retrieve_files_for_project_steps.rb

@@ -0,0 +1,61 @@
+require File.dirname(__FILE__) + '/../../lib/header-inserter/project'
+require File.dirname(__FILE__) + '/../../lib/header-inserter/project_file'
+require 'ftools'
+
+non_existing = "/tmp/non_existing_project" + rand(1000000).to_s
+
+empty = "/tmp/empty_project" + rand(1000000).to_s
+Dir.mkdir empty
+
+non_structured = "/tmp/non_structured_project" + rand(1000000).to_s
+Dir.mkdir non_structured
+main = File.new non_structured+"/Main.java", "w"
+main.puts "class Main {}"
+main.close
+mainTest = File.new non_structured+"/MainTest.java", "w"
+mainTest.puts "class MainTest {}"
+mainTest.close
+mainTestClass = File.new non_structured+"/MainTest.class", "w"
+array = (1..500).to_a.map{|x| rand(256)}
+mainTestClass.puts array.pack("c*")
+mainTestClass.close
+
+structured = "/tmp/structured_project" + rand(1000000).to_s
+File.makedirs structured+"/src/my/project/internal"
+File.makedirs structured+"/bin/my/project/internal"
+File.makedirs structured+"/test/my/project/internal"
+main = File.new structured+"/src/my/project/Main.java", "w"
+main.puts "package my.project; class Main {}"
+main.close
+logic = File.new structured+"/src/my/project/internal/Logic.java", "w"
+logic.puts "package my.project.internal; class Logic {}"
+logic.close
+logicClass = File.new structured+"/bin/my/project/internal/Logic.class", "w"
+array = (1..500).to_a.map{|x| rand(256)}
+logicClass.puts array.pack("c*")
+logicClass.close
+logicTest = File.new structured+"/test/my/project/internal/LogicTest.java", "w"
+logicTest.puts "package my.project.internal; class LogicTest {}"
+logicTest.close
+
+Given /a[n]? (\S*) project/ do |type|
+  @project = Project.new eval(type.gsub("-","_"))
+end
+
+When /I list "(.*)" files/ do |type|
+  @files = @project.list(type.to_sym)
+end
+
+Then /I should get nothing/ do
+  @files.should == []
+end
+
+Then /I should get (\[".*"(?:, ".*")?\])/ do |list|
+  @files.sort.should == eval(list).map{|path| ProjectFile.new @project, path }.sort
+end
+
+at_exit do
+  FileUtils.rm_rf empty
+  FileUtils.rm_rf non_structured
+  FileUtils.rm_rf structured
+end

data/features/support/env.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + "/../../lib/header-inserter"
+
+gem 'cucumber'
+require 'cucumber'
+gem 'rspec'
+require 'spec'

data/lib/header-inserter.rb

@@ -0,0 +1,6 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module HeaderInserter
+  VERSION = '1.0.1'
+end

data/lib/header-inserter/modification.rb

@@ -0,0 +1,31 @@
+require 'date'
+
+class Modification
+  include Comparable
+  
+  @@revision_format = /r(\d{1,}) \| (\S+) \| (\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}) ([+|-]?\d{2})(\d{2}) .* \| \d{1,} line[s]?\n\n(.*)\n/m
+  @@svn_time_format = "%Y-%m-%d %H:%M:%S %z"
+  attr_reader :revision, :author, :date, :log
+  
+  def Modification.parse text_log
+    if @@revision_format.match text_log
+      revision = $1.to_i
+      author = $2
+      time_zone = ($4 + ":" + $5)
+      date = DateTime.strptime($3 + " " + time_zone, @@svn_time_format)
+      log = $6
+      Modification.new revision, author, date, log
+    end
+  end
+  
+  def initialize revision, author, date, log
+    @revision = revision
+    @author = author
+    @date = date
+    @log = log
+  end
+  
+  def <=> other
+    revision <=> other.revision
+  end
+end

data/lib/header-inserter/nil_version_control.rb

@@ -0,0 +1,11 @@
+class NilVersionControl
+  @@instance = self.new
+  
+  def NilVersionControl.new
+    @@instance
+  end
+  
+  def history file_path
+    []
+  end
+end

data/lib/header-inserter/project.rb

@@ -0,0 +1,47 @@
+require 'find'
+require File.dirname(__FILE__) + '/project_file'
+require File.dirname(__FILE__) + '/nil_version_control'
+require File.dirname(__FILE__) + '/svn_version_control'
+
+class Project
+  include Comparable
+  attr_reader :path
+  
+  def initialize path
+    @path = File.expand_path(path)
+  end
+  
+  def <=> other
+    @path <=> other.path
+  end
+  
+  def list file_pattern
+    if file_pattern.is_a? Symbol
+      file_pattern = /.*\.#{file_pattern.to_s}$/
+    end
+    files = []
+    Find.find @path do |entry|
+      short_entry = entry.sub /^#{@path+File::SEPARATOR}/, ""
+      if file_pattern.match short_entry
+        version_control = obtain_version_control short_entry
+        files << ProjectFile.new(self, short_entry, version_control)
+      end
+    end
+    files
+  end
+  
+  protected
+  
+  def obtain_version_control path
+    entries_path = @path + "/#{File.dirname(path)}/.svn/entries"
+    file_name = File.basename(path)
+    entries = File.new entries_path, "r"
+    contents = []
+    entries.each{|line| contents << line}
+    svn_path = contents[4].strip.gsub(/#{File.dirname(path)}/, "")
+    entry_for_file = contents.collect{|line| /^#{file_name}$/.match line }
+    return SvnVersionControl.new(svn_path) unless entry_for_file.empty?
+  rescue Errno::ENOENT
+    NilVersionControl.new
+  end
+end

data/lib/header-inserter/project_file.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/project'
+require File.dirname(__FILE__) + '/nil_version_control'
+require File.dirname(__FILE__) + '/svn_version_control'
+require 'date'
+require 'etc'
+
+class ProjectFile
+  include Comparable
+  attr_reader :project, :path, :version_control
+  
+  def initialize project, path, version_control = NilVersionControl.new
+    if project.nil?
+      @project = Project.new "/"
+    else
+      @project = project
+    end
+    @path = path
+    @version_control = version_control
+  end
+  
+  def <=> other
+    absolute_path <=> other.absolute_path
+  end
+  
+  def absolute_path
+    absolute = @project.path
+    absolute += File::SEPARATOR if @project.path != "/"
+    absolute + @path
+  end
+  
+  def original_header
+    file = File.new absolute_path, "r"
+    header = ""
+    while (line = file.readline) and not(/\s*(?:package|class|import)\s*/.match line)
+      header += line
+    end
+    header
+  rescue Errno::ENOENT
+    return nil
+  end
+  
+  def created_on
+    return Date.today if modifications.empty?
+    modifications[0].date
+  end
+  
+  def contributors
+    return [username.strip] if modifications.empty?
+    modifications.map{ |mod| mod.author.strip }.uniq
+  end
+  
+  def generate_header header, hooks
+    generated_header = header
+    hooks.keys.each do |key|
+      value = hooks[key].call(self)
+      if not value.is_a?(String)
+        puts "Error while evaluating the hook for #{key}. Returned a #{value.class} valued as '#{value}'. Calling to_s."
+      end
+      generated_header = generated_header.gsub key.to_s, value.to_s
+    end
+    generated_header
+  end
+  
+  def add_header header, old_header = nil
+    content = header
+    file = File.new absolute_path, "r"
+    file.each do |line|
+      content += line
+    end
+    file.close
+    
+    content.gsub(old_header, "") unless old_header.nil?
+    
+    file = File.new absolute_path, "w"
+    file.puts content
+    file.close
+  end
+  
+  protected
+
+  def modifications
+    @mods = version_control.history path if @mods.nil?
+    @mods
+  end
+  
+  def username
+    Etc.getlogin
+  end
+end

data/lib/header-inserter/svn_version_control.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/modification'
+
+class SvnVersionControl
+  attr_reader :path
+  @@entry_start = /^[-]{72}$/
+  @@valid = /\s*r\d{1,} \| \S+ \| .* | \d{1,} line[s]?\n\n.*\n/
+  
+  def initialize server_path
+    @path = server_path
+    @logs = {}
+  end
+
+  def retrieve_log file_path
+    if not @logs.has_key?(file_path)
+      @logs[file_path] = %x[svn log #{@path + file_path}]
+    end
+    @logs[file_path]
+  end
+  
+  def history file_path
+    mods = []
+    log = retrieve_log file_path
+    log.split(@@entry_start).each do |entry|
+      mods << Modification.parse(entry) if @@valid.match(entry)
+    end
+    mods.reverse
+  end
+end

data/spec/modification_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../lib/header-inserter/modification'
+require 'date'
+
+describe Modification do
+  it "should be created with revision number, author, date and log entry" do
+    date = Date.today
+    mod = Modification.new 1, "Hugo", date, "Just a test"
+    mod.author.should == "Hugo"
+    mod.revision.should == 1
+    mod.date.should == date
+    mod.log.should == "Just a test"
+  end
+  
+  it "should parse a complete log entry" do
+    date = DateTime.strptime "2009-03-17 17:21:03 -0300", "%Y-%m-%d %H:%M:%S %z"
+    mod = Modification.parse """r1451 | hugo.corbucci | 2009-03-17 17:21:03 -0300 (Ter, 17 Mar 2009) | 2 lines
+
+Adding the projects for erase and tests for it. I forgot it before.
+Hugo
+"""
+    mod.author.should == "hugo.corbucci"
+    mod.revision.should == 1451
+    mod.date.should == date
+    mod.log.should == "Adding the projects for erase and tests for it. I forgot it before.\nHugo"
+  end
+  
+  it "should sort according to the revision" do
+    date = Date.today - 1
+    first_mod = Modification.new 1, "Hugo", date, "Just a test"
+    second_mod = Modification.new 2, "Hugo", Date.today, "Just a test"
+    equal_mod = Modification.new 1, "Hugo", date, "Just a test"
+    (first_mod<=>second_mod).should == -1
+    (second_mod<=>first_mod).should == 1
+    (first_mod<=>first_mod).should == 0
+    (first_mod<=>equal_mod).should == 0
+  end
+end

data/spec/nil_version_control_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../lib/header-inserter/nil_version_control'
+
+describe NilVersionControl do
+  it "should have only one instance" do
+    instance1 = NilVersionControl.new
+    instance2 = NilVersionControl.new
+    instance1.should == instance2
+  end
+  
+  it "should always return an empty history" do
+    vc = NilVersionControl.new
+    vc.history("a").should == []
+    vc.history("http://svn.archimedes.org.br/public/mainarchimedes/rcparchimedes/br.org.archimedes.izpack/ArchimedesProjectSet.psf").should == []
+  end
+end

data/spec/project-file_spec.rb

@@ -0,0 +1,202 @@
+require File.dirname(__FILE__) + '/../lib/header-inserter/project'
+require File.dirname(__FILE__) + '/../lib/header-inserter/svn_version_control'
+require File.dirname(__FILE__) + '/../lib/header-inserter/modification'
+require 'ftools'
+require 'fileutils'
+
+describe ProjectFile do
+  before(:each) do
+    @project = Project.new "/tmp/header-insert-test-project"
+  end
+  
+  it "should be created with a project, a path relative to that project (assuming NilVersionControl)" do
+    file = ProjectFile.new @project, "non-existing-file.rb"
+    file.absolute_path.should == "/tmp/header-insert-test-project/non-existing-file.rb"
+    file.version_control.should be_kind_of(NilVersionControl)
+  end
+  
+  it "should be created with a project, a path relative to that project and a version control system" do
+    file = ProjectFile.new @project, "non-existing-file.rb", SvnVersionControl.new("http://svn.archimedes.org.br/public/")
+    file.absolute_path.should == "/tmp/header-insert-test-project/non-existing-file.rb"
+    file.version_control.should be_kind_of(SvnVersionControl)
+  end
+  
+  it "should be assume '/' as a root path if the project is nil" do
+    file = ProjectFile.new nil, "testfile.rb"
+    file.absolute_path.should == "/testfile.rb"
+  end
+  
+  it "should compare based on the relative path" do
+    file = ProjectFile.new @project, "a.file"
+    other_file = ProjectFile.new @project, "z.file"
+    (file<=>other_file).should == -1
+    (other_file<=>file).should == 1
+    (file<=>file).should == 0
+    (other_file<=>other_file).should == 0
+  end
+  
+  it "should equal based on the absolute and the path" do
+    file = ProjectFile.new @project, "a.file"
+    other_file = ProjectFile.new @project, "z.file"
+    equal_file = ProjectFile.new @project, "a.file"
+    
+    file.should == file
+    file.should_not == other_file
+    file.should == equal_file
+    
+    other_file.should == other_file
+    other_file.should_not == file
+    other_file.should_not == equal_file
+  end
+  
+  it "should retrieve an empty original header from a non existing file" do
+    file = ProjectFile.new @project, "a.file"
+    file.original_header.should be_nil
+  end
+  
+  it "should retrieve all the header until package from an existing file" do
+    file = ProjectFile.new @project, "my/project/A.java"
+    header = "/**\n * A simple test\n */\n\n"
+    
+    create_file file.absolute_path, "#{header}package my.project;\n\nclass A {}"
+    file.original_header.should == header
+  end
+  
+  it "should retrieve all the header until import from an existing file without package" do
+    file = ProjectFile.new @project, "A.java"
+    header = "/**\n * A simple test\n */\n\n"
+    
+    create_file file.absolute_path, "#{header}import java.util.Observable;\n\nclass A extends Observable {}"
+    file.original_header.should == header
+  end
+  
+  it "should retrieve all the header until class from an existing file without package or imports" do
+    file = ProjectFile.new @project, "A.java"
+    header = "/**\n * A simple test\n */\n\n"
+    
+    create_file file.absolute_path, "#{header}class A {}"
+    file.original_header.should == header
+  end
+  
+  it "should retrieve created on information from modifications from version control" do
+    mock_version_control = mock(NilVersionControl.new)
+    mock_version_control.should_receive(:history).with("A.java").once.and_return([])
+    file = ProjectFile.new @project, "A.java", mock_version_control
+    file.created_on.should == Date.today
+    
+    date = DateTime.parse("2009-01-01T17:32:45-03:00")
+    mock_version_control = mock(NilVersionControl.new)
+    mock_version_control.should_receive(:history).with("A.java").once.and_return([Modification.new(134, "hugo", date, "Unique entry")])
+    file = ProjectFile.new @project, "A.java", mock_version_control
+    file.created_on.should == date
+    
+    mock_version_control = mock(NilVersionControl.new)
+    date1 = DateTime.parse("2009-01-01T17:32:45-03:00")
+    date2 = DateTime.parse("2009-02-12T09:02:56+08:00")
+    date3 = DateTime.parse("2009-03-24T19:45:30+00:00")
+    mods = [Modification.new(134, "hugo", date1, "First entry"),
+            Modification.new(531, "mari", date2, "Second entry"),
+            Modification.new(1039, "hugo", date3, "Third and last entry")]
+    mock_version_control.should_receive(:history).with("A.java").once.and_return(mods)
+    file = ProjectFile.new @project, "A.java", mock_version_control
+    file.created_on.should == date1
+  end
+  
+  it "should retrieve contributors from modifications from version control with unique names sorted by first occurrence" do
+    mock_version_control = mock(NilVersionControl.new)
+    mock_version_control.should_receive(:history).with("A.java").once.and_return([])
+    file = ProjectFile.new @project, "A.java", mock_version_control
+    file.contributors.should == ["night"]
+    
+    date = DateTime.parse("2009-01-01T17:32:45-03:00")
+    mock_version_control = mock(NilVersionControl.new)
+    mock_version_control.should_receive(:history).with("A.java").once.and_return([Modification.new(134, "hugo", date, "Unique entry")])
+    file = ProjectFile.new @project, "A.java", mock_version_control
+    file.contributors.should == ["hugo"]
+    
+    mock_version_control = mock(NilVersionControl.new)
+    date1 = DateTime.parse("2009-01-01T17:32:45-03:00")
+    date2 = DateTime.parse("2009-02-12T09:02:56+08:00")
+    date3 = DateTime.parse("2009-03-24T19:45:30+00:00")
+    date4 = DateTime.parse("2009-03-24T20:01:13-03:00")
+    date5 = DateTime.parse("2009-03-24T20:11:16-03:00")
+    mods = [Modification.new(134, "hugo", date1, "First entry"),
+            Modification.new(531, "mari", date2, "Second entry"),
+            Modification.new(1039, "hugo", date3, "Third entry"),
+            Modification.new(1045, "kung", date4, "Fourth entry"),
+            Modification.new(1253, "mari", date5, "Last entry")]
+    mock_version_control.should_receive(:history).with("A.java").once.and_return(mods)
+    file = ProjectFile.new @project, "A.java", mock_version_control
+    file.contributors.should == ["hugo", "mari", "kung"]
+  end
+  
+  it "should have a nil version control by default" do
+    file = ProjectFile.new @project, "A.java"
+    header = "/**\n * A simple test\n */\n\n"
+    
+    create_file file.absolute_path, "#{header}class A {}"
+    file.version_control.should == NilVersionControl.new
+  end
+  
+  it "should retrieve a nil history if not under subversion control"
+  it "should retrieve a single modification history if recently under subversion control"
+  it "should retrieve multiple modifications history if under subversion control for a long time"
+  
+  it "should generate a header according to a header format and hooks" do
+    header = "# My fine header.\n# It has the date (REPLACE_DATE) and the first contributor (FIRST_CONTRIBUTOR).\n # And ends like nothing\n"
+    hooks = { :REPLACE_DATE => lambda { |file| file.created_on.strftime "%Y-%m-%d, %H:%M:%S" },
+              :FIRST_CONTRIBUTOR => lambda {|file| file.contributors[0] } }
+
+    expected_header = "# My fine header.\n# It has the date (2009-03-24, 21:43:58) and the first contributor (hugo).\n # And ends like nothing\n"
+    
+    date = DateTime.parse "2009-03-24T21:43:58-03:00"
+    mock_version_control = mock(NilVersionControl.new)
+    mock_version_control.should_receive(:history).with("A.java").once.and_return([Modification.new(324, "hugo", date, "Unique entry")])
+    file = ProjectFile.new @project, "A.java", mock_version_control
+    file.generate_header(header, hooks).should == expected_header
+  end
+  
+  it "should add a header at the beginning of the file" do
+    new_header = "/**\n * My fine header.\n * It has the date (2009-03-24, 21:43:58) and the first contributor (hugo).\n * And ends like nothing\n */\n\n"
+    content = "class A {}\n"
+    
+    file = ProjectFile.new @project, "A.java"
+    create_file file.absolute_path, content
+    file.add_header(new_header)
+    
+    read_content(file.absolute_path).should == new_header + content
+  end
+  
+  it "should add a header at the beginning of the file and remove the one specified" do
+    new_header = "/**\n * My fine header.\n * It has the date (2009-03-24, 21:43:58) and the first contributor (hugo).\n * And ends like nothing\n */\n\n"
+    stupid_header = "/** A stupid header */\n\n"
+    content = "#{stupid_header}class A {}\n"
+    
+    file = ProjectFile.new @project, "A.java"
+    create_file file.absolute_path, content
+    file.add_header(new_header, stupid_header)
+    
+    read_content(file.absolute_path).should == new_header + content
+  end
+  
+  after(:each) do
+    FileUtils.rm_rf @project.path
+  end
+  
+  protected
+  
+  
+  def create_file absolute_path, content
+    File.makedirs File.dirname(absolute_path)
+    file = File.new absolute_path, "w"
+    file.puts content
+    file.close
+  end
+  
+  def read_content absolute_path
+    file = File.new absolute_path, "r"
+    content = file.inject { |result , line| result + line }
+    file.close
+    content
+  end
+end