tetra 0.43.0 → 0.44.0

data/.rubocop.yml

@@ -5,7 +5,7 @@ LineLength:
   Max: 120
 
 MethodLength:
-  Max: 35
+  Max: 40
 
 StringLiterals:
   EnforcedStyle: double_quotes

data/README.md

@@ -68,11 +68,11 @@ Fourth, you need to show `tetra` how to build your package by running appropriat
 Note that we used `tetra mvn package` instead of `mvn package`: this will use of the Maven copy we put in `kit/` and the repository in `kit/m2`.
 Also note that this being a dry-run build, sources will be brought back to their original state after `tetra finish`, as this ensures build repeatability.
 
-Finally, generate build scripts, spec files and tarballs in the `output/` directory:
+Finally, generate build scripts, spec files and tarballs in the `packages/` directory:
 
     tetra generate-all
 
-Note that `tetra` will generate files for the commons-collections package and all binary-only build-time dependencies (basically, the `kit/` folder). This will be shared among all packages you might add to your `tetra` project.
+Note that `tetra` will generate files for the commons-collections package and all binary-only build-time dependencies in the `kit/` folder.
 
 ## In-depth information
 

data/SPECIAL_CASES.md

@@ -8,17 +8,16 @@ If your build fails for whatever reason, abort it with `tetra finish --abort`. `
 
 You can do any manual changes to spec and build.sh files and regenerate them later, `tetra` will reconcile changes with a [three-way merge](http://en.wikipedia.org/wiki/Three-way_merge#Three-way_merge) and alert about any conflicts. You can generate single files with the following commands:
 
-* `tetra generate-kit-archive`: (re)generates the kit tarball;
-* `tetra generate-kit-spec`: (re)generates the kit spec;
-* `tetra generate-package-script`: (re)generates the `build.sh` file from the latest bash history (assumes `tetra dry-run` and `tetra finish`have been used);
-* `tetra generate-package-archive`: (re)generates the package tarball;
-* `tetra generate-package-spec`: (re)generates the package spec;
+* `tetra generate-script`: (re)generates the `build.sh` file from the latest bash history (assumes `tetra dry-run` and `tetra finish` have been used);
+* `tetra generate-archive`: (re)generates the package tarball;
+* `tetra generate-spec`: (re)generates the package spec;
+* `tetra generate-kit`: (re)generates all kit tarballs and specs;
 
 ## Kit sources
 
 Your kit packages are basically binary blobs. If its sources are needed for proper packaging, for example to comply with the GPL, some extra steps are needed.
 
-If you use Maven, most (~90%) sources can be automatically downloaded:
+If you use Maven, most (~90%) of the sources can be automatically downloaded:
 
     tetra download-maven-source-jars
 
@@ -62,12 +61,13 @@ Other build tools are currently unsupported but will be added in the future. You
 
 ## [OBS](build.opensuse.org) integration
 
-If you want to submit packages to OBS, you can do so by replacing the `output/` directory in your `tetra` project with a symlink to your OBS project directory.
+If you want to submit your package to OBS, you can do so by copying contents of the `packages` and `packages/kit` in proper OBS project directories.
 
 Packages will rebuild cleanly in OBS because no Internet access is needed - all files were already downloaded during dry-run and are included in the kit.
 
-Note that the kit package is needed at build time only by OBS, no end user should ever install it.
+Note that packages in `kit` are only needed at build time only by OBS, no end user should ever install them, so you can place them in non-public repositories.
 
+Also note that you can mix and match packages from `kit` with other `tetra`-built packages, even from other users, as they are designed to be immutable and will not break your builds.
 
 ## Gotchas
 

data/integration-tests/build-commons.sh

@@ -20,13 +20,12 @@ cd commons-collections-3.2.1-src/
 tetra mvn package -DskipTests
 tetra finish
 
-tetra generate-kit-archive
-tetra generate-kit-spec
-tetra generate-package-archive
-tetra generate-package-spec
-# simulate tetra generate-package-script
+tetra generate-kit
+tetra generate-archive
+tetra generate-spec
+# simulate tetra generate-script
 cd ../..
-cat >src/build.sh <<"EOF"
+cat >packages/commons-collections/build.sh <<"EOF"
 #!/bin/bash
 PROJECT_PREFIX=`readlink -e .`
 cd .

data/lib/template/gitignore

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

data/lib/template/packages/kit/CONTENTS

@@ -0,0 +1,3 @@
+tetra will save all binary build dependency packages here.
+
+Feel free to use this as a subproject in OBS.

data/lib/tetra.rb

@@ -23,7 +23,6 @@ require "zip"
 require "tetra/version"
 require "tetra/logger"
 require "tetra/git"
-require "tetra/script_generator"
 require "tetra/project"
 require "tetra/pom"
 require "tetra/version_matcher"
@@ -33,28 +32,29 @@ require "tetra/source_getter"
 require "tetra/kit_runner"
 require "tetra/ant_runner"
 require "tetra/maven_runner"
-require "tetra/spec_generator"
-require "tetra/archiver"
-require "tetra/maven_kit_item"
-require "tetra/jar_kit_item"
-require "tetra/glue_kit_item"
-require "tetra/kit"
-require "tetra/package"
 require "tetra/kit_checker"
 
+# internal, package related
+require "tetra/packages/archivable"
+require "tetra/packages/speccable"
+require "tetra/packages/scriptable"
+require "tetra/packages/maven_kit_item"
+require "tetra/packages/jar_kit_item"
+require "tetra/packages/glue_kit_item"
+require "tetra/packages/kit"
+require "tetra/packages/built_package"
+
 # internal, UI
 require "tetra/commands/base"
-
 require "tetra/commands/ant"
 require "tetra/commands/download_maven_source_jars"
 require "tetra/commands/dry_run"
 require "tetra/commands/finish"
 require "tetra/commands/generate_all"
-require "tetra/commands/generate_kit_archive"
-require "tetra/commands/generate_kit_spec"
-require "tetra/commands/generate_package_archive"
-require "tetra/commands/generate_package_script"
-require "tetra/commands/generate_package_spec"
+require "tetra/commands/generate_kit"
+require "tetra/commands/generate_archive"
+require "tetra/commands/generate_script"
+require "tetra/commands/generate_spec"
 require "tetra/commands/get_pom"
 require "tetra/commands/get_source"
 require "tetra/commands/init"

data/lib/tetra/commands/generate_all.rb

@@ -10,20 +10,16 @@ module Tetra
       checking_exceptions do
         project = Tetra::Project.new(".")
         ensure_dry_running(false, project) do
-          GenerateKitArchiveCommand.new(@invocation_path).execute
+          GenerateKitCommand.new(@invocation_path).execute
 
-          GenerateKitSpecCommand.new(@invocation_path).execute
+          GenerateScriptCommand.new(@invocation_path).execute
 
-          script_command = GeneratePackageScriptCommand.new(@invocation_path)
-          script_command.execute
+          GenerateArchiveCommand.new(@invocation_path).execute
 
-          archive_command = GeneratePackageArchiveCommand.new(@invocation_path)
-          archive_command.execute
-
-          archive_command = GeneratePackageSpecCommand.new(@invocation_path)
-          archive_command.filter = filter
-          archive_command.pom = pom
-          archive_command.execute
+          command = GenerateSpecCommand.new(@invocation_path)
+          command.filter = filter
+          command.pom = pom
+          command.execute
         end
       end
     end

data/lib/tetra/commands/{generate_package_archive.rb → generate_archive.rb}

@@ -1,13 +1,13 @@
 # encoding: UTF-8
 
 module Tetra
-  # tetra generate-package-archive
-  class GeneratePackageArchiveCommand < Tetra::BaseCommand
+  # tetra generate-archive
+  class GenerateArchiveCommand < Tetra::BaseCommand
     def execute
       checking_exceptions do
         project = Tetra::Project.new(".")
         ensure_dry_running(false, project) do
-          result_path = Tetra::Package.new(project).to_archive
+          result_path = Tetra::BuiltPackage.new(project).to_archive
           print_generation_result(project, result_path)
         end
       end

data/lib/tetra/commands/{generate_kit_spec.rb → generate_kit.rb}

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
 module Tetra
-  # tetra generate-kit-spec
-  class GenerateKitSpecCommand < Tetra::BaseCommand
+  # tetra generate-kit
+  class GenerateKitCommand < Tetra::BaseCommand
     def execute
       checking_exceptions do
         project = Tetra::Project.new(".")
@@ -10,6 +10,9 @@ module Tetra
           Tetra::Kit.new(project).items.each do |item|
             result_path, conflict_count = item.to_spec
             print_generation_result(project, result_path, conflict_count)
+
+            result_path = item.to_archive
+            print_generation_result(project, result_path)
           end
         end
       end

data/lib/tetra/commands/generate_script.rb

@@ -0,0 +1,18 @@
+# encoding: UTF-8
+
+module Tetra
+  # tetra generate-script
+  class GenerateScriptCommand < Tetra::BaseCommand
+    def execute
+      checking_exceptions do
+        project = Tetra::Project.new(".")
+        ensure_dry_running(false, project) do
+          history = File.join(Dir.home, ".bash_history")
+          result_path, conflict_count =
+            Tetra::BuiltPackage.new(project).to_script(history)
+          print_generation_result(project, result_path, conflict_count)
+        end
+      end
+    end
+  end
+end

data/lib/tetra/commands/{generate_package_spec.rb → generate_spec.rb}

@@ -1,8 +1,8 @@
 # encoding: UTF-8
 
 module Tetra
-  # tetra generate-package-spec
-  class GeneratePackageSpecCommand < Tetra::BaseCommand
+  # tetra generate-spec
+  class GenerateSpecCommand < Tetra::BaseCommand
     option %w(-f --filter), "FILTER", "filter files to be installed by this spec", default: "*.jar"
     parameter "[POM]", "a pom file path", default: "pom.xml"
 
@@ -11,7 +11,7 @@ module Tetra
         project = Tetra::Project.new(".")
         ensure_dry_running(false, project) do
           result_path, conflict_count =
-            Tetra::Package.new(project, pom, filter).to_spec
+            Tetra::BuiltPackage.new(project, pom, filter).to_spec
           print_generation_result(project, result_path, conflict_count)
         end
       end

data/lib/tetra/git.rb

@@ -53,14 +53,6 @@ module Tetra
       Dir.chdir(@directory) do
         log.debug "committing with message: #{message}"
 
-        # rename all .gitignore files by default as
-        # they prevent snapshotting
-        Find.find(".") do |file|
-          next unless file =~ /\.gitignore$/
-
-          FileUtils.mv(file, "#{file}_disabled_by_tetra")
-        end
-
         `git rm -r --cached --ignore-unmatch .`
         `git add .`
         `git commit -m "#{message}"`

data/lib/tetra/main.rb

@@ -34,33 +34,27 @@ module Tetra
     )
 
     subcommand(
-      "generate-kit-archive",
-      "Create or refresh the kit tarballs",
-      Tetra::GenerateKitArchiveCommand
+      "generate-kit",
+      "Create or refresh the kit spec and archive files",
+      Tetra::GenerateKitCommand
     )
 
     subcommand(
-      "generate-kit-spec",
-      "Create or refresh the kit spec files",
-      Tetra::GenerateKitSpecCommand
-    )
-
-    subcommand(
-      "generate-package-script",
+      "generate-script",
       "Create or refresh the package build.sh file",
-      Tetra::GeneratePackageScriptCommand
+      Tetra::GenerateScriptCommand
     )
 
     subcommand(
-      "generate-package-archive",
+      "generate-archive",
       "Create or refresh the package tarball",
-      Tetra::GeneratePackageArchiveCommand
+      Tetra::GenerateArchiveCommand
     )
 
     subcommand(
-      "generate-package-spec",
+      "generate-spec",
       "Create or refresh the package spec file",
-      Tetra::GeneratePackageSpecCommand
+      Tetra::GenerateSpecCommand
     )
 
     subcommand(

data/lib/tetra/packages/archivable.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+module Tetra
+  # adds methods to generate a tarball from a package object
+  module Archivable
+    include Logging
+
+    # generates an archive and returns its name
+    # this will archive source_paths starting from source_dir in
+    # destination_dir/name/name.tar.xz
+    def _to_archive(project, name, source_dir, source_paths, destination_dir)
+      full_destination_dir = File.join(project.full_path, destination_dir, name)
+      log.debug "creating #{full_destination_dir}"
+      FileUtils.mkdir_p(full_destination_dir)
+
+      project.from_directory(source_dir) do
+        destination_path = File.join(full_destination_dir, "#{name}.tar.xz")
+        log.debug "tarring to #{destination_path}"
+
+        `tar -cJf #{destination_path} #{source_paths.join(" ")}`
+
+        destination_path
+      end
+    end
+  end
+end

data/lib/tetra/{package.rb → packages/built_package.rb}

@@ -2,14 +2,14 @@
 
 module Tetra
   # represents a Java project packaged in Tetra
-  class Package
+  class BuiltPackage
     extend Forwardable
-    include SpecGenerator
+    include Archivable
+    include Speccable
+    include Scriptable
 
     def_delegator :@project, :name, :name
-
     def_delegator :@kit, :items, :kit_items
-
     def_delegator :@pom, :license_name, :license
     def_delegator :@pom, :url
     def_delegator :@pom, :group_id
@@ -17,26 +17,11 @@ module Tetra
     def_delegator :@pom, :version
     def_delegator :@pom, :runtime_dependency_ids
 
-    # implement to_spec
-    attr_reader :spec_dir
-
-    # implement to_archive
-    include Archiver
-    attr_reader :source_dir
-    attr_reader :source_paths
-    attr_reader :destination_dir
-
     def initialize(project, pom_path = nil, filter = nil)
       @project = project
       @kit = Tetra::Kit.new(project)
       @pom = pom_path.nil? ? nil : Tetra::Pom.new(pom_path)
       @filter = filter
-
-      @spec_dir = "src"
-
-      @source_dir = "src"
-      @source_paths = ["*"]
-      @destination_dir = name
     end
 
     # a short summary from the POM
@@ -65,15 +50,16 @@ module Tetra
         .sub(/\.+$/, "")
     end
 
-    # needed by SpecGenerator
-    attr_reader :project
+    def to_archive
+      _to_archive(@project, name, "src", ["*"], @project.packages_dir)
+    end
 
-    def package_name
-      name
+    def to_spec
+      _to_spec(@project, name, "package.spec", @project.packages_dir)
     end
 
-    def template_spec_name
-      "package.spec"
+    def to_script(history)
+      _to_script(@project, history)
     end
   end
 end

data/lib/tetra/{glue_kit_item.rb → packages/glue_kit_item.rb}

@@ -4,21 +4,14 @@ module Tetra
   # represents a prebuilt package dependency from a jar file
   # in a kit
   class GlueKitItem
-    # implement to_spec
-    include SpecGenerator
+    include Archivable
+    include Speccable
+
     attr_reader :project
     attr_reader :package_name
-    attr_reader :spec_dir
-    attr_reader :template_spec_name
     attr_reader :conflicts
-
-    # implement to_archive
-    include Archiver
     attr_reader :source_dir
     attr_reader :source_paths
-    attr_reader :destination_dir
-
-    # template-specific attributes
     attr_reader :provides_symbol
     attr_reader :provides_version
     attr_reader :install_dir
@@ -26,17 +19,23 @@ module Tetra
     def initialize(project, source_paths)
       @project = project
       @package_name = "kit-item-glue-#{project.name}"
-      @spec_dir = "kit"
-      @template_spec_name = "kit_item.spec"
       @conflicts = true
-
-      @source_dir = File.join("kit")
+      @source_dir = "kit"
       @source_paths = source_paths
-      @destination_dir = @package_name
 
       @provides_symbol = "tetra-glue"
       @provides_version = "#{project.name}-#{project.version}"
       @install_dir = ""
     end
+
+    def to_archive
+      _to_archive(@project, @package_name, @source_dir,
+                  @source_paths, @project.kit_packages_dir)
+    end
+
+    def to_spec
+      _to_spec(@project, @package_name, "kit_item.spec",
+               @project.kit_packages_dir)
+    end
   end
 end