gscan 4.29.2 → 4.30.0

package/app/tpl/index.hbs

@@ -22,8 +22,8 @@
                 <span class="gh-input-icon select-arrow">{{> icon-arrow-up}}</span>
                 <span class="gh-input-icon select-arrow active">{{> icon-arrow-down}}</span>
                 <select class="gh-input gh-select" name="version" id="version">
-                    <option value="v5">{{ghostVersions.v5.major}}</option>
-                    <option value="v4" selected>{{ghostVersions.v4.major}}</option>
+                    <option value="v5" selected>{{ghostVersions.v5.major}}</option>
+                    <option value="v4">{{ghostVersions.v4.major}}</option>
                     <option value="v3">{{ghostVersions.v3.major}}</option>
                     <option value="v2">{{ghostVersions.v2.major}}</option>
                     <option value="v1">{{ghostVersions.v1.major}}</option>

package/lib/ast-linter/rules/index.js

@@ -7,7 +7,11 @@ module.exports = {
     'GS090-NO-PRODUCT-DATA-HELPER': require('./lint-no-product-data-helper'),
     'GS090-NO-PRODUCTS-DATA-HELPER': require('./lint-no-products-data-helper'),
     'GS090-NO-MEMBER-PRODUCTS-DATA-HELPER': require('./lint-no-member-products-data-helper'),
-    'GS090-NO-PRICE-DATA-HELPER': require('./lint-no-price-data-helper'),
+    'GS090-NO-TIER-PRICE-AS-OBJECT': require('./lint-no-tier-price-as-object'),
+    'GS090-NO-TIER-BENEFIT-AS-OBJECT': require('./lint-no-tier-benefit-as-object'),
+    'GS090-NO-PRICE-DATA-CURRENCY-GLOBAL': require('./lint-no-price-data-currency-global'),
+    'GS090-NO-PRICE-DATA-CURRENCY-CONTEXT': require('./lint-no-price-data-currency-context'),
+    'GS090-NO-PRICE-DATA-MONTHLY-YEARLY': require('./lint-no-price-data-monthly-yearly'),
     'no-multi-param-conditionals': require('./lint-no-multi-param-conditionals'),
     'no-nested-async-helpers': require('./lint-no-nested-async-helpers'),
     'no-prev-next-post-outside-post-context': require('./lint-no-prev-next-post-outside-post-context'),

package/lib/ast-linter/rules/internal/scope.js

@@ -204,6 +204,20 @@ class Scope {
         return found;
     }
 
+    getParentContextNode(context) {
+        let matchedFrame = null;
+
+        if (this.frames && this.frames.length) {
+            matchedFrame = this.frames.find((frame) => {
+                if (frame.nodeName === context) {
+                    return true;
+                }
+            });
+        }
+
+        return matchedFrame && matchedFrame.node;
+    }
+
     isLocal(node) {
         // @foo MustacheStatements are referencing globals rather than locals
         if (node.type === 'MustacheStatement' && node.path.data) {

package/lib/ast-linter/rules/lint-no-price-data-currency-context.js

@@ -0,0 +1,26 @@
+const Rule = require('./base');
+const _ = require('lodash');
+
+module.exports = class NoPriceDataCurrencyContext extends Rule {
+    _findPriceData(node) {
+        if (node.data && node.parts && node.parts.length === 2 && node.parts[0] === 'price' && node.parts[1] === 'currency') {
+            const foreachNode = this.scope.getParentContextNode('foreach');
+            const foreachObject = _.get(foreachNode, 'params[0].original');
+
+            if (['@member.subscriptions', 'tiers'].includes(foreachObject)) {
+                this.log(({
+                    message: `{{@price.currency}} should be replaced with {{currency}}`,
+                    line: node.loc && node.loc.start.line,
+                    column: node.loc && node.loc.start.column,
+                    source: this.sourceForNode(node)
+                }));
+            }
+        }
+    }
+
+    visitor() {
+        return {
+            PathExpression: this._findPriceData.bind(this)
+        };
+    }
+};

package/lib/ast-linter/rules/lint-no-price-data-currency-global.js

@@ -0,0 +1,26 @@
+const Rule = require('./base');
+const _ = require('lodash');
+
+module.exports = class NoPriceDataCurrencyGlobal extends Rule {
+    _findPriceData(node) {
+        if (node.data && node.parts && node.parts.length === 2 && node.parts[0] === 'price' && node.parts[1] === 'currency') {
+            const foreachNode = this.scope.getParentContextNode('foreach');
+            const foreachObject = _.get(foreachNode, 'params[0].original');
+
+            if (!['@member.subscriptions', 'tiers'].includes(foreachObject)) {
+                this.log(({
+                    message: `{{@price.currency}} should be replaced with {{currency}} and a context`,
+                    line: node.loc && node.loc.start.line,
+                    column: node.loc && node.loc.start.column,
+                    source: this.sourceForNode(node)
+                }));
+            }
+        }
+    }
+
+    visitor() {
+        return {
+            PathExpression: this._findPriceData.bind(this)
+        };
+    }
+};

package/lib/ast-linter/rules/lint-no-price-data-monthly-yearly.js

@@ -0,0 +1,20 @@
+const Rule = require('./base');
+
+module.exports = class NoPriceDataMonthlyYearly extends Rule {
+    _findPriceData(node) {
+        if (node.data && node.parts && node.parts.length === 2 && node.parts[0] === 'price' && ['monthly', 'yearly'].includes(node.parts[1])) {
+            this.log(({
+                message: `{{@price.monthly}} and {{@price.yearly}} should be replaced with {{#get "tiers"}}`,
+                line: node.loc && node.loc.start.line,
+                column: node.loc && node.loc.start.column,
+                source: this.sourceForNode(node)
+            }));
+        }
+    }
+
+    visitor() {
+        return {
+            PathExpression: this._findPriceData.bind(this)
+        };
+    }
+};

package/lib/ast-linter/rules/lint-no-tier-benefit-as-object.js

@@ -0,0 +1,30 @@
+const Rule = require('./base');
+const {getNodeName, logNode} = require('../helpers');
+const _ = require('lodash');
+
+module.exports = class NoTierBenefitAsObject extends Rule {
+    _checkForHelperName(node) {
+        const nodeName = getNodeName(node);
+        const isMatchingHelper = (nodeName.includes('name'));
+        const foreachNode = this.scope.getParentContextNode('foreach');
+        const getNode = this.scope.getParentContextNode('get');
+
+        const hasForeachBenefits = _.get(foreachNode, 'params[0].original') === 'benefits';
+        const hasGetTiers = _.get(getNode, 'params[0].original') === 'tiers';
+
+        if (hasForeachBenefits && hasGetTiers && isMatchingHelper) {
+            this.log({
+                message: `${logNode(node)} should not be used`,
+                line: node.loc && node.loc.start.line,
+                column: node.loc && node.loc.start.column,
+                source: this.sourceForNode(node)
+            });
+        }
+    }
+
+    visitor() {
+        return {
+            MustacheStatement: this._checkForHelperName.bind(this)
+        };
+    }
+};

package/lib/ast-linter/rules/{lint-no-price-data-helper.js → lint-no-tier-price-as-object.js}

@@ -1,12 +1,15 @@
+const _ = require('lodash');
 const Rule = require('./base');
 const {getNodeName, logNode} = require('../helpers');
 
-module.exports = class NoPriceDataHelper extends Rule {
+module.exports = class NoMonthlyYearlyPriceObjects extends Rule {
     _checkForHelperName(node) {
         const nodeName = getNodeName(node);
-        const isMatchingHelper = (nodeName.startsWith('@price.'));
+        const isMatchingHelper = (nodeName.includes('monthly_price.')) || (nodeName.includes('yearly_price.'));
+        const getNode = this.scope.getParentContextNode('get');
+        const hasGetTiers = _.get(getNode, 'params[0].original') === 'tiers';
 
-        if (isMatchingHelper) {
+        if (isMatchingHelper && hasGetTiers) {
             this.log({
                 message: `${logNode(node)} should not be used`,
                 line: node.loc && node.loc.start.line,

package/lib/checks/010-package-json.js

@@ -55,7 +55,10 @@ const v4PackageJSONValidationRules = _.extend({},
 );
 
 const canaryPackageJSONConditionalRules = {};
-const canaryPackageJSONValidationRules = _.extend({});
+const canaryPackageJSONValidationRules = _.extend({},
+    {isNotPresentCardAssets: 'GS010-PJ-GHOST-CARD-ASSETS-NOT-PRESENT'},
+    canaryPackageJSONConditionalRules
+);
 
 _private.validatePackageJSONFields = function validatePackageJSONFields(packageJSON, theme, packageJSONValidationRules) {
     let failed = [];
@@ -138,6 +141,11 @@ _private.validatePackageJSONFields = function validatePackageJSONFields(packageJ
         }
     }
 
+    // @TODO: validate that the card_assets config is valid
+    if (!packageJSON.config || (_.isEmpty(packageJSON.config.card_assets) && !_.isBoolean(packageJSON.config.card_assets))) {
+        markFailed('isNotPresentCardAssets');
+    }
+
     if (packageJSON.config && packageJSON.config.custom) {
         const customSettingsKeys = Object.keys(packageJSON.config.custom);
 

package/lib/format.js

@@ -1,30 +1,7 @@
 const _ = require('lodash');
 const spec = require('./specs');
-const levelWeights = {
-    error: 10,
-    warning: 3,
-    recommendation: 1
-};
 const versions = require('./utils').versions;
-
-const calcScore = function calcScore(results, stats) {
-    var maxScore, actualScore, balancedScore;
-
-    maxScore = _.reduce(levelWeights, function (max, weight, level) {
-        return max + (weight * stats[level]);
-    }, 0);
-
-    actualScore = _.reduce(levelWeights, function (max, weight, level) {
-        return max - (weight * _.size(results[level]));
-    }, maxScore);
-
-    balancedScore = _.ceil((100 / maxScore) * actualScore);
-
-    return {
-        value: balancedScore,
-        level: _.size(results.error) > 0 ? 'error' : balancedScore < 60 ? 'warning' : 'passing'
-    };
-};
+const calcScore = require('./utils/score-calculator');
 
 const formatCLI = (theme) => {
     _.each(theme.results, (results) => {

package/lib/specs/canary.js

@@ -21,10 +21,16 @@ let rules = {
     // New rules
     'GS010-PJ-GHOST-API-PRESENT': {
         level: 'warning',
-        rule: 'Remove <code>"engines.ghost-api"</code> from <code>package.json</code>.',
+        rule: 'Remove <code>"engines.ghost-api"</code> from <code>package.json</code>',
         details: oneLineTrim`The <code>"ghost-api"</code> version is no longer used and can be removed.<br>
         Find more information about the <code>package.json</code> file <a href="${docsBaseUrl}structure/#packagejson" target=_blank>here</a>.`
     },
+    'GS010-PJ-GHOST-CARD-ASSETS-NOT-PRESENT': {
+        level: 'warning',
+        rule: '<code>"card_assets"</code> will default to <code>true</code> in <code>package.json</code>',
+        details: oneLineTrim`The <code>"card_assets"</code> property is enabled by default if not explicitly set.<br>
+        Find more information about the <code>card_assets</code> property <a href="${docsBaseUrl}content/#editor-cards" target=_blank>here</a>.`
+    },
     'GS090-NO-AUTHOR-HELPER-IN-POST-CONTEXT': {
         level: 'error',
         fatal: true,
@@ -69,14 +75,46 @@ let rules = {
         Find more information about the <code>{{@member.subscriptions}}</code> property <a href="${docsBaseUrl}members/#member-subscriptions" target=_blank>here</a>.`,
         helper: '{{@member.products}}'
     },
-    'GS090-NO-PRICE-DATA-HELPER': {
+    'GS090-NO-PRICE-DATA-CURRENCY-GLOBAL': {
+        level: 'error',
+        fatal: true,
+        rule: 'Replace <code>@price.currency</code> with <code>{{#get "tiers"}}</code> and <code>{{currency}}</code> or <code>{{#foreach @member.subscriptions}}</code> and <code>{{plan.currency}}</code>',
+        details: oneLineTrim`There is no longer a global <code>@price</code> object. You need to use either <code>{{#get "tiers"}}</code> to fetch all tiers and use the <code>{{currency}}</code> property of a tier<br>
+        or use <code>{{#foreach @member.subscriptions}}</code> to fetch an individual member's subscriptions, and use the <code>{{plan.currency}}</code> property from the subscription.<br>
+        Find more information about the <code>{{price}}</code> helper <a href="${docsBaseUrl}members/price/" target=_blank>here</a>.`
+    },
+    'GS090-NO-PRICE-DATA-CURRENCY-CONTEXT': {
+        level: 'error',
+        fatal: true,
+        rule: 'Replace <code>{{@price.currency}}</code> with <code>{{currency}}</code> or <code>{{plan.currency}}</code>',
+        details: oneLineTrim`There is no longer a global <code>@price</code> object. Instead the <code>{{currency}}</code> property can be used inside <code>{{#get "tiers"}}</code><br>
+        or <code>{{plan.currency}}</code> can be used inside <code>{{#foreach @member.subscriptions}}</code><br>
+        Find more information about the <code>{{price}}</code> helper <a href="${docsBaseUrl}members/price/" target=_blank>here</a>.`
+    },
+    'GS090-NO-PRICE-DATA-MONTHLY-YEARLY': {
+        level: 'error',
+        fatal: true,
+        rule: 'Replace <code>{{@price.monthly}}</code> and <code>{{@price.yearly}}</code> with <code>{{#get "tiers"}}</code> and <code>{{monthly_price}}</code> or <code>{{yearly_price}}</code>',
+        details: oneLineTrim`There is no longer a global <code>@price</code> object. You need to use <code>{{#get "tiers"}}</code> to fetch all the tiers and get access to the <code>{{monthly_price}}</code> or <code>{{yearly_price}}</code> for each tier<br>
+        Find more information about the <code>{{price}}</code> helper <a href="${docsBaseUrl}helpers/price/" target=_blank>here</a>.`
+    },
+    'GS090-NO-TIER-PRICE-AS-OBJECT': {
+        level: 'error',
+        fatal: true,
+        rule: 'Remove usage of <code>{{monthly_price.*}}</code> and <code>{{yearly_price.*}}.</code>',
+        details: oneLineTrim`The usage of <code>{{monthly_price.*}}</code> and <code>{{yearly_price.*}} is no longer supported.</code><br>
+        ${tierDesc}<br>
+        Find more information about the <code>{{#get "tiers"}}</code> <a href="${docsBaseUrl}helpers/tiers/" target=_blank>here</a>.`,
+        helper: '{{#get "tiers"}}'
+    },
+    'GS090-NO-TIER-BENEFIT-AS-OBJECT': {
         level: 'error',
         fatal: true,
-        rule: 'Replace <code>{{@price}}</code> with <code>{{price}}</code> and <code>{{@member.subscriptions}}</code>',
-        details: oneLineTrim`The <code>{{@price}}</code> data helper was removed in favor of <code>{{price}}</code> and <code>{{@member.subscriptions}}</code><br>
+        rule: 'Remove usage of <code>{{name}}</code> for tier benefits.</code>',
+        details: oneLineTrim`The usage of <code>{{name}}</code> for tier benefits is no longer supported.</code><br>
         ${tierDesc}<br>
-        Find more information about the <code>{{price}}</code> helper <a href="${docsBaseUrl}members/#the-price-helper" target=_blank>here</a>.`,
-        helper: '{{@price}}'
+        Find more information about the <code>{{#get "tiers"}}</code> <a href="${docsBaseUrl}helpers/tiers/" target=_blank>here</a>.`,
+        helper: '{{#get "tiers"}}'
     },
 
     // Updated v1 & v2 rules
@@ -685,8 +723,8 @@ let rules = {
         level: 'error',
         fatal: true,
         rule: 'Replace <code>{{[#].currency_symbol}}</code> with <code>{{price currency=currency}}</code>.',
-        details: oneLineTrim`The hardcoded <code>currency_symbol</code> attribute is no longer supported in favour of passing the currency to updated <code>{{price}}</code> helper.
-        Find more information about the updated <code>{{price}}</code> helper <a href="${docsBaseUrl}members/#the-price-helper" target=_blank>here</a>.`,
+        details: oneLineTrim`The <code>currency_symbol</code> attribute is no longer supported in favour of passing the currency to updated <code>{{price}}</code> helper.<br>
+        Find more information about the updated <code>{{price}}</code> helper <a href="${docsBaseUrl}helpers/price" target=_blank>here</a>.`,
         helper: '{{[#].currency_symbol}}',
         regex: /currency_symbol/g
     }

package/lib/utils/score-calculator.js

@@ -0,0 +1,40 @@
+const _ = require('lodash');
+
+const levelWeights = {
+    error: 10,
+    warning: 3,
+    recommendation: 1
+};
+
+/**
+ *
+ * @param {Object} results
+ * @param {Object} results.error
+ * @param {Object} results.warning
+ * @param {Object} results.recommendation
+ * @param {Object} stats
+ * @param {Object} stats.error
+ * @param {Object} stats.warning
+ * @param {Object} stats.recommendation
+* @returns {Object}
+ */
+const calcScore = function calcScore(results, stats) {
+    var maxScore, actualScore, balancedScore;
+
+    maxScore = _.reduce(levelWeights, function (max, weight, level) {
+        return max + (weight * stats[level]);
+    }, 0);
+
+    actualScore = _.reduce(levelWeights, function (max, weight, level) {
+        return max - (weight * _.size(results[level]));
+    }, maxScore);
+
+    balancedScore = _.floor((100 / maxScore) * actualScore);
+
+    return {
+        value: balancedScore,
+        level: _.size(results.error) > 0 ? 'error' : balancedScore < 60 ? 'warning' : 'passing'
+    };
+};
+
+module.exports = calcScore;

package/lib/utils/versions.json

@@ -19,5 +19,5 @@
     "major": "5.x",
     "docs": "5.0.0"
   },
-  "default": "v4"
+  "default": "v5"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gscan",
-  "version": "4.29.2",
+  "version": "4.30.0",
   "description": "Scans Ghost themes looking for errors, deprecations, features and compatibility",
   "keywords": [
     "ghost",
@@ -45,7 +45,7 @@
     "@tryghost/debug": "0.1.11",
     "@tryghost/errors": "1.2.12",
     "@tryghost/logging": "2.1.8",
-    "@tryghost/pretty-cli": "1.2.27",
+    "@tryghost/pretty-cli": "1.2.28",
     "@tryghost/server": "0.1.4",
     "@tryghost/zip": "1.1.25",
     "bluebird": "3.7.2",