gjp 0.23.0 → 0.24.0

data/README.md

@@ -101,7 +101,7 @@ Note that, if the build was unsusccesful, the following command can be used to c
 
 `gjp` expects that all commands needed to build a package are in a `build.sh` script in `src/<package name>`. If you are a Bash user you are lucky - `gjp` can create one for you by looking at your command history! Just type:
 
-    gjp generate-package-script commons-collections
+    gjp generate-package-script
 
 Note that `gjp` will substitute the `gjp mvn` calls with equivalent lines that are actually runnable on a build host without `gjp` itself.
 
@@ -123,14 +123,14 @@ You can inspect the generated "galaxy-kit.spec" file, but in general you should
 
 You can then generate the project spec and archive files provided you have a pom file (more formats will be supported in future). In this case:
 
-    gjp generate-package-archive commons-collections
-    gjp generate-package-spec commons-collections src/commons-collections/commons-collections-3.2.1-src/pom.xml
-    less output/commons-collections/commons-collections.spec
+    gjp generate-package-archive
+    gjp generate-package-spec
+    less ../commons-collections.spec
 
 commons-collection BuldRequires galaxy-kit, its archive contains only source files and it will install any produced .jar file in `/usr/lib/java`.
 You can also edit the specs file manually if you want. When you later regenerate it, `gjp` will automatically try to reconcile changes with a [three-way merge](http://en.wikipedia.org/wiki/Three-way_merge#Three-way_merge).
 
-Packages are ready to be submitted to an OBS project. As OBS integration is not yet implemented, refer to OBS documentation to do that.
+OBS users: note that the output/ directory created by gjp can be submitted or used as OBS project. Feel free to replace it with a symlink pointing at your home OBS project, or use symlinks from your OBS project to its contents.
 
 #### Ant packages
 
@@ -179,7 +179,7 @@ You are advised to use [Maven Central](http://search.maven.org/) to search for s
 
 ### Troubleshooting
 
-`gjp` internally uses `git` to keep track of files, any gjp project is actually also a `git` repo. Feel free to navigate it, you can commit, push and pull freely as long as the `gjp` tags are preserved. You can also delete commits and tags, effectively rewiding gjp history (just make sure to delete all tags pointing to a certain commit when you discard it).
+`gjp` internally uses `git` to keep track of files, any gjp project is actually also a `git` repo. Feel free to navigate it, you can commit, push and pull freely as long as the `gjp` tags are preserved. You can also delete commits and tags, effectively rewinding gjp history (just make sure to delete all tags pointing to a certain commit when you discard it).
 
 ## Motivation
 

data/integration-tests/commons.sh

@@ -23,15 +23,14 @@ cd ..
 gjp dry-run
 cd src/commons-collections/commons-collections-3.2.1-src/
 gjp mvn package -DskipTests
-cd ../../..
 gjp finish
 
 gjp generate-kit-archive
 gjp generate-kit-spec
-
-gjp generate-package-archive commons-collections
-gjp generate-package-spec commons-collections src/commons-collections/commons-collections-3.2.1-src/pom.xml
-
+gjp generate-package-script
+gjp generate-package-archive
+gjp generate-package-spec
+cd ../../..
 
 cd src
 mkdir commons-fileupload
@@ -43,14 +42,14 @@ rm commons-fileupload-1.3-src.zip
 gjp dry-run
 cd commons-fileupload-1.3-src/
 gjp mvn package -DskipTests
-cd ../../..
 gjp finish
 
 gjp generate-kit-archive -i
 gjp generate-kit-spec
-
-gjp generate-package-archive commons-fileupload
-gjp generate-package-spec commons-fileupload src/commons-fileupload/commons-fileupload-1.3-src/pom.xml
+gjp generate-package-script
+gjp generate-package-archive
+gjp generate-package-spec
+cd ../../..
 
 
 echo "**************** All Done ****************"

data/lib/gjp/cli.rb

@@ -134,12 +134,13 @@ module Gjp
     end
 
     subcommand "generate-package-script", "Create or refresh a build.sh file for a package" do
-      parameter "NAME", "name of a package, that is, an src/ subdirectory name"
+      parameter "[DIRECTORY]", "path to a package directory (src/<package name>)", :default => "."
       def execute
         checking_exceptions do
           project = Gjp::Project.new(".")
+          package_name = project.get_package_name(directory)
           history_file = File.join(Dir.home, ".bash_history")
-          result_path, conflict_count = Gjp::ScriptGenerator.new(project, history_file).generate_build_script(name)
+          result_path, conflict_count = Gjp::ScriptGenerator.new(project, history_file).generate_build_script(package_name)
           puts "#{format_path(result_path, project)} generated"
           if conflict_count > 0
             puts "Warning: #{conflict_count} unresolved conflicts"
@@ -150,12 +151,13 @@ module Gjp
 
     subcommand "generate-package-spec", "Create or refresh a spec file for a package" do
       option ["-f", "--filter"], "FILTER", "filter files to be installed by this spec", :default => "*.jar"
-      parameter "NAME", "name of a package, that is, an src/ subdirectory name"
-      parameter "POM", "a pom file path or URI"
+      parameter "[DIRECTORY]", "path to a package directory (src/<package name>)", :default => "."
+      parameter "[POM]", "a pom file path", :default => "pom.xml"
       def execute
         checking_exceptions do
           project = Gjp::Project.new(".")
-          result_path, conflict_count = Gjp::SpecGenerator.new(project).generate_package_spec name, pom, filter
+          package_name = project.get_package_name(directory)
+          result_path, conflict_count = Gjp::SpecGenerator.new(project).generate_package_spec package_name, pom, filter
           puts "#{format_path(result_path, project)} generated"
           if conflict_count > 0
             puts "Warning: #{conflict_count} unresolved conflicts"
@@ -165,11 +167,12 @@ module Gjp
     end
 
     subcommand "generate-package-archive", "Create or refresh a package tarball" do
-      parameter "NAME", "name of a package, that is, an src/ subdirectory name"
+      parameter "[DIRECTORY]", "path to a package directory (src/<package name>)", :default => "."
       def execute
         checking_exceptions do
           project = Gjp::Project.new(".")
-          result_path = Gjp::Archiver.new(project).archive_package name
+          package_name = project.get_package_name(directory)
+          result_path = Gjp::Archiver.new(project).archive_package package_name
           puts "#{format_path(result_path, project)} generated"
         end
       end
@@ -271,12 +274,14 @@ module Gjp
         $stderr.puts e
       rescue Errno::EEXIST => e
         $stderr.puts e
-      rescue NotGjpDirectoryException
-        $stderr.puts "This is not a gjp project directory, see gjp init"
-      rescue GitAlreadyInitedException
+      rescue NoProjectDirectoryError => e
+        $stderr.puts "#{e.directory} not a gjp project directory, see gjp init"
+      rescue NoPackageDirectoryException => e
+        $stderr.puts "#{e.directory} is not a gjp package directory, see README"
+      rescue GitAlreadyInitedError => e
         $stderr.puts "This directory is already a gjp project"
-      rescue Gjp::ExecutableNotFoundException
-        $stderr.puts "Executable not found in kit/ or any of its subdirectories"
+      rescue ExecutableNotFoundError => e
+        $stderr.puts "Executable #{e.executable} not found in kit/ or any of its subdirectories"
       end
     end
   end

data/lib/gjp/git.rb

@@ -18,7 +18,7 @@ module Gjp
         if Dir.exists?(".git") == false
           `git init`
         else
-          raise GitAlreadyInitedException
+          raise GitAlreadyInitedError
         end
       end
     end
@@ -80,10 +80,18 @@ module Gjp
     # reverts path contents as per specified tag
     def revert_whole_directory(path, tag)
       Dir.chdir(@directory) do
-        `git rm -rf --ignore-unmatch #{path}`
+        # reverts added and modified files, both in index and working tree
         `git checkout -f gjp_#{tag} -- #{path}`
 
-        `git clean -f -d #{path}`
+        # compute the list of deleted files
+        files_in_tag = `git ls-tree --name-only -r gjp_#{tag} -- #{path}`.split("\n")
+        files_in_head = `git ls-tree --name-only -r HEAD -- #{path}`.split("\n")
+        files_added_after_head = `git ls-files -o -- #{path}`.split("\n")
+        files_to_delete = files_in_head - files_in_tag + files_added_after_head
+
+        files_to_delete.each do |file|
+          File.delete(file)
+        end
       end
     end
 
@@ -115,6 +123,6 @@ module Gjp
     end
   end
 
-  class GitAlreadyInitedException < Exception
+  class GitAlreadyInitedError < StandardError
   end
 end

data/lib/gjp/kit_runner.rb

@@ -50,7 +50,7 @@ module Gjp
 
         "#{mvn_path} -Dmaven.repo.local=#{repo_path} -s#{config_path}"
       else
-        raise ExecutableNotFoundException
+        raise ExecutableNotFoundError.new("mvn")
       end
     end
 
@@ -69,11 +69,16 @@ module Gjp
 
         "#{ant_path}"
       else
-        raise ExecutableNotFoundException
+        raise ExecutableNotFoundError.new("ant")
       end
     end
   end
 
-  class ExecutableNotFoundException < Exception
+  class ExecutableNotFoundError < Exception
+    attr_reader :executable
+
+    def initialize(executable)
+      @executable = executable
+    end
   end
 end

data/lib/gjp/project.rb

@@ -30,7 +30,7 @@ module Gjp
         result = File.expand_path("..", result)
       end
 
-      raise NotGjpDirectoryException if result == "/"
+      raise NoProjectDirectoryError.new(starting_dir) if result == "/"
 
       result
     end
@@ -42,6 +42,23 @@ module Gjp
       File.directory?(File.join(dir, ".git"))
     end
 
+    # 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 and components.first == "src" and Dir.exist?(File.join(@full_path, components[0], components[1]))
+          components[1]
+        else
+          raise NoPackageDirectoryError
+        end
+      rescue ArgumentError, NoProjectDirectoryError
+        raise NoPackageDirectoryError.new(dir)
+      end
+    end
+
     # inits a new project directory structure
     def self.init(dir)
       Dir.chdir(dir) do
@@ -57,6 +74,7 @@ module Gjp
         template_manager.copy "output", "."
         template_manager.copy "kit", "."
         template_manager.copy "src", "."
+        template_manager.copy "gitignore", ".gitignore"
 
         project.take_snapshot "Template files added", :init
       end
@@ -210,6 +228,18 @@ module Gjp
     end
   end
 
-  class NotGjpDirectoryException < Exception
+  class NoProjectDirectoryError < StandardError
+    attr_reader :directory
+
+    def initialize(directory)
+      @directory = directory
+    end
+  end
+  class NoPackageDirectoryError < StandardError
+    attr_reader :directory
+
+    def initialize(directory)
+      @directory = directory
+    end
   end
 end

data/lib/gjp/spec_generator.rb

@@ -11,34 +11,50 @@ module Gjp
 
     def generate_kit_spec
       @project.from_directory do
-        destination_dir = File.join("output", "#{@project.name}-kit")
-        FileUtils.mkdir_p(destination_dir)
-        spec_path = File.join(destination_dir, "#{@project.name}-kit.spec")
+        spec_name = "#{@project.name}-kit.spec"
+        spec_path = File.join("kit", spec_name)
+        output_dir = File.join("output", "#{@project.name}-kit")
+        FileUtils.mkdir_p(output_dir)
 
         adapter = Gjp::KitSpecAdapter.new(@project)
-
         conflict_count = generate_merging("kit.spec", adapter.get_binding, spec_path, :generate_kit_spec)
+
+        symlink_to_output(spec_path, output_dir)
+
         [spec_path, conflict_count]
       end
     end
 
-    def generate_package_spec(name, pom, filter)
+    def generate_package_spec(name, pom_path, filter)
+      pom = Gjp::Pom.new(pom_path)
       @project.from_directory do
-        destination_dir = File.join("output", name)
-        FileUtils.mkdir_p(destination_dir)
-        spec_path = File.join(destination_dir, "#{name}.spec")
-
-        adapter = Gjp::PackageSpecAdapter.new(@project, name, Gjp::Pom.new(pom), filter)
+        spec_name = "#{name}.spec"
+        spec_path = File.join("src", name, spec_name)
+        output_dir = File.join("output", name)
+        FileUtils.mkdir_p(output_dir)
 
+        adapter = Gjp::PackageSpecAdapter.new(@project, name, pom, filter)
         conflict_count = generate_merging("package.spec", adapter.get_binding, spec_path, "generate_#{name}_spec")
+
+        symlink_to_output(spec_path, output_dir)
+
         [spec_path, conflict_count]
       end
     end
 
+    private
+
     # 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)      
     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)
+    end
   end
 end

data/lib/gjp/version.rb

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

data/lib/template/{output/.gitignore → gitignore}

@@ -1,2 +1,2 @@
 *.gjp_user_edited
-*.tar.xz
+output/

data/spec/lib/git_spec.rb

@@ -19,7 +19,7 @@ describe Gjp::Git do
     it "complains if a double initialization is attempted" do
       expect {
         @git.init
-      }.to raise_error(Gjp::GitAlreadyInitedException)
+      }.to raise_error(Gjp::GitAlreadyInitedError)
     end
   end
 

data/spec/lib/kit_runner_spec.rb

@@ -37,7 +37,7 @@ describe Gjp::KitRunner do
       end
     end
     it "doesn't return commandline options if Maven is not available" do
-      expect { @kit_runner.get_maven_commandline(".") }.to raise_error(Gjp::ExecutableNotFoundException)
+      expect { @kit_runner.get_maven_commandline(".") }.to raise_error(Gjp::ExecutableNotFoundError)
     end
   end
 
@@ -51,7 +51,7 @@ describe Gjp::KitRunner do
     end
     it "doesn't run Maven if it is not available" do
       @project.from_directory do
-        expect { @kit_runner.mvn([]) }.to raise_error(Gjp::ExecutableNotFoundException)
+        expect { @kit_runner.mvn([]) }.to raise_error(Gjp::ExecutableNotFoundError)
       end
     end
   end
@@ -67,7 +67,7 @@ describe Gjp::KitRunner do
       end
     end
     it "doesn't return commandline options if Ant is not available" do
-      expect { @kit_runner.get_ant_commandline(".") }.to raise_error(Gjp::ExecutableNotFoundException)
+      expect { @kit_runner.get_ant_commandline(".") }.to raise_error(Gjp::ExecutableNotFoundError)
     end
   end
 
@@ -81,7 +81,7 @@ describe Gjp::KitRunner do
     end
     it "doesn't run Ant if it is not available" do
       @project.from_directory do
-        expect { @kit_runner.ant([]) }.to raise_error(Gjp::ExecutableNotFoundException)
+        expect { @kit_runner.ant([]) }.to raise_error(Gjp::ExecutableNotFoundError)
       end
     end
   end

data/spec/lib/project_spec.rb

@@ -31,7 +31,54 @@ describe Gjp::Project do
 
       expect {
         Gjp::Project.find_project_dir(File.expand_path("..", @project_path)).should raise_error
-      }.to raise_error(Gjp::NotGjpDirectoryException)
+      }.to raise_error(Gjp::NoProjectDirectoryError)
+    end
+  end
+
+  describe ".get_package_name"  do
+    it "raises an error with a directory outside a gjp project" do
+      expect {
+        @project.get_package_name("/")
+      }.to raise_error(Gjp::NoPackageDirectoryError)
+    end
+
+    it "raises an error with a gjp project directory" do
+      expect {
+        @project.get_package_name(@project_path)
+      }.to raise_error(Gjp::NoPackageDirectoryError)
+    end
+
+    it "raises an error with a gjp kit directory" do
+      expect {
+        @project.get_package_name(File.join(@project_path, "kit"))
+      }.to raise_error(Gjp::NoPackageDirectoryError)
+    end
+
+    it "raises an error with a gjp src directory" do
+      expect {
+        @project.get_package_name(File.join(@project_path, "src"))
+      }.to raise_error(Gjp::NoPackageDirectoryError)
+    end
+
+    it "raises an error with a nonexisting package directory" do
+      expect {
+        @project.get_package_name(File.join(@project_path, "src", "test_package"))
+      }.to raise_error(Gjp::NoPackageDirectoryError)
+    end
+
+    it "returns the package on an existing package directory" do
+      FileUtils.mkdir_p(File.join(@project_path, "src", "test_package"))
+      @project.get_package_name(File.join(@project_path, "src", "test_package")).should eq "test_package"
+    end
+
+    it "returns the package on an existing package subdirectory" do
+      FileUtils.mkdir_p(File.join(@project_path, "src", "test_package", "subdir1"))
+      @project.get_package_name(File.join(@project_path, "src", "test_package", "subdir1")).should eq "test_package"
+    end
+
+    it "returns the package on an existing package subsubdirectory" do
+      FileUtils.mkdir_p(File.join(@project_path, "src", "test_package", "subdir1", "subdir2"))
+      @project.get_package_name(File.join(@project_path, "src", "test_package", "subdir1", "subdir2")).should eq "test_package"
     end
   end
 

data/spec/lib/spec_generator_spec.rb

@@ -114,7 +114,7 @@ describe Gjp::SpecGenerator do
       end
 
       FileUtils.copy(File.join("spec", "data", "nailgun", "pom.xml"), @project_path)
-      @spec_generator.generate_package_spec "test", "pom.xml", "*.jar"
+      @spec_generator.generate_package_spec "test", File.join(@project_path, "pom.xml"), "*.jar"
 
       @project.from_directory do
         spec_lines = File.readlines(File.join("output", "test", "test.spec"))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gjp
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2013-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -177,11 +177,11 @@ files:
 - lib/gjp/template_manager.rb
 - lib/gjp/version.rb
 - lib/gjp/version_matcher.rb
+- lib/template/gitignore
 - lib/template/kit.spec
 - lib/template/kit/CONTENTS
 - lib/template/kit/jars/CONTENTS
 - lib/template/kit/m2/settings.xml
-- lib/template/output/.gitignore
 - lib/template/output/CONTENTS
 - lib/template/package.spec
 - lib/template/src/CONTENTS