standard-procedure-consolidate 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f240fafdaf4fea72b63ba38b70c0e49736bb46a3f1f793ed79030f0f184d7760
-  data.tar.gz: '08930023d6b6865933a65a1cbefcd026d3a33b56323f702b5b46c9eedb76a210'
+  metadata.gz: 5647faddeab8829e8494e02b4b87acc33276e7f293fa147f3b15b1dd2a6d4c09
+  data.tar.gz: e867ef111010caa13eef6da80f11ccaa7ee0d780f82309a8f4d976bcff058545
 SHA512:
-  metadata.gz: b205661ee1cd85599254559477ef73809086a9c232036c34a090b706437a01f46a947def4dfe3a90c12b50a0a589dcac671c1b5c5f1d9cea69bfadf160de5b02
-  data.tar.gz: 917b84c6116e50936b1de0a31605c345d8ec4ac48c466bd97afec9f937ebe81b67f0b56f9c5a75fda735d71f496382ef714d7b5e9012878b2f1af4223833a8d0
+  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

@@ -8,3 +8,8 @@
 ## [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

@@ -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/lib/consolidate/docx/merge.rb

@@ -17,11 +17,13 @@ module Consolidate
       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
@@ -38,19 +40,22 @@ module Consolidate
 
       attr_reader :zip
       attr_reader :xml
-      attr_reader :doc
+      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)
-          @xml = @zip.read("word/document.xml")
-          @doc = Nokogiri::XML(xml) { |x| x.noent }
-
-          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
@@ -61,17 +66,21 @@ module Consolidate
       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
+            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
+            value.include?("MERGEFIELD") ? value.gsub("MERGEFIELD", "").strip : nil
+          end.compact
+        end.flatten
       end
 
       def substitute_style_one_with document, fields

data/lib/consolidate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Consolidate
-  VERSION = "0.1.1"
+  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.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Rahoul Baruah
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-08-03 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: []