### Home Classes Methods

### In Files

- lib/taskjuggler/AppConfig.rb

### Parent

Object

### Methods

- ::appName
- ::appName=
- ::authors
- ::authors=
- ::contact
- ::contact=
- ::copyright
- ::copyright=
- ::dataDirs
- ::dataFile
- ::dataFiles
- ::dataSearchDirs
- ::license
- ::license=
- ::new
- ::packageInfo
- ::packageInfo=
- ::packageName
- ::packageName=
- ::softwareName
- ::softwareName=
- ::version
- ::version=

### Files

- CHANGELOG
- COPYING
- README.rdoc

### Class/Module Index

Quicksearch

- TaskJuggler
- TaskJuggler::Account
- TaskJuggler::AccountAttribute
- TaskJuggler::AccountCredit
- TaskJuggler::AccountCreditListAttribute
- TaskJuggler::AccountListRE
- TaskJuggler::AccountScenario
- TaskJuggler::AlertLevelDefinition
- TaskJuggler::AlertLevelDefinitions
- TaskJuggler::Allocation
- TaskJuggler::AllocationAttribute
- TaskJuggler::AttributeBase
- TaskJuggler::AttributeDefinition
- TaskJuggler::AttributeOverwrite
- TaskJuggler::BatchProcessor
- TaskJuggler::Booking
- TaskJuggler::BookingListAttribute
- TaskJuggler::BooleanAttribute
- TaskJuggler::CSVFile
- TaskJuggler::CellSettingPattern
- TaskJuggler::CellSettingPatternList
- TaskJuggler::Charge
- TaskJuggler::ChargeListAttribute
- TaskJuggler::ChargeSet
- TaskJuggler::ChargeSetListAttribute
- TaskJuggler::ChartPlotter
- TaskJuggler::ChartPlotterError
- TaskJuggler::CollisionDetector
- TaskJuggler::ColumnListAttribute
- TaskJuggler::ColumnTable
- TaskJuggler::Daemon
- TaskJuggler::DaemonConnector
- TaskJuggler::DaemonConnectorMixin
- TaskJuggler::DataCache
- TaskJuggler::DataCacheEntry
- TaskJuggler::DateAttribute
- TaskJuggler::DefinitionListAttribute
- TaskJuggler::DependencyListAttribute
- TaskJuggler::DurationAttribute
- TaskJuggler::ExportRE
- TaskJuggler::FileList
- TaskJuggler::FileRecord
- TaskJuggler::FixnumAttribute
- TaskJuggler::FlagListAttribute
- TaskJuggler::FloatAttribute
- TaskJuggler::FormatListAttribute
- TaskJuggler::GanttChart
- TaskJuggler::GanttContainer
- TaskJuggler::GanttHeader
- TaskJuggler::GanttHeaderScaleItem
- TaskJuggler::GanttLine
- TaskJuggler::GanttLoadStack
- TaskJuggler::GanttMilestone
- TaskJuggler::GanttRouter
- TaskJuggler::GanttTaskBar
- TaskJuggler::HTMLDocument
- TaskJuggler::HTMLElements
- TaskJuggler::HTMLGraphics
- TaskJuggler::ICalReport
- TaskJuggler::ICalendar
- TaskJuggler::ICalendar::Component
- TaskJuggler::ICalendar::Event
- TaskJuggler::ICalendar::Journal
- TaskJuggler::ICalendar::Person
- TaskJuggler::ICalendar::Todo
- TaskJuggler::Interval
- TaskJuggler::IntervalList
- TaskJuggler::JobInfo
- TaskJuggler::Journal
- TaskJuggler::JournalEntry
- TaskJuggler::JournalEntryList
- TaskJuggler::JournalSortListAttribute
- TaskJuggler::KateSyntax
- TaskJuggler::KeywordArray
- TaskJuggler::KeywordDocumentation
- TaskJuggler::Leave
- TaskJuggler::LeaveAllowance
- TaskJuggler::LeaveAllowanceList
- TaskJuggler::LeaveAllowanceListAttribute
- TaskJuggler::LeaveList
- TaskJuggler::LeaveListAttribute
- TaskJuggler::Limits
- TaskJuggler::Limits::Limit
- TaskJuggler::LimitsAttribute
- TaskJuggler::ListAttributeBase
- TaskJuggler::Log
- TaskJuggler::LogicalAttribute
- TaskJuggler::LogicalExpression
- TaskJuggler::LogicalExpressionAttribute
- TaskJuggler::LogicalExpressionListAttribute
- TaskJuggler::LogicalFlag
- TaskJuggler::LogicalFunction
- TaskJuggler::LogicalOperation
- TaskJuggler::ManagerResponsibilities
- TaskJuggler::ManagerStatusRecord
- TaskJuggler::Message
- TaskJuggler::MessageHandler
- TaskJuggler::MessageHandlerInstance
- TaskJuggler::MspXmlRE
- TaskJuggler::Navigator
- TaskJuggler::NavigatorElement
- TaskJuggler::NikuProject
- TaskJuggler::NikuReport
- TaskJuggler::NikuResource
- TaskJuggler::NodeListAttribute
- TaskJuggler::PTNProxy
- TaskJuggler::Painter
- TaskJuggler::Painter::Circle
- TaskJuggler::Painter::Color
- TaskJuggler::Painter::Element
- TaskJuggler::Painter::Ellipse
- TaskJuggler::Painter::FontMetrics
- TaskJuggler::Painter::FontMetricsData
- TaskJuggler::Painter::Group
- TaskJuggler::Painter::Line
- TaskJuggler::Painter::Points
- TaskJuggler::Painter::PolyLine
- TaskJuggler::Painter::Primitives
- TaskJuggler::Painter::Rect
- TaskJuggler::Painter::SVGSupport
- TaskJuggler::Painter::Text
- TaskJuggler::PlaceHolderCell
- TaskJuggler::ProcessIntercom
- TaskJuggler::ProcessIntercomIface
- TaskJuggler::Project
- TaskJuggler::ProjectBroker
- TaskJuggler::ProjectBrokerIface
- TaskJuggler::ProjectFileParser
- TaskJuggler::ProjectFileScanner
- TaskJuggler::ProjectRecord
- TaskJuggler::ProjectServer
- TaskJuggler::ProjectServerIface
- TaskJuggler::PropertyAttribute
- TaskJuggler::PropertyList
- TaskJuggler::PropertySet
- TaskJuggler::PropertyTreeNode
- TaskJuggler::Query
- TaskJuggler::RTFHandlers
- TaskJuggler::RTFNavigator
- TaskJuggler::RTFQuery
- TaskJuggler::RTFReport
- TaskJuggler::RTFReportLink
- TaskJuggler::RTFWithQuerySupport
- TaskJuggler::RealFormat
- TaskJuggler::RealFormatAttribute
- TaskJuggler::ReferenceAttribute
- TaskJuggler::Report
- TaskJuggler::ReportBase
- TaskJuggler::ReportContext
- TaskJuggler::ReportScenario
- TaskJuggler::ReportServer
- TaskJuggler::ReportServerIface
- TaskJuggler::ReportServerRecord
- TaskJuggler::ReportServlet
- TaskJuggler::ReportTable
- TaskJuggler::ReportTableCell
- TaskJuggler::ReportTableColumn
- TaskJuggler::ReportTableLegend
- TaskJuggler::ReportTableLine
- TaskJuggler::Resource
- TaskJuggler::ResourceListAttribute
- TaskJuggler::ResourceListRE
- TaskJuggler::ResourceScenario
- TaskJuggler::RichText
- TaskJuggler::RichTextAttribute
- TaskJuggler::RichTextDocument
- TaskJuggler::RichTextElement
- TaskJuggler::RichTextFunctionExample
- TaskJuggler::RichTextFunctionHandler
- TaskJuggler::RichTextImage
- TaskJuggler::RichTextIntermediate
- TaskJuggler::RichTextParser
- TaskJuggler::RichTextScanner
- TaskJuggler::RichTextSnip
- TaskJuggler::RichTextSyntaxRules
- TaskJuggler::Scenario
- TaskJuggler::ScenarioData
- TaskJuggler::ScenarioListAttribute
- TaskJuggler::Scoreboard
- TaskJuggler::ScoreboardInterval
- TaskJuggler::SheetHandlerBase
- TaskJuggler::SheetReceiver
- TaskJuggler::SheetSender
- TaskJuggler::Shift
- TaskJuggler::ShiftAssignment
- TaskJuggler::ShiftAssignments
- TaskJuggler::ShiftAssignmentsAttribute
- TaskJuggler::ShiftScenario
- TaskJuggler::SimpleQueryExpander
- TaskJuggler::SortListAttribute
- TaskJuggler::StatusSheetReceiver
- TaskJuggler::StatusSheetReport
- TaskJuggler::StatusSheetSender
- TaskJuggler::StdIoWrapper
- TaskJuggler::StringAttribute
- TaskJuggler::SymbolAttribute
- TaskJuggler::SymbolListAttribute
- TaskJuggler::SyntaxReference
- TaskJuggler::TOCEntry
- TaskJuggler::TSResourceRecord
- TaskJuggler::TSTaskRecord
- TaskJuggler::TableColumnDefinition
- TaskJuggler::TableColumnSorter
- TaskJuggler::TableOfContents
- TaskJuggler::TableReport
- TaskJuggler::TableReportColumn
- TaskJuggler::TagFile
- TaskJuggler::TagFile::TagFileEntry
- TaskJuggler::Task
- TaskJuggler::TaskDepListAttribute
- TaskJuggler::TaskDependency
- TaskJuggler::TaskListAttribute
- TaskJuggler::TaskListRE
- TaskJuggler::TaskScenario
- TaskJuggler::TernarySearchTree
- TaskJuggler::TextFormatter
- TaskJuggler::TextParser
- TaskJuggler::TextParser::Macro
- TaskJuggler::TextParser::MacroTable
- TaskJuggler::TextParser::Pattern
- TaskJuggler::TextParser::Rule
- TaskJuggler::TextParser::Scanner
- TaskJuggler::TextParser::Scanner::BufferStreamHandle
- TaskJuggler::TextParser::Scanner::FileStreamHandle
- TaskJuggler::TextParser::Scanner::MacroStackEntry
- TaskJuggler::TextParser::Scanner::StreamHandle
- TaskJuggler::TextParser::SourceFileInfo
- TaskJuggler::TextParser::StackElement
- TaskJuggler::TextParser::State
- TaskJuggler::TextParser::StateTransition
- TaskJuggler::TextParser::TextParserResultArray
- TaskJuggler::TextParser::TokenDoc
- TaskJuggler::TextReport
- TaskJuggler::TimeInterval
- TaskJuggler::TimeIntervalListAttribute
- TaskJuggler::TimeSheet
- TaskJuggler::TimeSheetReceiver
- TaskJuggler::TimeSheetRecord
- TaskJuggler::TimeSheetReport
- TaskJuggler::TimeSheetSender
- TaskJuggler::TimeSheetSummary
- TaskJuggler::TimeSheets
- TaskJuggler::Tj3
- TaskJuggler::Tj3AppBase
- TaskJuggler::Tj3Client
- TaskJuggler::Tj3Daemon
- TaskJuggler::Tj3Man
- TaskJuggler::Tj3SheetAppBase
- TaskJuggler::Tj3SsReceiver
- TaskJuggler::Tj3SsSender
- TaskJuggler::Tj3TsReceiver
- TaskJuggler::Tj3TsSender
- TaskJuggler::Tj3TsSummary
- TaskJuggler::Tj3WebD
- TaskJuggler::TjException
- TaskJuggler::TjRuntimeError
- TaskJuggler::TjTime
- TaskJuggler::TjpExample
- TaskJuggler::TjpExportRE
- TaskJuggler::TjpSyntaxRules
- TaskJuggler::TraceReport
- TaskJuggler::URLParameter
- TaskJuggler::UserManual
- TaskJuggler::VimSyntax
- TaskJuggler::WebServer
- TaskJuggler::WelcomePage
- TaskJuggler::WorkingHours
- TaskJuggler::WorkingHoursAttribute
- TaskJuggler::XMLBlob
- TaskJuggler::XMLComment
- TaskJuggler::XMLDocument
- TaskJuggler::XMLElement
- TaskJuggler::XMLNamedText
- TaskJuggler::XMLText
- Diff
- Diff::Hunk
- AppConfig
- Diffable
- DiffableString
- Object
- RuntimeConfig
- String

No matching classes.

# AppConfig

This class provides central management of configuration data to an application. It stores the version number, the name of the application and the suite it belongs to. It also holds copyright and license information. These infos have to be set in the main module of the application right after launch. Then, all other modules can retrieve them from the global instance as needed.

### Public Class Methods

appName() click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 70
    def AppConfig.appName
      @@appName
    end

appName=(name) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 66
    def AppConfig.appName=(name)
      @@appName = name
    end

authors() click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 78
    def AppConfig.authors
      @@authors
    end

authors=(authors) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 74
    def AppConfig.authors=(authors)
      @@authors = authors
    end

contact() click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 94
    def AppConfig.contact
      @@contact
    end

contact=(contact) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 90
    def AppConfig.contact=(contact)
      @@contact = contact
    end

copyright() click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 86
    def AppConfig.copyright
      @@copyright
    end

copyright=(copyright) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 82
    def AppConfig.copyright=(copyright)
      @@copyright = copyright
    end

dataDirs(baseDir = 'data') click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 106
    def AppConfig.dataDirs(baseDir = 'data')
      dirs = dataSearchDirs(baseDir)
      # Remove non-existing directories from the list again
      dirs.delete_if do |dir|
        !File.exists?(dir.untaint)
      end
      dirs
    end

dataFile(fileName) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 150
    def AppConfig.dataFile(fileName)
      dirs = dataDirs
      dirs.each { |d| return d + fileName if File.exist?(d + fileName) }

      nil
    end

dataFiles(fileName) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 142
    def AppConfig.dataFiles(fileName)
      files = []
      dirs = dataDirs
      dirs.each { |d| files << d + fileName if File.exist?(d + fileName) }

      files
    end

dataSearchDirs(baseDir = 'data') click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 115
    def AppConfig.dataSearchDirs(baseDir = 'data')
      rubyLibDir = RbConfig::CONFIG['rubylibdir']
      rubyBaseDir, versionDir = rubyLibDir.scan(/(.*\/)(.*)/)[0]

      dirs = []
      if ENV['TASKJUGGLER_DATA_PATH']
        ENV['TASKJUGGLER_DATA_PATH'].split(':').each do |path|
          dirs << path + "/#{baseDir}/"
        end
      end

      # Find the data dir relative to the source of this file. This should
      # always work.
      dirs << File.join(File.dirname(__FILE__), '..', '..', baseDir)

      # This hopefully works for all setups. Otherwise we have to add more
      # alternative pathes.
      # This one is for RPM based distros like Novell
      dirs << rubyBaseDir + "gems/" + versionDir + '/gems/'          + @@packageName + '-' + @@version + "/#{baseDir}/"
      # This one is for Debian based distros
      dirs << rubyLibDir + '/gems/'          + @@packageName + '-' + @@version + "/#{baseDir}/"

      dirs
    end

license() click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 102
    def AppConfig.license
      @@license
    end

license=(license) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 98
    def AppConfig.license=(license)
      @@license = license
    end

new() click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 22
    def initialize
      @@version = '0.0.0'
      @@packageName = 'unnamed'
      @@softwareName = 'unnamed'
      @@packageInfo = 'no info'
      @@appName = 'unnamed'
      @@authors = []
      @@copyright = []
      @@contact = 'not specified'
      @@license = 'no license'
    end

packageInfo() click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 62
    def AppConfig.packageInfo
      @@packageInfo
    end

packageInfo=(info) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 58
    def AppConfig.packageInfo=(info)
      @@packageInfo = info
    end

packageName() click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 46
    def AppConfig.packageName
      @@packageName
    end

packageName=(name) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 42
    def AppConfig.packageName=(name)
      @@packageName = name
    end

softwareName() click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 54
    def AppConfig.softwareName
      @@softwareName
    end

softwareName=(name) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 50
    def AppConfig.softwareName=(name)
      @@softwareName = name
    end

version() click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 38
    def AppConfig.version
      @@version
    end

version=(version) click to toggle source

    # File lib/taskjuggler/AppConfig.rb, line 34
    def AppConfig.version=(version)
      @@version = version
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.