zorglub 0.0.1

data/tasks/git.rake

@@ -0,0 +1,38 @@
+# -*- coding: UTF-8 -*-
+#
+if HAVE_GIT
+
+namespace :git do
+
+    # A prerequisites task that all other tasks depend upon
+    task :prereqs
+
+    desc 'Show tags from the Git repository'
+    task :show_tags => 'git:prereqs' do |t|
+        puts %x/git tag/
+    end
+
+    desc 'Create a new tag in the Git repository'
+    task :create_tag => 'git:prereqs' do |t|
+        v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+        abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+        tag = "%s" % [ PROJ.version ]
+        msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+        puts "Creating Git tag '#{tag}'"
+        unless system "git tag -a -m '#{msg}' #{tag}"
+            abort "Tag creation failed"
+        end
+#        if %x/git remote/ =~ %r/^origin\s*$/
+#            unless system "git push origin #{tag}"
+#                abort "Could not push tag to remote Git repository"
+#            end
+#        end
+    end
+
+end  # namespace :git
+
+#task 'gem:release' => 'git:create_tag'
+
+end  # if HAVE_GIT
+
+# EOF

data/tasks/helpers.rb

@@ -0,0 +1,130 @@
+# -*- coding: UTF-8 -*-
+#
+require 'fileutils'
+require 'find'
+require 'date'
+#
+# Reads a file at +path+ and spits out an array of the +paragraphs+
+# specified.
+#
+#    changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+#    summary, *description = paragraphs_of('README.txt', 3, 3..8)
+#
+def paragraphs_of( path, *paragraphs )
+    title = String === paragraphs.first ? paragraphs.shift : nil
+    ary = File.read(path).delete("\r").split(/\n\n+/)
+
+    result = if title
+        tmp, matching = [], false
+        rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
+        paragraphs << (0..-1) if paragraphs.empty?
+
+        ary.each do |val|
+            if val =~ rgxp
+                break if matching
+                matching = true
+                rgxp = %r/^=+/i
+            elsif matching
+                tmp << val
+            end
+        end
+        tmp
+    else ary end
+
+    result.values_at(*paragraphs)
+end
+
+# Adds the given gem _name_ to the current project's dependency list. An
+# optional gem _version_ can be given. If omitted, the newest gem version
+# will be used.
+#
+def depend_on( name, version = nil )
+    spec = Gem::Specification.find_by_name(name)
+    version = spec.version.to_s if version.nil? and !spec.nil?
+
+    PROJ.gem.dependencies << case version
+        when nil; [name]
+        when %r/^\d/; [name, ">= #{version}"]
+        else [name, version] end
+end
+
+# Adds the given arguments to the include path if they are not already there
+#
+#def ensure_in_path( *args )
+#    args.each do |path|
+#        path = File.expand_path(path)
+#        $:.unshift(path) if test(?d, path) and not $:.include?(path)
+#    end
+#end
+
+# Find a rake task using the task name and remove any description text. This
+# will prevent the task from being displayed in the list of available tasks.
+#
+def remove_desc_for_task( names )
+    Array(names).each do |task_name|
+        task = Rake.application.tasks.find {|t| t.name == task_name}
+        next if task.nil?
+        task.instance_variable_set :@comment, nil
+    end
+end
+
+# Change working directories to _dir_, call the _block_ of code, and then
+# change back to the original working directory (the current directory when
+# this method was called).
+#
+#def in_directory( dir, &block )
+#    curdir = pwd
+#    begin
+#        cd dir
+#        return block.call
+#    ensure
+#        cd curdir
+#    end
+#end
+
+# Scans the current working directory and creates a list of files that are
+# candidates to be in the manifest.
+#
+#def manifest
+#    files = []
+#    exclude = PROJ.exclude.dup
+#    comment = %r/^\s*#/
+#
+#    # process the ignore file and add the items there to the exclude list
+#    if test(?f, PROJ.ignore_file)
+#        ary = []
+#        File.readlines(PROJ.ignore_file).each do |line|
+#            next if line =~ comment
+#            line.chomp!
+#            line.strip!
+#            next if line.nil? or line.empty?
+#
+#            glob = line =~ %r/\*\./ ? File.join('**', line) : line
+#            Dir.glob(glob).each {|fn| ary << "^#{Regexp.escape(fn)}"}
+#        end
+#        exclude.concat ary
+#    end
+#
+#    # generate a regular expression from the exclude list
+#    exclude = Regexp.new(exclude.join('|'))
+#
+#    Find.find '.' do |path|
+#        path.sub! %r/^(\.\/|\/)/o, ''
+#        next unless test ?f, path
+#        next if path =~ exclude
+#        files << path
+#    end
+#    files.sort!
+#end
+
+# We need a "valid" method that determines if a string is suitable for use
+# in the gem specification.
+#
+class Object
+    def valid?
+        return !(self.empty? or self == "\000") if self.respond_to?(:to_str)
+        return false
+    end
+end
+
+# EOF

data/tasks/notes.rake

@@ -0,0 +1,27 @@
+# -*- coding: UTF-8 -*-
+#
+if HAVE_BONES
+
+desc "Enumerate all annotations"
+task :notes do |t|
+    id = if t.application.top_level_tasks.length > 1
+        t.application.top_level_tasks.slice!(1..-1).join(' ')
+    end
+    Bones::AnnotationExtractor.enumerate(PROJ, PROJ.notes.tags.join('|'), id, :tag => true)
+end
+
+namespace :notes do
+    PROJ.notes.tags.each do |tag|
+        desc "Enumerate all #{tag} annotations"
+        task tag.downcase.to_sym do |t|
+            id = if t.application.top_level_tasks.length > 1
+                t.application.top_level_tasks.slice!(1..-1).join(' ')
+            end
+            Bones::AnnotationExtractor.enumerate(PROJ, tag, id)
+        end
+    end
+end
+
+end  # if HAVE_BONES
+
+# EOF

data/tasks/post_load.rake

@@ -0,0 +1,35 @@
+# -*- coding: UTF-8 -*-
+#
+# This file does not define any rake tasks. It is used to load some project
+# settings if they are not defined by the user.
+
+PROJ.exclude << ["^#{Regexp.escape(PROJ.ann.file)}$",
+                 "^#{Regexp.escape(PROJ.ignore_file)}$",
+                 "^#{Regexp.escape(PROJ.rdoc.dir)}/",
+                 "^#{Regexp.escape(PROJ.rcov.dir)}/"]
+
+flatten_arrays = lambda do |this,os|
+    os.instance_variable_get(:@table).each do |key,val|
+      next if key == :dependencies \
+           or key == :development_dependencies
+      case val
+      when Array; val.flatten!
+      when OpenStruct; this.call(this,val)
+      end
+    end
+  end
+flatten_arrays.call(flatten_arrays,PROJ)
+
+PROJ.changes ||= paragraphs_of(PROJ.history_file, 0..1).join("\n\n")
+
+PROJ.description ||= paragraphs_of(PROJ.readme_file, 'description').join("\n\n")
+
+PROJ.summary ||= PROJ.description.split('.').first
+
+PROJ.gem.files ||= manifest
+
+PROJ.gem.executables ||= PROJ.gem.files.find_all {|fn| fn =~ %r/^bin/}
+
+PROJ.rdoc.main ||= PROJ.readme_file
+
+# EOF

data/tasks/rdoc.rake

@@ -0,0 +1,46 @@
+# -*- coding: UTF-8 -*-
+#
+require 'rdoc/task'
+
+namespace :doc do
+    desc 'Generate RDoc documentation'
+    Rake::RDocTask.new do |rd|
+        rdoc = PROJ.rdoc
+        rd.main = rdoc.main
+        rd.rdoc_dir = rdoc.dir
+
+        incl = Regexp.new(rdoc.include.join('|'))
+        excl = Regexp.new(rdoc.exclude.join('|'))
+        files = PROJ.gem.files.find_all do |fn|
+            case fn
+            when excl; false
+            when incl; true
+            else false end
+        end
+        rd.rdoc_files.push(*files)
+        title = "#{PROJ.name}-#{PROJ.version} Documentation"
+        rf_name = PROJ.rubyforge.name
+        title = "#{rf_name}'s " + title if rf_name.valid? and rf_name != title
+        rd.options << "-t #{title}"
+        rd.options.concat(rdoc.opts)
+    end
+
+    desc 'Generate ri locally for testing'
+    task :ri => :clobber_ri do
+        sh "#{RDOC} --ri -o ri ."
+    end
+
+    task :clobber_ri do
+        rm_r 'ri' rescue nil
+    end
+end  # namespace :doc
+
+desc 'Alias to doc:rdoc'
+task :doc => 'doc:rdoc'
+
+desc 'Remove all build products'
+task :clobber => %w(doc:clobber_rdoc doc:clobber_ri)
+
+remove_desc_for_task %w(doc:clobber_rdoc)
+
+# EOF

data/tasks/rubyforge.rake

@@ -0,0 +1,54 @@
+# -*- coding: UTF-8 -*-
+#
+if PROJ.rubyforge.name.valid? && HAVE_RUBYFORGE
+
+require 'rubyforge'
+require 'rake/contrib/sshpublisher'
+
+namespace :gem do
+    desc 'Package and upload to RubyForge'
+    task :release => [:clobber, 'gem'] do |t|
+        v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+        abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+        pkg = "pkg/#{PROJ.gem._spec.full_name}"
+
+        if $DEBUG then
+            puts "release_id = rf.add_release #{PROJ.rubyforge.name.inspect}, #{PROJ.name.inspect}, #{PROJ.version.inspect}, \"#{pkg}.tgz\""
+            puts "rf.add_file #{PROJ.rubyforge.name.inspect}, #{PROJ.name.inspect}, release_id, \"#{pkg}.gem\""
+        end
+
+        rf = RubyForge.new
+        rf.configure rescue nil
+        puts 'Logging in'
+        rf.login
+
+        c = rf.userconfig
+        c['release_notes'] = PROJ.description if PROJ.description
+        c['release_changes'] = PROJ.changes if PROJ.changes
+        c['preformatted'] = true
+
+        files = Dir.glob("#{pkg}*.*")
+
+        puts "Releasing #{PROJ.name} v. #{PROJ.version}"
+        rf.add_release PROJ.rubyforge.name, PROJ.name, PROJ.version, *files
+    end
+end  # namespace :gem
+
+
+namespace :doc do
+    desc "Publish RDoc to RubyForge"
+    task :release => %w(doc:clobber_rdoc doc:rdoc) do
+        config = YAML.load(File.read(File.expand_path('~/.rubyforge/user-config.yml')))
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/#{PROJ.rubyforge.name}/"
+        remote_dir << PROJ.rdoc.remote_dir if PROJ.rdoc.remote_dir
+        local_dir = PROJ.rdoc.dir
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+    end
+end  # namespace :doc
+
+end  # if HAVE_RUBYFORGE
+
+# EOF

data/tasks/setup.rb

@@ -0,0 +1,129 @@
+# -*- coding: UTF-8 -*-
+#
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'ostruct'
+
+class OpenStruct; undef :gem; end
+
+# TODO: make my own openstruct type object that includes descriptions
+# TODO: use the descriptions to output help on the available bones options
+
+PROJ = OpenStruct.new(
+    # Project Defaults
+    :name => nil,
+    :summary => nil,
+    :description => nil,
+    :changes => nil,
+    :authors => nil,
+    :email => nil,
+    :url => "\000",
+    :version => ENV['VERSION'] || '0.0.0',
+    :exclude => %w(tmp$ bak$ ~$ CVS \.svn/ \.git/ ^pkg/),
+    :release_name => ENV['RELEASE'],
+
+    # System Defaults
+    :ruby_opts => %w(-w),
+    :libs => [],
+    :history_file => 'Changelog',
+    :readme_file => 'README.rdoc',
+    :ignore_file => '.bnsignore',
+
+    # Announce
+    :ann => OpenStruct.new(
+        :file => 'announcement.txt',
+        :text => nil,
+        :paragraphs => [],
+        :email => {
+            :from     => nil,
+            :to       => %w(ruby-talk@ruby-lang.org),
+            :server   => 'localhost',
+            :port     => 25,
+            :domain   => ENV['HOSTNAME'],
+            :acct     => nil,
+            :passwd   => nil,
+            :authtype => :plain,
+            :tls      => true,
+        }
+    ),
+
+    # Gem Packaging
+    :gem => OpenStruct.new(
+        :dependencies => [],
+        :development_dependencies => [],
+        :executables => nil,
+        :extensions => FileList['ext/**/extconf.rb'],
+        :files => nil,
+        :need_tar => true,
+        :need_zip => false,
+        :extras => {}
+    ),
+
+    # File Annotations
+    :notes => OpenStruct.new(
+        :exclude => %w(^tasks/setup\.rb$),
+        :extensions => %w(.txt .rb .erb .rdoc) << '',
+        :tags => %w(FIXME OPTIMIZE TODO)
+    ),
+
+    # Rcov
+    :rcov => OpenStruct.new(
+        :dir => 'coverage',
+        :opts => %w[--sort coverage -T -x lib/rcov],
+        :threshold => 90.0,
+        :threshold_exact => false
+    ),
+
+    # Rdoc
+    :rdoc => OpenStruct.new(
+        :opts => [],
+        :include => %w(^lib/ ^bin/ ^ext/ \.txt$ \.rdoc$),
+        :exclude => %w(extconf\.rb$),
+        :main => nil,
+        :dir => 'doc',
+        :remote_dir => nil
+    ),
+
+    # Rubyforge
+    :rubyforge => OpenStruct.new(
+        :name => "\000"
+    ),
+
+    # Rspec
+    :spec => OpenStruct.new(
+        :files => FileList['spec/**/*_spec.rb'],
+        :opts => []
+    ),
+
+    # Subversion Repository
+    :svn => OpenStruct.new(
+        :root => nil,
+        :path => '',
+        :trunk => 'trunk',
+        :tags => 'tags',
+        :branches => 'branches'
+    ),
+
+    # Test::Unit
+    :test => OpenStruct.new(
+        :files => FileList['test/**/test_*.rb'],
+        :file  => 'test/all.rb',
+        :opts  => []
+    )
+)
+
+# Load the other rake files in the tasks folder
+tasks_dir = File.expand_path(File.dirname(__FILE__))
+post_load_fn = File.join(tasks_dir, 'post_load.rake')
+rakefiles = Dir.glob(File.join(tasks_dir, '*.rake')).sort
+rakefiles.unshift(rakefiles.delete(post_load_fn)).compact!
+import(*rakefiles)
+
+# Setup the project libraries
+%w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
+
+load './tasks/constants.rb'
+load './tasks/helpers.rb'
+
+# EOF

data/tasks/spec.rake

@@ -0,0 +1,44 @@
+# -*- coding: UTF-8 -*-
+#
+#if HAVE_SPEC_RAKE_SPECTASK and not PROJ.spec.files.to_a.empty?
+require 'rspec/core/rake_task'
+#
+namespace :spec do
+
+    desc 'Run all specs with basic output'
+    RSpec::Core::RakeTask.new(:run) do |t,args|
+        t.ruby_opts = PROJ.ruby_opts
+        t.rspec_opts = PROJ.spec.opts
+        t.pattern = ENV['pattern'] if ENV['pattern']
+    end
+
+    desc 'Run all specs with text output'
+    RSpec::Core::RakeTask.new(:doc) do |t|
+        t.ruby_opts = PROJ.ruby_opts
+        t.rspec_opts = PROJ.spec.opts + ['-fs' ]
+        t.pattern = ENV['pattern'] if ENV['pattern']
+    end
+
+    desc 'Run all specs with html output'
+    RSpec::Core::RakeTask.new(:html) do |t|
+        t.ruby_opts = PROJ.ruby_opts
+        t.rspec_opts = PROJ.spec.opts + ['-fh' ]
+        t.pattern = ENV['pattern'] if ENV['pattern']
+    end
+
+    if HAVE_RCOV
+        desc 'Run all specs with RCov'
+        RSpec::Core::RakeTask.new(:rcov) do |t|
+            t.ruby_opts = PROJ.ruby_opts
+            t.rspec_opts = PROJ.spec.opts
+            t.rcov = true
+            t.rcov_opts = PROJ.rcov.opts + ['--exclude', 'spec']
+        end
+    end
+
+end  # namespace :spec
+
+desc 'Alias to spec:run'
+task :spec => 'spec:run'
+
+# EOF

data/tasks/svn.rake

@@ -0,0 +1,48 @@
+# -*- coding: UTF-8 -*-
+#
+if HAVE_SVN
+
+unless PROJ.svn.root
+    info = %x/svn info ./
+    m = %r/^Repository Root:\s+(.*)$/.match(info)
+    PROJ.svn.root = (m.nil? ? '' : m[1])
+end
+PROJ.svn.root = File.join(PROJ.svn.root, PROJ.svn.path) unless PROJ.svn.path.empty?
+
+namespace :svn do
+
+    # A prerequisites task that all other tasks depend upon
+    task :prereqs
+
+    desc 'Show tags from the SVN repository'
+    task :show_tags => 'svn:prereqs' do |t|
+        tags = %x/svn list #{File.join(PROJ.svn.root, PROJ.svn.tags)}/
+        tags.gsub!(%r/\/$/, '')
+        tags = tags.split("\n").sort {|a,b| b <=> a}
+        puts tags
+    end
+
+    desc 'Create a new tag in the SVN repository'
+    task :create_tag => 'svn:prereqs' do |t|
+        v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+        abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+
+        svn = PROJ.svn
+        trunk = File.join(svn.root, svn.trunk)
+        tag = "%s-%s" % [PROJ.name, PROJ.version]
+        tag = File.join(svn.root, svn.tags, tag)
+        msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+        puts "Creating SVN tag '#{tag}'"
+        unless system "svn cp -m '#{msg}' #{trunk} #{tag}"
+            abort "Tag creation failed"
+        end
+    end
+
+end  # namespace :svn
+
+task 'gem:release' => 'svn:create_tag'
+
+end  # if PROJ.svn.path
+
+# EOF

data/tasks/test.rake

@@ -0,0 +1,41 @@
+# -*- coding: UTF-8 -*-
+#
+if test(?e, PROJ.test.file) or not PROJ.test.files.to_a.empty?
+require 'rake/testtask'
+
+namespace :test do
+
+    Rake::TestTask.new(:run) do |t|
+        t.libs = PROJ.libs
+        t.test_files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+            else PROJ.test.files end
+        t.ruby_opts += PROJ.ruby_opts
+        t.ruby_opts += PROJ.test.opts
+    end
+
+    if HAVE_RCOV
+        desc 'Run rcov on the unit tests'
+        task :rcov => :clobber_rcov do
+            opts = PROJ.rcov.opts.dup << '-o' << PROJ.rcov.dir
+            opts = opts.join(' ')
+            files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+                else PROJ.test.files end
+            files = files.join(' ')
+            sh "#{RCOV} #{files} #{opts}"
+        end
+
+        task :clobber_rcov do
+            rm_r 'coverage' rescue nil
+        end
+    end
+
+end  # namespace :test
+
+desc 'Alias to test:run'
+task :test => 'test:run'
+
+task :clobber => 'test:clobber_rcov' if HAVE_RCOV
+
+end
+
+# EOF