gjp 0.20.0 → 0.21.0

data/README.md

@@ -50,7 +50,7 @@ Note that:
 * a `gjp` project can be used to build a number of packages that share one binary kit. This can help if the kit becomes big in size;
 * `gjp` will take advantage of Maven's pom files to generate its specs if they are available. This allows to precompile most spec fields automatically.
 
-### Sample project (commons-io)
+### Sample project (commons-collections)
 
 #### Initialization and project setup
 
@@ -91,7 +91,7 @@ Success! Now we have to tell gjp to return in normal mode:
 
     gjp finish
 
-At this point `gjp` restored `src/` as it was before the build and listed outputs in `file_lists/commons-collections_output`. Those will be used later to compile the `%install` and `%files` sections of the project spec.
+At this point `gjp` restored `src/` as it was before the build and listed outputs in `output/commons-collections/produced_file_list`. It will be used later to compile the `%install` and `%files` sections of the project spec.
 
 Note that, if the build was unsusccesful, the following command can be used to cancel it and return to pre-dry running state:
 
@@ -112,22 +112,21 @@ Of course this script can also be manually modified, and it must be in more diff
 The following command will generate the kit spec:
 
     gjp generate-kit-spec
-    less specs/galaxy-kit.spec
+    less output/galaxy-kit/galaxy-kit.spec
 
 Nothing fancy here, the spec simply copies `kit/` contents in a special directory to be available for later compilation of packages.
 You can also edit the spec 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).
 
-You can also generate the corresponding .tar.xz file with:
+You can also generate the corresponding .tar.xz file in `output/galaxy-kit/` with:
 
     gjp generate-kit-archive
 
-The contents of this file were tracked by `gjp` during gathering and dry-run phases, and are listed in `file_lists/kit`. You can also edit it if you want.
 
 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-spec commons-collections src/commons-collections/commons-collections-3.2.1-src/pom.xml
     gjp generate-package-archive commons-collections
-    less specs/commons-collections.spec
+    less output/commons-collections/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`.
 

data/lib/gjp/archiver.rb

@@ -11,7 +11,9 @@ module Gjp
 
     # generates an archive for the kit package
     def archive_kit
-      destination_file = File.join(@project.full_path, "archives/#{@project.name}-kit.tar.xz")
+      destination_dir = File.join(@project.full_path, "output", "#{@project.name}-kit")
+      FileUtils.mkdir_p(destination_dir)
+      destination_file = File.join(destination_dir, "#{@project.name}-kit.tar.xz")
 
       archive("kit", destination_file)
       
@@ -20,7 +22,9 @@ module Gjp
 
     # generates an archive for a project's package based on its file list
     def archive_package(name)
-      destination_file = File.join(@project.full_path, "archives/#{name}.tar.xz")
+      destination_dir = File.join(@project.full_path, "output", name)
+      FileUtils.mkdir_p(destination_dir)
+      destination_file = File.join(destination_dir, "#{name}.tar.xz")
 
       archive(File.join("src", name), destination_file)
 

data/lib/gjp/cli.rb

@@ -93,7 +93,7 @@ module Gjp
       end
     end
 
-    subcommand "generate-build-script", "Creates or refreshes a build.sh file" do
+    subcommand "generate-build-script", "Create or refresh a build.sh file" do
       parameter "NAME", "name of a package, that is, an src/ subdirectory name"
       def execute
         checking_exceptions do
@@ -108,7 +108,7 @@ module Gjp
       end
     end
 
-    subcommand "generate-kit-spec", "Creates or refreshes a spec file for the kit" do
+    subcommand "generate-kit-spec", "Create or refresh a spec file for the kit" do
       def execute
         checking_exceptions do
           project = Gjp::Project.new(".")
@@ -121,7 +121,7 @@ module Gjp
       end
     end
 
-    subcommand "generate-kit-archive", "Archives contents of kit in archives/" do
+    subcommand "generate-kit-archive", "Create or refresh the kit tarball" do
       def execute
         checking_exceptions do
           project = Gjp::Project.new(".")
@@ -131,7 +131,7 @@ module Gjp
       end
     end
 
-    subcommand "generate-package-spec", "Creates or refreshes a spec file for a package" do
+    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"
@@ -139,20 +139,15 @@ module Gjp
         checking_exceptions do
           project = Gjp::Project.new(".")
           result_path, conflict_count = Gjp::SpecGenerator.new(project).generate_package_spec name, pom, filter
-          if result_path != nil
-            puts "#{result_path} generated"
-            if conflict_count > 0
-              puts "Warning: #{conflict_count} unresolved conflicts"
-            end
-          else
-            $stderr.puts "file_list/#{name}_output not found. Ensure you have already run a" +
-            "\"gjp dry run\" and \"gjp finish\"."
+          puts "#{result_path} generated"
+          if conflict_count > 0
+            puts "Warning: #{conflict_count} unresolved conflicts"
           end
         end
       end
     end
 
-    subcommand "generate-package-archive", "Archives contents of a package in archives/" do
+    subcommand "generate-package-archive", "Create or refresh a package tarball" do
       parameter "NAME", "name of a package, that is, an src/ subdirectory name"
       def execute
         checking_exceptions do

data/lib/gjp/package_spec_adapter.rb

@@ -36,11 +36,15 @@ module Gjp
       @runtime_dependency_ids = pom.runtime_dependency_ids
       @description = cleanup_description(pom.description, 1500)
 
-      output_list = File.join(project.full_path, "file_lists", "#{@name}_output")
-      @outputs = File.open(output_list).readlines.map do |line|
-        line.strip
-      end.select do |line|
-        File.fnmatch? filter, File.basename(line.strip)
+      produced_file_list = File.join(project.full_path, "output", @name, "produced_file_list")
+      @outputs = if File.exist?(produced_file_list)
+        File.open(produced_file_list).readlines.map do |line|
+          line.strip
+        end.select do |line|
+          File.fnmatch? filter, File.basename(line.strip)
+        end
+      else
+        []
       end
     end
 

data/lib/gjp/project.rb

@@ -38,19 +38,16 @@ module Gjp
       Dir.chdir(dir) do
         Gjp::Git.new(".").init
 
-        Dir.mkdir "src"
-        Dir.mkdir "kit"
+        FileUtils.mkdir_p "src"
+        FileUtils.mkdir_p "kit"
 
         # populate the project with templates and take a snapshot
         project = Project.new(".")
 
         template_manager = Gjp::TemplateManager.new
-        template_manager.copy "archives", "."
-        template_manager.copy "file_lists", "."
+        template_manager.copy "output", "."
         template_manager.copy "kit", "."
-        template_manager.copy "specs", "."
         template_manager.copy "src", "."
-        template_manager.copy ".gitignore", ".gitignore"
 
         project.take_snapshot "Template files added", :init
       end
@@ -86,7 +83,7 @@ module Gjp
         else
           take_snapshot "Changes during dry-run"
 
-          update_output_file_lists
+          update_produced_file_lists
           take_snapshot "File list updates"
 
           @git.revert_whole_directory("src", latest_tag(:dry_run_started))
@@ -101,19 +98,29 @@ module Gjp
 
     # updates files that contain lists of the output files produced by
     # the build of each package
-    def update_output_file_lists
-      each_package_directory do |directory|
+    def update_produced_file_lists
+      each_package_directory do |name, path|
+        FileUtils.mkdir_p(File.join("output", name))
+
+        list_file = File.join("output", name, "produced_file_list")
+        tracked_files = if File.exists?(list_file)
+          File.readlines(list_file).map { |line| line.strip }
+        else
+          []
+        end
+
         files = (
           @git.changed_files_since(latest_tag(:dry_run_started))
-            .select { |file| file.start_with?(directory) }
-            .map { |file|file[directory.length + 1, file.length] }
+            .select { |file| file.start_with?(path) }
+            .map { |file|file[path.length + 1, file.length] }
+            .concat(tracked_files)
+            .uniq
             .sort
         )
 
-        log.debug("writing file list for #{directory}: #{files.to_s}")
+        log.debug("writing file list for #{path}: #{files.to_s}")
 
-        list_path = File.join("file_lists", "#{Pathname.new(directory).basename}_output")
-        File.open(list_path, "w+") do |file_list|
+        File.open(list_file, "w+") do |file_list|
           files.each do |file|
             file_list.puts file
           end
@@ -185,7 +192,7 @@ module Gjp
         Dir.foreach("src") do |entry|
           if File.directory?(File.join(Dir.getwd, "src", entry)) and entry != "." and entry != ".."
             directory = File.join("src", entry)
-            yield directory
+            yield entry, directory
           end
         end
       end

data/lib/gjp/spec_generator.rb

@@ -10,18 +10,17 @@ module Gjp
     end
 
     def generate_kit_spec
-      spec_path = File.join("specs", "#{@project.name}-kit.spec")
+      destination_dir = File.join(@project.full_path, "output", "#{@project.name}-kit")
+      FileUtils.mkdir_p(destination_dir)
+      spec_path = File.join(destination_dir, "#{@project.name}-kit.spec")
       conflict_count = generate_merging("kit.spec", @project.get_binding, spec_path, :generate_kit_spec)
       [spec_path, conflict_count]
     end
 
     def generate_package_spec(name, pom, filter)
-      spec_path = File.join("specs", "#{name}.spec")
-
-      list_file = File.join(@project.full_path, "file_lists/#{name}_output")
-      if not File.exist? list_file
-        return nil
-      end
+      destination_dir = File.join(@project.full_path, "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)
 

data/lib/gjp/version.rb

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

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

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

data/lib/template/output/CONTENTS

@@ -0,0 +1,3 @@
+gjp will save all output files it generates (specs, archives, etc.) here.
+
+Feel free to use this directory as an OBS project root.

data/spec/lib/archiver_spec.rb

@@ -37,7 +37,7 @@ describe Gjp::Archiver do
 
       archiver.archive_kit
       @project.from_directory do
-        `tar -Jtf archives/test-project-kit.tar.xz`.split.should include("kit_test")
+        `tar -Jtf output/test-project-kit/test-project-kit.tar.xz`.split.should include("kit_test")
       end
     end
   end
@@ -52,7 +52,7 @@ describe Gjp::Archiver do
 
       archiver.archive_package "package-name"
       @project.from_directory do
-        `tar -Jtf archives/package-name.tar.xz`.split.should include("src_test")
+        `tar -Jtf output/package-name/package-name.tar.xz`.split.should include("src_test")
       end
     end
   end

data/spec/lib/project_spec.rb

@@ -99,7 +99,7 @@ describe Gjp::Project do
       @project.from_directory do
         `git rev-list --all`.split("\n").length.should eq 5
         File.read("src/abc/test").should eq "A\n"
-        File.readlines(File.join("file_lists", "abc_output")).should include("test2\n")
+        File.readlines(File.join("output", "abc", "produced_file_list")).should include("test2\n")
 
         `git diff-tree --no-commit-id --name-only -r HEAD~`.split("\n").should_not include("src/abc/test2")
         File.exists?("src/abc/test2").should be_false
@@ -135,7 +135,7 @@ describe Gjp::Project do
         File.read("kit/test").should eq "A\n"
         File.exists?("kit/test2").should be_false
 
-        File.exists?(File.join("file_lists", "abc_output")).should be_false
+        File.exists?(File.join("output", "abc", "produced_file_list")).should be_false
       end
     end
   end

data/spec/lib/spec_generator_spec.rb

@@ -29,7 +29,7 @@ describe Gjp::SpecGenerator do
       @spec_generator.generate_kit_spec.should be_true
 
       @project.from_directory do
-        spec_lines = File.readlines(File.join("specs", "test-project-kit.spec"))
+        spec_lines = File.readlines(File.join("output", "test-project-kit", "test-project-kit.spec"))
         spec_lines.should include("Name:           test-project-kit\n")
         spec_lines.should include("Version:        1\n")
         spec_lines.should include("Source0:        %{name}.tar.xz\n")
@@ -42,7 +42,7 @@ describe Gjp::SpecGenerator do
         test_file = File.join("kit", "test")
         File.open(test_file, "w") { |io| io.puts "changed kit content test file" }
 
-        File.open(File.join("specs", "test-project-kit.spec"), "a") do |io|
+        File.open(File.join("output", "test-project-kit", "test-project-kit.spec"), "a") do |io|
           io.write("nonconflicting line")
         end
       end
@@ -51,7 +51,7 @@ describe Gjp::SpecGenerator do
       @spec_generator.generate_kit_spec.should be_true
 
       @project.from_directory do
-        spec_lines = File.readlines(File.join("specs", "test-project-kit.spec"))
+        spec_lines = File.readlines(File.join("output", "test-project-kit", "test-project-kit.spec"))
         spec_lines.should include("Name:           test-project-kit\n")
         spec_lines.should include("Version:        2\n")
         spec_lines.should include("Source0:        %{name}.tar.xz\n")
@@ -65,7 +65,7 @@ describe Gjp::SpecGenerator do
         test_file = File.join("kit", "test")
         File.open(test_file, "w") { |io| io.puts "changed kit content test file" }
 
-        spec_path = File.join("specs", "test-project-kit.spec")
+        spec_path = File.join("output", "test-project-kit", "test-project-kit.spec")
         spec_contents = File.read spec_path
 
         spec_contents.gsub! /^Version:.*$/, "CONFLICTING!"
@@ -79,7 +79,7 @@ describe Gjp::SpecGenerator do
       @spec_generator.generate_kit_spec.should be_true
 
       @project.from_directory do
-        spec_lines = File.readlines(File.join("specs", "test-project-kit.spec"))
+        spec_lines = File.readlines(File.join("output", "test-project-kit", "test-project-kit.spec"))
         spec_lines.should include("Name:           test-project-kit\n")
         spec_lines.should include("Source0:        %{name}.tar.xz\n")
         spec_lines.should include("<<<<<<< newly generated\n")
@@ -115,7 +115,7 @@ describe Gjp::SpecGenerator do
       @spec_generator.generate_package_spec "test", File.join("spec", "data", "nailgun", "pom.xml"), "*.jar"
 
       @project.from_directory do
-        spec_lines = File.readlines(File.join("specs", "test.spec"))
+        spec_lines = File.readlines(File.join("output", "test", "test.spec"))
         spec_lines.should include("Name:           test\n")
         spec_lines.should include("License:        The Apache Software License, Version 2.0\n")
         spec_lines.should include("Summary:        Nailgun is a client, protocol, and server for running Java\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gjp
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
   prerelease: 
 platform: ruby
 authors:
@@ -176,14 +176,12 @@ files:
 - lib/gjp/template_manager.rb
 - lib/gjp/version.rb
 - lib/gjp/version_matcher.rb
-- lib/template/.gitignore
-- lib/template/archives/CONTENTS
-- lib/template/file_lists/CONTENTS
 - lib/template/kit.spec
 - lib/template/kit/CONTENTS
 - lib/template/kit/m2/settings.xml
+- lib/template/output/.gitignore
+- lib/template/output/CONTENTS
 - lib/template/package.spec
-- lib/template/specs/CONTENTS
 - lib/template/src/CONTENTS
 - spec/data/ant-super-simple-code/build.xml
 - spec/data/ant-super-simple-code/build/HW.class

data/lib/template/file_lists/CONTENTS

@@ -1,3 +0,0 @@
-gjp will generate file lists its internal use here.
-
-You should not edit them manually.

data/lib/template/specs/CONTENTS

@@ -1,3 +0,0 @@
-gjp will generate spec files for all packages here.
-
-You can edit them manually, if you wish, and also let gjp regenerate them later. If you do that, gjp will use three-way merge if possible (prompting in case any conflict arise).