gjp 0.13.1 → 0.14.1

data/README.md

@@ -14,19 +14,26 @@ Easiest install is via RubyGems:
 
 ## Usage
 
-Currently available tools:
+Main workflow subcommands:
 * `gjp init` inits a new gjp project in the current directory, generating minimal directories and files;
-* `gjp gather` starts a new gathering phase, to add files to the packages you want to create. You should place source files in src/<orgId_artifactId_version>, and binary dependency files in kit/;
+* `gjp gather` starts a new gathering phase, to add files to the packages you want to create. You should place source files in src/<orgId:artifactId:version>, and binary dependency files in kit/;
+* `gjp dry-run` starts a new dry-run phase, where you attempt to build your package. Any change to src/ will be reverted after you call `gjp finish`
+* `gjp finish` ends the current phase;
+* `gjp mvn` locates and runs Maven from any directory in kit/, using options to force repository in kit/m2 and settings in kit/m2/settings.xml. Use during dry runs;
+superuser privileges;
+* `gjp generate-kit-spec` creates or refreshes a spec file for the kit package. Use when you are finished gathering and dry-running;
+* `gjp generate-kit-archive` creates or refreshes an archive file for the kit package. Use when you are finished gathering and dry-running;
+* `gjp generate-source-archive NAME` creates or refreshes an archive file for source package NAME. Use when you are finished gathering and dry-running;
+
+Optional workflow subcommands:
+* `gjp set-up-nonet-user` sets up a user named `nonet` without Internet access you can use for networkless dry runs. Requires `iptables` and 
+* `gjp tear-down-nonet-user` removes a user previously created by gjp;
+
+Other available tools:
 * `gjp get-pom NAME` will attempt to find a pom. `NAME` can be a jar file on your disk, a project directory, or simply a `name-version` string. `gjp` will get the pom either from the package itself or through search.maven.org using heuristic searching;
 * `gjp get-parent-pom POM` will attempt to download a pom's parent from search.maven.org, where `POM` is a filename or URI;
 * `gjp get-source-address POM` will attempt to find the SCM Internet address of a pom.xml from the file itself or through api.github.com. `POM` can either be a filename or a URI;
 * `gjp get-source POM ADDRESS` downloads the source of a pom.xml's project from its SCM at ADDRESS;
-* `gjp finish` marks the end of a phase;
-* `gjp dry-run` starts a new dry-run phase, where you attempt to build your package. Any change to src/ will be reverted after you call `gjp finish`;
-* `gjp mvn` locates and runs Maven from any directory in kit/, using options to force repository in kit/m2 and settings in kit/m2/settings.xml;
-* `gjp scaffold-kit-spec` creates or refreshes a spec file for the kit package;
-* `gjp set-up-nonet-user` sets up a user named `nonet` without Internet access using `iptables`, needs superuser privileges. You can then use it for networkless dry-runs;
-* `gjp tear-down-nonet-user` removes a user previously created by gjp;
 * `gjp scaffold-jar-table DIRECTORY` looks for jars in the project's DIRECTORY and classifies them as build-time dependencies (b), run-time dependencies (r) or products (p);
 
 ## Source

data/lib/gjp/archiver.rb

@@ -14,7 +14,7 @@ module Gjp
     def archive_kit
       list_file = File.join(@project.full_path, "file_lists/kit")
       if not File.exist? list_file
-        return false
+        return nil
       end
       destination_file = File.join(@project.full_path, "archives/#{@project.name}-kit.tar.xz")
 
@@ -22,7 +22,7 @@ module Gjp
         archive list_file, destination_file
       end
       
-      true
+      Pathname.new(destination_file).relative_path_from Pathname.new(@project.full_path)
     end
 
     # generates an archive for a project's source package based on
@@ -30,7 +30,7 @@ module Gjp
     def archive_src(name)
       list_file = File.join(@project.full_path, "file_lists/#{name}_input")
       if not File.exist? list_file
-        return false
+        return nil
       end
       destination_file = File.join(@project.full_path, "archives/#{@project.name}-#{name}.tar.xz")
 
@@ -38,7 +38,7 @@ module Gjp
         archive list_file, destination_file
       end
 
-      true
+      Pathname.new(destination_file).relative_path_from Pathname.new(@project.full_path)
     end
 
     # compresses files specified in the list file to the destination file

data/lib/gjp/cli.rb

@@ -109,22 +109,21 @@ module Gjp
       end
     end
 
-    subcommand "scaffold-kit-spec", "Scaffolds or refreshes a spec file for the kit package" do
+    subcommand "generate-kit-spec", "Scaffolds or refreshes a spec file for the kit package" do
       def execute
         project = Gjp::Project.new(".")
-        success = Gjp::Scaffolder.new(project).scaffold_kit_spec        
-        if not success
-          puts "You must be gathering before scaffolding."
-          puts "Use \"gjp gather\" to start a new gathering."
-        end
+        result_path = Gjp::Scaffolder.new(project).scaffold_kit_spec
+        puts "#{result_path} generated"
       end
     end
 
     subcommand "generate-kit-archive", "Archives contents of the kit package in a tarball" do
       def execute
         project = Gjp::Project.new(".")
-        success = Gjp::Archiver.new(project).archive_kit
-        if not success
+        result_path = Gjp::Archiver.new(project).archive_kit
+        if result_path != nil
+          puts "#{result_path} generated"
+        else
           "The file_list/kit file was not found. Ensure you already added content to kit/ " +
           "during a gathering and/or dry-running phase, and ensure you ended that phase " +
           "with \"gjp finish\"."
@@ -136,8 +135,10 @@ module Gjp
       parameter "NAME", "name of a package in src/"
       def execute
         project = Gjp::Project.new(".")
-        success = Gjp::Archiver.new(project).archive_src name
-        if not success
+        result_path = Gjp::Archiver.new(project).archive_src name
+        if result_path != nil
+          puts "#{result_path} generated"
+        else
           "The file_list/#{name}_input file was not found. Ensure you already added content to " +
           "src/#{name} during a gathering phase, and ensure you ended that phase with \"gjp finish\"."
         end

data/lib/gjp/project.rb

@@ -42,18 +42,18 @@ module Gjp
           `git init`
         end
 
+        Dir.mkdir "src"
+        Dir.mkdir "kit"
+
+        # automatically begin a gathering phase
+        Project.new(".").gather
+
         template_manager = Gjp::TemplateManager.new
         template_manager.copy "archives", "."
         template_manager.copy "file_lists", "."
         template_manager.copy "kit", "."
         template_manager.copy "specs", "."
         template_manager.copy "src", "."
-
-        `git add .`
-        `git commit -m "Project initialized"`
-  
-        # automatically begin a gathering phase
-        Project.new(".").gather
       end
     end
 
@@ -187,7 +187,7 @@ module Gjp
 
     # returns the last tag given in a gjp snapshot
     def latest_tag(tag)
-      `git describe --abbrev=0 --tags --match=gjp_#{tag}_*`.strip
+      `git describe --abbrev=0 --tags --match=gjp_#{tag}_* --always`.strip
     end
 
     # reverts path contents as per latest tag

data/lib/gjp/scaffolder.rb

@@ -10,10 +10,6 @@ module Gjp
     end
 
     def scaffold_kit_spec
-      if @project.get_status != :gathering
-        return false
-      end
-
       @project.from_directory do
         spec_path = File.join("specs", "#{@project.name}-kit.spec")
 
@@ -35,7 +31,7 @@ module Gjp
 
         @project.take_snapshot "Kit spec scaffolded", :scaffold_kit_spec
 
-        true
+        spec_path
       end
     end
   end

data/lib/gjp/version.rb

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

data/lib/template/kit.spec

@@ -19,11 +19,13 @@ Name:           <%= name %>-kit
 Version:        <%= version %>
 Release:        1
 License:        Apache-2.0
-Summary:        Build-time dependencies for %{name}
+Summary:        Build-time dependencies for gjp project <%= name %>
 Url:            https://github.com/SilvioMoioli/gjp
-Group:          Develompent/Libraries/Java
+Group:          Development/Libraries/Java
 Source0:        %{name}.tar.xz
 BuildRoot:      %{_tmppath}/%{name}-%{version}-build
+BuildRequires:  java-devel
+BuildArch:      noarch
 Provides:       gjp(kit)
 # no two kits should ever be installed at any given time
 Conflicts:      otherproviders(gjp(kit))
@@ -35,7 +37,7 @@ not be used except for rebuilding those packages and it should never
 be installed on end users' systems.
 
 %prep
-%setup -q
+%setup -q -c
 
 %build
 # nothing to do, gjp kits are precompiled by design
@@ -46,6 +48,7 @@ cp -a * %{buildroot}%{_datadir}/gjp/%{name}/
 
 %files
 %defattr(-,root,root)
+%{_datadir}/gjp
 %{_datadir}/gjp/%{name}/
 
 %changelog

data/lib/template/kit/m2/settings.xml

@@ -1,257 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
 <!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements.  See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership.  The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License.  You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied.  See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-
-<!--
- | This is the configuration file for Maven. It can be specified at two levels:
- |
- |  1. User Level. This settings.xml file provides configuration for a single user,
- |                 and is normally provided in ${user.home}/.m2/settings.xml.
- |
- |                 NOTE: This location can be overridden with the CLI option:
- |
- |                 -s /path/to/user/settings.xml
- |
- |  2. Global Level. This settings.xml file provides configuration for all Maven
- |                 users on a machine (assuming they're all using the same Maven
- |                 installation). It's normally provided in
- |                 ${maven.home}/conf/settings.xml.
- |
- |                 NOTE: This location can be overridden with the CLI option:
- |
- |                 -gs /path/to/global/settings.xml
- |
- | The sections in this sample file are intended to give you a running start at
- | getting the most out of your Maven installation. Where appropriate, the default
- | values (values used when the setting is not specified) are provided.
- |
+ | This is the configuration file used by default by `gjp mvn`.
+ | Feel free to add settings here if any are needed for gjp dry runs.
  |-->
 <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
-  <!-- localRepository
-   | The path to the local repository maven will use to store artifacts.
-   |
-   | Default: ~/.m2/repository
-  <localRepository>/path/to/local/repo</localRepository>
-  -->
-
-  <!-- interactiveMode
-   | This will determine whether maven prompts you when it needs input. If set to false,
-   | maven will use a sensible default value, perhaps based on some other setting, for
-   | the parameter in question.
-   |
-   | Default: true
-  <interactiveMode>true</interactiveMode>
-  -->
-
-  <!-- offline
-   | Determines whether maven should attempt to connect to the network when executing a build.
-   | This will have an effect on artifact downloads, artifact deployment, and others.
-   |
-   | Default: false
-  <offline>false</offline>
-  -->
-
-  <!-- pluginGroups
-   | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e.
-   | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers
-   | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list.
-   |-->
-  <pluginGroups>
-    <!-- pluginGroup
-     | Specifies a further group identifier to use for plugin lookup.
-    <pluginGroup>com.your.plugins</pluginGroup>
-    -->
-  </pluginGroups>
-
-  <!-- proxies
-   | This is a list of proxies which can be used on this machine to connect to the network.
-   | Unless otherwise specified (by system property or command-line switch), the first proxy
-   | specification in this list marked as active will be used.
-   |-->
-  <proxies>
-    <!-- proxy
-     | Specification for one proxy, to be used in connecting to the network.
-     |
-    <proxy>
-      <id>optional</id>
-      <active>true</active>
-      <protocol>http</protocol>
-      <username>proxyuser</username>
-      <password>proxypass</password>
-      <host>proxy.host.net</host>
-      <port>80</port>
-      <nonProxyHosts>local.net|some.host.com</nonProxyHosts>
-    </proxy>
-    -->
-  </proxies>
-
-  <!-- servers
-   | This is a list of authentication profiles, keyed by the server-id used within the system.
-   | Authentication profiles can be used whenever maven must make a connection to a remote server.
-   |-->
-  <servers>
-    <!-- server
-     | Specifies the authentication information to use when connecting to a particular server, identified by
-     | a unique name within the system (referred to by the 'id' attribute below).
-     |
-     | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are
-     |       used together.
-     |
-    <server>
-      <id>deploymentRepo</id>
-      <username>repouser</username>
-      <password>repopwd</password>
-    </server>
-    -->
-
-    <!-- Another sample, using keys to authenticate.
-    <server>
-      <id>siteServer</id>
-      <privateKey>/path/to/private/key</privateKey>
-      <passphrase>optional; leave empty if not used.</passphrase>
-    </server>
-    -->
-  </servers>
-
-  <!-- mirrors
-   | This is a list of mirrors to be used in downloading artifacts from remote repositories.
-   |
-   | It works like this: a POM may declare a repository to use in resolving certain artifacts.
-   | However, this repository may have problems with heavy traffic at times, so people have mirrored
-   | it to several places.
-   |
-   | That repository definition will have a unique id, so we can create a mirror reference for that
-   | repository, to be used as an alternate download site. The mirror site will be the preferred
-   | server for that repository.
-   |-->
-  <mirrors>
-    <!-- mirror
-     | Specifies a repository mirror site to use instead of a given repository. The repository that
-     | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used
-     | for inheritance and direct lookup purposes, and must be unique across the set of mirrors.
-     |
-    <mirror>
-      <id>mirrorId</id>
-      <mirrorOf>repositoryId</mirrorOf>
-      <name>Human Readable Name for this Mirror.</name>
-      <url>http://my.repository.com/repo/path</url>
-    </mirror>
-     -->
-  </mirrors>
-
-  <!-- profiles
-   | This is a list of profiles which can be activated in a variety of ways, and which can modify
-   | the build process. Profiles provided in the settings.xml are intended to provide local machine-
-   | specific paths and repository locations which allow the build to work in the local environment.
-   |
-   | For example, if you have an integration testing plugin - like cactus - that needs to know where
-   | your Tomcat instance is installed, you can provide a variable here such that the variable is
-   | dereferenced during the build process to configure the cactus plugin.
-   |
-   | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles
-   | section of this document (settings.xml) - will be discussed later. Another way essentially
-   | relies on the detection of a system property, either matching a particular value for the property,
-   | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a
-   | value of '1.4' might activate a profile when the build is executed on a JDK version of '1.4.2_07'.
-   | Finally, the list of active profiles can be specified directly from the command line.
-   |
-   | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact
-   |       repositories, plugin repositories, and free-form properties to be used as configuration
-   |       variables for plugins in the POM.
-   |
-   |-->
-  <profiles>
-    <!-- profile
-     | Specifies a set of introductions to the build process, to be activated using one or more of the
-     | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/>
-     | or the command line, profiles have to have an ID that is unique.
-     |
-     | An encouraged best practice for profile identification is to use a consistent naming convention
-     | for profiles, such as 'env-dev', 'env-test', 'env-production', 'user-jdcasey', 'user-brett', etc.
-     | This will make it more intuitive to understand what the set of introduced profiles is attempting
-     | to accomplish, particularly when you only have a list of profile id's for debug.
-     |
-     | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo.
-    <profile>
-      <id>jdk-1.4</id>
-
-      <activation>
-        <jdk>1.4</jdk>
-      </activation>
-
-      <repositories>
-        <repository>
-          <id>jdk14</id>
-          <name>Repository for JDK 1.4 builds</name>
-          <url>http://www.myhost.com/maven/jdk14</url>
-          <layout>default</layout>
-          <snapshotPolicy>always</snapshotPolicy>
-        </repository>
-      </repositories>
-    </profile>
-    -->
-
-    <!--
-     | Here is another profile, activated by the system property 'target-env' with a value of 'dev',
-     | which provides a specific path to the Tomcat instance. To use this, your plugin configuration
-     | might hypothetically look like:
-     |
-     | ...
-     | <plugin>
-     |   <groupId>org.myco.myplugins</groupId>
-     |   <artifactId>myplugin</artifactId>
-     |
-     |   <configuration>
-     |     <tomcatLocation>${tomcatPath}</tomcatLocation>
-     |   </configuration>
-     | </plugin>
-     | ...
-     |
-     | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to
-     |       anything, you could just leave off the <value/> inside the activation-property.
-     |
-    <profile>
-      <id>env-dev</id>
-
-      <activation>
-        <property>
-          <name>target-env</name>
-          <value>dev</value>
-        </property>
-      </activation>
-
-      <properties>
-        <tomcatPath>/path/to/tomcat/instance</tomcatPath>
-      </properties>
-    </profile>
-    -->
-  </profiles>
-
-  <!-- activeProfiles
-   | List of profiles that are active for all builds.
-   |
-  <activeProfiles>
-    <activeProfile>alwaysActiveProfile</activeProfile>
-    <activeProfile>anotherAlwaysActiveProfile</activeProfile>
-  </activeProfiles>
-  -->
 </settings>

data/spec/lib/project_spec.rb

@@ -51,7 +51,7 @@ describe Gjp::Project do
 
       @project.from_directory do
         @project.latest_tag(:gathering_started).should eq "gjp_gathering_started_1"
-        `git rev-list --all`.split("\n").length.should eq 2
+        `git rev-list --all`.split("\n").length.should eq 1
       end
 
       @project.get_status.should eq :gathering
@@ -84,7 +84,7 @@ describe Gjp::Project do
 
          @project.take_snapshot "test", :revertable
 
-        `git rev-list --all`.split("\n").length.should eq 3
+        `git rev-list --all`.split("\n").length.should eq 2
          @project.latest_tag(:revertable).should eq "gjp_revertable_1"
       end
     end
@@ -120,7 +120,7 @@ describe Gjp::Project do
       @project.get_status.should be_nil
 
       @project.from_directory do
-        `git rev-list --all`.split("\n").length.should eq 5
+        `git rev-list --all`.split("\n").length.should eq 4
         `git diff-tree --no-commit-id --name-only -r HEAD~2`.split("\n").should include("src/a:b:c/test")
         File.readlines(File.join("file_lists", "a:b:c_input")).should include("test\n")
         File.readlines(File.join("file_lists","kit")).should include("test\n")
@@ -147,7 +147,7 @@ describe Gjp::Project do
       @project.get_status.should be_nil
 
       @project.from_directory do
-        `git rev-list --all`.split("\n").length.should eq 10
+        `git rev-list --all`.split("\n").length.should eq 9
         File.read("src/a:b:c/test").should eq "A\n"
         File.readlines(File.join("file_lists", "a:b:c_output")).should include("test2\n")
         File.readlines(File.join("file_lists", "a:b:c_input")).should_not include("test2\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gjp
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-30 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake