gjp 0.29.0 → 0.30.0

data/lib/gjp/limited_network_user.rb

@@ -43,7 +43,7 @@ module Gjp
 
     # determines if a user without Internet access exists
     def set_up?
-      user_exists? and firewall_rule_exists?
+      user_exists? && firewall_rule_exists?
     end
 
     # checks user existence

data/lib/gjp/maven_runner.rb

@@ -0,0 +1,47 @@
+# encoding: UTF-8
+
+module Gjp
+  # runs Maven with gjp-specific options
+  class MavenRunner < KitRunner
+    include Logger
+
+    # runs Maven in a subprocess
+    def mvn(options)
+      run_executable("#{get_maven_commandline(@project.full_path)} #{options.join(' ')}")
+    end
+
+    # runs Maven to attempt getting a source jar
+    # returns true if successful
+    def get_source_jar(group_id, artifact_id, version)
+      mvn(["dependency:get", "-Dartifact=#{group_id}:#{artifact_id}:#{version}:jar:sources", "-Dtransitive=false"])
+    end
+
+    # runs Maven to get the effective POM from an existing POM
+    # returns effective pom path or nil if not found
+    def get_effective_pom(pom_path)
+      effective_pom_path = "#{pom_path}.effective"
+      success = mvn(["help:effective-pom", "-f#{pom_path}", "-Doutput=#{File.split(effective_pom_path)[1]}"])
+      if success
+        effective_pom_path
+      else
+        nil
+      end
+    end
+
+    # returns a command line for running Maven from the specified
+    # prefix
+    def get_maven_commandline(prefix)
+      executable = find_executable("mvn")
+
+      if executable != nil
+        mvn_path = File.join(prefix, executable)
+        repo_path = File.join(prefix, "kit", "m2")
+        config_path = File.join(prefix, "kit", "m2", "settings.xml")
+
+        "#{mvn_path} -Dmaven.repo.local=#{repo_path} -s#{config_path}"
+      else
+        raise ExecutableNotFoundError.new("mvn")
+      end
+    end
+  end
+end

data/lib/gjp/pom.rb

@@ -10,14 +10,7 @@ module Gjp
       @doc = Nokogiri::XML(open(filename).read)
       @doc.remove_namespaces!
     end
-    
-    def connection_address
-      connection_nodes = @doc.xpath("//scm/connection/text()")    
-      if connection_nodes.any?
-        connection_nodes.first.to_s.sub(/^scm:/, "")
-      end
-    end
-    
+        
     def group_id
       @doc.xpath("project/groupId").text
     end
@@ -26,6 +19,10 @@ module Gjp
       @doc.xpath("project/artifactId").text
     end
     
+    def name
+      @doc.xpath("project/name").text
+    end
+
     def version
       @doc.xpath("project/version").text
     end
@@ -48,16 +45,12 @@ module Gjp
       end
     end
 
-    def parent_group_id
-      @doc.xpath("project/parent/groupId").text
-    end
-    
-    def parent_artifact_id
-      @doc.xpath("project/parent/artifactId").text
+    def scm_connection
+      @doc.xpath("project/scm/connection").text
     end
-    
-    def parent_version
-      @doc.xpath("project/parent/version").text
+
+    def scm_url
+      @doc.xpath("project/scm/url").text
     end
   end
 end

data/lib/gjp/pom_getter.rb

@@ -26,6 +26,7 @@ module Gjp
 
     # returns a pom embedded in a jar file
     def get_pom_from_jar(file)
+      log.debug("Attempting unpack of #{file} to find a POM")
       begin
         Zip::ZipFile.foreach(file) do |entry|
           if entry.name =~ /\/pom.xml$/
@@ -43,6 +44,7 @@ module Gjp
     
     # returns a pom from search.maven.org with a jar sha1 search
     def get_pom_from_sha1(file)
+      log.debug("Attempting SHA1 POM lookup for #{file}")
       begin
         if File.file?(file)
           site = MavenWebsite.new
@@ -55,24 +57,28 @@ module Gjp
             return site.download_pom(group_id, artifact_id, version), :found_via_sha1
           end
         end
-        return nil
       rescue RestClient::ResourceNotFound
-        log.error("Got an error while looking for #{file}'s SHA1 in search.maven.org")
+        log.warn("Got a 404 error while looking for #{file}'s SHA1 in search.maven.org")
       end
+      nil
     end
 
     # returns a pom from search.maven.org with a heuristic name search
     def get_pom_from_heuristic(filename)
       begin
+        log.debug("Attempting heuristic POM search for #{filename}")
         site = MavenWebsite.new
         filename = cleanup_name(filename)
         version_matcher = VersionMatcher.new
         my_artifact_id, my_version = version_matcher.split_version(filename)
+        log.debug("Guessed artifact id: #{my_artifact_id}, version: #{my_version}")
 
         result = site.search_by_name(my_artifact_id).first
+        log.debug("Artifact id search result: #{result}")
         if result != nil
           group_id, artifact_id, version = site.get_maven_id_from result
           results = site.search_by_group_id_and_artifact_id(group_id, artifact_id)
+          log.debug("All versions: #{results}")
           their_versions = results.map {|doc| doc["v"]}
           best_matched_version = if my_version != nil then version_matcher.best_match(my_version, their_versions) else their_versions.max end
           best_matched_result = (results.select{|result| result["v"] == best_matched_version}).first
@@ -83,8 +89,9 @@ module Gjp
           return site.download_pom(group_id, artifact_id, version), :found_via_heuristic
         end
       rescue RestClient::ResourceNotFound
-        log.error("Got an error while looking for #{filename}'s SHA1 in search.maven.org")
+        log.warn("Got a 404 error while looking for #{filename} heuristically in search.maven.org")
       end
+      nil
     end
 
     # get a heuristic name from a path

data/lib/gjp/project.rb

@@ -26,7 +26,7 @@ module Gjp
     # finds the project directory up in the tree, like git does
     def self.find_project_dir(starting_dir)
       result = starting_dir
-      while is_project(result) == false and result != "/"
+      while is_project(result) == false && result != "/"
         result = File.expand_path("..", result)
       end
 
@@ -37,8 +37,8 @@ module Gjp
 
     # returns true if the specified directory is a valid gjp project
     def self.is_project(dir)
-      File.directory?(File.join(dir, "src")) and
-      File.directory?(File.join(dir, "kit")) and
+      File.directory?(File.join(dir, "src")) &&
+      File.directory?(File.join(dir, "kit")) &&
       File.directory?(File.join(dir, ".git"))
     end
 
@@ -49,7 +49,7 @@ module Gjp
         dir_path = Pathname.new(File.expand_path(dir)).relative_path_from(Pathname.new(@full_path))
         components = dir_path.to_s.split(File::SEPARATOR)
 
-        if components.count >= 2 and components.first == "src" and Dir.exist?(File.join(@full_path, components[0], components[1]))
+        if components.count >= 2 && components.first == "src" && Dir.exist?(File.join(@full_path, components[0], components[1]))
           components[1]
         else
           raise NoPackageDirectoryError
@@ -210,7 +210,7 @@ module Gjp
       from_directory do
         result = []
         Find.find("src") do |file|
-          if file =~ /.jar$/ and not File.symlink?(file)
+          if file =~ /.jar$/ && !File.symlink?(file)
             new_location = File.join("kit", "jars", Pathname.new(file).split[1])
             FileUtils.mv(file, new_location)
 

data/lib/gjp/script_generator.rb

@@ -7,7 +7,8 @@ module Gjp
 
     def initialize(project, history_path)
       @project = project
-      @kit_runner = Gjp::KitRunner.new(project)
+      @ant_runner = Gjp::AntRunner.new(project)
+      @maven_runner = Gjp::MavenRunner.new(project)
       @history_path = history_path
     end
     
@@ -29,9 +30,9 @@ module Gjp
         ] +
         relevant_lines.map do |line|
           if line =~ /gjp +mvn/
-            line.gsub(/gjp +mvn/, "#{@kit_runner.get_maven_commandline("$PROJECT_PREFIX")}")
+            line.gsub(/gjp +mvn/, "#{@maven_runner.get_maven_commandline("$PROJECT_PREFIX")}")
           elsif line =~ /gjp +ant/
-            line.gsub(/gjp +ant/, "#{@kit_runner.get_ant_commandline("$PROJECT_PREFIX")}")
+            line.gsub(/gjp +ant/, "#{@ant_runner.get_ant_commandline("$PROJECT_PREFIX")}")
           else
             line
           end

data/lib/gjp/source_getter.rb

@@ -7,107 +7,38 @@ module Gjp
   class SourceGetter
     include Logger
 
+    # attempts to download a project's sources
+    def get_maven_source_jar(project, pom_path)
+      maven_runner = Gjp::MavenRunner.new(project)
+      pom = Pom.new(pom_path)
+      maven_runner.get_source_jar(pom.group_id, pom.artifact_id, pom.version)
+    end
+
     # looks for jars in maven's local repo and downloads corresponding
     # source jars
     def get_maven_source_jars(project)
-      kit_runner = Gjp::KitRunner.new(project)
+      maven_runner = Gjp::MavenRunner.new(project)
 
       project.from_directory do
         paths = Find.find(".").reject {|path| artifact_from_path(path) == nil}.sort
 
         succeded_paths = paths.select.with_index do |path, i|
-          artifact = artifact_from_path(path)
-          log.info("attempting source download for #{path} (#{artifact})")
-          status = kit_runner.mvn(["dependency:get", "-Dartifact=#{artifact}", "-Dtransitive=false"])
-          status.exitstatus == 0
+          group_id, artifact_id, version = artifact_from_path(path)
+          log.info("attempting source download for #{path} (#{group_id}:#{artifact_id}:#{version})")
+          maven_runner.get_source_jar(group_id, artifact_id, version)
         end
 
         [succeded_paths, (paths - succeded_paths)]
       end
     end
 
-    # downloads a project's source into a specified directory
-    def get_source(address, pomfile, directory)
-      log.info("downloading: #{address} in #{directory}, pomfile: #{pomfile}")
-      
-      dummy, prefix, scm_address = address.split(/^([^:]+):(.*)$/)
-      log.info("prefix: #{prefix}, scm_address: #{scm_address}")
-  	
-  		get_source_from_scm(prefix, scm_address, pomfile, directory)
-    end
-
-    # checks code out from an scm
-    def get_source_from_scm(prefix, scm_address, pomfile, directory)
-      pom = Pom.new(pomfile)
-      dir = File.join(directory, "#{pom.group_id}:#{pom.artifact_id}:#{pom.version}")
-  		begin
-  	    Dir::mkdir(dir)
-  		rescue Errno::EEXIST
-  			log.warn("Source directory exists, leaving...")
-  		end
-      
-  		if prefix == "git"
-  			get_source_from_git(scm_address, dir, pom.version)
-      elsif prefix == "svn"
-  			get_source_from_svn(scm_address, dir, pom.version)
-  		end
-    end
-
-    # checks code out of git
-  	def get_source_from_git(scm_address, dir, version)
-  		`git clone #{scm_address} #{dir}`
-  		
-  		Dir.chdir(dir) do
-  			tags = `git tag`.split("\n")
-  		  
-  			if tags.any?
-  				best_tag = get_best_tag(tags, version)		 	
-  				log.info("checking out tag: #{best_tag}")
-
-  				`git checkout #{best_tag}`
-  			end	
-  		end
-  	end
-
-    # checks code out of svn
-  	def get_source_from_svn(scm_address, dir, version)
-  		`svn checkout #{scm_address} #{dir}`
-  		
-  		Dir.chdir(dir) do
-  			tags = `svn ls "^/tags"`.split("\n")
-  			
-  			if tags.any?
-  				best_tag = get_best_tag(tags, version)		 	
-  				log.info("checking out tag: #{best_tag}")
-
-  				`svn checkout ^/tags/#{best_tag}`
-  			end
-  		end
-  	end
-
-  	# return the (heuristically) most similar tag to the specified version
-  	def get_best_tag(tags, version)
-      version_matcher = VersionMatcher.new
-
-  		versions_to_tags = Hash[
-  			*tags.map do |tag|
-  				[version_matcher.split_version(tag)[1], tag]
-  			end.flatten
-  		]
-  			
-  	  log.info("found the following versions and tags: #{versions_to_tags}")
-
-  		best_version = version_matcher.best_match(version, versions_to_tags.keys)
-  		versions_to_tags[best_version]
-  	end
-
     private
 
     # if possible, turn path into a Maven artifact name, otherwise return nil
     def artifact_from_path(path)
       match = path.match(/\.\/kit\/m2\/(.+)\/(.+)\/(.+)\/\2-\3.*\.jar$/)
       if match != nil
-        "#{match[1].gsub("/", ".")}:#{match[2]}:#{match[3]}:jar:sources"
+        [match[1].gsub("/", "."), match[2], match[3]]
       end
     end
   end

data/lib/gjp/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 
 module Gjp
-  VERSION = "0.29.0"
+  VERSION = "0.30.0"
 end

data/lib/gjp/version_matcher.rb

@@ -13,7 +13,7 @@ module Gjp
     # returns a [name, version] pair
   	def split_version(full_name)	
       matches = full_name.match(/(.*?)(?:[\.\-\_ ~,]?([0-9].*))?$/)
-      if matches != nil and matches.length > 1
+      if matches != nil && matches.length > 1
         [matches[1], matches[2]]
   		else
   			[full_string, nil]
@@ -82,7 +82,7 @@ module Gjp
       if their_chunk == nil
         their_chunk = "0"
       end
-      if my_chunk.is_i? and their_chunk.is_i?
+      if my_chunk.is_i? && their_chunk.is_i?
         return [(my_chunk.to_i - their_chunk.to_i).abs, 99].min
       else
         return [Text::Levenshtein.distance(my_chunk.upcase, their_chunk.upcase), 99].min

data/spec/lib/ant_runner_spec.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'lib/kit_runner_spec'
+
+describe Gjp::AntRunner do
+  it_behaves_like Gjp::KitRunner
+  include Gjp::Mockers
+
+  before(:each) do
+    create_mock_project
+    @kit_runner = Gjp::AntRunner.new(@project)
+  end
+
+  after(:each) do
+    delete_mock_project
+  end
+
+  describe "#get_ant_commandline"  do
+    it "returns commandline options for running Ant" do
+      executable_path = create_mock_executable("ant")
+      @project.from_directory do
+        commandline = @kit_runner.get_ant_commandline(".")
+        commandline.should eq "./#{executable_path}"
+      end
+    end
+    it "doesn't return commandline options if Ant is not available" do
+      expect { @kit_runner.get_ant_commandline(".") }.to raise_error(Gjp::ExecutableNotFoundError)
+    end
+  end
+
+  describe "#ant"  do
+    it "runs Ant" do
+      executable_path = create_mock_executable("ant")
+      @project.from_directory do
+        @kit_runner.ant(["extra-option"])
+        File.read("test_out").strip.should match /extra-option$/
+      end
+    end
+    it "doesn't run Ant if it is not available" do
+      @project.from_directory do
+        expect { @kit_runner.ant([]) }.to raise_error(Gjp::ExecutableNotFoundError)
+      end
+    end
+  end
+end

data/spec/lib/kit_runner_spec.rb

@@ -2,87 +2,16 @@
 
 require 'spec_helper'
 
-describe Gjp::KitRunner do
-
-  before(:each) do
-    @project_path = File.join("spec", "data", "test-project")
-    Dir.mkdir(@project_path)
-
-    Gjp::Project.init(@project_path)
-    @project = Gjp::Project.new(@project_path)
-    @kit_runner = Gjp::KitRunner.new(@project)
-  end
-
-  after(:each) do
-    FileUtils.rm_rf(@project_path)
-  end
+shared_examples_for Gjp::KitRunner do
+  include Gjp::Mockers
 
   describe "#find_executable"  do
     it "finds an executable in kit" do
-      executable_path = mock_executable("mvn", @project_path)
-      @kit_runner.find_executable("mvn").should eq executable_path
+      executable_path = create_mock_executable("any")
+      @kit_runner.find_executable("any").should eq executable_path
     end
     it "doesn't find a Maven executable in kit" do
-      @kit_runner.find_executable("mvn").should be_nil
-    end
-  end
-
-  describe "#get_maven_commandline"  do
-    it "returns commandline options for running maven" do
-      executable_path = mock_executable("mvn", @project_path)
-
-      @project.from_directory do
-        commandline = @kit_runner.get_maven_commandline(".")
-        commandline.should eq "./#{executable_path} -Dmaven.repo.local=./kit/m2 -s./kit/m2/settings.xml"
-      end
-    end
-    it "doesn't return commandline options if Maven is not available" do
-      expect { @kit_runner.get_maven_commandline(".") }.to raise_error(Gjp::ExecutableNotFoundError)
-    end
-  end
-
-  describe "#mvn"  do
-    it "runs maven" do
-      mock_executable("mvn", @project_path)
-      @project.from_directory do
-        @kit_runner.mvn(["extra-option"])
-        File.read("test_out").strip.should match /extra-option$/
-      end
-    end
-    it "doesn't run Maven if it is not available" do
-      @project.from_directory do
-        expect { @kit_runner.mvn([]) }.to raise_error(Gjp::ExecutableNotFoundError)
-      end
-    end
-  end
-
-
-  describe "#get_ant_commandline"  do
-    it "returns commandline options for running Ant" do
-      executable_path = mock_executable("ant", @project_path)
-
-      @project.from_directory do
-        commandline = @kit_runner.get_ant_commandline(".")
-        commandline.should eq "./#{executable_path}"
-      end
-    end
-    it "doesn't return commandline options if Ant is not available" do
-      expect { @kit_runner.get_ant_commandline(".") }.to raise_error(Gjp::ExecutableNotFoundError)
-    end
-  end
-
-  describe "#ant"  do
-    it "runs Ant" do
-      mock_executable("ant", @project_path)
-      @project.from_directory do
-        @kit_runner.ant(["extra-option"])
-        File.read("test_out").strip.should match /extra-option$/
-      end
-    end
-    it "doesn't run Ant if it is not available" do
-      @project.from_directory do
-        expect { @kit_runner.ant([]) }.to raise_error(Gjp::ExecutableNotFoundError)
-      end
+      @kit_runner.find_executable("any").should be_nil
     end
   end
 end