gjp 0.28.0 → 0.29.0

data/README.md

@@ -154,9 +154,14 @@ If you use Maven, most sources for binary jars in your kit can be automatically
 
     gjp get-maven-source-jars
 
-For non-Maven jars, or Maven jars that have no available sources, some extra manual work is needed. At the moment `gjp` can help you with the following utility subcommands:
+For non-Maven jars, or Maven jars that have no available sources, some extra manual work is needed. First of all, you should get a `pom.xml` file for your jar, if you don't have it already:
+
+    gjp get-pom jarname.jar
+
+This will create a `jarname.pom` file (if it can be found in Maven Central, otherwise you will need to search the Internet manually).
+
+If you are lucky, the pom file will contain an URL to a site where sources can be downloaded, or even an SCM address. At the moment automatic source retrieval is not automated, but `gjp` can help you with the following utility subcommands:
 
-* `gjp get-pom NAME` will attempt to find a pom. `NAME` can be a jar file on your disk, a project directory, or simply a `name-version` string. `gjp` will get the pom either from the package itself or through search.maven.org using heuristic searching;
 * `gjp get-parent-pom POM` will attempt to download a pom's parent from search.maven.org, where `POM` is a filename or URI;
 * `gjp get-source-address POM` will attempt to find the SCM Internet address of a pom.xml from the file itself or through api.github.com. `POM` can either be a filename or a URI;
 * `gjp get-source POM ADDRESS` downloads the source of a pom.xml's project from its SCM at ADDRESS;
@@ -169,7 +174,7 @@ Building Ant packages is not really different from Maven ones, as `gjp ant` will
 
 Sometimes you will have jar files distributed along with the source archive that will end up in `src/`: you don't want that, just run `gjp purge-jars` to have them moved to the kit. The command will generate a symlink back to the original, so builds will not fail.
 
-Once built, you are advised to grab an "informational" pom.xml (via `gjp get-pom` or Maven Central) in order to generate its spec.
+Once built, you should get a pom.xml file (via `gjp get-pom`, see above) in order to generate its spec.
 
 #### Optional: running networkless dry-run builds
 

data/lib/gjp/cli.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 require "gjp/logger"
 require "clamp"
+require "open-uri"
 
 module Gjp
   class MainCommand < Clamp::Command
@@ -281,11 +282,27 @@ module Gjp
       end
     end
 
-    subcommand "get-pom", "Retrieves a pom corresponding to a filename" do
-      parameter "NAME", "a jar file path, a project directory path or a non-existing filename in the `project-version` form"
+    subcommand "get-pom", "Retrieves a pom file" do
+      parameter "NAME", "a jar file name or a `name-version` string (heuristic)"
       def execute
-          checking_exceptions do
-          puts Gjp::PomGetter.new.get_pom(name)
+        checking_exceptions do
+          project = Gjp::Project.new(".")
+          pom_getter = Gjp::PomGetter.new
+
+          path, status = pom_getter.get_pom(name)
+          if path
+            text_status = if status == :found_in_jar
+              "was inside the jar"
+            elsif status == :found_via_sha1
+              "found by sha1 search from search.maven.org"
+            elsif status == :found_via_heuristic
+              "found by heuristic search from search.maven.org"
+            end
+
+            puts "#{format_path(path, project)} written, #{text_status}"
+          else
+            puts "#{name} not found. Try http://google.com/#q=#{URI::encode(pom_getter.cleanup_name(name))}"
+          end
         end
       end
     end
@@ -293,7 +310,7 @@ module Gjp
     subcommand "get-parent-pom", "Retrieves a pom that is the parent of an existing pom" do
       parameter "POM", "a pom file path or URI"
       def execute
-          checking_exceptions do
+        checking_exceptions do
           puts Gjp::ParentPomGetter.new.get_parent_pom(pom)
         end
       end

data/lib/gjp/pom_getter.rb

@@ -13,35 +13,30 @@ module Gjp
   class PomGetter
     include Logger
 
-    # returns the pom corresponding to a filename
+    # saves a jar poms in <jar_filename>.pom
+    # returns filename and status if found, else nil
     def get_pom(filename)
-      (get_pom_from_dir(filename) or get_pom_from_jar(filename) or get_pom_from_sha1(filename) or get_pom_from_heuristic(filename))
-    end
-
-    # returns the pom in a project directory
-    def get_pom_from_dir(dir)
-      if File.directory?(dir)
-        pom_path = File.join(dir, "pom.xml")
-        if File.file?(pom_path)
-          log.info("pom.xml found in #{dir}/pom.xml")
-          return File.read(pom_path)
-        end
+      content, status = (get_pom_from_jar(filename) or get_pom_from_sha1(filename) or get_pom_from_heuristic(filename))
+      if content
+        pom_filename = filename.sub(/(\.jar)?$/, ".pom")
+        File.open(pom_filename, "w") { |io| io.write(content) }
+        [pom_filename, status]
       end
     end
-    
+
     # returns a pom embedded in a jar file
     def get_pom_from_jar(file)
       begin
         Zip::ZipFile.foreach(file) do |entry|
           if entry.name =~ /\/pom.xml$/
             log.info("pom.xml found in #{file}##{entry.name}")
-            return entry.get_input_stream.read
+            return entry.get_input_stream.read, :found_in_jar
           end
         end
       rescue Zip::ZipError
-        log.info "#{file} does not seem to be a valid jar archive, skipping"
+        log.warn("#{file} does not seem to be a valid jar archive, skipping")
       rescue TypeError
-        log.info "#{file} seems to be a valid jar archive but is corrupt, skipping"
+        log.warn("#{file} seems to be a valid jar archive but is corrupt, skipping")
       end
       return nil
     end
@@ -57,12 +52,12 @@ module Gjp
           if result != nil
             log.info("pom.xml for #{file} found on search.maven.org for sha1 #{sha1} (#{result["g"]}:#{result["a"]}:#{result["v"]})")
             group_id, artifact_id, version = site.get_maven_id_from result
-            return site.download_pom(group_id, artifact_id, version)
+            return site.download_pom(group_id, artifact_id, version), :found_via_sha1
           end
         end
         return nil
       rescue RestClient::ResourceNotFound
-        $stderr.puts "Got an error while looking for #{file}'s SHA1 in search.maven.org" 
+        log.error("Got an error while looking for #{file}'s SHA1 in search.maven.org")
       end
     end
 
@@ -70,7 +65,7 @@ module Gjp
     def get_pom_from_heuristic(filename)
       begin
         site = MavenWebsite.new
-        filename = Pathname.new(filename).basename.to_s.sub(/.jar$/, "")
+        filename = cleanup_name(filename)
         version_matcher = VersionMatcher.new
         my_artifact_id, my_version = version_matcher.split_version(filename)
 
@@ -85,11 +80,16 @@ module Gjp
           group_id, artifact_id, version = site.get_maven_id_from(best_matched_result)
           log.warn("pom.xml for #{filename} found on search.maven.org with heuristic search (#{group_id}:#{artifact_id}:#{version})")
             
-          return site.download_pom(group_id, artifact_id, version)
+          return site.download_pom(group_id, artifact_id, version), :found_via_heuristic
         end
       rescue RestClient::ResourceNotFound
-        $stderr.puts "Got an error while looking for #{filename} in search.maven.org" 
+        log.error("Got an error while looking for #{filename}'s SHA1 in search.maven.org")
       end
     end
+
+    # get a heuristic name from a path
+    def cleanup_name(path)
+      Pathname.new(path).basename.to_s.sub(/.jar$/, "")
+    end
   end
 end

data/lib/gjp/version.rb

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

data/spec/lib/pom_getter_spec.rb

@@ -6,31 +6,25 @@ describe Gjp::PomGetter do
   let(:pom_getter) { Gjp::PomGetter.new }
 
   describe "#get_pom" do
-    it "gets the pom from a directory" do
-      dir_path = File.join("spec", "data", "commons-logging")
-      pom_path = File.join(dir_path, "pom.xml")
-      pom_getter.get_pom(dir_path).should eq(File.read(pom_path))
-    end
-    
     it "gets the pom from a jar" do
       dir_path = File.join("spec", "data", "commons-logging")
-      pom_path = File.join(dir_path, "pom.xml")
       jar_path = File.join(dir_path, "commons-logging-1.1.1.jar")
-      pom_getter.get_pom(jar_path).should eq(File.read(pom_path))
+      path, status = pom_getter.get_pom(jar_path)
+      status.should eq :found_in_jar
     end
 
     it "gets the pom from sha1" do
       dir_path = File.join("spec", "data", "antlr")
-      pom_path = File.join(dir_path, "pom.xml")
       jar_path = File.join(dir_path, "antlr-2.7.2.jar")
-      pom_getter.get_pom(jar_path).should eq(File.read(pom_path))
+      path, status = pom_getter.get_pom(jar_path)
+      status.should eq :found_via_sha1
     end
     
     it "gets the pom from a heuristic" do
       dir_path = File.join("spec", "data", "nailgun")
-      pom_path = File.join(dir_path, "pom.xml")
       jar_path = File.join(dir_path, "nailgun-0.7.1.jar")
-      pom_getter.get_pom(jar_path).should eq(File.read(pom_path))
+      path, status = pom_getter.get_pom(jar_path)
+      status.should eq :found_via_heuristic
     end         
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gjp
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
   prerelease: 
 platform: ruby
 authors: