goldendocx 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1603ab8a5538d27e48b351b381f8859c92fb9e42169df8cbcc6104545803c2b
-  data.tar.gz: 9bc30497d4a1f96da15f8190d9edb42857f2ec6876550ebb47415f3ed5e67caa
+  metadata.gz: ec01d96d925886ed23aa79de96bfcc71fd8c0cb0c151239c7696536095b7c8c4
+  data.tar.gz: e72d2a380906b12216d2e29ef2cb4ec94e9036860d9d5000a60313f8a95a8350
 SHA512:
-  metadata.gz: b826c86f0013b2af7af58b047cdb5340cc912913ca78b0198ab9b506a8614a173b2d1a53f42d928da6f277f21a6312895175687a49e79e2cf63658acace1ef4a
-  data.tar.gz: cb4198c911418e3579df98019d87709a009aed9bd595b2889602e595a32d53b2a333561cd8d43dde67f40a55b1ebd6552e0921a184308417f4ce8270a215cd0f
+  metadata.gz: c53baede5b94336cbf2b3461183d3301114842d3bea12957655f86118d9fa9050f7f78ab2ed072720bcd0f43c126b61a8ea59cdf78b28cb7fd3282f676937860
+  data.tar.gz: 576eca3f0caedb097062afb1952ee05ac39786848498cc9de1ac55359a25131320fd2d93a0df3e75ab992419b98bef1a4831e7d4bbb2e34a0fcbe540d69fa29b

data/.rubocop.yml

@@ -6,6 +6,10 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 2.7
   SuggestExtensions: false
+  Exclude:
+    - 'tmp/**/*'
+    - 'demo/templates/xml_to_class.rb'
+
 
 Metrics/AbcSize:
   CountRepeatedAttributes: false

data/CHANGELOG.md

@@ -30,7 +30,7 @@ Mostly refactoring
 - Introduce `ActiveSupport` to make coding easier
 - Clean irrelevant demos
 
-## [0.2.2] - 2023-03-31(WIP)
+## [0.2.2] - 2023-03-31
 
 ### Features
 
@@ -40,4 +40,10 @@ Mostly refactoring
 ### Fixes
 
 - Fix create charts issues
-- Fix Nokogiri XML serializer compatible issues
+- Fix Nokogiri XML serializer compatible issues
+
+## [0.2.3] - 2023-04-07
+
+### Features
+
+- Support create new MS Word docx file without template

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    goldendocx (0.2.2)
+    goldendocx (0.2.3)
       activesupport (~> 7.0)
       nokogiri (~> 1.14)
       ox (~> 2.14)
@@ -78,6 +78,7 @@ GEM
     simplecov-html (0.12.3)
     simplecov-lcov (0.8.0)
     simplecov_json_formatter (0.1.4)
+    timecop (0.9.6)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
@@ -96,6 +97,7 @@ DEPENDENCIES
   rubocop-rspec (~> 2.19)
   simplecov (~> 0.22.0)
   simplecov-lcov (~> 0.8.0)
+  timecop (~> 0.9.6)
 
 BUNDLED WITH
    2.3.23

data/README.md

@@ -1,5 +1,8 @@
 # The Ruby API for Microsoft Word
 
+[![Gem Version](https://badge.fury.io/rb/goldendocx.svg)](https://badge.fury.io/rb/goldendocx)
+[![Coverage Status](https://coveralls.io/repos/github/SheldonLeo/goldendocx/badge.svg)](https://coveralls.io/github/SheldonLeo/goldendocx)
+
 Ruby APIs for manipulating Microsoft Word based upon OOXML standards.
 
 ## Installation
@@ -23,6 +26,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 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
@@ -30,9 +34,13 @@ end
 ```
 
 ### Compose MS Word
-- Read MS Word file and write to another path
+
+- Create new MS Word file or read exists file and write to another path
     ```ruby
+      docx = Goldendocx::Docx.new
       docx = Goldendocx::Docx.new(docx_file_path)
+      docx.read_from(docx_file_path)
+  
       docx.write_to(new_file_path)
     ```
 - Create texts to MS Word
@@ -71,6 +79,6 @@ end
       values = [13, 12, 9, 9, 8, 7, 7, 6, 5, 3]
       chart.add_series('地域分布详情数据', categories, values)
     ```
-  
+
 More demos view at [Demos](demo/)
 

data/Rakefile

@@ -4,7 +4,18 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
-RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:ox_compatible_spec) do |task|
+  ENV['XML_SERIALIZER'] = 'ox'
+  task.failure_message = 'Failed with ox xml serializer compatible'
+end
 
-task default: %i[rubocop spec]
+RSpec::Core::RakeTask.new(:nokogiri_compatible_spec) do |task|
+  ENV['XML_SERIALIZER'] = 'nokogiri'
+  task.failure_message = 'Failed with nokogiri xml serializer compatible'
+end
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.options = ['-P']
+end
+
+task default: %i[rubocop ox_compatible_spec nokogiri_compatible_spec]

data/demo/templates/generate_codes.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'ox'
+require_relative 'xml_to_class'
+
+xml_fragment = File.read("#{Dir.pwd}/demo/templates/styles/reportTitle")
+root_class = XmlToClass.new.parse(Ox.parse(xml_fragment))
+
+root_class.write_rb('goldendocx/styles')
+root_class.write_spec('goldendocx/styles')

data/demo/templates/xml_to_class.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'ox'
+require 'fileutils'
+require 'active_support/core_ext/string/inflections'
+
+class XmlToClass
+  def parse(node)
+    @node = node
+    @namespace, @tag = parse_tag(@node.name)
+    @class_name = "#{@tag}Property".classify
+    parse_attributes
+    parse_children
+    self
+  end
+
+  def write_rb(dir)
+    dir_to_write = "#{Dir.pwd}/lib/#{dir}"
+    FileUtils.mkdir_p(dir_to_write)
+
+    File.open("#{dir_to_write}/#{@tag}.rb", 'w') do |f|
+      f.puts '# frozen_string_literal: true'
+      f.puts ''
+      f.puts "class Goldendocx::#{@class_name}"
+      f.puts '  include Goldendocx::Element'
+      f.puts ''
+      f.puts "  namespace :#{@namespace}" if @namespace
+      f.puts "  tag :#{@tag}"
+      f.puts ''
+      @attributes.each do |name, opt|
+        options = opt.map { |k, v| "#{k}: :#{v}" }.join(',')
+        f.puts "  attribute :#{name.underscore}, #{options}"
+      end
+      f.puts ''
+      @children.group_by(&:to_s).each do |name, values|
+        method = values.size > 1 ? :embeds_many : :embeds_one
+        _, class_name = parse_tag(name)
+        f.puts "  #{method} :#{class_name.underscore}, class_name: 'Goldendocx::#{class_name.classify}Property'"
+      end
+      f.puts 'end'
+    end
+
+    @subclasses.each { |c| c.write_rb("#{dir}/#{@tag}") }
+  end
+
+  def write_spec(dir)
+    dir_to_write = "#{Dir.pwd}/spec/#{dir}"
+    FileUtils.mkdir_p(dir_to_write)
+
+    File.open("#{dir_to_write}/#{@tag}_spec.rb", 'w') do |f|
+      f.puts '# frozen_string_literal: true'
+      f.puts ''
+      f.puts "describe Goldendocx::#{@class_name} do"
+      f.puts '  let(:property) { described_class.new }'
+      f.puts ''
+      f.puts "  specify 'builds default #{@tag} property xml' do "
+      f.puts "    expect(property.to_xml).to eq('<#{@namespace}:#{@tag}/>')"
+      f.puts '  end'
+      f.puts ''
+      f.puts "  specify 'builds customized #{@tag} property xml' do"
+      f.puts '    property.attribute = :value '
+      f.puts "    expect(property.to_xml).to eq('<#{@namespace}:#{@tag}/>') "
+      f.puts '  end '
+      f.puts 'end'
+    end
+
+    @subclasses.each { |c| c.write_spec("#{dir}/#{@tag}") }
+  end
+
+  def parse_tag(string)
+    string = string.to_s
+    string.include?(':') ? string.split(':') : [nil, string]
+  end
+
+  def parse_attributes
+    @attributes ||= {}
+    @node.attributes.each_key do |name|
+      ns, tg = parse_tag(name)
+      @attributes[tg] = { alias_name: tg, namespace: ns }.compact
+    end
+  end
+
+  def parse_children
+    @children = []
+    @subclasses = []
+    @node.nodes.each do |node|
+      @children << node.name.to_s
+      @subclasses << XmlToClass.new.parse(node)
+    end
+  end
+end

data/demo/texts/append_plain_text.rb

@@ -3,7 +3,7 @@
 $LOAD_PATH.push "#{Dir.pwd}/lib"
 require 'goldendocx'
 
-docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+docx = Goldendocx::Docx.new.read_from("#{Dir.pwd}/demo/templates/blankDocument.docx")
 
 docx.create_text('Hello World!')
 

data/demo/texts/append_styled_text.rb

@@ -2,8 +2,7 @@
 
 $LOAD_PATH.push "#{Dir.pwd}/lib"
 require 'goldendocx'
-
-docx = Goldendocx::Docx.new("#{Dir.pwd}/demo/templates/blankDocument.docx")
+docx = Goldendocx::Docx.new.read_from("#{Dir.pwd}/demo/templates/blankDocument.docx")
 
 # Register styles because default document without any style
 docx.add_style(File.read("#{Dir.pwd}/demo/templates/styles/reportTitle"))

data/demo/texts/create_text.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push "#{Dir.pwd}/lib"
+require 'goldendocx'
+
+docx = Goldendocx::Docx.new
+
+docx.create_text('Hello World!')
+docx.create_text('Hello World!', align: :center, color: 'FF8533', bold: true)
+
+filename = 'plainTextDocument.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/lib/extensions/active_support_extensions.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/core_ext/array/access'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/class/subclasses'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/string/conversions'
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.uncountable 'extents', 'image_data', 'data', 'defaults', 'latentStyles'
+  inflect.irregular 'axis', 'axes'
+
+  inflect.uncountable 'values' # TODO: Find better names
+end

data/lib/extensions/nokogiri_extensions.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+# FIXME: Temporarily here to provider syntactic sugar
+module Nokogiri
+  module XML
+    class Document
+      def tag_name
+        root.tag_name
+      end
+    end
+
+    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
+
+      def adapt?(klass)
+        adaptable_classes = [String, Integer, Time]
+        is_a?(Nokogiri::XML::Text) && adaptable_classes.include?(klass)
+      end
+
+      def tag_name
+        [namespace&.prefix, name].compact.join(':')
+      end
+
+      def unparsed_children
+        @unparsed_children ||= children.dup
+      end
+
+      def attributes_hash
+        attribute_nodes.reject { |node| node.tag_name == 'mc:Ignorable' }.to_h { |node| [node.tag_name, node.value] }
+      end
+    end
+  end
+end

data/lib/extensions/ox_extensions.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'ox'
+
+module Ox
+  class Document
+    def root
+      children.first
+    end
+  end
+
+  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
+
+    alias children nodes
+    alias tag_name name
+
+    def unparsed_children
+      @unparsed_children ||= children.dup
+    end
+
+    def attributes_hash
+      attributes.with_indifferent_access.reject { |k, _| k.to_s.start_with?('xmlns') || k.to_s == 'mc:Ignorable' }
+    end
+  end
+end

data/lib/extensions/xml_serialize_extensions.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class String
+  class << self
+    def adapt?(xml_node)
+      xml_node.is_a?(String) || xml_node.adapt?(String)
+    end
+
+    def read_from(xml_node)
+      xml_node.to_s
+    end
+  end
+end
+
+class Time
+  class << self
+    def adapt?(xml_node)
+      xml_node.is_a?(String) || xml_node.adapt?(Time)
+    end
+
+    def read_from(xml_node)
+      xml_node.to_s.to_time
+    end
+  end
+
+  def to_element(**_context)
+    strftime('%Y-%m-%dT%H:%M:%SZ')
+  end
+end
+
+class Integer
+  class << self
+    def adapt?(xml_node)
+      xml_node.is_a?(String) || xml_node.adapt?(Integer)
+    end
+
+    def read_from(xml_node)
+      xml_node.to_s.to_i
+    end
+  end
+
+  def to_element(**_context)
+    to_s
+  end
+end

data/lib/goldendocx/components/properties/font_property.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Components
+    module Properties
+      class FontProperty
+        include Goldendocx::Element
+
+        namespace :w
+        tag :rFonts
+
+        attribute :ascii, namespace: :w, default: 'Times New Roman'
+        attribute :east_asia, alias_name: :eastAsia, namespace: :w, default: '宋体'
+        attribute :high_ansi, alias_name: :hAnsi, namespace: :w, default: 'Times New Roman'
+        attribute :complex, alias_name: :cs, namespace: :w, default: 'Times New Roman'
+      end
+    end
+  end
+end

data/lib/goldendocx/components/properties/language_property.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Components
+    module Properties
+      class LanguageProperty
+        include Goldendocx::Element
+
+        namespace :w
+        tag :lang
+
+        attribute :complex, alias_name: :bidi, namespace: :w, default: 'ar-SA'
+        attribute :east_asia, alias_name: :eastAsia, namespace: :w, default: 'zh-CN'
+        attribute :latin, alias_name: :val, namespace: :w, default: 'en-US'
+      end
+    end
+  end
+end

data/lib/goldendocx/components/properties/run_property.rb

@@ -11,6 +11,8 @@ module Goldendocx
 
         embeds_one :color, class_name: 'Goldendocx::Components::Properties::ColorProperty', auto_build: false
         embeds_one :bold, class_name: 'Goldendocx::Components::Properties::BoldProperty', auto_build: false
+        embeds_one :language, class_name: 'Goldendocx::Components::Properties::LanguageProperty', auto_build: false
+        embeds_one :font, class_name: 'Goldendocx::Components::Properties::FontProperty', auto_build: false
       end
     end
   end

data/lib/goldendocx/content_types/default.rb

@@ -6,13 +6,9 @@ module Goldendocx
       include Goldendocx::Element
 
       tag :Default
-      attribute :extension, alias_name: :Extension, readonly: true
-      attribute :content_type, alias_name: :ContentType, readonly: true
 
-      def initialize(extension, content_type)
-        @extension = extension
-        @content_type = content_type
-      end
+      attribute :extension, alias_name: :Extension
+      attribute :content_type, alias_name: :ContentType
 
       def ==(other)
         extension == other.extension && content_type == other.content_type

data/lib/goldendocx/content_types/override.rb

@@ -6,13 +6,9 @@ module Goldendocx
       include Goldendocx::Element
 
       tag :Override
-      attribute :part_name, alias_name: :PartName, readonly: true
-      attribute :content_type, alias_name: :ContentType, readonly: true
 
-      def initialize(part_name, content_type)
-        @part_name = part_name
-        @content_type = content_type
-      end
+      attribute :part_name, alias_name: :PartName
+      attribute :content_type, alias_name: :ContentType
 
       def ==(other)
         part_name == other.part_name && content_type == other.content_type

data/lib/goldendocx/document.rb

@@ -3,49 +3,30 @@
 # Just to mark a element as a root document node
 module Goldendocx
   module Document
-    def self.included(base)
-      base.include(Goldendocx::Element)
-      base.extend(ClassMethods)
+    extend ActiveSupport::Concern
+    include Goldendocx::Element
+
+    included do
+      class_attribute :concerned_namespaces, default: []
+      class_attribute :ignorable_namespaces, default: []
     end
 
-    module ClassMethods
+    class_methods do
       def concern_namespaces(*namespaces)
         namespaces.each do |namespace|
           concerned_namespaces << namespace unless concerned_namespaces.include?(namespace)
         end
       end
 
-      def concerned_namespaces
-        @concerned_namespaces ||= []
-      end
-
       def ignore_namespaces(*namespaces)
         namespaces.each do |namespace|
           ignorable_namespaces << namespace.to_sym unless ignorable_namespaces.include?(namespace)
         end
       end
-
-      def ignorable_namespaces
-        @ignorable_namespaces ||= []
-      end
-    end
-
-    def concerned_namespaces
-      self.class.concerning_ancestors.flat_map(&:concerned_namespaces)
-    end
-
-    def ignorable_namespaces
-      self.class.concerning_ancestors.flat_map(&:ignorable_namespaces)
     end
 
-    def to_document_xml
-      Goldendocx.xml_serializer.build_document_xml(root_tag, concerned_namespaces, ignorable_namespaces) do |xml|
-        attributes.each { |name, value| xml[name] = value }
-
-        yield(xml) if block_given?
-
-        children.each { |child| xml << child }
-      end
+    def to_document_xml(&block)
+      Goldendocx.xml_serializer.build_document_xml(tag_name, concerned_namespaces, ignorable_namespaces) { |xml| build_element(xml, &block) }
     end
   end
 end

data/lib/goldendocx/documents/body.rb

@@ -7,33 +7,42 @@ module Goldendocx
 
       XML_PATH = 'word/document.xml'
 
-      attr_reader :components, :properties, :charts
+      attr_reader :components, :charts
 
       namespace :w
       tag :body
 
+      # TODO: Try to distinguish these paragraphs
       embeds_many :texts, class_name: 'Goldendocx::Components::Text'
       embeds_many :images, class_name: 'Goldendocx::Components::Image'
+
       embeds_many :tables, class_name: 'Goldendocx::Components::Table'
 
+      embeds_one :section_property, class_name: 'Goldendocx::Documents::Properties::SectionProperty', auto_build: true
+
+      class << self
+        def read_from(xml_node)
+          document = super(xml_node)
+
+          component_tags = %w[w:p w:tbl]
+          xml_node.children.map do |node|
+            document.components << node if component_tags.include?(node.tag_name)
+          end
+
+          document
+        end
+      end
+
       def initialize
         @components = []
         @charts = []
       end
 
-      def read_from(docx_file)
-        Goldendocx.xml_serializer.parse(docx_file.read(XML_PATH), %w[w:document w:body *]).map do |node|
-          element = Goldendocx::Documents::Element.new(node)
-          @components << element if element.component?
-          @properties = element if element.properties?
-        end
-      end
-
       # FIXME: Override for children not in correctly order
       def to_element(**_context)
-        Goldendocx.xml_serializer.build_element(root_tag) do |xml|
+        Goldendocx.xml_serializer.build_element(tag_name) do |xml|
           components.each { |component| xml << component }
-          xml << properties if properties
+          xml << section_property if section_property
 
           yield(xml) if block_given?
         end

data/lib/goldendocx/documents/document.rb

@@ -5,7 +5,9 @@ module Goldendocx
     class Document
       include Goldendocx::Document
 
+      TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument'
       XML_PATH = 'word/document.xml'
+      CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml'
 
       namespace :w
       tag :document
@@ -16,10 +18,6 @@ module Goldendocx
 
       embeds_one :body, class_name: 'Goldendocx::Documents::Body', auto_build: true
 
-      def read_from(docx_file)
-        body.read_from(docx_file)
-      end
-
       def write_to(zos)
         zos.put_next_entry XML_PATH
         zos.write to_document_xml

data/lib/goldendocx/documents/latent_styles.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    class LatentStyles
+      include Goldendocx::Element
+
+      namespace :w
+      tag :latentStyles
+    end
+  end
+end

data/lib/goldendocx/documents/properties/default_style_property.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Goldendocx
+  module Documents
+    module Properties
+      class DefaultStyleProperty
+        include Goldendocx::Element
+
+        namespace :w
+        tag :docDefaults
+
+        embeds_one :run_default, class_name: 'Goldendocx::Documents::Properties::RunDefaultStyleProperty', auto_build: true
+        embeds_one :paragraph_default, class_name: 'Goldendocx::Documents::Properties::ParagraphDefaultStyleProperty', auto_build: true
+      end
+    end
+  end
+end