goldendocx 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f1603ab8a5538d27e48b351b381f8859c92fb9e42169df8cbcc6104545803c2b
+  data.tar.gz: 9bc30497d4a1f96da15f8190d9edb42857f2ec6876550ebb47415f3ed5e67caa
+SHA512:
+  metadata.gz: b826c86f0013b2af7af58b047cdb5340cc912913ca78b0198ab9b506a8614a173b2d1a53f42d928da6f277f21a6312895175687a49e79e2cf63658acace1ef4a
+  data.tar.gz: cb4198c911418e3579df98019d87709a009aed9bd595b2889602e595a32d53b2a333561cd8d43dde67f40a55b1ebd6552e0921a184308417f4ce8270a215cd0f

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+
+Metrics/AbcSize:
+  CountRepeatedAttributes: false
+
+Metrics/ClassLength:
+  CountAsOne:
+    - array
+    - hash
+
+Metrics/MethodLength:
+  Max: 15
+  CountAsOne:
+    - array
+    - hash
+
+Style/Documentation:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 150
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 10
+
+

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+## [0.1.0] - 2023-02-20
+
+Basic implementation for generating a docx file based on docx file as template.
+
+Already available for production usages.
+
+### Features
+
+- Create texts for docx
+- Create tables for docx
+- Create images for docx
+- Create charts for docx ( Yet only readable for WPS )
+
+## [0.2.0] - 2023-03-22
+
+Mostly refactoring
+
+### Features
+
+- Support both `ox` and `nokogiri` as XML serializer
+
+## [0.2.1] - 2023-03-23
+
+### Features
+
+- Support customize color and bold for Text
+
+### Refactors
+
+- Introduce `ActiveSupport` to make coding easier
+- Clean irrelevant demos
+
+## [0.2.2] - 2023-03-31(WIP)
+
+### Features
+
+- Add Github CI support
+
+
+### Fixes
+
+- Fix create charts issues
+- Fix Nokogiri XML serializer compatible issues

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://gems.ruby-china.com'
+# source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    goldendocx (0.2.2)
+      activesupport (~> 7.0)
+      nokogiri (~> 1.14)
+      ox (~> 2.14)
+      rubyzip (~> 2.3)
+
+GEM
+  remote: https://gems.ruby-china.com/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.18.0)
+    nokogiri (1.14.2-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.2-x86_64-linux)
+      racc (~> 1.4)
+    ox (2.14.14)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.42.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    rubyzip (2.3.2)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov-lcov (0.8.0)
+    simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  x86_64-darwin
+  x86_64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  goldendocx!
+  rake (~> 13.0)
+  rspec (~> 3.11)
+  rubocop (~> 1.25)
+  rubocop-performance (~> 1.16)
+  rubocop-rspec (~> 2.19)
+  simplecov (~> 0.22.0)
+  simplecov-lcov (~> 0.8.0)
+
+BUNDLED WITH
+   2.3.23

data/README.md

@@ -0,0 +1,76 @@
+# The Ruby API for Microsoft Word
+
+Ruby APIs for manipulating Microsoft Word based upon OOXML standards.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add goldendocx
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install goldendocx
+
+## Usage
+
+```ruby
+  require 'goldendocx'
+```
+
+### XML Serializers
+
+Support both `ox` and `nokogiri` as XML serializer, and `ox` as default.
+
+You can customize with configuration
+```ruby
+Goldendocx.configure do |config|
+  config.xml_serializer = :nokogiri
+end
+```
+
+### Compose MS Word
+- Read MS Word file and write to another path
+    ```ruby
+      docx = Goldendocx::Docx.new(docx_file_path)
+      docx.write_to(new_file_path)
+    ```
+- Create texts to MS Word
+    ```ruby
+      docx.create_text("Hello World!")
+    ```
+    ```ruby
+      docx.add_style(well_comsposed_style_path)
+      docx.create_text("Hello World!", style: 'StyleName', align: :center)
+    ```
+- Create tables to MS Word
+    ```ruby
+      headers = %w[名称 数量 百分比]
+      rows = [
+        %w[A 10 10%],
+        %w[B 66 66%],
+        %w[C 24 24%]
+      ]
+      table = docx.create_table
+      headers.each { |header| table.add_header(header) }
+      rows.each { |row| table.add_row(row) }
+    ```
+- Create images to MS Word
+    ```ruby
+      docx.create_image(File.open(image_path))
+      docx.create_image("data:image/png;base64,ImageBase64StringData")
+      docx.create_image(Kernel.open('https://image.url'))
+    ```  
+
+- Create charts to MS Word
+    ```ruby
+      chart = docx.create_chart(:column)
+      chart.name = '地域分布详情数据'
+        
+      categories = %w[河南省 山东省 浙江省 四川省 安徽省 上海市 湖北省 山西省 河北省 贵州省]
+      values = [13, 12, 9, 9, 8, 7, 7, 6, 5, 3]
+      chart.add_series('地域分布详情数据', categories, values)
+    ```
+  
+More demos view at [Demos](demo/)
+

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: %i[rubocop spec]

data/coverage/.last_run.json

@@ -0,0 +1,5 @@
+{
+  "result": {
+    "line": 100.0
+  }
+}

data/demo/charts/create_bar_chart.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push "#{Dir.pwd}/lib"
+require 'goldendocx'
+
+docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+
+docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportTitle"))
+docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportSubTitle"))
+
+docx.create_text('地域分布详情数据（Top 10）', style: 'SubTitle')
+
+chart = docx.create_chart(:bar)
+chart.name = '地域分布详情数据（Top 10）'
+
+categories = %w[
+  河南省 山东省 浙江省 四川省 安徽省 上海市 湖北省 山西省 河北省 贵州省 广东省 江西省
+  北京市 陕西省 江苏省 广西壮族自治区 福建省 甘肃省 新疆维吾尔自治区 内蒙古自治区 黑龙江省
+  宁夏回族自治区 吉林省 天津市 辽宁省 云南省 海外
+]
+values = [
+  13, 12, 9, 9, 8, 7, 7, 6, 5, 4, 4, 3, 3, 3, 3, 2, 2, 2, 2, 2, 2, 1, 1, 1, 1, 1, 1
+]
+
+chart.add_series('地域分布详情数据', categories, values)
+
+filename = 'simpleBarChartDocument.docx'
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+docx.write_to File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/demo/charts/create_column_chart.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push "#{Dir.pwd}/lib"
+require 'goldendocx'
+
+docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+
+docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportTitle"))
+docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportSubTitle"))
+
+docx.create_text('地域分布详情数据', style: 'SubTitle')
+
+chart = docx.create_chart(:column)
+chart.name = '地域分布详情数据'
+
+categories = %w[
+  河南省 山东省 浙江省 四川省 安徽省 上海市 湖北省 山西省 河北省 贵州省 广东省 江西省
+  北京市 陕西省 江苏省 广西壮族自治区 福建省 甘肃省 新疆维吾尔自治区 内蒙古自治区 黑龙江省
+  宁夏回族自治区 吉林省 天津市 辽宁省 云南省 海外
+]
+values = [
+  13, 12, 9, 9, 8, 7, 7, 6, 5, 4, 4, 3, 3, 3, 3, 2, 2, 2, 2, 2, 2, 1, 1, 1, 1, 1, 1
+]
+chart.add_series('地域分布详情数据', categories, values)
+
+filename = 'simpleColumnChartDocument.docx'
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+docx.write_to File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/demo/charts/create_doughnut_chart.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push "#{Dir.pwd}/lib"
+require 'goldendocx'
+
+docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+
+docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportTitle"))
+docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportSubTitle"))
+
+docx.create_text('地域分布详情数据（Top 10）', style: 'SubTitle')
+
+chart = docx.create_chart(:doughnut)
+categories = %w[
+  河南省 山东省 浙江省 四川省 安徽省 上海市 湖北省 山西省 河北省 贵州省 广东省 江西省
+  北京市 陕西省 江苏省 广西壮族自治区 福建省 甘肃省 新疆维吾尔自治区 内蒙古自治区 黑龙江省
+  宁夏回族自治区 吉林省 天津市 辽宁省 云南省 海外
+]
+values = [
+  13, 12, 9, 9, 8, 7, 7, 6, 5, 4, 4, 3, 3, 3, 3, 2, 2, 2, 2, 2, 2, 1, 1, 1, 1, 1, 1
+]
+
+chart.add_series('地域分布详情数据', categories, values)
+
+filename = 'simpleDoughnutChartDocument.docx'
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+docx.write_to File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/demo/charts/create_line_chart.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push "#{Dir.pwd}/lib"
+require 'goldendocx'
+
+docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+
+docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportTitle"))
+docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportSubTitle"))
+
+docx.create_text('表单最近表现(2023.01.29-2023.02.28)', style: 'SubTitle')
+
+chart = docx.create_chart(:line)
+chart.name = '表单最近表现'
+
+categories = %w[
+  2023-01-29 2023-01-30 2023-01-31 2023-02-01 2023-02-02 2023-02-03 2023-02-04 2023-02-05
+  2023-02-06 2023-02-07 2023-02-08 2023-02-09 2023-02-10 2023-02-11 2023-02-12 2023-02-13
+  2023-02-14 2023-02-15 2023-02-16 2023-02-17 2023-02-18 2023-02-19 2023-02-20 2023-02-21
+  2023-02-22 2023-02-23 2023-02-24 2023-02-25 2023-02-26 2023-02-27 2023-02-28
+]
+
+view_values = [
+  0, 0, 0, 2, 0, 48, 158, 94, 126, 142, 9, 7, 1, 1, 0, 1, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 0, 1, 2, 3, 2
+]
+chart.add_series('浏览', categories, view_values)
+
+fill_values = [
+  0, 0, 0, 23, 0, 0, 0, 0, 0, 0, 20, 0, 20, 0, 0, 60, 0, 0, 2, 0, 0, 0, 0, 0, 0, 0, 0, 45, 30, 0, 0
+]
+chart.add_series('填写', categories, fill_values)
+
+query_values = [
+  2, 1, 12, 0, 0, 0, 0, 45, 0, 0, 20, 0, 0, 24, 0, 0, 0, 0, 23, 0, 0, 10, 0, 0, 0, 0, 0, 0, 0, 0, 0
+]
+chart.add_series('查询', categories, query_values)
+
+filename = 'simpleLineChartDocument.docx'
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+docx.write_to File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/demo/images/append_image.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push "#{Dir.pwd}/lib"
+require 'goldendocx'
+require 'open-uri'
+
+docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+
+image = File.open("#{Dir.pwd}/demo/templates/bg.png")
+docx.create_image(image)
+
+image_base64 = File.read("#{Dir.pwd}/demo/templates/image_base64")
+docx.create_image(image_base64)
+
+image_url = 'https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png'
+docx.create_image(Kernel.open(image_url))
+
+filename = 'simpleImageDocument.docx'
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+docx.write_to File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/demo/images/append_styled_image.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push "#{Dir.pwd}/lib"
+require 'goldendocx'
+
+docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+
+image = File.open("#{Dir.pwd}/demo/templates/bg.png")
+docx.create_image(image, width: 720000, height: 720000)
+
+filename = 'styledImageDocument.docx'
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+docx.write_to File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/demo/tables/create_embed_image_table.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push "#{Dir.pwd}/lib"
+require 'goldendocx'
+Goldendocx.configure { |config| config.xml_serializer = :ox }
+docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+
+# Register styles because default document without any style
+docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportTable"))
+# Set default textAlignment at template instead of modify manually
+# docx.document.styles.styles.find { |s| s.type == 'paragraph' && s.default? }.tap do |style|
+#   style.node.public_send('w:pPr').tap do |pr|
+#     pr << Ox::Element.new('w:textAlignment').tap { |a| a['w:val'] = :center }
+#   end
+# end
+
+table = docx.create_table(style: 'reportTable')
+
+# Headers
+table.add_header('名称', width: (Goldendocx::Tables::DEFAULT_TABLE_DXA_WIDTH / 2))
+table.add_header('数量', width: 1500)
+table.add_header('单价')
+table.add_header('总价', width: (Goldendocx::Tables::DEFAULT_TABLE_DXA_WIDTH / 6))
+
+# Rows
+image_base64 = File.read("#{Dir.pwd}/demo/templates/image_base64")
+image = docx.create_embed_image(image_base64, width: 720000, height: 720000, align: :left)
+
+rows = [
+  [Goldendocx::Tables::ImageCell.new(image: image, content: '选项A'), 3, '¥3.00', '¥9.00'],
+  [Goldendocx::Tables::ImageCell.new(image: image, content: '选项B'), 4, '¥6.50', '¥18.00'],
+  [Goldendocx::Tables::ImageCell.new(image: image, content: '选项C'), 10, '¥6.00', '¥60.00']
+]
+rows.each do |r|
+  row = table.add_row(r)
+  row.height = 1500
+end
+
+filename = 'embedImageTableDocument.docx'
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+docx.write_to File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/demo/tables/create_plain_table.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push "#{Dir.pwd}/lib"
+require 'goldendocx'
+
+docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+
+headers = %w[名称 数量 单价]
+rows = [
+  %w[可口可乐 3 ¥3.00],
+  %w[魔爪 4 ¥6.50],
+  %w[北冰洋 10 ¥6.00]
+]
+
+table = docx.create_table
+headers.each { |header| table.add_header(header) }
+rows.each { |row| table.add_row(row) }
+
+filename = 'plainTableDocument.docx'
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+docx.write_to File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"

data/demo/tables/create_styled_table.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push "#{Dir.pwd}/lib"
+require 'goldendocx'
+
+docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+
+# Register styles because default document without any style
+docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportTable"))
+
+table = docx.create_table(style: 'reportTable')
+
+# Headers
+table.add_header('名称', width: (Goldendocx::Tables::DEFAULT_TABLE_DXA_WIDTH / 2))
+table.add_header('数量', width: 1500)
+table.add_header('单价')
+table.add_header('总价', width: (Goldendocx::Tables::DEFAULT_TABLE_DXA_WIDTH / 6))
+
+# Rows
+rows = [
+  %w[可口可乐 3 ¥3.00 ¥9.00],
+  %w[魔爪 4 ¥6.50 ¥18.00],
+  %w[北冰洋 10 ¥6.00 ¥60.00]
+]
+rows.each do |r|
+  row = table.add_row(r)
+  row.height = 500
+end
+
+# RowMergeCell
+table.add_row([{ span: 4, content: '总数据量： 210', align: :center }])
+
+filename = 'styledTableDocument.docx'
+system "rm -f ~/Desktop/#{filename}" # -f so that we don't have an error if the file doesn't exist
+docx.write_to File.expand_path("~/Desktop/#{filename}")
+exec "open ~/Desktop/#{filename}"