rtrac-utils 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-04-11
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 ELC Technologies
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/rtrac-cards
+config/hoe.rb
+config/requirements.rb
+lib/rtrac-utils.rb
+lib/rtrac-utils/version.rb
+lib/rtrac-utils/rtrac_cards.rb
+log/debug.log
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+spec/spec_helper.rb
+spec/rtrac-utils_spec.rb
+spec/rtrac-utils/rtrac_cards_spec.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,51 @@
+= rtrac-utils
+
+* http://rubyforge.org/projects/rtrac-utils 
+
+== DESCRIPTION:
+
+rtrac-utils is a suite of power-user Trac ticket utilities to make your Trac project run more smoothly.
+
+== FEATURES/PROBLEMS:
+
+* rtrac-cards:  export your Trac tickets to index-card-size PDF's
+  * supports 3x5 and 4x6 sizes
+  * print only one milestone or all tickets
+
+== SYNOPSIS:
+
+   rtrac-cards --milestone="Some Milestone"
+
+== REQUIREMENTS:
+
+* rtrac
+* pdf-writer
+
+== INSTALL:
+
+sudo gem install -y rtrac-utils
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/rtrac-cards

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-4-15.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+  require File.dirname(__FILE__) + '/../lib/rtrac-utils'
+rescue LoadError
+   puts "Error loading dependencies."
+end
+
+include RtracUtils
+
+require 'optparse'
+
+# NOTE: the option -p/--path= is given as an example, and should probably be replaced in your application.
+
+OPTIONS = {
+  :path     => '~',
+  :file     => 'trac.pdf',
+  :size     => '4x6'
+}
+MANDATORY_OPTIONS = %w( )
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Export a PDF of your Trac tickets for printing to index cards.  
+Be sure to set up your Rtrac configuration file before executing.  This is usually kept at ~/.rtrac.yml.
+
+Usage: #{File.basename($0)} [options]
+
+Options are:
+BANNER
+  opts.separator ""
+  opts.on("-p", "--path=PATH", String,
+          "The root path for selecting files",
+          "Default: ~") { |OPTIONS[:path]| }
+  opts.on("-h", "--help",
+          "Show this help message.") { puts opts; exit }
+  opts.on("-m", "--milestone=MILESTONE", String,
+          "Milestone to print",
+          "Default: ALL") { |OPTIONS[:milestone]| }
+  opts.on("-s", "--size=SIZE", String,
+          "Paper size (one of 3x5 or 4x6)",
+          "Default: 4x6") { |OPTIONS[:paper]| }
+  opts.on("-o", "--output=FILE", String,
+          "Output file",
+          "Default: trac.pdf") { |OPTIONS[:file]| }
+
+  opts.parse!(ARGV)
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+    puts opts; exit
+  end
+end
+
+path = OPTIONS[:path]
+
+OPTIONS[:paper] = OPTIONS[:paper]=='3x5' ? :is_3x5 : :is_4x6
+
+RtracUtils::RtracCards.write!(OPTIONS[:file], OPTIONS)

data/config/hoe.rb

@@ -0,0 +1,74 @@
+require 'rtrac-utils/version'
+
+AUTHOR = 'T.J. VanSlyke'  # can also be an array of Authors
+EMAIL = "tj@elctech.com"
+DESCRIPTION = "a suite of utilities for use with Josh Stephenson's Rtrac gem"
+GEM_NAME = 'rtrac-utils' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'rtrac-utils' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = YAML.load(`svn info`)['Revision']
+VERS = RtracUtils::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'rtrac-utils documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = 
+     [
+        ['rtrac',      '1.0.2'],
+        ['pdf-writer', '1.1.8']
+     ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/rtrac-utils.rb

@@ -0,0 +1,13 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+gem 'rtrac'
+gem 'pdf-writer'
+require 'rtrac'
+require 'pdf/writer'
+require File.dirname(__FILE__) + '/rtrac-utils/rtrac_cards'
+
+module RtracUtils
+  
+end

data/lib/rtrac-utils/rtrac_cards.rb

@@ -0,0 +1,44 @@
+module RtracUtils
+   class RtracCards
+
+      def self.message(text)
+         puts "rtrac-cards: #{text}"
+      end
+
+      # Needed because Rtrac currently only allows pulling a 
+      # given number of tickets.
+      MAX_FIXNUM = 999
+
+      def self.write!(file, options={})
+         file = File.new(file, "w") if file.is_a? String
+
+         message 'Retreiving tickets...'
+         if !options[:milestone] || options[:milestone] == :all
+            tickets = Rtrac::Base.get_tickets(MAX_FIXNUM)
+         else
+            milestone = options[:milestone]
+            tickets = Rtrac::Base.get_by_milestone(milestone)
+         end
+
+
+         if options[:paper] == :is_3x5
+            paper = [ 12.7, 7.62 ]
+         else
+            paper = [ 15.24, 10.16 ]
+         end
+         pdf = PDF::Writer.new(:paper => paper)
+
+         message 'Exporting pages...'
+         tickets.each do |id|
+            ticket = Rtrac::Ticket.new(id)
+            puts ">> #{ticket.summary}"
+            pdf.text "##{id}",       :font_size => 12, :justification => :right
+            pdf.text ticket.summary, :font_size => 14, :justification => :left
+            pdf.start_new_page
+         end
+
+         pdf.save_as(file.path)
+      end
+   end
+end
+

data/lib/rtrac-utils/version.rb

@@ -0,0 +1,9 @@
+module RtracUtils #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rtrac-utils.rb'}"
+puts "Loading rtrac-utils gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,74 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+begin
+  require 'newgem'
+rescue LoadError
+  puts "\n\nGenerating the website requires the newgem RubyGem"
+  puts "Install: gem install newgem\n\n"
+  exit(1)
+end
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/rtrac-utils/version.rb'
+
+version  = RtracUtils::VERSION::STRING
+download = 'http://rubyforge.org/projects/rtrac-utils'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)