mpxj 13.5.1 → 13.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b72a34740417fbd948a463ecaa76511764cfb2ade1c6fba68ffa2a27b0c1284b
-  data.tar.gz: 49605d4a56eba134093c991a3e67c0de5a31e218c46098b4d796d853936c35eb
+  metadata.gz: 6db16fa074527bf24f66fc3489f80b74e8d3b57f66c16a1ec08fb1caff9549f9
+  data.tar.gz: 828539843889b0dc81b6af42895d40002aafa3f21333ee746f2f51402d0fb9e6
 SHA512:
-  metadata.gz: 876121dc9fc8c178ab44c4d9e557f68db06cc8d197dc5f9a22298a6e3127d32f60e38f36f5da06b59f0e4caaea4d58d092de3602e02018f3931739d03d87e853
-  data.tar.gz: 8b312e0f24087235e831111555cd345ad55dddbe66e3e67b5af946c9ef81de311ab7bd65cd7e471e3a8200a0d61de0dacffa78fd85b14fe52f16c580c4b5744b
+  metadata.gz: 3b797948446ff205f52ad52442308923c89b571c6f74b5d9524dad595a50fc04ca3b3f82db67a2ae15e948fd90bc29c61e7df10adbbafe0dc2e5fff7014ac014
+  data.tar.gz: 2f5e9809446502455952c062e2a848bc06031d29d3fa293a7c755b077263e199540bb0f1191013ed562e6aa6404f2a3b96b817ac5977f900d3fbc5f217faec30

data/lib/mpxj/calendar.rb

@@ -0,0 +1,112 @@
+module MPXJ
+  # Represents a calendar
+  class Calendar < Container
+    attr_reader :days
+    attr_reader :weeks
+    attr_reader :exceptions
+
+    def initialize(parent_project, attribute_values)
+      super(parent_project, attribute_values.slice('unique_id', 'guid', 'parent_unique_id', 'name', 'type', 'personal', 'minutes_per_day', 'minutes_per_week', 'minutes_per_month', 'minutes_per_year'))
+      process_days(attribute_values)
+      process_weeks(attribute_values)
+      process_exceptions(attribute_values)
+    end
+
+    # Retrieve the calendar unique ID
+    #
+    # @return [Integer] the calendar unique ID
+    def unique_id
+      get_integer_value(attribute_values['unique_id'])
+    end
+
+    # Retrieve the calendar GUID
+    #
+    # @return [String] the calendar GUID
+    def guid
+      attribute_values['guid']
+    end
+
+    # Retrieve the parent calendar unique ID
+    #
+    # @return [Integer] the parent calendar unique ID
+    # @return [nil] if the calendar does not have a parent
+    def parent_unique_id
+      get_nillable_integer_value(attribute_values['parent_unique_id'])
+    end
+
+    # Retrieve the parent calendar of this calendar
+    #
+    # @return [Calendar] if this calendar is the child of another calendar
+    # @return [nil] if this is a base calendar
+    def parent_calendar
+      parent_project.get_calendar_by_unique_id(attribute_values['parent_unique_id']&.to_i)
+    end
+
+    # Retrieve the calendar name
+    #
+    # @return [String] the calendar name
+    def name
+      attribute_values['name']
+    end
+
+    # Retrieve the calendar type
+    #
+    # @return [String] the calendar type
+    def type
+      attribute_values['type']
+    end
+
+    # Retrieve the personal flag
+    #
+    # @return [Boolean] true if this is a personal calendar
+    def personal
+      get_boolean_value(attribute_values['personal'])
+    end
+
+    # Retrieve the number of minutes per day
+    #
+    # @return [Integer] the number of minutes per day
+    # @return [nil] if this calendar does not provide a value for minutes per day
+    def minutes_per_day
+      get_nillable_integer_value(attribute_values['minutes_per_day'])
+    end
+
+    # Retrieve the number of minutes per week
+    #
+    # @return [Integer] the number of minutes per week
+    # @return [nil] if this calendar does not provide a value for minutes per week
+    def minutes_per_week
+      get_nillable_integer_value(attribute_values['minutes_per_week'])
+    end
+
+    # Retrieve the number of minutes per month
+    #
+    # @return [Integer] the number of minutes per month
+    # @return [nil] if this calendar does not provide a value for minutes per month
+    def minutes_per_month
+      get_nillable_integer_value(attribute_values['minutes_per_month'])
+    end
+
+    # Retrieve the number of minutes per year
+    #
+    # @return [Integer] the number of minutes per year
+    # @return [nil] if this calendar does not provide a value for minutes per year
+    def minutes_per_year
+      get_nillable_integer_value(attribute_values['minutes_per_year'])
+    end
+
+  private
+
+    def process_days(attribute_values)
+      @days = attribute_values.slice('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday').map {|name, day| [name, CalendarDay.new(parent_project, day)]}.to_h
+    end
+
+    def process_weeks(attribute_values)
+      @weeks = (attribute_values['working_weeks'] || []).map {|week| CalendarWeek.new(parent_project, week)}
+    end
+
+    def process_exceptions(attribute_values)
+      @exceptions = (attribute_values['exceptions'] || []).map {|exception| CalendarException.new(parent_project, exception)}
+    end
+  end
+end

data/lib/mpxj/calendar_day.rb

@@ -0,0 +1,26 @@
+module MPXJ
+  # Represents a calendar day
+  class CalendarDay < Container
+    attr_reader :hours
+
+    def initialize(parent_project, attribute_values)
+      super(parent_project, attribute_values.slice('type'))
+      process_hours(attribute_values)
+    end
+
+    # Retrieve the day type
+    #
+    # @return [String] the calendar day type
+    def type
+      attribute_values['type']
+    end
+
+  private
+
+    def process_hours(attribute_values)
+      @hours = (attribute_values['hours'] || {}).map do |hours|
+        CalendarHours.new(parent_project, hours)
+      end
+    end
+  end
+end

data/lib/mpxj/calendar_exception.rb

@@ -0,0 +1,47 @@
+module MPXJ
+  # Represents a calendar exception
+  class CalendarException < Container
+    attr_reader :hours
+
+    def initialize(parent_project, attribute_values)
+      super(parent_project, attribute_values.slice('name', 'from', 'to', 'type'))
+      process_hours(attribute_values)
+    end
+
+    # Retrieve the exception name
+    #
+    # @return [String] the exception name
+    def name
+      attribute_values['name']
+    end
+
+    # Retrieve the date on which this exception starts
+    #
+    # @return [Time] the exception from date
+    def from
+      get_date_value(attribute_values['from'])
+    end
+
+    # Retrieve the date on which this exception ends
+    #
+    # @return [Time] the exception to date
+    def to
+      get_date_value(attribute_values['to'])
+    end
+
+    # Retrieve the exception type
+    #
+    # @return [String] the exception type
+    def type
+      attribute_values['type']
+    end
+
+    private
+
+    def process_hours(attribute_values)
+      @hours = (attribute_values['hours'] || {}).map do |hours|
+        CalendarHours.new(parent_project, hours)
+      end
+    end
+  end
+end

data/lib/mpxj/calendar_hours.rb

@@ -0,0 +1,19 @@
+module MPXJ
+  # Represents a range of hours
+  class CalendarHours < Container
+
+    # Retrieve the the start hour
+    #
+    # @return [Time] start hour
+    def from
+      get_date_value(attribute_values['from'])
+    end
+
+    # Retrieve the the finish hour
+    #
+    # @return [Time] finish hour
+    def to
+      get_date_value(attribute_values['to'])
+    end
+  end
+end

data/lib/mpxj/calendar_week.rb

@@ -0,0 +1,38 @@
+module MPXJ
+  # Represents a working week
+  class CalendarWeek < Container
+    attr_reader :days
+
+    def initialize(parent_project, attribute_values)
+      super(parent_project, attribute_values.slice('name', 'effective_from', 'effective_to'))
+      process_days(attribute_values)
+    end
+
+    # Retrieve the exception name
+    #
+    # @return [String] the exception name
+    def name
+      attribute_values['name']
+    end
+
+    # Retrieve the date from which this working week is in effect
+    #
+    # @return [Time] effective from date
+    def effective_from
+      get_date_value(attribute_values['effective_from'])
+    end
+
+    # Retrieve the date to which this working week is in effect
+    #
+    # @return [Time] effective to date
+    def effective_to
+      get_date_value(attribute_values['effective_to'])
+    end
+
+    private
+
+    def process_days(attribute_values)
+      @days = attribute_values.slice('sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday').map {|name, day| [name, CalendarDay.new(parent_project, day)]}.to_h
+    end
+  end
+end

data/lib/mpxj/container.rb

@@ -45,6 +45,14 @@ module MPXJ
       end
     end
 
+    def get_nillable_integer_value(attribute_value)
+      if attribute_value.nil?
+        nil
+      else
+        attribute_value.to_i
+      end
+    end
+
     def get_boolean_value(attribute_value)
       attribute_value == true
     end

data/lib/mpxj/project.rb

@@ -4,6 +4,7 @@ module MPXJ
   # Represents a project plan
   class Project
     attr_reader :properties
+    attr_reader :all_calendars
     attr_reader :all_resources
     attr_reader :all_tasks
     attr_reader :child_tasks
@@ -11,12 +12,14 @@ module MPXJ
     attr_reader :zone
 
     def initialize(file_name, zone)
+      @calendars_by_unique_id = {}
       @resources_by_unique_id = {}
       @tasks_by_unique_id = {}
 
-      @resources_by_id = {}
+      @resources_by_id = {}      
       @tasks_by_id = {}
 
+      @all_calendars = []
       @all_resources = []
       @all_tasks = []
       @all_assignments = []
@@ -29,6 +32,7 @@ module MPXJ
 
       file = File.read(file_name)
       json_data = JSON.parse(file)
+      process_calendars(json_data)
       process_custom_fields(json_data)
       process_properties(json_data)
       process_resources(json_data)
@@ -36,6 +40,15 @@ module MPXJ
       process_assignments(json_data)
     end
 
+    # Retrieves the calendar with the matching unique_id attribute
+    #
+    # @param unique_id [Integer] calendar unique ID
+    # @return [Calendar] if the requested calendar is found
+    # @return [nil] if the requested calendar is not found
+    def get_calendar_by_unique_id(unique_id)
+      @calendars_by_unique_id[unique_id]
+    end
+
     # Retrieves the resource with the matching unique_id attribute
     #
     # @param unique_id [Integer] resource unique ID
@@ -104,6 +117,15 @@ module MPXJ
 
     private
 
+    def process_calendars(json_data)
+      calendars = json_data["calendars"]
+      calendars.each do |attribute_values|
+        calendar = Calendar.new(self, attribute_values)
+        @all_calendars << calendar
+        @calendars_by_unique_id[calendar.unique_id] = calendar
+      end
+    end
+
     def process_custom_fields(json_data)
       custom_fields = json_data["custom_fields"] || []
       custom_fields.each do |field|

data/lib/mpxj/properties.rb

@@ -2,5 +2,12 @@ module MPXJ
   # Represents the properties of a project
   class Properties < Container
   	include MPXJ::PropertyMethods
+
+    # Retrieve the default calendar for this project
+    #
+    # @return [Calendar] default calendar
+    def default_calendar
+      parent_project.get_calendar_by_unique_id(attribute_values['default_calendar_unique_id']&.to_i)
+    end
   end
 end

data/lib/mpxj/relation.rb

@@ -2,12 +2,27 @@ module MPXJ
   # Represents a relationship between two tasks in a project plan
   class Relation < Container
     # Retrieve the Task Unique ID value
-    #
+    # <b>DEPRECATED:</b> Please use <tt>predecessor_task_unique_id</tt> or <tt>successor_task_unique_id</tt>instead.
+    # 
     # @return Task Unique ID value
  		def task_unique_id
  			get_integer_value(attribute_values['task_unique_id'])
   	end
 
+    # Retrieve the Predecessor Task Unique ID value
+    #
+    # @return Predecessor Task Unique ID value
+    def predecessor_task_unique_id
+      get_integer_value(attribute_values['predecessor_task_unique_id'])
+    end
+
+    # Retrieve the Successor Task Unique ID value
+    #
+    # @return Successor Task Unique ID value
+    def successor_task_unique_id
+      get_integer_value(attribute_values['successor_task_unique_id'])
+    end
+
     # Retrieve the Lag value
     #
     # @return Lag value

data/lib/mpxj/resource.rb

@@ -8,5 +8,13 @@ module MPXJ
       super(parent_project, attribute_values)
       @assignments = []
     end
+
+    # Retrieve the calendar used by this resource
+    #
+    # @return [Calendar] resource calendar
+    # @return [nil] if this resource does not have a calendar
+    def calendar
+      parent_project.get_calendar_by_unique_id(attribute_values['calendar_unique_id']&.to_i)
+    end
   end
 end

data/lib/mpxj/task.rb

@@ -24,6 +24,14 @@ module MPXJ
       parent_project.get_task_by_unique_id(attribute_values['parent_task_unique_id']&.to_i)
     end
 
+    # Retrieve the calendar used by this task
+    #
+    # @return [Calendar] task calendar
+    # @return [nil] if this task does not have a calendar assigned
+    def calendar
+      parent_project.get_calendar_by_unique_id(attribute_values['calendar_unique_id']&.to_i)
+    end
+
     private
 
     def process_relations

data/lib/mpxj/task_methods.rb

@@ -18,6 +18,13 @@ module MPXJ
       attribute_values['activity_codes']
     end
 
+    # Retrieve the Activity Code Values value
+    #
+    # @return Activity Code Values value
+    def activity_code_values
+      attribute_values['activity_code_values']
+    end
+
     # Retrieve the Activity ID value
     #
     # @return Activity ID value
@@ -25,6 +32,13 @@ module MPXJ
       attribute_values['activity_id']
     end
 
+    # Retrieve the Activity Percent Complete value
+    #
+    # @return Activity Percent Complete value
+    def activity_percent_complete
+      get_float_value(attribute_values['activity_percent_complete'])
+    end
+
     # Retrieve the Activity Status value
     #
     # @return Activity Status value
@@ -6902,7 +6916,9 @@ module MPXJ
     ATTRIBUTE_TYPES = {
       'active' => :boolean,
       'activity_codes' => :activity_code_list,
+      'activity_code_values' => :activity_code_values,
       'activity_id' => :string,
+      'activity_percent_complete' => :percentage,
       'activity_status' => :activity_status,
       'activity_type' => :activity_type,
       'actual_cost' => :currency,

data/lib/mpxj/version.rb

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

data/lib/mpxj.rb

@@ -3,6 +3,11 @@ require "mpxj/container"
 require "mpxj/project"
 require "mpxj/property_methods"
 require "mpxj/properties"
+require "mpxj/calendar"
+require "mpxj/calendar_day"
+require "mpxj/calendar_week"
+require "mpxj/calendar_hours"
+require "mpxj/calendar_exception"
 require "mpxj/resource_methods"
 require "mpxj/resource"
 require "mpxj/task_methods"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mpxj
 version: !ruby/object:Gem::Version
-  version: 13.5.1
+  version: 13.7.0
 platform: ruby
 authors:
 - Jon Iles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-28 00:00:00.000000000 Z
+date: 2024-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -118,6 +118,11 @@ files:
 - lib/mpxj/argument_error.rb
 - lib/mpxj/assignment.rb
 - lib/mpxj/assignment_methods.rb
+- lib/mpxj/calendar.rb
+- lib/mpxj/calendar_day.rb
+- lib/mpxj/calendar_exception.rb
+- lib/mpxj/calendar_hours.rb
+- lib/mpxj/calendar_week.rb
 - lib/mpxj/commons-codec-1.17.0.jar
 - lib/mpxj/commons-collections4-4.4.jar
 - lib/mpxj/commons-io-2.16.1.jar