4.0.3

.gitignore

@@ -1,3 +1,20 @@
+.nogit/
+
+# artifacts
+coverage/
+public/
+pages/
+
+# installs
 node_modules/
-.settings/
-.idea/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -0,0 +1,127 @@
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
+
+stages:
+  - security
+  - test
+  - release
+  - metadata
+
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+    - npmci git mirror
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# test stage
+# ====================
+
+testStable:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+release:
+  stage: release
+  script:
+    - npmci node install stable
+    - npmci npm publish
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+    - lossless
+    - docker
+    - priv
+
+trigger:
+  stage: metadata
+  script:
+    - npmci trigger
+  only:
+    - tags
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+pages:
+  stage: metadata
+  script:
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
+  only:
+    - tags
+  artifacts:
+    expire_in: 1 week
+    paths:
+      - public
+  allow_failure: true

.travis.yml

@@ -1,19 +0,0 @@
-language: node_js
-before_install:
-  - nvm install stable
-  - node -v
-  - npm -v
-  - npm install -g gulp
-  - npm install gulp
-  - npm install gulp-typescript
-deploy:
-  provider: npm
-  email: npm@smart-coordination.com
-  api_key:
-    secure: hfuRCg2RSNTvSe49w+rqx/fPt2OILDTjdYkga5BnGr0Rja5yL/2SpVNOP62lYNQBB61TfqfT8F4gQsQyAuygzhNT1ijZ4qCvSdqHqXki/0hzTVZAvfF2aoLxUnuCMAYawUyx5nibJKCmGXvH9MbMrEwV5Gh0uSf0HRmskp/GKuXw5epnMkOT2SEr9Mw7Hpu3VKLEALoKOI2hYBRv555sRFkI3Cd9v1n0384HEjCbQEwXhPwwki2XL2SXzGP8IOccE3xLK9zsQO2RDCqaKpIsK682ZtrvyqxmAJaivtO6VImkpBXcKniYOqJR6sWrsw5345er/iSSr30fgjw4I6LNyUcmF59Uw/dPAElvLN6jU6zxg/+GHM7xqz/J/HV3rlE4d20/9ZJB9IIm2761c3T7DraBMbA7ehj1lolTvCq1vx8oGbNEhkTVBj06V3ltdMPHMiNbeG2Tqs50h/lOgRy5+oqZ8ULWayWX1KXloM3LlddXJnnB31LzHbZUZw7m+q8QnfBlPCWuLd1JfluFrszr1YAR6YPciL9grBNV7beG+8wbh2G0gfMdCHZOzhDmoEHgt/y8liV0QdsFH6QLlEwt8UMPeZ8IO0sNYx5A2ffznZIzy9xEDmMySwl8J3/EdQxhS6FGrm000lu4BH+c2dVlCn/5va9fJLD+m6seSN8Yy40=
-  on:
-    tags: true
-    repo: pushrocks/smartpath
-notifications:
-  slack:
-    secure: f5Uss0z9RPl/QcA/DroB8loyE93aOYI6bqCkrsiUscmZtlv/TVQtT4dxqGA6uvcG6iTQDBi3Ul88dQxWkRm4IqbhY35/iMaV2dHW4FVYMAh8GQMbsfL2sALCcufxD9blw47awv3iFcwhV1EeyesscjgL0JIjduk96v/7G/6QIO2838M1lzlgtj+kRUkim8qkaEs1je3gRrhMUIjLuAdscMXyUKYFMjWo9ACSjVUl30R/ZNemb18itIja6i92GotreBgcfEMczvy58ovDC7xdJUsY8LjMI01DwY+WPRnI0tAhsuI8moBwwcdM4e3bAjKjucQRjO33O5bMWRZ6QCiYd0DnCEFyCPQLJ4GSy/tkD00n8ijLHAOSV3AH1zNbdK1EAdSPQXDvlI36KJn/2hyQLoitGHVUPr76ujJWP82ypO2tgIp3XQU0dJVCxDuHnwJO2+hjdI+gCPqxNTpjeujHx3UdkTGNRjuuf9dlZ/D08fApjYxy2fxItTqo3QjP/nrqvBXUOPP8yPHpjIT4H2t5Pr4SJjBGI6X4qhKyFj6s9rA/Xu1rL+45zu1C3uC3z+u3T9UwrbzJ/cZM6r6UQvQmUvIfBNaMlg4I/diQCDIPL+Rhop2nylY3IcHmJnk2itn7kOqj1tohCpFEml5pRuSZy4udWywkdtyBAsHWFLF7oiQ=

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Push.Rocks
+Copyright (c) 2015 Lossless GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +0,0 @@
-# smartpath
-offers smart ways to handle paths

index.js

@@ -1,19 +0,0 @@
-/// <reference path="typings/tsd.d.ts" />
-var path = require("path");
-var bl = require("beautylog");
-/**
- *
- * @type {{getPath: (function(any): undefined)}}
- */
-var smartpath = {
-    getAbsPath: function (varPath, logBool) {
-        if (logBool === void 0) { logBool = false; }
-        var absPath = path.resolve(varPath);
-        if (logBool == true) {
-            bl.log('varPath is' + varPath);
-            bl.log('absPath is' + absPath);
-        }
-        return absPath;
-    }
-};
-module.exports = smartpath;

npmextra.json

@@ -0,0 +1,19 @@
+{
+  "npmci": {
+    "npmGlobalTools": [
+      "@gitzone/npmts"
+    ],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "smartpath",
+      "shortDescription": "offers smart ways to handle paths",
+      "npmPackagename": "@pushrocks/smartpath",
+      "license": "MIT"
+    }
+  }
+}

package.json

@@ -1,10 +1,13 @@
 {
-  "name": "smartpath",
-  "version": "1.0.2",
+  "name": "@pushrocks/smartpath",
+  "version": "4.0.3",
+  "private": false,
   "description": "offers smart ways to handle paths",
-  "main": "index.js",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
   "scripts": {
-    "test": "cd ts/compile && gulp"
+    "test": "(tstest test)",
+    "build": "(tsbuild)"
   },
   "repository": {
     "type": "git",
@@ -15,11 +18,30 @@
     "jade",
     "template"
   ],
-  "author": "Smart Coordination GmbH <office@push.rocks> (https://push.rocks)",
+  "author": "Lossless GmbH <office@lossless.com> (https://lossless.com)",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/pushrocks/smartpath/issues"
   },
   "homepage": "https://github.com/pushrocks/smartpath",
-  "dependencies": {}
+  "dependencies": {},
+  "devDependencies": {
+    "@gitzone/tsbuild": "^2.1.22",
+    "@gitzone/tsrun": "^1.2.8",
+    "@gitzone/tstest": "^1.0.28",
+    "@pushrocks/tapbundle": "^3.2.1",
+    "@types/node": "^13.11.1"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,38 @@
+# @pushrocks/smartpath
+offers smart ways to handle paths
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartpath)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/smartpath)
+* [github.com (source mirror)](https://github.com/pushrocks/smartpath)
+* [docs (typedoc)](https://pushrocks.gitlab.io/smartpath/)
+
+## Status for master
+[![pipeline status](https://gitlab.com/pushrocks/smartpath/badges/master/pipeline.svg)](https://gitlab.com/pushrocks/smartpath/commits/master)
+[![coverage report](https://gitlab.com/pushrocks/smartpath/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartpath/commits/master)
+[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartpath.svg)](https://www.npmjs.com/package/@pushrocks/smartpath)
+[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartpath/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartpath)
+[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/)
+
+## Usage
+
+Use TypeScript for best in class instellisense.
+
+For further information read the linked docs at the top of this README.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+
+[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/test.ts

@@ -0,0 +1,66 @@
+import { tap, expect } from '@pushrocks/tapbundle';
+import * as smartpath from '../ts/index';
+
+let mySmartpath: smartpath.Smartpath;
+tap.test('expect create a valid instance', async () => {
+  mySmartpath = new smartpath.Smartpath('/some/path/to/some.file');
+  expect(mySmartpath).to.be.instanceof(smartpath.Smartpath);
+  expect(mySmartpath.pathLevelsBackwards).to.be.of.length(5);
+});
+
+let filePathString = './somedir/somefile.json';
+let dirPathString = './somedir/anotherdir';
+let dirPathString2 = './somedir/another.dir/';
+
+tap.test('expect be true for a file path', async () => {
+  expect(smartpath.check.isFile(filePathString)).to.be.true;
+});
+tap.test('expect be false for a directory path', async () => {
+  expect(smartpath.check.isFile(dirPathString)).to.be.false;
+  expect(smartpath.check.isFile(dirPathString2)).to.be.false;
+});
+
+tap.test('expect be true for a directory path', async () => {
+  expect(smartpath.check.isDir(dirPathString)).to.be.true;
+
+  expect(smartpath.check.isDir(dirPathString2)).to.be.true;
+});
+
+tap.test('expect be false for a file path', async () => {
+  expect(smartpath.check.isDir(filePathString)).to.be.false;
+});
+
+let baseString = '/basedir';
+let relativeString = 'somedir/somefile.txt';
+let relativeString2 = 'anotherdir/anotherfile.txt';
+let relativeArray = [relativeString, relativeString, relativeString2];
+tap.test('expect make a string absolute', async () => {
+  expect(smartpath.transform.toAbsolute(relativeString)).startWith('/');
+  expect(smartpath.transform.toAbsolute(relativeString)).endWith(relativeString);
+  expect(smartpath.transform.toAbsolute(relativeString, baseString)).equal(
+    '/basedir/somedir/somefile.txt'
+  );
+});
+tap.test('expect make an array of relative Strings an Array of absolute Strings', async () => {
+  let absoluteArray = smartpath.transform.toAbsolute(relativeArray, baseString);
+  expect(absoluteArray[2]).to.startWith('/');
+  expect(absoluteArray[2]).endWith(relativeString2);
+});
+
+tap.test("expect return 'url' for an URL", async () => {
+  expect(smartpath.get.type('https://push.rocks/some/url')).equal('url');
+  expect(smartpath.get.type('https://push.rocks/some/url')).not.equal('local');
+});
+tap.test("expect return 'path' for a Path", async () => {
+  expect(smartpath.get.type('/some/absolute/path/')).equal('local');
+  expect(smartpath.get.type('./some/relative/path/')).not.equal('url');
+});
+
+tap.test('expect a absolute path for an home relative URL', async () => {
+  console.log(smartpath.get.home('~/test'));
+});
+tap.test('expect return the home directory path when no argument is specified', async () => {
+  console.log(smartpath.get.home());
+});
+
+tap.start();

ts/compile/compile.sh

@@ -1,2 +0,0 @@
-nvm use v0.12.7
-gulp

ts/compile/gulpfile.js

@@ -1,16 +0,0 @@
-// import gulp
-var gulp = require("gulp"),
-	gulpTypescript = require("gulp-typescript");
-
-gulp.task('compileTS', function() {
-	var stream = gulp.src('../index.ts')
-	  .pipe(gulpTypescript({
-	  	out: "index.js"
-	  }))
-	  .pipe(gulp.dest("../../"));
-	return stream;
-});
-
-gulp.task('default',['compileTS'], function() {
-	console.log('Typescript compiled');
-});

ts/compile/readme.md

@@ -1,2 +0,0 @@
-# How to compile.
-Make sure gulp and gulp-taypescript from npm are available. Then run the gulpfile in this directory.

ts/index.ts

@@ -1,22 +1,8 @@
-/// <reference path="typings/tsd.d.ts" />
+// import modules
+import * as check from './smartpath.check';
+import * as get from './smartpath.get';
+import * as transform from './smartpath.transform';
 
-var path = require("path");
-var bl = require("beautylog");
+export { check, get, transform };
 
-/**
- *
- * @type {{getPath: (function(any): undefined)}}
- */
-var smartpath:any = {
-    getAbsPath: function(varPath,logBool = false) {
-        var absPath = path.resolve(varPath);
-        if (logBool == true) {
-            bl.log('varPath is' + varPath);
-            bl.log('absPath is' + absPath);
-        }
-        return absPath;
-    }
-};
-
-
-module.exports = smartpath;
+export * from './smartpath.classes.smartpath';

ts/smartpath.check.ts

@@ -0,0 +1,9 @@
+import plugins = require('./smartpath.plugins');
+
+export let isDir = function(pathArg: string) {
+  return !isFile(pathArg);
+};
+
+export let isFile = function(pathArg) {
+  return /\.[a-zA-Z]*$/.test(pathArg); // checks if there is a .anything at the end
+};

ts/smartpath.classes.smartpath.ts

@@ -0,0 +1,15 @@
+import * as plugins from './smartpath.plugins';
+import * as getMod from './smartpath.get';
+
+export class Smartpath {
+  originalPath: string;
+  type: getMod.TPathType;
+  pathLevels: string[];
+  pathLevelsBackwards: string[];
+  constructor(pathArg: string) {
+    this.originalPath = pathArg;
+    this.type = getMod.type(this.originalPath);
+    this.pathLevels = getMod.pathLevels(this.originalPath);
+    this.pathLevelsBackwards = getMod.pathLevelsBackwards(this.originalPath);
+  }
+}

ts/smartpath.get.ts

@@ -0,0 +1,36 @@
+import plugins = require('./smartpath.plugins');
+export type TPathType = 'url' | 'local';
+
+/**
+ * returns the type of the given path. Can be "url" or "local"
+ */
+export let type = function(pathStringArg: string): TPathType {
+  let urlRegex = /http[s|\s]:\/\/.*/i;
+  if (urlRegex.exec(pathStringArg)) {
+    return 'url';
+  } else {
+    return 'local';
+  }
+};
+
+export let home = function(pathArgument?: string) {
+  if (pathArgument) {
+    return pathArgument.replace('~', plugins.os.homedir());
+  } else {
+    return plugins.os.homedir();
+  }
+};
+
+export type TSystemArg = 'dynamic' | 'windows' | 'linux' | 'osx';
+
+export let pathLevels = (pathArg: string, systemArg: TSystemArg = 'dynamic') => {
+  let pathLevelArray: string[];
+  if (systemArg === 'dynamic') {
+    pathLevelArray = pathArg.split(plugins.path.sep);
+  }
+  return pathLevelArray;
+};
+
+export let pathLevelsBackwards = (pathArg: string, systemArg?: TSystemArg) => {
+  return pathLevels(pathArg, systemArg).reverse();
+};

ts/smartpath.plugins.ts

@@ -0,0 +1,4 @@
+import * as os from 'os';
+import * as path from 'path';
+
+export { os, path };

ts/smartpath.transform.ts

@@ -0,0 +1,41 @@
+import plugins = require('./smartpath.plugins');
+
+/* ------------------------------------------ *
+ * ------------ helpers --------------------- *
+ * ------------------------------------------ */
+
+// checks a file
+let makeAbsolute = function(localPathArg: string, baseArg?: string): string {
+  let absolutePath: string;
+  let alreadyAbsolute = plugins.path.isAbsolute(localPathArg);
+  if (baseArg && !alreadyAbsolute) {
+    absolutePath = plugins.path.join(baseArg, localPathArg);
+  } else if (!alreadyAbsolute) {
+    absolutePath = plugins.path.resolve(localPathArg);
+  } else {
+    absolutePath = localPathArg;
+  }
+  return absolutePath;
+};
+
+/* ------------------------------------------ *
+ * ------- export functions ----------------- *
+ * ------------------------------------------ */
+export let toAbsolute = function(relativeArg: string | string[], baseArg?: string): any {
+  if (typeof relativeArg === 'string') {
+    return makeAbsolute(relativeArg, baseArg);
+  } else if (Array.isArray(relativeArg)) {
+    let relativeArray = relativeArg;
+    let absoluteArray: string[] = [];
+    for (let key in relativeArray) {
+      absoluteArray.push(makeAbsolute(relativeArray[key], baseArg));
+    }
+    return absoluteArray;
+  } else {
+    console.error(
+      'smartpath.absolute() could not make sense of the input. ' +
+        'Input is neither String nor Array'
+    );
+    return false;
+  }
+};

ts/tsd.json

@@ -1,12 +0,0 @@
-{
-  "version": "v4",
-  "repo": "borisyankov/DefinitelyTyped",
-  "ref": "master",
-  "path": "typings",
-  "bundle": "typings/tsd.d.ts",
-  "installed": {
-    "node/node.d.ts": {
-      "commit": "efa0c1196d7280640e624ac1e7fa604502e7bd63"
-    }
-  }
-}

ts/typings/tsd.d.ts

@@ -1 +0,0 @@
-/// <reference path="node/node.d.ts" />

tslint.json

@@ -0,0 +1,17 @@
+{
+  "extends": ["tslint:latest", "tslint-config-prettier"],
+  "rules": {
+    "semicolon": [true, "always"],
+    "no-console": false,
+    "ordered-imports": false,
+    "object-literal-sort-keys": false,
+    "member-ordering": {
+      "options":{
+        "order": [
+          "static-method"
+        ]
+      }
+    }
+  },
+  "defaultSeverity": "warning"
+}