jruby-warck 1.0.1

data/README.md

@@ -0,0 +1,34 @@
+# jruby-warck
+
+jruby-warck takes any Rack-based application and sticks it in a .war file that you can run either
+
+  * with "java -jar" or
+  * inside a servlet container like Tomcat, JBoss or Jetty.
+
+Yes, it's like Warbler, but far simpler.
+
+## Usage
+
+### Dependencies
+  * jruby-jars
+  * jruby-rack
+
+### Basic
+
+  1. change directory to the root of your application
+  2. run "rake assets:precompile" if you've a Rails application.
+  3. run "warck package[war_name_here]"
+    3a. if you need to compile the source code, use "warck package_compiled[war_name_here]" instead
+  4. boom, a wild war_name_here.war appears!
+  5. deploy in your app server or run it in the command line
+
+### Customizing what gets in the .war
+
+#### Files
+When packaging, jruby-warck will include all .rb files in the web archive.
+
+Additionally, by default it will also include all .yml and .erb files, but there are two ways you can use to change this.
+
+* To select exactly what files will be brought, create a "select.files" inside the application directory containing a glob pattern per line for the filenames you need. Note that this will override the default, so that no other files will be included.
+
+* To keep any files from being included, create "reject.files" inside the app directory containing a glob pattern per line for the filenames you want to reject.

data/bin/warck

@@ -0,0 +1,3 @@
+#!/usr/bin/env jruby
+require 'jruby-warck'
+JrubyWarck::Application.new.run

data/lib/jruby-warck/constants.rb

@@ -0,0 +1,62 @@
+require 'rake'
+require 'jruby-rack'
+
+module JrubyWarck
+  module Constants
+    HOME = File.expand_path(File.dirname(__FILE__) + '/../..') unless defined?(HOME)
+
+    WEB_XML = <<-XML
+<!DOCTYPE web-app PUBLIC
+  "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
+  "http://java.sun.com/dtd/web-app_2_3.dtd">
+<web-app>
+  <filter>
+    <filter-name>RackFilter</filter-name>
+    <filter-class>org.jruby.rack.RackFilter</filter-class>
+  </filter>
+  <filter-mapping>
+    <filter-name>RackFilter</filter-name>
+    <url-pattern>/*</url-pattern>
+  </filter-mapping>
+
+  <listener>
+    <listener-class><%= context_listener %></listener-class>
+  </listener>
+</web-app>
+    XML
+
+    CONTEXT_LISTENERS = {
+      :rack  => "org.jruby.rack.RackServletContextListener",
+      :rails => "org.jruby.rack.rails.RailsServletContextListener"
+    }
+
+    MANIFEST_MF = <<-MANIFEST
+Manifest-Version: 1.0
+Created-By: jruby-warck
+Main-Class: org.jruby.JarBootstrapMain
+Class-Path: /opt/jruby/lib/jruby-complete/jruby-complete.jar #{::JRubyJars.jruby_rack_jar_path}
+    MANIFEST
+
+    INIT = <<-_INIT
+# rack.version: #{JRuby::Rack::VERSION}
+    _INIT
+
+    RUNNING_FROM = Dir.pwd
+
+    BUILD_DIR = "/tmp/war-#{Time.now.to_i}"
+    WEB_INF   = BUILD_DIR + "/WEB-INF"
+    META_INF  = BUILD_DIR + "/META-INF"
+
+    RACKUP_FILE = "config.ru"
+
+    BOOTSTRAP_ERB = File.read(File.exist?(custom_bootstrap = RUNNING_FROM + "/jar-bootstrap.rb.erb") ? custom
+                                                                                                     : (HOME + "/lib/templates/jar-bootstrap.rb.erb"))
+
+    # additional filename patterns to be included inside the archive
+    # default is all yml files
+    SELECT_FILES = FileList[IO.readlines(Dir.pwd + "/select.files").map(&:chomp).reject { |line| line[0] == "#" }] rescue FileList["**/*.yml", "**/*.erb"]
+    # filename patterns to be rejected from the archive
+    # default is none
+    REJECT_FILES = FileList[IO.readlines(Dir.pwd + "/reject.files").map(&:chomp).reject { |line| line[0] == "#" }] rescue FileList[]
+  end
+end

data/lib/jruby-warck/manipulations.rb

@@ -0,0 +1,140 @@
+require 'rake'
+require 'erb'
+require 'jruby-warck/constants'
+
+module JrubyWarck::Manipulations
+  include JrubyWarck::Constants
+
+  def create_archive_dirs
+    puts "++ Creating archive directories"    
+    mkdir_p "#{BUILD_DIR}/assets" if Rake::Task.task_defined?("assets:precompile")
+    mkdir_p WEB_INF
+    mkdir_p META_INF
+  end
+
+  def add_manifest_file
+    puts "++ Adding MANIFEST to #{META_INF}"
+    manifest = File.new(META_INF + "/MANIFEST.MF", "w")
+    manifest.puts(MANIFEST_MF)
+    manifest.close
+  end
+
+  def generate_deployment_descriptor(path, framework = :rack)
+    puts "++ Generating web.xml"
+    context_listener = CONTEXT_LISTENERS[framework.to_sym]
+
+    web_xml = File.new(path, "w")
+    web_xml.puts(ERB.new(WEB_XML).result(binding))
+    web_xml.close
+  end
+
+  def add_deployment_descriptor(framework = :rack)
+    web_xml_path = "web.xml"
+
+    # if there is no web.xml file, generate it
+    generate_deployment_descriptor(web_xml_path, framework) if !File.exist?(web_xml_path)
+    
+    puts "++ Adding web.xml to #{WEB_INF}"
+    cp web_xml_path, "#{WEB_INF}"
+  end
+
+  def add_init_file
+    puts "++ Generating init.rb"
+    
+    init = File.new(META_INF + "/init.rb", "w")
+    init.puts(INIT)
+    init.close
+  end
+
+  def add_rackup_file
+    puts "++ Copying #{RACKUP_FILE} to #{WEB_INF}"
+    cp RACKUP_FILE, WEB_INF
+  end
+
+  def add_ruby_files
+    @ruby_files  = FileList["**/*.rb"]
+    puts "++ Copying #{@ruby_files.size} Ruby sources to #{WEB_INF}"
+  
+    @ruby_files.each do |file|
+      mkdir_p file.pathmap(WEB_INF + "/%d") unless File.exists? file.pathmap(WEB_INF + "/%d")
+      cp file, (WEB_INF + "/" + file)
+    end
+  end
+
+  def add_class_files
+    puts "++ Moving .class files to #{WEB_INF}"
+    puts "++ Generating .rb stubs in #{WEB_INF}"
+
+    @class_files.each do |file|
+      mkdir_p file.pathmap(WEB_INF + "/%d") unless File.exists? file.pathmap(WEB_INF + "/%d")
+      mv file, (WEB_INF + "/" + file)
+
+      stub = File.open((WEB_INF + "/" + file).sub(/\.class$/, ".rb"), "w")
+      stub.puts("load __FILE__.sub(/\.rb$/, '.class')")
+      stub.close  
+    end
+  end
+
+  def add_public_files
+    puts "++ Copying public files to #{BUILD_DIR}"
+    
+    (FileList["public/**/*"] - FileList[REJECT_FILES]).each do |file|
+      if File.directory?(file)
+        puts "  ++ Creating #{file.pathmap("%{public,#{BUILD_DIR}}d/%f")
+}"
+        mkdir_p file.pathmap("%{public,#{BUILD_DIR}}d/%f")
+      else
+        puts "  ++ Copying #{file.pathmap("%{public,#{BUILD_DIR}}d/%f")
+}"
+        cp file, file.pathmap("%{public,#{BUILD_DIR}}d/%f")
+      end
+    end
+  end
+
+  def add_additional_files
+    puts "++ Copying additional files to #{WEB_INF}"
+    FileList[SELECT_FILES].each do |file|
+      mkdir_p file.pathmap("#{WEB_INF}/%d") unless File.exists?(file.pathmap("#{WEB_INF}/%d"))
+      cp file, file.pathmap("#{WEB_INF}/%d/%f")
+    end
+  end 
+
+  def add_bootstrap_script(archive_name)
+    puts "++ Creating bootstrapping script"
+    bootstrap = File.new("#{BUILD_DIR}/jar-bootstrap.rb", "w")
+    # archive_name gets passed in the binding
+    bootstrap.puts(ERB.new(BOOTSTRAP_ERB).result(binding))
+    bootstrap.close
+  end
+
+  def archive_war(archive_name)
+    puts "++ Creating war file #{archive_name}.war"
+
+    if File.exist? "#{archive_name}.war"
+      $stderr.puts "!! #{archive_name}.war already exists, aborting"
+      exit 1
+    end
+
+    Zip::ZipFile.open("#{RUNNING_FROM}/#{archive_name}.war", Zip::ZipFile::CREATE) do |zip|
+      Dir.chdir(BUILD_DIR)
+      Dir["**/"].each { |d| zip.mkdir(d, 0744) }
+      FileList["**/*"].exclude { |f| File.directory?(f) }.each { |f| puts "  ++ Adding #{f}"; zip.add(f, f) }
+
+      zip.close
+    end
+  end
+
+  def compile_ruby_scripts
+    @ruby_files  = FileList["**/*.rb"]
+    
+    `jrubyc #{@ruby_files.join(" ")}`
+    
+    @class_files = FileList["**/*.class"] - FileList["tmp/**/*"]
+
+    unless @ruby_files.size.eql?(@class_files.size)
+      puts "** Warning: it seems that some ruby files were not compiled" 
+      puts ".rb files: #{@ruby_files.size}"
+      puts ".class files: #{@class_files.size}"
+    end
+  end
+end

data/lib/jruby-warck/tasks/jruby.rake

@@ -0,0 +1,45 @@
+require 'jruby-warck/manipulations'
+require 'jruby-warck/constants'
+
+include JrubyWarck::Manipulations
+include JrubyWarck::Constants
+
+desc "Create a .war package out of this application"
+task :package, [:archive_name, :framework] do |t, args|
+  args.with_defaults(:archive_name => File.basename(RUNNING_FROM), :framework => :rack)
+
+  create_archive_dirs
+  add_manifest_file
+  add_deployment_descriptor(args[:framework])
+  add_rackup_file if File.exists?(RACKUP_FILE)
+  add_init_file
+  add_ruby_files
+  add_public_files
+  add_additional_files
+  add_bootstrap_script(args[:archive_name])
+  archive_war(args[:archive_name])
+end
+
+desc "Create a .war package out of this application, compiling Ruby sources to .class files"
+task :package_compiled, [:archive_name, :framework] do |t, args|
+  args.with_defaults(:archive_name => File.basename(RUNNING_FROM), :framework => :rack)
+
+  create_archive_dirs
+  add_manifest_file
+  add_deployment_descriptor(args[:framework])
+  add_rackup_file if File.exists?(RACKUP_FILE)
+  add_init_file
+  compile_ruby_scripts
+  add_class_files
+  add_public_files
+  add_additional_files
+  add_bootstrap_script(args[:archive_name])
+  archive_war(args[:archive_name])
+end
+
+desc "Generate a deployment descriptor (web.xml) to be customized for this application"
+task :webxml, :framework do |t, args|
+  args.with_defaults(:framework => :rack)
+
+  generate_deployment_descriptor("web.xml", args[:framework]) 
+end

data/lib/jruby-warck/version.rb

@@ -0,0 +1,13 @@
+module JrubyWarck
+  module VERSION
+    MAJOR = 1 
+    MINOR = 0
+    PATCH = 1
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+
+    def self.version
+      STRING
+    end
+  end
+end

data/lib/jruby-warck.rb

@@ -0,0 +1,40 @@
+require 'rake'
+require 'jruby-warck/version'
+require 'jruby-warck/constants'
+require 'jruby-warck/manipulations'
+
+require 'zip/zip'
+require 'erb'
+
+class JrubyWarck::Application < Rake::Application
+  include JrubyWarck::Constants
+  include JrubyWarck::Manipulations
+  include Rake::DSL
+
+  def name
+    'warck'
+  end
+
+  def initialize
+    super 
+  end 
+
+  def load_rakefile
+    Rake::TaskManager.record_task_metadata = true
+    task :default do
+      options.show_tasks        = :tasks
+      options.show_task_pattern = //
+      puts "#{name} #{JrubyWarck::VERSION.version} -- package your Rack application in a .war file that can be run from the command line or in a servlet container!"
+      puts "Available commands:"
+      display_tasks_and_comments
+    end
+    
+    load 'jruby-warck/tasks/jruby.rake'
+  end 
+
+  def run
+    Rake.application = self
+    super
+  end
+end
+

data/lib/templates/jar-bootstrap.rb.erb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'zip/zip'
+
+unless File.exist?("<%= archive_name %>.war.extracted")
+  puts "First run... extracting war contents to <%= archive_name %>.war.extracted..."
+  %x{unzip <%= archive_name %>.war -d<%= archive_name %>.war.extracted}
+  puts "Done."
+end
+
+puts "Loading Puma..."
+
+Dir.chdir("<%= archive_name %>.war.extracted/WEB-INF")
+
+NOT_IN_SERVLET_CONTAINER = true
+
+gem 'puma'
+load Gem.bin_path('puma', 'puma')

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: jruby-warck
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Nuno Correia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jruby-jars
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jruby-rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Kinda like warbler, except WAR-only and contained in a single Rakefile.
+email:
+- nuno-g-correia@ext.ptinovacao.pt
+executables:
+- warck
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/warck
+- lib/templates/jar-bootstrap.rb.erb
+- lib/jruby-warck/tasks/jruby.rake
+- lib/jruby-warck/manipulations.rb
+- lib/jruby-warck/constants.rb
+- lib/jruby-warck/version.rb
+- lib/jruby-warck.rb
+- README.md
+homepage: http://github.com/ptinovacao/rubygem-jruby-warck
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Kinda like warbler, except our way
+test_files: []