standard-procedure-consolidate 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2d1794f2a364e867d285325c3a0dd9b5c6b4716145d5eaf964c91c44e937e5c
-  data.tar.gz: 6622d19bc3de12fe8d77775b579c1531a057a27bacf227b0b119a252e7fd0003
+  metadata.gz: f45c16dc8e6f37f91043673804db8076030a804ab6c08fa1139f4d86cdf54b79
+  data.tar.gz: 7c77802d6b578ac50b9f9c8b5bad9ff097918fab5644eb3c771b2baf98451a36
 SHA512:
-  metadata.gz: bb6944c739e5d772a45076b86f5c08d299913575027845ba505aa76b4ade18e3ecb47efe77f4499ac2a01f8782fcbf797b7dde9d00fb479716ac0b927288c9b4
-  data.tar.gz: b9c10360e43007c6cd523ad238664786f2aa0884e524349d451989646e05f3f59569821e7361a8f4c553dad182ca61588629d108359b08953287bddf62f8533c
+  metadata.gz: 2ed822b460867d75395fdb9253ef3501619781d3ab31acaca7db4daf699658f8253d4a063336bcc2321bf6dd08f0207e91600172f8ec84e4263af055ee9107a7
+  data.tar.gz: 37a8f85beb0b9c65ba76bf9457edcb9e141d1e87aca1f65c01b5a4e43f45f143c66695d5922eb3ffafca43625f9e3745db8fd2e3c516dd6ffb73172a8c9437ac

data/.nova/Configuration.json

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

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.1.4] - 2023-09-11
+
+Updated which files get exclusions after crashes in production with some client files
+
 ## [0.1.3] - 2023-09-07
 
 Customer had an issue where some fields were not merging correctly
@@ -21,6 +25,3 @@ Customer had an issue where some fields were not merging correctly
 - 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.4.gem.sha512

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

data/lib/consolidate/docx/merge.rb

@@ -46,8 +46,6 @@ module Consolidate
       attr_reader :documents
       attr_accessor :output
 
-      EXCLUSIONS = %w{_rels/.rels [Content_Types].xml word/_rels/document.xml.rels word/theme/theme1.xml word/settings.xml word/_rels/settings.xml.rels word/styles.xml word/webSettings.xml word/fontTable.xml docProps/core.xml docProps/app.xml}
-
       def initialize(path, verbose: false, &block)
         raise "No block given" unless block
         @verbose = verbose
@@ -56,7 +54,7 @@ module Consolidate
         begin
           @zip = Zip::File.open(path)
           @zip.entries.each do |entry|
-            next if EXCLUSIONS.include? entry.name
+            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 }

data/lib/consolidate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Consolidate
-  VERSION = "0.1.3"
+  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.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Rahoul Baruah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-07 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"
@@ -58,6 +59,7 @@ files:
 - 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