Skip to content

Latest commit

 

History

History
312 lines (269 loc) · 10.1 KB

README.md

File metadata and controls

312 lines (269 loc) · 10.1 KB
Raw

This project is outdated, look at this one!

rapydml_cmp

Vue-components generator

Installation

  1. Install RapydScript

    • Note: if there are any problems with RapydScript you can just download & unpack it to anywhere

  2. Install RapydML

  3. Replace RapydML/rapydml/compiler.py with one from this repo

  4. Put rapydml_cmp.py, ml_cmp.conf in the root of RapydML

  5. Adjust the paths to node and rapydscript by editig ml_cmp.conf

  6. Append to the end of RapydML/rapydml/markup/html this line: <*>+ * - it is rough solution that allows to use invalid html-tags like in v_hello( :items = 'items'): in RapydML templates. The strict way looks like <v_hello>+ * - see RapydML for more info.

Compilation

Just run python /path/to/rapydml_cmp.py <cmp_file> it should produce 3 files (in the <cmp_file> directory):

  • <cmp_file>_test.html
  • <cmp_file>.pyj
  • <cmp_file>.js

Getting Started

Here is an example of a simple Vue component RapydScript/RapydML source code v_hello

RS = code_block( script(type = 'text/javascript'), 'rapydscript')
#---------------------  demo-test.html ---------------   
html:
    head:
        meta(charset='utf-8'):
        script(src='vue.js'):
        script(src='v_hello.js'):
        title:
            "demo-test v_hello.js"
    body:
        div(id = 'container'):
            v_hello( :items = 'items'):

    #--------------- demo bootstrap rapydscript block -------------------
    RS:
        v_opt = {
            el : '#container', 
            data : {
                items : [ {id : 1, value : 'one'}, {id : 2, value : 'two'},  {id : 3, value : 'three'} ]
            },
            components : {'v_hello': my_vcs.v_hello()},
        }
        window.v = new Vue(v_opt)
#-------------------------  < TEMPLATES > ----------------------
script( type = 'text/vuetemplate', id = "v_hello_tmpl" ):
    div():
        h4:
            '${ header_d }'
        div(v-for = 'it in items' , :id =  'it.id'):
            '${ it.value }'
        div():
            'Count = ${items_count}'
            
#----------------------  < RS_SCRIPT > -------------------------
def v_hello():
    vc = {}
    vc.template = @TMPL(v_hello_tmpl)
    vc.delimiters = ['${','}']
    vc.props =  {
            items : Array,
            header : String
    }
    vc.data = def(): return { header_d :  this.header or 'v_hello component'};

    vc.computed = {}
    vc.computed.items_count = def(): return len(this.items);
    return vc    
    
def main():
    # we need to assign our component function to some global object, since RapydScript wraps all code in a function
    if not window.my_vcs:
        window.my_vcs = {}
    window.my_vcs.v_hello = v_hello
    # or it may be just 
    # Vue.component('v_hello', v_hello())  # it will be Vue-global component
if __name__=='__main__':
    main()

The code consits of three sections:

  1. From the begining to #---< TEMPLATES >---
  2. Between #---< TEMPLATES >--- and #---< RS_SCRIPT >---
  3. From#---< RS_SCRIPT >--- to the end

The First section will be converted to a regular html-file like v_hello_test.html by RapydML - thus, we will have demo-test of the component.

The Second section will be:

  • splited to templates by script( type= 'text/vuetemplate', id = 'awesome_id')
  • converted to a html-string or several ones corresponding to splitting result
  • used to replace the pseudocode like @TMPL(awesome_id) in the Last section.

The Last section will be:

  • searched for @TMPL(awesome_id) that will be replaced with corresponding html-string
  • saved as v_hello.pyj - regular rapydscript file with embedded template that could be imported in another file.pyj or vue-component file like this one!
  • finally v_hello.pyj will be compiled to v_hello.js by RapydScript

Known issues

RapydML

  • Indentation is very strict

The indent increment should be the same almost everywhere, so this doesn't work:

html:
   head:
            body:    # wrong indent!

You can relax inside non-html blocks (like rapydscript or javascript), but don't cross the indentation boundary

  • Multi-Line tag definition should be glued by \ despite it is inside parentheses. The following is allowed:
...
   div( id= ...,  \
@click  = ...):  # will be glued, so the indent doesn't matter
  • $ has special meaning

RapydML accepts $ as token of variable (see RapydML doc), use \ to escape it.

   div( @click = 'on_click( \$event, some)'):  # $event - Vue variable, not RapydML, so it should be escaped
   RS:
      def():
         $a = 12  # don't worry - it's inside code block

RapydScript

Keep in mind that RapydScript is still JS, not Python. You should study JS-fundamentals and RS-documentation in details. There is only a pair of tens issues at the moment (and only some of them are real bugs), so you can explore them yourself.

Python style

One of the most impressive features of RapydScript is the classes, why not use them to define the Vue component?
Let's have a look at:

...
    #--------------- demo bootstrap rapydscript block -------------------
    RS:
...
            components : {'v_hello': my_vcs.v_hello.make()},
...
#----------------------  < RS_SCRIPT > -------------------------

class V_hello:
    def __init__(self):
        self.template = @TMPL(v_hello_tmpl)
        self.delimiters = ['${','}']
        self.props =  {
            items : Array,
            header : String
        }
        self.data = self._init_data
        computed = self.computed = {}
        computed.items_count = self.items_count
    
    def _init_data(self):
        return { header_d : self.header or 'v_hello component'}

    def items_count(self):
        return len(self.items)

    # if you're true ghostbuster then omit this method   
    @staticmethod
    def make():
        return V_hello()

def main():
    if not window.my_vcs:
        window.my_vcs = {}
    window.my_vcs.v_hello = V_hello 
    # Now, we can feed Vue with one of the equivalent variants:
    # - my_vcs.v_hello.make() 
    # - new my_vcs.v_hello()

if __name__=='__main__':
    main()

This is more familiar for pythonic eyes, but not quite DRY, because we have to do the stuff like:

computed = self.computed = {}
computed.items_count = self.items_count

Let @decorators do it!:

...
#----------------------  < RS_SCRIPT > -------------------------
from rs_vue import v_computed, RS_vue

class V_hello(RS_vue):
    def __init__(self):
        # !!! ES6 issue:  in fact, `self` (i.e. `this`) doesn't exist yet !!! 
        # reference `this` is allowed only after `super()` - i.e. `Base_class.__init__()` - call:  
        RS_vue.__init__(self) 
        self.template = @TMPL(v_hello_tmpl)
        self.delimiters = ['${','}']
        self.props =  {
            items : Array,
            header : String
        }
    
    def _init_data(self):
        return { header_d : self.header or 'v_hello component'}

    @v_computed
    def items_count(self):
        return len(self.items)
...

Much better, isn't it?

How it works

Decorator (like @v_computed) marks the function by key:value, that is equal to the assignment:

items_count['_vue_computed']  = 'items_count'

RS_vue.__init__() collects marked functions into methods, computed and other vue-component hashes (see rs_vue.pyj), i.e. does the tedious job like:

self.computed = {}
self.computed[ self.items_count['_vue_computed'] ] = self.items_count

The decorators can accept an alias name:

@v_computed('foo') 
def bar(self):
   ...

which is the same as:

bar['_vue_computed']  = 'foo'

thus, the bar will be registered as foo and in the vue-component context only foo will exist (which is bar in fact)
Here is an example of the grid-component that was converted from original one

#----------------------  < RS_SCRIPT > -------------------------
from rs_vue import v_filter, v_meth, v_computed, v_watch, RS_vue

class Grid(RS_vue):
    def __init__(self):
        RS_vue.__init__(self)
        self.delimiters = ['${','}']
        self.template = @TMPL(grid_template)
        self.props =  {
            data: Array,
            columns: Array,
            filterKey: String
        }
    
    def _init_data(self):
        sortOrders = {col_name : 1 for col_name in self.columns}
        return {  sortKey: '',
                  sortOrders: sortOrders
        }
    
    @v_computed
    def filteredData(self):
        sortKey = self.sortKey
        filterKey = self.filterKey and self.filterKey.toLowerCase()
        order = self.sortOrders[sortKey] or 1
        data = self.data
        if filterKey:
            ...
        if sortKey:
            ...
        return data

    @v_filter    
    def capitalize(self, str):
        return str[0].toUpperCase() + str[1:]
    
    @v_meth
    def sortBy(self, key):
        self.sortKey = key
        self.sortOrders[key] = self.sortOrders[key] * -1
    
    @v_watch
    def $w_filteredData(self, v, v_was):
        print('watcher: filteredData changed')
    
    @staticmethod
    def make():
        return Grid()

def  main():
    if not window.my_vcs:
        window.my_vcs = {}
    window.my_vcs.grid = Grid

if __name__ = '__main__':
    main()

Note that 'watcher' (that watches for 'computed') has a special prefix $w_ to prevent names conflict, since they are both methods (of the class). The alias may be applied instead of this trick:

    @v_watch('filteredData')
    def whatever(self, v, v_was):
        ...

to be continued ...