pptxt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af8adcaf1ae4e8b2e76aaadff580d8d0ff48534f
+  data.tar.gz: 3324a84c53ff4ae4865a92530d62875c0a662492
+SHA512:
+  metadata.gz: fabd38653a74ae682deb4e74e081cca977a50f3cb4186c5b3daba60e98f4f2ffda3e976ec54a003742732fa7f85c8c7a1060d0f06ed56a56b86c472933688469
+  data.tar.gz: 974f4152ce33df205b76afaa4fd669fb052de111e6ee6fe6f059dc1d01bcb5c025b77a4d3b95401b3cff7088c2cf83b1e081e2e12bffafecebd8f7bb455a6e7b

data/bin/pptxt

@@ -0,0 +1,151 @@
+#!/usr/bin/env ruby
+
+require "io/wait"
+require "optparse"
+require "pathname"
+require "pptxt"
+require "pptxt_exit_status"
+require "pptxt_slide"
+
+def parse(args)
+    options = Hash.new
+    options["detailed"] = false
+    options["git"] = false
+    options["pptx"] = nil
+    options["slideshow"] = false
+
+    parser = OptionParser.new do |opts|
+        opts.banner = "Usage: #{File.basename($0)} [OPTIONS] [pptx]"
+
+        opts.on(
+            "-c",
+            "--configure",
+            "Configure git repo to use pptxt"
+        ) do
+            PPtxt.configure_git
+            exit PPtxtExitStatus::GOOD
+        end
+
+        opts.on("-d", "--detailed", "Display full xml") do
+            options["detailed"] = true
+        end
+
+        opts.on("--git", "Hide the slide dividers for git-diff") do
+            options["git"] = true
+        end
+
+        opts.on(
+            "-g",
+            "--global-config",
+            "Configure git to use pptxt globally"
+        ) do
+            PPtxt.configure_git(true)
+            exit PPtxtExitStatus::GOOD
+        end
+
+        opts.on("-h", "--help", "Display this help message") do
+            puts opts
+            exit PPtxtExitStatus::GOOD
+        end
+
+        opts.on("-s", "--slideshow", "Display as slideshow") do
+            options["slideshow"] = true
+        end
+    end
+
+    begin
+        parser.parse!
+    rescue OptionParser::InvalidOption => e
+        puts e.message
+        puts parser
+        exit PPtxtExitStatus::INVALID_OPTION
+    rescue OptionParser::InvalidArgument => e
+        puts e.message
+        puts parser
+        exit PPtxtExitStatus::INVALID_ARGUMENT
+    rescue OptionParser::MissingArgument => e
+        puts e.message
+        puts parser
+        exit PPtxtExitStatus::MISSING_ARGUMENT
+    end
+
+    if (args.empty?)
+        puts parser
+        exit PPtxtExitStatus::MISSING_ARGUMENT
+    elsif (args.length > 1)
+        puts parser
+        exit PPtxtExitStatus::EXTRA_ARGUMENTS
+    end
+
+    if (!Pathname.new(args[0]).expand_path.exist?)
+        puts "#{args[0]} does not exist!"
+        exit PPtxtExitStatus::FILE_DOES_NOT_EXIST
+    end
+
+    options["pptx"] = args[0].strip
+    if (options["pptx"] == "/dev/null")
+        exit PPtxtExitStatus::GOOD
+    end
+
+    return options
+end
+
+# Parse CLI args
+options = parse(ARGV)
+
+# Get slides
+slides = PPtxt.new(options["pptx"]).slides
+
+if (!options["slideshow"])
+    # Loop through slides
+    slides.each do |slide|
+        if (options["detailed"])
+            puts slide.detailed
+        elsif (options["git"])
+            puts slide.diffable
+            puts
+        else
+            puts slide
+            puts
+        end
+    end
+else
+    quit = false
+    count = 0
+
+    while (!quit)
+        slide = slides[count]
+
+        # Make it human readable and parse
+        system("clear")
+        puts
+        puts slide
+        puts
+        puts "j:Next k:Previous q:Quit"
+
+        answer = nil
+        while (!answer)
+            begin
+                system("stty raw -echo")
+                if $stdin.ready?
+                    answer = $stdin.getc.chr
+                else
+                    sleep 0.1
+                end
+            ensure
+                system("stty -raw echo")
+            end
+        end
+        puts
+
+        case answer
+        when "j", "J"
+            count += 1 if (count < (slides.length - 1))
+        when "k", "K"
+            count -= 1 if (count > 0)
+        when "q", "Q", "\x03"
+            # Quit or ^C
+            quit = true
+        end
+    end
+end

data/lib/pptxt.rb

@@ -0,0 +1,76 @@
+require "pptxt_error"
+require "pptxt_slide"
+require "scoobydoo"
+
+class PPtxt
+    attr_accessor :slides
+
+    def self.configure_git(global = false)
+        if (ScoobyDoo.where_are_you("git").nil?)
+            raise PPtxtError::MissingDependency.new("git")
+        end
+
+        # Configure git
+        flag = ""
+        flag = "--global" if (global)
+        system(
+            "git config #{flag} diff.pptxt.textconv \"pptxt --git\""
+        )
+
+        # Setup .gitattributes
+        filename = ".gitattributes"
+        if (global)
+            cfg = "git config --global core.attributesfile"
+            filename = %x(#{cfg}).strip
+            if (filename.nil? || filename.empty?)
+                filename = "~/.gitattributes"
+                system("#{cfg} \"#{filename}\"")
+            end
+        end
+        new_line = "*.pptx diff=pptxt\n"
+
+        file = Pathname.new(filename).expand_path
+        if (file.exist?)
+            File.open(file) do |f|
+                f.each_line do |line|
+                    if (line == new_line)
+                        return
+                    end
+                end
+            end
+            File.open(file, "a") do |f|
+                f.write(new_line)
+            end
+        else
+            File.open(file, "w") do |f|
+                f.write(new_line)
+            end
+        end
+    end
+
+    def create_slides
+        slides = %x(
+        unzip -l "#{@pptx}" | \grep -E "ppt/slides/[^_]" |
+                awk '{print $4}' | sort -k 1.17n
+        ).split("\n")
+
+        count = 0
+        slides.each do |slide|
+            xml = %x(unzip -qc "#{@pptx}" #{slide}).gsub("<", "\n<")
+            count += 1
+            @slides.push(PPtxtSlide.new(xml, count))
+        end
+    end
+    private :create_slides
+
+    def initialize(pptx)
+        @pptx = pptx
+        @slides = Array.new
+
+        if (ScoobyDoo.where_are_you("unzip").nil?)
+            raise PPtxtError::MissingDependency.new("unzip")
+        end
+
+        create_slides
+    end
+end

data/lib/pptxt_error.rb

@@ -0,0 +1,16 @@
+module PPtxtError
+    class Error < RuntimeError
+    end
+
+    class MissingDependency < Error
+        def initialize(tool)
+            super("Missing dependency: #{tool}")
+        end
+    end
+
+    class UnknownXML < Error
+        def initialize(line)
+            super("Unknown line in xml: #{line}")
+        end
+    end
+end

data/lib/pptxt_exit_status.rb

@@ -0,0 +1,9 @@
+class PPtxtExitStatus
+    GOOD = 0
+    INVALID_OPTION = 1
+    INVALID_ARGUMENT = 2
+    MISSING_ARGUMENT = 3
+    EXTRA_ARGUMENTS = 4
+    FILE_DOES_NOT_EXIST = 5
+    MISSING_UTILITY = 6
+end

data/lib/pptxt_slide.rb

@@ -0,0 +1,176 @@
+class PPtxtSlide
+    def detailed
+        ret = Array.new
+        num_indents = 0
+
+        @xml.each_line do |line|
+            line.strip!
+            indents = Array.new(num_indents, "  ").join
+
+            case line
+            when %r{^<\?.+$}, ""
+                # Ignore xml version and blank lines
+            when %r{^<.+/> *$}, %r{^<[^/].+>.*</.+> *$}
+                # Don't indent if one-liner
+                ret.push("#{indents}#{line}")
+            when %r{^<[^/].+$}
+                # Indent after opening tag
+                ret.push("#{indents}#{line}")
+                num_indents += 1
+            when %r{^</.+> *$}
+                # Remove indent after closing tag
+                num_indents -= 1
+                indents = Array.new(num_indents, "  ").join
+                ret.push("#{indents}#{line}")
+            else
+                raise PPtxtError::UnknownXML.new(line)
+            end
+        end
+
+        return ret.join("\n")
+    end
+
+    def diffable
+        out = Array.new
+        out.push(@title) if (!@title.empty?)
+        out.push(@subtitle) if (!@subtitle.empty?)
+        out.push("\n") if (!@title.empty? || !@subtitle.empty?)
+        out.push(@content) if (!@content.empty?)
+        return out.join.strip
+    end
+
+    def handle_format(str, format, lvl, list_index)
+        case format
+        when "bullet"
+            return "#{Array.new(lvl, "  ").join}- #{str}"
+        when "number"
+            return "#{Array.new(lvl, "  ").join}#{list_index}. #{str}"
+        else
+            return str
+        end
+    end
+    private :handle_format
+
+    def initialize(xml, count)
+        @content = ""
+        @count = count
+        @subtitle = ""
+        @title = ""
+        @xml = xml
+        parse_xml
+    end
+
+    def parse_xml
+        can_be_newline = false
+        first_time = false
+        ignore = false
+        in_subtitle = false
+        in_title = false
+        was_newline = true
+
+        format = "bullet"
+        lvl = 0
+        numlist_count = Array.new
+
+        @xml.each_line do |line|
+            line.strip!
+            case line
+            when "<a:p>"
+                # Assume bullet list
+                format = "bullet"
+            when %r{<a:pPr.*lvl="[^"]+".*}
+                # Sub bullet/item
+                lvl = line[%r{<a:pPr.*lvl="([^"]+)".*}, 1].to_i
+            when %r{<.?a:buNone}
+                # Regular text
+                format = "text"
+            when %r{<.?a:buAutoNum}
+                # Numbered list
+                format = "number"
+            when %r{<p:cNvPr .*Title}
+                # Setup titles
+                in_title = true
+                first_time = true
+                @title += "# "
+            when %r{<p:cNvPr .*Subtitle}
+                # Setup subtitles
+                in_subtitle = true
+                first_time = true
+                @subtitle += "## "
+            when %r{<a:t>.*}
+                # Handle text
+                if (in_title)
+                    @title += "  " if (!first_time && was_newline)
+                    @title += line[5..-1]
+                elsif (in_subtitle)
+                    @subtitle += "   " if (!first_time && was_newline)
+                    @subtitle += line[5..-1]
+                elsif(ignore)
+                    break
+                else
+                    if (was_newline)
+                        list_index = numlist_count[lvl] || 1
+                        @content += handle_format(
+                            line[5..-1],
+                            format,
+                            lvl,
+                            list_index
+                        )
+                        if (format == "number")
+                            numlist_count[lvl] = list_index + 1
+                        end
+                    else
+                        @content += line[5..-1]
+                    end
+                end
+
+                first_time = false
+                was_newline = false
+                lvl = 0
+            when "</a:t>"
+                # Setup newlines
+                can_be_newline = true
+            when "<a:br>", "</a:p>", "</p:txBody>"
+                # Handle newlines
+                if (in_title)
+                    @title += "\n" if (can_be_newline)
+                elsif (in_subtitle)
+                    @subtitle += "\n" if (can_be_newline)
+                elsif(ignore)
+                    break
+                else
+                    @content += "\n" if (can_be_newline)
+                end
+
+                can_be_newline = false
+                was_newline = true
+
+                if (line == "</p:txBody>")
+                    in_title = false
+                    in_subtitle = false
+                end
+            when "<p:graphicFrame>"
+                # Ignore graphics for now
+                # FIXME
+                ignore = true
+            when "</p:graphicFrame>"
+                ignore = false
+            else
+                # Ignore
+            end
+        end
+    end
+    private :parse_xml
+
+    def to_s()
+        div = Array.new(70, "-").join
+        out = Array.new
+        out.push("#{div}\n")
+        out.push(@title) if (!@title.empty?)
+        out.push(@subtitle) if (!@subtitle.empty?)
+        out.push("\n") if (!@title.empty? || !@subtitle.empty?)
+        out.push(@content) if (!@content.empty?)
+        out.push("#{div} #{@count}\n")
+        return out.join.strip
+    end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: pptxt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Miles Whittaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.8.1
+- !ruby/object:Gem::Dependency
+  name: scoobydoo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: This gem can extract the xml info from a pptx and convert to human-readable
+  text. It was intended to be used with git for seeing changes between revisions.
+email: mjwhitta@gmail.com
+executables:
+- pptxt
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/pptxt
+- lib/pptxt.rb
+- lib/pptxt_error.rb
+- lib/pptxt_exit_status.rb
+- lib/pptxt_slide.rb
+homepage: http://mjwhitta.github.io/pptxt
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Converts pptx files to human-readable text
+test_files: []
+has_rdoc: