gjp 0.38.0 → 0.39.0

data/.rubocop.yml

@@ -1,10 +1,14 @@
-inherit_from: .rubocop_todo.yml
-
 ClassLength:
   Max: 200
 
 LineLength:
   Max: 120
 
+MethodLength:
+  Max: 35
+
 StringLiterals:
   EnforcedStyle: double_quotes
+
+MultilineBlockChain:
+  Enabled: false

data/Rakefile

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/SPECIAL_CASES.md

@@ -14,7 +14,7 @@ You can do any manual changes to spec and build.sh files and regenerate them lat
 * `gjp generate-package-archive`: (re)generates a package tarball;
 * `gjp generate-package-spec`: (re)generates a package spec;
 
-Note that, by default, `generate-kit-archive` will generate additional "diff" tar.xz files instead of rewriting the whole archive - this will result in faster uploads if you use OBS (see below). You can use the `--full` option to regenerate a single complete archive.
+Note that, by default, `generate-kit-archive` will generate additional "diff" tar.xz files instead of rewriting the whole archive - this will result in faster uploads if you use OBS (see below). You can use the `--whole` option to regenerate a single complete archive.
 
 ## Kit sources
 

data/bin/gjp

@@ -16,7 +16,7 @@
 #
 
 if File.exist?(File.join(File.dirname(__FILE__), "..", ".git"))
-  $: << File.join(File.dirname(__FILE__), "..", "lib")
+  $LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
 end
 
 begin

data/gjp.gemspec

@@ -1,5 +1,5 @@
 # encoding: UTF-8
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
 require "gjp/version"
 
 Gem::Specification.new do |s|

data/lib/gjp.rb

@@ -1,4 +1,25 @@
-# backend
+# encoding: UTF-8
+
+# ruby standard library
+require "digest/sha1"
+require "English"
+require "erb"
+require "find"
+require "forwardable"
+require "logger"
+require "open-uri"
+require "pathname"
+require "singleton"
+require "text"
+
+# third party libraries
+require "clamp"
+require "json"
+require "nokogiri"
+require "rest_client"
+require "zip"
+
+# internal, backend
 require "gjp/version"
 require "gjp/logger"
 require "gjp/template_manager"
@@ -19,7 +40,7 @@ require "gjp/spec_generator"
 require "gjp/archiver"
 require "gjp/kit_checker"
 
-# UI
+# internal, UI
 require "gjp/commands/base"
 
 require "gjp/commands/ant"

data/lib/gjp/ant_runner.rb

@@ -20,7 +20,7 @@ module Gjp
 
         "#{ant_path}"
       else
-        raise ExecutableNotFoundError.new("ant")
+        fail ExecutableNotFoundError, "ant"
       end
     end
   end

data/lib/gjp/archiver.rb

@@ -10,7 +10,7 @@ module Gjp
     end
 
     # generates an archive for the kit package
-    def archive_kit(full)
+    def archive_kit(whole)
       destination_dir = File.join(@project.full_path, "output", "#{@project.name}-kit")
       FileUtils.mkdir_p(destination_dir)
       file_prefix = "#{@project.name}-kit"
@@ -19,7 +19,7 @@ module Gjp
       @project.take_snapshot "Kit archival started"
 
       destination_file = (
-        if full
+        if whole
           remove_stale_incremental(destination_dir, file_prefix, file_suffix)
           archive_single("kit", File.join(destination_dir, file_prefix + file_suffix))
         else
@@ -62,7 +62,8 @@ module Gjp
         if latest_tag_count == 0
           archive_single(source_directory, File.join(destination_dir, file_prefix + file_suffix))
         else
-          destination_file = File.join(destination_dir, "#{file_prefix}_#{"%04d" % (latest_tag_count)}#{file_suffix}")
+          destination_file = File.join(destination_dir,
+                                       "#{file_prefix}_#{format("%04d", latest_tag_count)}#{file_suffix}")
           tag = @project.latest_tag(tag_prefix)
           log.debug "creating #{destination_file} with files newer than #{tag}"
 

data/lib/gjp/commands/ant.rb

@@ -1,10 +1,12 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp ant
   class AntCommand < Gjp::BaseCommand
     parameter "[ANT OPTIONS] ...", "ant options", attribute_name: "dummy"
 
     # override parsing in order to pipe everything to mvn
+    # rubocop:disable TrivialAccessors
     def parse(args)
       @options = args
     end

data/lib/gjp/commands/base.rb

@@ -1,6 +1,4 @@
 # encoding: UTF-8
-require "clamp"
-require "gjp/logger"
 
 module Gjp
   # implements common options and utility methods
@@ -8,7 +6,7 @@ module Gjp
     include Logging
 
     # Options available to all gjp commands
-    option ["-v", "--verbose"], :flag, "verbose output"
+    option %w(-v --verbose), :flag, "verbose output"
     option ["--very-verbose"], :flag, "very verbose output"
     option ["--very-very-verbose"], :flag, "very very verbose output"
 
@@ -40,7 +38,7 @@ module Gjp
 
     # prints an error message and exits unless there is a dry-run in progress
     def ensure_dry_running(state, project)
-      if project.is_dry_running == state
+      if project.dry_running? == state
         yield
       else
         if state == true
@@ -54,9 +52,7 @@ module Gjp
     # outputs output of a file generation
     def print_generation_result(project, result_path, conflict_count = 0)
       puts "#{format_path(result_path, project)} generated"
-      if conflict_count > 0
-        puts "Warning: #{conflict_count} unresolved conflicts"
-      end
+      puts "Warning: #{conflict_count} unresolved conflicts" if conflict_count > 0
     end
 
     # generates a version of path relative to the current directory
@@ -84,7 +80,7 @@ module Gjp
       $stderr.puts "#{e.directory} is not a gjp project directory, see gjp init"
     rescue NoPackageDirectoryError => e
       $stderr.puts "#{e.directory} is not a gjp package directory, see README"
-    rescue GitAlreadyInitedError => e
+    rescue GitAlreadyInitedError
       $stderr.puts "This directory is already a gjp project"
     rescue ExecutableNotFoundError => e
       $stderr.puts "Executable #{e.executable} not found in kit/ or any of its subdirectories"

data/lib/gjp/commands/download_maven_source_jars.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp download-maven-source-jars
   class DownloadMavenSourceJarsCommand < Gjp::BaseCommand
     def execute
       checking_exceptions do

data/lib/gjp/commands/dry_run.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp dry-run
   class DryRunCommand < Gjp::BaseCommand
     def execute
       checking_exceptions do

data/lib/gjp/commands/finish.rb

@@ -1,8 +1,9 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp finish
   class FinishCommand < Gjp::BaseCommand
-    option ["-a", "--abort"], :flag, "build abort, restore files as before dry-run"
+    option %w(-a --abort), :flag, "build abort, restore files as before dry-run"
 
     def execute
       checking_exceptions do

data/lib/gjp/commands/generate_all.rb

@@ -1,9 +1,10 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp generate-all
   class GenerateAllCommand < Gjp::BaseCommand
-    option ["-f", "--filter"], "FILTER", "filter files to be installed by this package spec", default: "*.jar"
-    option ["-f", "--full"], :flag, "create a full archive (not incremental)"
+    option %w(-f --filter), "FILTER", "filter files to be installed by this package spec", default: "*.jar"
+    option %w(-w --whole), :flag, "recreate the whole archive (not incremental)"
     parameter "[DIRECTORY]", "path to a package directory (src/<package name>)", default: "."
     parameter "[POM]", "a package pom file path", default: "pom.xml"
 
@@ -13,7 +14,7 @@ module Gjp
         ensure_dry_running(false, project) do
           package_name = project.get_package_name(directory)
 
-          result_path = Gjp::Archiver.new(project).archive_kit(full?)
+          result_path = Gjp::Archiver.new(project).archive_kit(whole?)
           print_generation_result(project, result_path)
 
           result_path, conflict_count = Gjp::SpecGenerator.new(project).generate_kit_spec

data/lib/gjp/commands/generate_kit_archive.rb

@@ -1,14 +1,15 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp generate-kit-archive
   class GenerateKitArchiveCommand < Gjp::BaseCommand
-    option ["-f", "--full"], :flag, "create a full archive (not incremental)"
+    option %w(-w --whole), :flag, "recreate the whole archive (not incremental)"
 
     def execute
       checking_exceptions do
         project = Gjp::Project.new(".")
         ensure_dry_running(false, project) do
-          result_path = Gjp::Archiver.new(project).archive_kit(full?)
+          result_path = Gjp::Archiver.new(project).archive_kit(whole?)
           print_generation_result(project, result_path)
         end
       end

data/lib/gjp/commands/generate_kit_spec.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp generate-kit-spec
   class GenerateKitSpecCommand < Gjp::BaseCommand
     def execute
       checking_exceptions do

data/lib/gjp/commands/generate_package_archive.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp generate-package-archive
   class GeneratePackageArchiveCommand < Gjp::BaseCommand
     parameter "[DIRECTORY]", "path to a package directory (src/<package name>)", default: "."
 

data/lib/gjp/commands/generate_package_script.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp generate-package-script
   class GeneratePackageScriptCommand < Gjp::BaseCommand
     parameter "[DIRECTORY]", "path to a package directory (src/<package name>)", default: "."
 

data/lib/gjp/commands/generate_package_spec.rb

@@ -1,8 +1,9 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp generate-package-spec
   class GeneratePackageSpecCommand < Gjp::BaseCommand
-    option ["-f", "--filter"], "FILTER", "filter files to be installed by this spec", default: "*.jar"
+    option %w(-f --filter), "FILTER", "filter files to be installed by this spec", default: "*.jar"
     parameter "[DIRECTORY]", "path to a package directory (src/<package name>)", default: "."
     parameter "[POM]", "a pom file path", default: "pom.xml"
 

data/lib/gjp/commands/get_pom.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp get-pom
   class GetPomCommand < Gjp::BaseCommand
     parameter "NAME", "a jar file name or a `name-version` string (heuristic)"
 

data/lib/gjp/commands/get_source.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp get-source
   class GetSourceCommand < Gjp::BaseCommand
     parameter "POM", "a pom file path or URI"
 
@@ -16,17 +17,12 @@ module Gjp
           effective_pom_path = Gjp::MavenRunner.new(project).get_effective_pom(pom)
           puts "Source jar not found in Maven. Try looking here:"
           pom = Gjp::Pom.new(effective_pom_path)
-          unless pom.url.empty?
-            puts "Website: #{pom.url}"
-          end
-          unless pom.scm_connection.empty?
-            puts "SCM connection: #{pom.scm_connection}"
-          end
-          unless pom.scm_url.empty?
-            puts "SCM connection: #{pom.scm_url}"
-          end
+          puts "Website: #{pom.url}" unless pom.url.empty?
+          puts "SCM connection: #{pom.scm_connection}" unless pom.scm_connection.empty?
+          puts "SCM connection: #{pom.scm_url}" unless pom.scm_url.empty?
           puts "The effective POM: #{effective_pom_path}"
-          puts "Google: http://google.com/#q=#{URI.encode(pom.name + " sources")}"
+          name = !pom.name.empty? ? pom.name : pom.artifact_id
+          puts "Google: http://google.com/#q=#{URI.encode("#{name} sources")}"
         end
       end
     end

data/lib/gjp/commands/init.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp init
   class InitCommand < Gjp::BaseCommand
     def execute
       checking_exceptions do

data/lib/gjp/commands/list_kit_missing_sources.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp list-kit-missing-sources
   class ListKitMissingSourcesCommand < Gjp::BaseCommand
     def execute
       checking_exceptions do
@@ -10,8 +11,8 @@ module Gjp
         ensure_dry_running(false, project) do
           puts "Some source files were not found in these archives:"
           kit_checker.unsourced_archives.each do |archive|
-            percentage = "%.2f" % (100.0 * archive[:unsourced_class_names].length / archive[:class_names].length)
-            puts "#{format_path(archive[:archive], project)} (~#{percentage}% missing)"
+            percentage = 100.0 * archive[:unsourced_class_names].length / archive[:class_names].length
+            puts "#{format_path(archive[:archive], project)} (~#{format("%.2f", percentage)}% missing)"
           end
         end
       end

data/lib/gjp/commands/move_jars_to_kit.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp move-jars-to-kit
   class MoveJarsToKitCommand < Gjp::BaseCommand
     def execute
       checking_exceptions do

data/lib/gjp/commands/mvn.rb

@@ -1,10 +1,12 @@
 # encoding: UTF-8
 
 module Gjp
+  # gjp mvn
   class MavenCommand < Gjp::BaseCommand
     parameter "[MAVEN OPTIONS] ...", "mvn options", attribute_name: "dummy"
 
     # override parsing in order to pipe everything to mvn
+    # rubocop:disable TrivialAccessors
     def parse(args)
       @options = args
     end

data/lib/gjp/git.rb

@@ -18,7 +18,7 @@ module Gjp
         if Dir.exist?(".git") == false
           `git init`
         else
-          raise GitAlreadyInitedError
+          fail GitAlreadyInitedError
         end
       end
     end
@@ -56,9 +56,9 @@ module Gjp
         # rename all .gitignore files by default as
         # they prevent snapshotting
         Find.find(".") do |file|
-          if file =~ /\.gitignore$/
-            FileUtils.mv(file, "#{file}_disabled_by_gjp")
-          end
+          next unless file =~ /\.gitignore$/
+
+          FileUtils.mv(file, "#{file}_disabled_by_gjp")
         end
 
         `git rm -r --cached --ignore-unmatch .`
@@ -116,7 +116,7 @@ module Gjp
         log.debug "calling git merge-file #{path} #{path}.old_version #{new_path}, output follows"
         `git merge-file #{path} #{path}.old_version #{new_path} \
           -L "newly generated" -L "previously generated" -L "user edited"`
-        conflict_count = $?.exitstatus
+        conflict_count = $CHILD_STATUS.exitstatus
         File.delete "#{path}.old_version"
         return conflict_count
       end

data/lib/gjp/kit_checker.rb

@@ -1,8 +1,5 @@
 # encoding: UTF-8
 
-require "find"
-require "zip"
-
 module Gjp
   # checks kits for errors
   class KitChecker
@@ -22,14 +19,12 @@ module Gjp
           [path, nil]
         end
 
-        archived_file_paths = plain_file_paths.select do |path, archive|
+        archived_file_paths = plain_file_paths.select do |path, _archive|
           path. =~ (/\.(zip)|([jwe]ar)$/)
-        end.map do |path, archive|
+        end.map do |path, _archive|
           result = []
           Zip::File.foreach(path) do |entry|
-            if entry.file?
-              result << [entry.to_s, path]
-            end
+            result << [entry.to_s, path] if entry.file?
           end
           result
         end.flatten(1)
@@ -41,7 +36,7 @@ module Gjp
     # returns a list of class names for which
     # we have source files in kit/
     def source_class_names(paths)
-      source_paths = paths.select do |path, archive|
+      source_paths = paths.select do |path, _archive|
         path =~ /\.java$/
       end
 
@@ -49,7 +44,7 @@ module Gjp
       # back the directory tree all the way back to root.
       # This could add non-existent names, but allows not looking
       # in the file at all
-      class_names = source_paths.map do |path, archive|
+      class_names = source_paths.map do |path, _archive|
         class_name = path_to_class(path)
         parts = class_name.split(".")
         last_index = parts.length - 1
@@ -65,7 +60,7 @@ module Gjp
     # we have binary files in kit/
     def compiled_classes(paths)
       result = {}
-      compiled_paths = paths.select do |path, archive|
+      paths.select do |path, _archive|
         path =~ /\.class$/
       end.each do |path, archive|
         class_name = path_to_class(path)
@@ -86,7 +81,7 @@ module Gjp
       source_class_names = source_class_names(paths)
       archive_paths_to_class_names = compiled_classes(paths)
 
-      result = archive_paths_to_class_names.map do |archive, class_names|
+      archive_paths_to_class_names.map do |archive, class_names|
         unsourced_class_names = class_names.select do |class_name|
           source_class_names.include?(class_name) == false
         end
@@ -97,6 +92,7 @@ module Gjp
     end
 
     private
+
     # attempts to turn a .java/.class file name into a class name
     def path_to_class(path)
       path

data/lib/gjp/kit_runner.rb

@@ -1,8 +1,5 @@
 # encoding: UTF-8
 
-require "find"
-require "pathname"
-
 module Gjp
   # runs programs from a gjp kit with gjp-specific options
   class KitRunner
@@ -16,10 +13,10 @@ module Gjp
     def find_executable(name)
       @project.from_directory do
         Find.find("kit") do |path|
-          if path =~ /bin\/#{name}$/
-            log.debug("found #{name} executable: #{path}")
-            return path
-          end
+          next unless path =~ /bin\/#{name}$/
+
+          log.debug("found #{name} executable: #{path}")
+          return path
         end
       end
 
@@ -31,10 +28,11 @@ module Gjp
     def run_executable(full_commandline)
       log.debug "running #{full_commandline}"
       Process.wait(Process.spawn(full_commandline))
-      $?.exitstatus == 0
+      $CHILD_STATUS.exitstatus == 0
     end
   end
 
+  # an executable from the kit was not found
   class ExecutableNotFoundError < Exception
     attr_reader :executable
 

data/lib/gjp/logger.rb

@@ -1,10 +1,7 @@
 # encoding: UTF-8
 
-require "singleton"
-require "forwardable"
-require "logger"
-
 module Gjp
+  # configures logging for this application
   class Logger
     include Singleton
     extend Forwardable
@@ -15,12 +12,13 @@ module Gjp
       @logger = ::Logger.new(STDERR)
       @logger.datetime_format = "%Y-%m-%d %H:%M "
       @logger.level = ::Logger::ERROR
-      @logger.formatter = proc do |severity, datetime, progname, msg|
+      @logger.formatter = proc do |severity, _datetime, _progname, msg|
         "#{severity.chars.first}: #{msg}\n"
       end
     end
   end
 
+  # convenience methods
   module Logging
     # convenience instance method
     def log

data/lib/gjp/main.rb

@@ -1,7 +1,7 @@
 # encoding: UTF-8
-require "clamp"
 
 module Gjp
+  # program entry point
   class MainCommand < Clamp::Command
     subcommand(
       "init",

data/lib/gjp/maven_runner.rb

@@ -40,7 +40,7 @@ module Gjp
 
         "#{mvn_path} -Dmaven.repo.local=#{repo_path} -s#{config_path} #{options.join(" ")}"
       else
-        raise ExecutableNotFoundError.new("mvn")
+        fail ExecutableNotFoundError, "mvn"
       end
     end
   end

data/lib/gjp/maven_website.rb

@@ -1,7 +1,5 @@
 # encoding: UTF-8
 
-require "text"
-
 module Gjp
   # Facade to search.maven.org
   class MavenWebsite

data/lib/gjp/pom.rb

@@ -1,8 +1,5 @@
 # encoding: UTF-8
 
-require "nokogiri"
-require "open-uri"
-
 module Gjp
   # encapsulates a pom.xml file
   class Pom
@@ -40,7 +37,7 @@ module Gjp
     end
 
     def runtime_dependency_ids
-      result = @doc.xpath("project/dependencies/dependency[\
+      @doc.xpath("project/dependencies/dependency[\
         not(optional='true') and not(scope='provided') and not(scope='test') and not(scope='system')\
       ]").map do |element|
         [element.xpath("groupId").text, element.xpath("artifactId").text, element.xpath("version").text]

data/lib/gjp/pom_getter.rb

@@ -1,13 +1,5 @@
 # encoding: UTF-8
 
-require "digest/sha1"
-require "zip"
-require "rest_client"
-require "json"
-require "pathname"
-
-require "gjp/version_matcher"
-
 module Gjp
   # attempts to get java projects' pom file
   class PomGetter
@@ -17,11 +9,11 @@ module Gjp
     # returns filename and status if found, else nil
     def get_pom(filename)
       content, status = (get_pom_from_jar(filename) || get_pom_from_sha1(filename) || 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
+      return unless content
+
+      pom_filename = filename.sub(/(\.jar)?$/, ".pom")
+      File.open(pom_filename, "w") { |io| io.write(content) }
+      [pom_filename, status]
     end
 
     # returns a pom embedded in a jar file
@@ -78,7 +70,7 @@ module Gjp
         result = site.search_by_name(my_artifact_id).first
         log.debug("Artifact id search result: #{result}")
         unless result.nil?
-          group_id, artifact_id, version = site.get_maven_id_from result
+          group_id, artifact_id, _ = 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"] }
@@ -89,7 +81,7 @@ module Gjp
               their_versions.max
             end
           )
-          best_matched_result = (results.select { |result| result["v"] == best_matched_version }).first
+          best_matched_result = (results.select { |r| r["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\

data/lib/gjp/project.rb

@@ -1,7 +1,5 @@
 # encoding: UTF-8
 
-require "find"
-
 module Gjp
   # encapsulates a Gjp project directory
   class Project
@@ -26,17 +24,17 @@ 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 && result != "/"
+      while project?(result) == false && result != "/"
         result = File.expand_path("..", result)
       end
 
-      raise NoProjectDirectoryError.new(starting_dir) if result == "/"
+      fail NoProjectDirectoryError, starting_dir if result == "/"
 
       result
     end
 
     # returns true if the specified directory is a valid gjp project
-    def self.is_project(dir)
+    def self.project?(dir)
       File.directory?(File.join(dir, "src")) &&
       File.directory?(File.join(dir, "kit")) &&
       File.directory?(File.join(dir, ".git"))
@@ -48,14 +46,14 @@ 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 &&
-       components.first == "src" &&
-       Dir.exist?(File.join(@full_path, components[0], components[1]))
+        components.first == "src" &&
+        Dir.exist?(File.join(@full_path, components[0], components[1]))
         components[1]
-     else
-       raise NoPackageDirectoryError
-     end
+      else
+        fail NoPackageDirectoryError
+      end
     rescue ArgumentError, NoProjectDirectoryError
-      raise NoPackageDirectoryError.new(dir)
+      raise NoPackageDirectoryError, dir
     end
 
     # inits a new project directory structure
@@ -83,9 +81,7 @@ module Gjp
     # to the kit package, src/ will be reset at the current state
     # when finished
     def dry_run
-      if is_dry_running
-        return false
-      end
+      return false if dry_running?
 
       current_directory = Pathname.new(Dir.pwd).relative_path_from Pathname.new(@full_path)
 
@@ -94,7 +90,7 @@ module Gjp
     end
 
     # returns true iff we are currently dry-running
-    def is_dry_running
+    def dry_running?
       latest_tag_count(:dry_run_started) > latest_tag_count(:dry_run_finished)
     end
 
@@ -102,7 +98,7 @@ module Gjp
     # if abort is true, reverts the whole directory
     # if abort is false, reverts sources and updates output file lists
     def finish(abort)
-      if is_dry_running
+      if dry_running?
         if abort
           @git.revert_whole_directory(".", latest_tag(:dry_run_started))
           @git.delete_tag(latest_tag(:dry_run_started))
@@ -211,17 +207,17 @@ module Gjp
       from_directory do
         result = []
         Find.find("src") do |file|
-          if file =~ /.jar$/ && !File.symlink?(file)
-            new_location = File.join("kit", "jars", Pathname.new(file).split[1])
-            FileUtils.mv(file, new_location)
+          next unless file =~ /.jar$/ && !File.symlink?(file)
 
-            link_target = Pathname.new(new_location)
-              .relative_path_from(Pathname.new(file).split.first)
-              .to_s
+          new_location = File.join("kit", "jars", Pathname.new(file).split[1])
+          FileUtils.mv(file, new_location)
 
-            File.symlink(link_target, file)
-            result << [file, new_location]
-          end
+          link_target = Pathname.new(new_location)
+            .relative_path_from(Pathname.new(file).split.first)
+            .to_s
+
+          File.symlink(link_target, file)
+          result << [file, new_location]
         end
 
         result
@@ -229,6 +225,7 @@ module Gjp
     end
   end
 
+  # current directory is not a gjp project
   class NoProjectDirectoryError < StandardError
     attr_reader :directory
 
@@ -236,6 +233,8 @@ module Gjp
       @directory = directory
     end
   end
+
+  # current directory is not a gjp package directory
   class NoPackageDirectoryError < StandardError
     attr_reader :directory
 

data/lib/gjp/source_getter.rb

@@ -1,7 +1,5 @@
 # encoding: UTF-8
 
-require "rest_client"
-
 module Gjp
   # attempts to get java projects' sources
   class SourceGetter
@@ -22,7 +20,7 @@ module Gjp
       project.from_directory do
         paths = Find.find(".").reject { |path| artifact_from_path(path).nil? }.sort
 
-        succeded_paths = paths.select.with_index do |path, i|
+        succeded_paths = paths.each do |path|
           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)
@@ -36,10 +34,8 @@ 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$/)
-      unless match.nil?
-        [match[1].gsub("/", "."), match[2], match[3]]
-      end
+      match = path.match(%r{\./kit/m2/(.+)/(.+)/(.+)/\2-\3.*\.jar$})
+      [match[1].gsub("/", "."), match[2], match[3]] unless match.nil?
     end
   end
 end

data/lib/gjp/template_manager.rb

@@ -1,7 +1,5 @@
 # encoding: UTF-8
 
-require "erb"
-
 module Gjp
   # operates on files in template/
   class TemplateManager

data/lib/gjp/version.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 
+# base module for gjp
 module Gjp
-  VERSION = "0.38.0"
+  VERSION = "0.39.0"
 end

data/lib/gjp/version_matcher.rb

@@ -1,7 +1,5 @@
 # encoding: UTF-8
 
-require "text"
-
 module Gjp
   # heuristically matches version strings
   class VersionMatcher
@@ -74,23 +72,19 @@ module Gjp
     # 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?
-        my_chunk = "0"
-      end
-      if their_chunk.nil?
-        their_chunk = "0"
-      end
-      if my_chunk.is_i? && their_chunk.is_i?
+      my_chunk = "0" if my_chunk.nil?
+      their_chunk = "0" if their_chunk.nil?
+
+      if i?(my_chunk) && i?(their_chunk)
         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
       end
     end
-  end
-end
 
-class String
-  def is_i?
-    !!(self =~ /^[0-9]+$/)
+    # true for integer strings
+    def i?(string)
+      string =~ /^[0-9]+$/
+    end
   end
 end

data/spec/lib/ant_runner_spec.rb

@@ -1,7 +1,6 @@
 # encoding: UTF-8
 
 require "spec_helper"
-require "lib/kit_runner_spec"
 
 describe Gjp::AntRunner do
   it_behaves_like Gjp::KitRunner
@@ -31,7 +30,7 @@ describe Gjp::AntRunner do
 
   describe "#ant"  do
     it "runs Ant" do
-      executable_path = create_mock_executable("ant")
+      create_mock_executable("ant")
       @project.from_directory do
         @kit_runner.ant(["extra-option"])
         File.read("test_out").strip.should match(/extra-option$/)

data/spec/lib/maven_runner_spec.rb

@@ -1,7 +1,6 @@
 # encoding: UTF-8
 
 require "spec_helper"
-require "lib/kit_runner_spec"
 
 describe Gjp::MavenRunner do
   it_behaves_like Gjp::KitRunner

data/spec/lib/project_spec.rb

@@ -15,10 +15,10 @@ describe Gjp::Project do
     FileUtils.rm_rf(@project_path)
   end
 
-  describe "#is_project"  do
+  describe "#project?"  do
     it "checks if a directory is a gjp project or not" do
-      Gjp::Project.is_project(@project_path).should be_true
-      Gjp::Project.is_project(File.join(@project_path, "..")).should be_false
+      Gjp::Project.project?(@project_path).should be_true
+      Gjp::Project.project?(File.join(@project_path, "..")).should be_false
     end
   end
 
@@ -99,14 +99,14 @@ describe Gjp::Project do
     end
   end
 
-  describe "#is_dry_running" do
+  describe "#dry_running?" do
     it "checks if a project is dry running" do
       @project.from_directory do
-        @project.is_dry_running.should be_false
+        @project.dry_running?.should be_false
         @project.dry_run
-        @project.is_dry_running.should be_true
+        @project.dry_running?.should be_true
         @project.finish(false)
-        @project.is_dry_running.should be_false
+        @project.dry_running?.should be_false
       end
     end
   end
@@ -142,7 +142,7 @@ describe Gjp::Project do
       end
 
       @project.finish(false).should be_true
-      @project.is_dry_running.should be_false
+      @project.dry_running?.should be_false
 
       @project.from_directory do
         `git rev-list --all`.split("\n").length.should eq 4
@@ -172,7 +172,7 @@ describe Gjp::Project do
       end
 
       @project.finish(true).should be_true
-      @project.is_dry_running.should be_false
+      @project.dry_running?.should be_false
 
       @project.from_directory do
         `git rev-list --all`.split("\n").length.should eq 2
@@ -198,7 +198,7 @@ describe Gjp::Project do
       end
 
       @project.from_directory do
-        @project.is_dry_running.should be_true
+        @project.dry_running?.should be_true
         `git rev-list --all`.split("\n").length.should eq 2
         `git diff-tree --no-commit-id --name-only -r HEAD`.split("\n").should include("src/test")
         `git cat-file tag gjp_dry_run_started_1 | tail -1`.should include("src")

data/spec/lib/script_generator_spec.rb

@@ -21,6 +21,7 @@ describe Gjp::ScriptGenerator do
       end
 
       FileUtils.mkdir_p(File.join("src", "test-package"))
+      @project.dry_run
 
       @generator = Gjp::ScriptGenerator.new(@project, "history")
     end

data/spec/lib/template_manager_spec.rb

@@ -34,6 +34,7 @@ describe Gjp::TemplateManager do
       destination_path = destination.path
       destination.unlink
 
+      # binding test class
       class WorldClass
         def world_property
           "World!"

data/spec/spec_helper.rb

@@ -1,9 +1,10 @@
 # encoding: UTF-8
 
 require "gjp"
+Dir["./spec/support/**/*.rb"].sort.each { |f| require f}
 
-# custom mock methods
 module Gjp
+  # custom mock methods
   module Mockers
     # creates a minimal gjp project
     def create_mock_project

data/spec/{lib/kit_runner_spec.rb → support/kit_runner_examples.rb}

@@ -1,7 +1,5 @@
 # encoding: UTF-8
 
-require "spec_helper"
-
 shared_examples_for Gjp::KitRunner do
   include Gjp::Mockers
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gjp
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.39.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -149,7 +149,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rubocop.yml
-- .rubocop_todo.yml
 - Gemfile
 - LICENSE
 - MOTIVATION.md
@@ -225,7 +224,6 @@ files:
 - spec/lib/archiver_spec.rb
 - spec/lib/git_spec.rb
 - spec/lib/kit_checker_spec.rb
-- spec/lib/kit_runner_spec.rb
 - spec/lib/maven_runner_spec.rb
 - spec/lib/maven_website_spec.rb
 - spec/lib/pom_getter_spec.rb
@@ -237,6 +235,7 @@ files:
 - spec/lib/template_manager_spec.rb
 - spec/lib/version_matcher_spec.rb
 - spec/spec_helper.rb
+- spec/support/kit_runner_examples.rb
 - utils/delete_nonet_user.sh
 - utils/setup_nonet_user.sh
 homepage: https://github.com/SilvioMoioli/gjp
@@ -285,7 +284,6 @@ test_files:
 - spec/lib/archiver_spec.rb
 - spec/lib/git_spec.rb
 - spec/lib/kit_checker_spec.rb
-- spec/lib/kit_runner_spec.rb
 - spec/lib/maven_runner_spec.rb
 - spec/lib/maven_website_spec.rb
 - spec/lib/pom_getter_spec.rb
@@ -297,3 +295,4 @@ test_files:
 - spec/lib/template_manager_spec.rb
 - spec/lib/version_matcher_spec.rb
 - spec/spec_helper.rb
+- spec/support/kit_runner_examples.rb

data/.rubocop_todo.yml

@@ -1,111 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-05-23 15:40:35 +0200 using RuboCop version 0.22.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 8
-Documentation:
-  Enabled: false
-
-# Offense count: 1
-DoubleNegation:
-  Enabled: false
-
-# Offense count: 1
-EmptyLinesAroundAccessModifier:
-  Enabled: false
-
-# Offense count: 2
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Encoding:
-  Enabled: false
-
-# Offense count: 9
-# Configuration parameters: AlignWith, SupportedStyles.
-EndAlignment:
-  Enabled: false
-
-# Offense count: 2
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-FormatString:
-  Enabled: false
-
-# Offense count: 4
-# Configuration parameters: MinBodyLength.
-GuardClause:
-  Enabled: false
-
-# Offense count: 7
-# Configuration parameters: MaxLineLength.
-IfUnlessModifier:
-  Enabled: false
-
-# Offense count: 28
-# Configuration parameters: CountComments.
-MethodLength:
-  Max: 34
-
-# Offense count: 6
-MultilineBlockChain:
-  Enabled: false
-
-# Offense count: 3
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Next:
-  Enabled: false
-
-# Offense count: 3
-# Configuration parameters: NamePrefixBlacklist.
-PredicateName:
-  Enabled: false
-
-# Offense count: 4
-# Configuration parameters: SupportedStyles.
-RaiseArgs:
-  EnforcedStyle: compact
-
-# Offense count: 1
-# Configuration parameters: MaxSlashes.
-RegexpLiteral:
-  Enabled: false
-
-# Offense count: 1
-ShadowingOuterLocalVariable:
-  Enabled: false
-
-# Offense count: 5
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-SignalException:
-  Enabled: false
-
-# Offense count: 4
-# Cop supports --auto-correct.
-SpecialGlobalVars:
-  Enabled: false
-
-# Offense count: 7
-Tab:
-  Enabled: false
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
-TrivialAccessors:
-  Enabled: false
-
-# Offense count: 8
-# Cop supports --auto-correct.
-UnusedBlockArgument:
-  Enabled: false
-
-# Offense count: 6
-UselessAssignment:
-  Enabled: false
-
-# Offense count: 6
-# Cop supports --auto-correct.
-WordArray:
-  MinSize: 2