sablon 0.4.2 → 0.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e5e1eb2032c1dabea9541897a7c808ac60f231f05433b692e5065f03f170ce9b
4
- data.tar.gz: 1b81c62aff7f9a1a3993fb73e6d25b8b0e6723914d8470c014c49116df25aaad
3
+ metadata.gz: 0ede5e89f3efb63644af593418b79d9f9a1b292fb2e324bcf219bc4df45861db
4
+ data.tar.gz: 2d74c177fa676898fbcb7049d2a603970efaee750020fbbe04e451224d0e40c3
5
5
  SHA512:
6
- metadata.gz: 6117e358ac595e371761bb2d66bae3e874cb59ddae8626bc440940b926e7e247c372d1cf16ee7e77c8de7bfed4e94d7015c2c7cdeab616f90f2d126446a784b8
7
- data.tar.gz: 23db1f9f4f9b7d393cd12eaae8b84545119fe85e1b107069e9edfd6e0e375bed82a53eb5ca4df9e4f3f44bbba51c089578ba5d515197d551407e6cff4cfe744a
6
+ metadata.gz: 69c5d66b34f2a2d9a8a9d83fe427d0cfb7889ee94c189e5bd36ac51adcadb45aeaf151657ec9a05e04f4bbb204c73ca52844a0336f0b1cc163fb8df7adbae87c
7
+ data.tar.gz: 25c099669cce5a689a491aa5382933d630e578ce1cc7871d977fc78696e07b3b4898012eedec457f76e3ee3102b5add4f02a58476ecad5177d1bb7f3a4ca4dba
@@ -15,7 +15,7 @@ jobs:
15
15
  runs-on: 'ubuntu-latest'
16
16
  strategy:
17
17
  matrix:
18
- ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2', '3.3']
18
+ ruby-version: ['2.3', '2.4', '2.5', '2.6', '2.7', '3.0', '3.1', '3.2', '3.3', '3.4']
19
19
  channel: ['stable']
20
20
 
21
21
  include:
data/Gemfile.lock CHANGED
@@ -1,21 +1,24 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- sablon (0.4.2)
4
+ sablon (0.4.4)
5
5
  nokogiri (>= 1.8.5)
6
6
  rubyzip (>= 1.3.0)
7
7
 
8
8
  GEM
9
9
  remote: https://rubygems.org/
10
10
  specs:
11
- minitest (5.20.0)
12
- nokogiri (1.18.8-arm64-darwin)
11
+ mini_portile2 (2.8.9)
12
+ minitest (5.27.0)
13
+ mutex_m (0.3.0)
14
+ nokogiri (1.18.9)
15
+ mini_portile2 (~> 2.8.2)
13
16
  racc (~> 1.4)
14
- ostruct (0.6.0)
15
- racc (1.8.0)
16
- rake (13.1.0)
17
- rexml (3.2.6)
18
- rubyzip (2.3.2)
17
+ ostruct (0.6.3)
18
+ racc (1.8.1)
19
+ rake (13.3.0)
20
+ rexml (3.4.1)
21
+ rubyzip (3.0.1)
19
22
  xml-simple (1.1.9)
20
23
  rexml
21
24
 
@@ -25,6 +28,7 @@ PLATFORMS
25
28
  DEPENDENCIES
26
29
  bundler (>= 1.6)
27
30
  minitest (~> 5.4)
31
+ mutex_m
28
32
  ostruct
29
33
  rake (~> 13.0)
30
34
  sablon!
@@ -86,7 +86,7 @@ module Sablon
86
86
  @ast_class = value
87
87
  return
88
88
  else
89
- value = value.to_s
89
+ value = value.to_s.dup
90
90
  end
91
91
  # camel case the word and get class, similar logic to
92
92
  # ActiveSupport::Inflector.constantize but refactored to be specific
@@ -53,7 +53,13 @@ module Sablon
53
53
 
54
54
  def render(context, properties = {})
55
55
  # initialize environment
56
- @document = Sablon::DOM::Model.new(Zip::File.open(@path, !File.exist?(@path)))
56
+ @document = Sablon::DOM::Model.new(
57
+ if defined?(Zip::VERSION) && Gem::Version.new(Zip::VERSION) >= Gem::Version.new('3.0.0')
58
+ Zip::File.open(@path, create: !File.exist?(@path))
59
+ else
60
+ Zip::File.open(@path, !File.exist?(@path))
61
+ end
62
+ )
57
63
  env = Sablon::Environment.new(self, context)
58
64
  env.section_properties = properties
59
65
  #
@@ -83,13 +89,15 @@ module Sablon
83
89
  created_dirs = []
84
90
  contents.each do |entry_name, content|
85
91
  create_dirs_in_zipfile(created_dirs, File.dirname(entry_name), zip_out)
86
- zip_out.put_next_entry(entry_name)
87
92
  #
88
93
  # convert Nokogiri XML to string
89
94
  if content.instance_of? Nokogiri::XML::Document
90
95
  content = content.to_xml(indent: 0, save_with: 0)
91
96
  end
92
97
  #
98
+ entry = Zip::Entry.new('', entry_name)
99
+ entry.size = content.bytesize
100
+ zip_out.put_next_entry(entry)
93
101
  zip_out.write(content)
94
102
  end
95
103
  end
@@ -1,3 +1,3 @@
1
1
  module Sablon
2
- VERSION = "0.4.2"
2
+ VERSION = "0.4.4"
3
3
  end
data/sablon.gemspec CHANGED
@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
31
31
  spec.add_development_dependency "minitest", "~> 5.4"
32
32
  spec.add_development_dependency "xml-simple"
33
33
  spec.add_development_dependency "ostruct"
34
+ spec.add_development_dependency "mutex_m"
34
35
  end
data/test/content_test.rb CHANGED
@@ -252,7 +252,10 @@ class ContentImageTest < Sablon::TestCase
252
252
  #
253
253
  # set some rid's and retest
254
254
  @expected.rid_by_file['word/test.xml'] = 'rId1'
255
- assert_equal '#<Image r2d2.jpg:{"word/test.xml"=>"rId1"}>', @expected.inspect
255
+ assert_includes [
256
+ '#<Image r2d2.jpg:{"word/test.xml"=>"rId1"}>',
257
+ '#<Image r2d2.jpg:{"word/test.xml" => "rId1"}>'
258
+ ], @expected.inspect
256
259
  end
257
260
 
258
261
  def test_wraps_image_from_string_path
@@ -24,7 +24,6 @@ class HTMLConverterASTBuilderTest < Sablon::TestCase
24
24
 
25
25
  def test_validate_structure
26
26
  @builder = new_builder
27
- root = Sablon::Configuration.instance.permitted_html_tags['#document-fragment'.to_sym]
28
27
  div = Sablon::Configuration.instance.permitted_html_tags[:div]
29
28
  span = Sablon::Configuration.instance.permitted_html_tags[:span]
30
29
  # test valid relationship
@@ -35,14 +35,20 @@ class NodePropertiesTest < Sablon::TestCase
35
35
  def test_node_property_with_hash_value_converison
36
36
  props = { 'shd' => { color: 'clear', fill: '123456', test: nil } }
37
37
  props = Sablon::HTMLConverter::NodeProperties.new('w:rPr', props, @inc_props.new)
38
- assert_equal props.inspect, 'shd={:color=>"clear", :fill=>"123456", :test=>nil}'
38
+ assert_includes [
39
+ 'shd={:color=>"clear", :fill=>"123456", :test=>nil}',
40
+ 'shd={color: "clear", fill: "123456", test: nil}'
41
+ ], props.inspect
39
42
  assert_equal props.to_docx, '<w:rPr><w:shd w:color="clear" w:fill="123456" /></w:rPr>'
40
43
  end
41
44
 
42
45
  def test_node_property_with_array_value_converison
43
46
  props = { 'numPr' => [{ 'ilvl' => 1 }, { 'numId' => 34 }] }
44
47
  props = Sablon::HTMLConverter::NodeProperties.new('w:pPr', props, @inc_props.new)
45
- assert_equal props.inspect, 'numPr=[{"ilvl"=>1}, {"numId"=>34}]'
48
+ assert_includes [
49
+ 'numPr=[{"ilvl"=>1}, {"numId"=>34}]',
50
+ 'numPr=[{"ilvl" => 1}, {"numId" => 34}]'
51
+ ], props.inspect
46
52
  assert_equal props.to_docx, '<w:pPr><w:numPr><w:ilvl w:val="1" /><w:numId w:val="34" /></w:numPr></w:pPr>'
47
53
  end
48
54
 
@@ -0,0 +1,92 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "test_helper"
4
+
5
+ class SablonTemplateTest < Sablon::TestCase
6
+ def setup
7
+ super
8
+ @template_path = File.expand_path("fixtures/loops_template.docx", File.dirname(__FILE__))
9
+ @rendered_document = Sablon.template(template_path).render_to_string(
10
+ fruits: [{ name: "Piña" }],
11
+ cars: [{ name: "Camión" }]
12
+ ).b
13
+ end
14
+
15
+ def test_small_entries_do_not_use_zip64_in_local_or_central_headers
16
+ headers.each do |header|
17
+ refute_includes extra_field_ids(header[:extra]), 0x0001,
18
+ "Unexpected ZIP64 extra field in #{header[:description]}"
19
+ end
20
+ end
21
+
22
+ def test_small_entries_only_require_zip_version_20
23
+ headers.each do |header|
24
+ assert_equal 20, header[:version],
25
+ "Unexpected version needed to extract in #{header[:description]}"
26
+ end
27
+ end
28
+
29
+ def test_rendering_preserves_multibyte_text_and_binary_entries
30
+ Zip::File.open_buffer(StringIO.new(rendered_document)) do |output|
31
+ text = Nokogiri::XML(output.read("word/document.xml")).text
32
+ assert_includes text, "Piña"
33
+ assert_includes text, "Camión"
34
+
35
+ Zip::File.open(template_path) do |input|
36
+ binary_entries = input.entries.select do |entry|
37
+ entry.file? && entry.name !~ /\.(xml|rels)$/
38
+ end
39
+ refute_empty binary_entries
40
+
41
+ binary_entries.each do |entry|
42
+ assert_equal input.read(entry.name).b, output.read(entry.name).b, entry.name
43
+ end
44
+ end
45
+ end
46
+ end
47
+
48
+ private
49
+
50
+ attr_reader :template_path, :rendered_document
51
+
52
+ # XML comparisons discard the ZIP metadata that affects document-reader compatibility.
53
+ def headers
54
+ result = []
55
+ end_offset = rendered_document.rindex("PK\x05\x06".b)
56
+ central_offset = rendered_document.byteslice(end_offset + 16, 4).unpack('V').first
57
+
58
+ Zip::File.open_buffer(StringIO.new(rendered_document)) do |zip|
59
+ zip.each do |entry|
60
+ local_offset = entry.local_header_offset
61
+ assert_equal "PK\x03\x04".b, rendered_document.byteslice(local_offset, 4)
62
+ name_size, extra_size = rendered_document.byteslice(local_offset + 26, 4).unpack('vv')
63
+ result << {
64
+ description: "local header for #{entry.name}",
65
+ version: rendered_document.byteslice(local_offset + 4, 2).unpack('v').first,
66
+ extra: rendered_document.byteslice(local_offset + 30 + name_size, extra_size)
67
+ }
68
+
69
+ assert_equal "PK\x01\x02".b, rendered_document.byteslice(central_offset, 4)
70
+ name_size, extra_size, comment_size = rendered_document.byteslice(central_offset + 28, 6).unpack('vvv')
71
+ result << {
72
+ description: "central header for #{entry.name}",
73
+ version: rendered_document.byteslice(central_offset + 6, 2).unpack('v').first,
74
+ extra: rendered_document.byteslice(central_offset + 46 + name_size, extra_size)
75
+ }
76
+ central_offset += 46 + name_size + extra_size + comment_size
77
+ end
78
+ end
79
+ result
80
+ end
81
+
82
+ def extra_field_ids(data)
83
+ ids = []
84
+ offset = 0
85
+ while offset < data.bytesize
86
+ id, size = data.byteslice(offset, 4).unpack('vv')
87
+ ids << id
88
+ offset += 4 + size
89
+ end
90
+ ids
91
+ end
92
+ end
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: sablon
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.2
4
+ version: 0.4.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Yves Senn
8
- autorequire:
9
8
  bindir: exe
10
9
  cert_chain: []
11
- date: 2025-07-18 00:00:00.000000000 Z
10
+ date: 1980-01-02 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: nokogiri
@@ -108,6 +107,20 @@ dependencies:
108
107
  - - ">="
109
108
  - !ruby/object:Gem::Version
110
109
  version: '0'
110
+ - !ruby/object:Gem::Dependency
111
+ name: mutex_m
112
+ requirement: !ruby/object:Gem::Requirement
113
+ requirements:
114
+ - - ">="
115
+ - !ruby/object:Gem::Version
116
+ version: '0'
117
+ type: :development
118
+ prerelease: false
119
+ version_requirements: !ruby/object:Gem::Requirement
120
+ requirements:
121
+ - - ">="
122
+ - !ruby/object:Gem::Version
123
+ version: '0'
111
124
  description: Sablon is a document template processor. At this time it works only with
112
125
  docx and MailMerge fields.
113
126
  email:
@@ -241,13 +254,13 @@ files:
241
254
  - test/support/document_xml_helper.rb
242
255
  - test/support/html_snippets.rb
243
256
  - test/support/xml_snippets.rb
257
+ - test/template_test.rb
244
258
  - test/test_helper.rb
245
259
  homepage: http://github.com/senny/sablon
246
260
  licenses:
247
261
  - MIT
248
262
  metadata:
249
263
  rubygems_mfa_required: 'true'
250
- post_install_message:
251
264
  rdoc_options: []
252
265
  require_paths:
253
266
  - lib
@@ -262,8 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
262
275
  - !ruby/object:Gem::Version
263
276
  version: '0'
264
277
  requirements: []
265
- rubygems_version: 3.5.16
266
- signing_key:
278
+ rubygems_version: 4.0.16
267
279
  specification_version: 4
268
280
  summary: docx template processor
269
281
  test_files:
@@ -337,4 +349,5 @@ test_files:
337
349
  - test/support/document_xml_helper.rb
338
350
  - test/support/html_snippets.rb
339
351
  - test/support/xml_snippets.rb
352
+ - test/template_test.rb
340
353
  - test/test_helper.rb