rjack-tarpit 2.0.0-java

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

data/lib/rjack-tarpit/line_match.rb

@@ -0,0 +1,134 @@
+#--
+# 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 LineMatchTaskDefiner
+
+    # Regexp to use for first line of History file with version, date
+    attr_accessor :history_regexp
+
+    # Regexp to use for a valid/releasable date on History
+    attr_accessor :history_date_regexp
+
+    # Proc returning regexp given gem version as parameter, to use to
+    # validate the version of the latest history entry.
+    attr_accessor :history_version_regexp
+
+    # Array of "init" files to check for gem version references in
+    # (default: [ init/<spec.name> ], if exists)
+    attr_accessor :init_files
+
+    # Proc given spec and returning regexp matching gem line to find in
+    # init_files. (default: /^gem.+<spec.name>/)
+    attr_accessor :init_line_regexp
+
+    # Proc returning regexp given gem version as parameter, to use to
+    # validate the gem version of gem line in init_files.
+    # (default: /= <spec.version>/)
+    attr_accessor :init_version_regexp
+
+    def initialize
+      super
+
+      @history_regexp         = /^==/
+      @history_date_regexp    = /\([0-9\-]+\)$/
+      @history_version_regexp = Proc.new { |v| / #{v} / }
+
+      @init_files             = :default
+      @init_line_regexp       = Proc.new { |s| /^gem.+#{s.name}/ }
+      @init_version_regexp    = Proc.new { |v| /= #{v}/ }
+
+      add_define_hook( :define_line_match_tasks )
+    end
+
+    def define_line_match_tasks
+
+      if spec.history_file && history_regexp
+        desc "Check that #{spec.history_file} has latest version"
+        task :check_history_version do
+          test_line_match( spec.history_file,
+                           history_regexp,
+                           history_version_regexp.call( spec.version ) )
+        end
+        [ :gem, :tag, :push ].each { |t| task t => :check_history_version }
+      end
+
+      if spec.history_file && history_date_regexp
+        desc "Check that #{spec.history_file} has a date for release"
+        task :check_history_date do
+          test_line_match( spec.history_file,
+                           history_regexp,
+                           history_date_regexp )
+        end
+        [ :tag, :push ].each { |t| task t => :check_history_date }
+      end
+
+      if init_files == :default
+        init_files = [ File.join( 'init', spec.name ) ].
+          select { |f| File.exist?( f ) }
+      end
+
+      init_files.each do |inf|
+        desc "Check that #{init_files.join(", ")} has latest version"
+        task :check_init_version do
+          test_line_match( inf,
+                           init_line_regexp.call( spec ),
+                           init_version_regexp.call( spec.version ) )
+        end
+      end
+
+      unless init_files.empty?
+        [ :gem, :tag ].each { |t| task t => :check_init_version }
+      end
+
+    end
+
+    # Test that all specified files have at least one line matching
+    # line_regex, and that first line additionally matches (optional)
+    # pass_line_regex.
+    # ==== Parameters
+    # files<Array(~)>:: List of files to test
+    # line_regex<Regexp>:: Test first matching line
+    # pass_line_regex:: Further test on match line (default: match all)
+    # ==== Raises
+    # RuntimeError:: on test failure.
+    def test_line_match( files, line_regex, pass_line_regex = // )
+      Array( files ).each do |mfile|
+        found = false
+        open( mfile ) do |mf|
+          num = 0
+          mf.each do |line|
+            num += 1
+            if line =~ line_regex
+              found = true
+              unless line =~ pass_line_regex
+                raise( "%s:%d: %s !~ %s" %
+                       [ mfile, num, line.strip, pass_line_regex.inspect ] )
+              end
+              break
+            end
+          end
+        end
+        unless found
+          raise "#{mfile}: #{line_regex.inspect} not found"
+        end
+      end
+    end
+
+  end
+
+end

data/lib/rjack-tarpit/readme_parser.rb

@@ -0,0 +1,74 @@
+#--
+# 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'
+
+module RJack::TarPit
+
+  # Helper mixin for deriving default spec properties from the README
+  # (rdoc,txt) file
+  module ReadmeParser
+
+    # Parse the given README file, setting properties homepage,
+    # summary, and description on self if possible.
+    def parse_readme( file )
+
+      in_desc = false
+      desc = ""
+
+      readme_file_open( file ) do |fin|
+        fin.each do |line|
+          if homepage.nil? && line =~ /^\s*\*\s*(http\S+)\s*$/
+            self.homepage = $1
+          elsif line =~ /^=/ # section header
+            in_desc = ( line =~ /^=+\s*Description\s*$/i )
+            # Stop at new section if we already have a description
+            break unless desc.empty?
+          elsif in_desc
+            # Stop if empty line after description, or bullet (*) list
+            break if ( !desc.empty? && line =~ /^\s*$/ ) || line =~ /^\s*\*/
+            desc << line
+          end
+        end
+      end
+
+      desc = desc.
+        gsub( /\s+/, ' ' ). #Simplify whitespace
+        gsub( /\{([^\}]+)\}\[[^\]]*\]/, '\1' ). # Replace rdoc link \w anchor
+        gsub( /(\S)\[\s*http:[^\]]*\]/, '\1' ). # Replace bare rdoc links
+        strip.
+        sub( /:$/, '.' ) # Replace a final ':', like when term. at list
+
+      # Summary is first sentence if we find one, or entire desc otherwise
+      if desc =~ /^(.+[!?:.])\s/
+        self.summary = $1.strip
+        self.description = desc # Use remainder for description
+      else
+        self.summary = desc
+      end
+
+    end
+
+    private
+
+    # Open, and test hook
+    def readme_file_open( file, &block )
+      File.open( file, 'r', &block )
+    end
+
+  end
+
+end