xrd 0.1.0

data/tasks/clobber.rake

@@ -0,0 +1,2 @@
+desc 'Remove all build products'
+task 'clobber'

data/tasks/gem.rake

@@ -0,0 +1,70 @@
+require 'rake/gempackagetask'
+
+namespace :gem do
+  GEM_SPEC = Gem::Specification.new do |s|
+    unless s.respond_to?(:add_development_dependency)
+      puts 'The gem spec requires a newer version of RubyGems.'
+      exit(1)
+    end
+
+    s.name = PKG_NAME
+    s.version = PKG_VERSION
+    s.author = PKG_AUTHOR
+    s.email = PKG_AUTHOR_EMAIL
+    s.homepage = PKG_HOMEPAGE
+    s.summary = PKG_SUMMARY
+    s.description = PKG_DESCRIPTION
+    s.rubyforge_project = RUBY_FORGE_PROJECT
+
+    s.files = PKG_FILES.to_a
+
+    s.has_rdoc = true
+    s.extra_rdoc_files = %w( README.md )
+    s.rdoc_options.concat ['--main',  'README.md']
+
+    s.add_runtime_dependency('sporkmonger-sax-machine', '>= 0.1.1')
+
+    s.add_development_dependency('rake', '~> 0.8.3')
+    s.add_development_dependency('rspec', '~> 1.1.11')
+    s.add_development_dependency('launchy', '~> 0.3.2')
+    s.add_development_dependency('diff-lcs', '~> 1.1.2')
+
+    s.require_path = 'lib'
+  end
+
+  Rake::GemPackageTask.new(GEM_SPEC) do |p|
+    p.gem_spec = GEM_SPEC
+    p.need_tar = true
+    p.need_zip = true
+  end
+
+  desc 'Show information about the gem'
+  task :debug do
+    puts GEM_SPEC.to_ruby
+  end
+
+  desc 'Install the gem'
+  task :install => ['clobber', 'gem:package'] do
+    sh "#{SUDO} gem install --local pkg/#{GEM_SPEC.full_name}"
+  end
+
+  desc 'Uninstall the gem'
+  task :uninstall do
+    installed_list = Gem.source_index.find_name(PKG_NAME)
+    if installed_list &&
+        (installed_list.collect { |s| s.version.to_s}.include?(PKG_VERSION))
+      sh(
+        "#{SUDO} gem uninstall --version '#{PKG_VERSION}' " +
+        "--ignore-dependencies --executables #{PKG_NAME}"
+      )
+    end
+  end
+
+  desc 'Reinstall the gem'
+  task :reinstall => [:uninstall, :install]
+end
+
+desc 'Alias to gem:package'
+task 'gem' => 'gem:package'
+
+task 'clobber' => ['gem:clobber_package']

data/tasks/git.rake

@@ -0,0 +1,40 @@
+namespace :git do
+  namespace :tag do
+    desc 'List tags from the Git repository'
+    task :list do
+      tags = `git tag -l`
+      tags.gsub!("\r", '')
+      tags = tags.split("\n").sort {|a, b| b <=> a }
+      puts tags.join("\n")
+    end
+
+    desc 'Create a new tag in the Git repository'
+    task :create do
+      changelog = File.open('CHANGELOG', 'r') { |file| file.read }
+      puts '-' * 80
+      puts changelog
+      puts '-' * 80
+      puts
+
+      v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+      abort "Versions don't match #{v} vs #{PKG_VERSION}" if v != PKG_VERSION
+
+      tag = "#{PKG_NAME}-#{PKG_VERSION}"
+      msg = "Release #{PKG_NAME}-#{PKG_VERSION}"
+
+      existing_tags = `git tag -l #{PKG_NAME}-*`.split("\n")
+      if existing_tags.include?(tag)
+        warn('Tag already exists, deleting...')
+        unless system "git tag -d #{tag}"
+          abort 'Tag deletion failed.'
+        end
+      end
+      puts "Creating git tag '#{tag}'..."
+      unless system "git tag -a -m \"#{msg}\" #{tag}"
+        abort 'Tag creation failed.'
+      end
+    end
+  end
+end
+
+task 'gem:release' => 'git:tag:create'

data/tasks/metrics.rake

@@ -0,0 +1,22 @@
+namespace :metrics do
+  task :lines do
+    lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
+    for file_name in FileList['lib/**/*.rb']
+      f = File.open(file_name)
+      while line = f.gets
+        lines += 1
+        next if line =~ /^\s*$/
+        next if line =~ /^\s*#/
+        codelines += 1
+      end
+      puts "L: #{sprintf('%4d', lines)}, " +
+        "LOC #{sprintf('%4d', codelines)} | #{file_name}"
+      total_lines     += lines
+      total_codelines += codelines
+
+      lines, codelines = 0, 0
+    end
+
+    puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
+  end
+end

data/tasks/rdoc.rake

@@ -0,0 +1,26 @@
+require 'rake/rdoctask'
+
+namespace :doc do
+  desc 'Generate RDoc documentation'
+  Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir = 'doc'
+    rdoc.title    = "#{PKG_NAME}-#{PKG_VERSION} Documentation"
+    rdoc.options << '--line-numbers' << '--inline-source' <<
+      '--accessor' << 'cattr_accessor=object' << '--charset' << 'utf-8'
+    rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+    rdoc.rdoc_files.include('README', 'CHANGELOG', 'LICENSE')
+    rdoc.rdoc_files.include('lib/**/*.rb')
+  end
+
+  desc 'Generate ri locally for testing'
+  task :ri do
+    sh 'rdoc --ri -o ri .'
+  end
+
+  desc 'Remove ri products'
+  task :clobber_ri do
+    rm_r 'ri' rescue nil
+  end
+end
+
+task 'clobber' => ['doc:clobber_rdoc', 'doc:clobber_ri']

data/tasks/rubyforge.rake

@@ -0,0 +1,103 @@
+namespace :gem do
+  desc 'Package and upload to RubyForge'
+  task :release => ['gem:package'] do |t|
+    require 'rubyforge'
+
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PKG_VERSION
+    pkg = "pkg/#{GEM_SPEC.full_name}"
+
+    rf = RubyForge.new
+    rf.configure
+    puts 'Logging in...'
+    rf.login
+
+    c = rf.userconfig
+    changelog = File.open('CHANGELOG') { |file| file.read }
+    c['release_changes'] = changelog
+    c['preformatted'] = true
+
+    files = ["#{pkg}.tgz", "#{pkg}.zip", "#{pkg}.gem"]
+
+    puts "Releasing #{PKG_NAME} v. #{PKG_VERSION}"
+    rf.add_release RUBY_FORGE_PROJECT, PKG_NAME, PKG_VERSION, *files
+  end
+end
+
+namespace :doc do
+  desc 'Publish RDoc to RubyForge'
+  task :release => ['doc:rdoc'] do
+    require 'rake/contrib/sshpublisher'
+    require 'yaml'
+
+    config = YAML.load(
+      File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = RUBY_FORGE_PATH + '/api'
+    local_dir = 'doc'
+    if !File.exist?('website/api')
+      system('mkdir website/api')
+    end
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+end
+
+namespace :spec do
+  desc 'Publish specdoc to RubyForge'
+  task :release => ['spec:specdoc'] do
+    require 'rake/contrib/sshpublisher'
+    require 'yaml'
+
+    config = YAML.load(
+      File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = RUBY_FORGE_PATH + '/specdoc'
+    local_dir = 'specdoc'
+    if !File.exist?('website/specdoc')
+      system('mkdir website/specdoc')
+    end
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+
+  namespace :rcov do
+    desc 'Publish coverage report to RubyForge'
+    task :release => ['spec:rcov'] do
+      require 'rake/contrib/sshpublisher'
+      require 'yaml'
+
+      config = YAML.load(
+        File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+      )
+      host = "#{config['username']}@rubyforge.org"
+      remote_dir = RUBY_FORGE_PATH + '/coverage'
+      local_dir = 'coverage'
+      if !File.exist?('website/coverage')
+        system('mkdir website/coverage')
+      end
+      Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+    end
+  end
+end
+
+namespace :website do
+  desc 'Publish website to RubyForge'
+  task :init do
+    require 'rake/contrib/sshpublisher'
+    require 'yaml'
+
+    config = YAML.load(
+      File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+    )
+    host = "#{config['username']}@rubyforge.org"
+    remote_dir = RUBY_FORGE_PATH
+    local_dir = 'website'
+    Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+  end
+
+  desc 'Publish website to RubyForge'
+  task :release => [
+    'website:init', 'doc:release', 'spec:release', 'spec:rcov:release'
+  ]
+end

data/tasks/spec.rake

@@ -0,0 +1,71 @@
+require 'spec/rake/verify_rcov'
+
+namespace :spec do
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color', '--format', 'specdoc']
+    if RCOV_ENABLED
+      if `which rcov`.strip == ''
+        STDERR.puts 'Please install rcov:'
+        STDERR.puts 'sudo gem install relevance-rcov'
+        exit(1)
+      end
+      t.rcov = true
+    else
+      t.rcov = false
+    end
+    t.rcov_opts = [
+      '--exclude', 'spec',
+      '--exclude', '\\.rvm\\/gems',
+      '--exclude', '1\\.8\\/gems',
+      '--exclude', '1\\.9\\/gems',
+      '--exclude', '\\.rvm',
+      '--exclude', '\\/Library\\/Ruby'
+    ]
+  end
+
+  Spec::Rake::SpecTask.new(:normal) do |t|
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--color', '--format', 'specdoc']
+    t.rcov = false
+  end
+
+  if RCOV_ENABLED
+    RCov::VerifyTask.new(:verify) do |t|
+      t.threshold = 100.0
+      t.index_html = 'coverage/index.html'
+    end
+
+    task :verify => :rcov
+  end
+
+  desc 'Generate HTML Specdocs for all specs'
+  Spec::Rake::SpecTask.new(:specdoc) do |t|
+    specdoc_path = File.expand_path(
+      File.join(File.dirname(__FILE__), '../specdoc/'))
+    Dir.mkdir(specdoc_path) if !File.exist?(specdoc_path)
+
+    output_file = File.join(specdoc_path, 'index.html')
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.spec_opts = ['--format', "\"html:#{output_file}\"", '--diff']
+    t.fail_on_error = false
+  end
+
+  namespace :rcov do
+    desc 'Browse the code coverage report.'
+    task :browse => 'spec:rcov' do
+      require 'launchy'
+      Launchy::Browser.run('coverage/index.html')
+    end
+  end
+end
+
+if RCOV_ENABLED
+  desc 'Alias to spec:verify'
+  task 'spec' => 'spec:verify'
+else
+  desc 'Alias to spec:normal'
+  task 'spec' => 'spec:normal'
+end
+
+task 'clobber' => ['spec:clobber_rcov']

data/tasks/yard.rake

@@ -0,0 +1,26 @@
+require 'rake'
+
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+
+  namespace :doc do
+    desc 'Generate Yardoc documentation'
+    YARD::Rake::YardocTask.new do |yardoc|
+      yardoc.name = 'yard'
+      yardoc.options = ['--verbose']
+      yardoc.files = [
+        'lib/**/*.rb', 'ext/**/*.c', 'README', 'CHANGELOG', 'LICENSE'
+      ]
+    end
+  end
+
+  task 'clobber' => ['doc:clobber_yard']
+
+  desc 'Alias to doc:yard'
+  task 'doc' => 'doc:yard'
+rescue LoadError
+  # If yard isn't available, it's not the end of the world
+  desc 'Alias to doc:rdoc'
+  task 'doc' => 'doc:rdoc'
+end

data/website/index.html

@@ -0,0 +1,95 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+  <head>
+    <meta charset="utf-8"/>
+    <title>XRD</title>
+    <style type="text/css">
+      * {
+        font-size: 100%;
+        margin: 0;
+        padding: 0;
+      }
+      
+      body {
+        font-family: "Lucida Grande", Verdana, sans-serif;
+        margin: 1em;
+      }
+      
+      a {
+        color: #880000;
+      }
+
+      a:visited {
+        color: #333333;
+      }
+      
+      h1 {
+        font-size: 2em;
+        margin: 0 0 0.8em 0;
+        text-align: center;
+      }
+      
+      h2 {
+        font-size: 1em;
+        margin: 0.8em 0;
+      }
+      
+      p {
+        margin: 0.8em 0;
+      }
+
+      ul {
+        font-size: 0.9em;
+        margin: 0 0 0 1.5em;
+      }
+      
+      div {
+        width: 50%;
+        margin: 0 auto;
+        padding: 0.8em;
+        background-color: #AA5852;
+        border: 2px solid #C2645D;
+      }
+
+      @media print {
+        body {
+          font-size: 0.9em;
+        }
+        
+        a {
+          text-decoration: none;
+          color: #000;
+        }
+      }
+    </style>
+  </head>
+  <body>
+    <h1>XRD</h1>
+    <div>
+      <p>
+        An XRD parser and generator for Ruby.
+      </p>
+      <ul>
+        <li>
+          <a href="http://rubyforge.org/projects/xrd/">
+            Project Page
+          </a>
+        </li>
+        <li>
+          <a href="http://github.com/sporkmonger/xrd/tree/">
+            GitHub Page
+          </a>
+        </li>
+        <li><a href="/api/">API</a></li>
+        <li><a href="/specdoc/">Specifications</a></li>
+        <li><a href="/coverage/">Code Coverage</a></li>
+      </ul>
+      <p>
+        You know what to do:
+      </p>
+      <p>
+        <code>sudo gem install xrd</code>
+      </p>
+    </div>
+  </body>
+</html>