odf-converter 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.project
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in opendoc-converter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Daniel Vandersluis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Opendoc::Converter
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opendoc-converter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opendoc-converter
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+desc "Open an pry session preloaded with this library"
+task :console do
+  sh "pry -rubygems -I lib -r odf/converter.rb"
+end

data/lib/odf-converter.rb

@@ -0,0 +1,3 @@
+require "rubyuno"
+require "odf/converter/version"
+require "odf/converter"

data/lib/odf/converter.rb

@@ -0,0 +1,108 @@
+require "rubyuno"
+require "odf/converter/version"
+require "odf/converter/families"
+require "odf/converter/filters/base_filter"
+require "odf/converter/filters/import"
+require "odf/converter/filters/export"
+require "odf/converter/hash"
+
+module ODF
+  PropertyValue = Rubyuno.uno_require "com.sun.star.beans.PropertyValue"
+  
+  class Converter
+    class DocumentConversionError < Exception; end
+    
+    attr_reader :ctx, :smgr, :desktop, :document
+    
+    def initialize
+      @ctx = Uno::Connector.bootstrap("soffice", "socket", "localhost", 8100)
+      @smgr = @ctx.getServiceManager
+      @desktop = @smgr.createInstanceWithContext("com.sun.star.frame.Desktop", @ctx)
+    end
+    
+    def convert(infile, options = {})
+      raise ArgumentError, "to option must be provided." unless options[:to]
+      
+      if options[:to].is_a? Symbol #and Filters::Export[options[:to]]
+        outfile = get_output_name(infile, options[:to])
+      elsif options[:to].is_a? String
+        raise DocumentConversionError, "#{options[:to]} doesn't specify an extension" if File.extname(options[:to]).empty?
+        outfile = File.expand_path(options[:to])
+      else
+        raise DocumentConversionError, "not given a valid destination"
+      end
+      
+      perform_conversion(infile, outfile) && outfile
+    end
+    
+    def self.convert(*args)
+      new.convert(*args)
+    end
+  
+  private
+    def detect_family(doc)
+      return Families::WEB if doc.supportsService("com.sun.star.text.WebDocument")
+      return Families::TEXT if doc.supportsService("com.sun.star.text.GenericTextDocument")
+      return Families::SPREADSHEET if doc.supportsService("com.sun.star.sheet.SpreadsheetDocument")
+      return Families::PRESENTATION if doc.supportsService("com.sun.star.presentation.PresentationDocument")
+      return Families::DRAWING if doc.supportsService("com.sun.star.drawing.DrawingDocument")
+      raise DocumentConversionError, "unknown document family"
+    end
+    
+    def file_url_for(file)
+      Rubyuno.system_path_to_file_url File.expand_path(file)
+    end
+    
+    def get_output_name(file, ext)
+      file = File.expand_path(file)
+      File.join(File.dirname(file), File.basename(file, File.extname(file)) + ".#{ext}")
+    end
+    
+    def perform_conversion(infile, outfile)
+      begin
+        load(infile) && store(outfile)
+      ensure
+        @document.close(true)
+      end
+    end
+    
+    def load(infile)
+      input_url = file_url_for(infile)
+      input_ext = File.extname(infile).gsub(/^\./, "")
+      props = { Hidden: true }.merge(Filters::Import[input_ext] || {})
+      
+      begin
+        @document = desktop.loadComponentFromURL(input_url, "_blank", 0, props.to_uno_properties)
+      rescue Rubyuno::Com::Sun::Star::Lang::IllegalArgumentException => e
+        raise DocumentConversionError, e.message
+      end
+      
+      @document.refresh
+      family = detect_family(@document)
+      
+      if family == Families::SPREADSHEET
+        page_styles = @document.getStyleFamilies.getByName('PageStyles')
+        page_styles.getElementNames.each do |name|
+          page_style = pageStyles.getByName(name)
+          page_style.setPropertyValue("PageScale", 100)
+          page_style.setPropertyValue("PrintGrid", false) 
+        end
+      end
+      
+      true
+    end
+    
+    def store(outfile)
+      output_url = file_url_for(outfile)
+      output_ext = File.extname(outfile).gsub(/^\./, "")
+      
+      family = detect_family(@document)
+      props = Filters::Export[output_ext] or raise DocumentConversionError, "unknown output format: #{output_ext}"
+      props = props[family] or raise DocumentConversionError, "unsupported conversion: from #{family} to #{output_ext}"
+      
+      @document.storeToURL(output_url, props.to_uno_properties)
+
+      true
+    end
+  end
+end

data/lib/odf/converter/families.rb

@@ -0,0 +1,11 @@
+module ODF
+  class Converter
+    module Families
+      TEXT = "Text"
+      WEB = "Web"
+      SPREADSHEET = "Spreadsheet"
+      PRESENTATION = "Presentation"
+      DRAWING = "Drawing"
+    end
+  end
+end

data/lib/odf/converter/filters/base_filter.rb

@@ -0,0 +1,17 @@
+module ODF
+  class Converter
+    module Filters
+      module BaseFilter
+        def self.included(klass)
+          klass.extend(ClassMethods)
+        end
+        
+        module ClassMethods
+          def [](filter)
+            self.const_get(filter.to_s.upcase) rescue nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/odf/converter/filters/export.rb

@@ -0,0 +1,115 @@
+module ODF
+  class Converter
+    module Filters
+      module Export
+        include BaseFilter
+        
+        # see http://wiki.services.openoffice.org/wiki/Framework/Article/Filter
+        # most formats are auto-detected; only those requiring options are defined here
+        PDF = {
+          ODF::Converter::Families::TEXT => {
+            FilterName: "writer_pdf_Export"
+          },
+          ODF::Converter::Families::WEB => {
+            FilterName: "writer_web_pdf_Export"
+          },
+          ODF::Converter::Families::SPREADSHEET => {
+            FilterName: "calc_pdf_Export"
+          },
+          ODF::Converter::Families::PRESENTATION => {
+            FilterName: "impress_pdf_Export"
+          },
+          ODF::Converter::Families::DRAWING => {
+            FilterName: "draw_pdf_Export"
+          }
+        }
+        
+        HTML = {
+          ODF::Converter::Families::TEXT => {
+            FilterName: "HTML (StarWriter)"
+          },
+          ODF::Converter::Families::SPREADSHEET => {
+            FilterName: "HTML (StarCalc)"
+          },
+          ODF::Converter::Families::PRESENTATION => {
+            FilterName: "impress_html_Export"
+          }
+        }
+        
+        ODT = {
+          ODF::Converter::Families::TEXT => {
+            FilterName: "writer8"
+          },
+          ODF::Converter::Families::WEB => {
+            FilterName: "writerweb8_writer"
+          }
+        }
+        
+        DOC = {
+          ODF::Converter::Families::TEXT => {
+            FilterName: "MS Word 97"
+          }
+        }
+        
+        DOCX = {
+          ODF::Converter::Families::TEXT => {
+            FilterName: "MS Word 2007 XML"
+          } 
+        }
+        
+        RTF = {
+          ODF::Converter::Families::TEXT => {
+            FilterName: "Rich Text Format"
+          }
+        }
+        
+        TXT = {
+          ODF::Converter::Families::TEXT => {
+            FilterName: "Text",
+            FilterOptions: "utf8"
+          }
+        }
+        
+        ODS = {
+          ODF::Converter::Families::SPREADSHEET => {
+            FilterName: "calc8"
+          }
+        }
+        
+        XLS = {
+          ODF::Converter::Families::SPREADSHEET => {
+            FilterName: "MS Excel 97"
+          }
+        }
+        
+        CSV = {
+          ODF::Converter::Families::SPREADSHEET => {
+            FilterName: "Text - txt - csv (StarCalc)",
+            FilterOptions: "44,34,0"
+          }
+        }
+        
+        ODP = {
+          ODF::Converter::Families::PRESENTATION => {
+            FilterName: "impress8"
+          }
+        }
+        
+        PPT = {
+          ODF::Converter::Families::PRESENTATION => {
+            FilterName: "MS PowerPoint 97"
+          }
+        }
+        
+        SWF = {
+          ODF::Converter::Families::PRESENTATION => {
+            FilterName: "impress_flash_Export"
+          },
+          ODF::Converter::Families::DRAWING => {
+            FilterName: "draw_flash_Export"
+          }
+        }
+      end
+    end
+  end
+end

data/lib/odf/converter/filters/import.rb

@@ -0,0 +1,21 @@
+module ODF                                                                                                                                                                                               
+  class Converter                                                                                                                                                                                        
+    module Filters                                                                                                                                                                                      
+      module Import
+        include BaseFilter
+        
+        # see http://wiki.services.openoffice.org/wiki/Framework/Article/Filter
+        # most formats are auto-detected; only those requiring options are defined here
+        TXT = {
+          FilterName: "Text (encoded)",
+          FilterOptions: "utf8"  
+        }
+        
+        CSV = {
+          FilterName: "Text - txt - csv (StarCalc)",
+          FilterOptions: "44,34,0"
+        }
+      end                                                                                                                                                                         
+    end                                                                                                                                                                                                  
+  end                                                                                                                                                                                                    
+end                                                                                                                                                                                                      

data/lib/odf/converter/hash.rb

@@ -0,0 +1,11 @@
+class Hash
+  def to_uno_properties
+    self.inject([]) do |memo, (key, value)|
+      property = ODF::PropertyValue.new
+      property.Name = key.to_s
+      property.Value = value.to_s
+      memo << property
+      memo
+    end      
+  end
+end

data/lib/odf/converter/version.rb

@@ -0,0 +1,5 @@
+module ODF
+  class Converter
+    VERSION = "0.0.1"
+  end
+end

data/odf-converter.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/odf/converter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Daniel Vandersluis"]
+  gem.email         = ["dvandersluis@selfmgmt.com"]
+  gem.description   = %q{Ruby library for converting ODF files through OO.org}
+  gem.summary       = %q{Uses a native Ruby-UNO bridge (rubyuno) to connect to OpenOffice.org running as a service and convert ODF documents to a different format.}
+  gem.homepage      = "https://www.github.com/dvandersluis/odf-converter"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "odf-converter"
+  gem.require_paths = ["lib"]
+  gem.version       = ODF::Converter::VERSION
+  
+  gem.add_dependency "rubyuno"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-editline"
+  gem.add_development_dependency "rspec"
+end

data/spec/odf/converter_spec.rb

@@ -0,0 +1,42 @@
+require 'odf/converter'
+
+describe ODF::Converter do
+  describe "#new" do
+    it "should initialize a connection" do
+    end
+  end
+  
+  describe "#convert" do
+    let(:c) { ODF::Converter.new }
+    
+    describe do
+      before { c.stub(:perform_conversion) { true } }
+      
+      it "should raise an error if the to option is not given" do
+        expect { c.convert("infile.txt") }.to raise_error ArgumentError
+      end
+  
+      it "should raise an error if the to option is a string but doesn't look like a file with extension" do
+        expect { c.convert("infile.txt", to: "file") }.to raise_error ODF::Converter::DocumentConversionError
+      end
+      
+      it "should raise an error if the to option is not a string or a symbol" do
+        expect { c.convert("infile.txt", to: []) }.to raise_error ODF::Converter::DocumentConversionError
+      end
+          
+      it "should output to the input file name with the extension changed if to is set to a symbol" do
+        FileUtils.cd "/"
+        
+        c.convert("infile.txt", to: :html).should == "/infile.html"
+        c.convert("/home/username/infile.txt", to: :html).should == "/home/username/infile.html"
+      end
+      
+      it "should output to the given name if it's a valid filename" do
+        FileUtils.cd "/"
+        
+        c.convert("infile.txt", to: "outfile.html").should == "/outfile.html"
+        c.convert("/home/username/infile.txt", to: "/home/username/outfile.html").should == "/home/username/outfile.html"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: odf-converter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Vandersluis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyuno
+  requirement: &20530940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *20530940
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &20530480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20530480
+- !ruby/object:Gem::Dependency
+  name: pry-editline
+  requirement: &20529660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20529660
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &20528780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20528780
+description: Ruby library for converting ODF files through OO.org
+email:
+- dvandersluis@selfmgmt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/odf-converter.rb
+- lib/odf/converter.rb
+- lib/odf/converter/families.rb
+- lib/odf/converter/filters/base_filter.rb
+- lib/odf/converter/filters/export.rb
+- lib/odf/converter/filters/import.rb
+- lib/odf/converter/hash.rb
+- lib/odf/converter/version.rb
+- odf-converter.gemspec
+- spec/odf/converter_spec.rb
+homepage: https://www.github.com/dvandersluis/odf-converter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Uses a native Ruby-UNO bridge (rubyuno) to connect to OpenOffice.org running
+  as a service and convert ODF documents to a different format.
+test_files:
+- spec/odf/converter_spec.rb
+has_rdoc: