warbler 2.1.0 → 2.1.1

data/lib/warbler/config.rb

@@ -15,8 +15,8 @@ module Warbler
     include RakeHelper
 
     TOP_DIRS = %w(app db config lib log script vendor)
-    FILE = "config/warble.rb"
-    BUILD_GEMS = %w(warbler rake rcov)
+    CONFIG_DIR = "config"
+    FILE = "#{CONFIG_DIR}/warble.rb"
 
     include Traits
 
@@ -29,11 +29,8 @@ module Warbler
 
     # Traits: an array of trait classes corresponding to
     # characteristics of the project that are either auto-detected or
-    # configured.
-    attr_accessor :traits
-
-    # Deprecated: No longer has any effect.
-    attr_accessor :staging_dir
+    # forced enabled during `Config.new(forced_traits: [...]) do |config|`
+    attr_reader :traits
 
     # Directory where the war file will be written. Can be used to direct
     # Warbler to place your war file directly in your application server's
@@ -185,8 +182,9 @@ module Warbler
     attr_reader :warbler_templates
     attr_reader :warbler_scripts
 
-    def initialize(warbler_home = WARBLER_HOME)
-      super()
+    # @param forced_traits [Array<Class>, nil] optional array of Warbler::Trait types to force rather than auto-detecting them
+    def initialize(warbler_home = WARBLER_HOME, forced_traits: nil)
+      super(forced_traits)
 
       @warbler_home      = warbler_home
       @warbler_templates = "#{WARBLER_HOME}/lib/warbler/templates"

data/lib/warbler/gems.rb

@@ -51,9 +51,8 @@ module Warbler
 
     # Add a single gem to WEB-INF/gems
     def find_single_gem_files(gem_dependencies, gem_pattern, version = nil)
-      gem_spec_class = Gem::Specification
       case gem_pattern
-      when gem_spec_class
+      when Gem::Specification
         return BundlerHelper.to_spec(gem_pattern)
       when Gem::Dependency
         gem = gem_pattern
@@ -61,12 +60,9 @@ module Warbler
         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
+      return nil if 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
+      spec = gem.to_spec
       return spec unless gem_dependencies
       [spec] + spec.dependencies.map { |dependent_gem| find_single_gem_files(gem_dependencies, dependent_gem) }
     end

data/lib/warbler/jar.rb

@@ -70,8 +70,6 @@ module Warbler
       end
       @compiled = true
     end
-    # @deprecated only due compatibility
-    alias_method :run_javac, :run_jrubyc
 
     def sh_jrubyc(cmd)
       sh(cmd) do |ok, res|
@@ -178,6 +176,7 @@ module Warbler
 
     # Invoke a hook to allow the project traits to add or modify the archive contents.
     def apply_traits(config)
+      puts "Applying traits #{config.traits}" unless silent?
       config.update_archive(self)
     end
 
@@ -335,14 +334,6 @@ module Warbler
 
     # Java-boosted jar creation for JRuby; replaces #create_jar and
     # #entry_in_jar with Java version
-    require 'warbler_jar' if defined?(JRUBY_VERSION) && JRUBY_VERSION >= "1.5"
-  end
-
-  # Warbler::War is Deprecated. Please use Warbler::Jar.
-  class War < Jar
-    def initialize(*)
-      super
-      warn "Warbler::War is deprecated. Please replace all occurrences with Warbler::Jar."
-    end
+    require 'warbler_jar' if defined?(JRUBY_VERSION)
   end
 end

data/lib/warbler/task.rb

@@ -151,12 +151,15 @@ module Warbler
         if File.exist?(Warbler::Config::FILE) && ENV["FORCE"].nil?
           puts "There's another bird sitting on my favorite branch"
           puts "(file '#{Warbler::Config::FILE}' already exists. Pass argument FORCE=1 to override)"
-        elsif !File.directory?("config")
-          puts "I'm confused; my favorite branch is missing"
-          puts "(directory 'config' is missing)"
-        else
-          cp "#{Warbler::WARBLER_HOME}/warble.rb", Warbler::Config::FILE
+          next
+        end
+
+        if !File.directory?(Warbler::Config::CONFIG_DIR)
+          puts "config dir is missing, creating it"
+          mkdir_p Warbler::Config::CONFIG_DIR
         end
+
+        cp "#{Warbler::WARBLER_HOME}/warble.rb", Warbler::Config::FILE
       end
     end
 

data/lib/warbler/traits/gemspec.rb

@@ -18,6 +18,10 @@ module Warbler
         !Dir['*.gemspec'].empty?
       end
 
+      def self.conflicts
+        [ Traits::NoGemspec ]
+      end
+
       def before_configure; require 'yaml'
         @spec_file = Dir['*.gemspec'].first
         @spec = File.open(@spec_file) { |f| Gem::Specification.from_yaml(f) } rescue Gem::Specification.load(@spec_file)

data/lib/warbler/traits/jar.rb

@@ -17,7 +17,11 @@ module Warbler
       include Trait
 
       def self.detect?
-        !War.detect?
+        !detect_any_conflicts?
+      end
+
+      def self.conflicts
+        [ Traits::War ]
       end
 
       def before_configure

data/lib/warbler/traits/jbundler.rb

@@ -23,6 +23,7 @@ module Warbler
 
       def before_configure
         config.jbundler = true
+        warn "JBundler support is deprecated due to the EOL of JBundler. See https://github.com/jruby/warbler/issues/481 for discussion on replacement with jar-dependencies."
       end
 
       def after_configure
@@ -35,7 +36,7 @@ module Warbler
         if File.exist?( classpath )
           require File.expand_path( classpath )
         else
-          raise 'jbundler support needs jruby to create a local config: jruby -S jbundle install'
+          raise 'JBundler support needs JRuby to create a local config: jruby -S jbundle install'
         end
         # use only the jars from jbundler and jruby
         config.java_libs += jruby_jars

data/lib/warbler/traits/nogemspec.rb

@@ -16,7 +16,11 @@ module Warbler
       include ExecutableHelper
 
       def self.detect?
-        Jar.detect? && !Gemspec.detect?
+        Jar.detect? && !detect_any_conflicts?
+      end
+
+      def self.conflicts
+        [ Traits::Gemspec ]
       end
 
       def before_configure

data/lib/warbler/traits/rack.rb

@@ -12,7 +12,11 @@ module Warbler
       include Trait
 
       def self.detect?
-        !Rails.detect? && (File.exist?("config.ru") || !Dir['*/config.ru'].empty?)
+        (File.exist?("config.ru") || !Dir['*/config.ru'].empty?) && !detect_any_conflicts?
+      end
+
+      def self.conflicts
+        [ Traits::Rails ]
       end
 
       def self.requirements

data/lib/warbler/traits/rails.rb

@@ -15,6 +15,10 @@ module Warbler
         File.exist?('config/environment.rb')
       end
 
+      def self.conflicts
+        [ Traits::Rack ]
+      end
+
       def self.requirements
         [ Traits::War ]
       end

data/lib/warbler/traits/war.rb

@@ -21,6 +21,10 @@ module Warbler
         Traits::Rails.detect? || Traits::Rack.detect?
       end
 
+      def self.conflicts
+        [ Traits::Jar ]
+      end
+
       def before_configure
         config.gem_path      = DEFAULT_GEM_PATH
         config.pathmaps      = default_pathmaps

data/lib/warbler/traits.rb

@@ -5,6 +5,7 @@
 # See the file LICENSE.txt for details.
 #++
 
+require 'set'
 require 'stringio'
 require 'tsort'
 
@@ -15,10 +16,13 @@ module Warbler
   # the kind of project and how it should be packed into the jar or
   # war file.
   module Traits
-    attr_accessor :traits
-
-    def initialize
-      @traits = auto_detect_traits
+    # @param forced_traits [Array<Class>, nil] array of Warbler::Trait types to force rather than auto-detecting them
+    def initialize(forced_traits)
+      @traits = if forced_traits.nil? || forced_traits.empty?
+                  auto_detect_traits
+                else
+                  validate_traits(forced_traits)
+                end
     end
 
     def auto_detect_traits
@@ -45,6 +49,18 @@ module Warbler
       @trait_objects = nil
       @traits.collect! {|t| t.name }
     end
+
+    private
+    def validate_traits(requested_traits)
+      conflicts = Set.new
+      requested_traits.each do |trait|
+        trait.conflicts.each do |conflict|
+          conflicts += [trait, conflict] if requested_traits.include?(conflict)
+        end
+      end
+      raise "Some forced traits declare conflicts with each other: #{conflicts.to_a}" unless conflicts.empty?
+      TraitsDependencyArray.new(requested_traits).tsort
+    end
   end
 
   # Each trait class includes this module to receive shared functionality.
@@ -53,6 +69,14 @@ module Warbler
       def requirements
         []
       end
+
+      def conflicts
+        []
+      end
+
+      def detect_any_conflicts?
+        conflicts.any? { |c| c.detect? }
+      end
     end
 
     def self.included(base)
@@ -108,7 +132,7 @@ module Warbler
 
     alias tsort_each_node each
     def tsort_each_child(node, &block)
-      node.requirements.each(&block)
+      node.requirements.select { |r| include?(r) }.each(&block)
     end
   end
 

data/lib/warbler/version.rb

@@ -6,5 +6,5 @@
 #++
 
 module Warbler
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

data/lib/warbler/web_server.rb

@@ -106,7 +106,6 @@ CONFIG
       jar.files["WEB-INF/webserver.properties"] ||= StringIO.new(<<-PROPS)
 mainclass = org.eclipse.jetty.runner.Runner
 args = args0,args1,args2,args3,args4,args5,args6
-props = jetty.home
 args0 = --host
 args1 = {{host}}
 args2 = --port
@@ -114,7 +113,10 @@ args3 = {{port}}
 args4 = --config
 args5 = {{config}}
 args6 = {{warfile}}
+props = jetty.home,org.eclipse.jetty.util.log.class,org.eclipse.jetty.util.log.stderr.ESCAPE
 jetty.home = {{webroot}}
+org.eclipse.jetty.util.log.class = org.eclipse.jetty.util.log.StdErrLog
+org.eclipse.jetty.util.log.stderr.ESCAPE = false
 PROPS
     end
   end

data/warble.rb

@@ -1,8 +1,25 @@
-# Disable Rake-environment-task framework detection by uncommenting/setting to false
+# Warbler is designed to auto-detect "traits" of your application based on the presence of various files.
+# In some cases this is ambiguous, or there is a desire to disable certain traits from being detected
+# and a list of traits can be supplied to override this.
+#
+# This is an advanced option, and must be a complete list of traits. Using this capability disables
+# some of Warbler's validation and conflict detection that causes traits to be automatically enabled and
+# disabled as required.
+# - `Warbler::Traits::Jar`       - package as a normal executable java archive (jar) application
+# - `Warbler::Traits::War`       - package as an executable web archive (war) application
+# - `Warbler::Traits::Bundler`   - package with the gems implied by a bundle Gemfile/Gemfile.lock
+# - `Warbler::Traits::Gemspec`   - package with the gems implied by a gemspec
+# - `Warbler::Traits::NoGemspec` - package only with the gems implied by that in a local `lib` folder
+# - `Warbler::Traits::JBundler`  - (deprecated, experimental) package with the jars implied by a `Jarfile`
+# - `Warbler::Traits::Rails`     - package with the necessary startup logic to boot a Rails application
+# - `Warbler::Traits::Rack`      - package with the necessary startup logic to boot a standalone Rack (non-Rails) application
+# forced_traits = [Warbler::Traits::Jar]
+
+# Disable Rake-environment-task framework detection for Rails applications by uncommenting/setting to false
 # Warbler.framework_detection = false
 
-# Warbler web application assembly configuration file
-Warbler::Config.new do |config|
+# Configure a new Warbler application assembly
+Warbler::Config.new(forced_traits: defined?(forced_traits) ? forced_traits : nil) do |config|
   # Features: additional options controlling how the jar is built.
   # Currently the following features are supported:
   # - *gemjar*: package the gem repository in a jar file in WEB-INF/lib
@@ -101,7 +118,7 @@ Warbler::Config.new do |config|
   # config.compile_gems = false
 
   # When set it specify the bytecode version for compiled class files
-  # config.bytecode_version = "1.6"
+  # config.bytecode_version = "1.8"
 
   # When set to true, Warbler will override the value of ENV['GEM_HOME'] even it
   # has already been set. When set to false it will use any existing value of
@@ -171,7 +188,7 @@ Warbler::Config.new do |config|
   #   is simply embedded in web.xml.
   # The script is evaluated in a Rack::Builder to load the application.
   # Examples:
-  # config.webxml.rackup.path = 'WEB-INF/hello.ru'
+  # config.webxml.rackup.path = '/WEB-INF/hello.ru'
   # config.webxml.rackup = %{require './lib/demo'; run Rack::Adapter::Camping.new(Demo)}
   # config.webxml.rackup = require 'cgi' && CGI::escapeHTML(File.read("config.ru"))
 

data/warbler.gemspec

@@ -32,10 +32,16 @@ bundle up all of your application files for deployment to a Java environment.}
 
   gem.add_runtime_dependency 'rake', ['~> 13.0', '>= 13.0.3']
   gem.add_runtime_dependency 'rexml', '~> 3.0'
-  gem.add_runtime_dependency 'jruby-jars', ['>= 9.4', '< 10.1']
-  gem.add_runtime_dependency 'jruby-rack', ['>= 1.2.3', '< 1.3']
-  gem.add_runtime_dependency 'rubyzip', '>= 3.0.0'
+  gem.add_runtime_dependency 'jruby-jars', ['>= 9.4', '< 10.2']
+  gem.add_runtime_dependency 'jruby-rack', ['>= 1.2.7', '< 1.4']
+  gem.add_runtime_dependency 'rubyzip', ['>= 2.1.0', '< 4']
   gem.add_runtime_dependency 'ostruct', '~> 0.6.2'
-  gem.add_development_dependency 'jbundler', '0.9.5'
+
   gem.add_development_dependency 'rspec', '~> 3.0'
+  gem.add_development_dependency 'drb', ['~> 2.2', '>= 2.2.3']
+  gem.add_development_dependency 'ruby-maven', '~> 3.9'
+  gem.add_development_dependency 'bigdecimal' # Needed workaround for maven-tools > vertus > axiom-types lack of explicit bigdecimal dependency for JRuby 10
+
+  # JBundler is unsupported on JRuby 10.1
+  gem.add_development_dependency 'jbundler', '~> 0.9.5' if RUBY_VERSION.to_f < 4.0
 end

data/web.xml.erb

@@ -5,7 +5,6 @@
   <!--
   <display-name>Uncomment and put name :here: for Tomcat Dashboard</display-name>-->
 
-  <%# NOTE: to be renamed to servlet_context_params %>
   <%- webxml.context_params.each do |name, value| -%>
   <context-param>
     <param-name><%= name %></param-name>
@@ -13,7 +12,6 @@
   </context-param>
   <%- end -%>
 
-  <%- if webxml.respond_to?(:servlet_filter) -%>
   <filter>
     <filter-name><%= webxml.servlet_filter_name %></filter-name>
     <filter-class><%= webxml.servlet_filter %></filter-class>
@@ -23,29 +21,12 @@
     <filter-name><%= webxml.servlet_filter_name %></filter-name>
     <url-pattern><%= webxml.servlet_filter_url_pattern %></url-pattern>
   </filter-mapping>
-  <%- else -%> <%# NOTE: due compatibility when warbler gets downgraded to 2.0.0 %>
-  <filter>
-    <filter-name>RackFilter</filter-name>
-    <filter-class>org.jruby.rack.RackFilter</filter-class>
-    <async-supported>true</async-supported>
-  </filter>
-  <filter-mapping>
-    <filter-name>RackFilter</filter-name>
-    <url-pattern>/*</url-pattern>
-  </filter-mapping>
-  <%- end -%>
 
-  <%- if webxml.respond_to?(:servlet_context_listeners) -%>
   <%- webxml.servlet_context_listeners.each do |listener| -%>
   <listener>
     <listener-class><%= listener %></listener-class>
   </listener>
   <%- end -%>
-  <%- else -%> <%# NOTE: due compatibility when warbler gets downgraded to 2.0.0 %>
-  <listener>
-    <listener-class><%= webxml.servlet_context_listener %></listener-class>
-  </listener>
-  <%- end -%>
 
   <%- [webxml.jndi].flatten.each do |jndi| -%>
   <resource-ref>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: warbler
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Nick Sieger
@@ -52,7 +52,7 @@ dependencies:
         version: '9.4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '10.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -62,41 +62,47 @@ dependencies:
         version: '9.4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: '10.2'
 - !ruby/object:Gem::Dependency
   name: jruby-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: 1.2.7
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.2.3
+        version: 1.2.7
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 2.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 2.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: ostruct
   requirement: !ruby/object:Gem::Requirement
@@ -112,33 +118,81 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.2
 - !ruby/object:Gem::Dependency
-  name: jbundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: drb
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: ruby-maven
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jbundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
 description: |-
   Warbler is a gem to make a Java jar or war file out of any Ruby,
   Rails, or Rack application. Warbler provides a minimal, flexible, Ruby-like way to
@@ -149,8 +203,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - Gemfile
-- History.txt
 - LICENSE.txt
 - Mavenfile
 - README.rdoc
@@ -189,7 +243,6 @@ files:
 - lib/warbler/traits/rails.rb
 - lib/warbler/traits/war.rb
 - lib/warbler/version.rb
-- lib/warbler/war.rb
 - lib/warbler/web_server.rb
 - lib/warbler/zip_support.rb
 - lib/warbler_jar.jar
@@ -219,7 +272,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Warbler chirpily constructs .war files of your Rails applications.
 test_files: []

data/lib/warbler/war.rb

@@ -1,8 +0,0 @@
-#--
-# Copyright (c) 2010-2012 Engine Yard, Inc.
-# Copyright (c) 2007-2009 Sun Microsystems, Inc.
-# This source code is available under the MIT license.
-# See the file LICENSE.txt for details.
-#++
-
-require 'warbler/jar'