middleman-newsletter 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: e2c64d703700265a174426b2d0ac2ca4f28137fcd059f3ee0b2e7c5e32f09d5c
4
+ data.tar.gz: 9b778f8c6fda16e1823de172fd18ed43a126c4aa7543cb9d63d93299e39fd8b0
5
+ SHA512:
6
+ metadata.gz: 732e460987be5076019c35f1faf2db363cd122bd4adb2057c0ef12c19fbcb69cb882ba1547d05717133d3263ca04e6e1606f6e5e40f1e24386fe9b6b4aac4998
7
+ data.tar.gz: 42bfcb3f6933f0e5e97d1a8efa219f6edf8b85e4adcf4f7cdb7c379aef9489052b96ea7a789c09d8ff5a8e5059c72a4864e6f0e182eacd65473b8a4a3797895a
data/.gitignore ADDED
@@ -0,0 +1,5 @@
1
+ # Ignore bundler lock file
2
+ /Gemfile.lock
3
+
4
+ # Ignore pkg folder
5
+ /pkg
data/Gemfile ADDED
@@ -0,0 +1,19 @@
1
+ # If you do not have OpenSSL installed, update
2
+ # the following line to use "http://" instead
3
+ source 'https://rubygems.org'
4
+
5
+ # Specify your gem's dependencies in middleman-newsletter.gemspec
6
+ gemspec
7
+
8
+ group :development do
9
+ gem 'rake'
10
+ gem 'rdoc'
11
+ gem 'yard'
12
+ end
13
+
14
+ group :test do
15
+ gem 'capybara'
16
+ gem 'cucumber'
17
+ gem 'aruba'
18
+ gem 'rspec'
19
+ end
data/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
data/NOTICE ADDED
@@ -0,0 +1,2 @@
1
+ middleman-newsletter
2
+ Copyright 2024 Teak.io, Inc.
data/Rakefile ADDED
@@ -0,0 +1,14 @@
1
+ require 'bundler'
2
+ Bundler::GemHelper.install_tasks
3
+
4
+ require 'cucumber/rake/task'
5
+
6
+ Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
7
+ t.cucumber_opts = '--color --tags "not @wip" --strict'
8
+ end
9
+
10
+ require 'rake/clean'
11
+
12
+ task test: ['cucumber']
13
+
14
+ task default: :test
@@ -0,0 +1,4 @@
1
+ PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
2
+ require 'middleman-core'
3
+ require 'middleman-core/step_definitions'
4
+ require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-newsletter')
@@ -0,0 +1,13 @@
1
+ module Middleman
2
+ module Blog
3
+ module BlogArticle
4
+ def newsletter_resource=(resource)
5
+ @newsletter_resource = resource
6
+ end
7
+
8
+ def newsletter_resource
9
+ @newsletter_resource
10
+ end
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,165 @@
1
+ # Require core library
2
+ require 'middleman-core'
3
+
4
+
5
+ # Extension namespace
6
+ module Middleman
7
+ class NewsletterExtension < ::Middleman::Extension
8
+ extend Forwardable
9
+
10
+ # We want this to come after just about everything else, but especially the blog.
11
+ self.resource_list_manipulator_priority = 200
12
+
13
+ def_delegator :app, :logger
14
+
15
+ option :layout, 'layout', 'Newsletter specific layout'
16
+ option :sendgrid_api_key, nil, 'API Key for SendGrid -- must have marketing access.'
17
+ option :sendgrid_category, 'newsletters', 'Category assigned to all managed single sends in SendGrid.'
18
+
19
+ def initialize(app, options_hash={}, &block)
20
+ # Call super to build options from the options_hash
21
+ super
22
+
23
+ require 'middleman-newsletter/newsletter'
24
+ require 'middleman-newsletter/blog_article_extensions'
25
+ require 'middleman-newsletter/kramdown'
26
+
27
+ require 'premailer'
28
+ end
29
+
30
+ def after_configuration
31
+ app.sitemap.register_resource_list_manipulator(:newsletter_generator, self)
32
+ end
33
+
34
+ def after_build
35
+ if options.sendgrid_api_key.blank?
36
+ logger.info('== Newsletter: No SendGrid API key, not setting up newsletters')
37
+ return
38
+ end
39
+
40
+ require 'sendgrid-ruby'
41
+
42
+ expected_newsletters = @_newsletters.each_with_object({}) { |r, h| h[r.source_resource.title] = r unless r.source_resource.data['publish_newsletter'] == false }
43
+ live_newsletters = extant_newsletters.each_with_object({}) { |r, h| h[r[:name]] = r }
44
+
45
+ to_update = []
46
+ to_create = []
47
+
48
+ expected_newsletters.each do |(key, value)|
49
+ live = live_newsletters[key]
50
+ if live
51
+ to_update << [live[:id], value] if live[:status] != 'triggered'
52
+ else
53
+ to_create << value
54
+ end
55
+ end
56
+
57
+ to_destroy = live_newsletters.each_with_object([]) { |(key, value), arr| arr << value if !expected_newsletters.key?(key) && value[:status] != 'triggered' }
58
+
59
+ to_create.each do |newsletter|
60
+ create_in_sendgrid(newsletter)
61
+ end
62
+
63
+ to_update.each do |(id, newsletter)|
64
+ update_in_sendgrid(id, newsletter)
65
+ end
66
+
67
+ to_destroy.each do |live|
68
+ destroy_in_sendgrid(live)
69
+ end
70
+ end
71
+
72
+ def manipulate_resource_list(resources)
73
+ @_newsletters = []
74
+ resources.each do |resource|
75
+ newsletter = convert_to_newsletter(resource)
76
+ next unless newsletter
77
+
78
+ @_newsletters << newsletter
79
+ end
80
+
81
+ (resources + @_newsletters).uniq
82
+ end
83
+
84
+ private
85
+
86
+ def sendgrid_client
87
+ @sendgrid_client ||= SendGrid::API.new(api_key: options.sendgrid_api_key).client
88
+ end
89
+
90
+ def create_in_sendgrid(newsletter)
91
+ blog = newsletter.source_resource
92
+ name = blog.title
93
+ logger.info("== Creating Single Send for #{name}")
94
+ sendgrid_client.marketing.singlesends.post(
95
+ request_body: {
96
+ name: name,
97
+ categories: [options.sendgrid_category],
98
+ email_config: {
99
+ subject: name,
100
+ html_content: newsletter.render({}, {})
101
+ }
102
+ }
103
+ )
104
+ end
105
+
106
+ def update_in_sendgrid(singlesend_id, newsletter)
107
+ blog = newsletter.source_resource
108
+ name = blog.title
109
+ logger.info("== Updating Single Send for #{name}, sg id #{singlesend_id}")
110
+ sendgrid_client.marketing.singlesends._(singlesend_id).patch(
111
+ request_body: {
112
+ email_config: {
113
+ subject: name,
114
+ html_content: newsletter.render({}, {})
115
+ }
116
+ }
117
+ )
118
+ end
119
+
120
+ def destroy_in_sendgrid(singlesend)
121
+ id = singlesend[:id]
122
+ logger.info("== Destroying Single Send #{singlesend[:name]}, sg id #{id}")
123
+ sendgrid_client.marketing.singlesends._(id).delete()
124
+ end
125
+
126
+ def extant_newsletters
127
+ @extant_newsletters ||= begin
128
+ response = sendgrid_client.marketing.singlesends.search.post(
129
+ request_body: {
130
+ categories: [options.sendgrid_category]
131
+ }
132
+ )
133
+ # I decided to include an extra sanity check where we strip out any single sends that don't have
134
+ # our tag category before any further consideration. In theory the API should not return any single sends
135
+ # that don't have our category, buuuut since we will go on to delete 'unexpected' singlesends...
136
+ # This sanity check will help us not go "sorcerer's apprentice" if the SendGrid API fails.
137
+ capture_all(response).select { |result| result[:categories].include?(options.sendgrid_category) }
138
+ end
139
+ end
140
+
141
+ def capture_all(response)
142
+ ret = response.parsed_body[:result]
143
+ next_page = response.parsed_body.dig(:_metadata, :next)
144
+ return ret if next_page.nil?
145
+ next_response = sendgrid_client._(next_page.delete_prefix(sendgrid_client.host)).post()
146
+ ret + capture_all(next_response)
147
+ end
148
+
149
+ def convert_to_newsletter(resource)
150
+ return resource if resource.is_a?(Newsletter)
151
+ return nil unless resource.is_a?(::Middleman::Blog::BlogArticle)
152
+ return resource.newsletter_resource if resource.newsletter_resource
153
+
154
+ newsletter = ::Middleman::Sitemap::Resource.new(app.sitemap, "newsletters/#{resource.destination_path}", resource.file_descriptor)
155
+ newsletter.extend Newsletter
156
+ newsletter.newsletter_controller = self
157
+ resource.newsletter_resource = newsletter
158
+ newsletter.source_resource = resource
159
+
160
+ newsletter.ignore! if @app.production?
161
+
162
+ newsletter
163
+ end
164
+ end
165
+ end
@@ -0,0 +1,102 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Middleman
4
+ module Renderers
5
+ class KramdownEmailTemplate < ::Tilt::KramdownTemplate
6
+ def initialize(*args, &block)
7
+ super
8
+
9
+ @context = @options[:context] if @options.key?(:context)
10
+ end
11
+
12
+ def evaluate(context, *)
13
+ MiddlemanKramdownEmailHtmlConverter.scope = @context || context
14
+
15
+ @output ||= begin
16
+ output, warnings = MiddlemanKramdownEmailHtmlConverter.convert(@engine.root, @engine.options)
17
+ @engine.warnings.concat(warnings)
18
+ output
19
+ end
20
+ end
21
+ end
22
+
23
+ class MiddlemanKramdownEmailHtmlConverter < ::Kramdown::Converter::Html
24
+ cattr_accessor :scope
25
+
26
+ BLANK_LINE = %(<div class="paragraph-break"><br></div)
27
+ TABLE_PREAMBLE = %(<table class="module" role="module" data-type="text" border="0" cellpadding="0" cellspacing="0"><tbody><tr><td><div>)
28
+ TABLE_POSTFIX = %(<br></div>#{BLANK_LINE}</td></tr></tbody></table>)
29
+ def convert_p(el, indent)
30
+ if el.options[:transparent]
31
+ inner(el, indent)
32
+ elsif el.children.size == 1 && el.children.first.type == :img
33
+ convert_standalone_image(el, indent)
34
+ else
35
+ "#{(' ' * indent)}#{TABLE_PREAMBLE}#{format_as_block_html("span", el.attr, inner(el, indent), indent)}#{TABLE_POSTFIX}"
36
+ end
37
+ end
38
+
39
+
40
+ IMG_TABLE_PREFIX = %(<table class="module" role="module" data-type="image" border="0" cellpadding="0" cellspacing="0" width="100%"><tbody><tr><td>)
41
+ IMG_TABLE_POSTFIX = %(#{BLANK_LINE}</td></tr></tbody></table>)
42
+ def convert_standalone_image(el, indent)
43
+ image = el.children.first
44
+ "#{(' ' * indent)}#{IMG_TABLE_PREFIX}#{convert_img(image, indent)}#{IMG_TABLE_POSTFIX}"
45
+ end
46
+
47
+ def convert_img(el, indent)
48
+ attr = el.attr.dup
49
+ attr['class'] = ["max-width", *attr['class']].compact.join(' ')
50
+ link = attr.delete('src')
51
+ scope.image_tag(link, attr)
52
+ end
53
+
54
+ def convert_br(_el, _indent)
55
+ if @stack.last&.type == :p
56
+ "</span></div>\n<div><span>"
57
+ else
58
+ ''
59
+ end
60
+ end
61
+
62
+ def convert_table(el, indent)
63
+ if el.type == :table
64
+ attr = el.attr.dup
65
+ attr['class'] = ['module', *attr['class']].compact.join(' ')
66
+ attr['data-type'] = 'table'
67
+ format_as_indented_block_html(el.type, attr, inner(el, indent), indent) + '<br>'
68
+ else
69
+ super(el, indent)
70
+ end
71
+ end
72
+
73
+ TD_TABLE_PREFIX = %(<table cellpadding="0" cellspacing="0" align="left" border="0" bgcolor=""><tbody><tr>)
74
+ TD_TABLE_POSTFIX = %(</tr></tbody></table>)
75
+
76
+ def convert_thead(el, indent)
77
+ format_as_block_html(:tr, el.attr, inner(el, indent), indent)
78
+ end
79
+
80
+ def convert_td(el, indent)
81
+ res = inner(el, indent)
82
+ type = :td
83
+
84
+ count = @stack.last.children.length
85
+ width = (90.0 / count).to_s
86
+ width = '%.1f%%' % width
87
+
88
+ attr = el.attr.dup
89
+ alignment = @stack[-3].options[:alignment][@stack.last.children.index(el)]
90
+
91
+ if alignment != :default
92
+ attr['style'] = (attr.key?('style') ? "#{attr['style']}; " : '') + "text-align: #{alignment}"
93
+ end
94
+ attr['style'] = (attr.key?('style') ? "#{attr['style']}; " : '') + "width: #{width}"
95
+
96
+ res = "<table><tbody><tr><td>#{res}</td></tr></tbody></table>"
97
+
98
+ format_as_block_html(:td, attr, res.empty? ? entity_to_str(ENTITY_NBSP) : res, indent)
99
+ end
100
+ end
101
+ end
102
+ end
@@ -0,0 +1,35 @@
1
+ module Middleman
2
+ module Newsletter
3
+ def self.extended(base)
4
+ base.class.send(:attr_accessor, :newsletter_controller)
5
+ base.class.send(:attr_accessor, :source_resource)
6
+ end
7
+
8
+ def newsletter_options
9
+ newsletter_controller.options
10
+ end
11
+
12
+ def render(opts = {}, locs = {}, &block)
13
+ unless opts.key?(:layout)
14
+ opts[:layout] = metadata[:options][:newsletter_layout]
15
+ opts[:layout] = newsletter_options.layout if opts[:layout].nil? || opts[:layout] == :_auto_layout
16
+
17
+ # Convert to a string unless it's a boolean
18
+ opts[:layout] = opts[:layout].to_s if opts[:layout].is_a? Symbol
19
+ end
20
+
21
+ content = with_email_renderer { super(opts, locs, &block) }
22
+
23
+ Premailer.new(content, with_html_string: true, output_encoding: 'UTF-8', input_encoding: 'UTF-8').to_inline_css
24
+ end
25
+
26
+ def with_email_renderer
27
+ # Ensure we render using our custom email renderer
28
+ ::Tilt.register(source_file.downcase, ::Middleman::Renderers::KramdownEmailTemplate)
29
+ yield
30
+ ensure
31
+ # Don't pollute the tilt mappings, will slow things down
32
+ ::Tilt.default_mapping.unregister(source_file.downcase)
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,26 @@
1
+ require "middleman-core"
2
+
3
+ Middleman::Extensions.register :newsletter do
4
+ require "middleman-newsletter/extension"
5
+
6
+ module ::Tilt
7
+ class Mapping
8
+ # This was added in Tilt 2.1, but middleman-core is tied to ~> 2.0.9.
9
+ # So, backport, but guard it in case middleman-core updates to permit
10
+ # more modern tilt versions.
11
+ if !method_defined?(:unregister)
12
+ def unregister(*extensions)
13
+ extensions.each do |ext|
14
+ ext = ext.to_s
15
+ @template_map.delete(ext)
16
+ @lazy_map.delete(ext)
17
+ end
18
+
19
+ nil
20
+ end
21
+ end
22
+ end
23
+ end
24
+
25
+ ::Middleman::NewsletterExtension
26
+ end
@@ -0,0 +1,27 @@
1
+ # -*- encoding: utf-8 -*-
2
+ $:.push File.expand_path("../lib", __FILE__)
3
+
4
+ Gem::Specification.new do |s|
5
+ s.name = "middleman-newsletter"
6
+ s.version = "0.0.1"
7
+ s.platform = Gem::Platform::RUBY
8
+ s.authors = ["Alex Scarborough"]
9
+ # s.email = ["email@example.com"]
10
+ # s.homepage = "http://example.com"
11
+ s.summary = %q{Convert middleman blogs into a newsletter}
12
+ # s.description = %q{A longer description of your extension}
13
+
14
+ s.files = `git ls-files`.split("\n")
15
+ s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
16
+ s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
17
+ s.require_paths = ["lib"]
18
+
19
+ # The version of middleman-core your extension depends on
20
+ s.add_runtime_dependency("middleman-core", [">= 4.4.0"])
21
+ s.add_runtime_dependency("middleman-blog", [">= 4.0.3"])
22
+ s.add_runtime_dependency("premailer", ["~> 1.22"])
23
+ s.add_runtime_dependency("sendgrid-ruby", ["~> 6.7"])
24
+
25
+ # Additional dependencies
26
+ # s.add_runtime_dependency("gem-name", "gem-version")
27
+ end
metadata ADDED
@@ -0,0 +1,110 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: middleman-newsletter
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Alex Scarborough
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2024-03-06 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: middleman-core
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: 4.4.0
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: 4.4.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: middleman-blog
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 4.0.3
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: 4.0.3
41
+ - !ruby/object:Gem::Dependency
42
+ name: premailer
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '1.22'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '1.22'
55
+ - !ruby/object:Gem::Dependency
56
+ name: sendgrid-ruby
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - "~>"
60
+ - !ruby/object:Gem::Version
61
+ version: '6.7'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - "~>"
67
+ - !ruby/object:Gem::Version
68
+ version: '6.7'
69
+ description:
70
+ email:
71
+ executables: []
72
+ extensions: []
73
+ extra_rdoc_files: []
74
+ files:
75
+ - ".gitignore"
76
+ - Gemfile
77
+ - LICENSE
78
+ - NOTICE
79
+ - Rakefile
80
+ - features/support/env.rb
81
+ - lib/middleman-newsletter.rb
82
+ - lib/middleman-newsletter/blog_article_extensions.rb
83
+ - lib/middleman-newsletter/extension.rb
84
+ - lib/middleman-newsletter/kramdown.rb
85
+ - lib/middleman-newsletter/newsletter.rb
86
+ - middleman-newsletter.gemspec
87
+ homepage:
88
+ licenses: []
89
+ metadata: {}
90
+ post_install_message:
91
+ rdoc_options: []
92
+ require_paths:
93
+ - lib
94
+ required_ruby_version: !ruby/object:Gem::Requirement
95
+ requirements:
96
+ - - ">="
97
+ - !ruby/object:Gem::Version
98
+ version: '0'
99
+ required_rubygems_version: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ requirements: []
105
+ rubygems_version: 3.2.3
106
+ signing_key:
107
+ specification_version: 4
108
+ summary: Convert middleman blogs into a newsletter
109
+ test_files:
110
+ - features/support/env.rb