warbler 0.9 → 0.9.1

data/History.txt

@@ -1,3 +1,11 @@
+== 0.9.1
+
+* Bundle Bouncy Castle JCE provider so that Digests work properly. See LICENSES.txt for details of
+  the distribution.
+* Add rake >= 0.7.3 as a dependency in the gem specification.
+* Add debug tasks: war:debug, war:debug:gems, war:debug:public, war:debug:app, war:debug:includes,
+  war:debug:excludes, war:debug:java_libs gives you a breakdown of what Warbler expects to package.
+
 == 0.9
 
 * Birthday! Warbler is a gem to make a .war file out of a Rails project. The intent is to provide a

data/README.txt

@@ -62,9 +62,25 @@ If you wish to upgrade or switch one or more java libraries from what's bundled
 
 Once Warbler is installed as a plugin, you can use +rake+ to build the war (with the same set of tasks as above).
 
+=== Web.xml
+
+Java web applications are configured mainly through this file, and Warbler creates a suitable default file for you for use with the bundled Goldspike bits.  However, if you need to customize it in any way, you have two options.
+
+1. If you just want a static web.xml file whose contents you manually control, you may copy the one generated for you in <tt>tmp/war/WEB-INF/web.xml</tt> to <tt>config/web.xml</tt>.  It will be copied into the webapp for you.
+2. If you want to inject some dynamic information into the file, copy the <tt>WARBLER_HOME/web.xml.erb</tt> to <tt>config/web.xml.erb</tt>.  Its contents will be evaluated for you and put in the webapp.  Note that you can also pass arbitrary properties to the ERb template by setting <tt>config.webxml.customkey</tt> values in your <tt>config/warble.rb</tt> file.
+
 For more information on configuration, see Warbler::Config.
 
-=== Caveats
+=== Troubleshooting
+
+If Warbler isn't packaging the files you were expecting, there are several debug tasks available to give you more insight into what's going on.
+
+* <tt>war:debug</tt> prints a YAML dump of the current configuration
+* <tt>war:debug:X</tt> prints a list of files that Warbler will include during that stage of
+  assembly. Valid values of <tt>X</tt> are <tt>app, java_libs, gems, public, includes,
+  excludes</tt>.
+
+== Caveats
 
 Warbler requires that RAILS_ROOT will effectively be set to /WEB-INF when running inside the war, while the application public files will be in the root directory.  The purpose is to make the application structure match the Java webapp archive structure, where WEB-INF is a protected directory not visible to the web server.  Because of this change, features of Rails that expect the public assets directory to live in RAILS_ROOT/public may not function properly.  However, we feel that the added security of conforming to the webapp structure is worth these minor inconveniences.
 
@@ -74,11 +90,17 @@ For Rails 1.2.3, the items that may need your attention are:
 * Asset tag timestamp calculation (e.g., <tt>javascripts/prototype.js?1188482864</tt>) will not happen.  The workaround is to control this manually by setting the RAILS_ASSET_ID environment variable.
 * Automatic inclusion of <tt>application.js</tt> through <tt>javascript_include_tag :defaults</tt> will not work.  The workaround is to include it yourself with <tt>javascript_include_tag "application"</tt>.
 
+== Source
+
+Warbler source is not currently located in Rubyforge's SVN.  To get the source:
+
+    svn co http://svn.caldersphere.net/svn/main/rubyforge/warbler/trunk warbler
+
 == License
 
 Warbler is provided under the terms of the MIT license.
 
-    Warbler (c) 2007 Nick Sieger <nicksieger@gmail.com>.
+    Warbler (c) 2007 Nick Sieger <nicksieger@gmail.com>
 
 Warbler also bundles several other pieces of software. Please read the file LICENSES.txt to ensure
 that you agree with the terms of all the components.

data/Rakefile

@@ -15,7 +15,7 @@ begin
     p.summary = "Warbler chirpily constructs .war files of your Rails applications."
     p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
     p.description = p.paragraphs_of('README.txt', 0...1).join("\n\n")
-    p.extra_deps.reject!{|d| d.first == "hoe"}
+    p.extra_deps << ['rake', '>= 0.7.3']
     p.test_globs = ["spec/**/*_spec.rb"]
     p.rdoc_pattern = /\.(rb|txt)/
   end

data/bin/warble

@@ -21,7 +21,11 @@ application.standard_exception_handling do
   desc "Generate a configuration file to customize your war assembly"
   task :config do
     if File.exists?(Warbler::Config::FILE) && ENV["FORCE"].nil?
-      warn "#{Warbler::Config::FILE}: file already exists. Use FORCE=1 to override"
+      warn "There's another bird sitting on my favorite branch"
+      warn "(file '#{Warbler::Config::FILE}' already exists. Pass argument FORCE=1 to override)"
+    elsif !File.directory?("config")
+      warn "I'm confused; my favorite branch is missing"
+      warn "(directory 'config' is missing)"
     else
       cp "#{Warbler::WARBLER_HOME}/generators/warble/templates/warble.rb", Warbler::Config::FILE
     end
@@ -29,8 +33,12 @@ application.standard_exception_handling do
 
   desc "Unpack warbler as a plugin in your Rails application"
   task :pluginize do
-    unless Dir["vendor/plugins/warbler*"].empty?
-      warn "warbler is already installed as a plugin; please remove before re-installing"
+    if !Dir["vendor/plugins/warbler*"].empty?
+      warn "I found an old nest in vendor/plugins; please trash it so I can make a new one"
+      warn "(directory vendor/plugins/warbler* exists)"
+    elsif !File.directory?("vendor/plugins")
+      warn "I can't find a place to build my nest"
+      warn "(directory 'vendor/plugins' is missing)"
     else
       Dir.chdir("vendor/plugins") do
         ruby "-S", "gem", "unpack", "warbler"
@@ -38,5 +46,10 @@ application.standard_exception_handling do
     end
   end
 
+  desc "Display version of warbler"
+  task :version do
+    puts "Warbler version #{Warbler::VERSION}"
+  end
+
   application.top_level
 end

data/generators/warble/templates/warble.rb

@@ -14,17 +14,21 @@ Warbler::Config.new do |config|
 
   # Additional Java .jar files to include.  Note that if .jar files are placed
   # in lib (and not otherwise excluded) then they need not be mentioned here
-  # config.java_libs = FileList["lib/java/*.jar"]
-  # config.java_libs << "lib/java/*.jar"
+  # JRuby and Goldspike are pre-loaded in this list.  Be sure to include your
+  # own versions if you directly set the value
+  # config.java_libs += FileList["lib/java/*.jar"]
 
-  # External gems to be packaged in the webapp.
+  # Gems to be packaged in the webapp.  Note that Rails gems are added to this
+  # list if vendor/rails is not present, so be sure to include rails if you
+  # overwrite the value
   # config.gems = ["ActiveRecord-JDBC", "jruby-openssl"]
   # config.gems << "tzinfo"
 
   # Include gem dependencies not mentioned specifically
   config.gem_dependencies = true
 
-  # Files to be included in the root of the webapp
+  # Files to be included in the root of the webapp.  Note that files in public
+  # will have the leading 'public/' part of the path stripped during staging.
   # config.public_html = FileList["public/**/*", "doc/**/*"]
 
   # Name of the war file (without the .war) -- defaults to the basename

data/lib/warbler/config.rb

@@ -77,18 +77,16 @@ module Warbler
       @staging_dir = "tmp/war"
       @dirs        = TOP_DIRS
       @includes    = FileList[]
-      @excludes    = FileList["#{WARBLER_HOME}/**/*"]
+      @excludes    = FileList[]
       @java_libs   = FileList["#{WARBLER_HOME}/lib/*.jar"]
       @gems        = default_gems
       @gem_dependencies = true
       @public_html = FileList["public/**/*"]
       @webxml      = default_webxml_config
-      @war_name    = if defined?(RAILS_ROOT)
-        File.basename(File.expand_path(RAILS_ROOT))
-      else
-        File.basename(File.expand_path(Dir.getwd))  
-      end
+      @rails_root  = File.expand_path(defined?(RAILS_ROOT) ? RAILS_ROOT : Dir.getwd)
+      @war_name    = File.basename(@rails_root)
       yield self if block_given?
+      @excludes += warbler_vendor_excludes
       @excludes << @staging_dir
     end
 
@@ -97,6 +95,15 @@ module Warbler
     end
 
     private
+    def warbler_vendor_excludes
+      warbler = File.expand_path(WARBLER_HOME)
+      if warbler =~ %r{^#{@rails_root}/(.*)}
+        FileList["#{$1}"]
+      else
+        []
+      end
+    end
+
     def default_webxml_config
       c = OpenStruct.new
       c.standalone = true

data/lib/warbler/task.rb

@@ -71,6 +71,10 @@ module Warbler
       with_namespace_and_config do
         desc "Copy all public HTML files to the root of the .war"
         task "public" => public_target_files
+        task "debug:public" do
+          puts "", "public files:"
+          puts *public_target_files
+        end
       end
     end
 
@@ -80,6 +84,10 @@ module Warbler
       with_namespace_and_config do
         desc "Unpack all gems into WEB-INF/gems"
         task "gems" => targets
+        task "debug:gems" do
+          puts "", "gems files:"
+          puts *targets
+        end
       end
     end
 
@@ -114,6 +122,10 @@ module Warbler
       with_namespace_and_config do |name, config|
         desc "Copy all java libraries into the .war"
         task "java_libs" => target_files
+        task "debug:java_libs" do
+          puts "", "java_libs files:"
+          puts *target_files
+        end
       end
       target_files
     end
@@ -123,6 +135,10 @@ module Warbler
       with_namespace_and_config do |name, config|
         desc "Copy all application files into the .war"
         task "app" => ["#{name}:gems", *webinf_target_files]
+        task "debug:app" do
+          puts "", "app files:"
+          puts *webinf_target_files
+        end
       end
     end
 
@@ -130,7 +146,7 @@ module Warbler
       with_namespace_and_config do |name, config|
         desc "Run the jar command to create the .war"
         task "jar" do
-          sh "jar", "cf", "#{config.war_name}.war", "-C", config.staging_dir, "."
+          sh "jar cf #{config.war_name}.war -C #{config.staging_dir} ."
         end
       end
     end
@@ -138,9 +154,13 @@ module Warbler
     def define_debug_task
       with_namespace_and_config do |name, config|
         task "debug" do
-          require 'pp'
-          pp config
+          require 'yaml'
+          puts YAML::dump(config)
         end
+        all_debug_tasks = %w(: app java_libs gems public includes excludes).map do |n|
+          n.sub(/^:?/, "#{name}:debug:").sub(/:$/, '')
+        end
+        task "debug:all" => all_debug_tasks
       end
     end
 
@@ -151,13 +171,21 @@ module Warbler
     end
 
     def define_webinf_file_tasks
-      files = FileList[*@config.dirs.map{|d| "#{d}/**/*"}]
-      files.include(*@config.includes.to_a)
-      files.exclude(*@config.excludes.to_a)
+      files = FileList[*(@config.dirs.map{|d| "#{d}/**/*"})]
+      files.include *(@config.includes.to_a)
+      files.exclude *(@config.excludes.to_a)
       target_files = files.map do |f|
         define_file_task(f, "#{@config.staging_dir}/WEB-INF/#{f}")
       end
       target_files += define_java_libs_task
+      task "#@name:debug:includes" do
+        puts "", "included files:"
+        puts *files.include
+      end
+      task "#@name:debug:excludes" do
+        puts "", "excluded files:"
+        puts *files.exclude
+      end
       target_files
     end
 

data/lib/warbler/version.rb

@@ -5,5 +5,5 @@
 #++
 
 module Warbler
-  VERSION = "0.9"
+  VERSION = "0.9.1"
 end

data/spec/warbler/task_spec.rb

@@ -33,8 +33,8 @@ describe Warbler::Task do
     end
   end
 
-  def files_should_contain(regex)
-    FileList["#{@config.staging_dir}/**/*"].detect {|f| f =~ regex }.should_not be_nil
+  def file_list(regex)
+    FileList["#{@config.staging_dir}/**/*"].select {|f| f =~ regex }
   end
 
   after(:each) do
@@ -53,20 +53,20 @@ describe Warbler::Task do
   it "should define a public task for copying the public files" do
     define_tasks "public"
     Rake::Task["warble:public"].invoke
-    files_should_contain %r{tasks/warbler\.rake}
+    file_list(%r{tasks/warbler\.rake}).should_not be_nil
   end
 
   it "should define a gems task for unpacking gems" do
     define_tasks "gems"
     Rake::Task["warble:gems"].invoke
-    files_should_contain %r{WEB-INF/gems/gems/rake.*/lib/rake.rb}
-    files_should_contain %r{WEB-INF/gems/specifications/rake.*\.gemspec}
+    file_list(%r{WEB-INF/gems/gems/rake.*/lib/rake.rb}).should_not be_empty
+    file_list(%r{WEB-INF/gems/specifications/rake.*\.gemspec}).should_not be_empty
   end
 
   it "should define a webxml task for creating web.xml" do
     define_tasks "webxml"
     Rake::Task["warble:webxml"].invoke
-    files_should_contain %r{WEB-INF/web.xml$}
+    file_list(%r{WEB-INF/web.xml$}).should_not be_empty
     require 'rexml/document'
     
     elements = File.open("#{@config.staging_dir}/WEB-INF/web.xml") do |f|
@@ -83,7 +83,7 @@ describe Warbler::Task do
   it "should define a java_libs task for copying java libraries" do
     define_tasks "java_libs"
     Rake::Task["warble:java_libs"].invoke
-    files_should_contain %r{WEB-INF/lib/jruby-complete.*\.jar$}
+    file_list(%r{WEB-INF/lib/jruby-complete.*\.jar$}).should_not be_empty
   end
 
   it "should define an app task for copying application files" do
@@ -93,9 +93,9 @@ describe Warbler::Task do
     end
     define_tasks "app"
     Rake::Task["warble:app"].invoke
-    files_should_contain %r{WEB-INF/bin/warble$}
-    files_should_contain %r{WEB-INF/generators/warble/warble_generator\.rb$}
-    files_should_contain %r{WEB-INF/lib/warbler\.rb$}
+    file_list(%r{WEB-INF/bin/warble$}).should_not be_empty
+    file_list(%r{WEB-INF/generators/warble/warble_generator\.rb$}).should_not be_empty
+    file_list(%r{WEB-INF/lib/warbler\.rb$}).should_not be_empty
     gems_ran.should == true
   end
 
@@ -120,6 +120,15 @@ describe Warbler::Task do
     webxml_ran.should == true
   end
 
+  it "should be able to exclude files from the .war" do
+    @config.dirs << "spec"
+    @config.excludes += FileList['spec/spec_helper.rb']
+    task "warble:gems" do; end
+    define_tasks "app"
+    Rake::Task["warble:app"].invoke
+    file_list(%r{spec/spec_helper.rb}).should be_empty
+  end
+
   it "should be able to define all tasks successfully" do
     Warbler::Task.new "warble", @config
   end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: warbler
 version: !ruby/object:Gem::Version 
-  version: "0.9"
-date: 2007-08-30 00:00:00 -05:00
+  version: 0.9.1
+date: 2007-12-13 00:00:00 -08:00
 summary: Warbler chirpily constructs .war files of your Rails applications.
 require_paths: 
 - lib
@@ -70,5 +70,13 @@ extensions: []
 
 requirements: []
 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.7.3
+    version: