rjack-tarpit 1.4.1 → 2.0.0

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

data/lib/rjack-tarpit/clean.rb

@@ -0,0 +1,43 @@
+#--
+# 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::TarPit
+
+  module CleanTaskDefiner
+
+    # An array of file patterns to delete on clean.
+    attr_accessor :clean_globs
+
+    def initialize
+      super
+
+      @clean_globs ||= %w[ .source_index **/*~ **/.*~ ]
+
+      add_define_hook( :define_clean_tasks )
+    end
+
+    def define_clean_tasks
+      desc 'Clean up (common backup file patterns)'
+      task :clean do
+        globs = clean_globs + [ 'pkg', rdoc_dir ]
+        files = globs.map { |p| Dir[ p ] }.flatten
+        rm_rf( files, :verbose => true ) unless files.empty?
+      end
+    end
+
+  end
+
+end

data/lib/rjack-tarpit/doc.rb

@@ -0,0 +1,67 @@
+#--
+# 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::TarPit
+
+  module DocTaskDefiner
+
+    # Local destination directory for RDoc generated files.
+    # (default: doc)
+    attr_accessor :rdoc_dir
+
+    # Remote destinations array for publish_rdoc. (default: [])
+    attr_accessor :rdoc_destinations
+
+    # Rsync flags for publish_rdoc. (default: %w[ -a -u -i ])
+    attr_accessor :publish_rdoc_rsync_flags
+
+    def initialize
+      super
+
+      @rdoc_dir = 'doc'
+      @rdoc_destinations = []
+      @publish_rdoc_rsync_flags = %w[ -a -u -i ]
+
+      add_define_hook( :define_doc_tasks )
+    end
+
+    def define_doc_tasks
+      require 'rdoc/task'
+
+      RDoc::Task.new( :rdoc ) do |t|
+        t.rdoc_dir = rdoc_dir
+        t.rdoc_files += spec.require_paths
+        t.rdoc_files += spec.extra_rdoc_files
+        t.options = spec.rdoc_options
+      end
+
+      unless rdoc_destinations.empty?
+        desc "Publish rdoc to #{ rdoc_destinations.join( ', ' ) }"
+        task :publish_rdoc => [ :docs ] do
+          rdoc_destinations.each do |dest|
+            sh( *[ 'rsync', publish_rdoc_rsync_flags,
+                   rdoc_dir + '/', dest ].flatten )
+          end
+        end
+      end
+
+      desc "Alias rdoc task"
+      task :docs => [ :rdoc ]
+    end
+
+  end
+
+end

data/lib/rjack-tarpit/gem.rb

@@ -0,0 +1,119 @@
+#--
+# 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 'rubygems/package_task'
+
+module RJack::TarPit
+
+  module GemTaskDefiner
+
+    # Should package create a tarball? (default: false)
+    attr_accessor :need_tar
+
+    # Should package create a zipfile? (default: false)
+    attr_accessor :need_zip
+
+    def initialize
+      super
+
+      @need_tar = false
+      @need_zip = false
+
+      add_define_hook( :define_gem_tasks )
+    end
+
+    def define_gem_tasks
+
+      Gem::PackageTask.new( spec ) do |pkg|
+        pkg.need_tar = @need_tar
+        pkg.need_zip = @need_zip
+      end
+
+      desc 'Dump plain ruby Gem::Specification'
+      task :debug_gem do
+        puts spec.to_ruby
+      end
+
+      desc "gem push (gemcutter)"
+      task :push => [ :gem ] do
+        require 'rubygems'
+        require 'rubygems/command_manager'
+        cm = Gem::CommandManager.instance
+        cm.run( gem_config( 'push', '-V', gem_file ) )
+      end
+
+      desc "gem(+maven) install"
+      task :install => [ :gem ] do
+        require 'rubygems'
+        require 'rubygems/command_manager'
+        cm = Gem::CommandManager.instance
+        begin
+          cm.run( gem_config( 'install', '--local', '-V', gem_file ) )
+        rescue Gem::SystemExitException => x
+          raise "Install failed (#{x.exit_code})" if x.exit_code != 0
+        end
+      end
+
+      desc "gem install missing/all dev dependencies"
+      task( :install_deps, :force ) do |t,args|
+        require 'rubygems'
+        require 'rubygems/command_manager'
+        force = ( args[:force] == 'force' )
+        ( @spec.extra_deps + @spec.extra_dev_deps ).each do |dep|
+          if force
+            gem_install_dep( dep )
+          else
+            begin
+              gem( *dep )
+            rescue Gem::LoadError => e
+              puts "Gem dep: " + e.to_s
+              gem_install_dep( dep )
+            end
+          end
+        end
+      end
+    end
+
+    def gem_install_dep( dep )
+      puts "Install: " + dep.inspect
+      cm = Gem::CommandManager.instance
+      c = [ 'install', '--remote', '-V', dep.first ]
+      c += dep[1..-1].map { |r| [ '-v', r ] }.flatten
+      cm.run( gem_config( *c ) )
+    rescue Gem::SystemExitException => x
+      raise "Install failed (#{x.exit_code})" if x.exit_code != 0
+    end
+
+    def gem_file
+      parts = [ spec.name, spec.version ]
+      p = spec.platform
+      parts << 'java' if p.respond_to?( :os ) && p.os == 'java'
+
+      "pkg/#{ parts.join( '-' ) }.gem"
+    end
+
+    def gem_config( command, *args )
+      cargs = [ 'gem', command ].map do |cmd|
+        conf = Gem.configuration[ cmd ]
+        conf.is_a?( String ) ? conf.split( ' ' ) : Array( conf )
+      end
+      cargs.flatten!
+      [ command ] + cargs + args
+    end
+
+  end
+
+end

data/lib/rjack-tarpit/git.rb

@@ -0,0 +1,45 @@
+#--
+# 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::TarPit
+
+  module GitTaskDefiner
+
+    def initialize
+      super
+
+      add_define_hook( :define_git_tasks )
+    end
+
+    # Define git based :tag task
+    def define_git_tasks
+      desc "git tag current version"
+      task :tag do
+        tag = [ spec.name, spec.version ].join( '-' )
+        dname = Rake.original_dir
+        dname = '.' if Dir.getwd == dname
+        delta = `git status --porcelain -- #{dname} 2>&1`.split(/^/)
+        if delta.length > 0
+          puts delta
+          raise "Commit these changes before tagging"
+        end
+        sh %{git tag -s -f -m "tag [#{tag}]" "#{tag}"}
+      end
+    end
+
+  end
+
+end