mvnizer 0.0.1 → 0.0.2

data/.rspec

@@ -1 +1 @@
---color
+--color

data/Gemfile

@@ -1,9 +1,9 @@
-source 'http://rubygems.org'
-
-group :development do
-  gem 'rspec', '~> 2.11.0'
-  gem 'rspec-mocks', '~> 2.11.2'
-  gem 'fakefs', '~> 0.4.0'
-  gem 'nokogiri', '~> 1.5.5'
-  gem 'jeweler', '~> 1.8.4'
-end
+source 'http://rubygems.org'
+
+group :development do
+  gem 'rspec', '~> 2.11.0'
+  gem 'rspec-mocks', '~> 2.11.2'
+  gem 'fakefs', '~> 0.4.0'
+  gem 'nokogiri', '~> 1.5.5'
+  gem 'jeweler', '~> 1.8.4'
+end

data/LICENSE.txt

@@ -1,20 +1,20 @@
-Copyright (c) 2012 Sebastien Le Callonnec
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2012 Sebastien Le Callonnec
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,5 +1,23 @@
-Bootstraps a Maven project.  Because archetypes shouldn't be so complicated.
-
-# Introduction
-
-Mvnizer is ideal to create a throw-away Maven project that adds junit as a dependency and sets up the Maven project structure.
+Bootstraps a Maven project.  Because archetypes shouldn't be so complicated.
+
+# Introduction
+
+Mvnizer is ideal to create a throw-away Maven project that adds junit as a dependency and sets up the Maven project structure.
+
+# Command
+
+Mvnizer is used as follows:
+
+    $ mvnizer new <coordinates>
+
+The coordinates can have the following format:
+
+    <group:>artifact<:version><:type>
+
+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.
+
+# License
+
+MIT License. 

data/Rakefile

@@ -1,55 +1,55 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-require './lib/mvnizer/version.rb'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "mvnizer"
-  gem.version = Mvnizer::Version::STRING
-  gem.homepage = "http://github.com/tychobrailleur/mvnizer"
-  gem.license = "MIT"
-  gem.summary = %Q{Bootstrap a Maven project without the pain of archetypes.}
-  gem.description = %Q{Bootstrap a Maven project without the pain of archetypes.}
-  gem.email = "sebastien@weblogism.com"
-  gem.authors = ["Sébastien Le Callonnec"]
-
-  gem.executables = ['mvnizer']
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :default => :spec
-
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "helloworld #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+require './lib/mvnizer/version.rb'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "mvnizer"
+  gem.version = Mvnizer::Version::STRING
+  gem.homepage = "http://github.com/tychobrailleur/mvnizer"
+  gem.license = "MIT"
+  gem.summary = %Q{Bootstrap a Maven project without the pain of archetypes.}
+  gem.description = %Q{Bootstrap a Maven project without the pain of archetypes.}
+  gem.email = "sebastien@weblogism.com"
+  gem.authors = ["Sébastien Le Callonnec"]
+
+  gem.executables = ['mvnizer']
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "helloworld #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
 # -*- coding: utf-8 -*-

data/TODO.md

@@ -0,0 +1,14 @@
+- Provide full or partial coordinates to define project coordinates. e.g. here are a list of valid values for mvnizer:
+
+    blah
+    blah:1.0.0-SNAPSHOT
+    blah:war
+    com.weblogism:blah
+    com.weblogism:blah:1.0.0-SNAPSHOT
+    com.weblogism:blah:war
+- Depending on type of artifact (jar, war, etc.), generate appropriate pom and structure.
+- Provide way to add dependency to pom given coordinates, e.g.:
+
+    mvnizer add org.junit:junit:4.10
+- Provide dependency search facility.
+- Support external config file (e.g. ~/.mvnizerrc) to override current defaults.

data/bin/mvnizer

@@ -1,35 +1,41 @@
-#!/usr/bin/env ruby
-
-$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
-require 'mvnizer'
-require 'optparse'
-
-
-help = <<HELP
-Mvnizer bootstraps a Maven project without the pain of archetypes.
-
-  mvnizer <project_name>
-HELP
-
-options = {}
-
-opts = OptionParser.new do |opts|
-  opts.banner = help
-
-  opts.on("--version", "Display current version") do
-    puts "Mvnizer " + Mvnizer::Version::STRING
-    exit 0
-  end
-end
-
-# Read command line options into `options` hash
-opts.parse!
-
-if ARGV.size == 1
-  options[:name] = ARGV[0]
-else
-  puts "Incorrect parameters.  Please `mvnizer --help` for usage."
-  exit(1)
-end
-
-Mvnizer::Mvnize.new.run(options)
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+require 'mvnizer'
+require 'optparse'
+
+
+help = <<HELP
+Mvnizer bootstraps a Maven project without the pain of archetypes.
+
+  mvnizer new <project_name>
+HELP
+
+options = {}
+
+opts = OptionParser.new do |opts|
+  opts.banner = help
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on("--version", "Display current version") do
+    puts "Mvnizer " + Mvnizer::Version::STRING
+    exit 0
+  end
+end
+
+# Read command line options into `options` hash
+opts.parse!
+
+if ARGV.size == 2
+  options[:command] = ARGV[0]
+  options[:name] = ARGV[1]
+else
+  puts "Incorrect parameters.  Please `mvnizer --help` for usage."
+  exit(1)
+end
+
+Mvnizer::Mvnize.new.run(options)

data/conf/default.yml

@@ -1,2 +1,4 @@
-group_id: com.weblogism
-version: 0.0.1-SNAPSHOT
+group_id: com.example
+version: 0.0.1-SNAPSHOT
+type: jar
+dependencies: [ "junit:junit:4.10:jar:test" ]

data/lib/mvnizer/commands/new_project.rb

@@ -0,0 +1,49 @@
+module Mvnizer
+  module Command
+    class NewProject
+      include Mvnizer::Configuration
+
+      def initialize(generator = Mvnizer::PomGenerator.new,
+                     dir_creator = Mvnizer::DirCreator.new,
+                     coordinate_parser = Mvnizer::CoordinateParser.new)
+        @generator = generator
+        @dir_creator = dir_creator
+        @coordinate_parser = coordinate_parser
+      end
+
+      # Creates the Maven project structure, and creates the pom file
+      # from the options
+      def run(options)
+        @project = define_project(options)
+
+        @dir_creator.create("#{@project.artifact_id}/src/main/java",
+                            "#{@project.artifact_id}/src/test/java")
+
+        File.open("#{@project.artifact_id}/pom.xml", "w") do |f|
+          f.write(@generator.generate(@project))
+        end
+      end
+      
+      private
+      # Creates an instance of +Project+ class populated with the coordinates
+      # set with the user’s definition, or default values if not set.
+      def define_project(options)
+        coordinates = options[:name]
+        options = conf(options)
+        
+        project = @coordinate_parser.parse(coordinates)
+        return_project = Project.new(project.group_id || options[:group_id],
+                                     project.artifact_id,
+                                     project.version || options[:version],
+                                     project.type || options[:type])
+        
+        dependencies = options[:dependencies]
+        dependencies.each do |d|
+          return_project.add_dependency(@coordinate_parser.parse_scoped_coordinates(d))
+        end if dependencies
+        
+        return_project
+      end
+    end
+  end
+end

data/lib/mvnizer/commands/new_war_project.rb

@@ -0,0 +1,20 @@
+module Mvnizer
+  module Command
+    class NewWarProject < NewProject
+      def run(options)
+        super
+
+        @dir_creator.create("#{@project.artifact_id}/src/main/webapp/WEB-INF")
+
+        # web.xml is optional in Servlet 3.0
+        # Do we keep its generation here?
+        web_xml = File.join(File.dirname(__FILE__), '..', 'templates', 'web.xml.erb')
+        FileUtils.cp(web_xml, "#{@project.artifact_id}/src/main/webapp/WEB-INF/web.xml")
+
+        # TODO:
+        # Create sample @WebServlet?
+        # Add JEE dependencies into pom.
+      end
+    end
+  end
+end

data/lib/mvnizer/commands/project_factory.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+module Mvnizer
+  module Command
+    class ProjectFactory
+      def self.create(type)
+        case type
+        when "jar"
+          return NewProject.new
+        when "war"
+          require 'mvnizer/commands/new_war_project'
+          return NewWarProject.new
+        else
+          raise ArgumentError, "Don’t know how to create #{type}."
+        end
+      end
+    end
+  end
+end
+

data/lib/mvnizer/commands.rb

@@ -0,0 +1,2 @@
+require 'mvnizer/commands/new_project'
+require 'mvnizer/commands/project_factory'

data/lib/mvnizer/configuration.rb

@@ -1,21 +1,24 @@
-require 'yaml'
-
-module Mvnizer
-  module Configuration
-    def conf(options)
-      config_file = File.join(File.dirname(__FILE__), "..", "..", "conf", "default.yml")
-      default_config = YAML.load_file(config_file)
-
-      symbolize_keys(default_config.merge(symbolize_keys(options)))
-    end
-
-    private
-    def symbolize_keys(hash)
-      h = hash.dup
-      h.keys.each do |key|
-        h[(key.to_sym rescue key) || key] = h.delete(key)
-      end
-      h
-    end
-  end
-end
+require 'yaml'
+
+module Mvnizer
+  module Configuration
+    # Loads configuration from config/default.yml
+    # and merges the values into the passed options hash.
+    def conf(options)
+      config_file = File.join(File.dirname(__FILE__), "..", "..", "conf", "default.yml")
+
+      default_config = YAML.load_file(config_file)
+      symbolize_keys(default_config.merge(symbolize_keys(options)))
+    end
+
+    private
+    # Transforms all the keys in the hash into symbols
+    def symbolize_keys(hash)
+      h = hash.dup
+      h.keys.each do |key|
+        h[(key.to_sym rescue key) || key] = h.delete(key)
+      end
+      h
+    end
+  end
+end

data/lib/mvnizer/coordinate_parser.rb

@@ -0,0 +1,29 @@
+module Mvnizer 
+  class CoordinateParser
+    # Parse the coordinates of an artifact.
+    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)/
+        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
+          |i,g,a,v0,v,m,t0,t|
+          p = Project.new(g, a, v, t)
+        end
+      end
+
+      p
+    end
+
+    # Parse the coordinates of a dependency, i.e. that include
+    # 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)/
+        p = Project.new($2, $3, $5, $8, [], $9)
+      end
+      p
+    end
+  end
+end

data/lib/mvnizer/dir_creator.rb

@@ -1,10 +1,10 @@
-require 'fileutils'
-
-module Mvnizer
-  class DirCreator
-    # creates recursively all directories passed as a param.
-    def create(*dir)
-      dir.each { |d| FileUtils.mkdir_p d }
-    end
-  end
-end
+require 'fileutils'
+
+module Mvnizer
+  class DirCreator
+    # creates recursively all directories passed as a param.
+    def create(*dir)
+      dir.each { |d| FileUtils.mkdir_p d }
+    end
+  end
+end

data/lib/mvnizer/erb_helper.rb

@@ -0,0 +1,27 @@
+module Mvnizer
+
+  # ERB utilities that needs to be brought into a class
+  # used as an ERB binding.
+  module Erbicole
+    # Path to folder storing all templates.
+    TEMPLATE_PATH = File.join(File.dirname(__FILE__), 'templates')
+
+    # Renders a template named `name` located in the templates
+    # folder.
+    def render(name, object = nil)
+      binding = get_binding
+
+      if object.respond_to?(:get_binding)
+        binding = object.get_binding
+      end
+
+      content = File.read(File.join(TEMPLATE_PATH, name))
+      ERB.new(content).result(binding)
+    end
+
+    # Return the ERB binding.
+    def get_binding
+      binding
+    end
+  end
+end

data/lib/mvnizer/mvnize.rb

@@ -1,23 +1,36 @@
-module Mvnizer
-  class Mvnize
-    include Configuration
-
-    def initialize(generator = Mvnizer::PomGenerator.new, dir_creator = Mvnizer::DirCreator.new)
-      @generator = generator
-      @dir_creator = dir_creator
-    end
-
-    # Creates the Maven project structure, and creates the pom file
-    # from the options
-    def run(options)
-      options = conf(options)
-
-      @dir_creator.create("#{options[:name]}/src/main/java", 
-                          "#{options[:name]}/src/test/java")
-
-      File.open("#{options[:name]}/pom.xml", "w") do |f|
-        f.write(@generator.generate(options))
-      end
-    end 
-  end
-end
+module Mvnizer
+  # Mvnize is the main entry point into Mvnizer.
+  class Mvnize
+    attr_writer :out
+
+    def out
+      @out ||= $stdout
+    end
+
+    def self.new_project
+      @new_project ||= Mvnizer::Command::NewProject.new
+    end
+
+    # Execute the right command depending on the :command parameter
+    # 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]
+      if options[:command] == "new"
+        # FIXME: coordinates should be parsed here to check type.
+        # and pass to the factory, rather than doing this if, 
+        # and parse coordinates later down in NewProject.
+        if options[:name] =~ /:war$/
+          project = Mvnizer::Command::ProjectFactory.create("war") 
+        else
+          project = Mvnizer::Command::ProjectFactory.create("jar")
+        end
+
+        project.run(options)
+        out.puts("Project created successfully.")
+      else
+        raise ArgumentError, "#{options[:command]} is not a valid command."
+      end
+    end
+  end
+end

data/lib/mvnizer/pom_generator.rb

@@ -1,25 +1,10 @@
-require 'erb'
-
-module Mvnizer
-  class Project
-    attr_reader :group_id, :artifact_id, :version
-    def initialize(group_id, artifact_id, version)
-      @group_id = group_id
-      @artifact_id = artifact_id
-      @version = version
-    end
-
-    def get_binding
-      binding
-    end
-  end
-
-  class PomGenerator
-    # Creates the pom content by reading the erb template.
-    def generate(options)
-      template = File.open(File.join(File.dirname(__FILE__), 'templates', 'pom.xml.erb'), 'r').read
-      project = Project.new(options[:group_id], options[:name], options[:version])
-      ERB.new(template).result(project.get_binding)
-    end
-  end
-end
+module Mvnizer
+  # This class handles the generation of the content of the pom file.
+  class PomGenerator
+    # Creates the pom content by reading the erb template.
+    def generate(project)
+      template = File.open(File.join(File.dirname(__FILE__), 'templates', 'pom.xml.erb'), 'r').read
+      ERB.new(template).result(project.get_binding)
+    end
+  end
+end