jetty-run 0.1.0 → 0.2.1

data/README.md

@@ -1,15 +1,75 @@
-# jetty run #
+# jetty run 
 
-jetty-run will use Gemfile/Gemfile.lock and Jarfile/Jarfile.lock to setup an environment to start rails in development mode with jetty. it uses ruby-maven to achieve this, i.e. all missing jar dependencies (jetty and all) will be downloaded on the first run (that can take time since it is a lot).
+* [![Build Status](https://secure.travis-ci.org/mkristian/jetty-run.png)](http://travis-ci.org/mkristian/jetty-run)
+* [![Dependency Status](https://gemnasium.com/mkristian/jetty-run.png)](https://gemnasium.com/mkristian/jetty-run)
+* [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mkristian/jetty-run)
 
-jetty will start with port 8080 (none ssl) and 8443 (ssl). the ssl certificate is ./src/test/resources/server.keystore with password '123456' - it will be copied there on the first run.
 
-to customize jetty you can use _Mavenfile_ which allows to reconfigure jetty-maven-plugin with a ruby DSL:
+## install ##
 
-     properties['jetty.version'] = '7.5.1.v20110908'
+first uninstall older ruby-maven (< 3.0.4.0.29.0) if present, they will otherwise conflict with jetty-run command
 
-TODO more advanced example and current config
+    $ gem uninstall ruby-maven
+	$ gem install jetty-run
 
+## usage ##
+
+    $ cd my_rails_app
+ 	$ jruby -S bundle install #optional
+	$ jetty-run
+
+or for a rack application (assuming existiing config.ru)
+
+    $ cd my_rack_app
+ 	$ jruby -S bundle install #optional
+	$ jetty-run
+
+regarding `bundle install`: it must work wth JRuby since JRuby is the runtime environment. but `bundle install` since jetty-run will resolve a valid gemset itself and creates a Gemfile.lock (with the help of bundler). in short; all gems must be for the java platform or you need to provide jruby alternative gems.
+
+`jetty-run` works with both MRI and JRuby - MRI starts up slightly faster BUT **uses JRuby** when running the applicaton.
+
+jetty-run will use Gemfile/Gemfile.lock and Jarfile/Jarfile.lock to setup an environment to start rails in development mode with jetty. it uses ruby-maven to achieve this, i.e. all missing jar dependencies (jetty itself and all its dependences) will be downloaded on the first run (that can take time since it first needs to download all the jars).
+
+jetty will start with port 8080 (none ssl) and 8443 (ssl). the ssl certificate is ./target/server.keystore with password '123456'.
+
+to customize jetty you can use the _Mavenfile_ which allows to reconfigure jetty-maven-plugin, i.e. the version of jetty
+
+    properties['jetty.version'] = '7.5.1.v20110908'
+
+or you pass it in via the command line
+
+	$ jetty-run -- -Djetty.version=7.5.1.v20110908
+	
+**--** is used a separator after which you can use any maven open available. like `-- -X` gives you a complete maven debug output, etc.
+
+## running any given war-file ##
+
+    jetty-run war /path/to/war-file
+
+with this you can `warble` your warfile and use `jetty-run` to start it with jetty.
+
+## more ##
+
+see
+
+    jetty-run help
+	 
 # note #
 
-most functionality is hidden inside 'maven-tools' gem and de.saumya.mojo:ruby-tools jar (from jruby-maven-plugins). it was first part of these jruby-maven-plugins and slowly the functionality moved to the ruby side of things. so things are on the move . . .
+orginally the code was part the jruby-maven-plugins and slowly the functionality moved to the ruby side of things. so things are on the move and there is room for improvements . . .
+    
+contributing
+------------
+
+1. fork it
+2. create your feature branch (`git checkout -b my-new-feature`)
+3. commit your changes (`git commit -am 'Added some feature'`)
+4. push to the branch (`git push origin my-new-feature`)
+5. create new Pull Request
+
+meta-fu
+-------
+
+bug-reports and pull request are most welcome. otherwise
+
+enjoy :) 

data/bin/jetty-run

@@ -1,62 +1,39 @@
 #!/usr/bin/env ruby
-# if ARGV.size > 4 || ARGV[0] == "--help" || ARGV[0] == "-h" || ARGV[0] == "-?"
-#   puts "usage: #{File.basename($0)} [-e <environment>] [--war [<path/to/warfile>]]"
-#   puts "\tdefault environment: development"
-#   exit 1
-# end
-
-# args = [__FILE__.gsub(/-/, ':').gsub(/.*[\/\\]/, '')]
-# if ARGV.size == 2 && ARGV[0] == "-e"
-#   args << "-Drails.env=#{ARGV[1]}"
-#   args << "-Prun"
-# elsif ARGV.size == 1 && ARGV[0] == "--war"
-#   args = ["jetty:run-war", "-Pwar"]
-# elsif ARGV.size == 2 && ARGV[0] == "--war"
-#   args = ["jetty:deploy-war", "-DwebApp=#{ARGV[1]}", "-Pwar"]
-# elsif ARGV.size == 3 && ARGV[0] == "-e" && ARGV[2] == "--war"
-#    args = ["jetty:run-war", "-Pwar", "-Drails.env=#{ARGV[1]}"]
-# elsif ARGV.size == 3 && ARGV[1] == "-e" && ARGV[0] == "--war"
-#    args = ["jetty:run-war", "-Pwar", "-Drails.env=#{ARGV[2]}"]
-# elsif ARGV.size == 4 && ARGV[0] == "-e" && ARGV[2] == "--war"
-#    args = ["jetty:deploy-war", "-Pwar",  "-DwebApp=#{ARGV[3]}", "-Drails.env=#{ARGV[1]}"]
-# elsif ARGV.size == 4 && ARGV[2] == "-e" && ARGV[0] == "--war"
-#    args = ["jetty:deploy-war", "-Pwar",  "-DwebApp=#{ARGV[1]}", "-Drails.env=#{ARGV[3]}"]
-# end
-# ARGV.replace(args)
-# if !File.exists?(File.join('config', 'web.xml')) && !File.exists?(File.join('src', 'main', 'webapp', 'WEB-INF', 'web.xml'))
-#   require 'fileutils'
-#   web_xml = Gem.find_files( 'maven/jetty/web.xml').first
-#   FileUtils.cp(web_xml, 'config')
-# end
-# load Gem.bin_path('ruby-maven', 'rmvn')
-
-
-require 'maven/jetty/ruby_maven'
+require 'maven/jetty/cli'
 require 'thor'
 
 class JettyCommand < Thor
   no_tasks do
     def mvn
-      @mvn ||= Maven::Jetty::RubyMaven.new
+      @mvn ||= Maven::Jetty::Cli.new
     end
     
     def exec(*args)
       ARGV.clear # clean up in case another script gets executed
       mvn.exec(args)
     end
+
+    def maven_args
+      args = ARGV.dup
+      if i = args.index("--")
+        maven_args = args[i..-1]
+      end
+      maven_args ||= []
+      if options[ :pom ]
+        maven_args << '--pom'
+        maven_args << options[ :pom ]
+      end
+      maven_args
+    end
   end
 
-  desc "[run]", "runs jetty with a rails filesystem layout"
-  method_option :environment, :aliases => '-e', :type => :string, :required => false, :desc => 'rails environment'
+  desc "[run]", "runs jetty with either rails filesystem layout or with config.ru"
+  method_option :environment, :aliases => '-e', :type => :string, :required => false, :desc => 'rails environment (no effect on rackup setups)'
   method_option :port, :type => :numeric, :default => 8080, :desc => 'http port'
   method_option :sslport, :type => :numeric, :default => 8443, :desc => 'https port'
+  method_option :pom, :type => :string, :default => '.jetty-pom.xml', :desc => 'name of pom file which get generated (jetty-run just generates a pom.xml which gets execued by maven)'
   def server(*args)
-    args = ARGV.dup
-    args.delete('server')
-    if i = args.index("--")
-      maven_args = args[i..-1]
-    end
-    maven_args ||= []
+    maven_args = self.maven_args
     maven_args << "-Drails.env=#{options[:environment]}" if options[:environment]
     maven_args << "-Djetty.port=#{options[:port]}"
     maven_args << "-Djetty.sslport=#{options[:sslport]}"
@@ -67,18 +44,14 @@ class JettyCommand < Thor
   method_option :port, :type => :numeric, :default => 8080, :desc => 'http port'
   method_option :sslport, :type => :numeric, :default => 8443, :desc => 'https port'
   def war(file, *args)
-    args = ARGV.dup
-    if i = args.index("--")
-      maven_args = args[i..-1]
-    end
-    maven_args ||= []
+    maven_args = self.maven_args
     maven_args << "-Djetty.war=#{file}"
     maven_args << "-Djetty.port=#{options[:port]}"
     maven_args << "-Djetty.sslport=#{options[:sslport]}"
     exec(*(["jetty:deploy-war", "-Pwar"] + maven_args))
   end
 
-  desc "pom", "dump the pom used into pom.xml"
+  desc "pom", "dump the jetty pom into pom.xml"
   method_option :force, :type => :boolean, :default => false, :desc => 'force to overwrite pom.xml'
   def pom(*args)
     if File.exists?('pom.xml') && !options[:force]
@@ -87,28 +60,10 @@ class JettyCommand < Thor
       mvn.dump_pom(options[:force])
     end
   end
-
-  def help(*args)
-    super(*args)
-    goal = 
-      case args[0]
-      when 'server'  
-        'run'
-      when 'war' 
-        'deploy-war'
-      end
-    if goal
-      puts
-      puts "Maven Options: (from jetty maven plugin)"
-      exec ["jetty:help", "-Ddetail=true", "-Dgoal=#{goal}"]
-    end
-  end
-
 end
 if i = ARGV.index('run')
   ARGV[i] = 'server'
 end
-#p ARGV.detect {|a| p a ;a =~ /^[a-z]/ }
 unless ARGV[0] =~ /^[a-z]/
   ARGV.insert(0, 'server')
 end

data/bin/jetty-run~

@@ -1,31 +1,84 @@
 #!/usr/bin/env ruby
-if ARGV.size > 4 || ARGV[0] == "--help" || ARGV[0] == "-h" || ARGV[0] == "-?"
-  puts "usage: #{File.basename($0)} [-e <environment>] [--war [<path/to/warfile>]]"
-  puts "\tdefault environment: development"
-  exit 1
-end
+require 'maven/jetty/ruby_maven'
+require 'thor'
+
+class JettyCommand < Thor
+  no_tasks do
+    def mvn
+      @mvn ||= Maven::Jetty::RubyMaven.new
+    end
+    
+    def exec(*args)
+      ARGV.clear # clean up in case another script gets executed
+      mvn.exec(args)
+    end
+  end
+
+  desc "[run]", "runs jetty with a rails filesystem layout"
+  method_option :environment, :aliases => '-e', :type => :string, :required => false, :desc => 'rails environment'
+  method_option :port, :type => :numeric, :default => 8080, :desc => 'http port'
+  method_option :sslport, :type => :numeric, :default => 8443, :desc => 'https port'
+  def server(*args)
+    args = ARGV.dup
+    args.delete('server')
+    if i = args.index("--")
+      maven_args = args[i..-1]
+    end
+    maven_args ||= []
+    maven_args << "-Drails.env=#{options[:environment]}" if options[:environment]
+    maven_args << "-Djetty.port=#{options[:port]}"
+    maven_args << "-Djetty.sslport=#{options[:sslport]}"
+    exec(*(["jetty:run", "-Prun"] + maven_args))
+  end
+
+  desc "war WARFILE", "runs jetty with a given warfile"
+  method_option :port, :type => :numeric, :default => 8080, :desc => 'http port'
+  method_option :sslport, :type => :numeric, :default => 8443, :desc => 'https port'
+  def war(file, *args)
+    args = ARGV.dup
+    if i = args.index("--")
+      maven_args = args[i..-1]
+    end
+    maven_args ||= []
+    maven_args << "-Djetty.war=#{file}"
+    maven_args << "-Djetty.port=#{options[:port]}"
+    maven_args << "-Djetty.sslport=#{options[:sslport]}"
+    exec(*(["jetty:deploy-war", "-Pwar"] + maven_args))
+  end
 
-args = [__FILE__.gsub(/-/, ':').gsub(/.*[\/\\]/, '')]
-if ARGV.size == 2 && ARGV[0] == "-e"
-  args << "-Drails.env=#{ARGV[1]}"
-  args << "-Prun"
-elsif ARGV.size == 1 && ARGV[0] == "--war"
-  args = ["jetty:run-war", "-Pwar"]
-elsif ARGV.size == 2 && ARGV[0] == "--war"
-  args = ["jetty:deploy-war", "-DwebApp=#{ARGV[1]}", "-Pwar"]
-elsif ARGV.size == 3 && ARGV[0] == "-e" && ARGV[2] == "--war"
-   args = ["jetty:run-war", "-Pwar", "-Drails.env=#{ARGV[1]}"]
-elsif ARGV.size == 3 && ARGV[1] == "-e" && ARGV[0] == "--war"
-   args = ["jetty:run-war", "-Pwar", "-Drails.env=#{ARGV[2]}"]
-elsif ARGV.size == 4 && ARGV[0] == "-e" && ARGV[2] == "--war"
-   args = ["jetty:deploy-war", "-Pwar",  "-DwebApp=#{ARGV[3]}", "-Drails.env=#{ARGV[1]}"]
-elsif ARGV.size == 4 && ARGV[2] == "-e" && ARGV[0] == "--war"
-   args = ["jetty:deploy-war", "-Pwar",  "-DwebApp=#{ARGV[1]}", "-Drails.env=#{ARGV[3]}"]
+  desc "pom", "dump the pom used into pom.xml"
+  method_option :force, :type => :boolean, :default => false, :desc => 'force to overwrite pom.xml'
+  def pom(*args)
+    if File.exists?('pom.xml') && !options[:force]
+      warn "abort. pom.xml already exist. use --force to overwrite"
+    else
+      mvn.dump_pom(options[:force])
+    end
+  end
+
+  def help(*args)
+    super(*args)
+    goal = 
+      case args[0]
+      when 'server'  
+        'run'
+      when 'war' 
+        'deploy-war'
+      end
+# TODO not sure whether or not these options are needed/helpful
+#    if goal
+#      puts
+#      puts "Maven Options: (from jetty maven plugin)"
+#      exec ["jetty:help", "-Ddetail=true", "-Dgoal=#{goal}"]
+#    end
+  end
+
+end
+if i = ARGV.index('run')
+  ARGV[i] = 'server'
 end
-ARGV.replace(args)
-if !File.exists?(File.join('config', 'web.xml')) && !File.exists?(File.join('src', 'main', 'webapp', 'WEB-INF', 'web.xml'))
-  require 'fileutils'
-  web_xml = Gem.find_files( 'maven/jetty/web.xml').first
-  FileUtils.cp(web_xml, 'config')
+#p ARGV.detect {|a| p a ;a =~ /^[a-z]/ }
+unless ARGV[0] =~ /^[a-z]/
+  ARGV.insert(0, 'server')
 end
-load Gem.bin_path('ruby-maven', 'rmvn')
+JettyCommand.start

data/lib/jetty-run.rb

@@ -1 +1,21 @@
+#
+# Copyright (C) 2013 Christian Meier
+#
+# 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.
+#
 require 'jetty_run'

data/lib/jetty_run.rb

@@ -1 +1,21 @@
+#
+# Copyright (C) 2013 Christian Meier
+#
+# 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.
+#
 require 'maven/jetty/version'

data/lib/maven/jetty/Mavenfile

@@ -0,0 +1,15 @@
+#-*- mode: ruby -*-
+
+jar("org.jruby.rack:jruby-rack", '1.1.13.1')
+if defined?( JRUBY_VERSION ) && JRUBY_VERSION =~ /^1\.7\./
+  jar("org.jruby:jruby-core", "${jruby.version}")
+else
+  jar("org.jruby:jruby-complete", "${jruby.version}")
+end
+
+# lock down versions
+properties['jruby.version'] = '1.7.3'
+properties['jruby.plugins.version'] = '0.29.4'
+properties['jetty.version'] = '8.1.9.v20130131'
+
+# vim: syntax=Ruby

data/lib/maven/jetty/Mavenfile~

@@ -0,0 +1,11 @@
+#-*- mode: ruby -*-
+
+jar("org.jruby:jruby-complete", "1.7.2")
+jar("org.jruby.rack:jruby-rack", '1.1.13.1')
+
+# lock down versions
+properties['jetty.version'] = 
+properties['jruby.version'] = '1.7.2'
+properties['jruby.plugins.version'] = '0.29.3'
+
+# vim: syntax=Ruby

data/lib/maven/jetty/cli.rb

@@ -0,0 +1,34 @@
+#
+# Copyright (C) 2013 Christian Meier
+#
+# 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.
+#
+require 'maven/ruby/cli'
+require 'maven/jetty/pom_magic'
+
+module Maven
+  module Jetty
+    class Cli < Maven::Ruby::Cli
+
+      def magic_pom( dir = '.', *args )
+        PomMagic.new.generate_pom( File.expand_path( dir ), *args ) 
+      end
+
+    end
+  end
+end

data/lib/maven/jetty/cli.rb~

@@ -0,0 +1,52 @@
+require 'ruby_maven'
+require 'maven/jetty/rails_project'
+
+module Maven
+  module Jetty
+    class Cli < Maven::Ruby::Cli
+
+      def magic_pom(dir = '.', *args)
+
+        if File.exists? File.join( 'config', 'application.rb' )
+          ensure_web_xml( dir, "rails" )
+        else
+          ensure_web_xml( dir, "rack" )
+        end
+
+        proj = JettyProject.new
+        proj.load_gemspec( first_gemspec( dir ) )
+        proj.load_gemfile( file( dir, 'Gemfile' ) )
+        proj.load_jarfile( file( dir, 'Jarfile' ) )
+        proj.load_gemfile( file( dir, 'Mavenfile' ) )
+        proj.add_defaults( :jruby_plugins => JRUBY_MAVEN_PLUGINS_VERSION )
+        pom = pom_xml(dir)
+        File.open(pom, 'w') do |f|
+          f.puts proj.to_xml
+        end
+      end
+      
+      def ensure_web_xml( dir = '.', flavour )
+        if !File.exists?(File.join( dir, 'config', 'web.xml')) && !File.exists?(File.join(dir, 'src', 'main', 'webapp', 'WEB-INF', 'web.xml'))
+          web_xml = Gem.find_files( "maven/jetty/#{flavour}-web.xml" ).first
+          FileUtils.cp(web_xml, 'config/web.xml')
+        end
+      end
+
+      def first_gemspec( dir = '.' )
+        gemspecs = Dir[ File.join( dir, "*.gemspec" ) ]
+        if gemspecs.size > 0
+          File.expand_path( gemspecs[ 0 ] )
+        end
+      end
+
+      def file( name, dir = '.' )
+        File.expand_path( File.join( dir, name ) )
+      end
+
+      def pom_xml( dir = '.' )
+        File.join( dir, ".pom.xml" )
+      end
+
+    end
+  end
+end