taskjuggler 0.0.10 → 0.0.11

data/lib/tj3man.rb

@@ -11,79 +11,6 @@
 # published by the Free Software Foundation.
 #
 
-require 'optparse'
-require 'Tj3Config'
-require 'SyntaxReference'
-require 'UserManual'
-
-AppConfig.appName = 'tj3man'
-
-class Arguments
-
-  attr_reader :keywords, :directory, :manual
-
-  def initialize(argv)
-    @keywords = []
-    @directory = './'
-    @manual = false
-
-    opts = OptionParser.new
-    opts.banner = "#{AppConfig.softwareName} v#{AppConfig.version} - " +
-                  "#{AppConfig.packageInfo}\n\n" +
-                  "Copyright (c) #{AppConfig.copyright.join(', ')}\n" +
-                  "              by #{AppConfig.authors.join(', ')}\n\n" +
-                  "#{AppConfig.license}\n" +
-                  "For more info about #{AppConfig.softwareName} see " +
-                  "#{AppConfig.contact}\n"
-    opts.separator ''
-    opts.separator "Usage: #{AppConfig.appName} [options] [<keyword> ...]"
-    opts.separator 'Options:'
-
-    opts.on('-d', '--dir <directory>', String,
-            'directory to put the manual') do |dir|
-      @directory = dir
-    end
-    opts.on('-m', '--manual',
-            'Generate the user manual into the current directory or ' +
-            'the directory specified with the -d option.') do
-      @manual = true
-    end
-    opts.on_tail('-h', '--help', 'Show this message.') do
-      puts opts
-      exit
-    end
-    opts.on_tail('--version', 'Show version number.') do
-      puts opts.banner
-      exit
-    end
-
-    @keywords = opts.parse(argv)
-  end
-
-end
-
-def main
-  args = Arguments.new(ARGV)
-
-  man = TaskJuggler::SyntaxReference.new
-  keywords = args.keywords
-
-  if args.manual
-    TaskJuggler::UserManual.new.generate(args.directory)
-  elsif keywords.empty?
-    puts man.all.join("\n")
-  else
-    keywords.each do |keyword|
-      puts man.to_s(keyword)
-    end
-  end
-
-  #$stderr.puts "#{AppConfig.softwareName} v#{AppConfig.version} - " +
-  #             "#{AppConfig.packageInfo}\n\n"
-  #puts man.to_s(args.keyword)
-
-  exit 0
-end
-
-main()
+require 'taskjuggler/Tj3Man'
 
+exit TaskJuggler::Tj3Man.new.main()

data/lib/tj3ss_receiver.rb

@@ -11,47 +11,7 @@
 # published by the Free Software Foundation.
 #
 
-require 'Tj3SheetAppBase'
-require 'StatusSheetReceiver'
-
-# Name of the application
-AppConfig.appName = 'tj3ss_receiver'
-
-class TaskJuggler
-
-  class Tj3SsReceiver < Tj3SheetAppBase
-
-    def initialize
-      super
-    end
-
-    def processArguments(argv)
-      super do
-        @opts.banner += <<'EOT'
-This program can be used to receive filled-out status sheets via email.
-It reads the emails from STDIN and extracts the status sheet from the
-attached files. The status sheet is checked for correctness. Good status
-sheets are filed away. The sender be informed by email that the status
-sheets was accepted or rejected.
-EOT
-      end
-    end
-
-    def main
-      super
-      ts = TaskJuggler::StatusSheetReceiver.new('tj3ss_receiver')
-      @rc.configure(ts, 'global')
-      @rc.configure(ts, 'statussheets')
-      @rc.configure(ts, 'statussheets.receiver')
-      ts.workingDir = @workingDir if @workingDir
-      ts.dryRun = @dryRun
-
-      ts.processEmail
-      0
-    end
-
-  end
-
-end
+require 'taskjuggler/apps/Tj3SsReceiver'
 
 exit TaskJuggler::Tj3SsReceiver.new.main()
+

data/lib/tj3ss_sender.rb

@@ -11,82 +11,7 @@
 # published by the Free Software Foundation.
 #
 
-# This script is used to send out the time sheet templates to the employees.
-# It should be run from a cron job once a week.
-
-require 'Tj3SheetAppBase'
-require 'StatusSheetSender'
-
-# Name of the application
-AppConfig.appName = 'tj3ss_sender'
-
-class TaskJuggler
-
-  class Tj3SsSender < Tj3SheetAppBase
-
-    def initialize
-      super
-      @optsSummaryWidth = 25
-      @force = false
-      @intervalDuration = nil
-
-      @hideResource = nil
-      # The default report period end is next Wednesday 0:00.
-      @date = TjTime.now.nextDayOfWeek(3).to_s('%Y-%m-%d')
-      @resourceList = []
-    end
-
-    def processArguments(argv)
-      super do
-        @opts.banner += <<'EOT'
-This program can be used to out status sheets templates via email. It will
-generate status sheet templates for managers of the project. The project data
-will be accesses via tj3client from a running TaskJuggler server process.
-EOT
-        @opts.on('-r', '--resource <ID>', String,
-                 format('Only generate template for given resource')) do |arg|
-          @resourceList << arg
-        end
-        @opts.on('-f', '--force',
-                format('Send out a new template even if one exists ' +
-                       'already')) do |arg|
-          @force = true
-        end
-        @opts.on('--hideresource <EXPR>', String,
-                 format('Filter expression to limit the resource list')) do |arg|
-          @hideResource = arg
-        end
-        @opts.on('-i', '--interval <DURATION>', String,
-                 format('The duration of the interval. This is a number ' +
-                        'directly followed by a unit. 1w means one week ' +
-                        '(the default), 5d means 5 days and 72h means 72 ' +
-                        'hours.')) do |arg|
-          @intervalDuration = arg
-        end
-        optsEndDate
-      end
-    end
-
-    def main
-      super
-      ts = StatusSheetSender.new('tj3ss_sender')
-      @rc.configure(ts, 'global')
-      @rc.configure(ts, 'statussheets')
-      @rc.configure(ts, 'statussheets.sender')
-      ts.workingDir = @workingDir if @workingDir
-      ts.dryRun = @dryRun
-      ts.force = @force
-      ts.intervalDuration = @intervalDuration if @intervalDuration
-      ts.date = @date if @date
-      ts.hideResource = @hideResource if @hideResource
-
-      ts.sendTemplates(@resourceList)
-      0
-    end
-
-  end
-
-end
+require 'taskjuggler/apps/Tj3SsSender'
 
 exit TaskJuggler::Tj3SsSender.new.main()
 

data/lib/tj3ts_receiver.rb

@@ -11,51 +11,7 @@
 # published by the Free Software Foundation.
 #
 
-# This script is used to send out the time sheet templates to the employees.
-# It should be run from a cron job once a week.
-
-require 'Tj3SheetAppBase'
-require 'TimeSheetReceiver'
-
-# Name of the application suite
-AppConfig.appName = 'tj3ts_receiver'
-
-class TaskJuggler
-
-  class Tj3TsReceiver < Tj3SheetAppBase
-
-    def initialize
-      super
-    end
-
-    def processArguments(argv)
-      super do
-        @opts.banner += <<'EOT'
-This program can be used to receive filled-out time sheets via email.  It
-reads the emails from STDIN and extracts the time sheet from the attached
-files. The time sheet is checked for correctness. Good time sheets are filed
-away. The sender will be informed by email that the time sheets was accepted
-or rejected.
-EOT
-      end
-    end
-
-    def main
-      super
-      ts = TimeSheetReceiver.new('tj3ts_receiver')
-      @rc.configure(ts, 'global')
-      @rc.configure(ts, 'timesheets')
-      @rc.configure(ts, 'timesheets.receiver')
-      ts.workingDir = @workingDir if @workingDir
-      ts.dryRun = @dryRun
-
-      ts.processEmail
-      0
-    end
-
-  end
-
-end
+require 'taskjuggler/apps/Tj3TsReceiver'
 
 exit TaskJuggler::Tj3TsReceiver.new.main()
 

data/lib/tj3ts_sender.rb

@@ -11,69 +11,7 @@
 # published by the Free Software Foundation.
 #
 
-# This script is used to send out the time sheet templates to the employees.
-# It should be run from a cron job once a week.
-
-require 'Tj3SheetAppBase'
-require 'TimeSheetSender'
-
-# Name of the application suite
-AppConfig.appName = 'tj3ts_sender'
-
-class TaskJuggler
-
-  class Tj3TsSender < Tj3SheetAppBase
-
-    def initialize
-      super
-      @optsSummaryWidth = 22
-      @force = false
-      @intervalDuration = nil
-
-      # The default report period end is next Monday 0:00.
-      @date = TjTime.now.nextDayOfWeek(1).to_s('%Y-%m-%d')
-      @resourceList = []
-    end
-
-    def processArguments(argv)
-      super do
-        @opts.banner += <<'EOT'
-This program can be used to send out time sheets templates via email. It will
-generate time sheet templates for all resources of the project. The project
-data will be accesses via tj3client from a running TaskJuggler server process.
-EOT
-        @opts.on('-r', '--resource <ID>', String,
-                format('Only generate template for given resource')) do |arg|
-          @resourceList << arg
-        end
-        @opts.on('-f', '--force',
-                format('Send out a new template even if one exists ' +
-                       'already')) do |arg|
-          @force = true
-        end
-        optsEndDate
-      end
-    end
-
-    def main
-      super
-      ts = TimeSheetSender.new('tj3ts_sender')
-      @rc.configure(ts, 'global')
-      @rc.configure(ts, 'timesheets')
-      @rc.configure(ts, 'timesheets.sender')
-      ts.workingDir = @workingDir if @workingDir
-      ts.dryRun = @dryRun
-      ts.force = @force
-      ts.intervalDuration = @intervalDuration if @intervalDuration
-      ts.date = @date if @date
-
-      ts.sendTemplates(@resourceList)
-      0
-    end
-
-  end
-
-end
+require 'taskjuggler/apps/Tj3TsSender'
 
 exit TaskJuggler::Tj3TsSender.new.main()
 

data/lib/tj3ts_summary.rb

@@ -11,78 +11,7 @@
 # published by the Free Software Foundation.
 #
 
-# This script is used to send out the time sheet templates to the employees.
-# It should be run from a cron job once a week.
-
-require 'Tj3SheetAppBase'
-require 'TimeSheetSummary'
-
-# Name of the application
-AppConfig.appName = 'tj3ts_summary'
-
-class TaskJuggler
-
-  class Tj3TsSummary < Tj3SheetAppBase
-
-    def initialize
-      super
-
-      # The default report period end is next Monday 0:00.
-      @date = TjTime.now.nextDayOfWeek(1).to_s('%Y-%m-%d')
-      @resourceList = []
-      @sheetRecipients = []
-      @digestRecipients = []
-    end
-
-    def processArguments(argv)
-      super do
-        @opts.banner += <<'EOT'
-This program can be used to send out individual copies and a summary of all
-accepted time sheets a list of email addresses. The directory structures for
-templates and submitted time sheets must be present. The project data will be
-accesses via tj3client from a running TaskJuggler server process.
-EOT
-        @opts.on('-r', '--resource <ID>', String,
-                 format('Only generate summary for given resource')) do |arg|
-          @resourceList << arg
-        end
-        @opts.on('-t', '--to <EMAIL>', String,
-                 format('Send all individual reports and a summary report ' +
-                        'to this email address')) do |arg|
-          @sheetRecipients << arg
-          @digestRecipients << arg
-        end
-        @opts.on('--sheet <EMAIL>', String,
-                 format('Send all reports to this email address')) do |arg|
-          @sheetRecipients << arg
-        end
-        @opts.on('--digest <EMAIL>', String,
-                 format('Send a summary report to this email address')) do |arg|
-          @digestRecipients << arg
-        end
-        optsEndDate
-      end
-    end
-
-    def main
-      super
-      ts = TimeSheetSummary.new
-      @rc.configure(ts, 'global')
-      @rc.configure(ts, 'timesheets')
-      @rc.configure(ts, 'timesheets.summary')
-      ts.workingDir = @workingDir if @workingDir
-      ts.dryRun = @dryRun
-      ts.date = @date if @date
-      ts.sheetRecipients += @sheetRecipients
-      ts.digestRecipients += @digestRecipients
-
-      ts.sendSummary(@resourceList)
-      0
-    end
-
-  end
-
-end
+require 'taskjuggler/apps/Tj3TsSummary'
 
 exit TaskJuggler::Tj3TsSummary.new.main()
 

data/manual/How_To_Contribute

@@ -18,18 +18,11 @@ TaskJuggler software releases.
 ==== Preparing a contribution ====
 
 All TaskJuggler development is coordinated using the
-[http://git.or.cz/ Git revision control system]. All changes must be
-submitted using Git so that we can track the authorship of each
-submission. To contribute you need to have at least Git version 1.5.0
-installed. Git was developed as a tool for the Linux Kernel
-developers but is now very popular with many other Open Source
-projects as well. Git and the TaskJuggler development environment are
-primarily designed to be used on Linux or Unix-like systems. While it
-is possible to use it on other systems such as Microsoft Windows, we
-do not recommend this. If you can't switch to a Linux installation
-for your TaskJuggler contributions, you should consider using a Linux
-Live (or bootable) CD/DVD or use a VmWare Player image of a Linux
-distribution.
+[https://github.com/taskjuggler/TaskJuggler/issues github source code
+management platform]. All changes must be submitted using Git github
+so that we can track the authorship of each submission. There is
+[http://help.github.com/ excellent documentation] available on how to
+use github. 
 
 Make sure you have followed the steps described in the
 [Installation.html#Installation_Steps_for_Developers Installation
@@ -50,14 +43,7 @@ with full user names and valid email addresses.
 Next you need to find the files where you want to make your
 modifications. Sometimes files will be generated from other files. Do
 not change those generated files. Your changes will be overwritten the
-next time you call the make utility. To identify those files, some
-familiarity with make and other Linux tools are helpful. Whenever
-there is a file with the same base name and the extension .in in the
-same directory, then the file is generated from the .in-file. You need
-to modify the .in-file, not the one with just the base name. Another
-indicator is the fact that the file is not part of the repository.
-With few exceptions the repository does not contain any generated
-files.
+next time you call the make utility.
 
 ==== Creating a Patch ====
 
@@ -81,14 +67,15 @@ changes that have an impact on the generated files. Do not change
 indentation or line wrapping of paragraphs unless absolutely
 necessary. These kinds of changes increase the size of diff files and
 make it much harder to evaluate the patches. When making changes to
-the program code, please use exactly the same coding style. If your
-contribution is large enough to justify a copyright claim, please
-indicate what copyright you claim in the patch. For modifications to
-existing files, we will assume that your contribution falls under the
-same license as the modified file. All new files will need to contain
-a license declaration, preferably GPL version 2. In any case, the
-license must be [http://www.opensource.org/licenses an OSI accepted
-license] and be compatible with the rest of the project.
+the program code, please use exactly the same coding style as the
+rest of the code. If your contribution is large enough to justify a
+copyright claim, please indicate what copyright you claim in the
+patch. For modifications to existing files, we will assume that your
+contribution falls under the same license as the modified file. All
+new files will need to contain a license declaration, preferably GPL
+version 2. In any case, the license must be
+[http://www.opensource.org/licenses an OSI accepted license] and be
+compatible with the GPL version 2 used by the rest of the project.
 
 Review all changes carefully. In case you have created new source
 files, you need to register them with your repository.
@@ -100,29 +87,12 @@ repository.
 
  git commit -a
 
-Whenever you have made a certain change or added a certain feature,
-you should commit your changes to your local repository. This keeps
-patches small and makes reviewing them easier. The easier your patches
-can be reviewed, the more likely they will get in.
+And then push it into your forked github repository.
 
-The final step to submit your changes is to package them up and sign
-them. It is always a good idea to check for upstream changes again.
+ git push
 
- git pull
-
-This makes sure you are really committing your patches against the
-latest version of the source code. In case there were upstream
-changes, you need to merge them first. Usually Git does this
-automatically. Refer to the
-[http://www.kernel.org/pub/software/scm/git/docs/user-manual.html Git
-manual] for details on resolving conflicts during merges. Now you can
-create the patch or patch-set.
-
- git format-patch -s origin
-
-This will generate a number of files starting with 5-digit file names.
-You then need to attach these files to a posting in the
-[http://www.taskjuggler.org/forum.php TaskJuggler Developer Forum].
+The final step is to send us a [http://help.github.com/pull-requests/
+pull request] for your changes.
 
 ==== Contributing to the User Manual ====