mpxj 5.1.9 → 5.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 341098bd06b4186e6228fcfc40c4d1a36ac2d90e
-  data.tar.gz: 8feda84984b5742bc2a0b6418ea16dfcccf097bf
+  metadata.gz: 14e3c6791d8518f3cac4f787d9d4cc94b6dd76da
+  data.tar.gz: 3f6e8363e3a72ad46cb10739e21a315296480ae6
 SHA512:
-  metadata.gz: 3f2fb3a5184d5996f87c40545b14e7d4afd37e42c8644e26c8624a8d000ea32633f0b6b7255d0ca106bac2658df1c151860b136405d9ee87cd563a98fae9ef6c
-  data.tar.gz: 1ce8e7b048a800b535ea4bb789f42e0ba43d000386d14f2172f25b6680eb777234a7c3955b26ec7fce3e232c2afc06a096994d663cd960078250781ca64ecdfe
+  metadata.gz: 52a0b516a7604f65574f1dccff38de2e1ff8767e67538e2159098d8d1743a4def4bc4b85312c28141a7cd11bb29094d87f929c96bf1901d598fe93caf2d27a1d
+  data.tar.gz: acf7cfa6573b31342e3a95c786b163282e4ab6cea1123459201224750a0f409677187aaba75c844232ab90671bbcb40f769bda2702ad394f232b966ee3d07910

data/README.md

@@ -3,7 +3,10 @@
 This gem allows a Ruby developer to work with a read-only view of project plans saved by a number of popular project planning applications.
 The work required to read data from these files is actually carried out by a [Java library](http://mpxj.sf.net), hence you will need Java installed
 and available on your path in order to work with this gem. Once the project data has been read from a file, a set of Ruby objects provides access to the
-structure of the project plan and its attributes. 
+structure of the project plan and its attributes.
+
+This gem only came about through the interest and support of Procore, who would love to [hear from you](https://www.procore.com/jobs/) 
+if you're excited about working with Ruby and Rails.
 
 ## Installation
 

data/lib/mpxj/container.rb

@@ -1,89 +1,89 @@
-require 'duration'
-require 'time'
-
-module MPXJ
-  # Base class from which all project entities are derived
-  class Container
-    attr_reader :parent_project
-    def initialize(parent_project, attribute_types, attribute_values)
-      @parent_project = parent_project
-      @attribute_types = attribute_types
-      @attribute_values = attribute_values
-    end
-
-    def method_missing(name, *args, &block)
-      # We can probably do this more efficiently with dynamic methods... but let's get some feedback first!
-      attribute_name = name.to_s
-      attribute_type = @attribute_types[attribute_name]
-      attribute_value = @attribute_values[attribute_name]
-
-      if attribute_type.nil? && attribute_value.nil?
-        super
-      else
-        if attribute_type.nil?
-          attribute_type = 1
-        end
-        get_attribute_value(attribute_type, attribute_value)
-      end
-    end
-
-    protected
-
-    attr_reader :attribute_values
-
-    private
-
-    def get_attribute_value(attribute_type, attribute_value)
-      case attribute_type.to_i
-      when 12, 17, 19
-        get_integer_value(attribute_value)
-      when 8, 3, 5, 7
-        get_float_value(attribute_value)
-      when 2
-        get_date_value(attribute_value)
-      when 6, 16
-        get_duration_value(attribute_value)
-      when 4
-        get_boolean_value(attribute_value)
-      else
-        attribute_value
-      end
-    end
-
-    def get_duration_value(attribute_value)
-      if attribute_value.nil?
-        Duration.new(0)
-      else
-        Duration.new(attribute_value.to_i)
-      end
-    end
-
-    def get_date_value(attribute_value)
-      if attribute_value.nil?
-        nil
-      else
-        @parent_project.zone.parse(attribute_value)
-      end
-    end
-
-    def get_float_value(attribute_value)
-      if attribute_value.nil?
-        0.0
-      else
-        attribute_value.to_f
-      end
-    end
-
-    def get_integer_value(attribute_value)
-      if attribute_value.nil?
-        0
-      else
-        attribute_value.to_i
-      end
-    end
-
-    def get_boolean_value(attribute_value)
-      attribute_value == true
-    end
-  end
-end
+require 'duration'
+require 'time'
+
+module MPXJ
+  # Base class from which all project entities are derived
+  class Container
+    attr_reader :parent_project
+    def initialize(parent_project, attribute_types, attribute_values)
+      @parent_project = parent_project
+      @attribute_types = attribute_types
+      @attribute_values = attribute_values
+    end
+
+    def method_missing(name, *args, &block)
+      # We can probably do this more efficiently with dynamic methods... but let's get some feedback first!
+      attribute_name = name.to_s
+      attribute_type = @attribute_types[attribute_name]
+      attribute_value = @attribute_values[attribute_name]
+
+      if attribute_type.nil? && attribute_value.nil?
+        super
+      else
+        if attribute_type.nil?
+          attribute_type = 1
+        end
+        get_attribute_value(attribute_type, attribute_value)
+      end
+    end
+
+    protected
+
+    attr_reader :attribute_values
+
+    private
+
+    def get_attribute_value(attribute_type, attribute_value)
+      case attribute_type.to_i
+      when 12, 17, 19
+        get_integer_value(attribute_value)
+      when 8, 3, 5, 7
+        get_float_value(attribute_value)
+      when 2
+        get_date_value(attribute_value)
+      when 6, 16
+        get_duration_value(attribute_value)
+      when 4
+        get_boolean_value(attribute_value)
+      else
+        attribute_value
+      end
+    end
+
+    def get_duration_value(attribute_value)
+      if attribute_value.nil?
+        Duration.new(0)
+      else
+        Duration.new(attribute_value.to_i)
+      end
+    end
+
+    def get_date_value(attribute_value)
+      if attribute_value.nil?
+        nil
+      else
+        @parent_project.zone.parse(attribute_value)
+      end
+    end
+
+    def get_float_value(attribute_value)
+      if attribute_value.nil?
+        0.0
+      else
+        attribute_value.to_f
+      end
+    end
+
+    def get_integer_value(attribute_value)
+      if attribute_value.nil?
+        0
+      else
+        attribute_value.to_i
+      end
+    end
+
+    def get_boolean_value(attribute_value)
+      attribute_value == true
+    end
+  end
+end

data/lib/mpxj/project.rb

@@ -1,175 +1,175 @@
-require 'json'
-
-module MPXJ
-  # Represents a project plan
-  class Project
-    attr_reader :properties
-    attr_reader :all_resources
-    attr_reader :all_tasks
-    attr_reader :child_tasks
-    attr_reader :all_assignments
-    attr_reader :zone
-
-    def initialize(file_name, zone)
-      @resources_by_unique_id = {}
-      @tasks_by_unique_id = {}
-
-      @resources_by_id = {}
-      @tasks_by_id = {}
-
-      @all_resources = []
-      @all_tasks = []
-      @all_assignments = []
-      @child_tasks = []
-
-      @zone = zone
-
-      @field_by_alias = {}
-      @alias_by_field = {}
-
-      file = File.read(file_name)
-      json_data = JSON.parse(file)
-      process_custom_fields(json_data)
-      process_properties(json_data)
-      process_resources(json_data)
-      process_tasks(json_data)
-      process_assignments(json_data)
-    end
-
-    # Retrieves the resource with the matching unique_id attribute
-    #
-    # @param unique_id [Integer] resource unique ID
-    # @return [Resource] if the requested resource is found
-    # @return [nil] if the requested resource is not found
-    def get_resource_by_unique_id(unique_id)
-      @resources_by_unique_id[unique_id]
-    end
-
-    # Retrieves the task with the matching unique_id attribute
-    #
-    # @param unique_id [Integer] task unique ID
-    # @return [Task] if the requested task is found
-    # @return [nil] if the requested task is not found
-    def get_task_by_unique_id(unique_id)
-      @tasks_by_unique_id[unique_id]
-    end
-
-    # Retrieves the resource with the matching id attribute
-    #
-    # @param id [Integer] resource ID
-    # @return [Resource] if the requested resource is found
-    # @return [nil] if the requested resource is not found
-    def get_resource_by_id(id)
-      @resources_by_id[id]
-    end
-
-    # Retrieves the task with the matching id attribute
-    #
-    # @param id [Integer] task ID
-    # @return [Task] if the requested task is found
-    # @return [nil] if the requested task is not found
-    def get_task_by_id(id)
-      @tasks_by_unique_id[id]
-    end
-
-    # For a particular entity type (task, resource, and so on), retrieve
-    # the field which has the supplied alias. For example this allows the caller to
-    # answer the question "which task field is using the alias `Activity ID`"
-    #
-    # @param field_type_class[String] field type (possible values: task, resource, assignment, constraint, project)
-    # @param field_alias[String] the alias we want to look up
-    # @return [String] if the alias has been found return the name of the underlying field
-    # @return [nil] if the alias is not in use
-    def get_field_by_alias(field_type_class, field_alias)
-      hash = @field_by_alias[field_type_class]
-      if hash
-        hash[field_alias]
-      end
-    end
-
-    # For a particular entity type (task, resource, and so on), retrieve
-    # the alias used by the supplied field. For example this allows the caller to
-    # answer the question "does the task field Text1 have an alias?"
-    #
-    # @param field_type_class[String] field type (possible values: task, resource, assignment, constraint, project)
-    # @param field_type[String] the field type we want to look up
-    # @return [String] if the field has an alias, return the alias
-    # @return [nil] if the field does not have an alias
-    def get_alias_by_field(field_type_class, field_type)
-      hash = @alias_by_field[field_type_class]
-      if hash
-        hash[field_type]
-      end
-    end
-
-    private
-
-    def process_custom_fields(json_data)
-      custom_fields = json_data["custom_fields"]
-      custom_fields.each do |field|
-        process_custom_field(field)
-      end
-    end
-
-    def process_custom_field(field)
-      field_type_class = field["field_type_class"]
-      field_type = field["field_type"]
-      field_alias = field["field_alias"]
-
-      process_custom_field_hash(@field_by_alias, field_type_class, field_alias, field_type)
-      process_custom_field_hash(@alias_by_field, field_type_class, field_type, field_alias)
-    end
-
-    def process_custom_field_hash(hash, key1, key2, value)
-      key1_hash = hash[key1]
-      unless key1_hash
-        key1_hash = {}
-        hash[key1] = key1_hash
-      end
-      key1_hash[key2] = value
-    end
-
-    def process_properties(json_data)
-      attribute_types = json_data["property_types"]
-      attribute_values = json_data["property_values"]
-      @properties = Properties.new(self, attribute_types, attribute_values)
-    end
-
-    def process_resources(json_data)
-      attribute_types = json_data["resource_types"]
-      resources = json_data["resources"]
-      resources.each do |attribute_values|
-        resource = Resource.new(self, attribute_types, attribute_values)
-        @all_resources << resource
-        @resources_by_unique_id[resource.unique_id] = resource
-        @resources_by_id[resource.id] = resource
-      end
-    end
-
-    def process_tasks(json_data)
-      attribute_types = json_data["task_types"]
-      tasks = json_data["tasks"]
-      tasks.each do |attribute_values|
-        task = Task.new(self, attribute_types, attribute_values)
-        @all_tasks << task
-        @tasks_by_unique_id[task.unique_id] = task
-        @tasks_by_id[task.id] = task
-      end
-    end
-
-    def process_assignments(json_data)
-      attribute_types = json_data["assignment_types"]
-      assignments = json_data["assignments"]
-      assignments.each do |attribute_values|
-        assignment = Assignment.new(self, attribute_types, attribute_values)
-        @all_assignments << assignment
-        if assignment.task
-          assignment.task.assignments << assignment
-        end
-        if assignment.resource
-          assignment.resource.assignments << assignment
-        end
-      end
-    end
-  end
-end
+require 'json'
+
+module MPXJ
+  # Represents a project plan
+  class Project
+    attr_reader :properties
+    attr_reader :all_resources
+    attr_reader :all_tasks
+    attr_reader :child_tasks
+    attr_reader :all_assignments
+    attr_reader :zone
+
+    def initialize(file_name, zone)
+      @resources_by_unique_id = {}
+      @tasks_by_unique_id = {}
+
+      @resources_by_id = {}
+      @tasks_by_id = {}
+
+      @all_resources = []
+      @all_tasks = []
+      @all_assignments = []
+      @child_tasks = []
+
+      @zone = zone
+
+      @field_by_alias = {}
+      @alias_by_field = {}
+
+      file = File.read(file_name)
+      json_data = JSON.parse(file)
+      process_custom_fields(json_data)
+      process_properties(json_data)
+      process_resources(json_data)
+      process_tasks(json_data)
+      process_assignments(json_data)
+    end
+
+    # Retrieves the resource with the matching unique_id attribute
+    #
+    # @param unique_id [Integer] resource unique ID
+    # @return [Resource] if the requested resource is found
+    # @return [nil] if the requested resource is not found
+    def get_resource_by_unique_id(unique_id)
+      @resources_by_unique_id[unique_id]
+    end
+
+    # Retrieves the task with the matching unique_id attribute
+    #
+    # @param unique_id [Integer] task unique ID
+    # @return [Task] if the requested task is found
+    # @return [nil] if the requested task is not found
+    def get_task_by_unique_id(unique_id)
+      @tasks_by_unique_id[unique_id]
+    end
+
+    # Retrieves the resource with the matching id attribute
+    #
+    # @param id [Integer] resource ID
+    # @return [Resource] if the requested resource is found
+    # @return [nil] if the requested resource is not found
+    def get_resource_by_id(id)
+      @resources_by_id[id]
+    end
+
+    # Retrieves the task with the matching id attribute
+    #
+    # @param id [Integer] task ID
+    # @return [Task] if the requested task is found
+    # @return [nil] if the requested task is not found
+    def get_task_by_id(id)
+      @tasks_by_unique_id[id]
+    end
+
+    # For a particular entity type (task, resource, and so on), retrieve
+    # the field which has the supplied alias. For example this allows the caller to
+    # answer the question "which task field is using the alias `Activity ID`"
+    #
+    # @param field_type_class[String] field type (possible values: task, resource, assignment, constraint, project)
+    # @param field_alias[String] the alias we want to look up
+    # @return [String] if the alias has been found return the name of the underlying field
+    # @return [nil] if the alias is not in use
+    def get_field_by_alias(field_type_class, field_alias)
+      hash = @field_by_alias[field_type_class]
+      if hash
+        hash[field_alias]
+      end
+    end
+
+    # For a particular entity type (task, resource, and so on), retrieve
+    # the alias used by the supplied field. For example this allows the caller to
+    # answer the question "does the task field Text1 have an alias?"
+    #
+    # @param field_type_class[String] field type (possible values: task, resource, assignment, constraint, project)
+    # @param field_type[String] the field type we want to look up
+    # @return [String] if the field has an alias, return the alias
+    # @return [nil] if the field does not have an alias
+    def get_alias_by_field(field_type_class, field_type)
+      hash = @alias_by_field[field_type_class]
+      if hash
+        hash[field_type]
+      end
+    end
+
+    private
+
+    def process_custom_fields(json_data)
+      custom_fields = json_data["custom_fields"]
+      custom_fields.each do |field|
+        process_custom_field(field)
+      end
+    end
+
+    def process_custom_field(field)
+      field_type_class = field["field_type_class"]
+      field_type = field["field_type"]
+      field_alias = field["field_alias"]
+
+      process_custom_field_hash(@field_by_alias, field_type_class, field_alias, field_type)
+      process_custom_field_hash(@alias_by_field, field_type_class, field_type, field_alias)
+    end
+
+    def process_custom_field_hash(hash, key1, key2, value)
+      key1_hash = hash[key1]
+      unless key1_hash
+        key1_hash = {}
+        hash[key1] = key1_hash
+      end
+      key1_hash[key2] = value
+    end
+
+    def process_properties(json_data)
+      attribute_types = json_data["property_types"]
+      attribute_values = json_data["property_values"]
+      @properties = Properties.new(self, attribute_types, attribute_values)
+    end
+
+    def process_resources(json_data)
+      attribute_types = json_data["resource_types"]
+      resources = json_data["resources"]
+      resources.each do |attribute_values|
+        resource = Resource.new(self, attribute_types, attribute_values)
+        @all_resources << resource
+        @resources_by_unique_id[resource.unique_id] = resource
+        @resources_by_id[resource.id] = resource
+      end
+    end
+
+    def process_tasks(json_data)
+      attribute_types = json_data["task_types"]
+      tasks = json_data["tasks"]
+      tasks.each do |attribute_values|
+        task = Task.new(self, attribute_types, attribute_values)
+        @all_tasks << task
+        @tasks_by_unique_id[task.unique_id] = task
+        @tasks_by_id[task.id] = task
+      end
+    end
+
+    def process_assignments(json_data)
+      attribute_types = json_data["assignment_types"]
+      assignments = json_data["assignments"]
+      assignments.each do |attribute_values|
+        assignment = Assignment.new(self, attribute_types, attribute_values)
+        @all_assignments << assignment
+        if assignment.task
+          assignment.task.assignments << assignment
+        end
+        if assignment.resource
+          assignment.resource.assignments << assignment
+        end
+      end
+    end
+  end
+end

data/lib/mpxj/reader.rb

@@ -1,48 +1,48 @@
-require 'tempfile'
-require 'active_support/core_ext/time/calculations'
-
-module MPXJ
-  # Used to read a project plan from a file
-  class Reader
-    # 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.
-    #
-    # @param file_name [String] the name of the file to read
-    # @param zone [ActiveSupport::TimeZone] an optional timezone
-    # @return [Project] new Project instance
-    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
-          raise "Failed to read file: #{java_output}"
-        end
-        project = Project.new(json_file, tz)
-      ensure
-        json_file.close
-        json_file.unlink
-      end
-      project
-    end
-
-    # @private
-    def self.path_separator
-      if windows?
-        ";"
-      else
-        ":"
-      end
-    end
-
-    # @private
-    def self.windows?
-      (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
-    end
-  end
-end
+require 'tempfile'
+require 'active_support/core_ext/time/calculations'
+
+module MPXJ
+  # Used to read a project plan from a file
+  class Reader
+    # 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.
+    #
+    # @param file_name [String] the name of the file to read
+    # @param zone [ActiveSupport::TimeZone] an optional timezone
+    # @return [Project] new Project instance
+    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
+          raise "Failed to read file: #{java_output}"
+        end
+        project = Project.new(json_file, tz)
+      ensure
+        json_file.close
+        json_file.unlink
+      end
+      project
+    end
+
+    # @private
+    def self.path_separator
+      if windows?
+        ";"
+      else
+        ":"
+      end
+    end
+
+    # @private
+    def self.windows?
+      (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+    end
+  end
+end

data/lib/mpxj/version.rb

@@ -1,5 +1,5 @@
-# MPXJ gem module
-module MPXJ
-  # MPXJ gem version number
-  VERSION = "5.1.9"
-end
+# MPXJ gem module
+module MPXJ
+  # MPXJ gem version number
+  VERSION = "5.1.10"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mpxj
 version: !ruby/object:Gem::Version
-  version: 5.1.9
+  version: 5.1.10
 platform: ruby
 authors:
 - Jon Iles
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-30 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler