warbler 1.3.8 → 1.4.0.beta1

data/lib/warbler.rb

@@ -10,7 +10,7 @@
 module Warbler
   WARBLER_HOME = File.expand_path(File.dirname(__FILE__) + '/..') unless defined?(WARBLER_HOME)
   WARBLER_JAR = "#{WARBLER_HOME}/lib/warbler_jar.jar" unless defined?(WARBLER_JAR)
-  
+
   class << self
     # An instance of Warbler::Application used by the +warble+ command.
     attr_accessor :application
@@ -30,6 +30,7 @@ module Warbler
 end
 
 require 'warbler/version'
+require 'warbler/executable_helper'
 require 'warbler/rake_helper'
 require 'warbler/pathmap_helper'
 require 'warbler/task'

data/lib/warbler/application.rb

@@ -58,7 +58,11 @@ class Warbler::Application < Rake::Application
     Rake.application = app
     Rake::Application::DEFAULT_RAKEFILES.each do |rf|
       if File.exist?(rf)
-        load rf
+        begin
+          load rf
+        rescue LoadError => e
+          load File.join(Dir.getwd, rf)
+        end
         break
       end
     end

data/lib/warbler/config.rb

@@ -78,6 +78,12 @@ module Warbler
     # entries in this structure).
     attr_accessor :pathmaps
 
+    # Executable of the jar
+    attr_accessor :executable
+
+    # parameters to pass to the executable
+    attr_accessor :executable_params
+
     # Name of jar or war file (without the extension), defaults to the
     # directory name containing the application.
     attr_accessor :jar_name
@@ -118,7 +124,7 @@ module Warbler
     # Override GEM_HOME environment variable at runtime. When false, gems in
     # GEM_HOME will be loaded in preference to those packaged within the jar
     # file. When true, only gems packaged in the jar file will be loaded.
-    # Defaults to false
+    # Defaults to true
     attr_accessor :override_gem_home
 
     # Extra configuration for web.xml. Controls how the dynamically-generated web.xml
@@ -155,7 +161,12 @@ module Warbler
     # * <tt>jetty</tt> - Embedded Jetty from Eclipse
     attr_accessor :webserver
 
+    # These file will be placed in the META-INF directory of the jar or war that warbler
+    # produces. They are primarily used as launchers by the runnable feature.
+    attr_accessor :script_files
+
     attr_reader :warbler_templates
+    attr_reader :warbler_scripts
 
     def initialize(warbler_home = WARBLER_HOME)
       super()
@@ -178,7 +189,9 @@ module Warbler
       @webinf_files      = FileList[]
       @init_filename     = 'META-INF/init.rb'
       @init_contents     = ["#{@warbler_templates}/config.erb"]
-      @override_gem_home = false
+      @override_gem_home = true
+      @script_files      = []
+      @warbler_scripts = "#{WARBLER_HOME}/lib/warbler/scripts"
 
       before_configure
       yield self if block_given?

data/lib/warbler/executable_helper.rb

@@ -0,0 +1,25 @@
+#--
+# Copyright (c) 2013 Michal Papis.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+module Warbler
+  module ExecutableHelper
+    def update_archive_add_executable(jar)
+      case executable
+      when Array
+        gem_name, executable_path = executable
+        gem_with_version = config.gems.full_name_for(gem_name, config.gem_dependencies)
+        bin_path = apply_pathmaps(config, File.join(gem_with_version, executable_path), :gems)
+      else
+        bin_path = apply_pathmaps(config, executable, :application)
+      end
+      add_main_rb(jar, bin_path, config.executable_params)
+    end
+
+    def executable
+      config.executable ||= default_executable
+    end
+  end
+end

data/lib/warbler/gems.rb

@@ -21,17 +21,56 @@ module Warbler
     end
 
     def <<(gem)
+      @specs = nil
       self[gem] ||= ANY_VERSION
     end
 
     def +(other)
+      @specs = nil
       other.each {|g| self[g] ||= ANY_VERSION }
       self
     end
 
     def -(other)
+      @specs = nil
       other.each {|g| self.delete(g)}
       self
     end
+
+    def full_name_for(name, gem_dependencies)
+      spec = specs(gem_dependencies).detect{ |spec| spec.name == name }
+      spec.nil? ? name : spec.full_name
+    end
+
+    def specs(gem_dependencies)
+      @specs ||= map{|gem, version| find_single_gem_files(gem_dependencies, gem, version) }.flatten.compact
+    end
+
+  private
+
+    # Add a single gem to WEB-INF/gems
+    def find_single_gem_files(gem_dependencies, gem_pattern, version = nil)
+      case gem_pattern
+      when Gem::Specification
+        return gem_pattern
+      when Gem::Dependency
+        gem = gem_pattern
+      else
+        gem = Gem::Dependency.new(gem_pattern, Gem::Requirement.create(version))
+      end
+      # skip development dependencies
+      return nil if gem.respond_to?(:type) and gem.type != :runtime
+
+      # Deal with deprecated Gem.source_index and #search
+      matched = gem.respond_to?(:to_spec) ? [gem.to_spec] : Gem.source_index.search(gem)
+      fail "gem '#{gem}' not installed" if matched.empty?
+      spec = matched.last
+      if gem_dependencies
+        [spec] + spec.dependencies.map{|gem| find_single_gem_files(gem_dependencies, gem) }
+      else
+        spec
+      end
+    end
+
   end
 end

data/lib/warbler/jar.rb

@@ -72,6 +72,7 @@ module Warbler
       find_gems_files(config)
       add_manifest(config)
       add_init_file(config)
+      add_script_files(config)
       apply_traits(config)
     end
 
@@ -120,30 +121,11 @@ module Warbler
 
     # Add gems to WEB-INF/gems
     def find_gems_files(config)
-      config.gems.each {|gem, version| find_single_gem_files(config, gem, version) }
+      config.gems.specs(config.gem_dependencies).each {|spec| find_single_gem_files(config, spec) }
     end
 
     # Add a single gem to WEB-INF/gems
-    def find_single_gem_files(config, gem_pattern, version = nil)
-      if Gem::Specification === gem_pattern
-        spec = gem_pattern
-      else
-        gem = case gem_pattern
-              when Gem::Dependency
-                gem_pattern
-              else
-                Gem::Dependency.new(gem_pattern, Gem::Requirement.create(version))
-              end
-
-        # skip development dependencies
-        return if gem.respond_to?(:type) and gem.type != :runtime
-
-        # Deal with deprecated Gem.source_index and #search
-        matched = gem.respond_to?(:to_spec) ? [gem.to_spec] : Gem.source_index.search(gem)
-        fail "gem '#{gem}' not installed" if matched.empty?
-        spec = matched.last
-      end
-
+    def find_single_gem_files(config, spec)
       full_gem_path = Pathname.new(spec.full_gem_path)
 
       # skip gems whose full_gem_path does not exist
@@ -155,8 +137,6 @@ module Warbler
         next if config.gem_excludes && config.gem_excludes.any? {|rx| f =~ rx }
         @files[apply_pathmaps(config, File.join(spec.full_name, f), :gems)] = src
       end
-
-      spec.dependencies.each {|dep| find_single_gem_files(config, dep) } if config.gem_dependencies
     end
 
     # Add all application directories and files to the archive.
@@ -191,6 +171,12 @@ module Warbler
       end
     end
 
+    def add_script_files(config)
+      config.script_files.each do |file|
+        @files["META-INF/#{File.basename(file)}"] = StringIO.new(File.read(file))
+      end
+    end
+
     def add_with_pathmaps(config, f, map_type)
       @files[apply_pathmaps(config, f, map_type)] = f
     end
@@ -224,8 +210,8 @@ module Warbler
             zipfile.get_output_stream(entry) {|f| f << src.read }
           elsif src.nil? || File.directory?(src)
             if File.symlink?(entry) && ! defined?(JRUBY_VERSION)
-              $stderr.puts "directory symlinks are not followed unless using JRuby; " + 
-                           "#{entry.inspect} contents not in archive" 
+              $stderr.puts "directory symlinks are not followed unless using JRuby; " +
+                           "#{entry.inspect} contents not in archive"
             end
             zipfile.mkdir(entry.dup) # in case it's frozen rubyzip 0.9.6.1 workaround
           elsif File.symlink?(src)

data/lib/warbler/scripts/rails.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+if RUBY_VERSION =~ /^1.8/
+  APP_PATH = File.expand_path('../../config/application',  __FILE__)
+  require File.expand_path('../../config/boot',  __FILE__)
+  require 'rails/commands' 
+else
+  APP_PATH = File.expand_path('../../config/application',  __FILE__)
+  require_relative '../config/boot'
+  require 'rails/commands'
+end

data/lib/warbler/templates/war.erb

@@ -1,4 +1,12 @@
-ENV['GEM_HOME'] ||= $servlet_context.getRealPath('<%= config.gem_path %>')
+<% assignment_operator = config.override_gem_home ? "=" : "||=" %>
+if $servlet_context.nil?
+  ENV['GEM_HOME'] <%= assignment_operator %> File.expand_path('../../WEB-INF', __FILE__)
 <% if config.bundler && config.bundler[:gemfile_path] %>
-ENV['BUNDLE_GEMFILE'] ||= $servlet_context.getRealPath('/<%= config.bundler[:gemfile_path] %>')
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('../../<%= config.bundler[:gemfile_path] %>', __FILE__)
 <% end %>
+else
+  ENV['GEM_HOME'] <%= assignment_operator %> $servlet_context.getRealPath('<%= config.gem_path %>')
+<% if config.bundler && config.bundler[:gemfile_path] %>
+  ENV['BUNDLE_GEMFILE'] ||= $servlet_context.getRealPath('/<%= config.bundler[:gemfile_path] %>')
+<% end %>
+end

data/lib/warbler/traits.rb

@@ -80,8 +80,11 @@ module Warbler
       config.init_contents << StringIO.new("$LOAD_PATH.unshift __FILE__.sub(/!.*/, '!/#{path}')\n")
     end
 
-    def add_main_rb(jar, bin_path)
-      jar.files['META-INF/main.rb'] = StringIO.new("load '#{bin_path}'")
+    def add_main_rb(jar, bin_path, params = nil)
+      binary = ""
+      binary << "ARGV.unshift('#{params}')\n" if params
+      binary << "load '#{bin_path}'"
+      jar.files['META-INF/main.rb'] = StringIO.new(binary)
     end
 
     def update_gem_path(default_gem_path)

data/lib/warbler/traits/gemspec.rb

@@ -12,6 +12,7 @@ module Warbler
     class Gemspec
       include Trait
       include PathmapHelper
+      include ExecutableHelper
 
       def self.detect?
         !Dir['*.gemspec'].empty?
@@ -33,16 +34,23 @@ module Warbler
       end
 
       def update_archive(jar)
-        (Dir['**/*'] - config.compiled_ruby_files).each do |f|
-          jar.files[apply_pathmaps(config, f, :application)] = f
+        @spec.files.each do |f|
+          unless File.exist?(f)
+            warn "update your gemspec; skipping missing file #{f}"
+            next
+          end
+          file_key = jar.apply_pathmaps(config, f, :application)
+          next if jar.files[file_key]
+          jar.files[file_key] = f
         end
+
         config.compiled_ruby_files.each do |f|
           f = f.sub(/\.rb$/, '.class')
           next unless File.exist?(f)
           jar.files[apply_pathmaps(config, f, :application)] = f
         end
-        bin_path = apply_pathmaps(config, default_executable, :application)
-        add_main_rb(jar, bin_path)
+
+        update_archive_add_executable(jar)
       end
 
       def default_executable
@@ -55,6 +63,7 @@ module Warbler
           exe
         end
       end
+
     end
   end
 end

data/lib/warbler/traits/nogemspec.rb

@@ -13,6 +13,7 @@ module Warbler
     class NoGemspec
       include Trait
       include PathmapHelper
+      include ExecutableHelper
 
       def self.detect?
         Jar.detect? && !Gemspec.detect?
@@ -29,7 +30,7 @@ module Warbler
       end
 
       def update_archive(jar)
-        add_main_rb(jar, apply_pathmaps(config, default_executable, :application))
+        update_archive_add_executable(jar)
       end
 
       def default_executable

data/lib/warbler/traits/rails.rb

@@ -39,24 +39,42 @@ module Warbler
             config.gems << Gem::Dependency.new(g.name, g.requirement) if Dir["vendor/gems/#{g.name}*"].empty?
           end
         end
+        config.script_files << "#{config.warbler_scripts}/rails.rb"
       end
 
       def after_configure
         config.init_contents << "#{config.warbler_templates}/rails.erb"
+
+        if threadsafe_enabled? or rails_4?
+          config.webxml.jruby.min.runtimes = 1 unless Integer === config.webxml.jruby.min.runtimes
+          config.webxml.jruby.max.runtimes = 1 unless Integer === config.webxml.jruby.max.runtimes
+        end
+      end
+
+
+      def default_app_name
+        File.basename(File.expand_path(defined?(::Rails.root) ? ::Rails.root : (defined?(RAILS_ROOT) ? RAILS_ROOT : Dir.getwd)))
+      end
+
+      def threadsafe_enabled?
+        rails_env = config.webxml.rails.env
         begin
-          rails_env = config.webxml.rails.env
           unless IO.readlines("config/environments/#{rails_env}.rb").grep(/^\s*config\.threadsafe!/).empty? &&
-                 IO.readlines("config/environment.rb").grep(/^\s*config\.threadsafe!/).empty?
-            config.webxml.jruby.min.runtimes = 1 unless Integer === config.webxml.jruby.min.runtimes
-            config.webxml.jruby.max.runtimes = 1 unless Integer === config.webxml.jruby.max.runtimes
+              IO.readlines("config/environment.rb").grep(/^\s*config\.threadsafe!/).empty?
+            return true
           end
         rescue
         end
       end
 
-
-      def default_app_name
-        File.basename(File.expand_path(defined?(::Rails.root) ? ::Rails.root : (defined?(RAILS_ROOT) ? RAILS_ROOT : Dir.getwd)))
+      def rails_4?
+        begin
+          unless IO.readlines("Gemfile").grep(/^\s*gem\s('|")rails('|"),\s('|")4\.\d+\.\d+/).empty? &&
+              IO.readlines("Gemfile.lock").grep(/^\s*rails\s\([=~><]*\s*4\.(\d+)\.(\d+).*\)$/).empty?
+            return true
+          end
+        rescue
+        end
       end
     end
   end

data/lib/warbler/version.rb

@@ -6,5 +6,5 @@
 #++
 
 module Warbler
-  VERSION = "1.3.8"
+  VERSION = "1.4.0.beta1"
 end

data/spec/sample_jar/bin/another_jar

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'sample_jar'
+
+SampleJar.hello

data/spec/spec_helper.rb

@@ -132,8 +132,8 @@ module ExampleGroupHelpers
   def use_test_webserver
     before :each do
       webserver = double('server').as_null_object
-      webserver.stub!(:main_class).and_return 'WarMain.class'
-      webserver.stub!(:add).and_return do |jar|
+      webserver.stub(:main_class).and_return 'WarMain.class'
+      webserver.stub(:add).and_return do |jar|
         jar.files['WEB-INF/webserver.jar'] = StringIO.new
       end
       Warbler::WEB_SERVERS['test'] = webserver

data/spec/warbler/bundler_spec.rb

@@ -20,15 +20,6 @@ describe Warbler::Jar, "with Bundler" do
     @extra_config = block
   end
 
-  def hide_shallow_git_clone
-    git_shallow_marker = File.join(Warbler::WARBLER_HOME, ".git/shallow")
-    tmp_marker = File.join(Warbler::WARBLER_HOME, ".git/shallow.tmp")
-    File.rename(git_shallow_marker, tmp_marker) if File.exists?(git_shallow_marker)
-    yield
-  ensure
-    File.rename(tmp_marker, git_shallow_marker) if File.exist?(tmp_marker)
-  end
-
   let(:config) { drbclient.config(@extra_config) }
   let(:jar) { drbclient.jar }
 
@@ -70,23 +61,19 @@ describe Warbler::Jar, "with Bundler" do
     end
 
     it "works with :git entries in Gemfiles" do
-      hide_shallow_git_clone do
-        File.open("Gemfile", "w") {|f| f << "gem 'warbler', :git => '#{Warbler::WARBLER_HOME}'\n"}
-        `#{RUBY_EXE} -S bundle install --local`
-        jar.apply(config)
-        file_list(%r{WEB-INF/gems/bundler/gems/warbler[^/]*/lib/warbler/version\.rb}).should_not be_empty
-        file_list(%r{WEB-INF/gems/bundler/gems/warbler[^/]*/warbler.gemspec}).should_not be_empty
-      end
+      File.open("Gemfile", "w") {|f| f << "gem 'warbler', :git => '#{Warbler::WARBLER_HOME}'\n"}
+      `#{RUBY_EXE} -S bundle install --local`
+      jar.apply(config)
+      file_list(%r{WEB-INF/gems/bundler/gems/warbler[^/]*/lib/warbler/version\.rb}).should_not be_empty
+      file_list(%r{WEB-INF/gems/bundler/gems/warbler[^/]*/warbler.gemspec}).should_not be_empty
     end
 
     it "bundles only the gemspec for :git entries that are excluded" do
-      hide_shallow_git_clone do
-        File.open("Gemfile", "w") {|f| f << "gem 'rake'\ngroup :test do\ngem 'warbler', :git => '#{Warbler::WARBLER_HOME}'\nend\n"}
-        `#{RUBY_EXE} -S bundle install --local`
-        jar.apply(config)
-        file_list(%r{WEB-INF/gems/bundler/gems/warbler[^/]*/lib/warbler/version\.rb}).should be_empty
-        file_list(%r{WEB-INF/gems/bundler/gems/warbler[^/]*/warbler.gemspec}).should_not be_empty
-      end
+      File.open("Gemfile", "w") {|f| f << "gem 'rake'\ngroup :test do\ngem 'warbler', :git => '#{Warbler::WARBLER_HOME}'\nend\n"}
+      `#{RUBY_EXE} -S bundle install --local`
+      jar.apply(config)
+      file_list(%r{WEB-INF/gems/bundler/gems/warbler[^/]*/lib/warbler/version\.rb}).should be_empty
+      file_list(%r{WEB-INF/gems/bundler/gems/warbler[^/]*/warbler.gemspec}).should_not be_empty
     end
 
     it "does not work with :path entries in Gemfiles" do
@@ -130,16 +117,14 @@ describe Warbler::Jar, "with Bundler" do
     cleanup_temp_files
 
     it "works with :git entries in Gemfiles" do
-      hide_shallow_git_clone do
-        File.open("Gemfile", "w") {|f| f << "gem 'warbler', :git => '#{Warbler::WARBLER_HOME}'\n"}
-        `#{RUBY_EXE} -S bundle install --local`
-        jar.apply(config)
-        file_list(%r{^bundler/gems/warbler[^/]*/lib/warbler/version\.rb}).should_not be_empty
-        file_list(%r{^bundler/gems/warbler[^/]*/warbler.gemspec}).should_not be_empty
-        jar.add_init_file(config)
-        contents = jar.contents('META-INF/init.rb')
-        contents.should =~ /ENV\['BUNDLE_GEMFILE'\] = File.expand_path(.*, __FILE__)/
-      end
+      File.open("Gemfile", "w") {|f| f << "gem 'warbler', :git => '#{Warbler::WARBLER_HOME}'\n"}
+      `#{RUBY_EXE} -S bundle install --local`
+      jar.apply(config)
+      file_list(%r{^bundler/gems/warbler[^/]*/lib/warbler/version\.rb}).should_not be_empty
+      file_list(%r{^bundler/gems/warbler[^/]*/warbler.gemspec}).should_not be_empty
+      jar.add_init_file(config)
+      contents = jar.contents('META-INF/init.rb')
+      contents.should =~ /ENV\['BUNDLE_GEMFILE'\] = File.expand_path(.*, __FILE__)/
     end
 
     it "adds BUNDLE_GEMFILE to init.rb" do