standard-procedure-consolidate 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52bf3de85226b0aa00c8a2d5ad8caa7e0dbc7aa2e8707150d844e34a3313fcf9
-  data.tar.gz: cf92c7c1fc1978cc7e615674d01e542d4ca5b4588da08856b6608301efd83109
+  metadata.gz: 5647faddeab8829e8494e02b4b87acc33276e7f293fa147f3b15b1dd2a6d4c09
+  data.tar.gz: e867ef111010caa13eef6da80f11ccaa7ee0d780f82309a8f4d976bcff058545
 SHA512:
-  metadata.gz: 1a2c3dfa7bc6fe20d8f3ddc2bdfe9f1c94fe53ddd1daf75009f96af35ba20f1d7acdaf6b1f3563b9484f50fa4a0a5b53ab4c2e161008f0131fd03d39b67df76f
-  data.tar.gz: f169d41a245b6dbe95d20eeded64c5ff684ec4822dfab36ed342374916c6e7eb2c6dee82cc14fc89bc1d141ba4c1b259629e8b6ba219952bd949db0f53384aa8
+  metadata.gz: 3f7e9ebff0ec1706b59983eb8b1f32132e58af066f3e4de56a4e05c55ea2f365a236cc513e5571930cd0173ddaebd6329a7d628cb5a137b0ac1b1b365f1d5672
+  data.tar.gz: cab09a1aa8f2338b24397fd2eb2252c4244b4890dd965581657fcd025197948a9290896e0fa519ab782719f25b34f292e17f44de3c15f13329b1fe964550162b

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,5 +1,15 @@
+
 ## [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
+
+## [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

data/README.md

@@ -13,25 +13,37 @@ 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).
 
 ## 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
 
@@ -39,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/lib/consolidate/docx/merge.rb

@@ -10,23 +10,27 @@ 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
+        @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"] = doc.serialize save_with: 0
+          @output[name] = result.serialize save_with: 0
+        end
       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 +38,66 @@ module Consolidate
 
       protected
 
+      attr_reader :zip
+      attr_reader :xml
+      attr_reader :documents
+      attr_accessor :output
+
       def initialize(path, force_settings: true, &block)
         raise "No block given" unless block
         @output = {}
+        @documents = {}
         set_standard_settings if force_settings
         begin
           @zip = Zip::File.open(path)
-          yield self
+          ["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
+          end
         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
+        documents.collect do |name, document|
+          (document / "//w:fldSimple").collect do |field|
+            value = field.attributes["instr"].value.strip
+            value.include?("MERGEFIELD") ? value.gsub("MERGEFIELD", "").strip : nil
+          end.compact
+        end.flatten
+      end
+
+      def extract_style_two
+        documents.collect do |name, document|
+          (document / "//w:instrText").collect do |instr|
+            value = instr.inner_text
+            value.include?("MERGEFIELD") ? value.gsub("MERGEFIELD", "").strip : nil
+          end.compact
+        end.flatten
+      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 +105,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.2"
 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.2
 platform: ruby
 authors:
 - Rahoul Baruah
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-25 00:00:00.000000000 Z
+date: 2023-08-29 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,7 @@ files:
 - README.md
 - Rakefile
 - checksums/standard-procedure-consolidate-0.1.0.gem.sha512
+- checksums/standard-procedure-consolidate-0.1.2.gem.sha512
 - exe/consolidate
 - lib/consolidate.rb
 - lib/consolidate/docx/merge.rb
@@ -68,7 +71,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
@@ -83,8 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
-signing_key:
+rubygems_version: 3.4.10
+signing_key: 
 specification_version: 4
 summary: Simple ruby mailmerge for Microsoft Word .docx files.
 test_files: []