standard-procedure-consolidate 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52bf3de85226b0aa00c8a2d5ad8caa7e0dbc7aa2e8707150d844e34a3313fcf9
-  data.tar.gz: cf92c7c1fc1978cc7e615674d01e542d4ca5b4588da08856b6608301efd83109
+  metadata.gz: f240fafdaf4fea72b63ba38b70c0e49736bb46a3f1f793ed79030f0f184d7760
+  data.tar.gz: '08930023d6b6865933a65a1cbefcd026d3a33b56323f702b5b46c9eedb76a210'
 SHA512:
-  metadata.gz: 1a2c3dfa7bc6fe20d8f3ddc2bdfe9f1c94fe53ddd1daf75009f96af35ba20f1d7acdaf6b1f3563b9484f50fa4a0a5b53ab4c2e161008f0131fd03d39b67df76f
-  data.tar.gz: f169d41a245b6dbe95d20eeded64c5ff684ec4822dfab36ed342374916c6e7eb2c6dee82cc14fc89bc1d141ba4c1b259629e8b6ba219952bd949db0f53384aa8
+  metadata.gz: b205661ee1cd85599254559477ef73809086a9c232036c34a090b706437a01f46a947def4dfe3a90c12b50a0a589dcac671c1b5c5f1d9cea69bfadf160de5b02
+  data.tar.gz: 917b84c6116e50936b1de0a31605c345d8ec4ac48c466bd97afec9f937ebe81b67f0b56f9c5a75fda735d71f496382ef714d7b5e9012878b2f1af4223833a8d0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
+
 ## [Unreleased]
 
 ## [0.1.0] - 2023-07-25
 
 - Initial release
+
+## [0.1.1] - 2023-08-02
+
+- Added `examine` to list the merge fields within a document

data/README.md

@@ -13,12 +13,20 @@ It's pretty simple, so it probably won't work with complex Word documents, but i
 
 ## Usage
 
+To list the merge fields within a document:
+
+```ruby
+Consolidate::Docx::Merge.open "/path/to/docx" do |merge|
+  puts merge.examine
+end and nil
+```
+To perform a merge, replacing merge fields with supplied values:
+
 ```ruby
 Consolidate::Docx::Merge.open "/path/to/docx" do |merge|
   merge.data "Name" => "Alice Aadvark", "Company" => "TinyCo", "Job_Title" => "CEO"
   merge.write_to "/path/to/output.docx"
 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).

data/lib/consolidate/docx/merge.rb

@@ -10,23 +10,25 @@ module Consolidate
         new(path, force_settings: force_settings, &block)
       end
 
+      def examine
+        extract_field_names
+      end
+
       def data fields = {}
         fields = fields.transform_keys(&:to_s)
 
-        xml = @zip.read("word/document.xml")
-        doc = Nokogiri::XML(xml) { |x| x.noent }
-
-        doc = substitute_style_one_with xml, doc, fields
-        doc = substitute_style_two_with xml, doc, fields
+        result = doc.dup
+        result = substitute_style_one_with result, fields
+        result = substitute_style_two_with result, fields
 
-        @output["word/document.xml"] = doc.serialize save_with: 0
+        @output["word/document.xml"] = result.serialize save_with: 0
       end
 
       def write_to path
         Zip::File.open(path, Zip::File::CREATE) do |out|
-          @zip.each do |entry|
+          zip.each do |entry|
             out.get_output_stream(entry.name) do |o|
-              o.write(@output[entry.name] || @zip.read(entry.name))
+              o.write(output[entry.name] || zip.read(entry.name))
             end
           end
         end
@@ -34,33 +36,59 @@ module Consolidate
 
       protected
 
+      attr_reader :zip
+      attr_reader :xml
+      attr_reader :doc
+      attr_accessor :output
+
       def initialize(path, force_settings: true, &block)
         raise "No block given" unless block
         @output = {}
         set_standard_settings if force_settings
         begin
           @zip = Zip::File.open(path)
+          @xml = @zip.read("word/document.xml")
+          @doc = Nokogiri::XML(xml) { |x| x.noent }
+
           yield self
         ensure
           @zip.close
         end
       end
 
-      def substitute_style_one_with xml, doc, fields
+      def extract_field_names
+        (extract_style_one + extract_style_two).uniq
+      end
+
+      def extract_style_one
+        (doc / "//w:fldSimple").collect do |field|
+          value = field.attributes["instr"].value.strip
+          value.include?("MERGEFIELD") ? value.gsub("MERGEFIELD", "").strip : nil
+        end.compact
+      end
+
+      def extract_style_two
+        (doc / "//w:instrText").collect do |instr|
+          value = instr.inner_text
+          value.include?("MERGEFIELD") ? value.gsub("MERGEFIELD", "").strip : nil
+        end.compact
+      end
+
+      def substitute_style_one_with document, fields
         # Word's first way of doing things
-        (doc / "//w:fldSimple").each do |field|
+        (document / "//w:fldSimple").each do |field|
           if field.attributes["instr"].value =~ /MERGEFIELD (\S+)/
             text_node = (field / ".//w:t").first
             next unless text_node
             text_node.inner_html = fields[$1].to_s
           end
         end
-        doc
+        document
       end
 
-      def substitute_style_two_with xml, doc, fields
+      def substitute_style_two_with document, fields
         # Word's second way of doing things
-        (doc / "//w:instrText").each do |instr|
+        (document / "//w:instrText").each do |instr|
           if instr.inner_text =~ /MERGEFIELD (\S+)/
             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
@@ -68,16 +96,16 @@ module Consolidate
             text_node.inner_html = fields[$1].to_s
           end
         end
-        doc
+        document
       end
 
       def set_standard_settings
-        @output["word/settings.xml"] = %(<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+        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
+        zip.close
       end
     end
   end

data/lib/consolidate/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-consolidate
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Rahoul Baruah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-25 00:00:00.000000000 Z
+date: 2023-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip