powerpointer 0.0.0 → 0.0.1

data/README.md

@@ -7,4 +7,8 @@ PowerPointer is an easy to use ruby library allowing you to create .pptx files f
 * To provide full support for the features of .pptx files.
 * To provide two levels of abstraction:
   1. A set of low-level classes that export directly to .pptx files.
-  2. A high-level set of classes that encapsulate the low-level classes, in a very simple, yet powerful and intuitive, way.
+  2. A high-level set of classes that encapsulate the low-level classes in a very simple, yet powerful and intuitive, way.
+  
+## Contributing
+
+At this point, PowerPointer is at such an early stage that having more people would hurt the project more than it would help. However as soon as the basic code structure is finished, all contributions are welcome!

data/lib/example.rb

@@ -0,0 +1,9 @@
+require 'powerpointer'
+
+pack = PowerPointer::PresentationPackage.new
+pres = pack.get_presentation
+
+pres.add_slide
+
+pack.verbose = true
+pack.export_xml "powerpoint.pptx"

data/lib/powerpointer/content_types/default.rb

@@ -0,0 +1,22 @@
+module PowerPointer
+    class ContentTypes
+        class Default
+            def initialize(extension, contentType)
+                @extension = extension
+                @contentType = contentType
+            end
+            
+            def getExtension
+                @extension
+            end
+            
+            def getContentType
+                @contentType
+            end
+            
+            def to_xml
+                "<Default Extension=\"#{@extension}\" ContentType=\"#{@contentType}\" />"
+            end
+        end
+    end
+end

data/lib/powerpointer/content_types/override.rb

@@ -0,0 +1,25 @@
+module PowerPointer
+    class ContentTypes
+        class Override
+            def initialize(partName, contentType)                
+                @partName = partName
+                if @partName[0] != "/"
+                    @partName = "/" + @partName
+                end
+                @contentType = contentType
+            end
+            
+            def getPartName
+                @partName
+            end
+            
+            def getContentType
+                @contentType
+            end
+            
+            def to_xml
+                "<Override PartName=\"#{@partName}\" ContentType=\"#{@contentType}\" />"
+            end
+        end
+    end
+end

data/lib/powerpointer/content_types.rb

@@ -0,0 +1,26 @@
+module PowerPointer
+    class ContentTypes
+        def initialize
+            @contentTypes = []
+        end
+        
+        def add_content_type(ct)
+            if ct.respond_to?(:to_xml)
+                @contentTypes << ct
+            end
+        end
+        
+        def export_xml(folder, package)
+            # Export me
+            export = ExportFile.new(folder, "[Content_Types].xml")
+            export << "<Types xmlns=\"http://schemas.openxmlformats.org/package/2006/content-types\">"
+            @contentTypes.each do |contentType|
+                export << contentType.to_xml
+            end
+            export << "</Types>"
+            package.add export
+            
+            # Content Types is a hardcoded file. No need to add references.
+        end
+    end
+end

data/lib/powerpointer/export_file.rb

@@ -0,0 +1,33 @@
+module PowerPointer
+    class ExportFile
+        def initialize(path, filename)
+            @path = path
+            @filename = filename
+            @content = ""
+        end
+        
+        def <<(content)
+            @content << content
+        end    
+        
+        def get_content
+            @content
+        end
+        
+        def get_path
+            @path
+        end
+        
+        def get_filename
+            @filename
+        end
+        
+        def get_full_path (leading_slash = false)
+            if leading_slash
+                return "/" + @path + @filename
+            else
+                return @path + @filename
+            end
+        end
+    end
+end

data/lib/powerpointer/globals.rb

@@ -0,0 +1,3 @@
+module PowerPointer
+    XML_HEADER = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"    
+end

data/lib/powerpointer/presentation.rb

@@ -0,0 +1,62 @@
+module PowerPointer
+    class Presentation
+        def initialize
+            @slides = []
+            @slideMasters = []
+            @noteMasters = []
+            @handoutMasters = []
+            @relationshipId = "rId_presentation"
+            
+            @filename = "presentation.xml"
+            
+            @relationships = Relationships.new @filename
+            
+            @notesSize = [913607, 913607]
+            @slideSize = [10080625, 7559675]
+        end
+            
+        def add_slide
+            s = Slide.new(@slides.count + 1)
+            @slides << s
+        end
+            
+        def get_relationships
+            @relationships
+        end
+            
+        def export_xml(folder, package)
+            me_folder = folder + "ppt/"
+        
+            # Export me
+            export = ExportFile.new(me_folder, @filename)             
+            export << XML_HEADER
+            export << "<p:presentation xmlns:p=\"http://schemas.openxmlformats.org/presentationml/2006/main\"  xmlns:a=\"http://schemas.openxmlformats.org/drawingml/2006/main\" xmlns:r=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships\">"
+            
+                # Export slide masters
+                export << "<p:sldMasterIdLst>"
+                export << "</p:sldMasterIdLst>"
+                
+                # Export slide list
+                export << "<p:sldIdLst>"
+                @slides.each do |slide|
+                    slide.export_xml(export.get_path, self, package)
+                    export << "<p:sldId id=\"#{slide.get_id}\" r:id=\"#{slide.get_relationship_id}\" />"
+                end
+                export << "</p:sldIdLst>"
+                
+                # Export sizes
+                export << "<p:sldSz cx=\"#{@slideSize[0]}\" cy=\"#{@slideSize[1]}\" />"
+                export << "<p:notesSz cx=\"#{@notesSize[0]}\" cy=\"#{@notesSize[1]}\" />"
+            export << "</p:presentation>"
+            package.add export
+            
+            # Add references to me
+            package.get_relationships.add(@relationshipId, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument", export.get_full_path)            
+            c = ContentTypes::Override.new(export.get_full_path, "application/vnd.openxmlformats-officedocument.presentationml.presentation.main+xml")
+            package.add_content_type(c)
+                       
+            # Export relationships
+            @relationships.export_xml(export.get_path, package)
+        end
+    end
+end

data/lib/powerpointer/presentation_package.rb

@@ -0,0 +1,103 @@
+require 'fileutils'
+require 'tmpdir'
+
+module PowerPointer
+    class PresentationPackage
+        def initialize
+            @presentation = Presentation.new
+            @contentTypes = ContentTypes.new
+            @relationships = Relationships.new("")
+            
+            @exportFiles = []
+            
+            @verbose = false
+        end
+
+        def export_xml output
+            rootFolder = ""
+
+            vputs ""
+            vputs "Preparing..."
+            vputs ""
+            
+            # 1. Prepare presentation (Adds relationships and content types)
+            @presentation.export_xml(rootFolder, self)
+            
+            # 2. Prepare relationships (Adds content types)
+            @relationships.export_xml(rootFolder, self)           
+            
+            # 3. Prepare content types
+            @contentTypes.export_xml(rootFolder, self)
+                                  
+            # Create tmp directory
+            Dir.mktmpdir do |tmp_folder|
+                vputs "Created temporary directory: #{tmp_folder}"
+                          
+                # Do the export
+                @exportFiles.each do |file|
+                    vputs "Exporting #{file.get_full_path}"
+                    
+                    # Create the path if it doesn't exist
+                    path = "#{tmp_folder}/#{file.get_path}"
+                    FileUtils::mkdir_p path
+                    
+                    # Write the file
+                    File.open("#{path}/#{file.get_filename}", "w") do |f|
+                        f << file.get_content
+                    end
+                end
+                
+                vputs ""
+                vputs "Export complete."
+                vputs ""
+                vputs "Zipping..."
+                vputs ""
+                
+                # Init zip file
+                Zip::File.open(output, Zip::File::CREATE) do |zip|
+                    # Add each file to zip
+                    @exportFiles.each do |file|
+                        zip.add(file.get_full_path, File.join(tmp_folder, file.get_full_path))
+                    end
+                end
+                
+                vputs "Zipping complete."
+                vputs ""
+                
+                # tmp directory is erased
+            end
+        end
+        
+        def add_content_type(ct)
+            @contentTypes.add_content_type ct
+        end                
+        
+        def verbose=(verbose)
+            @verbose = verbose
+        end
+
+        def verbose
+            @verbose
+        end
+        
+        def get_relationships
+            @relationships
+        end
+        
+        def get_presentation
+            @presentation
+        end
+        
+        def add file
+            @exportFiles << file
+        end
+                       
+        private
+        
+        def vputs s
+            if verbose
+                puts s
+            end
+        end       
+    end
+end

data/lib/powerpointer/relationships.rb

@@ -0,0 +1,36 @@
+module PowerPointer
+    class Relationships
+        def initialize(filename)
+            @filename = filename
+            @relationships = []
+        end
+        
+        def add(id, type, target)
+            relationship = {
+                :id => id,
+                :type => type,
+                :target => target
+            }
+            @relationships << relationship
+        end
+        
+        def get_filename
+            @filename
+        end
+        
+        def export_xml(folder, package)
+            # Export me
+            export = ExportFile.new(folder + "_rels/", @filename + ".rels")
+            export << XML_HEADER.dup
+            export << "<Relationships xmlns=\"http://schemas.openxmlformats.org/package/2006/relationships\">"
+            @relationships.each do |relationship|
+                export << "<Relationship Id=\"#{relationship[:id]}\" Type=\"#{relationship[:type]}\" Target=\"#{relationship[:target]}\" />"
+            end
+            export << "</Relationships>"
+            package.add export
+            
+            # Add references to me
+            package.add_content_type ContentTypes::Override.new(export.get_full_path, "application/vnd.openxmlformats-package.relationships+xml")
+        end
+    end
+end

data/lib/powerpointer/slide.rb

@@ -0,0 +1,36 @@
+module PowerPointer
+    class Slide
+        def initialize(slideId)
+            @slideId = slideId
+            @relationshipId = "rId_slide" + slideId.to_s
+            
+            @filename = "slide#{@slideId}.xml"
+            @relationships = Relationships.new @filename
+        end
+        
+        def export_xml(folder, presentation, package)
+            # Export me
+            export = ExportFile.new(folder + "slides/", @filename)
+            export << XML_HEADER
+            export << "<p:sld xmlns:p=\"http://schemas.openxmlformats.org/presentationml/2006/main\" xmlns:a=\"http://schemas.openxmlformats.org/drawingml/2006/main\" xmlns:r=\"http://schemas.openxmlformats.org/officeDocument/2006/relationships\">"
+            export << "</p:sld>"
+            package.add export
+            
+            # Add references to me
+            presentation.get_relationships.add(@relationshipId, "http://schemas.openxmlformats.org/officeDocument/2006/relationships/slide", "slides/#{export.get_filename}")            
+            c = ContentTypes::Override.new(export.get_full_path, "application/vnd.openxmlformats-officedocument.presentationml.slide+xml")
+            package.add_content_type(c)
+                       
+            # Export relationships
+            @relationships.export_xml(export.get_path, package)
+        end
+        
+        def get_id
+            @slideId
+        end
+        
+        def get_relationship_id
+            @relationshipId
+        end
+    end
+end

data/lib/powerpointer/version.rb

@@ -1,3 +1,3 @@
 module PowerPointer
-  VERSION = "0.0.0"
+  VERSION = "0.0.1"
 end

data/lib/powerpointer.rb

@@ -1,5 +1,14 @@
-class PowerPointer
-    def self.test
-        puts "Hello world"
-    end
-end
+require 'rubygems'
+require 'bundler/setup'
+require 'zip'
+
+require 'powerpointer/version'
+require 'powerpointer/globals'
+require 'powerpointer/export_file'
+require 'powerpointer/relationships'
+require 'powerpointer/content_types'
+require 'powerpointer/slide'
+require 'powerpointer/presentation'
+require 'powerpointer/presentation_package'
+require 'powerpointer/content_types/default'
+require 'powerpointer/content_types/override'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: powerpointer
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
-dependencies: []
+date: 2014-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: PowerPointer is an easy to use ruby library allowing you to create .pptx
   files from scratch.
 email:
@@ -19,7 +35,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/powerpointer/pp.rb
+- lib/example.rb
+- lib/powerpointer/content_types/default.rb
+- lib/powerpointer/content_types/override.rb
+- lib/powerpointer/content_types.rb
+- lib/powerpointer/export_file.rb
+- lib/powerpointer/globals.rb
+- lib/powerpointer/presentation.rb
+- lib/powerpointer/presentation_package.rb
+- lib/powerpointer/relationships.rb
+- lib/powerpointer/slide.rb
 - lib/powerpointer/version.rb
 - lib/powerpointer.rb
 - LICENSE
@@ -44,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.28
+rubygems_version: 1.8.29
 signing_key: 
 specification_version: 3
 summary: PowerPointer is an easy to use ruby library allowing you to create .pptx

data/lib/powerpointer/pp.rb

@@ -1,2 +0,0 @@
-module PowerPointer
-end