tzispa_rig 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aef6c491f3383fc7cbd791222d9a35f5ba1503ed
-  data.tar.gz: 75e0bc0bbf5d889882d886645c283027c6180575
+  metadata.gz: 484c207b444e399e36b3b280ec31d19bde762aaf
+  data.tar.gz: d72e7fc08e477694bde0eb6d38ca6c415796fb8c
 SHA512:
-  metadata.gz: 071b901ee6482b8609a743688dc4fd9a1c996d124522c75e91ee2109f5a95887a1e5fab41ec6eccfb7541238d018ff6e48afc66658859cc5e739baf605432794
-  data.tar.gz: 87e18aaae6a446409b51dfcd3943845819786457696742277cc6ffac45c042d58a116f236c3b7a463f9f9f59d24a49633807ae414536ebb185fa7066d8f64963
+  metadata.gz: a3d55a81e78788feb9c3eedd9a287ca467ec45024c244049a2e5d0553e47de5c9a6cd50a41ebc6cbbd991075d48256ee943e24e7e0764e45c76cbbe3fe91cd17
+  data.tar.gz: f132ca420011439890b476f274bf145a6331da7b10a4ac63f89128dfe68132e2c7074195c3a9bdbf2e3a2cbca722275475205615175bcdc99e6fc920fd173115

data/CHANGELOG.md

@@ -2,6 +2,9 @@ Tzispa Rig
 
 Rig templates implementation
 
+## v0.2.6
+- Add basic documentation
+
 ## v0.2.5
 - Add template methods for use in cli
 

data/README.md

@@ -1,3 +1,183 @@
-Txispa Rig
+# Tzispa Rig
 
-General purpose template engine
+A general purpose template engine
+
+## Rig template types
+
+There are 3 template types: layout, static and block:
+
+* layout: these are the skeleton entry points of the rig templates
+* static: these are "light" templates that are a included without any processing as plain text
+* block: the true core of the rig templates, each block template file has an associated ruby file with the template binder class
+
+To add templates to your app you can use cli coomands
+
+```shell
+% tzispa generate rig lister --type=layout --app=mainapp
+% tzispa generate rig sitefoot --type=static --app=mainapp
+% tzispa generate rig product_detail --type=block --app=mainapp
+```
+
+## Rig template language
+
+### Variables and metavariables
+
+Template variables are specified with:
+```
+<var:name/>
+```
+
+And metavariables with:
+```
+{%name%}
+```
+metavariables are used to make runtime template tags replacements
+
+```html
+<fieldset>
+  <div class='row'>
+    <div class='column column-80'>
+      <label for='name'>Nombre *</label>
+      <input type='text' name='name' id='name' maxlength="64" value='<var:name/>' required='required' />
+    </div>
+    <div class='column column-20'>
+      <label for='skey'>Código</label>
+      <input type='text' name='skey' id='skey' maxlength="16" value='{%skey%}'/>
+    </div>
+  </div>
+....
+
+```
+
+and in the template binder
+
+```ruby
+def bind!
+  @idb = context.router_params[:id0]
+  load_brand if idb
+end
+
+private
+
+attr_reader :idb
+
+def load_brand
+  context.repository.use :ecomm_shop
+  brand = context.repository[:brand][idb]
+  data(
+    idb: brand.id,
+    name: brand.name,
+    skey: brand.skey,
+    long_name: brand.long_name,
+    web: brand.web,
+    manual_order: brand.manual_order,
+    notes: brand.notes
+  )
+end
+```
+
+### Conditionals
+
+You can make decisions in your templates using conditionals:
+
+```html
+<ife:customer_exist>
+  <div class='row'>
+    <div class='column column-80'>
+      <label for='name'>Nombre *</label>
+      <input type='text' name='name' id='name' maxlength="64" value='<var:name/>' required='required' />
+    </div>
+    <div class='column column-20'>
+      <label for='skey'>Código</label>
+      <input type='text' name='skey' id='skey' maxlength="16" value='{%skey%}'/>
+    </div>
+  </div>
+<else:customer_exist/>  
+  <p> There isn't any customer here </p>
+</ife:customer_exist>  
+```
+
+In the binder you must define customer_exist
+
+```ruby
+def bind!
+  idc = context.router_params[:id0]
+  context.repository.use :ecomm_shop
+  customer = context.repository[:customer][idb]
+  data.customer_exist = !customer.nil?
+end
+```
+
+## Repeating
+
+To repeat a part in the template
+
+```html
+<loop:lbrands>
+<tr>
+  <td><var:id/></td>
+  <td><var:skey/></td>
+  <td><var:name/></td>
+  <td class='text-right'>
+    <a href='<purl:site[layout=brand_edit,title=edit-brand,id0={%id%}]/>'><i class='fa fa-edit'></i></a>
+    <a href='javascript:delete_brand("<api:brand:delete:{%id%}/>")'><i class='fa fa-trash'></i></a>
+  </td>
+<tr>
+</loop:lbrands>
+```
+
+In the binder you must use the 'loop_binder' method
+
+```ruby
+
+def bind!
+  data.lbrands = loop_binder(:lbrands).bind!(&load_brands)
+end
+
+private
+
+def load_brands
+  Proc.new {
+    context.repository.use :ecomm_shop
+    context.repository[:brand].list.map { |b|
+      loop_item(
+        id: b.id,
+        skey: b.skey,
+        name: b.name
+      )
+    }
+  }
+end
+```
+
+## Building urls
+
+Rig templates can build urls for you. There are 2 url types:
+
+### purl
+
+Site urls: used to provide links to site pages
+
+```
+<purl:route_id/>
+<purl:route_id[param1=value,param2=value]/>
+```
+```html
+<purl:site[layout=brands,title=brand-list]/>
+<purl:index/>
+```
+The route_id's area defined in the start.ru file
+
+### api
+
+Api urls: used to provide urls to the application Api
+
+```
+<api:handler:verb/>
+<api:handler:verb:predicate/>
+```
+```html
+<api:customer:add:address/>
+
+<api:brand:{%verb%}/>
+```

data/lib/tzispa/rig/template.rb

@@ -104,10 +104,9 @@ module Tzispa
         "#{@domain.path}/rig/#{@type.to_s.downcase}#{'/'+@subdomain if @subdomain}"
       end
 
-      def create
+      def create(content='')
         FileUtils.mkdir_p(path) unless Dir.exist? path
-        puts "path = #{Dir.exist? path}"
-        super
+        super(content)
         create_binder
       end
 

data/lib/tzispa/rig/version.rb

@@ -3,7 +3,7 @@
 module Tzispa
   module Rig
 
-    VERSION = '0.2.5'
+    VERSION = '0.2.6'
     GEM_NAME = 'tzispa_rig'
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tzispa_rig
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Juan Antonio Piñero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2016-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzispa_helpers