gjp 0.37.0 → 0.38.0

data/lib/gjp/package_spec_adapter.rb

@@ -1,4 +1,4 @@
-  # encoding: UTF-8
+# encoding: UTF-8
 
 module Gjp
   # encapsulates details of a package needed by the spec file
@@ -21,11 +21,13 @@ module Gjp
     def initialize(project, package_name, pom, filter)
       @name = package_name
       @version = pom.version
-      @license = if pom.license_name != ""
-        pom.license_name
-      else
-        "Apache-2.0"
-      end
+      @license = (
+        if pom.license_name != ""
+          pom.license_name
+        else
+          "Apache-2.0"
+        end
+      )
       @summary = cleanup_description(pom.description, 60)
       @url = pom.url
       @project_name = project.name
@@ -49,10 +51,9 @@ module Gjp
       raw
         .gsub(/[\s]+/, " ")
         .strip
-        .slice(0..max_length -1)
+        .slice(0..max_length - 1)
         .sub(/\s\w+$/, "")
         .sub(/\.+$/, "")
     end
   end
 end
-

data/lib/gjp/pom.rb

@@ -1,4 +1,4 @@
-  # encoding: UTF-8
+# encoding: UTF-8
 
 require "nokogiri"
 require "open-uri"
@@ -10,33 +10,33 @@ module Gjp
       @doc = Nokogiri::XML(open(filename).read)
       @doc.remove_namespaces!
     end
-        
+
     def group_id
-      @doc.xpath("project/groupId").text
+      @doc.xpath("project/groupId").text || ""
     end
-    
+
     def artifact_id
-      @doc.xpath("project/artifactId").text
+      @doc.xpath("project/artifactId").text || ""
     end
-    
+
     def name
-      @doc.xpath("project/name").text
+      @doc.xpath("project/name").text || ""
     end
 
     def version
-      @doc.xpath("project/version").text
+      @doc.xpath("project/version").text || ""
     end
 
     def description
-      @doc.xpath("project/description").text
+      @doc.xpath("project/description").text || ""
     end
 
     def url
-      @doc.xpath("project/url").text
+      @doc.xpath("project/url").text || ""
     end
 
     def license_name
-      @doc.xpath("project/licenses/license/name").text
+      @doc.xpath("project/licenses/license/name").text || ""
     end
 
     def runtime_dependency_ids
@@ -48,12 +48,11 @@ module Gjp
     end
 
     def scm_connection
-      @doc.xpath("project/scm/connection").text
+      @doc.xpath("project/scm/connection").text || ""
     end
 
     def scm_url
-      @doc.xpath("project/scm/url").text
+      @doc.xpath("project/scm/url").text || ""
     end
   end
 end
-

data/lib/gjp/pom_getter.rb

@@ -11,7 +11,7 @@ require "gjp/version_matcher"
 module Gjp
   # attempts to get java projects' pom file
   class PomGetter
-    include Logger
+    include Logging
 
     # saves a jar poms in <jar_filename>.pom
     # returns filename and status if found, else nil
@@ -39,9 +39,9 @@ module Gjp
       rescue TypeError
         log.warn("#{file} seems to be a valid jar archive but is corrupt, skipping")
       end
-      return nil
+      nil
     end
-    
+
     # 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}")
@@ -49,9 +49,9 @@ module Gjp
         if File.file?(file)
           site = MavenWebsite.new
           sha1 = Digest::SHA1.hexdigest File.read(file)
-          results = site.search_by_sha1(sha1).select {|result| result["ec"].include?(".pom")}
-          result = results.first    
-          if result != nil
+          results = site.search_by_sha1(sha1).select { |result| result["ec"].include?(".pom") }
+          result = results.first
+          unless result.nil?
             log.info("pom.xml for #{file} found on search.maven.org for sha1 #{sha1}\
               (#{result["g"]}:#{result["a"]}:#{result["v"]})"
             )
@@ -77,23 +77,25 @@ module Gjp
 
         result = site.search_by_name(my_artifact_id).first
         log.debug("Artifact id search result: #{result}")
-        if result != nil
+        unless 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
-            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
-            
+          their_versions = results.map { |doc| doc["v"] }
+          best_matched_version = (
+            if !my_version.nil?
+              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
+
           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), :found_via_heuristic
         end
       rescue RestClient::ResourceNotFound

data/lib/gjp/project.rb

@@ -5,12 +5,12 @@ require "find"
 module Gjp
   # encapsulates a Gjp project directory
   class Project
-    include Logger
+    include Logging
 
     attr_accessor :full_path
     attr_accessor :git
 
-    def initialize(path)      
+    def initialize(path)
       @full_path = Gjp::Project.find_project_dir(File.expand_path(path))
       @git = Gjp::Git.new(@full_path)
     end
@@ -45,20 +45,17 @@ module Gjp
     # returns the package name corresponding to the specified dir, if any
     # raises NoPackageDirectoryError if dir is not a (sub)directory of a package
     def get_package_name(dir)
-      begin
-        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 &&
-          components.first == "src" &&
-          Dir.exist?(File.join(@full_path, components[0], components[1]))
-          components[1]
-        else
-          raise NoPackageDirectoryError
-        end
-      rescue ArgumentError, NoProjectDirectoryError
-        raise NoPackageDirectoryError.new(dir)
-      end
+      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 &&
+       components.first == "src" &&
+       Dir.exist?(File.join(@full_path, components[0], components[1]))
+        components[1]
+     else
+       raise NoPackageDirectoryError
+     end
+    rescue ArgumentError, NoProjectDirectoryError
+      raise NoPackageDirectoryError.new(dir)
     end
 
     # inits a new project directory structure
@@ -123,11 +120,13 @@ module Gjp
 
     # takes a revertable snapshot of this project
     def take_snapshot(message, tag_prefix = nil, tag_message = nil)
-      tag = if tag_prefix
-        "#{tag_prefix}_#{latest_tag_count(tag_prefix) + 1}"
-      else
-        nil
-      end
+      tag = (
+        if tag_prefix
+          "#{tag_prefix}_#{latest_tag_count(tag_prefix) + 1}"
+        else
+          nil
+        end
+      )
 
       @git.commit_whole_directory(message, tag, tag_message)
     end
@@ -208,7 +207,7 @@ module Gjp
     end
 
     # moves any .jar from src/ to kit/ and links it back
-    def purge_jars      
+    def purge_jars
       from_directory do
         result = []
         Find.find("src") do |file|

data/lib/gjp/script_generator.rb

@@ -3,7 +3,7 @@
 module Gjp
   # generates build scripts from bash_history
   class ScriptGenerator
-    include Logger
+    include Logging
 
     def initialize(project, history_path)
       @project = project
@@ -11,17 +11,17 @@ module Gjp
       @maven_runner = Gjp::MavenRunner.new(project)
       @history_path = history_path
     end
-    
+
     def generate_build_script(name)
       @project.from_directory do
         history_lines = File.readlines(@history_path).map { |e| e.strip }
         relevant_lines =
           history_lines
             .reverse
-            .take_while { |e| e.match(/gjp +dry-run/) == nil }
+            .take_while { |e| e.match(/gjp +dry-run/).nil? }
             .reverse
-            .take_while { |e| e.match(/gjp +finish/) == nil }
-            .select { |e| e.match(/^#/) == nil }
+            .take_while { |e| e.match(/gjp +finish/).nil? }
+            .select { |e| e.match(/^#/).nil? }
 
         script_lines = [
           "#!/bin/bash",
@@ -42,13 +42,13 @@ module Gjp
 
         script_name = "build.sh"
         result_path = File.join("src", name, script_name)
-        conflict_count = @project.merge_new_content(new_content, result_path, "Build script generated", 
+        conflict_count = @project.merge_new_content(new_content, result_path, "Build script generated",
                                                     "generate_#{name}_build_script")
 
         destination_dir = File.join("output", name)
         FileUtils.mkdir_p(destination_dir)
-        destination_script_path =  File.join(destination_dir, script_name)        
-        FileUtils.symlink(File.expand_path(result_path), destination_script_path, :force => true)
+        destination_script_path =  File.join(destination_dir, script_name)
+        FileUtils.symlink(File.expand_path(result_path), destination_script_path, force: true)
 
         [result_path, conflict_count]
       end

data/lib/gjp/source_getter.rb

@@ -5,7 +5,7 @@ require "rest_client"
 module Gjp
   # attempts to get java projects' sources
   class SourceGetter
-    include Logger
+    include Logging
 
     # attempts to download a project's sources
     def get_maven_source_jar(project, pom_path)
@@ -20,7 +20,7 @@ module Gjp
       maven_runner = Gjp::MavenRunner.new(project)
 
       project.from_directory do
-        paths = Find.find(".").reject {|path| artifact_from_path(path) == nil}.sort
+        paths = Find.find(".").reject { |path| artifact_from_path(path).nil? }.sort
 
         succeded_paths = paths.select.with_index do |path, i|
           group_id, artifact_id, version = artifact_from_path(path)
@@ -37,7 +37,7 @@ module Gjp
     # 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
+      unless match.nil?
         [match[1].gsub("/", "."), match[2], match[3]]
       end
     end

data/lib/gjp/spec_generator.rb

@@ -3,7 +3,7 @@
 module Gjp
   # creates and updates spec files
   class SpecGenerator
-    include Logger
+    include Logging
 
     def initialize(project)
       @project = project
@@ -47,14 +47,14 @@ module Gjp
     # generates a spec file from a template and 3-way merges it
     def generate_merging(template, binding, path, tag_prefix)
       new_content = TemplateManager.new.generate(template, binding)
-      @project.merge_new_content(new_content, path, "Spec generated", tag_prefix)      
+      @project.merge_new_content(new_content, path, "Spec generated", tag_prefix)
     end
 
     # links a spec file in a subdirectory of output/
     def symlink_to_output(spec_path, destination_dir)
       spec_name = Pathname.new(spec_path).basename.to_s
       destination_spec_path = File.join(destination_dir, spec_name)
-      FileUtils.symlink(File.expand_path(spec_path), destination_spec_path, :force => true)
+      FileUtils.symlink(File.expand_path(spec_path), destination_spec_path, force: true)
     end
   end
 end

data/lib/gjp/template_manager.rb

@@ -5,7 +5,7 @@ require "erb"
 module Gjp
   # operates on files in template/
   class TemplateManager
-    include Logger
+    include Logging
 
     attr_reader :template_path
 
@@ -25,7 +25,7 @@ module Gjp
       erb = ERB.new File.read(File.join(template_path, template_name)), nil, "<>"
       new_content =  erb.result(object_binding)
 
-      if destination_path != nil
+      unless destination_path.nil?
         File.open(destination_path, "w") { |io| io.write new_content }
       end
 

data/lib/gjp/version.rb

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

data/lib/gjp/version_matcher.rb

@@ -4,23 +4,23 @@ require "text"
 
 module Gjp
   # heuristically matches version strings
-  class VersionMatcher 
-    include Logger
+  class VersionMatcher
+    include Logging
 
-  	# heuristically splits a full name into an artifact name and version string
+    # heuristically splits a full name into an artifact name and version string
     # assumes that version strings begin with a numeric character and are separated
     # by a ., -, _, ~ or space
     # returns a [name, version] pair
-  	def split_version(full_name)	
+    def split_version(full_name)
       matches = full_name.match(/(.*?)(?:[\.\-\_ ~,]?([0-9].*))?$/)
-      if matches != nil && matches.length > 1
+      if !matches.nil? && matches.length > 1
         [matches[1], matches[2]]
-  		else
-  			[full_string, nil]
-  		end
-  	end
+      else
+        [full_string, nil]
+      end
+    end
 
-  	# returns the "best match" between a version number and a set of available version numbers
+    # returns the "best match" between a version number and a set of available version numbers
     # using a heuristic criterion. Idea:
     #  - split the version number in chunks divided by ., - etc.
     #  - every chunk with same index is "compared", differences make up a score
@@ -29,57 +29,55 @@ module Gjp
     #  - lowest score wins
     def best_match(my_version, their_versions)
       log.debug("version comparison: #{my_version} vs #{their_versions.join(", ")}")
-    
+
       my_chunks = my_version.split(/[\.\-\_ ~,]/)
       their_chunks_hash = Hash[
         their_versions.map do |their_version|
-          their_chunks_for_version = if their_version != nil
-            their_version.split(/[\.\-\_ ~,]/)
-          else
-            []
-          end
-          their_chunks_for_version += [nil]*[my_chunks.length - their_chunks_for_version.length, 0].max
+          their_chunks_for_version = (
+            if !their_version.nil?
+              their_version.split(/[\.\-\_ ~,]/)
+            else
+              []
+            end
+          )
+          their_chunks_for_version += [nil] * [my_chunks.length - their_chunks_for_version.length, 0].max
           [their_version, their_chunks_for_version]
         end
       ]
-      
-      max_chunks_length = ([my_chunks.length] + their_chunks_hash.values.map {|chunk| chunk.length}).max
-      
+
+      max_chunks_length = ([my_chunks.length] + their_chunks_hash.values.map { |chunk| chunk.length }).max
+
       scoreboard = []
       their_versions.each do |their_version|
         their_chunks = their_chunks_hash[their_version]
         score = 0
         their_chunks.each_with_index do |their_chunk, i|
-          score_multiplier = 100**(max_chunks_length -i -1)
+          score_multiplier = 100**(max_chunks_length - i - 1)
           my_chunk = my_chunks[i]
           score += chunk_distance(my_chunk, their_chunk) * score_multiplier
         end
-        scoreboard << {:version => their_version, :score => score}
+        scoreboard << { version: their_version, score: score }
       end
-      
-      scoreboard = scoreboard.sort_by {|element| element[:score]}
+
+      scoreboard = scoreboard.sort_by { |element| element[:score] }
 
       log.debug("scoreboard: ")
       scoreboard.each_with_index do |element, i|
-        log.debug("  #{i+1}. #{element[:version]} (score: #{element[:score]})")
-      end
-      
-      winner = scoreboard.first
-      
-      if winner != nil
-        return winner[:version]
+        log.debug("  #{i + 1}. #{element[:version]} (score: #{element[:score]})")
       end
+
+      return scoreboard.first[:version] unless scoreboard.first.nil?
     end
-    
+
     # returns a score representing the distance between two version chunks
     # for integers, the score is the difference between their values
     # for strings, the score is the Levenshtein distance
     # in any case score is normalized between 0 (identical) and 99 (very different/uncomparable)
     def chunk_distance(my_chunk, their_chunk)
-      if my_chunk == nil
+      if my_chunk.nil?
         my_chunk = "0"
       end
-      if their_chunk == nil
+      if their_chunk.nil?
         their_chunk = "0"
       end
       if my_chunk.is_i? && their_chunk.is_i?
@@ -89,7 +87,6 @@ module Gjp
       end
     end
   end
-
 end
 
 class String