trac4r 1.2.1 → 1.2.2

data/README.rdoc

@@ -45,6 +45,8 @@ a more Rubyesque syntax:
     # This is a bit wierd, the "!" in the first element means "none of these values"
     not_closed_nor_testing = trac.tickets.query(:status => ["!closed","test"])
 
+:include:trac.rdoc
+
 == More Info
 
 * {RDoc}[http://davetron5000.github.com/trac4r]

data/Rakefile

@@ -2,8 +2,8 @@ require 'rake/clean'
 require 'hanna/rdoctask'
 require 'rubygems'
 require 'rake/gempackagetask'
+require 'grancher'
 
-$: << '../grancher/lib'
 begin
   require 'grancher/task'
   Grancher::Task.new do |g|
@@ -12,7 +12,7 @@ begin
     g.directory 'html'
   end
 rescue LoadError
-  #puts "you may install the optional gem 'grancher'"
+  puts 'You should install the \'grancher\' gem if you wish to push to gh-pages'
 end
 
 begin
@@ -27,7 +27,7 @@ begin
     s.add_dependency('rainbow', '>= 1.0.4')
     s.add_dependency('gli', '>= 1.1.0')
     s.has_rdoc = true
-    s.extra_rdoc_files = ['README.rdoc']
+    s.extra_rdoc_files = ['README.rdoc','trac.rdoc']
     s.rdoc_options << '--title' << 'trac4r Trac Ruby Client' << '--main' << 'README.rdoc' << '-ri'
     s.require_paths << 'lib'
   end
@@ -35,8 +35,11 @@ begin
 rescue LoadError
   puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
 end
+CLOBBER.include('trac4r.gemspec')
+CLOBBER.include('pkg')
+CLOBBER.include('trac.rdoc')
 
-Rake::RDocTask.new do |rd|
+Rake::RDocTask.new(:generate_rdoc) do |rd|
   rd.main = "README.rdoc"
   rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
   rd.title = 'Ruby interface to Trac'
@@ -45,3 +48,9 @@ end
 task :default => :test
 
 task :publish_rdoc => [:rdoc,:publish]
+
+task :rdoc => [:bin_rdoc,:generate_rdoc]
+
+task :bin_rdoc do |t|
+  `bin/trac rdoc`
+end

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.2.2

data/bin/trac

@@ -160,7 +160,7 @@ command [:tickets,:ls] do |c|
         end
         printf_string.gsub!(/ - $/,'')
         if columns.include? 'summary'
-          args << wrap(ticket.summary,padding+1,global_options[:cols])
+          args << do_wrap(ticket.summary,padding+1,global_options[:cols])
           printf_string += " - %s"
         end
         printf("#{printf_string}\n",*args)
@@ -181,7 +181,7 @@ command [:tickets,:ls] do |c|
 end
 
 # Not sure about this
-def wrap(string,indent,cols)
+def do_wrap(string,indent,cols)
   cols_left = cols.to_i - indent
   raise "Your terminal is too small for formatting" if (cols_left < 5)
   return_me = ""
@@ -281,6 +281,7 @@ post do |global,command,options,args|
 end
 
 on_error do |exception|
+  raise exception
   # Error logic here
   # return false to skip default error handling
   true

data/trac.rdoc

@@ -0,0 +1,75 @@
+= <tt>trac</tt>
+
+    trac [global options] command_name [command-specific options] [--] arguments...
+
+* Use the command +help+ to get a summary of commands
+* Use the command <tt>help command_name</tt> to get a help for +command_name+
+* Use <tt>--</tt> to stop command line argument processing; useful if your arguments have dashes in them
+
+== Global Options
+These options are available for any command and are specified before the name of the command
+
+[<tt>--cols=arg</tt>] number of columns for formatting <i>( default: <tt> 136</tt>)</i>
+[<tt>--noformat</tt>] Do not format output
+
+                      By default, the output is formatted fo readability in the terminal.  By disabling this, the output is more "machine readable" and parsable by other scripts
+
+[<tt>-o, --open=arg</tt>] Command to use to open URLs <i>( default: <tt>open</tt>)</i>
+[<tt>-p, --password=arg</tt>] Your password
+[<tt>-u, --user=arg</tt>] Your username
+[<tt>--url=arg</tt>] URL to trac
+== Commands
+[<tt>help</tt>] Shows list of commands or help for one command
+[<tt>initconfig</tt>] Initialize the config file using current global options
+[<tt>newticket</tt>] Go to the new ticket web interface
+[<tt>open</tt>] Open the ticket or wiki page
+[<tt>tickets</tt>] Lists tickets
+
+=== <tt>help [command]</tt>
+
+Shows list of commands or help for one command
+
+=== <tt>initconfig </tt>
+
+Initialize the config file using current global options
+
+Initializes a configuration file where you can set default options for command line flags, but globally and on a per-command basis.  These defaults override the built-in defaults and allow you to omit commonly-used command line flags when invoking this program
+
+==== Options
+These options are specified *after* the command.
+
+[<tt>--force</tt>] force overwrite of existing config file
+=== <tt>newticket summary for the ticket</tt>
+
+Go to the new ticket web interface
+
+Navigates your browser to the web interface, initialized with the values you provide, but does not actually create the ticket
+
+==== Options
+These options are specified *after* the command.
+
+[<tt>-c, --component=arg</tt>] component
+[<tt>-p, --priority=arg</tt>] priority
+[<tt>-t, --type=arg</tt>] type
+=== <tt>open the id of the ticket or name of wiki page</tt>
+
+Open the ticket or wiki page
+
+=== <tt>tickets ticket ids (blank for all)</tt>
+
+Lists tickets
+
+*Aliases*
+* <tt><b>ls</b></tt>
+
+
+
+==== Options
+These options are specified *after* the command.
+
+[<tt>-a, --accepted</tt>] Show tickets accepted
+[<tt>-c, --component=arg</tt>] Component
+[<tt>--columns=arg</tt>] Columns to show
+[<tt>-l, --description</tt>] Show full description
+[<tt>-o, --owner=arg</tt>] Owner ("ME" for the -u user)
+[<tt>-q, --query=arg</tt>] Arbitrary query (flags are included, too)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: trac4r
 version: !ruby/object:Gem::Version 
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors: 
 - Niklas Cathro
@@ -41,6 +41,7 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
+- trac.rdoc
 files: 
 - .gitignore
 - LICENCE
@@ -54,6 +55,7 @@ files:
 - lib/trac4r/ticket.rb
 - lib/trac4r/tickets.rb
 - lib/trac4r/wiki.rb
+- trac.rdoc
 has_rdoc: true
 homepage: 
 licenses: []