warbler 1.2.1 → 1.3.0.beta1

data/lib/warbler/task.rb

@@ -7,8 +7,8 @@
 
 require 'rake'
 require 'rake/tasklib'
-require 'stringio'
-require 'zip/zip'
+require 'warbler/config'
+require 'warbler/jar'
 
 module Warbler
   # Warbler Rake task.  Allows defining multiple configurations inside the same
@@ -18,11 +18,11 @@ module Warbler
   # code like the following in a Rakefile:
   #
   #     Warbler::Task.new("war1", Warbler::Config.new do |config|
-  #       config.war_name = "war1"
+  #       config.jar_name = "war1"
   #       # ...
   #     end
   #     Warbler::Task.new("war2", Warbler::Config.new do |config|
-  #       config.war_name = "war2"
+  #       config.jar_name = "war2"
   #       # ...
   #     end
   #
@@ -35,11 +35,10 @@ module Warbler
     # Warbler::Config
     attr_accessor :config
 
-    # Warbler::War
-    attr_accessor :war
+    # Warbler::Jar
+    attr_accessor :jar
 
-    def initialize(name = :war, config = nil)
-      @name   = name
+    def initialize(name = nil, config = nil)
       @config = config
       if @config.nil? && File.exists?(Config::FILE)
         @config = eval(File.open(Config::FILE) {|f| f.read})
@@ -49,11 +48,15 @@ module Warbler
         warn "Warbler::Config not provided by override in initializer or #{Config::FILE}; using defaults"
         @config = Config.new
       end
-      @war = Warbler::War.new
+      @name = name || @config.jar_extension
+      @jar = Warbler::Jar.new
       yield self if block_given?
       define_tasks
     end
 
+    # Deprecated: attr_accessor :war
+    alias war jar
+
     private
     def define_tasks
       define_main_task
@@ -72,7 +75,7 @@ module Warbler
     end
 
     def define_main_task
-      desc "Create the project .war file"
+      desc "Create the project #{config.jar_extension} file"
       task @name do
         unless @config.features.empty?
           @config.features.each do |feature|
@@ -93,28 +96,31 @@ module Warbler
     end
 
     def define_clean_task
-      desc "Remove the .war file"
+      desc "Remove the project #{config.jar_extension} file"
       task "clean" do
-        rm_f "#{config.war_name}.war"
+        rm_f "#{config.jar_name}.#{config.jar_extension}"
       end
       task "clear" => "#{name}:clean"
     end
 
     def define_compiled_task
       task "compiled" do
-        war.compile(config)
+        jar.compile(config)
+        task @name do
+          rm_f config.compiled_ruby_files.map {|f| f.sub(/\.rb$/, '.class') }
+        end
       end
     end
 
     def define_files_task
       task "files" do
-        war.apply(config)
+        jar.apply(config)
       end
     end
 
     def define_jar_task
       task "jar" do
-        war.create(config)
+        jar.create(config)
       end
     end
 
@@ -122,36 +128,22 @@ module Warbler
       desc "Dump diagnostic information"
       task "debug" => "files" do
         require 'yaml'
-        puts YAML::dump(config)
-        war.files.each {|k,v| puts "#{k} -> #{String === v ? v : '<blob>'}"}
+        puts config.dump
+        jar.files.each {|k,v| puts "#{k} -> #{String === v ? v : '<blob>'}"}
       end
       task "debug:includes" => "files" do
         puts "", "included files:"
-        puts *war.webinf_filelist.include
+        puts *war.app_filelist.include
       end
       task "debug:excludes" => "files" do
         puts "", "excluded files:"
-        puts *war.webinf_filelist.exclude
+        puts *war.app_filelist.exclude
       end
     end
 
     def define_gemjar_task
       task "gemjar" do
-        task "#@name:jar" => "#@name:make_gemjar"
-      end
-
-      gem_jar = Warbler::War.new
-      task "make_gemjar" => "files" do
-        gem_path = Regexp::quote(config.relative_gem_path)
-        gems = war.files.select{|k,v| k =~ %r{#{gem_path}/} }
-        gems.each do |k,v|
-          gem_jar.files[k.sub(%r{#{gem_path}/}, '')] = v
-        end
-        war.files["WEB-INF/lib/gems.jar"] = "tmp/gems.jar"
-        war.files.reject!{|k,v| k =~ /#{gem_path}/ }
-        mkdir_p "tmp"
-        gem_jar.add_manifest
-        gem_jar.create("tmp/gems.jar")
+        @config.features << "gemjar"
       end
     end
 
@@ -186,32 +178,8 @@ module Warbler
     end
 
     def define_executable_task
-      winstone_type = ENV["WINSTONE"] || "winstone-lite"
-      winstone_version = ENV["WINSTONE_VERSION"] || "0.9.10"
-      winstone_path = "net/sourceforge/winstone/#{winstone_type}/#{winstone_version}/#{winstone_type}-#{winstone_version}.jar"
-      winstone_jar = File.expand_path("~/.m2/repository/#{winstone_path}")
-      file winstone_jar do |t|
-        # Not always covered in tests as these lines may not get
-        # executed every time if the jar is cached.
-        puts "Downloading #{winstone_type}.jar" #:nocov:
-        mkdir_p File.dirname(t.name)            #:nocov:
-        require 'open-uri'                      #:nocov:
-        maven_repo = ENV["MAVEN_REPO"] || "http://repo2.maven.org/maven2" #:nocov:
-        open("#{maven_repo}/#{winstone_path}") do |stream| #:nocov:
-          File.open(t.name, "wb") do |f|  #:nocov:
-            while buf = stream.read(4096) #:nocov:
-              f << buf                    #:nocov:
-            end                           #:nocov:
-          end                             #:nocov:
-        end                               #:nocov:
-      end
-
-      task "executable" => winstone_jar do
-        war.files['META-INF/MANIFEST.MF'] = StringIO.new(War::DEFAULT_MANIFEST.chomp + "Main-Class: Main\n")
-        war.files['Main.class'] = Zip::ZipFile.open("#{WARBLER_HOME}/lib/warbler_war.jar") do |zf|
-          zf.get_input_stream('Main.class') {|io| StringIO.new(io.read) }
-        end
-        war.files['WEB-INF/winstone.jar'] = winstone_jar
+      task "executable" do
+        @config.features << "executable"
       end
     end
 

data/lib/warbler/templates/config.erb

@@ -1 +1 @@
-WARBLER_CONFIG = <%= webxml.context_params(false) .inspect %>
+WARBLER_CONFIG = <%= config.webxml ? config.webxml.context_params(false).inspect : '{}' %>

data/lib/warbler/templates/rack.erb

@@ -1 +1 @@
-ENV['RACK_ENV'] = '<%= (params = webxml.context_params; params['rack.env'] || params['rails.env']) %>'
+ENV['RACK_ENV'] = '<%= (params = config.webxml.context_params; params['rack.env'] || params['rails.env']) %>'

data/lib/warbler/templates/rails.erb

@@ -1 +1 @@
-ENV['RAILS_ENV'] = '<%= webxml.rails.env %>'
+ENV['RAILS_ENV'] = '<%= config.webxml.rails.env %>'

data/lib/warbler/traits/bundler.rb

@@ -0,0 +1,58 @@
+#--
+# Copyright (c) 2010 Engine Yard, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+module Warbler
+  module Traits
+    # The Bundler trait uses Bundler to determine gem dependencies to
+    # be added to the project.
+    class Bundler
+      include Trait
+
+      def self.detect?
+        File.exist?("Gemfile")
+      end
+
+      def self.requires?(trait)
+        trait == Traits::War || trait == Traits::Jar
+      end
+
+      def before_configure
+        config.bundler = true
+        config.bundle_without = ["development", "test"]
+      end
+
+      def after_configure
+        add_bundler_gems if config.bundler
+      end
+
+      def add_bundler_gems
+        config.gems.clear
+        config.gem_dependencies = false # Bundler takes care of these
+
+        require 'bundler'
+        gemfile = Pathname.new("Gemfile").expand_path
+        root = gemfile.dirname
+        lockfile = root.join('Gemfile.lock')
+        definition = ::Bundler::Definition.build(gemfile, lockfile, nil)
+        groups = definition.groups - config.bundle_without.map {|g| g.to_sym}
+        definition.specs_for(groups).each {|spec| config.gems << spec }
+        config.init_contents << StringIO.new("ENV['BUNDLE_WITHOUT'] = '#{config.bundle_without.join(':')}'\n")
+      end
+
+      def update_archive(jar)
+        add_bundler_files(jar) if config.bundler
+      end
+
+      # Add Bundler Gemfiles to the archive.
+      def add_bundler_files(jar)
+        jar.files[jar.apply_pathmaps(config, 'Gemfile', :application)] = 'Gemfile'
+        if File.exist?('Gemfile.lock')
+          jar.files[jar.apply_pathmaps(config, 'Gemfile.lock', :application)] = 'Gemfile.lock'
+        end
+      end
+    end
+  end
+end

data/lib/warbler/traits/gemspec.rb

@@ -0,0 +1,64 @@
+#--
+# Copyright (c) 2010 Engine Yard, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+module Warbler
+  module Traits
+    # The Gemspec trait reads a .gemspec file to determine the files,
+    # executables, require paths, and dependencies for a project.
+    class Gemspec
+      include Trait
+
+      def self.detect?
+        !Dir['*.gemspec'].empty?
+      end
+
+      def before_configure
+        @spec_file = Dir['*.gemspec'].first
+        require 'yaml'
+        @spec = File.open(@spec_file) {|f| Gem::Specification.from_yaml(f) } rescue Gem::Specification.load(@spec_file)
+        @spec.runtime_dependencies.each {|g| config.gems << g }
+        config.dirs = []
+        config.compiled_ruby_files = @spec.files.select {|f| f =~ /\.rb$/}
+      end
+
+      def after_configure
+        @spec.require_paths.each do |p|
+          add_init_load_path(config.pathmaps.application.inject(p) {|pm,x| pm.pathmap(x)})
+        end
+      end
+
+      def update_archive(jar)
+        @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[jar.apply_pathmaps(config, f, :application)] = f
+        end
+        bin_path = jar.apply_pathmaps(config, default_executable, :application)
+        add_main_rb(jar, bin_path)
+      end
+
+      def default_executable
+        if @spec.default_executable
+          "bin/#{@spec.default_executable}"
+        else
+          exe = Dir['bin/*'].first
+          raise "No executable script found" unless exe
+          warn "No default executable found in #{@spec_file}, using #{exe}"
+          exe
+        end
+      end
+    end
+  end
+end

data/lib/warbler/traits/jar.rb

@@ -0,0 +1,53 @@
+#--
+# Copyright (c) 2010 Engine Yard, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+require 'stringio'
+require 'ostruct'
+
+module Warbler
+  module Traits
+    # The Jar trait sets up the archive layout for an executable jar
+    # project, and adds the JRuby jar files and a JarMain class to the
+    # archive.
+    class Jar
+      include Trait
+
+      def self.detect?
+        !War.detect?
+      end
+
+      def before_configure
+        config.pathmaps      = default_pathmaps
+        config.java_libs     = default_jar_files
+        config.manifest_file = 'MANIFEST.MF' if File.exist?('MANIFEST.MF')
+      end
+
+      def after_configure
+        config.init_contents << StringIO.new("require 'rubygems'\n")
+      end
+
+      def update_archive(jar)
+        jar.files['META-INF/MANIFEST.MF'] = StringIO.new(Warbler::Jar::DEFAULT_MANIFEST.chomp + "Main-Class: JarMain\n") unless config.manifest_file
+        jar.files['JarMain.class'] = jar.entry_in_jar("#{WARBLER_HOME}/lib/warbler_jar.jar", "JarMain.class")
+      end
+
+      def default_pathmaps
+        p = OpenStruct.new
+        p.java_libs    = ["META-INF/lib/%f"]
+        p.java_classes = ["%p"]
+        p.application  = ["#{config.jar_name}/%p"]
+        p.gemspecs     = ["specifications/%f"]
+        p.gems         = ["gems/%p"]
+        p
+      end
+
+      def default_jar_files
+        require 'jruby-jars'
+        FileList[JRubyJars.core_jar_path, JRubyJars.stdlib_jar_path]
+      end
+    end
+  end
+end

data/lib/warbler/traits/merb.rb

@@ -0,0 +1,34 @@
+#--
+# Copyright (c) 2010 Engine Yard, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+module Warbler
+  module Traits
+    # The Merb trait adds Merb::BootLoader gem dependencies to the project.
+    class Merb
+      include Trait
+
+      def self.detect?
+        File.exist?("config/init.rb")
+      end
+
+      def self.requires?(trait)
+        trait == Traits::War
+      end
+
+      def before_configure
+        return false unless task = Warbler.project_application.lookup("merb_env")
+        task.invoke rescue nil
+        return false unless defined?(::Merb)
+        config.webxml.booter = :merb
+        if defined?(::Merb::BootLoader::Dependencies.dependencies)
+          ::Merb::BootLoader::Dependencies.dependencies.each {|g| config.gems << g }
+        else
+          warn "unable to auto-detect Merb dependencies; upgrade to Merb 1.0 or greater"
+        end
+      end
+    end
+  end
+end

data/lib/warbler/traits/nogemspec.rb

@@ -0,0 +1,41 @@
+#--
+# Copyright (c) 2010 Engine Yard, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+module Warbler
+  module Traits
+    # The NoGemspec trait is used when no gemspec file is found for a
+    # jar project. It assumes a standard layout including +bin+ and
+    # +lib+ directories.
+    class NoGemspec
+      include Trait
+
+      def self.detect?
+        Jar.detect? && !Gemspec.detect?
+      end
+
+      def before_configure
+        config.dirs = ['.']
+      end
+
+      def after_configure
+        if File.directory?("lib")
+          add_init_load_path(config.pathmaps.application.inject("lib") {|pm,x| pm.pathmap(x)})
+        end
+      end
+
+      def update_archive(jar)
+        add_main_rb(jar, jar.apply_pathmaps(config, default_executable, :application))
+      end
+
+      def default_executable
+        exes = Dir['bin/*']
+        exe = exes.grep(/#{config.jar_name}/).first || exes.first
+        raise "No executable script found" unless exe
+        exe
+      end
+    end
+  end
+end

data/lib/warbler/traits/rack.rb

@@ -0,0 +1,31 @@
+#--
+# Copyright (c) 2010 Engine Yard, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+module Warbler
+  module Traits
+    # The Rack trait adds config.ru to a Rack-based war project.
+    class Rack
+      include Trait
+
+      def self.detect?
+        !Rails.detect? && (File.exist?("config.ru") || !Dir['*/config.ru'].empty?)
+      end
+
+      def self.requires?(trait)
+        trait == Traits::War
+      end
+
+      def before_configure
+        config.webxml.booter = :rack
+        config.webinf_files += [FileList['config.ru', '*/config.ru'].detect {|f| File.exist?(f)}]
+      end
+
+      def after_configure
+        config.init_contents << "#{config.warbler_templates}/rack.erb"
+      end
+    end
+  end
+end

data/lib/warbler/traits/rails.rb

@@ -0,0 +1,57 @@
+#--
+# Copyright (c) 2010 Engine Yard, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+module Warbler
+  module Traits
+    # The Rails trait invokes the Rake environment task and sets up Rails for a war-based project.
+    class Rails
+      include Trait
+
+      def self.detect?
+        File.exist?("config/environment.rb")
+      end
+
+      def self.requires?(trait)
+        trait == Traits::War
+      end
+
+      def before_configure
+        config.jar_name = default_app_name
+
+        return unless Warbler.framework_detection
+        return false unless task = Warbler.project_application.lookup("environment")
+        task.invoke rescue nil
+        return false unless defined?(::Rails)
+        config.dirs << "tmp" if File.directory?("tmp")
+        config.webxml.booter = :rails
+        unless (defined?(::Rails.vendor_rails?) && ::Rails.vendor_rails?) || File.directory?("vendor/rails")
+          config.gems["rails"] = ::Rails::VERSION::STRING
+        end
+        if defined?(::Rails.configuration.gems)
+          ::Rails.configuration.gems.each do |g|
+            config.gems << Gem::Dependency.new(g.name, g.requirement) if Dir["vendor/gems/#{g.name}*"].empty?
+          end
+        end
+        if defined?(::Rails.configuration.threadsafe!) &&
+            (defined?(::Rails.configuration.allow_concurrency) && # Rails 3
+             ::Rails.configuration.allow_concurrency && ::Rails.configuration.preload_frameworks) ||
+          (defined?(::Rails.configuration.action_controller.allow_concurrency) && # Rails 2
+           ::Rails.configuration.action_controller.allow_concurrency && ::Rails.configuration.action_controller.preload_frameworks)
+          config.webxml.jruby.max.runtimes = 1
+        end
+      end
+
+      def after_configure
+        config.init_contents << "#{config.warbler_templates}/rails.erb"
+      end
+
+
+      def default_app_name
+        File.basename(File.expand_path(defined?(::Rails.root) ? ::Rails.root : (defined?(RAILS_ROOT) ? RAILS_ROOT : Dir.getwd)))
+      end
+    end
+  end
+end