standard-procedure-consolidate 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f240fafdaf4fea72b63ba38b70c0e49736bb46a3f1f793ed79030f0f184d7760
-  data.tar.gz: '08930023d6b6865933a65a1cbefcd026d3a33b56323f702b5b46c9eedb76a210'
+  metadata.gz: b2d1794f2a364e867d285325c3a0dd9b5c6b4716145d5eaf964c91c44e937e5c
+  data.tar.gz: 6622d19bc3de12fe8d77775b579c1531a057a27bacf227b0b119a252e7fd0003
 SHA512:
-  metadata.gz: b205661ee1cd85599254559477ef73809086a9c232036c34a090b706437a01f46a947def4dfe3a90c12b50a0a589dcac671c1b5c5f1d9cea69bfadf160de5b02
-  data.tar.gz: 917b84c6116e50936b1de0a31605c345d8ec4ac48c466bd97afec9f937ebe81b67f0b56f9c5a75fda735d71f496382ef714d7b5e9012878b2f1af4223833a8d0
+  metadata.gz: bb6944c739e5d772a45076b86f5c08d299913575027845ba505aa76b4ade18e3ecb47efe77f4499ac2a01f8782fcbf797b7dde9d00fb479716ac0b927288c9b4
+  data.tar.gz: b9c10360e43007c6cd523ad238664786f2aa0884e524349d451989646e05f3f59569821e7361a8f4c553dad182ca61588629d108359b08953287bddf62f8533c

data/.devcontainer/devcontainer.json

@@ -0,0 +1,7 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ruby
+{
+	"name": "Ruby",
+	"image": "mcr.microsoft.com/devcontainers/ruby:1-3.2-bullseye",
+	"postCreateCommand": "bundle install"
+}

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -1,10 +1,26 @@
+## [0.1.3] - 2023-09-07
 
-## [Unreleased]
+Customer had an issue where some fields were not merging correctly
 
-## [0.1.0] - 2023-07-25
+- 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
 
-- Initial release
+## [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.0] - 2023-07-25
+
+- Initial release
+
+## [Unreleased]
+
+
+

data/README.md

@@ -33,13 +33,17 @@ NOTE: The merge fields are case-sensitive - which is why they should be supplied
 
 ## Development
 
-After checking out the repo, run `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.
+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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+`bundle exec rake install` will install the gem on your local machine (obviously not from within the devcontainer though). To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/standard-procedure/standard-procedure-consolidate. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/standard-procedure/standard-procedure-consolidate/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/standard-procedure/standard-procedure-consolidate.
+
+When adding commit messages, please explain _why_ the change is being made.
+
+When submitting a pull request, please ensure that there is an RSpec detailing how the feature works and please explain, in the pull request itself, the reasoning behind adding the feature.
 
 ## License
 
@@ -47,4 +51,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Standard::Procedure::Consolidate project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/standard-procedure-consolidate/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Standard::Procedure::Consolidate project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/standard-procedure/standard-procedure-consolidate/blob/main/CODE_OF_CONDUCT.md).

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

@@ -0,0 +1 @@
+055a4ccf5326b9f737e0222cecfdbaee34554fc42dcfaf017807e643fdc1ceb06b35329fe6a8ca32805c7ca3adf0c7df39b6bc32766208d69820243cde0a3648

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

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

data/lib/consolidate/docx/merge.rb

@@ -6,22 +6,26 @@ 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 = {}
         fields = fields.transform_keys(&:to_s)
 
-        result = doc.dup
-        result = substitute_style_one_with result, fields
-        result = substitute_style_two_with result, fields
+        @documents.each do |name, document|
+          result = document.dup
+          result = substitute_style_one_with result, fields
+          result = substitute_style_two_with result, fields
 
-        @output["word/document.xml"] = result.serialize save_with: 0
+          @output[name] = result.serialize save_with: 0
+        end
       end
 
       def write_to path
@@ -36,42 +40,59 @@ module Consolidate
 
       protected
 
+      attr_reader :verbose
       attr_reader :zip
       attr_reader :xml
-      attr_reader :doc
+      attr_reader :documents
       attr_accessor :output
 
-      def initialize(path, force_settings: true, &block)
+      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
         @output = {}
-        set_standard_settings if force_settings
+        @documents = {}
         begin
           @zip = Zip::File.open(path)
-          @xml = @zip.read("word/document.xml")
-          @doc = Nokogiri::XML(xml) { |x| x.noent }
-
+          @zip.entries.each do |entry|
+            next if EXCLUSIONS.include? entry.name
+            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
-        (doc / "//w:fldSimple").collect do |field|
-          value = field.attributes["instr"].value.strip
-          value.include?("MERGEFIELD") ? value.gsub("MERGEFIELD", "").strip : nil
-        end.compact
+        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
       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
+        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
       end
 
       def substitute_style_one_with document, fields
@@ -80,6 +101,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
@@ -93,17 +115,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.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: standard-procedure-consolidate
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Rahoul Baruah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-03 00:00:00.000000000 Z
+date: 2023-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
@@ -46,7 +46,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/devcontainer.json"
 - ".rspec"
+- ".ruby-version"
 - ".standard.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -54,6 +56,8 @@ files:
 - README.md
 - 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
 - exe/consolidate
 - lib/consolidate.rb
 - lib/consolidate/docx/merge.rb
@@ -83,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Simple ruby mailmerge for Microsoft Word .docx files.