Merge pull request #50 from blackflux/dev

[Gally]: master <- dev

.depunusedignore

@@ -0,0 +1 @@
+eslint

package.json

@@ -40,7 +40,8 @@
     "babel-eslint": "10.0.1",
     "chai": "4.2.0",
     "coveralls": "3.0.3",
-    "js-gardener": "1.38.2",
+    "eslint": "5.15.1",
+    "js-gardener": "1.38.3",
     "nyc": "13.3.0",
     "semantic-release": "15.13.3",
     "tmp": "0.0.33"
@@ -94,6 +95,7 @@
     "joi": "14.3.1",
     "lodash.clonedeep": "4.5.0",
     "lodash.difference": "4.5.0",
+    "object-deep-contain": "1.0.4",
     "object-scan": "5.0.3",
     "smart-fs": "1.3.0"
   }

src/configs/jetbrains/@common.json

@@ -0,0 +1,5 @@
+{
+  "configs": [
+    "jetbrains/exclude-coverage-folder"
+  ]
+}

src/configs/jetbrains/exclude-coverage-folder.json

@@ -0,0 +1,13 @@
+{
+  "target": ".idea/${projectName}.iml",
+  "format": "xml",
+  "strategy": "xml-merge",
+  "snippets": [
+    {
+      "name": "exclude-folder-from-module",
+      "variables": {
+        "folder": "coverage"
+      }
+    }
+  ]
+}

src/configs/jetbrains/snippets/exclude-folder-from-module.iml

@@ -0,0 +1,7 @@
+<module>
+  <component>
+    <content url="file://$MODULE_DIR$">
+      <excludeFolder url="file://$MODULE_DIR$/${folder}"/>
+    </content>
+  </component>
+</module>

src/util/config.js

@@ -10,6 +10,7 @@ const strategies = require('./strategies');
 
 const configSchema = Joi.object().keys({
   target: Joi.string(),
+  format: Joi.string().allow(null),
   strategy: Joi.string().valid(...Object.keys(strategies)),
   snippets: Joi.array().items(
     Joi.string(),
@@ -20,7 +21,7 @@ const configSchema = Joi.object().keys({
   ).min(1),
   configs: Joi.array().items(Joi.string())
 })
-  .and('target', 'strategy', 'snippets')
+  .and('target', 'strategy', 'snippets', 'format')
   .xor('target', 'configs')
   .unknown(false)
   .required();
@@ -34,7 +35,7 @@ const loadSnippet = (snippetDir, snippetName, config, snippetVars) => {
 
   const fileName = sls.guessFile(path.join(snippetDir, snippetName));
   assert(fileName !== null, `Invalid Snippet File Name: ${snippetName}`);
-  const snippet = sls.smartRead(fileName);
+  const snippet = sls.smartRead(fileName, { treatAs: config.format });
 
   return populateVars(snippet, snippetVars, false);
 };
@@ -50,13 +51,17 @@ module.exports.loadConfig = (configName, variables) => {
     return null;
   }
   const config = sls.smartRead(configFilePath);
+  if (config.target !== undefined) {
+    config.format = config.format || null;
+  }
 
   assert(Joi.validate(config, configSchema).error === null, `Invalid Config Detected: ${configName}`);
   assert(configName.includes('/@') === (config.configs !== undefined), `Invalid Config Name Detected: ${configName}`);
 
   if (typeof config.target === 'string') {
     // load and merge config snippets into config
     const snippetDir = path.join(__dirname, '..', 'configs', configName.split('/')[0], 'snippets');
+    config.target = populateVars([config.target], variables, true)[0];
     config.toWrite = deepmerge.all(config.snippets
       .map(m => (typeof m === 'string' ? [m, {}] : [m.name, m.variables]))
       .map(([snippetName, snippetVars]) => [snippetName, populateVars(snippetVars, variables, true)])
@@ -73,6 +78,7 @@ module.exports.applyConfig = (config, projectRoot) => {
 
   const target = path.join(projectRoot, config.target);
   return sls.smartWrite(target, config.toWrite, {
+    treatAs: config.format,
     mergeStrategy: strategies[config.strategy]
   });
 };

src/util/strategies.js

@@ -1,4 +1,5 @@
 const assert = require('assert');
+const xmlMerge = require('./xml-merge');
 
 module.exports = {
   'merge-below-title': (existing, changeset) => {
@@ -32,5 +33,6 @@ module.exports = {
     return changeset.concat(existing);
   },
   'merge-shallow': (existing, changeset) => Object.assign(existing, changeset),
+  'xml-merge': (existing, changeset) => xmlMerge(existing, changeset),
   overwrite: (existing, changeset) => changeset
 };

src/util/xml-merge.js

@@ -0,0 +1,42 @@
+const objectDeepContain = require('object-deep-contain');
+
+const mergeRec = (target, changeset) => {
+  if (changeset === undefined) {
+    return target;
+  }
+
+  const isArray = Array.isArray(target);
+  if (isArray !== Array.isArray(changeset)) {
+    return changeset;
+  }
+
+  if (isArray) {
+    let next = 0;
+    for (let idx = 0; idx < target.length && next < changeset.length; idx += 1) {
+      const targetElement = target[idx];
+      const toInsert = changeset[next];
+
+      if (objectDeepContain(
+        targetElement,
+        Object
+          .entries(toInsert)
+          .reduce((p, [k, v]) => Object.assign(p, k === 'elements' ? {} : { [k]: v }), {})
+      )) {
+        // eslint-disable-next-line no-param-reassign
+        target[idx] = mergeRec(targetElement, toInsert);
+        next += 1;
+      }
+    }
+    target.push(...changeset.slice(next));
+    return target;
+  }
+
+  if (target instanceof Object && changeset instanceof Object) {
+    return [...new Set(Object.keys(target).concat(Object.keys(changeset)))]
+      .reduce((p, k) => Object.assign(p, { [k]: mergeRec(target[k], changeset[k]) }), {});
+  }
+
+  return changeset;
+};
+
+module.exports = (target, changeset) => Object.assign(target, { data: mergeRec(target.data, changeset.data) });

test/index.spec.js

@@ -4,10 +4,14 @@ const robo = require('../src/index');
 
 it('Executing Configuration', () => {
   expect(robo({
-    configs: ['assorted/@npm-opensource'],
+    configs: [
+      'assorted/@npm-opensource',
+      'jetbrains/@common'
+    ],
     variables: {
       repoKey: 'blackflux/robo-config',
       repoName: 'robo-config',
+      projectName: 'robo-config',
       owner: 'simlu',
       authorName: 'Lukas Siemon',
       mergeBot: 'MrsFlux'

test/util/xml-merge.spec.js

@@ -0,0 +1,51 @@
+const fs = require('fs');
+const path = require('path');
+const expect = require('chai').expect;
+const tmp = require('tmp');
+const sfs = require('smart-fs');
+const xmlMerge = require('../../src/util/xml-merge');
+
+describe('Integration xml-merge.js', () => {
+  fs.readdirSync(path.join(__dirname, 'xml-merge'))
+    .forEach((f) => {
+      it(`Testing '${f}'`, () => {
+        const target = sfs.smartRead(path.join(__dirname, 'xml-merge', f, 'target.xml'));
+        const changeset = sfs.smartRead(path.join(__dirname, 'xml-merge', f, 'changeset.xml'));
+        const result = sfs.smartRead(path.join(__dirname, 'xml-merge', f, 'result.xml'));
+        const merged = xmlMerge(target, changeset);
+        expect(result).to.deep.equal(merged);
+      });
+    });
+});
+
+describe('Unit xml-merge.js', () => {
+  let dir;
+  beforeEach(() => {
+    dir = tmp.dirSync({ keep: false, unsafeCleanup: true }).name;
+  });
+
+  const executeTest = (target, changeset, result) => {
+    fs.writeFileSync(path.join(dir, 'target.xml'), target);
+    fs.writeFileSync(path.join(dir, 'changeset.xml'), changeset);
+    fs.writeFileSync(path.join(dir, 'result.xml'), result);
+
+    const merged = xmlMerge(
+      sfs.smartRead(path.join(dir, 'target.xml')),
+      sfs.smartRead(path.join(dir, 'changeset.xml'))
+    );
+    expect(merged).to.deep.equal(sfs.smartRead(path.join(dir, 'result.xml')));
+  };
+
+  it('Test Simple Merge', () => {
+    executeTest('<a/>', '<b/>', '<a/><b/>');
+    executeTest('<r><a/></r>', '<r><b/></r>', '<r><a/><b/></r>');
+  });
+
+  it('Test Header Merge', () => {
+    executeTest(
+      '<?xml version="1.0" ?>',
+      '<?xml encoding="UTF-8" ?>',
+      '<?xml version="1.0" encoding="UTF-8" ?>'
+    );
+  });
+});

test/util/xml-merge/append/changeset.xml

@@ -0,0 +1,5 @@
+<root>
+  <b y="4"/>
+  <a y="5"/>
+  <b y="6"/>
+</root>

test/util/xml-merge/append/result.xml

@@ -0,0 +1,8 @@
+<root>
+  <a x="1"/>
+  <b x="2"/>
+  <a x="3"/>
+<b y="4"/>
+  <a y="5"/>
+  <b y="6"/>
+</root>

test/util/xml-merge/append/target.xml

@@ -0,0 +1,5 @@
+<root>
+  <a x="1"/>
+  <b x="2"/>
+  <a x="3"/>
+</root>

test/util/xml-merge/header/changeset.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8" ?>

test/util/xml-merge/header/result.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
+<empty />

test/util/xml-merge/header/target.xml

@@ -0,0 +1,2 @@
+<?xml standalone="yes" ?>
+<empty />

test/util/xml-merge/no-change/changeset.xml

@@ -0,0 +1,7 @@
+<module>
+  <component>
+    <orderEntry type="B">
+      <test/>
+    </orderEntry>
+  </component>
+</module>

test/util/xml-merge/no-change/result.xml

@@ -0,0 +1,8 @@
+<module>
+  <component>
+    <orderEntry type="A"/>
+    <orderEntry type="B">
+      <test/>
+    </orderEntry>
+  </component>
+</module>

test/util/xml-merge/no-change/target.xml

@@ -0,0 +1,8 @@
+<module>
+  <component>
+    <orderEntry type="A"/>
+    <orderEntry type="B">
+      <test/>
+    </orderEntry>
+  </component>
+</module>

test/util/xml-merge/target-first/changeset.xml

@@ -0,0 +1,7 @@
+<module>
+  <component>
+    <orderEntry type="A">
+      <test/>
+    </orderEntry>
+  </component>
+</module>

test/util/xml-merge/target-first/result.xml

@@ -0,0 +1,7 @@
+<module>
+  <component>
+    <orderEntry type="A">
+      <test/>
+    </orderEntry>
+  </component>
+</module>

test/util/xml-merge/target-first/target.xml

@@ -0,0 +1,5 @@
+<module>
+  <component>
+    <orderEntry type="A"/>
+  </component>
+</module>

test/util/xml-merge/target-second/changeset.xml

@@ -0,0 +1,7 @@
+<module>
+  <component>
+    <orderEntry type="B">
+      <test/>
+    </orderEntry>
+  </component>
+</module>

test/util/xml-merge/target-second/result.xml

@@ -0,0 +1,8 @@
+<module>
+  <component>
+    <orderEntry type="A"/>
+    <orderEntry type="B">
+      <test/>
+    </orderEntry>
+  </component>
+</module>

test/util/xml-merge/target-second/target.xml

@@ -0,0 +1,6 @@
+<module>
+  <component>
+    <orderEntry type="A"/>
+    <orderEntry type="B"/>
+  </component>
+</module>