Class: MPXJ::Reader

Inherits:
Object
  • Object
show all
Defined in:
lib/mpxj/reader.rb

Overview

Used to read a project plan from a file

Class Method Summary collapse

Class Method Details

.path_separator ⇒ Object 



35
36
37
38
39
40
41
 
# File 'lib/mpxj/reader.rb', line 35

def self.path_separator
  if windows?
    ";"
  else
    ":"
  end
end

.read(file_name, zone = nil) ⇒ Project

Reads a project plan from a file, and returns a Project instance which provides access to the structure and attributes of the project data. Note that an optional timezone can be supplied to ensue that all date-time values returned are in the specified timezone.

Parameters:

  • file_name (String) —

    the name of the file to read

  • zone (ActiveSupport::TimeZone) (defaults to: nil) —

    an optional timezone

Returns:

  • (Project) —

    new Project instance



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/mpxj/reader.rb', line 15

def self.read(file_name, zone = nil)
  project = nil
  json_file = Tempfile.new([File.basename(file_name, ".*"), '.json'])
  tz = zone || Time.zone || ActiveSupport::TimeZone["UTC"]

  begin
    classpath = Dir["#{File.dirname(__FILE__)}/*.jar"].join(path_separator)
    java_output = `java -cp \"#{classpath}\" net.sf.mpxj.sample.MpxjConvert \"#{file_name}\" \"#{json_file.path}\"`
    if $?.exitstatus != 0
      report_error(java_output)
    end
    project = Project.new(json_file, tz)
  ensure
    json_file.close
    json_file.unlink
  end
  project
end

.report_error(java_output) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/mpxj/reader.rb', line 49

def self.report_error(java_output)
  if java_output.include?('Conversion Error: ')
    message = java_output.split('Conversion Error: ')[1]
    if message.include?('Unsupported file type')
      raise MPXJ::ArgumentError, message
    else
      raise MPXJ::RuntimeError, message
    end
  else        
    raise MPXJ::UnknownError, "Failed to read file: #{java_output}"
  end
end

.windows? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/mpxj/reader.rb', line 44

def self.windows?
  (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
end