openxml-pptx 0.2.0

data/lib/openxml/pptx/parts/presentation.rb

@@ -0,0 +1,142 @@
+# frozen_string_literals: true
+
+module OpenXml
+  module Pptx
+    module Parts
+      class Presentation < OpenXml::Part
+        include OpenXml::RelatablePart
+        include OpenXml::HasAttributes
+        include OpenXml::ContainsProperties
+        attr_reader :slides, :slide_masters, :themes, :presentation_properties
+
+        relationship_type "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument"
+        content_type "application/vnd.openxmlformats-officedocument.presentationml.presentation.main+xml"
+        default_path "ppt/presentation.xml"
+
+        attribute :auto_compress_pictures, displays_as: :autoCompressPict, expects: :boolean
+        attribute :bookmark_id_seed, displays_as: :bookmarkIdSeed, expects: :integer, in_range: (1..2_147_483_648)
+        attribute :compatibility_mode, displays_as: :compatMode, expects: :boolean
+        attribute :conformance, one_of: %i{ strict transitional }
+        attribute :embed_fonts, displays_as: :embedTrueTypeFonts, expects: :boolean
+        attribute :first_slide_number, displays_as: :firstSlideNum, expects: :integer
+        attribute :remove_personal_information_on_save, displays_as: :removePersonalInfoOnSave, expects: :boolean
+        attribute :right_to_left, displays_as: :rtl, expects: :boolean
+        attribute :save_subset_fonts, displays_as: :saveSubsetFonts, expects: :boolean
+        attribute :server_zoom, displays_as: :serverZoom, expects: :percentage
+        attribute :show_special_placeholders_on_title_slide, displays_as: :showSpecialPlsOnTitleSld, expects: :boolean
+        attribute :strict_first_and_last_characters, displays_as: :strictFirstAndLastChars, expects: :boolean
+
+        property :slide_master_id_list
+        property :notes_master_id_list
+        property :handout_master_id_list
+        property :slide_id_list
+        property :slide_size
+        property :notes_size, required: true
+        property :smart_tags
+        property :embedded_font_list
+        property :custom_show_list
+        property :photo_album
+        # property :customer_data_list # tag :custDataLst
+        # property :kinsoku
+        property :default_text_style
+        # property :modification_verifier # tag :modifyVerifier
+
+        property :extension_list
+
+        # For proper interaction with HasAttributes
+        def self.tag
+          :presentation
+        end
+
+        def self.namespace
+          :p
+        end
+
+        def name
+          "presentation"
+        end
+
+        def initialize(*_args)
+          super
+          @slides = []
+          @slide_masters = []
+          @themes = []
+          @presentation_properties = OpenXml::Pptx::Parts::PresentationProperties.new
+          add_child_part(presentation_properties)
+
+          # Set defaults
+          slide_size.length = 12_192_000
+          slide_size.width = 6_858_000
+          notes_size.length = 6_858_000
+          notes_size.width = 9_144_000
+        end
+
+        def add_slide(slide)
+          slides.push(slide)
+          add_child_part(slide, with_index: slides.count)
+          slide_id_list << OpenXml::Pptx::Properties::SlideId.new.tap do |slide_id|
+            slide_id.rid = relationships_by_path[slide.path].id
+          end
+        end
+
+        def build_slide(named: nil, slide_layout: nil)
+          OpenXml::Pptx::Parts::Slide.new.tap do |slide|
+            slide.common_slide_data.slide_name = named unless named.nil?
+            slide.set_slide_layout(slide_layout) unless slide_layout.nil?
+            add_slide(slide)
+          end
+        end
+
+        def add_slide_master(slide_master)
+          slide_masters.push(slide_master)
+          add_child_part(slide_master, with_index: slide_masters.count)
+          slide_master_id_list << OpenXml::Pptx::Properties::SlideMasterId.new.tap do |master_id|
+            master_id.rid = relationships_by_path[slide_master.path].id
+          end
+        end
+
+        def build_slide_master(named: nil, theme: nil)
+          OpenXml::Pptx::Parts::SlideMaster.new.tap do |slide_master|
+            slide_master.common_slide_data.slide_name = named unless named.nil?
+            slide_master.set_theme(theme) unless theme.nil?
+            add_slide_master(slide_master)
+          end
+        end
+
+        def add_theme(theme)
+          themes.push(theme)
+          add_child_part(theme, with_index: themes.count)
+        end
+
+        def build_theme
+          OpenXml::Pptx::Parts::Theme.new.tap do |theme|
+            add_theme(theme)
+          end
+        end
+
+        def next_image_index
+          @image_index = (@image_index || 0) + 1
+        end
+
+        def to_xml
+          build_standalone_xml do |xml|
+            xml[:p].presentation(namespaces.merge(xml_attributes)) do
+              property_xml(xml)
+            end
+          end
+        end
+
+      private
+
+        def namespaces
+          {
+            "xmlns:a": "http://schemas.openxmlformats.org/drawingml/2006/main",
+            "xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
+            "xmlns:p": "http://schemas.openxmlformats.org/presentationml/2006/main"
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/pptx/parts/presentation_properties.rb

@@ -0,0 +1,38 @@
+# frozen_string_literals: true
+
+module OpenXml
+  module Pptx
+    module Parts
+      class PresentationProperties < OpenXml::Part
+        include OpenXml::RelatablePart
+        include OpenXml::ContainsProperties
+
+        relationship_type "http://schemas.openxmlformats.org/officeDocument/2006/relationships/presProps"
+        content_type "application/vnd.openxmlformats-officedocument.presentationml.presProps+xml"
+        default_path "ppt/presProps.xml"
+
+        # property :print_properties # tag: :prnPr
+        # property :show_properties # tag: :showPr
+        # property :color_mru # tag: :clrMru, DrawingML type, pptx namespace
+        property :extension_list
+
+        def to_xml
+          build_standalone_xml do |xml|
+            xml[:p].presentationPr(namespaces) do
+              property_xml(xml)
+            end
+          end
+        end
+
+      private
+
+        def namespaces
+          {
+            "xmlns:p": "http://schemas.openxmlformats.org/presentationml/2006/main"
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/pptx/parts/slide.rb

@@ -0,0 +1,87 @@
+module OpenXml
+  module Pptx
+    module Parts
+      class Slide < OpenXml::Part
+        include OpenXml::RelatablePart
+        include OpenXml::HasAttributes
+        include OpenXml::ContainsProperties
+        attr_reader :images
+
+        relationship_type "http://schemas.openxmlformats.org/officeDocument/2006/relationships/slide"
+        content_type "application/vnd.openxmlformats-officedocument.presentationml.slide+xml"
+        default_path "ppt/slides/slide.xml"
+
+        attribute :show_master_shapes, displays_as: :showMasterSp, expects: :boolean
+        attribute :show_master_placeholder_animations, displays_as: :showMasterPhAnim, expects: :boolean
+        attribute :show_slide, displays_as: :show, expects: :boolean
+
+        property :common_slide_data, required: true
+        property :color_mapping_override
+
+        # = TODO ================
+        # property :transition
+        # property :timing
+
+        property :extension_list
+
+        LAYOUT_SCHEMA =
+          "http://schemas.openxmlformats.org/officeDocument/2006/relationships/slideLayout".freeze
+
+        def initialize(*_args)
+          super
+          @images = []
+        end
+
+        # Necessary for HasAttributes
+        def name
+          "slide"
+        end
+
+        def add_image(image_part)
+          images.push(image_part)
+          index = (parent && parent.next_image_index) || images.count
+          add_child_part(image_part, with_index: index)
+        end
+
+        def build_image_part(path)
+          path = Pathname.new(path)
+          OpenXml::Pptx::Parts::Image.new(path.read, extension: path.extname).tap do |image|
+            add_image(image)
+          end
+        end
+
+        def set_slide_layout(layout)
+          add_relationship layout.relationship_type, layout.path
+        end
+
+        def to_xml
+          build_standalone_xml do |xml|
+            xml[:p].sld(namespaces.merge(xml_attributes)) do
+              property_xml(xml)
+            end
+          end
+        end
+
+        # Convenience accessors
+        def shapes
+          common_slide_data.shape_tree.shapes
+        end
+
+        def background_properties
+          common_slide_data.background.background_properties
+        end
+
+      private
+
+        def namespaces
+          {
+            "xmlns:a": "http://schemas.openxmlformats.org/drawingml/2006/main",
+            "xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
+            "xmlns:p": "http://schemas.openxmlformats.org/presentationml/2006/main"
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/pptx/parts/slide_layout.rb

@@ -0,0 +1,88 @@
+# frozen_string_literals: true
+
+module OpenXml
+  module Pptx
+    module Parts
+      class SlideLayout < OpenXml::Part
+        include OpenXml::RelatablePart
+        include OpenXml::HasAttributes
+        include OpenXml::ContainsProperties
+        attr_reader :images
+
+        relationship_type "http://schemas.openxmlformats.org/officeDocument/2006/relationships/slideLayout"
+        content_type "application/vnd.openxmlformats-officedocument.presentationml.slideLayout+xml"
+        default_path "ppt/slideLayouts/slideLayout.xml"
+
+        attribute :show_master_shapes, displays_as: :showMasterSp, expects: :boolean
+        attribute :show_master_placeholder_animations, displays_as: :showMasterPhAnim, expects: :boolean
+        attribute :matching_name, displays_as: :matchingName, expects: :string
+        attribute :type, one_of: OpenXml::Pptx::ST_SlideLayoutType
+        attribute :preserve, expects: :boolean
+        attribute :drawn_by_user, displays_as: :userDrawn, expects: :boolean
+
+        property :common_slide_data, required: true
+        property :color_mapping_override
+
+        # = TODO ================
+        # property :transition
+        # property :timing
+        # property :header_footer
+
+        property :extension_list
+
+        def initialize(*_args)
+          super
+          @images = []
+        end
+
+        # Necessary for HasAttributes
+        def name
+          "slide_layout"
+        end
+
+        def set_slide_master(master)
+          add_relationship master.relationship_type, master.path
+        end
+
+        def add_image(image_part)
+          images.push(image_part)
+          index = (parent && parent.next_image_index) || images.count
+          add_child_part(image_part, with_index: index)
+        end
+
+        def build_image_part(path)
+          path = Pathname.new(path)
+          OpenXml::Pptx::Parts::Image.new(path.read, extension: path.extname).tap do |image|
+            add_image(image)
+          end
+        end
+
+        def to_xml
+          build_standalone_xml do |xml|
+            xml[:p].sldLayout(namespaces.merge(xml_attributes)) do
+              property_xml(xml)
+            end
+          end
+        end
+
+        # Convenience accessors
+        def shapes
+          common_slide_data.shape_tree.shapes
+        end
+
+        def background_properties
+          common_slide_data.background.background_properties
+        end
+
+        private def namespaces
+          {
+            "xmlns:a": "http://schemas.openxmlformats.org/drawingml/2006/main",
+            "xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
+            "xmlns:p": "http://schemas.openxmlformats.org/presentationml/2006/main"
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/openxml/pptx/parts/slide_master.rb

@@ -0,0 +1,132 @@
+# frozen_string_literals: true
+
+module OpenXml
+  module Pptx
+    module Parts
+      class SlideMaster < OpenXml::Part
+        include OpenXml::RelatablePart
+        include OpenXml::HasAttributes
+        include OpenXml::ContainsProperties
+        attr_reader :theme, :layouts, :images
+
+        relationship_type "http://schemas.openxmlformats.org/officeDocument/2006/relationships/slideMaster"
+        content_type "application/vnd.openxmlformats-officedocument.presentationml.slideMaster+xml"
+        default_path "ppt/slideMasters/slideMaster.xml"
+
+        attribute :should_preserve, displays_as: :preserve, expects: :boolean
+
+        property :common_slide_data, required: true
+        property :color_mapping, required: true
+        property :slide_layout_id_list
+
+        # = TODO ================
+        # property :transition
+        # property :timing
+        # property :header_footer
+
+        property :text_styles
+
+        property :extension_list
+
+        def initialize(*_args)
+          super
+          @layouts = []
+          @images = []
+        end
+
+        # Necessary for HasAttributes
+        def name
+          "slide_master"
+        end
+
+        def set_theme(theme)
+          @theme = theme
+          add_relationship theme.relationship_type, theme.path
+        end
+
+        def add_slide_layout(layout)
+          layouts.push(layout)
+          add_child_part(layout, with_index: layouts.count)
+          slide_layout_id_list << OpenXml::Pptx::Properties::SlideLayoutId.new.tap do |layout_id|
+            layout_id.rid = relationships_by_path[layout.path].id
+          end
+        end
+
+        def build_slide_layout(named: nil)
+          OpenXml::Pptx::Parts::SlideLayout.new.tap do |layout|
+            layout.set_slide_master(self)
+            layout.common_slide_data.slide_name = named unless named.nil?
+            add_slide_layout(layout)
+          end
+        end
+
+        def add_image(image_part)
+          images.push(image_part)
+          index = (parent && parent.next_image_index) || images.count
+          add_child_part(image_part, with_index: index)
+        end
+
+        def build_image_part(path)
+          path = Pathname.new(path)
+          OpenXml::Pptx::Parts::Image.new(path.read, extension: path.extname).tap do |image|
+            add_image(image)
+          end
+        end
+
+        def next_image_index
+          @image_index = (parent && parent.next_image_index) || @image_index + 1
+        end
+
+        def to_xml
+          build_standalone_xml do |xml|
+            xml[:p].sldMaster(namespaces.merge(xml_attributes)) do
+              property_xml(xml)
+            end
+          end
+        end
+
+        def build_required_properties
+          super
+          DEFAULT_COLOR_MAPPING.each do |key, value|
+            color_mapping.public_send(:"#{key}=", value)
+          end
+        end
+
+        # Convenience accessors
+        def shapes
+          common_slide_data.shape_tree.shapes
+        end
+
+        def background_properties
+          common_slide_data.background.background_properties
+        end
+
+      private
+
+        def namespaces
+          {
+            "xmlns:a": "http://schemas.openxmlformats.org/drawingml/2006/main",
+            "xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
+            "xmlns:p": "http://schemas.openxmlformats.org/presentationml/2006/main"
+          }
+        end
+
+        DEFAULT_COLOR_MAPPING = {
+          bg1: :lt1,
+          tx1: :dk1,
+          bg2: :lt2,
+          tx2: :dk2,
+          accent1: :accent1,
+          accent2: :accent2,
+          accent3: :accent3,
+          accent4: :accent4,
+          accent5: :accent5,
+          accent6: :accent6,
+          hlink: :hlink,
+          folHlink: :folHlink
+        }.freeze
+
+      end
+    end
+  end
+end