asposewordsjavaforruby 0.0.3 → 0.0.4

data/Gempackage

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2001-2015 Aspose Pty Ltd
+
+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,2 @@
+# Aspose_Words_Java_for_Ruby
+Aspose Words Java for Ruby is a gem that demonstrates / provides the Aspose.Words for Java API usage examples in Ruby by using Rjb - Ruby Java Bridge.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/asposewordsjavaforruby.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asposewordsjavaforruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'asposewordsjavaforruby'
+  spec.version       = Asposewordsjavaforruby::VERSION
+  spec.authors       = ['Aspose Marketplace']
+  spec.email         = ['marketplace@aspose.com']
+  spec.summary       = %q{A Ruby gem to work with aspose.words libraries}
+  spec.description   = %q{AsposeWordsJavaforRuby is a Ruby gem that can help working with aspose.words libraries}
+  spec.homepage      = 'https://github.com/asposemarketplace/Aspose_Words_Java_for_Ruby'
+  spec.license       = 'MIT'
+
+spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'rjb', '~> 1.5.3'
+
+end

data/config/aspose.yml

@@ -0,0 +1,5 @@
+jar_dir: ../asposewordsjavaforruby/jars
+license_path: ../asposewordsjavaforruby/license/path
+jvm_args: -Xms512m -Xmx1G
+
+

data/data/LoadTxt.txt

@@ -0,0 +1,15 @@
+	Despite the fact txt format itself provides us with only "text" features for document lay-out, an ordinary txt file may contains many different pieces of formatting.
+	One of the text features is using "Tab" key to make indented paragraphs.
+		Paragraphs also may be nested within one another by using multiple "Tab" to increase the indent.
+
+Many txt files aslo contain lists formatted with bullets. The bullet symbol may take any of a variety of shapes, such as:
+- circular.
+- square.
+- diamond.
+- arrow.
+- etc.
+
+An alternative method to format data is to use a numbered list. Here is some examples of using numbers and characters for making numbered list:
+1. Arabic numerals (1, 2, 3, ...).
+2. Roman numerals (I, II, III, ... or i, ii, iii, ...).
+3. Letters (A, B, C, ... or a, b, c, ...).

data/lib/asposewordsjavaforruby.rb

@@ -0,0 +1,71 @@
+require_relative 'asposewordsjavaforruby/version'
+require_relative 'asposewordsjavaforruby/asposewordsjava'
+require 'logger'
+require 'rjb'
+
+module Asposewordsjavaforruby
+
+  class << self
+    attr_accessor :aspose_words_config
+  end
+
+  def initialize_aspose_words
+    aspose_jars_dir = Asposewordsjavaforruby.aspose_words_config ? Asposewordsjavaforruby.aspose_words_config['jar_dir'] : nil  
+    aspose_license_path = Asposewordsjavaforruby.aspose_words_config ? Asposewordsjavaforruby.aspose_words_config['license_path'] : nil
+    jvm_args = Asposewordsjavaforruby.aspose_words_config ? Asposewordsjavaforruby.aspose_words_config['jvm_args'] : nil
+    
+    load_aspose_jars(aspose_jars_dir, jvm_args)
+    load_aspose_license(aspose_license_path)
+  end
+
+  def load_aspose_license(aspose_license_path)
+    if aspose_license_path && File.exist?(aspose_license_path)
+      set_license(File.join(aspose_license_path))
+    else
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::WARN
+      logger.warn('Using the non licensed aspose jar. Please specify path to your aspose license directory in config/aspose.yml file!')
+    end
+  end
+
+  def load_aspose_jars(aspose_jars_dir, jvm_args)
+    if aspose_jars_dir && File.exist?(aspose_jars_dir)
+      jardir = File.join(aspose_jars_dir, '**', '*.jar')
+    else
+      jardir = File.join(File.dirname(File.dirname(__FILE__)), 'jars', '**', '*.jar')
+    end
+
+    if jvm_args
+      args = jvm_args.split(' ') << '-Djava.awt.headless=true'
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::DEBUG
+      logger.debug("JVM args : #{args}")
+      Rjb::load(classpath = Dir.glob(jardir).join(':'), jvmargs=args)
+    else
+      Rjb::load(classpath = Dir.glob(jardir).join(':'), jvmargs=['-Djava.awt.headless=true'])
+    end
+
+  end
+
+  def input_file(file)
+    Rjb::import('java.io.FileInputStream').new(file)
+  end
+
+  def set_license(aspose_license_file)
+    begin
+      fstream = input_file(aspose_license_file)
+      license = Rjb::import('com.aspose.api.License').new()
+      license.setLicense(fstream)
+    rescue Exception => ex
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::ERROR
+      logger.error("Could not load the license file : #{ex}")
+      fstream.close() if fstream
+    end
+  end
+
+  def self.configure_aspose_words config
+    Asposewordsjavaforruby.aspose_words_config = config
+  end
+
+end

data/lib/asposewordsjavaforruby/addwatermark.rb

@@ -0,0 +1,84 @@
+module Asposewordsjavaforruby
+  module AddWatermark
+    def initialize()
+        # The path to the documents directory.
+        data_dir = File.dirname(File.dirname(File.dirname(__FILE__))) + '/data/'
+        
+        doc = Rjb::import('com.aspose.words.Document').new(data_dir + "TestWatermark.doc")
+        
+        insert_watermark_text(doc, "CONFIDENTIAL")
+        
+        doc.save(data_dir + "TestWatermark Out.doc")
+    end
+
+=begin
+    Inserts a watermark into a document.
+    
+    @param doc The input document.
+    @param watermarkText Text of the watermark.
+=end
+    def insert_watermark_text(doc, watermark_text)       
+        # Create a watermark shape. This will be a WordArt shape.
+        # You are free to try other shape types as watermarks.
+        shape_type = Rjb::import("com.aspose.words.ShapeType")
+        watermark = Rjb::import("com.aspose.words.Shape").new(doc,  shape_type.TEXT_PLAIN_TEXT)
+
+        # Set up the text of the watermark.
+        watermark.getTextPath().setText(watermark_text)
+        watermark.getTextPath().setFontFamily("Arial")
+        watermark.setWidth(500)
+        watermark.setHeight(100)
+        
+        # Text will be directed from the bottom-left to the top-right corner.
+        watermark.setRotation(-40)
+
+        # Remove the following three lines if you need a solid black text.
+        color = Rjb::import("java.awt.Color")
+        watermark.getFill().setColor(color.GRAY) # Try LightGray to get more Word-style watermark
+        watermark.setStrokeColor(color.GRAY) # Try LightGray to get more Word-style watermark
+
+        # Place the watermark in the page center.
+        relativeHorizontalPosition = Rjb::import("com.aspose.words.RelativeHorizontalPosition")
+        watermark.setRelativeHorizontalPosition(relativeHorizontalPosition.PAGE)
+        watermark.setRelativeVerticalPosition(relativeHorizontalPosition.PAGE)
+        
+        wrapType = Rjb::import("com.aspose.words.WrapType")
+        watermark.setWrapType(wrapType.NONE)
+
+        verticalAlignment = Rjb::import("com.aspose.words.VerticalAlignment")
+        watermark.setVerticalAlignment(verticalAlignment.CENTER)
+
+        horizontalAlignment = Rjb::import("com.aspose.words.HorizontalAlignment")
+        watermark.setHorizontalAlignment(horizontalAlignment.CENTER)
+
+        # Create a new paragraph and append the watermark to this paragraph.
+        watermarkPara = Rjb::import("com.aspose.words.Paragraph").new(doc)
+        watermarkPara.appendChild(watermark)
+        sects = doc.getSections().toArray()
+
+        # Insert the watermark into all headers of each document section.
+        sects.each do |sect|
+            headerFooterType = Rjb::import("com.aspose.words.HeaderFooterType")
+            # There could be up to three different headers in each section, since we want
+            # the watermark to appear on all pages, insert into all headers.
+            insert_watermark_into_header(watermarkPara, sect, headerFooterType.HEADER_PRIMARY)
+            insert_watermark_into_header(watermarkPara, sect, headerFooterType.HEADER_FIRST)
+            insert_watermark_into_header(watermarkPara, sect, headerFooterType.HEADER_EVEN)
+        end
+    end    
+
+    def insert_watermark_into_header(watermarkPara, sect, headerType)
+        header = sect.getHeadersFooters().getByHeaderFooterType(headerType)
+        
+        if header.nil? then
+            # There is no header of the specified type in the current section, create it.
+            header = Rjb::import("com.aspose.words.HeaderFooter").new(sect.getDocument(), headerType)
+            sect.getHeadersFooters().add(header)
+        end
+        
+        # Insert a clone of the watermark into the header.
+        header.appendChild(watermarkPara.deepClone(true))
+    end
+
+  end
+end

data/lib/asposewordsjavaforruby/appenddoc.rb

@@ -0,0 +1,24 @@
+module Asposewordsjavaforruby
+  module AppendDoc
+    def initialize()
+        # Append document.
+        append_documents()
+    end
+        
+    def append_documents()
+        data_dir = File.dirname(File.dirname(File.dirname(__FILE__))) + '/data/quickstart/'
+        
+        # Load the destination and source documents from disk.
+        dst_doc = Rjb::import('com.aspose.words.Document').new(data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import('com.aspose.words.Document').new(data_dir + "TestFile.Source.doc")
+
+        importformatmode = Rjb::import('com.aspose.words.ImportFormatMode')
+        source_formating = importformatmode.KEEP_SOURCE_FORMATTING
+
+        # Append the source document to the destination document while keeping the original formatting of the source document.
+        dst_doc.appendDocument(src_doc, source_formating)
+        dst_doc.save(data_dir + "TestFile Out.docx")
+    end
+
+  end
+end

data/lib/asposewordsjavaforruby/appenddocument.rb

@@ -0,0 +1,229 @@
+module Asposewordsjavaforruby
+  module AppendDocument
+    def initialize()
+        # The path to the documents directory.
+        @data_dir = File.dirname(File.dirname(File.dirname(__FILE__))) + '/data/joiningandappending/'
+    
+        simple_append_document()
+        keep_source_formatting()
+        use_destination_styles()
+        join_continuous()
+        join_new_page()
+        restart_page_numbering()
+        link_headers_footers()
+        unlink_headers_footers()
+        remove_source_headers_footers()
+        different_page_setup()
+    end
+
+=begin
+    Shows how to append a document to the end of another document using no additional options.
+=end
+    def simple_append_document()
+        # Load the documents to join.
+        dst_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Source.doc")
+        
+        # Append the source document to the destination document using no extra options.
+        import_format_mode = Rjb::import("com.aspose.words.ImportFormatMode")
+        dst_doc.appendDocument(src_doc, import_format_mode.KEEP_SOURCE_FORMATTING)
+        
+        # Save the document.
+        dst_doc.save(@data_dir + "TestFile.SimpleAppendDocument Out.docx")
+    end
+
+=begin
+    Shows how to append a document to another document while keeping the original formatting.
+=end
+    def keep_source_formatting()
+        # Load the documents to join.
+        dst_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Source.doc")
+        
+        # Append the source document to the destination document using no extra options.
+        import_format_mode = Rjb::import("com.aspose.words.ImportFormatMode")
+        dst_doc.appendDocument(src_doc, import_format_mode.KEEP_SOURCE_FORMATTING)
+        
+        # Save the document.
+        dst_doc.save(@data_dir + "TestFile.KeepSourceFormatting Out.docx")
+    end
+
+=begin
+    Shows how to append a document to another document using the formatting of the destination document.
+=end
+    def use_destination_styles()
+        # Load the documents to join.
+        dst_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Source.doc")
+        
+        # Append the source document to the destination document using no extra options.
+        import_format_mode = Rjb::import("com.aspose.words.ImportFormatMode")
+        dst_doc.appendDocument(src_doc, import_format_mode.USE_DESTINATION_STYLES)
+        
+        # Save the document.
+        dst_doc.save(@data_dir + "TestFile.UseDestinationStyles Out.docx")
+    end
+
+=begin
+    Shows how to append a document to another document so the content flows continuously.
+=end
+    def join_continuous()
+        # Load the documents to join.
+        dst_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Source.doc")
+        
+        # Make the document appear straight after the destination documents content.
+        section_start = Rjb::import("com.aspose.words.SectionStart")
+        src_doc.getFirstSection().getPageSetup().setSectionStart(section_start.CONTINUOUS)
+        
+        # Append the source document using the original styles found in the source document.
+        import_format_mode = Rjb::import("com.aspose.words.ImportFormatMode")
+        dst_doc.appendDocument(src_doc, import_format_mode.KEEP_SOURCE_FORMATTING)
+        
+        # Save the document.
+        dst_doc.save(@data_dir + "TestFile.JoinContinuous Out.docx") 
+    end
+
+=begin
+    Shows how to append a document to another document so it starts on a new page.
+=end
+    def join_new_page()
+        # Load the documents to join.
+        dst_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Source.doc")
+        
+        # Set the appended document to start on a new page.
+        section_start = Rjb::import("com.aspose.words.SectionStart")
+        src_doc.getFirstSection().getPageSetup().setSectionStart(section_start.NEW_PAGE)
+        
+        # Append the source document using the original styles found in the source document.
+        import_format_mode = Rjb::import("com.aspose.words.ImportFormatMode")
+        dst_doc.appendDocument(src_doc, import_format_mode.KEEP_SOURCE_FORMATTING)
+        
+        # Save the document.
+        dst_doc.save(@data_dir + "TestFile.JoinNewPage Out.docx")  
+    end 
+
+=begin
+    Shows how to append a document to another document with page numbering restarted.
+=end
+    def restart_page_numbering()
+        # Load the documents to join.
+        dst_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Source.doc")
+        
+        # Set the appended document to start on a new page.
+        section_start = Rjb::import("com.aspose.words.SectionStart")
+        src_doc.getFirstSection().getPageSetup().setSectionStart(section_start.NEW_PAGE)
+
+        # Restart the page numbering for the document to be appended.
+        src_doc.getFirstSection().getPageSetup().setRestartPageNumbering(true)
+        
+        # Append the source document using the original styles found in the source document.
+        import_format_mode = Rjb::import("com.aspose.words.ImportFormatMode")
+        dst_doc.appendDocument(src_doc, import_format_mode.KEEP_SOURCE_FORMATTING)
+        
+        # Save the document.
+        dst_doc.save(@data_dir + "TestFile.RestartPageNumbering Out.docx")
+    end
+
+=begin
+    Shows how to append a document to another document and continue headers and footers from the destination document.
+=end
+    def link_headers_footers()
+        # Load the documents to join.
+        dst_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Source.doc")
+        
+        # Set the appended document to start on a new page.
+        section_start = Rjb::import("com.aspose.words.SectionStart")
+        src_doc.getFirstSection().getPageSetup().setSectionStart(section_start.NEW_PAGE)
+        
+        # Link the headers and footers in the source document to the previous section.
+        # This will override any headers or footers already found in the source document.
+        src_doc.getFirstSection().getHeadersFooters().linkToPrevious(true)
+        
+        import_format_mode = Rjb::import("com.aspose.words.ImportFormatMode")
+        dst_doc.appendDocument(src_doc, import_format_mode.KEEP_SOURCE_FORMATTING)
+
+        # Save the document.
+        dst_doc.save(@data_dir + "TestFile.LinkHeadersFooters Out.docx")
+    end
+
+=begin
+    Shows how to append a document to another document so headers and footers do not continue from the destination document.
+=end
+    def unlink_headers_footers()
+        # Load the documents to join.
+        dst_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Source.doc")
+        
+        # Even a document with no headers or footers can still have the LinkToPrevious setting set to true.
+        # Unlink the headers and footers in the source document to stop this from continuing the headers and footers
+        # from the destination document.
+        src_doc.getFirstSection().getHeadersFooters().linkToPrevious(false)
+        
+        import_format_mode = Rjb::import("com.aspose.words.ImportFormatMode")
+        dst_doc.appendDocument(src_doc, import_format_mode.KEEP_SOURCE_FORMATTING)
+
+        # Save the document.
+        dst_doc.save(@data_dir + "TestFile.UnlinkHeadersFooters Out.docx")
+    end
+
+=begin
+    Shows how to append a document to another document so headers and footers do not continue from the destination document.
+=end
+    def remove_source_headers_footers()
+        # Load the documents to join.
+        dst_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Source.doc")
+        
+        # Remove the headers and footers from each of the sections in the source document.
+        sections = src_doc.getSections().toArray()
+        sections.each do |section|
+            section.clearHeadersFooters()    
+        end
+        
+        # Even after the headers and footers are cleared from the source document, the "LinkToPrevious" setting
+        # for HeadersFooters can still be set. This will cause the headers and footers to continue from the destination
+        # document. This should set to false to avoid this behaviour.
+        src_doc.getFirstSection().getHeadersFooters().linkToPrevious(false)
+        
+        import_format_mode = Rjb::import("com.aspose.words.ImportFormatMode")
+        dst_doc.appendDocument(src_doc, import_format_mode.KEEP_SOURCE_FORMATTING)
+
+        # Save the document.
+        dst_doc.save(@data_dir + "TestFile.RemoveSourceHeadersFooters Out.docx")        
+    end
+
+=begin
+    Shows how to append a document to another document continuously which has different page settings.
+=end
+    def different_page_setup()
+        # Load the documents to join.
+        dst_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Destination.doc")
+        src_doc = Rjb::import("com.aspose.words.Document").new(@data_dir + "TestFile.Source.doc")
+        
+        # Set the source document to continue straight after the end of the destination document.
+        # If some page setup settings are different then this may not work and the source document will appear
+        # on a new page.
+        section_start = Rjb::import("com.aspose.words.SectionStart")
+        src_doc.getFirstSection().getPageSetup().setSectionStart(section_start.CONTINUOUS)
+
+        # To ensure this does not happen when the source document has different page setup settings make sure the
+        # settings are identical between the last section of the destination document.
+        # If there are further continuous sections that follow on in the source document then this will need to be
+        # repeated for those sections as well.
+        src_doc.getFirstSection().getPageSetup().setPageWidth(dst_doc.getLastSection().getPageSetup().getPageWidth())
+        src_doc.getFirstSection().getPageSetup().setPageHeight(dst_doc.getLastSection().getPageSetup().getPageHeight())
+        src_doc.getFirstSection().getPageSetup().setOrientation(dst_doc.getLastSection().getPageSetup().getOrientation())
+        
+        import_format_mode = Rjb::import("com.aspose.words.ImportFormatMode")
+        dst_doc.appendDocument(src_doc, import_format_mode.KEEP_SOURCE_FORMATTING)
+
+        # Save the document.
+        dst_doc.save(@data_dir + "TestFile.DifferentPageSetup Out.docx")        
+    end 
+        
+  end
+end