maven-helper-script 0.1.1 → 0.1.2

data/Gemfile

@@ -2,7 +2,6 @@ source "http://rubygems.org"
 
 group :development do
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.2.0"
   gem "jeweler", "~> 1.8.4"
   gem "rspec", "~> 2.11.0"
 end

data/Gemfile.lock

@@ -25,7 +25,6 @@ PLATFORMS
   x86-mingw32
 
 DEPENDENCIES
-  bundler (~> 1.2.0)
   jeweler (~> 1.8.4)
   rdoc (~> 3.12)
   rspec (~> 2.11.0)

data/README.rdoc

@@ -1,5 +1,7 @@
 = Maven Helper Script
 
+{<img src="https://secure.travis-ci.org/kingOburgers/maven-helper-script.png" />}[http://travis-ci.org/kingOburgers/maven-helper-script]
+
 == What is it?
 
 A script to simplify how you execute Maven commands. For example, instead of:
@@ -10,6 +12,8 @@ You can do something like:
 
     m ci p ci d
 
+== How?
+
 All you need is a YAML file with contents like this:
 
     modules:
@@ -19,7 +23,20 @@ All you need is a YAML file with contents like this:
     commands:
       - clean
       - install
-      - jetty:run
+
+    arguments:
+      - -ff
+
+Or you can supply a YAML file with your commands in a map, like this:
+
+    modules:
+      p: parent
+      d: domain
+
+    commands:
+      c: clean
+      i: install
+      cd: clean deploy
 
     arguments:
       - -ff
@@ -30,27 +47,34 @@ If you don't want to define a mapping for your module, you can use it's name.
 
     m ci parent ci d
 
-You can also create shorthand commands for various plugin phases. For example, executing "jetty:run" on your "web module could be:
+You can also create shorthand commands for various plugin phases. For example, executing "jetty:run" on your "web" module could be:
 
     m jr web
 
+if you provide a mapping file with either:
+
+    commands:
+      jr: jetty:run
+
+or:
+
+    commands:
+      - jetty:run
+
+
 All parameters passed into the helper script are applied to every execution. So you only need to flag a command like offline mode once:
 
     m ci web ci parent -o
 
-Including the optional "arguments:" mapping in your m.yml file allows you to apply arguments without typing them in the command line. The example "m.yml above would trigger the "-ff" arg for maven.
+Including the optional "arguments:" mapping in your m.yml file allows you to apply arguments without typing them in the command line. The example YAML files above would trigger the "-ff" arg for maven.
 
 Commands can be executed in any directory of your project, as long as there is an "m.yml" file in your project's top-level directory.
 
 == How do I use it?
  - Make sure you have ruby installed and on your path.
- - Check out the project to a directory on your machine.
- - From the checkout directory, type "rake install".
+ - In a command window, type "gem install maven-helper-script".
  - Find one of your existing maven projects and put an "m.yml" file like the one above in the top-level directory.
  - In a command window, "cd" to a directory in your project.
  - Execute a command.
 
-If you're having trouble, take a look at the sample-mvn-project located within the project on github.
-
-== To Do
- - Support commands in the form of a map, similar to how the modules are defined.
+If you're having trouble, take a look at the wiki or sample-mvn-project located within the project.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/argument_parser.rb

@@ -5,7 +5,7 @@ module MavenHelperScript
   class ArgumentParser
     def initialize(file)
       @projectPom = File.join(file, "pom.xml")
-      @configChecker = MavenHelperScript::ConfigurationChecker.new(file)
+      @configChecker = MavenHelperScript::ConfigurationChecker.new(file, 'm.yml')
     end
 
     public

data/lib/configuration_checker.rb

@@ -3,8 +3,8 @@ require 'yaml'
 module MavenHelperScript
 
   class ConfigurationChecker
-    def initialize(file)
-      @yml = YAML::load_file(File.join(file, 'm.yml'))
+    def initialize(file, configFileName)
+      @yml = YAML::load_file(File.join(file, configFileName))
       @commands = buildCommandKeys()
     end
 
@@ -23,34 +23,39 @@ module MavenHelperScript
       if !result
         result = ""
         mapping.each_char do |character|
-          result << findCommandFor(character) << " "
+          command = findCommandFor(character)
+          if !command || command.empty?
+            raise "Unable to locate command for: " << character
+          end
+          result << command << " "
         end
         result.strip!
       end
 
-
-      if !result || result.empty?
-        raise "Unable to locate command for: " << mapping
-      end
-
       result
     end
 
     private
     def buildCommandKeys()
-      commandKeys = Hash.new()
-      @yml['commands'].each do |phase|
-        if phase.include? ':'
-          key = ""
-          phase.split(':').each do |part|
-            key << part[0]
+      if @yml['commands'].class ==  Hash
+        #They are a map so you don't need to break them up.
+        return @yml['commands']
+      else
+        #Break the list up into a map keyed off the possible command values
+        commandKeys = Hash.new()
+        @yml['commands'].each do |phase|
+          if phase.include? ':'
+            key = ""
+            phase.split(':').each do |part|
+              key << part[0]
+            end
+            commandKeys[key] = phase
+          else
+            commandKeys[phase[0]] = phase
           end
-          commandKeys[key] = phase
-        else
-          commandKeys[phase[0]] = phase
         end
+        return commandKeys
       end
-      commandKeys
     end
 
     def findCommandFor(mapping)

data/maven-helper-script.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "maven-helper-script"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["kingOburgers"]
-  s.date = "2012-09-09"
+  s.date = "2012-09-19"
   s.description = "Execute your complex maven commands faster with the shortened helper syntax. See the rdoc for more details and examples."
   s.email = "kieferfam@msn.com"
   s.executables = ["m"]
@@ -36,9 +36,12 @@ Gem::Specification.new do |s|
     "sample-mvn-project/parent/pom.xml",
     "sample-mvn-project/pom.xml",
     "test/argument_parser_spec.rb",
+    "test/configuration_checker_map_spec.rb",
     "test/configuration_checker_spec.rb",
     "test/m.yml",
-    "test/project_home_finder_spec.rb"
+    "test/map.yml",
+    "test/project_home_finder_spec.rb",
+    "travis.yml"
   ]
   s.homepage = "http://github.com/kingOburgers/maven-helper-script"
   s.require_paths = ["lib"]
@@ -50,18 +53,15 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.2.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_development_dependency(%q<rspec>, ["~> 2.11.0"])
     else
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.2.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
       s.add_dependency(%q<rspec>, ["~> 2.11.0"])
     end
   else
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.2.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
     s.add_dependency(%q<rspec>, ["~> 2.11.0"])
   end

data/test/configuration_checker_map_spec.rb

@@ -0,0 +1,38 @@
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require "configuration_checker"
+
+describe MavenHelperScript::ConfigurationChecker do
+  before(:each) do
+    @checker = MavenHelperScript::ConfigurationChecker.new(File.join(File.dirname(__FILE__)), 'map.yml')
+  end
+
+  it "should find module by mapping" do
+    @checker.checkForModule("p").should == "parent"
+  end
+
+  it "should send back mapping name when no module found, assume that is the correct module name" do
+    @checker.checkForModule("boo").should == "boo"
+  end
+
+  it "should find command using first characters when not a plugin execution" do
+    @checker.checkForCommand("ci").should == "clean install"
+  end
+
+  it "should blow up if you can't find the other part of a command" do
+    expect {@checker.checkForCommand("cj") }.to raise_error(RuntimeError, "Unable to locate command for: j")
+  end
+
+  it "should find plugin execution" do
+    @checker.checkForCommand("jr").should == "jetty:run"
+  end
+
+  it "should blow up when can't find command" do
+    expect {@checker.checkForCommand("j") }.to raise_error(RuntimeError, "Unable to locate command for: j")
+  end
+
+  it  "should return all command arguments" do
+    args = Array['-ff', '-DskipTests']
+    expect @checker.checkForArguments().should == args
+  end
+
+end

data/test/configuration_checker_spec.rb

@@ -3,7 +3,7 @@ require "configuration_checker"
 
 describe MavenHelperScript::ConfigurationChecker do
   before(:each) do
-    @checker = MavenHelperScript::ConfigurationChecker.new(File.join(File.dirname(__FILE__)))
+    @checker = MavenHelperScript::ConfigurationChecker.new(File.join(File.dirname(__FILE__)), 'm.yml')
   end
 
   it "should find module by mapping" do

data/test/map.yml

@@ -0,0 +1,17 @@
+modules:
+  p: parent
+  par: parent
+
+commands:
+  c: clean
+  p: package
+  tc: test-compile
+  jr: jetty:run
+  i: install
+  d: deploy
+  ci: clean install
+
+arguments:
+  - -ff
+  - -DskipTests
+

data/travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+
+rvm:
+  - 1.9.3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: maven-helper-script
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-09 00:00:00.000000000 Z
+date: 2012-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -27,22 +27,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.12'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -103,9 +87,12 @@ files:
 - sample-mvn-project/parent/pom.xml
 - sample-mvn-project/pom.xml
 - test/argument_parser_spec.rb
+- test/configuration_checker_map_spec.rb
 - test/configuration_checker_spec.rb
 - test/m.yml
+- test/map.yml
 - test/project_home_finder_spec.rb
+- travis.yml
 homepage: http://github.com/kingOburgers/maven-helper-script
 licenses: []
 post_install_message: 
@@ -120,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1037379277
+      hash: -317974925
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: