standard-procedure-consolidate 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5647faddeab8829e8494e02b4b87acc33276e7f293fa147f3b15b1dd2a6d4c09
-  data.tar.gz: e867ef111010caa13eef6da80f11ccaa7ee0d780f82309a8f4d976bcff058545
+  metadata.gz: f45c16dc8e6f37f91043673804db8076030a804ab6c08fa1139f4d86cdf54b79
+  data.tar.gz: 7c77802d6b578ac50b9f9c8b5bad9ff097918fab5644eb3c771b2baf98451a36
 SHA512:
-  metadata.gz: 3f7e9ebff0ec1706b59983eb8b1f32132e58af066f3e4de56a4e05c55ea2f365a236cc513e5571930cd0173ddaebd6329a7d628cb5a137b0ac1b1b365f1d5672
-  data.tar.gz: cab09a1aa8f2338b24397fd2eb2252c4244b4890dd965581657fcd025197948a9290896e0fa519ab782719f25b34f292e17f44de3c15f13329b1fe964550162b
+  metadata.gz: 2ed822b460867d75395fdb9253ef3501619781d3ab31acaca7db4daf699658f8253d4a063336bcc2321bf6dd08f0207e91600172f8ec84e4263af055ee9107a7
+  data.tar.gz: 37a8f85beb0b9c65ba76bf9457edcb9e141d1e87aca1f65c01b5a4e43f45f143c66695d5922eb3ffafca43625f9e3745db8fd2e3c516dd6ffb73172a8c9437ac

data/.nova/Configuration.json

@@ -0,0 +1,3 @@
+{
+
+}

data/CHANGELOG.md

@@ -1,15 +1,27 @@
+## [0.1.4] - 2023-09-11
 
-## [Unreleased]
+Updated which files get exclusions after crashes in production with some client files
 
-## [0.1.0] - 2023-07-25
+## [0.1.3] - 2023-09-07
 
-- Initial release
+Customer had an issue where some fields were not merging correctly
+
+- Altered the code so it tries to perform the substitution in all .xml files that aren't obviously configuration data
+- Added verbose option to show what the code was doing
+- Added a list of files to `examine`
+- Still no tests for the header/footer support
+
+## [0.1.2] - 2023-08-23
+
+- Added untested support for headers and footers
+- this work was done in a rush to deal with a customer requirement - tests to come soon
 
 ## [0.1.1] - 2023-08-02
 
 - Added `examine` to list the merge fields within a document
 
-## [0.1.2] - 2023-08-23
+## [0.1.0] - 2023-07-25
 
-- Added untested support for headers and footers
-- this work was done in a rush to deal with a customer requirement - tests to come soon
+- Initial release
+
+## [Unreleased]

data/README.md

@@ -17,7 +17,7 @@ To list the merge fields within a document:
 
 ```ruby
 Consolidate::Docx::Merge.open "/path/to/docx" do |merge|
-  puts merge.examine
+  merge.examine
 end and nil
 ```
 To perform a merge, replacing merge fields with supplied values:
@@ -31,6 +31,18 @@ end
 
 NOTE: The merge fields are case-sensitive - which is why they should be supplied as strings (using the older `{ "key" => "value" }` style ruby hash).
 
+If your merge isn't working, you can pass `verbose: true` to `open` and it will list the internal .xml documents it finds, the fields it finds within those .xml documents and the substitutions it is trying to perform.
+
+## How it works
+
+This is a bit sketchy and pieced together from the [code I found]((https://gist.github.com/ericmason/7200448)) and various bits of skimming through the published file format.
+
+A .docx file (unlike the previous .doc file), is actually a .zip file that contains a number of .xml files.  The contents of the document are stored in these .xml files, along with configuration information and stuff like fonts and styles.
+
+When setting up a merge field, Word adds some special tags into the .xml file.  There appear to be two different versions of how it does this - using `w:fldSimple` or `w:instrText` tags.  Consolidate goes through each .xml file within the document (ignoring some which are configuration related) and looks for these two types of tag.
+
+The `data` method uses the hash of `field: value` data you supply, copies the .xml files and performs a straight text substitution on any matching merge fields.  Then `write_to`
+
 ## Development
 
 The repo contains a .devcontainer folder - this contains instructions for a development container that has everything needed to build the project.  Once the container has started, you can use `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/checksums/standard-procedure-consolidate-0.1.3.gem.sha512

@@ -0,0 +1 @@
+fcf685ae67c99908b9d67a57e9bd4bfe6dc8f61c3e421e167d0c9912ab6ac32fd4ad9a273cbbee47e9157cafb311aaecb8db0995eb227aa0afe0bdcc3bc01ee3

data/checksums/standard-procedure-consolidate-0.1.4.gem.sha512

@@ -0,0 +1 @@
+da681c73463215031518b2606899503d3217ab92e1877bd8f966e5dc3ebc971ae686958b78da821feb24374f84d179e86cdaf29dbb90f0bacb0a7cbde8e66c6b

data/lib/consolidate/docx/merge.rb

@@ -6,12 +6,14 @@ require "nokogiri"
 module Consolidate
   module Docx
     class Merge
-      def self.open(path, force_settings: true, &block)
-        new(path, force_settings: force_settings, &block)
+      def self.open(path, verbose: false, &block)
+        new(path, verbose: verbose, &block)
+        path
       end
 
       def examine
-        extract_field_names
+        puts "Documents: #{extract_document_names}"
+        puts "Merge fields: #{extract_field_names}"
       end
 
       def data fields = {}
@@ -38,37 +40,44 @@ module Consolidate
 
       protected
 
+      attr_reader :verbose
       attr_reader :zip
       attr_reader :xml
       attr_reader :documents
       attr_accessor :output
 
-      def initialize(path, force_settings: true, &block)
+      def initialize(path, verbose: false, &block)
         raise "No block given" unless block
+        @verbose = verbose
         @output = {}
         @documents = {}
-        set_standard_settings if force_settings
         begin
           @zip = Zip::File.open(path)
-          ["word/document.xml", "word/header1.xml", "word/footer1.xml"].each do |document|
-            next unless @zip.find_entry(document)
-            xml = @zip.read document
-            @documents[document] = Nokogiri::XML(xml) { |x| x.noent }
-            yield self
+          @zip.entries.each do |entry|
+            next unless entry.name =~ /word\/(document|header|footer|footnotes|endnotes).?\.xml/
+            puts "Reading #{entry.name}" if verbose
+            xml = @zip.get_input_stream entry
+            @documents[entry.name] = Nokogiri::XML(xml) { |x| x.noent }
           end
+          yield self
         ensure
           @zip.close
         end
       end
 
+      def extract_document_names
+        @zip.entries.collect { |entry| entry.name }.join(", ")
+      end
+
       def extract_field_names
-        (extract_style_one + extract_style_two).uniq
+        (extract_style_one + extract_style_two).uniq.join(", ")
       end
 
       def extract_style_one
         documents.collect do |name, document|
           (document / "//w:fldSimple").collect do |field|
             value = field.attributes["instr"].value.strip
+            puts "...found #{value} (v1) in #{name}" if verbose
             value.include?("MERGEFIELD") ? value.gsub("MERGEFIELD", "").strip : nil
           end.compact
         end.flatten
@@ -78,6 +87,7 @@ module Consolidate
         documents.collect do |name, document|
           (document / "//w:instrText").collect do |instr|
             value = instr.inner_text
+            puts "...found #{value} (v2) in #{name}" if verbose
             value.include?("MERGEFIELD") ? value.gsub("MERGEFIELD", "").strip : nil
           end.compact
         end.flatten
@@ -89,6 +99,7 @@ module Consolidate
           if field.attributes["instr"].value =~ /MERGEFIELD (\S+)/
             text_node = (field / ".//w:t").first
             next unless text_node
+            puts "...substituting v1 #{field.attributes["instr"]} with #{fields[$1]}" if verbose
             text_node.inner_html = fields[$1].to_s
           end
         end
@@ -102,17 +113,13 @@ module Consolidate
             text_node = instr.parent.next_sibling.next_sibling.xpath(".//w:t").first
             text_node ||= instr.parent.next_sibling.next_sibling.next_sibling.xpath(".//w:t").first
             next unless text_node
+            puts "...substituting v2 #{instr.inner_text} with #{fields[$1]}" if verbose
             text_node.inner_html = fields[$1].to_s
           end
         end
         document
       end
 
-      def set_standard_settings
-        output["word/settings.xml"] = %(<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
-<w:settings xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:m="http://schemas.openxmlformats.org/officeDocument/2006/math" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:sl="http://schemas.openxmlformats.org/schemaLibrary/2006/main"><w:zoom w:percent="100"/></w:settings>)
-      end
-
       def close
         zip.close
       end

data/lib/consolidate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Consolidate
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-consolidate
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Rahoul Baruah
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-29 00:00:00.000000000 Z
+date: 2023-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".devcontainer/devcontainer.json"
+- ".nova/Configuration.json"
 - ".rspec"
 - ".ruby-version"
 - ".standard.yml"
@@ -57,6 +58,8 @@ files:
 - Rakefile
 - checksums/standard-procedure-consolidate-0.1.0.gem.sha512
 - checksums/standard-procedure-consolidate-0.1.2.gem.sha512
+- checksums/standard-procedure-consolidate-0.1.3.gem.sha512
+- checksums/standard-procedure-consolidate-0.1.4.gem.sha512
 - exe/consolidate
 - lib/consolidate.rb
 - lib/consolidate/docx/merge.rb
@@ -71,7 +74,7 @@ metadata:
   homepage_uri: https://github.com/standard-procedure/standard-procedure-consolidate
   source_code_uri: https://github.com/standard-procedure/standard-procedure-consolidate
   changelog_uri: https://github.com/standard-procedure/standard-procedure-consolidate/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.4.10
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Simple ruby mailmerge for Microsoft Word .docx files.
 test_files: []