header-inserter 1.0.1

data/History.txt

@@ -0,0 +1,14 @@
+== 1.0.1 2009-03-25
+
+* New version
+  * Correcting path bugs and tweaking for release
+
+== 0.4.1 2009-03-21
+
+* 1 major enhancement:
+  * Adding support to modifications and svn
+
+== 0.0.1 2009-03-21
+
+* 1 major enhancement:
+  * Initial commit to github

data/Manifest.txt

@@ -0,0 +1,25 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile.rb
+features/get_subversion_modifications.feature
+features/retrieve_files_for_project.feature
+features/step_definitions/common_steps.rb
+features/step_definitions/get_subversion_modifications_steps.rb
+features/step_definitions/retrieve_files_for_project_steps.rb
+features/support/env.rb
+lib/header-inserter.rb
+lib/header-inserter/modification.rb
+lib/header-inserter/nil_version_control.rb
+lib/header-inserter/project.rb
+lib/header-inserter/project_file.rb
+lib/header-inserter/svn_version_control.rb
+spec/modification_spec.rb
+spec/nil_version_control_spec.rb
+spec/project-file_spec.rb
+spec/project_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/svn_version_control_spec.rb
+tasks/rspec.rake

data/PostInstall.txt

@@ -0,0 +1,58 @@
+Create a ruby script, let's say add-header.rb:
+
+require 'rubygems'
+require 'header-inserter'
+require 'header-inserter/project'
+
+header_format = """
+# Copyright (c) REPLACE_CREATE_AND_CURRENT_YEAR Hugo Corbucci
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+# This file received the following contributions:
+#   REPLACE_CREATOR - Initial API and implementation
+#   REPLACE_CONTRIBUTORS - Improvements
+#
+# It was created on REPLACE_DATE, REPLACE_TIME.
+# REPLACE_REST
+"""
+
+project = Project.new "/my/project"
+files = project.list :rb
+hooks = { "REPLACE_CREATE_AND_CURRENT_YEAR" => lambda { |file|
+									created_year = file.created_on.year;
+									year = Date.today.year
+									if created_year = Date.today.year
+									 	"#{year}"
+									else
+										"#{created_year}, #{year}" 
+									end
+								 },
+		  "REPLACE_CREATOR" => lambda { |file| file.contributors()[0] },
+		  "REPLACE_CONTRIBUTORS" => lambda { |file| contributors = file.contributors();contributors[1..contributors.size].join(", ") },
+		  "REPLACE_DATE" => lambda {|file| file.created_on.strftime("%Y/%m/%d") },
+		  "REPLACE_TIME" => lambda {|file| file.created_on.strftime("%H:%M") },
+		  "REPLACE_REST" => lambda {|file| file.original_header }
+	   }
+files.each do |file|
+	new_header = file.generate_header(header_format, hooks)
+	old_header = file.original_header
+	file.add_header new_header, old_header
+end

data/README.rdoc

@@ -0,0 +1,54 @@
+= header-inserter
+
+https://github.com/night/header-inserter/tree
+
+== DESCRIPTION:
+
+This project was created to help me insert the EPLv1.0 license into all Archimedes source code files.
+
+It should recover data from the subversion repository if needed and generated a header with the license, the years in which the copyright apply and the list of contributors for each file.
+
+== FEATURES/PROBLEMS:
+
+Feature:
+- Lists all files of a certain extension within a directory
+
+== SYNOPSIS:
+
+Create a new project:
+project = Project.new "/tmp/my/project/"
+List "rb" files in it:
+files = project.list "rb"
+
+== REQUIREMENTS:
+
+All you need is ruby 1.8 which you probably have since you are installing a gem.
+
+== INSTALL:
+
+sudo gem install header-inserter
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Hugo Corbucci
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile.rb

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/header-inserter'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('header-inserter', HeaderInserter::VERSION) do |p|
+  p.developer('FIXME full name', 'FIXME email')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+task :default => [:spec, :features]

data/features/get_subversion_modifications.feature

@@ -0,0 +1,26 @@
+Feature: Retrieve the history of a file from subversion
+	In order to present the full data of a file
+	Files should allow to
+	retrieve modifications made to them over time through the subversion repository
+	
+	Scenario: History of a non shared file
+		Given a file not version controlled
+		When I retrieve its history
+		Then I should receive an empty history
+
+	Scenario: History of a one version shared file
+		Given a file recently under version control
+		When I retrieve its history
+		Then I should receive a history with modifications:
+		| revision | author        | date                | log                                      |
+		| 1458     | hugo.corbucci | 2009-03-23 12:00:00 | Test file for the header-insert project. |
+
+	Scenario: History of an old multi-version shared file
+		Given a file under version control for some time
+		When I retrieve its history
+		Then I should receive a history with modifications:
+		| revision | author        | date                | log                                      |
+		| 1458     | hugo.corbucci | 2009-03-23 12:00:00 | Test file for the header-insert project. |
+		| 1459     | hugo.corbucci | 2009-03-23 13:00:00 | Changing it.                             |
+		| 1460     | hugo.corbucci | 2009-03-23 14:00:00 | Changing it again.                       |
+		| 1461     | hugo.corbucci | 2009-03-23 15:00:00 | Last change.                             |

data/features/retrieve_files_for_project.feature

@@ -0,0 +1,24 @@
+Feature: List all source files of a project
+	In order to control my source code
+	Maintainers should be able to
+	easily find out each source file in their project
+
+	Scenario: Source files of a non-existing project
+		Given a non-existing project
+		When I list "java" files
+		Then I should get nothing
+
+	Scenario: Source files of an empty project
+		Given an empty project
+		When I list "java" files
+		Then I should get nothing
+
+	Scenario: Source files on root of a project
+		Given a non-structured project
+		When I list "java" files
+		Then I should get ["Main.java", "MainTest.java"]
+
+	Scenario: Source files nested in a structured project
+		Given a structured project
+		When I list "java" files
+		Then I should get ["src/my/project/Main.java", "src/my/project/internal/Logic.java", "test/my/project/internal/LogicTest.java"]

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,194 @@
+def in_project_folder(&block)
+  project_folder = @active_project_folder || @tmp_root
+  FileUtils.chdir(project_folder, &block)
+end
+
+def in_home_folder(&block)
+  FileUtils.chdir(@home_path, &block)
+end
+
+Given %r{^a safe folder} do
+  FileUtils.rm_rf   @tmp_root = File.dirname(__FILE__) + "/../../tmp"
+  FileUtils.mkdir_p @tmp_root
+  FileUtils.mkdir_p @home_path = File.expand_path(File.join(@tmp_root, "home"))
+  @lib_path = File.expand_path(File.dirname(__FILE__) + '/../../lib')
+  Given "env variable $HOME set to '#{@home_path}'"
+end
+
+Given %r{^this project is active project folder} do
+  Given "a safe folder"
+  @active_project_folder = File.expand_path(File.dirname(__FILE__) + "/../..")
+end
+
+Given %r{^env variable \$([\w_]+) set to '(.*)'} do |env_var, value|
+  ENV[env_var] = value
+end
+
+def force_local_lib_override(project_name = @project_name)
+  rakefile = File.read(File.join(project_name, 'Rakefile'))
+  File.open(File.join(project_name, 'Rakefile'), "w+") do |f|
+    f << "$:.unshift('#{@lib_path}')\n"
+    f << rakefile
+  end
+end
+
+def setup_active_project_folder project_name
+  @active_project_folder = File.join(@tmp_root, project_name)
+  @project_name = project_name
+end
+
+Given %r{'(.*)' folder is deleted} do |folder|
+  in_project_folder do
+    FileUtils.rm_rf folder
+  end
+end
+
+When %r{^'(.*)' generator is invoked with arguments '(.*)'$} do |generator, arguments|
+  @stdout = StringIO.new
+  FileUtils.chdir(@active_project_folder) do
+    if Object.const_defined?("APP_ROOT")
+      APP_ROOT.replace(FileUtils.pwd)
+    else 
+      APP_ROOT = FileUtils.pwd
+    end
+    run_generator(generator, arguments.split(' '), SOURCES, :stdout => @stdout)
+  end
+  File.open(File.join(@tmp_root, "generator.out"), "w") do |f|
+    @stdout.rewind
+    f << @stdout.read
+  end
+end
+
+When %r{run executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "#{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When %r{run project executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When %r{run local executable '(.*)' with arguments '(.*)'} do |executable, arguments|
+  @stdout = File.expand_path(File.join(@tmp_root, "executable.out"))
+  executable = File.expand_path(File.join(File.dirname(__FILE__), "/../../bin", executable))
+  in_project_folder do
+    system "ruby #{executable} #{arguments} > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+When %r{^task 'rake (.*)' is invoked$} do |task|
+  @stdout = File.expand_path(File.join(@tmp_root, "tests.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "rake #{task} --trace > #{@stdout} 2> #{@stdout}"
+  end
+end
+
+Then %r{^folder '(.*)' (is|is not) created} do |folder, is|
+  in_project_folder do
+    File.exists?(folder).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then %r{^file '(.*)' (is|is not) created} do |file, is|
+  in_project_folder do
+    File.exists?(file).should(is == 'is' ? be_true : be_false)
+  end
+end
+
+Then %r{^file with name matching '(.*)' is created} do |pattern|
+  in_project_folder do
+    Dir[pattern].should_not be_empty
+  end
+end
+
+Then %r{gem file '(.*)' and generated file '(.*)' should be the same} do |gem_file, project_file|
+  File.exists?(gem_file).should be_true
+  File.exists?(project_file).should be_true
+  gem_file_contents = File.read(File.dirname(__FILE__) + "/../../#{gem_file}")
+  project_file_contents = File.read(File.join(@active_project_folder, project_file))
+  project_file_contents.should == gem_file_contents
+end
+
+Then %r{^output same as contents of '(.*)'$} do |file|
+  expected_output = File.read(File.join(File.dirname(__FILE__) + "/../expected_outputs", file))
+  actual_output = File.read(@stdout)
+  actual_output.should == expected_output
+end
+
+Then %r{^(does|does not) invoke generator '(.*)'$} do |does_invoke, generator|
+  actual_output = File.read(@stdout)
+  does_invoke == "does" ?
+    actual_output.should(match(/dependency\s+#{generator}/)) :
+    actual_output.should_not(match(/dependency\s+#{generator}/))
+end
+
+Then %r{help options '(.*)' and '(.*)' are displayed} do |opt1, opt2|
+  actual_output = File.read(@stdout)
+  actual_output.should match(/#{opt1}/)
+  actual_output.should match(/#{opt2}/)
+end
+
+Then %r{^output (does|does not) match \/(.*)\/} do |does, regex|
+  actual_output = File.read(@stdout)
+  (does == 'does') ?
+    actual_output.should(match(/#{regex}/)) :
+    actual_output.should_not(match(/#{regex}/)) 
+end
+
+Then %r{^contents of file '(.*)' (does|does not) match \/(.*)\/} do |file, does, regex|
+  in_project_folder do
+    actual_output = File.read(file)
+    (does == 'does') ?
+      actual_output.should(match(/#{regex}/)) :
+      actual_output.should_not(match(/#{regex}/))
+  end
+end
+
+Then %r{^all (\d+) tests pass} do |expected_test_count|
+  expected = %r{^#{expected_test_count} tests, \d+ assertions, 0 failures, 0 errors}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then %r{^all (\d+) examples pass} do |expected_test_count|
+  expected = %r{^#{expected_test_count} examples?, 0 failures}
+  actual_output = File.read(@stdout)
+  actual_output.should match(expected)
+end
+
+Then %r{^yaml file '(.*)' contains (\{.*\})} do |file, yaml|
+  in_project_folder do
+    yaml = eval yaml
+    YAML.load(File.read(file)).should == yaml
+  end
+end
+
+Then %r{^Rakefile can display tasks successfully} do
+  @stdout = File.expand_path(File.join(@tmp_root, "rakefile.out"))
+  FileUtils.chdir(@active_project_folder) do
+    system "rake -T > #{@stdout} 2> #{@stdout}"
+  end
+  actual_output = File.read(@stdout)
+  actual_output.should match(/^rake\s+\w+\s+#\s.*/)
+end
+
+Then %r{^task 'rake (.*)' is executed successfully} do |task|
+  @stdout.should_not be_nil
+  actual_output = File.read(@stdout)
+  actual_output.should_not match(/^Don't know how to build task '#{task}'/)
+  actual_output.should_not match(/Error/i)
+end
+
+Then %r{^gem spec key '(.*)' contains \/(.*)\/} do |key, regex|
+  in_project_folder do
+    gem_file = Dir["pkg/*.gem"].first
+    gem_spec = Gem::Specification.from_yaml(`gem spec #{gem_file}`)
+    spec_value = gem_spec.send(key.to_sym)
+    spec_value.to_s.should match(/#{regex}/)
+  end
+end

data/features/step_definitions/get_subversion_modifications_steps.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/../../lib/header-inserter/project'
+require File.dirname(__FILE__) + '/../../lib/header-inserter/project_file'
+require File.dirname(__FILE__) + '/../../lib/header-inserter/modification'
+require 'ftools'
+
+project = Project.new("/tmp/version_controlled_project")
+
+def create_file path, content
+  FileUtils.makedirs File.dirname(path)
+  file = File.new path, "w"
+  file.puts content
+  file.close
+end
+
+def obtain_file file
+  # system("svn co http://svn.archimedes.org.br/public/header-insert/#{file.path}")
+  create_file file.absolute_path, "a test"
+end
+
+Given /a file not version controlled/ do
+  @file = ProjectFile.new project, "my.file"
+  create_file @file.absolute_path, "Just a new file"
+end
+
+Given /a file recently under version control/ do
+  path = "single_mod.file"
+  @file = ProjectFile.new project, path
+  obtain_file @file
+end
+
+Given /a file under version control for some time/ do
+  path = "multiple_mods.file"
+  @file = ProjectFile.new project, path
+  obtain_file @file
+end
+
+When /I retrieve its history/ do
+  vcs = @file.version_control
+  @history = vcs.history @file
+end
+
+Then /I should receive an empty history/ do
+  @history.should == []
+end
+
+Then /I should receive a history with modifications:/ do |modifications|
+  mods = []
+  modifications.hashes.each do |hash|
+    mods << Modification.new(hash["revision"], hash["author"], hash["date"], hash["log"])
+  end
+  @history.should == mods
+end
+
+at_exit do
+  FileUtils.rm_rf project.path
+end