gjp 0.11.1 → 0.11.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gjp (0.10.2)
+    gjp (0.11.2)
       clamp
       json
       nokogiri

data/lib/gjp/cli.rb

@@ -2,16 +2,9 @@
 require "gjp/logger"
 require "clamp"
 
-# Initialize global logger for CLI
-Gjp.logger = ::Logger.new(STDERR)
-Gjp.logger.datetime_format = "%Y-%m-%d %H:%M "
-Gjp.logger.level = ::Logger::ERROR
-Gjp.logger.formatter = proc do |severity, datetime, progname, msg|
-  "#{severity.chars.first}: #{msg}\n"
-end
-
 module Gjp
   class MainCommand < Clamp::Command
+    include Logger
 
     # Common logging options
     option ["-v", "--verbose"], :flag, "verbose output"
@@ -32,13 +25,13 @@ module Gjp
 
     def configure_log_level(v, vv, vvv)
       if vvv
-        Gjp.logger.level = Logger::DEBUG
+        log.level = ::Logger::DEBUG
       elsif vv
-        Gjp.logger.level = Logger::INFO
+        log.level = ::Logger::INFO
       elsif v
-        Gjp.logger.level = Logger::WARN
+        log.level = ::Logger::WARN
       else
-        Gjp.logger.level = Logger::ERROR
+        log.level = ::Logger::ERROR
       end
     end
 
@@ -46,38 +39,36 @@ module Gjp
     subcommand "init", "Inits a gjp project in the current directory" do
       def execute
         Gjp::Project.init(".")
-        puts "Project inited."
-        puts "Use \"gjp gather\" before adding files to have gjp track them."
+        puts "Project inited, now gathering."
+        puts "Any file added to kit/ will be added to the kit package."
+        puts "Any file added to src/<orgId_artifactId_version> will be added to the corresponding package."
+        puts "Note that .gitignore files are honored!"
+        puts "When you are ready to test a dry-run build, use \"gjp dry-run\"."
       end
     end
 
     subcommand "gather", "Starts a gathering phase, add source and kit files to project" do
       def execute
-        result = Gjp::Project.new(".").gather
-        if result == :done
+        if Gjp::Project.new(".").gather
           puts "Now gathering."
           puts "Any file added to kit/ will be added to the kit package."
           puts "Any file added to src/<orgId_artifactId_version> will be added to the corresponding package."
           puts "Note that .gitignore files are honored!"
-          puts "To finalize this gathering, use \"gjp finish\"."
-        else
-          puts "Cannot begin gathering while #{result}, use \"gjp finish\" first."
+          puts "When you are ready to test a dry-run build, use \"gjp dry-run\"."
         end
       end
     end
 
     subcommand "dry-run", "Starts a dry-run phase, attempt build to add dependencies to kit." do
       def execute
-        result = Gjp::Project.new(".").dry_run
-        if result == :done
+        if Gjp::Project.new(".").dry_run
           puts "Now dry-running, please start your build."
           puts "Any file added to kit/, presumably downloaded dependencies, will be added to the kit package."
           puts "The src/ directory and all files in it will be brought back to the current state when finished."
           puts "Note that .gitignore files are honored!"
           puts "To run a Maven from the kit, use \"gjp mvn\"."
+          puts "To add or remove files, use \"gjp gather\"."
           puts "To finalize this dry run, use \"gjp finish\"."
-        else
-          puts "Cannot begin a dry run while #{result}, use \"gjp finish\" first."
         end
       end
     end
@@ -96,6 +87,11 @@ module Gjp
       end
     end
 
+    subcommand "status", "Prints the current phase" do
+      def execute
+        puts "Now #{Gjp::Project.new(".").get_status.to_s}"
+      end
+    end
 
     subcommand "finish", "Finishes the current phase" do
       def execute
@@ -136,14 +132,14 @@ module Gjp
     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"
       def execute
-        puts Gjp::PomGetter.get_pom(name)
+        puts Gjp::PomGetter.new.get_pom(name)
       end
     end
 
     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
-        puts Gjp::ParentPomGetter.get_parent_pom(pom)
+        puts Gjp::ParentPomGetter.new.get_parent_pom(pom)
       end
     end
       
@@ -151,7 +147,7 @@ module Gjp
       parameter "POM", "a pom file path or URI"
 
       def execute
-        puts Gjp::SourceAddressGetter.get_source_address(pom)
+        puts Gjp::SourceAddressGetter.new.get_source_address(pom)
       end    
     end
     
@@ -161,7 +157,7 @@ module Gjp
       parameter "[DIRECTORY]", "directory in which to save the source code", :default => "."
 
       def execute
-        puts Gjp::SourceGetter.get_source(address, pom, directory)
+        puts Gjp::SourceGetter.new.get_source(address, pom, directory)
       end    
     end
 

data/lib/gjp/jar_table.rb

@@ -7,9 +7,7 @@ module Gjp
   # assumes the project is in a directory with jar files
   # in its (possibly nested) subdirectories
   class JarTable
-    def log
-      Gjp.logger
-    end
+    include Logger
 
     attr_reader :rows, :runtime_required_packages, :source_defined_packages
 

data/lib/gjp/limited_network_user.rb

@@ -6,9 +6,7 @@ module Gjp
   # encapsulates a Linux user that cannot access the Internet
   # assumes root access (sudo) and iptables are available
   class LimitedNetworkUser
-    def log
-      Gjp.logger
-    end
+    include Logger
 
     def initialize(name)
       @name = name

data/lib/gjp/logger.rb

@@ -3,15 +3,25 @@
 require "logger"
 
 module Gjp
-  def self.logger=(logger)
-    @logger = logger
-  end
+  module Logger
+    @@logger = nil
 
-  def self.logger
-    @logger ||= Logger.new('/dev/null')
-  end
+    # returns a logger instance
+    def self.log
+      if @@logger == nil
+        @@logger = ::Logger.new(STDERR)
+        @@logger.datetime_format = "%Y-%m-%d %H:%M "
+        @@logger.level = ::Logger::ERROR
+        @@logger.formatter = proc do |severity, datetime, progname, msg|
+          "#{severity.chars.first}: #{msg}\n"
+        end
+      end
+      @@logger
+    end
 
-  def logger
-    Gjp.logger
+    # convenience instance method
+    def log
+      Gjp::Logger.log
+    end
   end
 end

data/lib/gjp/maven_runner.rb

@@ -6,9 +6,7 @@ require 'pathname'
 module Gjp
   # runs Maven from a gjp kit with gjp-specific options
   class MavenRunner
-    def log
-      Gjp.logger
-    end
+    include Logger
 
     def initialize(project)      
       @project = project

data/lib/gjp/maven_website.rb

@@ -5,9 +5,7 @@ require "text"
 module Gjp
   # Facade to search.maven.org
   class MavenWebsite 
-    def log
-      Gjp.logger
-    end
+    include Logger
 
     # returns a search result object from search.maven.com
     # searching by a jar sha1 hash

data/lib/gjp/parent_pom_getter.rb

@@ -5,13 +5,10 @@ require "pathname"
 module Gjp
   # attempts to get a pom's parent pom
   class ParentPomGetter
-
-    def self.log
-      Gjp.logger
-    end
+    include Logger
 
     # returns the pom's parent, if any
-    def self.get_parent_pom(filename)
+    def get_parent_pom(filename)
       begin
         pom = Pom.new(filename)
         site = MavenWebsite.new

data/lib/gjp/pom_getter.rb

@@ -11,18 +11,15 @@ require "gjp/version_matcher"
 module Gjp
   # attempts to get java projects' pom file
   class PomGetter
-
-    def self.log
-      Gjp.logger
-    end
+    include Logger
 
     # returns the pom corresponding to a filename
-    def self.get_pom(filename)
+    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 self.get_pom_from_dir(dir)
+    def get_pom_from_dir(dir)
       if File.directory?(dir)
         pom_path = File.join(dir, "pom.xml")
         if File.file?(pom_path)
@@ -33,7 +30,7 @@ module Gjp
     end
     
     # returns a pom embedded in a jar file
-    def self.get_pom_from_jar(file)
+    def get_pom_from_jar(file)
       begin
         Zip::ZipFile.foreach(file) do |entry|
           if entry.name =~ /\/pom.xml$/
@@ -50,7 +47,7 @@ module Gjp
     end
     
     # returns a pom from search.maven.org with a jar sha1 search
-    def self.get_pom_from_sha1(file)
+    def get_pom_from_sha1(file)
       begin
         if File.file?(file)
           site = MavenWebsite.new
@@ -70,18 +67,19 @@ module Gjp
     end
 
     # returns a pom from search.maven.org with a heuristic name search
-    def self.get_pom_from_heuristic(filename)
+    def get_pom_from_heuristic(filename)
       begin
         site = MavenWebsite.new
         filename = Pathname.new(filename).basename.to_s.sub(/.jar$/, "")
-        my_artifact_id, my_version = VersionMatcher.split_version(filename)
+        version_matcher = VersionMatcher.new
+        my_artifact_id, my_version = version_matcher.split_version(filename)
 
         result = site.search_by_name(my_artifact_id).first
         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)
           their_versions = results.map {|doc| doc["v"]}
-          best_matched_version = if my_version != nil then VersionMatcher.best_match(my_version, their_versions) else their_versions.max end
+          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
             
           group_id, artifact_id, version = site.get_maven_id_from(best_matched_result)

data/lib/gjp/project.rb

@@ -5,9 +5,10 @@ require 'find'
 module Gjp
   # encapsulates a Gjp project directory
   class Project
-    def log
-      Gjp.logger
-    end
+    include Logger
+
+    # list of possible statuses
+    @@statuses = [:gathering, :dry_running]
 
     attr_accessor :full_path
 
@@ -37,38 +38,43 @@ module Gjp
     # inits a new project directory structure
     def self.init(dir)
       Dir.chdir(dir) do
-        `git init`
-
-        Dir.mkdir("src")
-        File.open(File.join("src", "README"), "w") do |file|
-          file.puts "Sources are to be placed in subdirectories named after Maven names: orgId_artifactId_version"
-        end
-        Dir.mkdir("kit")
-        File.open(File.join("kit", "README"), "w") do |file|
-          file.puts "Build tool binaries are to be placed here"
+        if Dir.exists?(".git") == false
+          `git init`
         end
 
+        copy_from_template "file_lists", "."
+        copy_from_template "src", "."
+        copy_from_template "kit", "."
+
         `git add .`
         `git commit -m "Project initialized"`
-        `git tag init`
+  
+        # automatically begin a gathering phase
+        Project.new(".").gather
       end
     end
 
+    # copies a file/dir from the template directory to the destination directory
+    def self.copy_from_template(template_file, destination_dir)
+      FileUtils.cp_r(File.join(File.dirname(__FILE__), "..", "template", template_file), destination_dir)
+    end
+
     # starts a gathering phase, all files added to the project
     # will be added to packages (including kit)
     def gather
       from_directory do
-        if get_status(:gathering)
-          return :gathering
-        elsif get_status(:dry_running)
-          return :dry_running
+        status = get_status
+        if status == :gathering
+          return false
+        elsif status == :dry_running
+          finish
         end
 
-        set_status(:gathering)
-        commit_all("Gathering started")
+        set_status :gathering
+        take_snapshot "Gathering started", :revertable
       end
 
-      :done
+      true
     end
 
     # starts a dry running phase: files added to the kit will
@@ -76,46 +82,48 @@ module Gjp
     # end
     def dry_run
       from_directory do
-        if get_status(:gathering)
-          return :gathering
-        elsif get_status(:dry_running)
-          return :dry_running
+        status = get_status
+        if status == :dry_running
+          return false
+        elsif status == :gathering
+          finish
         end
 
-        set_status(:dry_running)
-        commit_all("Dry-run started")
+        set_status :dry_running
+        take_snapshot "Dry-run started", :revertable
       end
 
-      :done
+      true
     end
 
     # ends any phase that was previously started, 
     # generating file lists
     def finish
       from_directory do
-        if get_status(:gathering)
-          commit_all("Changes during gathering")
+        status = get_status
+        if status == :gathering
+          take_snapshot "Changes during gathering"
 
-          update_changed_file_list("kit", "gjp_kit_file_list")
-          update_changed_src_file_list(:file_list)
-          commit_all("File list updates")
+          update_changed_file_list("kit", "kit")
+          update_changed_src_file_list(:input)
+          take_snapshot "File list updates"
 
-          clear_status(:gathering)
-          commit_all("Gathering finished")
+          set_status nil
+          take_snapshot "Gathering finished", :revertable
 
           :gathering
-        elsif get_status(:dry_running)
-          commit_all("Changes during dry-run")
+        elsif status == :dry_running
+          take_snapshot "Changes during dry-run"
 
-          update_changed_file_list("kit", "gjp_kit_file_list")
-          update_changed_src_file_list(:produced_file_list)
-          commit_all("File list updates")
+          update_changed_file_list("kit", "kit")
+          update_changed_src_file_list(:output)
+          take_snapshot "File list updates"
 
-          revert("src", 2)
-          commit_all("Sources reverted as before dry-run")
+          revert("src")
+          take_snapshot "Sources reverted as before dry-run"
 
-          clear_status(:dry_running)
-          commit_all("Dry run finished")
+          set_status nil
+          take_snapshot "Dry run finished", :revertable
 
           :dry_running
         end
@@ -124,84 +132,103 @@ module Gjp
 
     def update_changed_src_file_list(list_name)
       Dir.foreach("src") do |entry|
-        if File.directory?(File.join(Dir.getwd, "src", entry)) and entry =~ /([^_\/]+_[^_]+_[^_]+)$/
-          update_changed_file_list(File.join("src", entry), "gjp_#{$1}_#{list_name.to_s}")
+        if File.directory?(File.join(Dir.getwd, "src", entry)) and entry =~ /([^:\/]+:[^:]+:[^:]+)$/
+          update_changed_file_list(File.join("src", entry), "#{$1}_#{list_name.to_s}")
         end
       end
     end
 
-    def update_changed_file_list(directory, list_file)
-      existing_files = if File.exists?(list_file)
+    def update_changed_file_list(directory, file_name)
+      list_file = File.join("file_lists", file_name)
+      tracked_files = if File.exists?(list_file)
         File.readlines(list_file)
       else
         []
       end
 
-      files = (
+      new_tracked_files = (
         `git diff-tree --no-commit-id --name-only -r HEAD`.split("\n")
         .select { |file| file.start_with?(directory) }
         .map { |file|file[directory.length + 1, file.length]  }
-        .concat(existing_files)
+        .concat(tracked_files)
         .sort
         .uniq
       )
 
-      log.debug("writing file list for #{directory}: #{files.to_s}")
+      log.debug("writing file list for #{directory}: #{new_tracked_files.to_s}")
 
         
       File.open(list_file, "w+") do |file_list|
-        files.each do |file|
+        new_tracked_files.each do |file|
           file_list.puts file
         end
       end
     end
 
     # adds the project's whole contents to git
-    def commit_all(message)
-      Find.find(".") do |path|
-        if path =~ /.gitignore$/
-          puts "Deleting #{path} to preserve all files..."
-          File.delete(path)
-        end
-      end
-
+    # if tag is given, commit is tagged
+    def take_snapshot(message, revertability = :not_revertable)
       log.debug "committing with message: #{message}"
 
       `git rm -r --cached .`
       `git add .`
       `git commit -m "#{message}"`
+
+      if revertability == :revertable
+        latest_count = if latest_snapshot_name =~ /^gjp_revertable_snapshot_([0-9]+)$/
+          $1
+        else
+          0
+        end
+        `git tag gjp_revertable_snapshot_#{$1.to_i + 1}`
+      end
+    end
+
+    # returns the last snapshot git tag name
+    def latest_snapshot_name
+      `git describe --abbrev=0 --tags --match=gjp_revertable_snapshot_*`.strip
     end
 
     # reverts dir contents as commit_count commits ago
-    def revert(dir, commit_count)
+    def revert(dir)
       `git rm -rf --ignore-unmatch #{dir}`
-      `git checkout -f HEAD~#{commit_count} -- #{dir}`
+      `git checkout -f #{latest_snapshot_name} -- #{dir}`
 
       `git clean -f -d #{dir}`
     end
 
-    # gets a project status flag
-    def get_status(status)
-      file_name = status_file_name(status)
-      File.exists?(file_name)
-    end
-
-    # sets a project status flag
-    def set_status(status)
-      file_name = status_file_name(status)
-      if File.exists?(file_name) == false
-        FileUtils.touch(file_name)
+    # returns a symbol with the current status
+    # flag
+    def get_status
+      from_directory do
+        @@statuses.each do |status|
+          if File.exists?(status_file_name(status))
+            return status
+          end
+        end
       end
+
+      nil
     end
 
-    # sets a project status flag
-    def clear_status(status)
-      file_name = status_file_name(status)
-      if File.exists?(file_name)
-        File.delete(file_name)
+    # sets a project status flag. if status = nil,
+    # clears all status flags
+    def set_status(status)
+      from_directory do
+        @@statuses.each do |a_status|
+          file_name = status_file_name(a_status)
+          if File.exists?(file_name)
+            File.delete(file_name)
+          end
+
+          if a_status == status
+            FileUtils.touch(file_name)
+          end
+        end
       end
     end
 
+    # returns a file name that represents a status
     def status_file_name(status)
       ".#{status.to_s}"
     end