Merge pull request #196 from aktos-io/dev

Dev

Author: ceremcem

.npmrc

@@ -1,26 +1,33 @@
-VENV_NAME := scadajs1
+DIR:=$(strip $(shell dirname $(realpath $(lastword $(MAKEFILE_LIST)))))
+
 APP := main
-CONFIG := ../dcs-modules.txt
+CONFIG := $(DIR)../dcs-modules.txt
 
-.PHONY: test update-deps update-app-version
+.PHONY: test-es6-compat update-deps update-app-version
 
 # Check if we are in a VIRTUAL_ENV:
+# the `NODE_VIRTUAL_ENV` variable is set by nodeenv after activating the environment.
 __c:
 	$(if $(NODE_VIRTUAL_ENV),,$($(warning ************  WARNING: NOT INSIDE A VIRTUAL ENV  ************)))
 
 __app: # Check if APP name is set
 	$(if $(APP),,$($(error *** APP variable is not set. ***)))
 
-test: __c
-	es-check es5 './release/$(APP)/**/*.js'
+test-es6-compat: __c
+	es-check es6 './release/$(APP)/**/*.js'
 
 update-deps: __c
 	npm run interactive-update
 
 update-app-version:
 	touch lib/app-version.json
 
-release: __c __prepare_release_dir __production __release_commit
+# Skip es-check with "make release ES_CHECK=skip
+ifeq ($(ES_CHECK),skip)
+release: __c __prepare_release_dir __production  __release_commit
+else
+release: __c __prepare_release_dir __production test-es6-compat __release_commit
+endif
 
 __production: __app
 	gulp --webapp $(APP) --production
@@ -51,13 +58,25 @@ freeze-venv: __c
 	freeze ./requirements.txt
 
 create-venv:
-	$(if $(SCADAJS_1_ENV),$(error SCADAJS_1_ENV variable is set, use it instead: $(SCADAJS_1_ENV)))
+ifndef SCADAJS_VENV_PATH
+	$(error SCADAJS_VENV_PATH can not be empty. Please provide an installation path to create a venv.)
+endif
+ifneq ($(wildcard $(SCADAJS_VENV_PATH)/.*),)
+	$(error SCADAJS_VENV_PATH is already created, use that instead: $(SCADAJS_VENV_PATH)))
+endif
+	$(eval VENV_NAME := $(shell basename $(SCADAJS_VENV_PATH)))
 	$(eval NODE_VERSION := $(shell echo `grep "^#node@" nodeenv.txt | cut -d@ -f2` | sed 's/^$$/system/'))
-	nodeenv --requirement=./nodeenv.txt --node=$(NODE_VERSION) --prompt="($(VENV_NAME))" --jobs=4 nodeenv
+	nodeenv --requirement=./nodeenv.txt --node=$(NODE_VERSION) --prompt="($(VENV_NAME))" --jobs=4 $(SCADAJS_VENV_PATH)
 
 use-venv:
 	./venv
 
+update-venv:
+	@echo "Virtual environment should not be updated. Create a new virtual environment"
+	@echo "with the new dependency versions and use that venv instead. If there is no "
+	@echo "breaking changes, simply backup the old venv and replace the new venv with "
+	@echo "the old one. This is the safest path to follow."
+
 __prepare_release_dir:
 	@( if [ ! -d release/$(APP) ]; then \
 		 	mkdir -p release; \

Makefile

@@ -0,0 +1,9 @@
+Ractive.components['accordion'] = Ractive.extend do
+    template: '<div class="ui accordion {{class}}">{{yield}}</div>'
+    onrender: -> 
+        element = $ '.ui.accordion' 
+        element.accordion!
+        @set 'element', element
+
+    data: -> 
+        element: null

components/accordion/index.ls

@@ -24,7 +24,7 @@ on:
         my-param = btn.get 'my-param'
         err, res <~ btn.actor.send-request "@foo.bar", {my: my-param}
         if err 
-            btn.state \error 
+            btn.error err 
         else 
             btn.state \done
 ```
@@ -62,3 +62,7 @@ if err => btn?error "Some error message"
 btn?state \done...
 @logger.clog "changes done..."
 ```
+
+### Timeout
+
+Use `timeout=` attribute to set timeout. Unit is `ms`.

components/ack-button/README.md

@@ -27,7 +27,7 @@ Ractive.components['ack-button'] = Ractive.extend do
 
         set-button = (mode, message) ~>
             @set \state, mode
-            message = if message then " |!| #{message}" else ''
+            message = if message then " (!) #{message}" else ''
             @set \tooltip, "#{orig-tooltip}#{message}"
             unless mode is \doing
                 @doing-watchdog.go!
@@ -61,18 +61,18 @@ Ractive.components['ack-button'] = Ractive.extend do
 
         @state = (state) ~>
             switch state
-                when \done =>
+                | \done =>
                     set-button \done
 
-                when \done... =>
+                | \done... =>
                     set-button \done
                     <~ sleep 3000ms
                     set-button \normal
 
-                when \normal =>
+                | \normal =>
                     set-button \normal
 
-                when \doing =>
+                | \doing =>
                     set-button \doing
                     @set \selfDisabled, yes
                     timeout <~ @doing-watchdog.wait @button-timeout
@@ -82,9 +82,12 @@ Ractive.components['ack-button'] = Ractive.extend do
                         #logger.error msg
                         set-button \error, msg
 
+                |_ => logger.error "Undefined ack-button state: #{state}"
+
         @error = (msg, callback) ~>
-            logger.error msg, callback
-            set-button \error, (msg.message or msg)
+            err = msg?.message or msg 
+            logger.error err, callback
+            set-button \error, err
 
         @warn = (msg, callback) ~>
             try
@@ -112,6 +115,9 @@ Ractive.components['ack-button'] = Ractive.extend do
             <~ sleep 200ms
             @set \heartbeat, no
 
+        @send-request = (opts={}, msg, callback) ~> 
+            @actor.send-request (opts <<< {timeout: @button-timeout}), msg, callback
+
         if @get \auto
             logger.clog "auto firing ack-button!"
             @fire \_click

components/ack-button/index.ls

@@ -11,6 +11,8 @@ Ractive.defaults.able = (permission) ->
         null
     permission `topic-match` permissions
 
+Ractive.defaults.isAble = Ractive.defaults.able
+
 Ractive.defaults.hasRoute = (route) ->
     routes = try
         @get \@global.session.routes
@@ -21,6 +23,8 @@ Ractive.defaults.hasRoute = (route) ->
 Ractive.defaults.unable = (...args) ->
     not Ractive.defaults.able.apply this, args
 
+Ractive.defaults.isUnable = Ractive.defaults.unable
+
 Ractive.defaults.loggedIn = ->
     if not @get('@global.session.token') or @get('@global.session.user') is \public
         return no

components/aktos-dcs/index.ls

@@ -0,0 +1,52 @@
+items = 
+  * id: ...
+    name: ...
+    checked: true/false 
+  ... 
+  
+  
+Example usage: 
+
+    Example Data: 
+    
+        items:
+            * id: 1
+              name: "rengine baktın mı "
+              checked: yes
+            * id: 2
+              name: "kokusu uygun mu "
+            * id: 3
+              name: "ambalajı açılmış mı?"
+            * id: 4
+              name: "seri numarası var mı "
+            * id: 5
+              name: "hoşuna gitti mi"    
+
+    JADE: 
+
+        checklist-button(
+            items="{{ xitems }}" 
+            on-success="checklistSucceeded" 
+            on-fail="checklistFailed" 
+            value="{{ xitems[0] }}"
+            success-text="Mal Kabul Tamam"
+            fail-text="Mal Kabul Reddedildi"
+            )
+        
+    LS: 
+    
+    
+        checklist-succeeded: (e, value) ->
+            e.component.fire \state, \doing
+            console.log "checklist succeeded: ", value
+            <- sleep 2000ms
+            e.component.fire \state, \done...
+
+        checklist-failed: (e, value) ->
+            e.component.fire \state, \doing
+            console.log "checklist failed: ", value 
+            <- sleep 2000ms
+            e.component.fire \state, \done...
+
+
+  

components/assign-if-null/index.ls

@@ -1,58 +1,3 @@
-//- 
-    items = 
-      * id: ...
-        name: ...
-        checked: true/false 
-      ... 
-      
-      
-    Example usage: 
-    
-        Example Data: 
-        
-            xitems:
-                * id: 1
-                  name: "rengine baktın mı "
-                  checked: yes
-                * id: 2
-                  name: "kokusu uygun mu "
-                * id: 3
-                  name: "ambalajı açılmış mı?"
-                * id: 4
-                  name: "seri numarası var mı "
-                * id: 5
-                  name: "hoşuna gitti mi"    
-    
-        JADE: 
-
-            checklist-button(
-                items="{{ xitems }}" 
-                on-success="checklistSucceeded" 
-                on-fail="checklistFailed" 
-                value="{{ xitems[0] }}"
-                success-text="Mal Kabul Tamam"
-                fail-text="Mal Kabul Reddedildi"
-                )
-            
-        LS: 
-        
-        
-            checklist-succeeded: (e, value) ->
-                e.component.fire \state, \doing
-                console.log "checklist succeeded: ", value
-                <- sleep 2000ms
-                e.component.fire \state, \done...
-
-            checklist-failed: (e, value) ->
-                e.component.fire \state, \doing
-                console.log "checklist failed: ", value 
-                <- sleep 2000ms
-                e.component.fire \state, \done...
-
-
-      
-
-      
 checklist(items="{{ items }}" completed="{{ completed }}")
 ack-button(
     on-click="success" 

components/checklist-button/README.md

@@ -4,23 +4,30 @@ See https://aktos.io/st/#/showcase/data-table
 
 # Properties
 
-- Marks last clicked row
-- Display a message while opening a row
+- Provides `on-init = (cb) -> cb!` function for initialization.
+- Executes a function while opening a row (`on-create-view = (row, cb) -> return cb(err, curr)` or `(row) ->> return curr`. `row` is the relevant element of `tableview` array.)
 - Displays error or info messages
 - Opens appropriate row if url matches with document id
 - Scrolls to clicked row (or opening row by url)
+- Memorizes last clicked row (`isLastClicked(.id)`)
 - Disables other rows in order to prevent accidental openings while a row is opened
 - Displays a warning if a filter is selected other than `all`
 
-# Names
+# Variables
 
-tableview : whole array that has the minimum data to create table view
+`tableview` : Whole array that has the minimum data to create table view
 
-tableview_visible: only the items for the current (selected) page of `tableview`
+`tableview_visible`: only the items for the current (selected) page of `tableview`
 
-curr: current document that is selected or being created
+`curr`: current document that is selected or being created
 
-readonly: if data-table has no `editForm` partial or set `readonly` explicitly, then it is readonly
+`readonly`: if data-table has no `editForm` partial or set `readonly` explicitly, then it is readonly
+
+`print_mode`: (Bool) Indicates that current view form is in print mode.
+
+`tmp`: (Object) A temporary variable that resets on every view-form creation.
+
+`this.actor`: Data-table's actor.
 
 # Partials (sections)
 
@@ -35,16 +42,24 @@ editForm: The section that appears when something "Edit" button is pressed
 
 `data-table` won't display any new entries unless it's successfully written to the database.
 
-`curr` document will be fetched from database everytime
+`curr` document must be manually assigned within `on-create-view` handler.
+
+if `auto-refresh` is not set to `yes`, a `Click to update` button will popup when table data is modified outside current window.
 
-if `auto-refresh` is not set to `yes`, a `Click to update` button will popup when table data is
-modified outside current window.
+Fields declared in `search-field` must be maximum of 2 levels deep (`value.foo_bar` is okay but `value.foo.bar` is not okay).
 
 # Mark last clicked row 
 
 Use `isLastClicked(rowId)`: 
 
-
     .ui.basic.label(
         on-click="openRow" 
         class="{{#if isLastClicked(.id)}}orange{{/if}}") {{.id}}
+
+# Full screen 
+
+Any opened row may be displayed as full screen for printing purposes. To make a row go full screen, 
+
+1. Design your edit/view form with `{{print_mode}}` (`true`/`false`) variable to hide elements in print mode. 
+2. Use `fire('make_row_full_screen')` and `fire('make_row_normal')` events to go to and return from full page.
+3. `@global.fullScreen` variable is set to true while in full page. Use this variable to hide the main menu.