hotcell 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 449b5df474465cb7aface35f5e960b944d3efb03
-  data.tar.gz: b0628e14925479f151259181106c924b57cf625e
+  metadata.gz: 891615844b788d5a97cd05732e62ccfea7fa9677
+  data.tar.gz: ce382e5b004e762cbb7bfecae1993cb29a62f408
 SHA512:
-  metadata.gz: fdd6e11a933a6d2ccba2e4e9f3cc82c291042d8f3c543f750e626f08626514a2b120d0453e4a7e4dc572a5a8faccd1332d02a4da368d12694e00481b1ef7c8f7
-  data.tar.gz: 29101765a3ddc4dc679ff59bddece44e18edf6314103dcb715984907b1cd3e493c8c2a4a639072e274e03408769b5dbbad31f19db8657f36087f3cbb655ed59b
+  metadata.gz: a23dfdd6e27f2d288d4ef3f8eab2b193a0ca72a6d7214bf3e3bd497587a4c22073906e79abdce32727188f31db5f5d71aa76435bc53bddaa12845cec202240b4
+  data.tar.gz: a677eb7af6252857c6e0210101676c93702e6b33a65174234d01b7e571dbf2700261bd0f49f035da806ee73bf9ff9c48d19243195489c6bbeb7675ec94f61373

data/README.md

@@ -26,6 +26,90 @@ Or install it yourself as:
 
     $ gem install hotcell
 
+## Usage
+
+### Basic usage:
+
+```ruby
+Hotcell::Template.parse('Hello, {{ name }}!').render name: 'Hulk'
+```
+
+### Additional `render` options:
+
+* `:variables` - variables hash
+* `:environment` - environment variables hash
+* `:scope` - variables and environment variables together
+
+The main difference between environment and ordinary variables is: ordinary variables
+are accessible from the template and environment variables are not. Environment variables
+are user for official purposes, in tag, for example. At the options level, variables have
+string keys and environment variables have symbol keys.
+
+```ruby
+Hotcell::Template.parse('Hello, {{ name }}!').render(
+  variables: { name: 'Hulk' },
+  environments: { some_access_token: '1234567890' },
+  scope: { 'foo' => 42, bar: 43 },
+  moo: 'Hello'
+)
+```
+
+So if you will use something like above, all three options will be merged, but `:variables`
+hash keys will be stringified, `:environment` hash keys will be symbolized, `:scope`
+hash will be lived as is and the rest non-official options will be stringified and used as
+variables. The result of this algorithm will be:
+
+```ruby
+{
+  'name' => 'Hulk', 'foo' => 42, 'moo' => 'Hello',
+  some_access_token: '1234567890', bar: 43
+}
+```
+
+Remaining allowed options are:
+
+* `:rescuer` - a lambda for error rescuing logic. The result of lambda call will be joined to
+  the template. The default lambda just returns error message to the template.
+
+  ```ruby
+    Hotcell::Template.parse('Hello, {{ name }}!').render(
+      name: 'Hulk',
+      rescuer: ->(e) { Rollbar.report_exception(e) }
+    )
+  ```
+
+* `:reraise` - raise exception after occurence or not. Error raises after `:rescuer` execution and
+  doesn't affect it. Accepts true or false.
+* `:helpers` - array of modules with fuctions accessible from template. `Hotcell.helpers` config
+  option is used by default. Works similar to ActionController's helpers.
+
+  ```ruby
+    Hotcell::Template.parse('Hello, {{ name }}!').render(
+      name: 'Hulk',
+      helpers: MyHelper # or array [MyHelper1, MyHelper2]
+    )
+  ```
+* `:shared` - just hash of shared variables, for internal usage
+
+### Configuring Hotcell
+
+Hotcell has several configuration methods, which provide default internals for
+template processor proper work.
+
+* `commands` accessor returns a hash of default commands
+* `blocks` - same is for blocks
+* `helpers` - default helper modules array
+* `resolver` - default resolver instance for `include` command
+* `escape_tags` - erb-like behavior. Escape tags, but not commands output.
+  False by default.
+
+Also there are methods to setup configuration options:
+
+* `register_command` adds command or block to the list of default commands or blocks
+* `register_helpers` used for adding module to the list of helpers
+* `resolver=` setups new default resolver (any Hotcell::Resolver-like class instance)
+* `escape_tags=` sets tags scaping behavior (true or false)
+
 ## Language reference
 
 Hotcell template consists of template parts and tags. Tags are enclosed in
@@ -43,6 +127,7 @@ Hotcell has several basic types:
   Strings support escaping `{{ 'tlhab \'oS \'Iw HoHwI\' So\' batlh\' }}`.
   Double-quoted strings also support escape sequences {{ "\n\r\s\t" }}
 * Regular expressions `{{ /Foo/i }}`. Simple. Expression plus options (imx)
+* Ranges `{{ 'a'..var_z }}` or `{{ 1...9 }}` for end value exclusion.
 * Arrays `{{ [42, 'hello', /regex/m] }}`
 * Hashes `{{ { a: 42, b: 'bar' } }}` has js-like syntax, so only string
   can be a key for a hash
@@ -113,9 +198,24 @@ really flexible expressions syntax.
 There is some tag modificators to set tag mode.
 
 * `!` - silence modificator. Prevents tag value to be concatenated with
-  template, so `{{! 42 }}` will return '' - empty string. This modificator
+  template, so `{{! 42 }}` will return `` - empty string. This modificator
   is useful for pre-calculation: `{{! var = 'foo' * 3 }}`.
 
+* `^` or `e` - html escape modificators. `{{^ '<article>' }}` will output
+  `&lt;article&gt;`, `{{e '<article>' }}` will do the same.
+  This also works with comants and blocks: `{{^ scope }}<article>{{ end }}`
+  will render `&lt;article&gt;`.
+
+* `~` or `r` means raw output, opposite to escape. `{{~ '<article>' }}`
+  will produce `<article>`.
+
+#### escape_tags config option
+
+Expression tags are not escaped by default, but if you will perform
+`Hotcell.escape_tags = true` - they will. But command and blocks still
+will not. This means: `{{ '<article>' }}` will be rendered as `&lt;article&gt;`,
+but `{{ scope }}<article>{{ end }}` will produce `<article>`.
+
 ### Comments
 
 There is two comments types in Hotcell: in-tag line comment and block comment.
@@ -250,7 +350,7 @@ Case command. Like in most programming languages
 ##### For
 
 Loop command, first argument - variable to put next value, `in` option
-takes an array.
+takes any enumerable (i.e. array, range or hash).
 
 ```
 {{ for post, in: posts }}
@@ -297,88 +397,6 @@ Or for template capturing:
 {{ title }}
 ```
 
-## Usage
-
-### Basic usage:
-
-```ruby
-Hotcell::Template.parse('Hello, {{ name }}!').render name: 'Pyromaniac'
-```
-
-### Additional `render` options:
-
-* `:variables` - variables hash
-* `:environment` - environment variables hash
-* `:scope` - variables and environment variables together
-
-The main difference between environment and ordinary variables is: ordinary variables
-are accessible from the template and environment variables are not. Environment variables
-are user for official purposes, in tag, for example. At the options level, variables have
-string keys and environment variables have symbol keys.
-
-```ruby
-Hotcell::Template.parse('Hello, {{ name }}!').render(
-  variables: { name: 'Pyromaniac' },
-  environments: { some_access_token: '1234567890' },
-  scope: { 'foo' => 42, bar: 43 },
-  moo: 'Hello'
-)
-```
-
-So if you will use something like above, all three options will be merged, but `:variables`
-hash keys will be stringified, `:environment` hash keys will be symbolized, `:scope`
-hash will be lived as is and the rest non-official options will be stringified and used as
-variables. The result of this algorithm will be:
-
-```ruby
-{
-  'name' => 'Pyromaniac', 'foo' => 42, 'moo' => 'Hello',
-  some_access_token: '1234567890', bar: 43
-}
-```
-
-Remaining allowed options are:
-
-* `:rescuer` - a lambda for error rescuing logic. The result of lambda call will be joined to
-  the template. The default lambda just returns error message to the template.
-
-  ```ruby
-    Hotcell::Template.parse('Hello, {{ name }}!').render(
-      name: 'Pyromaniac',
-      rescuer: ->(e) { Rollbar.report_exception(e) }
-    )
-  ```
-
-* `:reraise` - raise exception after occurence or not. Error raises after `:rescuer` execution and
-  doesn't affect it. Accepts true or false.
-* `:helpers` - array of modules with fuctions accessible from template. `Hotcell.helpers` config
-  option is used by default. Works similar to ActionController's helpers.
-
-  ```ruby
-    Hotcell::Template.parse('Hello, {{ name }}!').render(
-      name: 'Pyromaniac',
-      helpers: MyHelper # or array [MyHelper1, MyHelper2]
-    )
-  ```
-* `:shared` - just hash of shared variables, for internal usage
-
-### Configuring Hotcell
-
-Hotcell has several configuration methods, which provide default internals for
-template processor proper work.
-
-* `commands` accessor returns a hash of default commands
-* `blocks` - same is for blocks
-* `helpers` - default helper modules array
-* `resolver` - default resolver for `include` command
-
-Also there are methods to setup configuration options:
-
-* `register_command` adds command or block to the list of default commands or blocks
-* `register_helpers` used for adding module to the list of helpers
-* `resolver=` setups new default resolver
-
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -19,12 +19,12 @@ end
 namespace :project do
   desc 'Build lexer'
   task :lexerr do
-    `ragel -R -F1 lib/hotcell/lexerr.rl`
+    `ragel -R -F1 -I lib/hotcell lib/hotcell/lexerr.rl`
   end
 
   desc 'Build lexer'
   task :lexerc do
-    `ragel -C -G2 ext/lexerc/lexerc.rl`
+    `ragel -C -G2 -I lib/hotcell ext/lexerc/lexerc.rl`
   end
 
   task :dot do