mpp_reader 0.1.0

data/lib/mpp_reader.rb

@@ -0,0 +1,66 @@
+require_relative "mpp_reader/version"
+require_relative "mpp_reader/errors"
+require_relative "mpp_reader/decode"
+require_relative "mpp_reader/rtf_text"
+require_relative "mpp_reader/cfbf/header"
+require_relative "mpp_reader/cfbf/fat"
+require_relative "mpp_reader/cfbf/directory"
+require_relative "mpp_reader/cfbf/file"
+require_relative "mpp_reader/blocks/props"
+require_relative "mpp_reader/blocks/var_meta"
+require_relative "mpp_reader/blocks/var2_data"
+require_relative "mpp_reader/blocks/fixed_meta"
+require_relative "mpp_reader/blocks/fixed_data"
+require_relative "mpp_reader/field_map"
+require_relative "mpp_reader/field_reader"
+require_relative "mpp_reader/comp_obj"
+require_relative "mpp_reader/task"
+require_relative "mpp_reader/resource"
+require_relative "mpp_reader/assignment"
+require_relative "mpp_reader/relation"
+require_relative "mpp_reader/calendar"
+require_relative "mpp_reader/reader14"
+require_relative "mpp_reader/project"
+
+# Pure Ruby reader for Microsoft Project .mpp files (MPP14 format,
+# Project 2010-2021). Binary format knowledge ported from MPXJ
+# (https://github.com/joniles/mpxj, LGPL).
+module MppReader
+  # File-format identifiers (from the CompObj stream) this gem supports:
+  # MPP14 is the format written by Project 2010 through 2021. MPT are
+  # templates, GLOBAL is the global.mpt enterprise template.
+  SUPPORTED_FORMATS = %w[MSProject.MPP14 MSProject.MPT14 MSProject.GLOBAL14].freeze
+
+  # Known older generations, for clear error messages only.
+  KNOWN_UNSUPPORTED = {
+    "MSProject.MPP4" => "Project 4.x/95",
+    "MSProject.MPP8" => "Project 98",
+    "MSProject.MPT8" => "Project 98",
+    "MSProject.MPP9" => "Project 2000/2002",
+    "MSProject.MPT9" => "Project 2000/2002",
+    "MSProject.GLOBAL9" => "Project 2000/2002",
+    "MSProject.MPP12" => "Project 2003/2007",
+    "MSProject.MPT12" => "Project 2003/2007",
+    "MSProject.GLOBAL12" => "Project 2003/2007"
+  }.freeze
+
+  # Opens an .mpp file (path, binary String, or IO) and returns a Project.
+  def self.open(source)
+    cfbf = Cfbf::File.read(source)
+    comp_obj_stream = cfbf.stream("\x01CompObj")
+    if comp_obj_stream.nil?
+      raise InvalidFormatError, "OLE file has no CompObj stream - not an MS Project file"
+    end
+
+    comp_obj = CompObj.new(comp_obj_stream)
+    format = comp_obj.file_format
+    unless SUPPORTED_FORMATS.include?(format)
+      product = KNOWN_UNSUPPORTED[format]
+      detail = product ? "#{format} (written by #{product})" : format.inspect
+      raise UnsupportedFormatError,
+            "unsupported file format #{detail} - only MPP14 (Project 2010-2021) is supported"
+    end
+
+    Project.new(cfbf, comp_obj)
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: mpp_reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bart Duchesne
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: 'Reads MS Project .mpp files (MPP14 format, Project 2010-2021) into structured
+  Ruby objects: tasks, resources, assignments and calendars. Binary format ported
+  from MPXJ. No native extensions, no runtime dependencies.'
+email:
+- bduc@dyndaco.be
+executables:
+- mpp_reader
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/mpp_reader
+- lib/mpp_reader.rb
+- lib/mpp_reader/assignment.rb
+- lib/mpp_reader/blocks/fixed_data.rb
+- lib/mpp_reader/blocks/fixed_meta.rb
+- lib/mpp_reader/blocks/props.rb
+- lib/mpp_reader/blocks/var2_data.rb
+- lib/mpp_reader/blocks/var_meta.rb
+- lib/mpp_reader/calendar.rb
+- lib/mpp_reader/cfbf/directory.rb
+- lib/mpp_reader/cfbf/fat.rb
+- lib/mpp_reader/cfbf/file.rb
+- lib/mpp_reader/cfbf/header.rb
+- lib/mpp_reader/cli.rb
+- lib/mpp_reader/comp_obj.rb
+- lib/mpp_reader/decode.rb
+- lib/mpp_reader/errors.rb
+- lib/mpp_reader/field_map.rb
+- lib/mpp_reader/field_reader.rb
+- lib/mpp_reader/field_tables.rb
+- lib/mpp_reader/project.rb
+- lib/mpp_reader/reader14.rb
+- lib/mpp_reader/relation.rb
+- lib/mpp_reader/resource.rb
+- lib/mpp_reader/rtf_text.rb
+- lib/mpp_reader/task.rb
+- lib/mpp_reader/version.rb
+homepage: https://github.com/bduc/ms-project-reader-ruby
+licenses:
+- LGPL-2.1-or-later
+metadata:
+  source_code_uri: https://github.com/bduc/ms-project-reader-ruby
+  changelog_uri: https://github.com/bduc/ms-project-reader-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/bduc/ms-project-reader-ruby/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Pure Ruby reader for Microsoft Project .mpp files
+test_files: []