boc 0.3.2

data/devel/levitate.rb

@@ -0,0 +1,958 @@
+
+class Levitate
+  class Installer
+    def initialize
+      require 'fileutils'
+      require 'rbconfig'
+      require 'find'
+
+      rb_root = RbConfig::CONFIG["sitelibdir"]
+      @spec = []
+
+      Find.find "lib" do |source|
+        next if source == "lib"
+        next unless File.directory?(source) || File.extname(source) == ".rb"
+        dest = File.join(rb_root, source.sub(%r!\Alib/!, ""))
+        @spec << { :source => source, :dest => dest }
+      end
+    end
+  
+    def install
+      @spec.each do |entry|
+        source, dest = entry.values_at(:source, :dest)
+        if File.directory?(source)
+          unless File.directory?(dest)
+            puts "mkdir #{dest}"
+            FileUtils.mkdir(dest)
+          end
+        else
+          puts "install #{source} --> #{dest}"
+          FileUtils.install(source, dest)
+        end
+      end
+    end
+  
+    def uninstall
+      @spec.reverse.each do |entry|
+        source, dest = entry.values_at(:source, :dest)
+        if File.directory?(source)
+          if File.directory?(dest)
+            puts "rmdir #{dest}"
+            FileUtils.rmdir(dest)
+          end
+        else
+          if File.file?(dest)
+            puts "rm #{dest}"
+            FileUtils.rm(dest)
+          end
+        end
+      end
+    end
+  end
+
+  module AttrLazy
+    def attr_lazy(name, &block)
+      AttrLazy.define_reader(class << self ; self ; end, name, &block)
+    end
+
+    def attr_lazy_accessor(name, &block)
+      attr_lazy(name, &block)
+      AttrLazy.define_writer(class << self ; self ; end, name, &block)
+    end
+
+    class << self
+      def included(mod)
+        (class << mod ; self ; end).class_eval do
+          def attr_lazy(name, &block)
+            AttrLazy.define_reader(self, name, &block)
+          end
+
+          def attr_lazy_accessor(name, &block)
+            attr_lazy(name, &block)
+            AttrLazy.define_writer(self, name, &block)
+          end
+        end
+      end
+
+      def define_evaluated_reader(instance, name, value)
+        (class << instance ; self ; end).class_eval do
+          remove_method name rescue nil
+          define_method name do
+            value
+          end
+        end
+      end
+
+      def define_reader(klass, name, &block)
+        klass.class_eval do
+          remove_method name rescue nil
+          define_method name do
+            value = instance_eval(&block)
+            AttrLazy.define_evaluated_reader(self, name, value)
+            value
+          end
+        end
+      end
+
+      def define_writer(klass, name, &block)
+        klass.class_eval do
+          writer = "#{name}="
+          remove_method writer rescue nil
+          define_method writer do |value|
+            AttrLazy.define_evaluated_reader(self, name, value)
+            value
+          end
+        end
+      end
+    end
+  end
+
+  module Ruby
+    module_function
+
+    def executable
+      require 'rbconfig'
+
+      name = File.join(
+        RbConfig::CONFIG["bindir"],
+        RbConfig::CONFIG["RUBY_INSTALL_NAME"]
+      )
+
+      if RbConfig::CONFIG["host"] =~ %r!(mswin|cygwin|mingw)! and
+          File.basename(name) !~ %r!\.(exe|com|bat|cmd)\Z!i
+        name + RbConfig::CONFIG["EXEEXT"]
+      else
+        name
+      end
+    end
+
+    def run(*args)
+      cmd = [executable, *args]
+      unless system(*cmd)
+        cmd_str = cmd.map { |t| "'#{t}'" }.join(", ")
+        raise "system(#{cmd_str}) failed with status #{$?.exitstatus}"
+      end
+    end
+
+    def run_code_and_capture(code)
+      IO.popen(%{"#{executable}"}, "r+") { |pipe|
+        pipe.print(code)
+        pipe.flush
+        pipe.close_write
+        pipe.read
+      }
+    end
+
+    def run_file_and_capture(file)
+      unless File.file? file
+        raise "file does not exist: `#{file}'"
+      end
+      IO.popen(%{"#{executable}" "#{file}"}, "r") { |pipe|
+        pipe.read
+      }
+    end
+      
+    def with_warnings(value = true)
+      previous = $VERBOSE
+      $VERBOSE = value
+      begin
+        yield
+      ensure
+        $VERBOSE = previous
+      end
+    end
+      
+    def no_warnings(&block)
+      with_warnings(nil, &block)
+    end
+  end
+
+  module Util
+    module_function
+
+    def run_ruby_on_each(*files)
+      files.each { |file|
+        Ruby.run("-w", file)
+      }
+    end
+
+    def to_camel_case(str)
+      str.split('_').map { |t| t.capitalize }.join
+    end
+
+    def write_file(file)
+      contents = yield
+      File.open(file, "wb") { |out|
+        out.print(contents)
+      }
+      contents
+    end
+
+    def instance_exec2(obj, *args, &block)
+      method_name = ["_", obj.object_id, "_", Thread.current.object_id].join
+      (class << obj ; self ; end).class_eval do
+        define_method method_name, &block
+        begin
+          obj.send(method_name, *args)
+        ensure
+          remove_method method_name
+        end
+      end
+    end
+  end
+
+  include AttrLazy
+  include Util
+
+  def initialize(gem_name)
+    $LOAD_PATH.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+    require 'rubygems/package_task'
+
+    @gem_name = gem_name
+
+    yield self
+
+    self.class.instance_methods(false).select { |t|
+      t.to_s =~ %r!\Adefine_!
+    }.sort.each { |method_name|
+      send(method_name)
+    }
+  end
+
+  class << self
+    alias_method :attribute, :attr_lazy_accessor
+  end
+
+  attr_reader :gem_name
+
+  attribute :version_constant_name do
+    "VERSION"
+  end
+
+  attribute :camel_name do
+    to_camel_case(gem_name)
+  end
+
+  attribute :version do
+    catch :bail do
+      if File.file?(version_file = "./lib/#{gem_name}/version.rb")
+        require version_file
+      elsif File.file?("./lib/#{gem_name}.rb")
+        require gem_name
+      else
+        throw :bail
+      end
+      mod = Kernel.const_get(camel_name)
+      constants = mod.constants.map { |t| t.to_sym }
+      unless constants.include?(version_constant_name.to_sym)
+        throw :bail
+      end
+      mod.const_get(version_constant_name)
+    end or "0.0.0"
+  end
+
+  attribute :required_ruby_version do
+    ">= 0"
+  end
+  
+  attribute :readme_file do
+    "README.rdoc"
+  end
+  
+  attribute :history_file do
+    "CHANGES.rdoc"
+  end
+  
+  attribute :doc_dir do
+    "doc"
+  end
+  
+  attribute :spec_files do
+    Dir["./spec/*_{spec,example}.rb"]
+  end
+  
+  attribute :test_files do
+    (Dir["./test/test_*.rb"] + Dir["./test/*_test.rb"]).uniq
+  end
+  
+  attribute :cov_dir do
+    "coverage"
+  end
+  
+  attribute :spec_output_dir do
+    "rspec_output"
+  end
+
+  attribute :spec_output_file do
+    "spec.html"
+  end
+
+  attr_lazy :spec_output do
+    "#{spec_output_dir}/#{spec_output_file}"
+  end
+
+  [:gem, :tgz].each { |ext|
+    attribute ext do
+      "pkg/#{gem_name}-#{version}.#{ext}"
+    end
+  }
+
+  attribute :rcov_options do
+    # workaround for the default rspec task
+    Dir["*"].select { |f| File.directory? f }.inject(Array.new) { |acc, dir|
+      if dir == "lib"
+        acc
+      else
+        acc + ["--exclude", dir + "/"]
+      end
+    } + ["--text-report"]
+  end
+
+  attribute :readme_file do
+    "README.rdoc"
+  end
+    
+  attribute :manifest_file do
+    "MANIFEST"
+  end
+
+  attribute :generated_files do
+    []
+  end
+
+  attribute :extra_gemspec do
+    lambda { |spec| }
+  end
+
+  attribute :files do
+    if File.file? manifest_file
+      File.read(manifest_file).split("\n")
+    elsif source_control?
+      IO.popen("git ls-files") { |pipe| pipe.read.split "\n" }
+    end.to_a + [manifest_file] + generated_files
+  end
+
+  def files_in_require_paths
+    require_paths.inject([]) { |acc, dir|
+      acc + Dir.glob("#{dir}/**/*.rb")
+    }
+  end
+
+  attribute :rdoc_files do
+    files_in_require_paths
+  end
+    
+  attribute :rdoc_title do
+    "#{gem_name}: #{summary}".sub(/\.\Z/, "")
+  end
+
+  attribute :require_paths do
+    ["lib"]
+  end
+
+  attribute :rdoc_options do
+    if File.file?(readme_file)
+      ["--main", readme_file]
+    else
+      []
+    end + [
+     "--title", rdoc_title,
+    ] + (files_in_require_paths - rdoc_files).inject(Array.new) {
+      |acc, file|
+      acc + ["--exclude", file]
+    }
+  end
+
+  attribute :extra_rdoc_files do
+    [readme_file, history_file].select { |file| File.file?(file) }
+  end
+
+  attribute :browser do
+    require 'rbconfig'
+    if RbConfig::CONFIG["host"] =~ %r!darwin!
+      "open"
+    else
+      "firefox"
+    end
+  end
+
+  attribute :gemspec do
+    Gem::Specification.new do |g|
+      %w[
+        authors
+        email
+        summary
+        version
+        description
+        files
+        rdoc_options
+        extra_rdoc_files
+        require_paths
+        required_ruby_version
+        extensions
+      ].each do |param|
+        t = send(param) and g.send("#{param}=", t)
+      end
+      g.name = gem_name
+      g.has_rdoc = true
+      g.homepage = url if url
+      dependencies.each { |dep|
+        g.add_dependency(*dep)
+      }
+      development_dependencies.each { |dep|
+        g.add_development_dependency(*dep)
+      }
+      extra_gemspec.call(g)
+    end
+  end
+
+  attribute :readme_contents do
+    File.read(readme_file) rescue "FIXME: readme_file"
+  end
+  
+  attribute :sections do
+    begin
+      data = readme_contents.split(%r!^==\s*(.*?)\s*$!)
+      pairs = data[1..-1].each_slice(2).map { |section, contents|
+        [section.downcase, contents.strip]
+      }
+      Hash[*pairs.flatten]
+    rescue
+      nil
+    end
+  end
+
+  attribute :description_section do
+    "description"
+  end
+
+  attribute :summary_section do
+    "summary"
+  end
+
+  attribute :description_sentences do
+    1
+  end
+
+  attribute :summary_sentences do
+    1
+  end
+  
+  [:summary, :description].each { |section|
+    attribute section do
+      begin
+        sections[send("#{section}_section")].
+        gsub("\n", " ").
+        split(%r!\.\s+!m).
+        first(send("#{section}_sentences")).
+        join(". ").
+        concat(".").
+        sub(%r!\.+\Z!, ".")
+      rescue
+        "FIXME: #{section}"
+      end
+    end
+  }
+
+  attribute :url do
+    "http://#{username}.github.com/#{gem_name}"
+  end
+
+  attribute :username do
+    raise "username not set"
+  end
+
+  attribute :rubyforge_info do
+    nil
+  end
+
+  def authors
+    developers.map { |d| d[0] }
+  end
+
+  def email
+    developers.map { |d| d[1] }
+  end
+
+  attribute :dependencies do
+    []
+  end
+
+  attribute :development_dependencies do
+    []
+  end
+
+  attribute :developers do
+    []
+  end
+
+  attribute :extensions do
+    ["ext/#{gem_name}/extconf.rb"].select { |f| File.file? f }
+  end
+  
+  attribute :so_file do
+    unless extensions.empty?
+      require 'rbconfig'
+      "lib/" + gem_name + "." + RbConfig::CONFIG["DLEXT"]
+    end
+  end
+
+  def define_clean
+    require 'rake/clean'
+    task :clean do 
+      Rake::Task[:clobber].invoke
+    end
+  end
+
+  def define_package
+    if source_control?
+      task manifest_file do
+        create_manifest
+      end
+      CLEAN.add manifest_file
+      task :package => :clean
+      Gem::PackageTask.new(gemspec).define
+    end
+  end
+
+  def define_spec
+    unless spec_files.empty?
+      Ruby.no_warnings {
+        require 'spec/rake/spectask'
+      }
+      
+      desc "run specs"
+      Spec::Rake::SpecTask.new('spec') do |t|
+        t.spec_files = spec_files
+      end
+    
+      desc "run specs with text output"
+      Spec::Rake::SpecTask.new('text_spec') do |t|
+        t.spec_files = spec_files
+        t.spec_opts = ['-fs']
+      end
+  
+      desc "run specs with html output"
+      Spec::Rake::SpecTask.new('full_spec') do |t|
+        t.spec_files = spec_files
+        t.rcov = true
+        t.rcov_opts = rcov_options
+        t.spec_opts = ["-fh:#{spec_output}"]
+      end
+      
+      suppress_task_warnings :spec, :full_spec, :text_spec
+
+      desc "run full_spec then open browser"
+      task :show_spec => :full_spec do
+        open_browser(spec_output, cov_dir + "/index.html")
+      end
+
+      desc "run specs individually"
+      task :spec_deps do
+        run_ruby_on_each(*spec_files)
+      end
+
+      task :prerelease => [:spec, :spec_deps]
+      task :default => :spec
+
+      CLEAN.add spec_output_dir
+    end
+  end
+
+  def define_test
+    unless test_files.empty?
+      desc "run tests"
+      task :test do
+        test_files.each { |file| require file }
+
+        # if we use at_exit hook instead, it won't run before :release
+        MiniTest::Unit.new.run ARGV
+      end
+      
+      desc "run tests with coverage"
+      if ruby_18?
+        task :full_test do
+          verbose(false) {
+            sh("rcov", "-o", cov_dir, "--text-report",
+               *(test_files + rcov_options)
+            )
+          }
+        end
+      else
+        task :full_test do
+          rm_rf cov_dir
+          require 'simplecov'
+          SimpleCov.start do
+            add_filter "test/"
+            add_filter "devel/"
+          end
+          Rake::Task[:test].invoke
+        end
+      end
+      
+      desc "run full_test then open browser"
+      task :show_test => :full_test do
+        show = lambda { open_browser(cov_dir + "/index.html") }
+        if ruby_18?
+          show.call
+        else
+          SimpleCov.at_exit do
+            SimpleCov.result.format!
+            show.call
+          end
+        end
+      end
+      
+      desc "run tests individually"
+      task :test_deps do
+        run_ruby_on_each(*test_files)
+      end
+      
+      task :prerelease => [:test, :test_deps]
+      task :default => :test
+      
+      CLEAN.add cov_dir
+    end
+  end
+
+  def define_doc
+    desc "run rdoc"
+    task :doc => :clean_doc do
+      Kernel.send :gem, 'rdoc' rescue nil
+      require 'rdoc/rdoc'
+      args = (
+        gemspec.rdoc_options +
+        gemspec.require_paths.clone +
+        gemspec.extra_rdoc_files +
+        ["-o", doc_dir]
+      ).flatten.map { |t| t.to_s }
+      RDoc::RDoc.new.document args
+    end
+    
+    task :clean_doc do
+      # normally rm_rf, but mimic rake/clean output
+      rm_r(doc_dir) rescue nil
+    end
+
+    desc "run rdoc then open browser"
+    task :show_doc => :doc do
+      open_browser(doc_dir + "/index.html")
+    end
+
+    task :rdoc => :doc
+    task :clean => :clean_doc
+  end
+
+  def define_publish
+    if source_control?
+      desc "publish docs"
+      task :publish => [:clean, :check_directory, :doc] do
+        if rubyforge_info
+          user, project = rubyforge_info
+          Dir.chdir(doc_dir) do
+            sh "scp", "-r",
+               ".",
+               "#{user}@rubyforge.org:/var/www/gforge-projects/#{project}"
+          end
+        end
+        git "branch", "-D", "gh-pages"
+        git "checkout", "--orphan", "gh-pages"
+        FileUtils.rm ".git/index"
+        git "clean", "-fdx", "-e", "doc"
+        Dir["doc/*"].each { |path|
+          FileUtils.mv path, "."
+        }
+        FileUtils.rmdir "doc"
+        git "add", "."
+        git "commit", "-m", "generated by rdoc"
+        git "push", "-f", "origin", "gh-pages"
+      end
+    end
+  end
+
+  def define_install
+    desc "direct install (no gem)"
+    task :install do
+      Installer.new.install
+    end
+
+    desc "direct uninstall (no gem)"
+    task :uninstall do
+      Installer.new.uninstall
+    end
+
+    if so_file
+      dest = File.join(RbConfig::CONFIG["sitearchdir"], File.basename(so_file))
+
+      task :install => so_file do
+        puts "install #{so_file} --> #{dest}"
+        FileUtils.install(so_file, dest)
+      end
+
+      task :uninstall do
+        if File.file?(dest)
+          puts "rm #{dest}"
+          FileUtils.rm(dest)
+        end
+      end
+    end
+  end
+  
+  def define_check_directory
+    task :check_directory do
+      unless `git status` =~ %r!nothing to commit \(working directory clean\)!
+        raise "directory not clean"
+      end
+    end
+  end
+
+  def define_ping
+    task :ping do
+      require 'rbconfig'
+      %w[github.com].each { |server|
+        cmd = "ping " + (
+          if RbConfig::CONFIG["host"] =~ %r!darwin!
+            "-c2 #{server}"
+          else
+            "#{server} 2 2"
+          end
+        )
+        unless `#{cmd}` =~ %r!0% packet loss!
+          raise "No ping for #{server}"
+        end
+      }
+    end
+  end
+
+  def define_update_levitate
+    url = ENV["LEVITATE"] ||
+      "https://github.com/quix/levitate/raw/master/levitate.rb"
+    task :update_levitate do
+      if system "curl", "-s", "-o", __FILE__, url
+        if `git diff #{__FILE__}` == ""
+          puts "Already up-to-date."
+        else
+          git "commit", __FILE__, "-m", "updated levitate"
+          puts "Updated levitate."
+        end
+      else
+        raise "levitate download failed"
+      end
+    end
+  end
+
+  def define_changes
+    task :changes do
+      if File.read(history_file).index version
+        raise "version not updated"
+      end
+
+      header = "\n\n== Version #{version}\n\n"
+
+      bullets = `git log --format=%s #{last_release}..HEAD`.lines.map { |line|
+        "* #{line}"
+      }.join.chomp
+
+      write_file(history_file) do
+        File.read(history_file).sub(/(?<=#{gem_name} Changes)/) {
+          header + bullets
+        }
+      end
+    end
+  end
+
+  def last_release
+    `git tag`.lines.select { |t| t.index(gem_name) == 0 }.last.chomp
+  end
+
+  def git(*args)
+    sh "git", *args
+  end
+
+  def create_manifest
+    write_file(manifest_file) {
+      files.sort.join("\n")
+    }
+  end
+
+  def define_release
+    task :prerelease => [:clean, :check_directory, :ping, history_file]
+
+    task :finish_release do
+      git "tag", "#{gem_name}-" + version.to_s
+      git "push", "--tags", "origin", "master"
+      sh "gem", "push", gem
+    end
+
+    task :release => [:prerelease, :package, :finish_release]
+  end
+
+  def define_debug_gem
+    task :debug_gem do
+      puts gemspec.to_ruby
+    end
+  end
+
+  def define_extension
+    if source_control? or (so_file and !File.file?(so_file))
+      require 'rbconfig'
+      require 'rake/extensiontask'
+      
+      Rake::ExtensionTask.new gem_name, gemspec do |ext|
+        ext.cross_compile = true
+        ext.cross_platform = 'i386-mswin32'
+        ext.cross_compiling do |gemspec|
+          gemspec.post_install_message =
+            "U got dat binary versionation of this gemination!"
+        end
+      end
+
+      so = "lib/#{gem_name}.#{RbConfig::CONFIG["DLEXT"]}"
+      if Rake::Task[so].needed?
+        task :test => so
+      end
+
+      task :cross_native_gem do
+        Rake::Task[:gem].reenable
+        Rake.application.top_level_tasks.replace %w[cross native gem]
+        Rake.application.top_level
+      end
+
+      task :gem => :cross_native_gem
+    end
+  end
+  
+  def open_browser(*files)
+    sh(*([browser].flatten + files))
+  end
+
+  def suppress_task_warnings(*task_names)
+    task_names.each { |task_name|
+      Rake::Task[task_name].actions.map! { |action|
+        lambda { |*args|
+          Ruby.no_warnings {
+            action.call(*args)
+          }
+        }
+      }
+    }
+  end
+
+  def ruby_18?
+    RUBY_VERSION =~ %r!\A1\.8!
+  end
+
+  def source_control?
+    File.directory? ".git"
+  end
+
+  class << self
+    include Util
+
+    # From minitest, part of the Ruby source; by Ryan Davis.
+    def capture_io
+      require 'stringio'
+
+      orig_stdout, orig_stderr         = $stdout, $stderr
+      captured_stdout, captured_stderr = StringIO.new, StringIO.new
+      $stdout, $stderr                 = captured_stdout, captured_stderr
+
+      yield
+
+      return captured_stdout.string, captured_stderr.string
+    ensure
+      $stdout = orig_stdout
+      $stderr = orig_stderr
+    end
+
+    def run_doc_code(code, expected, index, instance, &block)
+      lib = File.expand_path(File.dirname(__FILE__) + "/../lib")
+      header = %{
+        $LOAD_PATH.unshift "#{lib}"
+        begin
+      }
+      footer = %{
+        rescue Exception => __levitate_exception
+          puts "raises \#{__levitate_exception.class}"
+        end
+      }
+      final_code = header + code + footer
+
+      # Sometimes code is required to be inside a file.
+      actual = nil
+      require 'tempfile'
+      Tempfile.open("run-rdoc-code") { |temp_file|
+        temp_file.print(final_code)
+        temp_file.close
+        actual = Ruby.run_file_and_capture(temp_file.path).chomp
+      }
+
+      instance_exec2(instance, expected, actual, index, &block)
+    end
+
+    def run_doc_section(file, section, instance, &block)
+      contents = File.read(file)
+      re = %r!^=+[ \t]#{Regexp.quote(section)}.*?\n(.*?)^=!m
+      if section_contents = contents[re, 1]
+        index = 0
+        section_contents.scan(%r!^(  \S.*?)(?=(^\S|\Z))!m) { |indented, unused|
+          code_sections = indented.split(%r!^  \#\#\#\# output:\s*$!)
+          code, expected = (
+            case code_sections.size
+            when 1
+              [indented, indented.scan(%r!\# => (.*?)\n!).flatten.join("\n")]
+            when 2
+              code_sections
+            else
+              raise "parse error"
+            end
+          )
+          run_doc_code(code, expected, index, instance, &block)
+          index += 1
+        }
+      else
+        raise "couldn't find section `#{section}' of `#{file}'"
+      end
+    end
+
+    def doc_to_spec(file, *sections, &block)
+      levitate = self
+      describe file do
+        sections.each { |section|
+          describe "section `#{section}'" do
+            it "should run as claimed" do
+              if block
+                levitate.run_doc_section(file, section, self, &block)
+              else
+                levitate.run_doc_section(file, section, self) {
+                  |expected, actual, index|
+                  actual.should == expected
+                }
+              end
+            end
+          end
+        }
+      end
+    end
+
+    def doc_to_test(file, *sections, &block)
+      levitate = self
+      klass = Class.new MiniTest::Unit::TestCase do
+        sections.each { |section|
+          define_method "test_#{file}_#{section}" do
+            if block
+              levitate.run_doc_section(file, section, self, &block)
+            else
+              levitate.run_doc_section(file, section, self) {
+                |expected, actual, index|
+                assert_equal expected, actual
+              }
+            end
+          end
+        }
+      end
+      Object.const_set("Test#{file}".gsub(".", ""), klass)
+    end
+  end
+end