goldendocx 0.2.2

data/lib/goldendocx/tables/row.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Tables
+    class Row
+      include Goldendocx::Element
+
+      namespace :w
+      tag :tr
+
+      embeds_one :row_property, class_name: 'Goldendocx::Tables::Properties::RowProperty', auto_build: true
+      embeds_many :cells, class_name: 'Goldendocx::Tables::Cell'
+
+      def height=(height)
+        row_property.height.height = height if height
+      end
+
+      def add_cell(data)
+        cell = case data
+               when Goldendocx::Tables::Cell then data
+               when Hash then Goldendocx::Tables::Cell.new(data)
+               else Goldendocx::Tables::Cell.new(content: data.to_s)
+               end
+        cells << cell
+      end
+    end
+  end
+end

data/lib/goldendocx/tables.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Tables
+    DEFAULT_TABLE_DXA_WIDTH = 8600
+    DEFAULT_CELL_DXA_WIDTH = 600
+    DEFAULT_CELL_DXA_HEIGHT = 600
+
+    DEFAULT_BACKGROUND_COLOR = 'F5F5F5'
+  end
+end
+
+require 'goldendocx/tables/properties'
+require 'goldendocx/tables/row'
+require 'goldendocx/tables/cell'
+
+Dir.glob(File.join(File.dirname(__FILE__), 'tables', '*.rb').to_s).sort.each do |file|
+  require file
+end

data/lib/goldendocx/units.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# About Measuring units https://startbigthinksmall.wordpress.com/2010/01/04/points-inches-and-emus-measuring-units-in-office-open-xml/
+module Goldendocx
+  module Units
+    EMU_PER_PIXEL = 9525
+    EMU_PER_POINT = 12700
+    EMU_PER_CENTIMETER = 360000
+    EMU_PER_DXA = 635
+  end
+end

data/lib/goldendocx/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  VERSION = '0.2.2'
+end

data/lib/goldendocx/xml_serializers/nokogiri.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module Goldendocx
+  module XmlSerializers
+    module Nokogiri
+      class << self
+        DEFAULT_BUILD_OPTIONS = ::Nokogiri::XML::Node::SaveOptions.new.tap do |options|
+          options.default_xml
+          options.no_declaration
+        end
+
+        def parse(xml, paths = [])
+          xml = ::Nokogiri::XML(xml)
+          # Should with namespaces
+          xml = xml.xpath(paths.map { |path| path.include?(':') || path == '*' ? path : ['xmlns', path].join(':') }.join('/')) unless paths.empty?
+          xml
+        end
+
+        def build_xml(tag, &block)
+          build_element(tag, &block).to_xml(indent: 0, save_with: DEFAULT_BUILD_OPTIONS).delete("\n")
+        end
+
+        def build_document_xml(tag, namespaces = [], ignore_namespaces = [], &block)
+          build_document(tag, namespaces, ignore_namespaces, &block).to_xml(indent: 0).delete("\n")
+        end
+
+        def build_document(tag, namespaces = [], ignore_namespaces = [])
+          ::Nokogiri::XML('<?xml version="1.0" encoding="UTF-8" standalone="yes"?>').tap do |root|
+            root << ::Nokogiri::XML::Node.new(tag, root).tap do |document|
+              Goldendocx::NAMESPACES.slice(*namespaces).each do |key, namespace|
+                document.add_namespace key.to_s, namespace
+              end
+              document['mc:Ignorable'] = ignore_namespaces.join(' ') unless ignore_namespaces.empty?
+
+              yield(document) if block_given?
+            end
+          end
+        end
+
+        def build_element(tag, parent: nil)
+          parent ||= ::Nokogiri::XML('<?xml version="1.0"')
+          ::Nokogiri::XML::Node.new(tag, parent).tap do |element|
+            yield(element) if block_given?
+          end
+        end
+      end
+    end
+  end
+end
+
+# FIXME: Temporarily here to provider syntactic sugar
+module Nokogiri
+  module XML
+    class Node
+      def <<(node_or_tags)
+        # FIXME: Add this line to transform element implicitly
+        node_or_tags = node_or_tags.public_send(:to_element, parent: self) if node_or_tags.respond_to?(:to_element)
+
+        add_child(node_or_tags)
+        self
+      end
+    end
+  end
+end

data/lib/goldendocx/xml_serializers/ox.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'ox'
+
+module Goldendocx
+  module XmlSerializers
+    class Ox
+      class << self
+        def parse(xml, paths = [])
+          xml = ::Ox.parse(xml)
+          xml = xml.locate(paths.join('/')) unless paths.empty?
+          xml
+        end
+
+        def build_xml(tag, &block)
+          xml = build_element(tag, &block)
+          ::Ox.dump(xml, indent: -1, with_xml: true)
+        end
+
+        def build_document_xml(tag, namespaces = [], ignore_namespaces = [], &block)
+          xml = build_document(tag, namespaces, ignore_namespaces, &block)
+          ::Ox.dump(xml, indent: -1, with_xml: true)
+        end
+
+        def build_document(tag, namespaces = [], ignore_namespaces = [])
+          ::Ox::Document.new(encoding: 'UTF-8', version: '1.0', standalone: 'yes').tap do |root|
+            root << ::Ox::Element.new(tag).tap do |document|
+              Goldendocx::NAMESPACES.slice(*namespaces).each do |key, namespace|
+                document["xmlns:#{key}"] = namespace
+              end
+
+              document['mc:Ignorable'] = ignore_namespaces.join(' ') unless ignore_namespaces.empty?
+
+              yield(document) if block_given?
+            end
+          end
+        end
+
+        def build_element(tag)
+          ::Ox::Element.new(tag).tap do |element|
+            yield(element) if block_given?
+          end
+        end
+      end
+    end
+  end
+end
+
+# FIXME: Temporarily here to provider syntactic sugar
+module Ox
+  class Element
+    def <<(node)
+      # FIXME: Add this line to transform element implicitly
+      node = node.public_send(:to_element) if node.respond_to?(:to_element)
+
+      raise 'argument to << must be a String or Ox::Node.' unless node.is_a?(String) || node.is_a?(Node)
+
+      @nodes = [] if !instance_variable_defined?(:@nodes) || @nodes.nil?
+      @nodes << node
+      self
+    end
+  end
+end

data/lib/goldendocx.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'zip'
+
+require 'goldendocx/version'
+require 'goldendocx/docx'
+
+module Goldendocx
+  autoload :Configuration, 'goldendocx/configuration'
+
+  NAMESPACES = {
+    a: 'http://schemas.openxmlformats.org/drawingml/2006/main',
+    a14: 'http://schemas.microsoft.com/office/drawing/2010/main',
+    c: 'http://schemas.openxmlformats.org/drawingml/2006/chart',
+    c14: 'http://schemas.microsoft.com/office/drawing/2007/8/2/chart',
+    cx: 'http://schemas.microsoft.com/office/drawing/2014/chartex',
+    cx1: 'http://schemas.microsoft.com/office/drawing/2015/9/8/chartex',
+    cx2: 'http://schemas.microsoft.com/office/drawing/2015/10/21/chartex',
+    cx3: 'http://schemas.microsoft.com/office/drawing/2016/5/9/chartex',
+    cx4: 'http://schemas.microsoft.com/office/drawing/2016/5/10/chartex',
+    cx5: 'http://schemas.microsoft.com/office/drawing/2016/5/11/chartex',
+    cx6: 'http://schemas.microsoft.com/office/drawing/2016/5/12/chartex',
+    cx7: 'http://schemas.microsoft.com/office/drawing/2016/5/13/chartex',
+    cx8: 'http://schemas.microsoft.com/office/drawing/2016/5/14/chartex',
+    m: 'http://schemas.openxmlformats.org/officeDocument/2006/math',
+    mc: 'http://schemas.openxmlformats.org/markup-compatibility/2006',
+    mo: 'http://schemas.microsoft.com/office/mac/office/2008/main',
+    mv: 'urn:schemas-microsoft-com:mac:vml',
+    o: 'urn:schemas-microsoft-com:office:office',
+    pic: 'http://schemas.openxmlformats.org/drawingml/2006/picture',
+    r: 'http://schemas.openxmlformats.org/officeDocument/2006/relationships',
+    sl: 'http://schemas.openxmlformats.org/schemaLibrary/2006/main',
+    v: 'urn:schemas-microsoft-com:vml',
+    w: 'http://schemas.openxmlformats.org/wordprocessingml/2006/main',
+    w10: 'urn:schemas-microsoft-com:office:word',
+    w14: 'http://schemas.microsoft.com/office/word/2010/wordml',
+    w15: 'http://schemas.microsoft.com/office/word/2012/wordml',
+    w16cid: 'http://schemas.microsoft.com/office/word/2016/wordml/cid',
+    w16se: 'http://schemas.microsoft.com/office/word/2015/wordml/symex',
+    wne: 'http://schemas.microsoft.com/office/word/2006/wordml',
+    wp: 'http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing',
+    wp14: 'http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing',
+    wpc: 'http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas',
+    wpg: 'http://schemas.microsoft.com/office/word/2010/wordprocessingGroup',
+    wpi: 'http://schemas.microsoft.com/office/word/2010/wordprocessingInk',
+    wps: 'http://schemas.microsoft.com/office/word/2010/wordprocessingShape'
+  }.freeze
+
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def xml_serializer
+      @xml_serializer ||=
+        begin
+          case config.xml_serializer
+          when :ox then require 'goldendocx/xml_serializers/ox'
+          when :nokogiri then require 'goldendocx/xml_serializers/nokogiri'
+          else raise StandardError, 'Unsupported XML serializer'
+          end
+
+          serializer_class = "Goldendocx::XmlSerializers::#{config.xml_serializer.to_s.capitalize}"
+          Kernel.const_get(serializer_class)
+        end
+    end
+  end
+end

data/sig/goldendocx.rbs

@@ -0,0 +1,4 @@
+module Goldendocx
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,347 @@
+--- !ruby/object:Gem::Specification
+name: goldendocx
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- WangYuechen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.19'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+description: Ruby APIs for manipulating Microsoft Word based upon OOXML standards.
+email:
+- 291943739@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- coverage/.last_run.json
+- demo/charts/create_bar_chart.rb
+- demo/charts/create_column_chart.rb
+- demo/charts/create_doughnut_chart.rb
+- demo/charts/create_line_chart.rb
+- demo/images/append_image.rb
+- demo/images/append_styled_image.rb
+- demo/tables/create_embed_image_table.rb
+- demo/tables/create_plain_table.rb
+- demo/tables/create_styled_table.rb
+- demo/templates/bg.png
+- demo/templates/blankDocument.docx
+- demo/templates/image_base64
+- demo/templates/styles/reportLabel
+- demo/templates/styles/reportSubTitle
+- demo/templates/styles/reportTable
+- demo/templates/styles/reportTitle
+- demo/texts/append_plain_text.rb
+- demo/texts/append_styled_text.rb
+- lib/goldendocx.rb
+- lib/goldendocx/charts.rb
+- lib/goldendocx/charts/category_axis.rb
+- lib/goldendocx/charts/properties.rb
+- lib/goldendocx/charts/properties/auto_title_deleted_property.rb
+- lib/goldendocx/charts/properties/axis_property.rb
+- lib/goldendocx/charts/properties/bar_chart_property.rb
+- lib/goldendocx/charts/properties/chart_property.rb
+- lib/goldendocx/charts/properties/column_chart_property.rb
+- lib/goldendocx/charts/properties/cross_axis_property.rb
+- lib/goldendocx/charts/properties/data_lables_property.rb
+- lib/goldendocx/charts/properties/direction_property.rb
+- lib/goldendocx/charts/properties/doughnut_chart_property.rb
+- lib/goldendocx/charts/properties/grouping_property.rb
+- lib/goldendocx/charts/properties/hole_property.rb
+- lib/goldendocx/charts/properties/index_property.rb
+- lib/goldendocx/charts/properties/label_hidden_property.rb
+- lib/goldendocx/charts/properties/layout_property.rb
+- lib/goldendocx/charts/properties/line_chart_property.rb
+- lib/goldendocx/charts/properties/marker_property.rb
+- lib/goldendocx/charts/properties/number_list_property.rb
+- lib/goldendocx/charts/properties/order_property.rb
+- lib/goldendocx/charts/properties/plot_area_property.rb
+- lib/goldendocx/charts/properties/point_count_property.rb
+- lib/goldendocx/charts/properties/point_property.rb
+- lib/goldendocx/charts/properties/rounded_corner_property.rb
+- lib/goldendocx/charts/properties/series_category_property.rb
+- lib/goldendocx/charts/properties/series_text_property.rb
+- lib/goldendocx/charts/properties/series_value_property.rb
+- lib/goldendocx/charts/properties/smooth_property.rb
+- lib/goldendocx/charts/properties/string_list_property.rb
+- lib/goldendocx/charts/properties/symbol_property.rb
+- lib/goldendocx/charts/properties/text_value_property.rb
+- lib/goldendocx/charts/reference.rb
+- lib/goldendocx/charts/series.rb
+- lib/goldendocx/charts/value_axis.rb
+- lib/goldendocx/components.rb
+- lib/goldendocx/components/bar_chart.rb
+- lib/goldendocx/components/chart.rb
+- lib/goldendocx/components/column_chart.rb
+- lib/goldendocx/components/doughnut_chart.rb
+- lib/goldendocx/components/image.rb
+- lib/goldendocx/components/line_chart.rb
+- lib/goldendocx/components/paragraph.rb
+- lib/goldendocx/components/properties.rb
+- lib/goldendocx/components/properties/align_property.rb
+- lib/goldendocx/components/properties/bold_property.rb
+- lib/goldendocx/components/properties/color_property.rb
+- lib/goldendocx/components/properties/drawing.rb
+- lib/goldendocx/components/properties/extents_property.rb
+- lib/goldendocx/components/properties/graphic_data_property.rb
+- lib/goldendocx/components/properties/graphic_frame_locks_property.rb
+- lib/goldendocx/components/properties/graphic_frame_property.rb
+- lib/goldendocx/components/properties/graphic_property.rb
+- lib/goldendocx/components/properties/inline.rb
+- lib/goldendocx/components/properties/non_visual_property.rb
+- lib/goldendocx/components/properties/padding_property.rb
+- lib/goldendocx/components/properties/property.rb
+- lib/goldendocx/components/properties/run.rb
+- lib/goldendocx/components/properties/run_property.rb
+- lib/goldendocx/components/properties/style_property.rb
+- lib/goldendocx/components/properties/textual.rb
+- lib/goldendocx/components/table.rb
+- lib/goldendocx/components/text.rb
+- lib/goldendocx/configuration.rb
+- lib/goldendocx/content_types/default.rb
+- lib/goldendocx/content_types/override.rb
+- lib/goldendocx/document.rb
+- lib/goldendocx/documents.rb
+- lib/goldendocx/documents/body.rb
+- lib/goldendocx/documents/document.rb
+- lib/goldendocx/documents/element.rb
+- lib/goldendocx/documents/relationship.rb
+- lib/goldendocx/documents/relationships.rb
+- lib/goldendocx/documents/style.rb
+- lib/goldendocx/documents/styles.rb
+- lib/goldendocx/documents/unparsed_style.rb
+- lib/goldendocx/docx.rb
+- lib/goldendocx/element.rb
+- lib/goldendocx/images.rb
+- lib/goldendocx/images/picture.rb
+- lib/goldendocx/images/properties.rb
+- lib/goldendocx/images/properties/blip_property.rb
+- lib/goldendocx/images/properties/drawing_property.rb
+- lib/goldendocx/images/properties/extents_property.rb
+- lib/goldendocx/images/properties/fill_rectangle_property.rb
+- lib/goldendocx/images/properties/image_data_property.rb
+- lib/goldendocx/images/properties/non_visual_drawing_property.rb
+- lib/goldendocx/images/properties/non_visual_picture_property.rb
+- lib/goldendocx/images/properties/picture_fill_property.rb
+- lib/goldendocx/images/properties/picture_shape_property.rb
+- lib/goldendocx/images/properties/shape_property.rb
+- lib/goldendocx/images/properties/stretch_property.rb
+- lib/goldendocx/images/properties/transform_property.rb
+- lib/goldendocx/images/shape.rb
+- lib/goldendocx/parts.rb
+- lib/goldendocx/parts/content_types.rb
+- lib/goldendocx/parts/documents.rb
+- lib/goldendocx/parts/media.rb
+- lib/goldendocx/tables.rb
+- lib/goldendocx/tables/cell.rb
+- lib/goldendocx/tables/header_cell.rb
+- lib/goldendocx/tables/header_row.rb
+- lib/goldendocx/tables/image_cell.rb
+- lib/goldendocx/tables/properties.rb
+- lib/goldendocx/tables/properties/cell_property.rb
+- lib/goldendocx/tables/properties/cell_width_property.rb
+- lib/goldendocx/tables/properties/grid_column_property.rb
+- lib/goldendocx/tables/properties/grid_property.rb
+- lib/goldendocx/tables/properties/grid_span_property.rb
+- lib/goldendocx/tables/properties/header_row_property.rb
+- lib/goldendocx/tables/properties/property.rb
+- lib/goldendocx/tables/properties/row_height_property.rb
+- lib/goldendocx/tables/properties/row_property.rb
+- lib/goldendocx/tables/properties/shading_property.rb
+- lib/goldendocx/tables/properties/style_property.rb
+- lib/goldendocx/tables/properties/vertical_align_property.rb
+- lib/goldendocx/tables/properties/width_property.rb
+- lib/goldendocx/tables/row.rb
+- lib/goldendocx/units.rb
+- lib/goldendocx/version.rb
+- lib/goldendocx/xml_serializers/nokogiri.rb
+- lib/goldendocx/xml_serializers/ox.rb
+- sig/goldendocx.rbs
+homepage: https://github.com/SheldonLeo/goldendocx
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.23
+signing_key:
+specification_version: 4
+summary: The Ruby API for Microsoft Word
+test_files: []