mvnizer 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d9b59c73bde4526206e7b323d96a2768ce13e5b80154603f3c3593e7f072278
-  data.tar.gz: 27ec3cce9384ff3a04ec3acf93e0376f179ad7d0dbc71a4f0def6fe64bd9bdd8
+  metadata.gz: e6ecb5dba13681bce3af48b9564e815074be4e0499e9772632ca0162234f5a3e
+  data.tar.gz: aeec16fa3223bd34d49b4cdff6d40cb9d482bd9e171b54a54822bc41571c210d
 SHA512:
-  metadata.gz: 54089cc2d7dfd584ff79ca57a1ed26fbb335f133414d7d27bc2f728430d5819a12453f522038f4856aca054d1f37532b5125b3e9037389bf5f3e030245879f83
-  data.tar.gz: e2dc029f58f105e3d29b827954e49bca5cc97ac90e644313bf141c5b5c77030f0865a1c378431a2e4fc53241d23b926d353efc7b22ec740346d153f174bf54e4
+  metadata.gz: ad28cc69a95b57a655faf946b1d8cce50562d5dae321142ad8330b1c8f3ea32f01270ac52a72f7313ddb60fe54276d202e98ae0ad9e16cb9dcfb25541ff9fa9f
+  data.tar.gz: 67c748fb775733258396d7ceb3f349072af59a4ce6010cd072bed6bdd44d392d117d5bf5d8dd7b004c344ceaa62e9ebd9dc81036e17779cfe7292bfc12214d1d

data/CHANGELOG.org

@@ -1,3 +1,14 @@
+* Mvnizer 1.2.0
+
+  - Add =--docker= option to generate =Dockerfile=
+  - Add =--logger= option to add logging dependencies to the project
+  - Add =--main=[Main class name]= option to generate main class, and set up =maven-shade-plugin= automatically.
+  - Fix bug with patch component of version not supporting multiple digits.
+
+* Mvnizer 1.1.0
+
+  - Update nokogiri dependency to 1.12
+
 * Mvnizer 1.0.0
 
   - Release of major version!

data/Dockerfile

@@ -10,8 +10,10 @@ RUN apt-get update -q && \
     apt-get install -qy git vim rvm --no-install-recommends && \
     apt-get clean
 
-RUN /bin/bash -l -c "rvm autolibs packages && rvm install 2.3.8"
-RUN /bin/bash -l -c "gem update --system && gem install bundler"
+RUN /bin/bash -l -c "rvm autolibs packages && rvm install 2.7.0 && rvm use 2.7.0"
+RUN /bin/bash -l -c "gem update -f --no-document --system && gem install bundler"
+
+WORKDIR /mvnizer
 
 # To run:
 #   docker run -t -i -v $(pwd):/mvnizer  mvnizer-build:latest /bin/bash

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 ruby ">= 2.7.0"
 
 gem 'httparty', '~> 0.17'
-gem 'nokogiri', '~> 1.11'
+gem 'nokogiri', '~> 1.13'
 gem 'rake', '~> 13.0'
 gem 'rake-release'
 

data/Gemfile.lock

@@ -9,15 +9,15 @@ GEM
     mime-types (3.3.1)
       mime-types-data (~> 3.2015)
     mime-types-data (3.2021.0225)
-    mini_portile2 (2.5.1)
+    mini_portile2 (2.8.0)
     multi_xml (0.6.0)
-    nokogiri (1.11.4)
-      mini_portile2 (~> 2.5.0)
+    nokogiri (1.13.3)
+      mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.11.4-java)
+    nokogiri (1.13.3-java)
       racc (~> 1.4)
-    racc (1.5.2)
-    racc (1.5.2-java)
+    racc (1.6.0)
+    racc (1.6.0-java)
     rake (13.0.3)
     rake-release (1.3.0)
       bundler (>= 1.11, < 3)
@@ -42,7 +42,7 @@ PLATFORMS
 DEPENDENCIES
   fakefs (~> 0.14)
   httparty (~> 0.17)
-  nokogiri (~> 1.11)
+  nokogiri (~> 1.13)
   rake (~> 13.0)
   rake-release
   rspec (~> 3.10.0)

data/README.org

@@ -1,5 +1,4 @@
-Bootstraps a Maven project. Because archetypes shouldn't be so
-complicated.
+Bootstraps a Maven project. Because archetypes shouldn't be so complicated.
 
 [[https://travis-ci.org/tychobrailleur/mvnizer][https://travis-ci.org/tychobrailleur/mvnizer.svg?branch=master]]
 [[https://badge.fury.io/rb/mvnizer][https://badge.fury.io/rb/mvnizer.svg]]
@@ -7,8 +6,7 @@ complicated.
 
 * Introduction
 
-  Mvnizer is ideal to create a throwaway Maven project that adds
-  junit as a dependency and sets up the Maven project structure.
+  Mvnizer is ideal to create a throwaway Maven project that adds junit as a dependency and sets up the Maven project structure.
 
 * Install
 
@@ -34,10 +32,7 @@ complicated.
     <group:>artifact<:version><:type>
 #+END_EXAMPLE
 
-   with the values between angled brackets optional. =type= can only
-have one of the following three values: =jar= (default), =war= or
-=pom=. This command creates a project in the =artifact= folder,
-populating the proper values in the pom file.
+   with the values between angled brackets optional. =type= can only have one of the following three values: =jar= (default), =war= or =pom=. This command creates a project in the =artifact= folder, populating the proper values in the pom file.
 
 Here are some examples of valid commands:
 
@@ -52,11 +47,23 @@ Here are some examples of valid commands:
 
 The version *must* be of the form =major.minor.patch-classifier=.
 
+*** Options
+
+    The following options can be used to add specific files to the project:
+
+    - =--docker= :: this creates a =Dockerfile= based on the Java 11 distroless base image.  It assumes that the jar generated by the build can be executed using the =java -jar= command;
+    - =--main=[Main class name] :: this creates a class with a =main= method that can be executed using the =java -jar= command.  It also adds the =maven-shade-plugin= to the pom, with this class as the main class.
+    - =--logger= :: this adds logging dependencies to the project.  The jar added are defined as the =logging_deps= of the configuration file.  The default are:
+
+    #+begin_src
+logging_deps: [ "org.slf4j:slf4j-api:1.7.32:jar",
+                "org.slf4j:slf4j-simple:1.7.32:jar",
+                "ch.qos.logback:logback-core:1.2.6:jar" ]
+    #+end_src
+
 *** WAR Project
 
-    If the type of project generated is =war=, a servlet
-    (=ExampleServlet=) is generated, along with a JSP file and an
-    empty =web.xml= file.
+    If the type of project generated is =war=, a servlet (=ExampleServlet=) is generated, along with a JSP file and an empty =web.xml= file.
 
     When running the Jetty plugin, /e.g./:
 
@@ -64,29 +71,24 @@ The version *must* be of the form =major.minor.patch-classifier=.
 mvn org.eclipse.jetty:jetty-maven-plugin:9.4.12.v20180830:run-war
 #+END_EXAMPLE
 
-    the example can then be accessed at http://localhost:8080/hello
+    The example can then be accessed at http://localhost:8080/hello
 
 ** Add Dependency
 
-   To add dependencies, you must be in the folder where the pom file
-   you want to add the dependency to is.
+   To add dependencies, you must be in the folder where the pom file you want to add the dependency to is.
 
-   To add a dependency, simply pass the coordinates of the dependency,
-   and add scope if needed (if no scope is given, =compile= is
-   assumed):
+   To add a dependency, simply pass the coordinates of the dependency, and add scope if needed (if no scope is given, =compile= is assumed):
 
 #+BEGIN_EXAMPLE
     mvnizer add org.apache.commons:commons-lang3:3.1:jar
     mvnizer add org.mockito:mockito-core:1.9.5-rc1:jar:test
 #+END_EXAMPLE
 
-The =search= features makes it easy to find the coordinates of the
-dependencies for you.
+The =search= features makes it easy to find the coordinates of the dependencies for you.
 
 ** Dependency Search
 
-You can search for dependencies in the Maven central repository with
-the command:
+You can search for dependencies in the Maven central repository with the command:
 
 #+BEGIN_EXAMPLE
     $ mvnizer search <text>
@@ -94,6 +96,6 @@ the command:
 
 * License
 
-MIT License.
+  MIT License.
 
-© Copyright 2012–2021 — Sébastien Le Callonnec
+  © Copyright 2012–2021 — Sébastien Le Callonnec

data/bin/mvnizer

@@ -26,7 +26,7 @@ HELP
 
 options = {}
 
-opts = OptionParser.new do |opts|
+opt_parser = OptionParser.new do |opts|
   opts.banner = help
 
   opts.on_tail("-h", "--help", "Show this message") do
@@ -38,10 +38,22 @@ opts = OptionParser.new do |opts|
     puts "Mvnizer " + Mvnizer::Version::STRING
     exit 0
   end
+
+  opts.on("--docker", "Create Dockerfile.  Ignored if not `new' command.") do
+    options[:docker] = true
+  end
+
+  opts.on("--main [MAIN_CLASS]", "Create a main class with name MAIN_CLASS.") do |main|
+    options[:main] = main
+  end
+
+  opts.on("--logger", "Add logging dependencies.  Ignored if not `new' command.") do
+    options[:logger] = true
+  end
 end
 
 # Read command line options into `options` hash
-opts.parse!
+opt_parser.parse!
 
 if ARGV.size == 2
   options[:command] = ARGV[0]

data/conf/default.yml

@@ -1,5 +1,8 @@
 group_id: com.example
 version: 0.0.1-SNAPSHOT
 type: jar
-dependencies: [ "org.junit.jupiter:junit-jupiter-engine:5.7.0:jar:test" ]
-plugins: [ ":maven-compiler-plugin:3.8.1" ]
+dependencies: [ "org.junit.jupiter:junit-jupiter-engine:5.8.2:jar:test" ]
+plugins: [ ":maven-compiler-plugin:3.10.0" ]
+logging_deps: [ "org.slf4j:slf4j-api:1.7.36:jar",
+                "org.slf4j:slf4j-simple:1.7.36:jar",
+                "ch.qos.logback:logback-core:1.2.11:jar" ]

data/lib/mvnizer/commands/new_project.rb

@@ -24,6 +24,19 @@ module Mvnizer
                       "#{project.artifact_id}/.editorconfig",
                       project)
 
+        if project.main
+          target_directory = project.package_name.gsub(/\./, File::SEPARATOR)
+          generate_file(File.join(TEMPLATE_DIR, "Main.java.erb"),
+                        "#{project.artifact_id}/src/main/java/#{target_directory}/#{project.main}.java",
+                        project)
+        end
+
+        if project.docker
+          generate_file(File.join(TEMPLATE_DIR, "Dockerfile.erb"),
+                        "#{project.artifact_id}/Dockerfile",
+                        project)
+        end
+
       end
 
       # Returns the list of dependencies to be added for this type of project.

data/lib/mvnizer/coordinate_parser.rb

@@ -4,10 +4,10 @@ module Mvnizer
     def parse(coordinates)
       p  = nil
       # When no group and type is given
-      if coordinates =~ /\A([a-zA-Z][\w\.\-]+)(:(\d+\.\d+\.\d(\-\w+)?))?:(war|jar|pom)/
+      if coordinates =~ /\A([a-zA-Z][\w\.\-]+)(:(\d+\.\d+\.\d+(\-\w+)?))?:(war|jar|pom)/
         p = Project.new(nil, $1, $3, $5)
       else
-        coordinates.scan(/(([a-zA-Z][\w\.\-]+):)?([a-zA-Z][\w\.\-]+)(:(\d+\.\d+\.\d(\-\w+)?))?(:(war|jar|pom))?/) do
+        coordinates.scan(/(([a-zA-Z][\w\.\-]+):)?([a-zA-Z][\w\.\-]+)(:(\d+\.\d+\.\d+(\-\w+)?))?(:(war|jar|pom))?/) do
           |i,g,a,v0,v,m,t0,t|
           p = Project.new(g, a, v, t)
         end
@@ -20,7 +20,7 @@ module Mvnizer
     # the scope (test, compile, provided, runtime, system or import)
     def parse_scoped_coordinates(coordinates)
       p  = nil
-      if coordinates =~ /\A(([a-zA-Z][\w\.\-]+):)?([a-zA-Z][\w\.\-]+)(:(\d+\.\d+(\.\d)?(\-\w+)?))?:(war|jar|pom):?(test|compile|provided|runtime|system|import)?/
+      if coordinates =~ /\A(([a-zA-Z][\w\.\-]+):)?([a-zA-Z][\w\.\-]+)(:(\d+\.\d+(\.\d+)?(\-\w+)?))?:(war|jar|pom):?(test|compile|provided|runtime|system|import)?/
         p = Project.new($2, $3, $5, $8, [], $9)
       end
       p

data/lib/mvnizer/mvnize.rb

@@ -17,19 +17,19 @@ module Mvnizer
     # passed in +options+.
     # If the command does not exit, throw an error.
     def run(options)
-      raise ArgumentError, "Please give a name to the project." unless options[:name]
+      raise ArgumentError, 'Please give a name to the project.' unless options[:name]
 
       case options[:command]
-      when "new"
+      when 'new'
         project_details = define_project(options)
-        project_command = Mvnizer::Command::ProjectFactory.create(project_details.type)
 
+        project_command = Mvnizer::Command::ProjectFactory.create(project_details.type)
         project_command.run(project_details)
         out.puts("Project #{project_details.artifact_id} created successfully.")
-      when "search"
+      when 'search'
         search_command = Command::SearchArtefact.new
         search_command.run(options)
-      when "add"
+      when 'add'
         add_command = Command::AddDependency.new
         add_command.run(options)
       else
@@ -51,20 +51,27 @@ module Mvnizer
       return_project = Project.new(project.group_id || options[:group_id],
                                    project.artifact_id,
                                    project.version || options[:version],
-                                   project.type || options[:type])
+                                   project.type || options[:type],
+                                   [], nil, [],
+                                   options[:main],
+                                   options[:docker] || false)
 
 
       # Get default dependencies, and add them after having parsed their coords.
       dependencies = options[:dependencies]
-      dependencies.each do |d|
+      dependencies&.each do |d|
         return_project.add_dependency(@coordinate_parser.parse_scoped_coordinates(d))
-      end if dependencies
+      end
 
+      # If logger is true, add logging dependencies.
+      options[:logging_deps]&.each do |d|
+        return_project.add_dependency(@coordinate_parser.parse_scoped_coordinates(d))
+      end
 
       plugins = options[:plugins]
-      plugins.each do |p|
+      plugins&.each do |p|
         return_project.add_plugin(@coordinate_parser.parse_scoped_coordinates(p))
-      end if plugins
+      end
 
       return_project
     end

data/lib/mvnizer/project.rb

@@ -3,9 +3,10 @@ module Mvnizer
   # The elements of the coordinates are read-only.
   class Project
     include Erbicole
-    attr_reader :group_id, :artifact_id, :version, :type, :dependencies, :scope, :plugins
+    attr_reader :group_id, :artifact_id, :version, :type, :dependencies, :scope, :plugins, :main, :docker
 
-    def initialize(group_id, artifact_id, version, type, dependencies = [], scope = nil, plugins = [])
+    def initialize(group_id, artifact_id, version, type, dependencies = [],
+                   scope = nil, plugins = [], main = nil, docker = false)
       @group_id = group_id
       @artifact_id = artifact_id
       @version = version
@@ -13,6 +14,8 @@ module Mvnizer
       @dependencies = dependencies
       @scope = scope
       @plugins = plugins
+      @main = main
+      @docker = docker
     end
 
     def add_dependency(dependency)
@@ -25,11 +28,11 @@ module Mvnizer
 
     # Check whether the project coordinates of this project
     # match the ones of the other project.
-    def ==(project)
-      (group_id == project.group_id \
-       && artifact_id == project.artifact_id \
-       && version == project.version \
-       && type == project.type)
+    def ==(other)
+      (group_id == other.group_id \
+       && artifact_id == other.artifact_id \
+       && version == other.version \
+       && type == other.type)
     end
 
     def package_name

data/lib/mvnizer/templates/Dockerfile.erb

@@ -0,0 +1,7 @@
+FROM gcr.io/distroless/java-debian11:11
+ARG JAR_FILE=<%= artifact_id %>-<%= version %>.<%= type %>
+
+COPY --chown=nonroot:nonroot ./target/${JAR_FILE} /app/<%= artifact_id %>.<%= type %>
+WORKDIR /app
+
+CMD ["/app/<%= artifact_id %>.<%= type %>"]

data/lib/mvnizer/templates/Main.java.erb

@@ -0,0 +1,8 @@
+package <%= package_name %>;
+
+
+public class <%= main %> {
+    public static void main(String... args) {
+        System.out.println("Hello World!");
+    }
+}

data/lib/mvnizer/templates/_dependency.xml.erb

@@ -1,6 +1,6 @@
     <dependency>
       <groupId><%= group_id %></groupId>
       <artifactId><%= artifact_id %></artifactId>
-      <version><%= version %></version>
-      <% if scope && scope != "compile" %><scope><%= scope %></scope><% end %>
+      <version><%= version %></version><% if scope && scope != "compile" %>
+      <scope><%= scope %></scope><% end %>
     </dependency>

data/lib/mvnizer/templates/pom.xml.erb

@@ -21,12 +21,31 @@
     <plugins>
       <plugin>
         <artifactId>maven-compiler-plugin</artifactId>
-        <version>3.8.1</version>
+        <version>3.10.0</version>
         <configuration>
-          <source>1.8</source>
-          <target>1.8</target>
+          <source>11</source>
+          <target>11</target>
         </configuration>
-      </plugin><% plugins.each do |p| if p %><%= render('_plugin.xml.erb', p) %><% end; end %>
+      </plugin><% if main %>
+      <plugin>
+        <artifactId>maven-shade-plugin</artifactId>
+        <version>3.2.4</version>
+        <executions>
+          <execution>
+            <phase>package</phase>
+            <goals>
+              <goal>shade</goal>
+            </goals>
+            <configuration>
+              <transformers>
+                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+                  <mainClass><%= package_name %>.<%= main %></mainClass>
+                </transformer>
+              </transformers>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin><% end %><% plugins.each do |p| if p %><%= render('_plugin.xml.erb', p) %><% end; end %>
     </plugins>
   </build>
 </project>

data/lib/mvnizer/version.rb

@@ -1,5 +1,5 @@
 module Mvnizer
   module Version
-    STRING = '1.0.0'
+    STRING = '1.3.0'
   end
 end

data/mvnizer.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
 
   s.require_paths = ["lib"]
   s.authors = ["S\u{e9}bastien Le Callonnec"]
-  s.date = "2021-05-23"
-  s.description = "Bootstrap a Maven project without the pain of archetypes."
+  s.date = "2021-11-12"
+  s.description = "Generate a Maven project with pre-defined values, including pom file, gitignore, and more."
   s.email = "sebastien@weblogism.com"
   s.executables = ["mvnizer"]
   s.extra_rdoc_files = [

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: mvnizer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Sébastien Le Callonnec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-23 00:00:00.000000000 Z
+date: 2021-11-12 00:00:00.000000000 Z
 dependencies: []
-description: Bootstrap a Maven project without the pain of archetypes.
+description: Generate a Maven project with pre-defined values, including pom file,
+  gitignore, and more.
 email: sebastien@weblogism.com
 executables:
 - mvnizer
@@ -47,6 +48,8 @@ files:
 - lib/mvnizer/plugin.rb
 - lib/mvnizer/project.rb
 - lib/mvnizer/task_helper.rb
+- lib/mvnizer/templates/Dockerfile.erb
+- lib/mvnizer/templates/Main.java.erb
 - lib/mvnizer/templates/_dependency.xml.erb
 - lib/mvnizer/templates/_plugin.xml.erb
 - lib/mvnizer/templates/editorconfig.erb