@rabbitio/ui-kit 1.0.0-beta.1 → 1.0.0-beta.100

package/.gitlab-ci.yml

@@ -0,0 +1,29 @@
+stages:
+  - build
+  - test
+#  - release
+
+test:
+  stage: test
+  image: node:iron
+  cache:
+    key: "$CI_COMMIT_REF_SLUG"
+    paths:
+    - node_modules/
+  variables:
+    GIT_STRATEGY: fetch
+  script:
+    - npm install --force --no-fund # --no-optional
+    - npm run test
+
+build:
+  stage: build
+  image: node:iron
+  cache:
+    key: "$CI_COMMIT_REF_SLUG"
+    paths:
+    - node_modules/
+  script:
+    - HUSKY=true npm install --force --no-fund
+    # use "- unset CI" if needed to ignore warnings - dirty workaround due to React's way to fail builds having warnings
+    - npm run build

package/.husky/commit-msg

@@ -0,0 +1,19 @@
+#!/bin/sh
+# Hook script to ensure commit messages end with 'task_id=[a-zA-Z0-9]+'
+
+# Check if the commit message starts with "Merge"
+if grep -qE '^Merge branch' "$1"; then
+    exit 0
+fi
+
+# Check if the commit message starts with "Merge"
+if grep -qE '^Merge remote-tracking branch' "$1"; then
+    exit 0
+fi
+
+# Fail regular commits without task_id in the end
+COMMIT_REGEXP='task_id=[,a-zA-Z0-9]+$'
+if ! grep -qE "$COMMIT_REGEXP" "$1"; then
+    echo "ERROR: Commit message doesn't end with task_id"
+    exit 1
+fi

package/.husky/pre-push

@@ -0,0 +1 @@
+npm run test && npm run build && git diff --quiet || (echo 'Uncommitted changes detected. Please commit or stash them. If you have no uncommitted changes this error is caused by running npm run build - you forget to do this. Please add build result to commit and retry.' && exit 1)

package/README.md

@@ -1,46 +1,62 @@
 # Installation
-~~~
+~~~bash
 npm install --save @rabbitio/ui-kit
 ~~~
 
 # Using library
-1. To use components for web import the following way:
-~~~
-import { Button } from "@rabbitio/ui-kit/web";
-~~~
-2. To use components for node import the following way:
+1. To use components or base modules for web:
+* import the following way
+~~~javascript
+import { Button, AmountUtils } from "@rabbitio/ui-kit";
 ~~~
-import { Button } from "@rabbitio/ui-kit/node";
+* add top-level styles import
+~~~javascript
+import "@rabbitio/ui-kit/index.css";
 ~~~
-3. To use components for next.js import the following way and add "@rabbitio/ui-kit" to transpilePackages inside your next.config.js:
-~~~
-import { Button } from "@rabbitio/ui-kit";
+2. To use components or base modules for next.js import the following way and add "@rabbitio/ui-kit" to transpilePackages inside your next.config.js:
+
+~~~javascript
+import { Button } from "@rabbitio/ui-kit/next";
+import { AmountUtils } from "@rabbitio/ui-kit";
 ~~~
-4. [In progress] Also, you can import base styles into your scss index file: 
+* add "@rabbitio/ui-kit" to transpilePackages in next.config.js
+~~~javascript
+transpilePackages: ["@rabbitio/ui-kit"],
 ~~~
-@import "@rabbitio/ui-kit/styles/index";
+* Import styles inside pages/_app.js
+~~~javascript
+import "@rabbitio/ui-kit/index.css";
 ~~~
 
 # Adding new component
-1. Add a directory for component under the semantically corresponding subdirectory inside **./stories**
-2. Under the component directory implement 3 files: **<Component>.js**, **<Component>.module.scss**, **<Component>.stories.js**
+1. Add a directory for component under the semantically corresponding subdirectory inside **./src/components** and add **<Component>.js**, **<Component>.module.scss** to this directory
+2. Under the **./stories** directory repeat the directories structure from **./src/components** and implement **<Component>.stories.js** there
 3. Add the implemented component import to barrel file **./stories/index.js**
-~~~
+~~~javascript
 export { default as <Component> } from "./path/to/<Component>";
 ~~~
 
 # Running storybook
-~~~
+~~~bash
 sudo docker build -t storybook-app .
 ~~~
-~~~
+~~~bash
 sudo docker run -d -p 6006:6006 storybook-app
 ~~~
 
 # Publishing
-1. Increase version number and commit
-2. Run:
-~~~
+1. Increase version number
+2. Run npm run build. Ensure that all the uncommitted changes are planned to be published as build command will build them all into the bundle.  
+3. Commit and push changes
+4. Run:
+~~~bash
 npm login
 npm publish --access public
 ~~~
+
+# Dev details
+1. The repository uses husky to assure
+   1. each commit message ends with task_id=<id>
+   2. there is no uncommitted changes when pushing (to avoid pushing not built changes)
+2. The repository follows git-flow branching model
+3. There is a basic CI/CD setup

package/coverage/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selecter that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);