onlyoffice / ooxml_parser Goto Github PK

View Code? Open in Web Editor NEW

83.0 18.0 21.0 78.78 MB

Ruby OOXML Parser

License: GNU Affero General Public License v3.0

Ruby 100.00%

ooxml docx pptx xlsx ruby parser ooxml-parser

ooxml_parser's Introduction

ooxml_parser

ooxml_parser is a Ooxml files (docx, xlsx, pptx) parser written in Ruby.

Installation

Install magic lib, required by ruby-filemagic
Mac OS:
```
brew install libmagic
```
Debian-Based Linux:
```
sudo apt-get install libmagic-dev
```
Centos-Based Linux:
```
sudo yum install file-devel
```
Install gem by command:
```
gem install ooxml_parser
```

Usage

Parse a docx file

require 'ooxml_parser'
docx = OoxmlParser::Parser.parse('spec/document/document_properties/page_count.docx')
p docx.document_properties.pages # 2

Also check the example directory for more examples.

Configuration

Accuracy

Accuracy of digits in fraction part Default is 2 digits in fraction part

OoxmlParser.configure do |config|
  config.accuracy = 3
end

Changes

Renamed SeriesText#string to SeriesText#reference

ooxml_parser's People

Contributors

Stargazers

Watchers

ooxml_parser's Issues

Table_borders has not properties

SetBasedOn.docx
docx.elements[1].properties.table_borders has not properties

Tab position is float

SetTabs.docx
docx.elements.first.tabs.first.position
Need this to eq OoxmlParser::OoxmlSize.new(1440, :twip)

Numbering properties is eq one(1), cant get properties from obj

GetTextPr.docx
docx.elements.first.numbering.numbering_properties.ilvls.first.font = "Calibri"
docx.elements.first.numbering.numbering_properties.ilvls.first.font_size = 28
but now
docx.elements.first.numbering.numbering_properties = 1

Implement support of units of measurement in OOXML Parser

table border space is not ooxmlsize obj, its float

SetTableInd.docx
docx.elements[1].properties.table_indent = 2.5396825396825395 (!):float

Add opportunity to get header and footer distance to top/bottom

FooterDistance = 1440 twips
SetFooterDistance.docx

HeaderDistance = 1440 twips
SetHeaderDistance (1).docx

right_to_left value is wrong

SetTextDirection.docx
docx.elements[1].properties.right_to_left is true, but text in table (elements[1]) is write to up/

Add shading type of background_color option for run

The shading type applied to the contents of the text run. Need option nil and clear for background_color option
See examples:
nil type
nil.docx
clear type
clear.docx

Drawing position is float

SetPosition.xlsx
xlsx.worksheets.first.drawings.first.position.from.column_offset
Need this to eq OoxmlParser::OoxmlSize.new(72000, :emu)
And also for xlsx.worksheets.first.drawings.first.position.from.row_offset

Add opportunity to get cell color

GetTableCellPr (1).docx
This code returns PresentationFill obj. Need to return Color class obj
docx.elements[1].rows.first.cells.first.properties.color

Add spacing to table

SetCellSpacing.docx
table spacing = 720 twip
I cant find it in object

Spacing:after in float value

SetSpacingAfter.docx
docx.elements.first.spacing.after = 2.54 its wrong

Add table cell spacing to ooxml object

SetCellSpacing.docx
I dont know, where it is has been placed, but i cant find celll spacing = 720 twip

Contextual spacing in always true

SetContextualSpacing (2).docx
contextual_spacing in 1,2,3 and 4 paragraph is false. For 5 and 6 - true.

`rStyle` is not parsed for run properties

<w:rPr>
<w:rStyle w:val="127"/>
</w:rPr>

table border space is not ooxmlsize obj, if it eq 0

SetTableBorderBottom.docx
docx.elements[1].properties.table_borders.bottom.space is equal 0:float
Need to eq OoxmlSize.new(0, :point)

SetTableBorderBottom11.docx
space = 11 points in this file

Font style of cells test is wrong

GetTextPr.docx
In first cell of table i see bold text, but ooxml object is not show it. In show text, but font style is wrong
docx.elements[1].rows.first.cells.first.elements.first.character_style_array[1].font_style.bold

table_look not content ColBandSize and RowBandSize

SetStyleColBandSize (8).docx
is a ColBandSize = 2

SetStyleRowBandSize.docx
is a RowBandSize = 2

SetStyleColBandSize5.docx
is a ColBandSize = 5

SetStyleRowBandSize5.docx
is a RowBandSize = 5

Add table_height to table properties

SetHeight.docx
In this example, height = 720 twip and type = "atLeast", but i cant find this properties in ooxml object

Make deprecated calls for Chart Data

All that data now stored in series
Remove that stuff
https://github.com/ONLYOFFICE/ooxml_parser/blob/master/lib/ooxml_parser/common_parser/common_data/alternate_content/chart/chart.rb#L40

Parent is nil

SetShd.docx
docx.elements[1].properties.table_style.table_cell_properties.color.parent eq nil

Add tables base style obj

SetBasedOn.docx
Add object of table base style

table_width is parsed like a flout

SetStyle.docx
In example file, table_width is eq("percent", 100);.
But parser is return 8.818342151675486 number.
Need to return Ooxml size parser object with 100% value.
docx.elements[1].properties.table_width is a path

'prstClr' is not parsed for color properties

CreatePresetColor.xlsx

<a:gs pos="0">
<a:prstClr val="lightYellow"/>
</a:gs>

Cell margins is float, not OoxmlSize obj

GetTablePr.docx
docx.elements[1].rows.first.cells.first.properties.margins.top.class - Float
Its true for left, right and bottom margins

Add opportunity to get parameters of non-printed symbols

GetParagraphMarkTextPr (1).docx
In this file non-printed symbols has parameters:
font size - 52
font color - 255, 255, 0
spacing - 5
But i cant to take this from parser

xlsx run space is dimensionless

SetSpacing.xlsx
xlsx.worksheets.first.drawings.first.shape.text_body.paragraphs.first.runs[1].properties.space

Add TableLayout to table properties

SetTableLayout (2).docx
TableLayout = fixed

SetTableLayout.docx
TableLayout = autofit

Delete merge option

MergeCells.docx
In this example, cells 2.2 -3.3 is merged.
docx.elements[1].rows[1].cells[1].properties.merge

Add new units delimiter - hps

Half-points(hps) (2 half-points = 1 point).
See position option in character_style_array obj
SetPosition.docx

Add type of fill to table shading

SetShd.docx
docx.elements[1].properties.shd - this option is contains only color (OoxmlParser::Color.new(238, 238, 238)), but not contain type of shading (clear in example file)

Found all places there is incorrect call to unit of measurement

It also included calls with magic number values

Add ability to call `parent` object to all OoxmlObjects

Add new units delimiter - pt_8

pt_8 - Eighths of a point (24 eighths of a point = 3 points).
Sometimes this is used for set width of the border

Add distance between columns

Add opportunity to get distance between columns
SetEqualColumns.docx
In this example, distance between columns eq 720 twips

Add separator between numbering and text

space.docx
tab.docx
none.docx
docx.elements[0].numbering.abstruct_numbering.level_list.first - is a numbering style. In first example, after numbering has setted space. In second - tab. In third - none.

Add new units delimiter - twips

twips equivalent to 1/1440th of an inch. Sometimes this is used in indents

Row height is nil in docx obj

GetTableRowPr.docx
Docx file has table with height row = 1440 twips and with rule from height value is atLeast, but code:
docx.elements[1].rows.first.table_row_properties.height return nil

'schemeClr' for color properties

CreateSchemeColor.xlsx

<a:gs pos="0">
<a:schemeClr val="accent6"/>
</a:gs>

xlsx.worksheets.first.drawings.first.shape.properties.fill_color.value.gradient_stops.first.color

In second header -

"This is page header #2. Only this header can be seen, as the first one has been removed."

But docx.notes objecT (only one) has one element with second headers data.