tzispa_rig 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 484c207b444e399e36b3b280ec31d19bde762aaf
-  data.tar.gz: d72e7fc08e477694bde0eb6d38ca6c415796fb8c
+  metadata.gz: 1aa4a9522b55f88d715802bab683693ae3ac267a
+  data.tar.gz: f1c4923b96b5e45a5198c4274386062d03c9dace
 SHA512:
-  metadata.gz: a3d55a81e78788feb9c3eedd9a287ca467ec45024c244049a2e5d0553e47de5c9a6cd50a41ebc6cbbd991075d48256ee943e24e7e0764e45c76cbbe3fe91cd17
-  data.tar.gz: f132ca420011439890b476f274bf145a6331da7b10a4ac63f89128dfe68132e2c7074195c3a9bdbf2e3a2cbca722275475205615175bcdc99e6fc920fd173115
+  metadata.gz: 776cfe3e0b6655dc2f0133c65b10b0914e1d4f94397a83862f34aa4c7c64cba9548c752586a3cf9735142074c1186b5d1c3df60800782c2a3b3ec42633bd9695
+  data.tar.gz: 88e84342bf54817050b45a06fe4226d2179ca5fee0ee5062ee6bac73aecf96d5410e2b6c73c0f45344cbd73770a1f4bff9d491cc7cd5d0f89c4b27d5ae18e11a

data/CHANGELOG.md

@@ -2,6 +2,9 @@ Tzispa Rig
 
 Rig templates implementation
 
+## v0.2.7
+- Add url template tag to build canonical urls
+
 ## v0.2.6
 - Add basic documentation
 

data/README.md

@@ -2,6 +2,12 @@
 
 A general purpose template engine
 
+## Installation
+
+```shell
+% gem install tzispa
+```
+
 ## Rig template types
 
 There are 3 template types: layout, static and block:
@@ -31,8 +37,8 @@ And metavariables with:
 ```
 {%name%}
 ```
-metavariables are used to make runtime template tags replacements
 
+metavariables are used to make runtime template tags replacements
 ```html
 <fieldset>
   <div class='row'>
@@ -42,15 +48,13 @@ metavariables are used to make runtime template tags replacements
     </div>
     <div class='column column-20'>
       <label for='skey'>Código</label>
-      <input type='text' name='skey' id='skey' maxlength="16" value='{%skey%}'/>
+      <input type='text' name='skey' id='skey' maxlength="16" value='<var:skey/>'/>
     </div>
+    <a href='<purl:site[layout=brand_edit,title=edit-brand,id0={%idb%}]/>'><i class='fa fa-edit'></i></a>
   </div>
-....
-
 ```
 
-and in the template binder
-
+in the template binder
 ```ruby
 def bind!
   @idb = context.router_params[:id0]
@@ -67,18 +71,21 @@ def load_brand
   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
+    skey: brand.skey
   )
 end
 ```
 
 ### Conditionals
 
-You can make decisions in your templates using conditionals:
+You can make decisions in your templates using template ife tag:
+```
+<ife:test> ..... <else:test/> .... </ife:test>
+
+or without the else part
+
+<ife:test> .....  </ife:test>
+```
 
 ```html
 <ife:customer_exist>
@@ -98,19 +105,23 @@ You can make decisions in your templates using conditionals:
 ```
 
 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
+To repeat a part in the template use loop tag
+```
+<loop:ltag> ... </loop:ltag>
+```
 
 ```html
 <loop:lbrands>
@@ -127,7 +138,6 @@ To repeat a part in the template
 ```
 
 In the binder you must use the 'loop_binder' method
-
 ```ruby
 
 def bind!
@@ -150,7 +160,7 @@ def load_brands
 end
 ```
 
-## Building urls
+## Template URLs
 
 Rig templates can build urls for you. There are 2 url types:
 
@@ -162,6 +172,7 @@ 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/>
@@ -176,8 +187,56 @@ 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%}/>
 ```
+
+## Building templates
+
+You can include block and static rig templates using these tags:
+```
+<blk:name[param1=value,param2=value, ... ]/>
+
+<static:name/>
+```
+
+As you can see, template parameters can be passed in the block tag.
+These parameters will be available in the binder.
+You can also use template subdomains using dot notation in the name
+```html
+<!DOCTYPE html>
+<html lang="es">
+<head>
+  <meta charset="utf-8" />
+  <blk:metasense/>
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <static:comassert/>
+</head>
+<body>
+  <blk:header/>
+  <div class="container m-bot-35 m-top-25 clearfix">
+    <div class="row">
+       <div class="three columns m-bot-25">
+         <blk:sidebar/>
+       </div>
+       <div class="nine columns m-bot-25">
+       <blk:folder.edit[doc=dokum]/>
+       </div>
+    </div>
+  </div>
+  <static:footer/>
+  <static:footscripts/>
+</body>
+</html>
+```
+
+In the folder binder you can access template parameters
+```ruby
+def bind!
+  context.repository.use :quality_dok
+  @doctype = params[:doc]
+end
+```

data/lib/tzispa/rig/binder.rb

@@ -71,7 +71,7 @@ module Tzispa
       end
 
       def self.for(template, context)
-        if template.is_block?
+        if template.bindable?
           binder_class = template.binder_class
           binder_class.new( template, context ) if binder_class
         else

data/lib/tzispa/rig/parsernext.rb

@@ -2,6 +2,7 @@
 
 require 'forwardable'
 require 'tzispa/utils/string'
+require_relative 'syntax'
 
 
 module Tzispa
@@ -27,8 +28,10 @@ module Tzispa
           ParsedMeta.new parser, type, match[1]
         when :var
           ParsedVar.new parser, type, match[1], match[2]
-        when :purl
+        when :url
           ParsedUrl.new parser, type, match[1], match[3]
+        when :purl
+          ParsedPurl.new parser, type, match[1], match[3]
         when :api
           ParsedApi.new parser, type, match[1], match[2], match[3], match[4]
         when :loop
@@ -100,7 +103,7 @@ module Tzispa
     end
 
 
-    class ParsedUrl < ParsedEntity
+    class ParsedPurl < ParsedEntity
 
       def initialize(parser, type, path_id, params)
         super(parser, type)
@@ -118,6 +121,25 @@ module Tzispa
     end
 
 
+    class ParsedUrl < ParsedEntity
+
+      def initialize(parser, type, path_id, params)
+        super(parser, type)
+        @path_id = path_id.to_sym
+        @params = params
+      end
+
+      def render(binder)
+        b_params = @params.dup.gsub(RE_ANCHOR) { |match|
+          parser.the_parsed.select { |p| p.anchor == match}.first.render(binder)
+        } if @params
+        binder.context.canonical_url @path_id, Parameters.new(b_params).data
+      end
+
+    end
+
+
+
     class ParsedApi < ParsedEntity
 
       attr_reader :handler, :verb, :predicate
@@ -313,24 +335,7 @@ module Tzispa
 
       EMPTY_STRING = ''
 
-      RIG_EMPTY = {
-        :flags => /<flags:(\[(\w+=[^,\]]+(,\w+=[^,\]]+)*?)\])\/>/
-      }.freeze
-
-      RIG_EXPRESSIONS = {
-        :meta => /\{%([^%]+?)%\}/.freeze,
-        :var  => /<var(\[%[A-Z]?[0-9]*[a-z]\])?:(\w+)\/>/,
-        :purl => /<purl:(\w+(?:\.\w+)?)(\[(\w+=[^,\]]+(,\w+=[^,\]]+)*?)\])?\/>/,
-        :api  => /<api:([^:\.]+(?:\.[^:]+)?):([^:\/]+)(?::([^:\/]+))?(?::([^\/]+))?\/>/
-      }.freeze
-
-      RIG_STATEMENTS = /(<(loop):(\w+)>(.*?)<\/loop:\3>)|(<(ife):(\w+)>(.*?)(<else:\7\/>(.*?))?<\/ife:\7>)/m
-
-      RIG_TEMPLATES = {
-        :blk    => /<(blk):(\w+(?:\.\w+)?)(?:\[(\w+=[^,\]]+(?:,\w+=[^,\]]+)*)\])?\/>/,
-        :iblk   => /<(iblk):(\w+):(\w+(?:\.\w+)?)(?:\[(\w+=[^,\]]+(?:,\w+=[^,\]]+)*)\])?:(\w+(?:\.\w+)?)(?:\[(\w+=[^,\]]+(?:,\w+=[^,\]]+)*)\])?\/>/,
-        :static => /<(static):(\w+(?:\.\w+)?)(?:\[(\w+=[^,\]]+(?:,\w+=[^,\]]+)*)\])?\/>/
-      }.freeze
+      include Tzispa::Rig::Syntax
 
       attr_reader :flags, :template, :the_parsed
 
@@ -343,7 +348,7 @@ module Tzispa
       def parse!
         @tags = nil
         parse_flags
-        if @template.is_block?
+        if @template.bindable?
           parse_statements
           parse_expressions
         end
@@ -394,7 +399,6 @@ module Tzispa
 
       def parse_statements
         @inner_text.gsub!(RIG_STATEMENTS) { |match|
-          #puts Regexp.last_match.inspect
           type = (Regexp.last_match[2] || String.new) << (Regexp.last_match[6] || String.new)
           pe = ParsedEntity.instance(self, type.to_sym, Regexp.last_match )
           @the_parsed << pe.parse!

data/lib/tzispa/rig/syntax.rb

@@ -0,0 +1,27 @@
+module Tzispa
+  module Rig
+    module Syntax
+
+      RIG_EMPTY = {
+        :flags => /<flags:(\[(\w+=[^,\]]+(,\w+=[^,\]]+)*?)\])\/>/
+      }.freeze
+
+      RIG_EXPRESSIONS = {
+        :meta => /\{%([^%]+?)%\}/,
+        :var  => /<var(\[%[A-Z]?[0-9]*[a-z]\])?:(\w+)\/>/,
+        :purl => /<purl:(\w+(?:\.\w+)?)(\[(\w+=[^,\]]+(,\w+=[^,\]]+)*?)\])?\/>/,
+        :url  => /<url:(\w+(?:\.\w+)?)(\[(\w+=[^,\]]+(,\w+=[^,\]]+)*?)\])?\/>/,
+        :api  => /<api:([^:\.]+(?:\.[^:]+)?):([^:\/]+)(?::([^:\/]+))?(?::([^\/]+))?\/>/
+      }.freeze
+
+      RIG_STATEMENTS = /(<(loop):(\w+)>(.*?)<\/loop:\3>)|(<(ife):(\w+)>(.*?)(<else:\7\/>(.*?))?<\/ife:\7>)/m
+
+      RIG_TEMPLATES = {
+        :blk    => /<(blk):(\w+(?:\.\w+)?)(?:\[(\w+=[^,\]]+(?:,\w+=[^,\]]+)*)\])?\/>/,
+        :iblk   => /<(iblk):(\w+):(\w+(?:\.\w+)?)(?:\[(\w+=[^,\]]+(?:,\w+=[^,\]]+)*)\])?:(\w+(?:\.\w+)?)(?:\[(\w+=[^,\]]+(?:,\w+=[^,\]]+)*)\])?\/>/,
+        :static => /<(static):(\w+(?:\.\w+)?)(?:\[(\w+=[^,\]]+(?:,\w+=[^,\]]+)*)\])?\/>/
+      }.freeze
+
+    end
+  end
+end

data/lib/tzispa/rig/template.rb

@@ -3,6 +3,8 @@
 require 'forwardable'
 require 'fileutils'
 require 'tzispa/utils/string'
+require 'tzispa/utils/indenter'
+require 'tzispa/utils/cache'
 require 'tzispa/rig'
 
 module Tzispa
@@ -26,7 +28,7 @@ module Tzispa
       end
 
       def modified?
-        @modified != File.mtime(@file)
+        @modified != ::File.mtime(@file)
       end
 
       def exist?
@@ -110,18 +112,22 @@ module Tzispa
         create_binder
       end
 
-      def is_block?
+      def block?
         @type == :block
       end
 
-      def is_layout?
+      def layout?
         @type == :layout
       end
 
-      def is_static?
+      def static?
         @type == :static
       end
 
+      def bindable?
+        block? || layout?
+      end
+
       def params=(value)
         @params = Parameters.new(value)
       end
@@ -156,21 +162,27 @@ module Tzispa
 
       def create_binder
         ::File.open("#{domain.path}/#{binder_require}.rb", "w") { |f|
-          binder_code = TzString.new
-          f.puts binder_code.indenter("require 'tzispa/rig/binder'\n\n")
+          f.puts new_binder_code
+        } if @type == :block
+      end
+
+      def new_binder_code
+        Tzispa::Utils::Indenter.new(2).tap { |binder_code|
+          binder_code << "require 'tzispa/rig/binder'\n\n"
           level = 0
           binder_namespace.split('::').each { |ns|
-            f.puts binder_code.indenter("module #{ns}\n", level > 0 ? 2 : 0).to_s
+            binder_code.indent if level > 0
+            binder_code << "module #{ns}\n"
             level += 1
           }
-          f.puts binder_code.indenter("\nclass #{binder_class_name} < Tzispa::Rig::TemplateBinder\n\n", 2)
-          f.puts binder_code.indenter("def bind!", 2)
-          f.puts binder_code.indenter("end\n\n")
-          f.puts binder_code.unindenter("end", 2)
+          binder_code.indent << "\nclass #{binder_class_name} < Tzispa::Rig::TemplateBinder\n\n"
+          binder_code.indent << "def bind!\n"
+          binder_code << "end\n\n"
+          binder_code.unindent << "end\n"
           binder_namespace.split('::').each { |ns|
-            f.puts binder_code.unindenter("end\n", 2)
+            binder_code.unindent << "end\n"
           }
-        } if @type == :block
+        }.to_s
       end
 
     end
@@ -180,9 +192,9 @@ module Tzispa
 
       attr_reader :app
 
-      def initialize(app)
+      def initialize(app, cache_enabled, cache_size)
         @app = app
-        @pool= Hash.new
+        @cache = Tzispa::Utils::LRUCache.new(cache_size) if cache_enabled
         @mutex = Mutex.new
       end
 
@@ -199,14 +211,20 @@ module Tzispa
       end
 
       def rig_template(name, type, format, params, parent)
-        if @mutex.owned?
-          tpl = @pool["#{type}__#{name}"] || Template.new( name: name, type: type, format: format, domain: @app.domain, params: params, parent: parent, engine: self )
-          tpl.loaded? && !tpl.modified? ? tpl : tpl.load!.parse!
+        if @cache
+          ktpl = "#{type}__#{name}".to_sym
+          if @mutex.owned?
+            tpl = @cache[ktpl] || Template.new(name: name, type: type, format: format, domain: @app.domain, params: params, parent: parent, engine: self)
+            @cache[ktpl] = tpl.loaded? && !tpl.modified? ? tpl : tpl.load!.parse!
+          else
+            @mutex.synchronize {
+              tpl = @cache[ktpl] || Template.new(name: name, type: type, format: format, domain: @app.domain, params: params, parent: parent, engine: self)
+              @cache[ktpl] = tpl.loaded? && !tpl.modified? ? tpl : tpl.load!.parse!
+            }
+          end
         else
-          @mutex.synchronize {
-            tpl = @pool["#{type}__#{name}"] || Template.new( name: name, type: type, format: format, domain: @app.domain, params: params, parent: parent, engine: self )
-            tpl.loaded? && !tpl.modified? ? tpl : tpl.load!.parse!
-          }
+          tpl = Template.new(name: name, type: type, format: format, domain: @app.domain, params: params, parent: parent, engine: self)
+          tpl.load!.parse!
         end
       end
 

data/lib/tzispa/rig/version.rb

@@ -3,7 +3,7 @@
 module Tzispa
   module Rig
 
-    VERSION = '0.2.6'
+    VERSION = '0.2.7'
     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.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Juan Antonio Piñero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-27 00:00:00.000000000 Z
+date: 2016-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tzispa_helpers
@@ -52,6 +52,7 @@ files:
 - lib/tzispa/rig/parameters.rb
 - lib/tzispa/rig/parser.rb
 - lib/tzispa/rig/parsernext.rb
+- lib/tzispa/rig/syntax.rb
 - lib/tzispa/rig/template.rb
 - lib/tzispa/rig/version.rb
 - lib/tzispa_rig.rb