rjack-tarpit 2.0.0-java

data/History.rdoc

@@ -0,0 +1,71 @@
+=== 2.0.0 (2011-1-12)
+* Major rewrite. Consumer project changes are required on upgrade!
+  See also updated README.
+* Gem specification details are now in a separate, but highly
+  automated and generally improved gemspec file. This allows full
+  interoperability with Bundler.
+* Improved ReadmeParser for spec automation.
+* For Java projects, Maven is now executed in process via the
+  rjack-maven gem (speed improvement)
+* Hoe is no longer a dependency, however many Hoe compatible tasks are
+  still supported.
+* New default, in process Minitest launcher (speed improvement,
+  particularly on JRuby)
+
+=== 1.4.0 (2011-9-21)
+* Update/broaden to rdoc ~> 3.6
+* Update to hoe ~> 2.12.3
+
+=== 1.3.3 (2011-6-26)
+* Ruby 1.9 compatibility fix; to_a -> Array()
+
+=== 1.3.2 (2011-6-11)
+* Fix case where :install task would omit running "mvn install" due to
+  prior run of "mvn package".
+* Add conditional Rake::DSL includes for rake ~> 0.9.0.
+* Update rdoc dependency to >= 2.5.11, < 3.7 (3.6.1 works well.)
+
+=== 1.3.1 (2011-5-19)
+* On gem install(_deps), only ignore gem SystemExitException when
+  exit_code == 0; Fail on failed install.
+
+=== 1.3.0 (2011-2-5)
+* Add new install_deps task to install missing or all gem
+  dev. dependencies.
+* Use hard links for jars to avoid package problems with rubygems 1.4+
+* Update to hoe 2.8.0 and drop now unnecessary explicit dependency on
+  rubyforge.
+* Update rdoc dependency to >= 2.5.11, < 3.6 (3.5.2 works well.)
+* Generate manifest only once per run.
+* Fix git status check on tag (status --only flag no longer supported.)
+
+=== 1.2.3 (2010-12-28)
+* Update rdoc dependency to >= 2.5.11, < 3.1 (3.0.1 works well.)
+
+=== 1.2.2 (2010-7-8)
+* Actually, use both Gem.configuration['gem'] and [command] in gem
+  command tasks (i.e. .gemrc with install: args)
+* Perform a 'mvn install' with rake :install task, checking for
+  changes since last .tarpit-install.
+
+=== 1.2.1 (2010-4-21)
+* Also require 'rubygems/command_manager' for gem tasks (ruby)
+* Really use Gem.configuration['gem'] in gem command tasks.
+
+=== 1.2.0 (2010-3-6)
+* Add RJack::TarPit::BaseStrategy.test_line_match for common
+  version, etc. file checks. See example usage in this gem's Rakefile.
+* Add :java_platform flag for setting gem specification platform to java.
+* Add available Gem.configuration in gem command tasks.
+* Fix tag task outside of RJack repo.
+
+=== 1.1.0 (2009-12-19)
+* Add :rdoc_diagram option to use Graphviz dot --diagram with rdoc.
+* Added gem :push (gemcutter) and :install tasks
+
+=== 1.0.1 (2009-10-11)
+* Make Hoe the last dependency to avoid version conflict with
+  rubyforge or others.
+
+=== 1.0.0 (2009-10-10)
+* Initial release.

data/Manifest.txt

@@ -0,0 +1,45 @@
+History.rdoc
+Manifest.txt
+NOTICE.txt
+README.rdoc
+Rakefile
+lib/rjack-tarpit/base.rb
+lib/rjack-tarpit.rb
+lib/rjack-tarpit/base_strategy.rb
+lib/rjack-tarpit/clean.rb
+lib/rjack-tarpit/doc.rb
+lib/rjack-tarpit/gem.rb
+lib/rjack-tarpit/git.rb
+lib/rjack-tarpit/line_match.rb
+lib/rjack-tarpit/readme_parser.rb
+lib/rjack-tarpit/spec.rb
+lib/rjack-tarpit/test.rb
+lib/rjack-tarpit/util.rb
+test/setup.rb
+test/test_projects.rb
+test/test_readme_parser.rb
+test/test_tarpit.rb
+test/jproject/History.rdoc
+test/jproject/Manifest.static
+test/jproject/Manifest.txt
+test/jproject/NOTICE.txt
+test/jproject/README.rdoc
+test/jproject/Rakefile
+test/jproject/jproject.gemspec
+test/jproject/pom.xml
+test/jproject/lib/jproject/base.rb
+test/jproject/lib/jproject.rb
+test/jproject/test/setup.rb
+test/jproject/test/test_jproject.rb
+test/zookeeper/History.rdoc
+test/zookeeper/Manifest.static
+test/zookeeper/Manifest.txt
+test/zookeeper/README.rdoc
+test/zookeeper/Rakefile
+test/zookeeper/assembly.xml
+test/zookeeper/pom.xml
+test/zookeeper/rjack-zookeeper.gemspec
+test/zookeeper/lib/rjack-zookeeper/base.rb
+test/zookeeper/lib/rjack-zookeeper.rb
+test/zookeeper/test/setup.rb
+test/zookeeper/test/test_zookeeper.rb

data/NOTICE.txt

@@ -0,0 +1,2 @@
+rjack-tarpit
+Copyright (c) 2009-2012 David Kellum

data/README.rdoc

@@ -0,0 +1,124 @@
+= rjack-tarpit
+
+* http://rjack.rubyforge.org/tarpit
+* http://rjack.rubyforge.org
+* https://github.com/dekellum/rjack
+
+== Description
+
+TarPit provides the glue for an unholy union of build tools. TarPit
+includes general automation for any rubygems project. It originally
+used and remains heavily influenced by
+Hoe[http://seattlerb.rubyforge.org/hoe/] (e.g. Manifest.txt.)
+However, it fully supports use of Bundler[http://gembundler.com/]. The
+gemspec benefits from sensible automation but remains in
+a <project>.gemspec per Bundler's requirements.
+
+For java platform projects, TarPit offers Maven integration via the
+rjack-maven[http://rjack.rubyforge.org/maven] gem. Maven
+package/install is run as needed, and jars are linked to the gem lib
+directory for inclusion, with semi-automatic Manifest.txt production.
+No need to bloat your git repo by checking in every version of every
+jar for all time.  The standard Maven layout and configuration
+(i.e. src, target, pom.xml, assembly.xml) is otherwise retained for
+complete java tool set compatibility. Use Maven only for what is it
+good at: java compilation with dependencies. Use Rake for everything
+else.
+
+=== Features
+
+* In Rake/JVM process Maven execution via rjack-maven (speed)
+* Default, in Rake process
+  Minitest[http://docs.seattlerb.org/minitest/] launcher (speed)
+* Manifest.txt for gem file contents, derived from Manifest.static
+  plus jars in Java projects
+* ReadmeParser for default specification url, summary, description
+  values
+* Specification name defaults from <name>.gemspec
+* LineMatchTaskDefiner defines check_(history|init)_(version|date)
+  tasks where appropriate to avoid missing history or version updates
+  on release
+
+=== Java strategies
+
+Java projects require different strategies for integrating Maven,
+specified via +s.maven_strategy=+ and summarized below:
+
++:no_assembly+ :: pom.xml builds a single jar, default same name and
+                  same version as gem project (SpecHelper.default_jar)
+                  or specified via +s.jars=+.
+
++:jars_from_assembly+ :: assembly.xml defines the jars at Maven
+                         package time. Changes to this set of jars
+                         must be incorporated by explicitly running
+                         the `rake manifest` task.
+
+Default :: No java, or use assembly for multiple jars but specify
+           +s.jars=+ when they can be computed, for example from
+           common version number or other gem data. This avoids the
+           need for the `rake manifest` step of +:jars_from_assembly+.
+
+Assemblies are built and located with the pom version number. This
+defaults to gem project version, but can be fixed
+(i.e. s.assembly_version='1.0') to avoid a separate version to bump,
+where the project will not export the pom, for example when the
+project is re-packaging upstream jars as a gem.
+
+== Synopsis
+
+Sample gemspec for a gem including a single jar, built from java
+source with maven (see also included test/jproject):
+
+  gem 'rjack-tarpit', '~> 2.0'
+  require 'rjack-tarpit/spec'
+
+  RJack::TarPit.specify do |s|
+    require 'jproject/base'
+
+    s.version = JProject::VERSION
+
+    s.add_developer 'David Kellum', 'dek-oss@gravitext.com'
+
+    s.maven_strategy = :no_assembly
+
+    s.depend 'rjack-slf4j',   '~> 1.6.4'
+    s.depend 'minitest',      '~> 2.3',     :dev
+  end
+
+And the associated Rakefile (assuming use of Bundler):
+
+  require 'rubygems'
+  require 'bundler/setup'
+  require 'rjack-tarpit'
+
+  RJack::TarPit.new( "jproject" ).define_tasks
+
+And a Bundler Gemfile:
+
+  source :rubygems
+  gemspec
+
+Java projects should provide a Manifest.static. Jars or other
+generated files will be added to this to produce Manifest.txt for use
+as the gemspec's files.
+
+== Dependencies
+
+See the gem dependencies. The rjack-maven gem is only a dependency on
+the java platform.
+
+== License
+
+Copyright (c) 2009-2012 David Kellum
+
+Licensed under the Apache License, Version 2.0 (the "License"); you
+may not use this file except in compliance with the License.  You
+may obtain a copy of the License at:
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied.  See the License for the specific language governing
+permissions and limitations under the License.

data/Rakefile

@@ -0,0 +1,21 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rjack-tarpit'
+
+RJack::TarPit.new( 'rjack-tarpit' ) do |tp|
+
+  tp.rdoc_destinations <<
+    'dekellum@rubyforge.org:/var/www/gforge-projects/rjack/tarpit'
+
+  desc "Check that README sample has latest version"
+  task :check_sample_version do
+    tp.test_line_match( 'README.rdoc',
+                        /^\s*gem.+rjack-tarpit/,
+                        /#{ RJack::TarPit::MINOR_VERSION }/ )
+  end
+  [ :gem, :tag, :push ].each { |t| task t => :check_sample_version }
+
+end

data/lib/rjack-tarpit.rb

@@ -0,0 +1,40 @@
+#--
+# Copyright (c) 2009-2012 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'rjack-tarpit/base'
+require 'rjack-tarpit/spec'
+require 'rjack-tarpit/base_strategy'
+
+module RJack::TarPit
+
+  # New task generator given name matching <name>.gemspec in the
+  # current directory. If block is given, yields self (err, actually
+  # the BaseStrategy) to block and calls define_tasks upon exit.
+  def self.new( name )
+
+    load( "#{name}.gemspec", true )
+
+    tp = BaseStrategy.new( last_spec )
+
+    if block_given?
+      yield tp
+      tp.define_tasks
+    end
+
+    tp
+  end
+
+end

data/lib/rjack-tarpit/base.rb

@@ -0,0 +1,22 @@
+#--
+# Copyright (c) 2009-2012 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+module RJack
+  module TarPit
+    MINOR_VERSION = '2.0'
+    VERSION = MINOR_VERSION + '.0'
+  end
+end

data/lib/rjack-tarpit/base_strategy.rb

@@ -0,0 +1,175 @@
+#--
+# Copyright (c) 2009-2012 David Kellum
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you
+# may not use this file except in compliance with the License.  You
+# may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.  See the License for the specific language governing
+# permissions and limitations under the License.
+#++
+
+require 'rjack-tarpit/base'
+require 'rjack-tarpit/util'
+require 'rjack-tarpit/spec'
+
+require 'rjack-tarpit/test'
+require 'rjack-tarpit/gem'
+require 'rjack-tarpit/clean'
+require 'rjack-tarpit/line_match'
+require 'rjack-tarpit/doc'
+require 'rjack-tarpit/git'
+
+module RJack::TarPit
+
+  # Base class for Rake task generation.
+  class BaseStrategy
+
+    #For rack ~> 0.9.0
+    include Rake::DSL if defined?( Rake::DSL )
+
+    include TestTaskDefiner
+    include GemTaskDefiner
+    include CleanTaskDefiner
+    include LineMatchTaskDefiner
+    include DocTaskDefiner
+    include GitTaskDefiner
+
+    include Util
+
+    # The augmented Gem::Specification as constructed.
+    attr_reader :spec
+
+    # See TarPit.new
+    def initialize( spec )
+      @defines = [ :define_maven_tasks ]
+      super()
+
+      @spec = spec
+
+      @install_request = Rake.application.top_level_tasks.include?( "install" )
+    end
+
+    def add_define_hook( sym )
+      @defines << sym
+    end
+
+    # Define rake tasks (given settings)
+    def define_tasks
+      @defines.each { |sym| send( sym ) }
+    end
+
+    # Define maven tasks based on spec strategy and other details.
+    def define_maven_tasks
+      from_assembly = ( spec.maven_strategy == :jars_from_assembly )
+      do_maven = from_assembly || spec.jars.size > 0
+
+      define_maven_package_task if do_maven
+
+      if do_maven || spec.generated_files
+        define_manifest_task
+        task( :manifest => [ MVN_STATE_FILE ] ) if from_assembly
+      end
+
+      define_post_maven_tasks if do_maven
+    end
+
+    # Define task for dynamically generating Manifest.txt
+    def define_manifest_task
+
+      if File.exist?( 'Manifest.static' )
+        file 'Manifest.txt' => [ 'Manifest.static' ]
+      end
+
+      gf = clean_list( spec.generated_files ).sort
+      [ :gem, :test ].each { |t| task t => gf }
+
+      unless gf.empty?
+        task :gen_clean do
+          rm_f gf
+        end
+        task :clean => :gen_clean
+      end
+
+      desc "Force update of Manifest.txt"
+      task :manifest do
+        spec.generate_manifest
+      end
+
+      mtask = file 'Manifest.txt' do
+        spec.generate_manifest
+      end
+
+      mtask
+    end
+
+    # File touched to record the time of last successful 'mvn
+    # package' run.
+    MVN_STATE_FILE         = 'target/.tarpit'
+    MVN_STATE_FILE_INSTALL = 'target/.tarpit-install'
+
+    # Define a file task tracking calls to "mvn package"
+    def define_maven_package_task
+      [ MVN_STATE_FILE, MVN_STATE_FILE_INSTALL ].each do |sf|
+        file sf => maven_dependencies do
+          run_maven
+        end
+      end
+
+      task :install => MVN_STATE_FILE_INSTALL
+    end
+
+    # Run Maven mvn package or install and touch state files.
+    def run_maven
+      # Delay till now, in case we were not running on jvm
+      require 'rjack-maven'
+
+      target = @install_request ? 'install' : 'package'
+
+      status = RJack::Maven.launch( [ target ] )
+      unless status == 0
+        raise "TARPIT: Maven #{target} failed (exit code: #{status})"
+      end
+
+      touch( MVN_STATE_FILE )
+      touch( MVN_STATE_FILE_INSTALL ) if @install_request
+    end
+
+    # Define file tasks for all jar symlinks and other misc. maven
+    # associated tasks like :mvn_clean.
+    def define_post_maven_tasks
+      jfrom = spec.jar_from
+      spec.jars.each do |jar|
+        from = File.join( jfrom, jar )
+        dest = File.join( spec.jar_dest, jar )
+        file from => [ MVN_STATE_FILE ]
+        file dest => [ from ] do
+          ln( from, dest, :force => true )
+        end
+        [ :gem, :test ].each { |t| task t => [ dest ] }
+      end
+
+      task :mvn_clean do
+        spec.remove_dest_jars
+        rm_rf 'target' if File.directory?( 'target' )
+      end
+      task :clean => :mvn_clean
+    end
+
+    # Dependencies on "mvn package" including pom.xml, any assembly.xml,
+    # all files under the "src" directory.
+    def maven_dependencies
+      deps  = [ 'pom.xml' ]
+      deps << 'assembly.xml' if File.exist?( 'assembly.xml' )
+      deps += FileList[ "src/**/*" ].exclude { |f| ! File.file?( f ) }
+      deps
+    end
+
+  end
+
+end