ruby-handlebars 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4850c228d3a84c6701b524aecbb493f801bc4927
-  data.tar.gz: d3d9abdc1cae0ab1a3625f500ec6f39a30c8cc75
+  metadata.gz: 151c26376bf8460ee2826d37725ab7cec3f75676
+  data.tar.gz: 2fa8d9952bec2bc231263ad18b4e9b3daabdeeea
 SHA512:
-  metadata.gz: e9e72431e3c5687b375b8064dbdb99ce089d395aca63d7d0ae09f65d75742f67f9479c91a7f5ebfa0d204f957aaca7d4b468dab2325ec1238dc42ac9f624dff4
-  data.tar.gz: c24ae4750d88e834db222b5830b242ae0a8571295aca85e3c38bc6acc895895c51f7d846608336b95573cc2304d6f784fbd3dcfe6336317d66f22cd49db2361d
+  metadata.gz: e322d2c6a44586ed7e28cd53176602be2b8b86b44a06f710adfd962a7ed50ae5a39fccecb8ee083850ef82be71e3a09a5a3b814e8f28880736f2f12e04c0283e
+  data.tar.gz: 0f46a77dce2f30aef353880f8feee1a81fef3d8dda36047e328fcdc24667882d8d32b0d6c0773fe4b2ac3f62d4d2650feeba70b800fa8bd72234c984ee80f56d

data/README.md

@@ -1,8 +1,117 @@
-# ruby-handlebars
+ruby-handlebars
+===============
 
 [![Build Status](https://travis-ci.org/vincent-psarga/ruby-handlebars.svg?branch=master)](https://travis-ci.org/vincent-psarga/ruby-handlebars)
 [![Code Climate](https://codeclimate.com/github/vincent-psarga/ruby-handlebars/badges/gpa.svg)](https://codeclimate.com/github/vincent-psarga/ruby-handlebars)
 [![Test Coverage](https://codeclimate.com/github/vincent-psarga/ruby-handlebars/badges/coverage.svg)](https://codeclimate.com/github/vincent-psarga/ruby-handlebars)
 
-Pure Ruby library for Handlebars templates.
+Pure Ruby library for [Handlebars](http://handlebarsjs.com/) template system.
 The main goal of this library is to simplify the use of Ruby and Handlebars on Windows machine. If you do not have any need of working on Windows, take a look at [handlebars.rb](https://github.com/cowboyd/handlebars.rb) that uses the real Handlebars library.
+
+Installing
+----------
+
+Simply run:
+
+```shell
+gem install ruby-handlebars
+```
+
+No need for libv8, ruby-racer or any JS related tool.
+
+Using
+-----
+
+A very simple case:
+
+```ruby
+
+require 'ruby-handlebars'
+
+hbs = Handlebars::Handlebars.new
+hbs.compile("Hello {{name}}").call({name: 'world'})
+# Gives: "Hello world", how original ...
+```
+
+You can also use partials:
+
+```ruby
+hbs.register_partial('full_name', "{{person.first_name}} {{person.last_name}}")
+hbs.compile("Hello {{> full_name}}").call({person: {first_name: 'Pinkie', last_name: 'Pie'}})
+# Gives: "Hello Pinkie Pie"
+```
+
+You can also register inline helpers:
+
+```ruby
+hbs.register_helper('strip') {|context, value| value.strip}
+hbs.compile("Hello {{strip name}}").call({name: '                       world     '})
+# Will give (again ....): "Hello world"
+```
+
+or block helpers:
+
+```ruby
+hbs.register_helper('comment') do |context, commenter, block|
+  block.fn(context).split("\n").map do |line|
+    "#{commenter} #{line}"
+  end.join("\n")
+end
+
+hbs.compile("{{#comment '//'}}My comment{{/comment}}").call
+# Will give: "// My comment"
+```
+
+Note that in any block helper you can use an ``else`` block:
+
+```ruby
+hbs.register_helper('markdown') do |context, block, else_block|
+  html = md_to_html(block.fn(context))
+  html.nil? : else_block.fn(context) : html
+end
+
+template = [
+  "{{#markdown}}",
+  "  {{ description }}",
+  "{{else}}",
+  "  Description is not valid markdown, no preview available",
+  "{{/markdown}}"
+].join("\n")
+
+hbs.compile(template).call({description: my_description})
+# Output will depend on the validity of the 'my_description' variable
+```
+
+Two default helpers are provided: ``each`` and ``if``. It is not yet possible to name the current item in an each loop and ``this`` must be used to reference it.
+
+```ruby
+template = [
+  "{{#each items}}",
+  "  {{{ this }}}",
+  "{{else}}",
+  "  No items",
+  "{{/each}}",
+  "",
+  "{{#if my_condition}}",
+  "  It's ok",
+  "{{else}}",
+  "  or maybe not",
+  "{{/if}}",
+].join("\n")
+```
+
+Limitations and roadmap
+-----------------------
+
+This gem does not reuse the real Handlebars code (the JS one) and not everything is handled yet (but it will be someday ;) ):
+
+ - there is no escaping, all strings are considered as safe (so ``{{{ my_var }}}`` and ``{{ my_var }}``) will output the same thing
+ - the parser is not fully tested yet, it may complain with spaces ...
+ - curly bracket are __not__ usable in the template content yet. one workaround is to create simple helpers to generate them
+ - parsing errors are, well, not helpful at all
+
+Aknowledgements
+---------------
+
+This gem would simply not exist if the handlebars team was not here. Thanks a lot for this awesome templating system.
+Thanks a lot to @cowboyd for the [handlebars.rb](https://github.com/cowboyd/handlebars.rb) gem. We used it for a while and it's great (and as told at the beginning of the README, if you do not need any Windows support, use handlebars.rb instead ;) )

data/lib/ruby-handlebars/parser.rb

@@ -1,4 +1,3 @@
-require 'pry'
 require 'parslet'
 
 module Handlebars

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-handlebars
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Vincent Pretre
@@ -17,14 +17,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.2
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -51,28 +57,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.10.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: pry-stack_explorer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.9.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.9.1
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement