ffi-tk 2009.11.29

data/spec/helper.rb

@@ -0,0 +1,3 @@
+require_relative '../lib/ffi-tk'
+require 'bacon'
+Bacon.summary_at_exit

data/tasks/authors.rake

@@ -0,0 +1,21 @@
+# Once git has a fix for the glibc in handling .mailmap and another fix for
+# allowing empty mail address to be mapped in .mailmap we won't have to handle
+# them manually.
+
+desc 'Update AUTHORS'
+task :authors do
+  authors = Hash.new(0)
+
+  `git shortlog -nse`.scan(/(\d+)\s(.+)\s<(.*)>$/) do |count, name, email|
+    authors[[name, email]] += count.to_i
+  end
+
+  File.open('AUTHORS', 'w+') do |io|
+    io.puts "Following persons have contributed to #{GEMSPEC.name}."
+    io.puts '(Sorted by number of submitted patches, then alphabetically)'
+    io.puts ''
+    authors.sort_by{|(n,e),c| [-c, n.downcase] }.each do |(name, email), count|
+      io.puts("%6d %s <%s>" % [count, name, email])
+    end
+  end
+end

data/tasks/bacon.rake

@@ -0,0 +1,66 @@
+desc 'Run all bacon specs with pretty output'
+task :bacon => :setup do
+  require 'open3'
+  require 'scanf'
+  require 'matrix'
+
+  specs = PROJECT_SPECS
+
+  some_failed = false
+  specs_size = specs.size
+  len = specs.map{|s| s.size }.sort.last
+  total_tests = total_assertions = total_failures = total_errors = 0
+  totals = Vector[0, 0, 0, 0]
+
+  red, yellow, green = "\e[31m%s\e[0m", "\e[33m%s\e[0m", "\e[32m%s\e[0m"
+  left_format = "%4d/%d: %-#{len + 11}s"
+  spec_format = "%d specifications (%d requirements), %d failures, %d errors"
+
+  specs.each_with_index do |spec, idx|
+    print(left_format % [idx + 1, specs_size, spec])
+
+    Open3.popen3(RUBY, spec) do |sin, sout, serr|
+      out = sout.read.strip
+      err = serr.read.strip
+
+      # this is conventional, see spec/innate/state/fiber.rb for usage
+      if out =~ /^Bacon::Error: (needed .*)/
+        puts(yellow % ("%6s %s" % ['', $1]))
+      else
+        total = nil
+
+        out.each_line do |line|
+          scanned = line.scanf(spec_format)
+
+          next unless scanned.size == 4
+
+          total = Vector[*scanned]
+          break
+        end
+
+        if total
+          totals += total
+          tests, assertions, failures, errors = total_array = total.to_a
+
+          if tests > 0 && failures + errors == 0
+            puts((green % "%6d passed") % tests)
+          else
+            some_failed = true
+            puts(red % "       failed")
+            puts out unless out.empty?
+            puts err unless err.empty?
+          end
+        else
+          some_failed = true
+          puts(red % "       failed")
+          puts out unless out.empty?
+          puts err unless err.empty?
+        end
+      end
+    end
+  end
+
+  total_color = some_failed ? red : green
+  puts(total_color % (spec_format % totals.to_a))
+  exit 1 if some_failed
+end

data/tasks/changelog.rake

@@ -0,0 +1,18 @@
+desc 'update changelog'
+task :changelog do
+  File.open('CHANGELOG', 'w+') do |changelog|
+    `git log -z --abbrev-commit`.split("\0").each do |commit|
+      next if commit =~ /^Merge: \d*/
+      ref, author, time, _, title, _, message = commit.split("\n", 7)
+      ref    = ref[/commit ([0-9a-f]+)/, 1]
+      author = author[/Author: (.*)/, 1].strip
+      time   = Time.parse(time[/Date: (.*)/, 1]).utc
+      title.strip!
+
+      changelog.puts "[#{ref} | #{time}] #{author}"
+      changelog.puts '', "  * #{title}"
+      changelog.puts '', message.rstrip if message
+      changelog.puts
+    end
+  end
+end

data/tasks/gem.rake

@@ -0,0 +1,22 @@
+require 'rake/gempackagetask'
+
+task :gemspec => [:manifest, :changelog] do
+  gemspec_file = "#{GEMSPEC.name}.gemspec"
+  File.open(gemspec_file, 'w+'){|gs| gs.puts(GEMSPEC.to_ruby) }
+end
+
+desc "package and install from gemspec"
+task :install => [:gemspec] do
+  sh "gem build #{GEMSPEC.name}.gemspec"
+  sh "gem install #{GEMSPEC.name}-#{GEMSPEC.version}.gem"
+end
+
+desc "uninstall the gem"
+task :uninstall => [:clean] do
+  sh %{gem uninstall -x #{GEMSPEC.name}}
+end
+
+Rake::GemPackageTask.new(GEMSPEC) do |p|
+  p.need_tar = true
+  p.need_zip = true
+end

data/tasks/gem_setup.rake

@@ -0,0 +1,113 @@
+task :gem_setup do
+  class GemSetup
+    def initialize(options = {}, &block)
+      @gems = []
+      @options = options.dup
+      @verbose = @options.delete(:verbose)
+
+      run(&block)
+    end
+
+    def run(&block)
+      return unless block_given?
+      instance_eval(&block)
+      setup
+    end
+
+    def gem(name, version = nil, options = {})
+      if version.respond_to?(:merge!)
+        options = version
+      else
+        options[:version] = version
+      end
+
+      @gems << [name, options]
+    end
+
+    # all gems defined, let's try to load/install them
+    def setup
+      require 'rubygems'
+      require 'rubygems/dependency_installer'
+
+      @gems.each do |name, options|
+        setup_gem(name, options)
+      end
+    end
+
+    def setup_gemspec(gemspec)
+      gemspec.dependencies.each do |dependency|
+        dependency.version_requirements.as_list.each do |version|
+          gem(dependency.name, version)
+        end
+      end
+
+      setup
+    end
+
+    # First try to activate.
+    # If activation fails, try to install and activate again.
+    # If the second activation also fails, try to require as it may just as
+    # well be in $LOAD_PATH.
+    def setup_gem(name, options)
+      version = [options[:version]].compact
+      lib_name = options[:lib] || name
+
+      log "activating #{name}"
+
+      Gem.activate(name, *version)
+    rescue Gem::LoadError
+      log "activating #{name} failed, try to install"
+
+      install_gem(name, version, options)
+    end
+
+    # tell rubygems to install a gem
+    def install_gem(name, version, options)
+      installer = Gem::DependencyInstaller.new(options)
+
+      temp_argv(options[:extconf]) do
+        log "installing #{name}"
+        installer.install(name, *version)
+      end
+
+      Gem.activate(name, *version)
+
+      log "install and final activation successful"
+    rescue Gem::GemNotFoundException => ex
+      log "installation failed: #{ex}, use normal require"
+
+      require(options[:lib] || name)
+
+      log "require successful, cannot verify version though"
+    end
+
+    # prepare ARGV for rubygems installer
+    def temp_argv(extconf)
+      if extconf ||= @options[:extconf]
+        old_argv = ARGV.clone
+        ARGV.replace(extconf.split(' '))
+      end
+
+      yield
+
+    ensure
+      ARGV.replace(old_argv) if extconf
+    end
+
+    private
+
+    def log(msg)
+      return unless @verbose
+
+      if defined?(Log)
+        Log.info(msg)
+      else
+        puts(msg)
+      end
+    end
+
+    def rubyforge; 'http://gems.rubyforge.org/' end
+    def github; 'http://gems.github.com/' end
+    def gemcutter; 'http://gemcutter.org' end
+  end
+end

data/tasks/grancher.rake

@@ -0,0 +1,12 @@
+begin
+  require 'grancher/task'
+
+  Grancher::Task.new do |g|
+    g.branch = 'gh-pages'
+    g.push_to = 'origin'
+    g.message = 'Updated website'
+    g.directory 'ydoc', 'doc'
+  end
+rescue LoadError
+  # oh well :)
+end

data/tasks/manifest.rake

@@ -0,0 +1,4 @@
+desc 'update manifest'
+task :manifest do
+  File.open('MANIFEST', 'w+'){|io| io.puts(*GEMSPEC.files) }
+end

data/tasks/rcov.rake

@@ -0,0 +1,17 @@
+desc 'code coverage'
+task :rcov => :clean do
+  specs = Dir['spec/ffi-tk/**/*.rb']
+
+  # we ignore adapter as this has extensive specs in rack already.
+  ignore = %w[ gem bacon ]
+
+  ignored = ignore.join(',')
+
+  cmd = "rcov --aggregate coverage.data --sort coverage -t --%s -x '#{ignored}' %s"
+
+  while spec = specs.shift
+    puts '', "Gather coverage for #{spec} ..."
+    html = specs.empty? ? 'html' : 'no-html'
+    sh(cmd % [html, spec])
+  end
+end

data/tasks/release.rake

@@ -0,0 +1,65 @@
+namespace :release do
+  task :prepare => [:reversion, :authors, :gemspec]
+  task :all => ['release:github', 'release:rubyforge', 'release:gemcutter']
+
+  desc 'Release on github'
+  task :github => :prepare do
+    name, version = GEMSPEC.name, GEMSPEC.version
+
+    sh('git', 'add',
+       'MANIFEST', 'CHANGELOG', 'AUTHORS',
+       "#{name}.gemspec",
+       "lib/#{name}/version.rb")
+
+    puts <<-INSTRUCTIONS
+================================================================================
+
+I added the relevant files, you can commit them, tag the commit, and push:
+
+git commit -m 'Version #{version}'
+git tag -a -m '#{version}' '#{version}'
+git push
+
+================================================================================
+    INSTRUCTIONS
+  end
+
+  desc 'Release on rubyforge'
+  task :rubyforge => ['release:prepare', :package] do
+    name, version = GEMSPEC.name, GEMSPEC.version
+
+    pkgs = Dir["pkg/#{name}-#{version}.{tgz,zip}"].map{|file|
+      "rubyforge add_file #{name} #{name} '#{version}' '#{file}'"
+    }
+
+    puts <<-INSTRUCTIONS
+================================================================================
+
+To publish to rubyforge do following:
+
+rubyforge login
+rubyforge add_release #{name} #{name} '#{version}' pkg/#{name}-#{version}.gem
+
+To publish the archives for distro packagers:
+
+#{pkgs.join "\n"}
+
+================================================================================
+    INSTRUCTIONS
+  end
+
+  desc 'Release on gemcutter'
+  task :gemcutter => ['release:prepare', :package] do
+    name, version = GEMSPEC.name, GEMSPEC.version
+
+    puts <<-INSTRUCTIONS
+================================================================================
+
+To publish to gemcutter do following:
+
+gem push pkg/#{name}-#{version}.gem
+
+================================================================================
+    INSTRUCTIONS
+  end
+end

data/tasks/reversion.rake

@@ -0,0 +1,8 @@
+desc "update version.rb"
+task :reversion do
+  File.open("lib/#{GEMSPEC.name}/version.rb", 'w+') do |file|
+    file.puts("module #{PROJECT_MODULE}")
+    file.puts('  VERSION = %p' % GEMSPEC.version.to_s)
+    file.puts('end')
+  end
+end

data/tasks/setup.rake

@@ -0,0 +1,12 @@
+desc 'install dependencies from gemspec'
+task :setup => [:gem_setup] do
+  GemSetup.new :verbose => false do
+    DEPENDENCIES.each do |name, options|
+      gem(name, options)
+    end
+
+    DEVELOPMENT_DEPENDENCIES.each do |name, options|
+      gem(name, options)
+    end
+  end
+end

data/tasks/ycov.rake

@@ -0,0 +1,84 @@
+begin
+  require 'yard'
+
+  task 'Show Documentation coverage'
+  task :ycov => ['.yardoc'] do
+    YARD::Registry.load_yardoc
+    code_objects = YARD::Registry.paths.map{|path| YARD::Registry.at(path) }
+    code_objects.delete_if{|obj| obj.type == :root }
+    without_doc, with_doc = code_objects.partition{|obj| obj.docstring.empty? }
+
+    documented = with_doc.size
+    undocumented = without_doc.size
+    total = documented + undocumented
+    percentage = (documented / 0.01) / total
+
+    puts "Documentation coverage is %d/%d (%3.1f%%)" % [documented, total, percentage]
+  end
+
+  task 'ycov-full' => ['.yardoc'] do
+    require 'builder'
+
+    YARD::Registry.load_yardoc
+    code_objects = YARD::Registry.paths.map{|path| YARD::Registry.at(path) }
+    code_objects.delete_if{|obj| obj.type == :root }
+    without_doc, with_doc = code_objects.partition{|obj| obj.docstring.empty? }
+
+    list_objects = lambda{|body, list|
+      body.table(:width => '100%') do |table|
+        list.group_by{|obj| obj.type }.
+          sort_by{|k,v| k.to_s }.each do |type, objects|
+
+          table.tr do |tr|
+            tr.th(type.to_s, :colspan => 2)
+          end
+
+          objects.sort_by{|obj| obj.path }.each do |obj|
+            table.tr do |tr|
+              tr.td obj.path
+              tr.td "#{obj.file} +#{obj.line}"
+            end
+          end
+        end
+      end
+    }
+
+    File.open('ycov.html', 'w+') do |ycov|
+      builder = Builder::XmlMarkup.new(:target => ycov, :indent=>2)
+      builder.html do |html|
+        html.head do |head|
+          head.title 'YARD Coverage report'
+        end
+
+        html.body do |body|
+          body.h1 'YARD Coverage report'
+
+          body.h2 "#{without_doc.size} Undocumented objects"
+          list_objects[body, without_doc]
+
+          body.h2 "#{with_doc.size} Documented objects"
+          list_objects[body, with_doc]
+        end
+      end
+    end
+  end
+
+  file '.yardoc' => FileList['lib/**/*.rb'] do
+    files = ['lib/**/*.rb']
+    options = ['--no-output', '--private']
+    YARD::CLI::Yardoc.run(*(options + files))
+  end
+
+  desc 'Generate YARD documentation'
+  task :yardoc => ['.yardoc'] do
+    files = ['lib/**/*.rb']
+    options = [
+      '--output-dir', 'ydoc',
+      '--readme', PROJECT_README,
+      '--db', '.yardoc',
+      '--private']
+    YARD::CLI::Yardoc.run(*(options + files))
+  end
+rescue LoadError
+  # you'll survive
+end