Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow functions to be added as styles in head #2377

Merged
merged 7 commits into from
Nov 24, 2021
Merged

Allow functions to be added as styles in head #2377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
61419d6
support style being a function
vidhu Oct 18, 2021
cdf4588
tests
vidhu Oct 18, 2021
4b3a059
use ternary
vidhu Oct 18, 2021
4c010d9
whoops
vidhu Oct 19, 2021
5420015
fix linting
vidhu Oct 21, 2021
421d3ba
Rename test file to
vidhu Oct 25, 2021
791df30
define property outside class instead of static for node 10
vidhu Nov 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions packages/mjml-core/src/helpers/skeleton.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { reduce, negate, isNil } from 'lodash'
import { map, reduce, negate, isNil, isFunction } from 'lodash'
import buildPreview from './preview'
import { buildFontsTags } from './fonts'
import buildMediaQueriesTags from './mediaQueries'
Expand All @@ -15,7 +15,7 @@ export default function skeleton(options) {
headRaw = [],
preview,
title = '',
style,
style = [],
forceOWADesktop,
inlineStyle,
lang,
Expand Down Expand Up @@ -71,11 +71,9 @@ export default function skeleton(options) {
'',
)}
</style>
${
style && style.length > 0
? `<style type="text/css">${style.join('')}</style>`
: ''
}
<style type="text/css">
${map(style, (s) => (isFunction(s) ? s(breakpoint) : s)).join('')}
</style>
${headRaw.filter(negate(isNil)).join('\n')}
</head>
<body style="word-spacing:normal;${
Expand Down
3 changes: 2 additions & 1 deletion packages/mjml/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"scripts": {
"clean": "rimraf lib",
"build": "babel src --out-dir lib --root-mode upward",
"test": "node ./test/test-html-attributes.js"
"test": "node ./test/index.js"
},
"dependencies": {
"@babel/runtime": "^7.14.6",
Expand All @@ -36,6 +36,7 @@
"devDependencies": {
"@babel/cli": "^7.8.4",
"chai": "^4.1.1",
"chai-spies": "^1.0.0",
"cheerio": "1.0.0-rc.10",
"lodash": "^4.17.21",
"rimraf": "^3.0.2"
Expand Down
48 changes: 25 additions & 23 deletions packages/mjml/test/test-html-attributes.js → packages/mjml/test/html-attributes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const mjml = require('../lib/index.js')
const chai = require('chai')
const cheerio = require('cheerio')
const { sortBy } = require('lodash')
const mjml = require('../lib')

const input = `
<mjml>
Expand Down Expand Up @@ -35,23 +35,31 @@ const input = `
</mjml>
`

const html = mjml(input).html
const { html } = mjml(input)
const $ = cheerio.load(html)

// should put the attributes at the right place
chai.expect(
$('.text div').map(function getAttr() {
return $(this).attr('data-id')
}).get(),
'Custom attributes added on texts',
).to.eql(['42', '42'])
chai
.expect(
$('.text div')
.map(function getAttr() {
return $(this).attr('data-id')
})
.get(),
'Custom attributes added on texts',
)
.to.eql(['42', '42'])

chai.expect(
$('.image td').map(function getAttr() {
return $(this).attr('data-name')
}).get(),
'Custom attributes added on image',
).to.eql(['43'])
chai
.expect(
$('.image td')
.map(function getAttr() {
return $(this).attr('data-name')
})
.get(),
'Custom attributes added on image',
)
.to.eql(['43'])

// should not alter templating syntax, or move the content that is outside any tag (mj-raws)
const expected = [
Expand All @@ -63,14 +71,8 @@ const expected = [
'{ end if }',
'{ item + 1 }',
]
const indexes = expected.map(str => html.indexOf(str))
const indexes = expected.map((str) => html.indexOf(str))

chai.expect(
indexes,
'Templating syntax unaltered',
).to.not.include(-1)
chai.expect(indexes, 'Templating syntax unaltered').to.not.include(-1)

chai.expect(
sortBy(indexes),
'Mj-raws kept same positions',
).to.deep.eql(indexes)
chai.expect(sortBy(indexes), 'Mj-raws kept same positions').to.deep.eql(indexes)
2 changes: 2 additions & 0 deletions packages/mjml/test/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
require('./html-attributes.test')
require('./lazy-head-style.test')
46 changes: 46 additions & 0 deletions packages/mjml/test/lazy-head-style.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
const chai = require('chai')
const spies = require('chai-spies')
const mjml = require('../lib')

chai.use(spies)

const {
HeadComponent,
registerComponent,
} = require('../../mjml-core/lib/index')

const addStyle = chai.spy(
(breakpoint) => `
@media only screen and (max-width:${breakpoint}) {
h1 {
font-size: 20px;
}
}
`,
)

class HeadComponentWithFunctionStyle extends HeadComponent {
handler() {
const { add } = this.context
add('style', addStyle)
}
}
HeadComponentWithFunctionStyle.componentName = 'mj-head-component-with-function-style'
HeadComponentWithFunctionStyle.endingTag = true
HeadComponentWithFunctionStyle.allowedAttributes = {}


registerComponent(HeadComponentWithFunctionStyle)

mjml(`
<mjml>
<mj-head>
<mj-head-component-with-function-style />
<mj-breakpoint width="300px" />
</mj-head>
<mj-body>
</mj-body>
</mjml>
`)

chai.expect(addStyle).to.have.been.called.with('300px')
5 changes: 5 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2824,6 +2824,11 @@ caseless@~0.12.0:
resolved "https://registry.yarnpkg.com/caseless/-/caseless-0.12.0.tgz#1b681c21ff84033c826543090689420d187151dc"
integrity sha1-G2gcIf+EAzyCZUMJBolCDRhxUdw=

chai-spies@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/chai-spies/-/chai-spies-1.0.0.tgz#d16b39336fb316d03abf8c375feb23c0c8bb163d"
integrity sha512-elF2ZUczBsFoP07qCfMO/zeggs8pqCf3fZGyK5+2X4AndS8jycZYID91ztD9oQ7d/0tnS963dPkd0frQEThDsg==

chai@^4.1.1:
version "4.3.4"
resolved "https://registry.yarnpkg.com/chai/-/chai-4.3.4.tgz#b55e655b31e1eac7099be4c08c21964fce2e6c49"
Expand Down