smolbars 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad4a5813703e27fae7f72ae855641b2cc72937e62658405c8799aa92e83497c1
+  data.tar.gz: 95985e08bf35a511003b1ea7965dd86086cbbe750e300803e3553f26a333f14a
+SHA512:
+  metadata.gz: abe547c07dc93bddef2b1ef2ef2046443fae8cf4cf2b116dc66317f1526da8c52f06b255bfb1e4a09b2d40bd986fe3e9068595e49db35526e0c42e73676524bc
+  data.tar.gz: 277ebb7ff739b959d48f7730438f8bb1d522697277e2f85f08bf7c683932c64bcdc4416e4f861b9dcf686e05e7f51c2bd23e1599020d41148b2e19e62103f393

data/README.mdown

@@ -0,0 +1,87 @@
+## Smolbars
+
+[![Gem Version](https://badge.fury.io/rb/smolbars.png)](http://badge.fury.io/rb/handlebars)
+[![Build Status](https://travis-ci.org/cowboyd/handlebars.rb.png?branch=master)](https://travis-ci.org/cowboyd/handlebars.rb)
+[![Dependency Status](https://gemnasium.com/cowboyd/handlebars.rb.png)](https://gemnasium.com/cowboyd/handlebars.rb)
+
+
+This uses [mini_racer][1] to bind to the _actual_ JavaScript implementation of
+[Handlebars.js][2] so that you can use it from ruby. This is a fork of [handlebars.rb][3] to
+change out the deprecated [therubyracer][4] JS integration. 99% the same idea as the better-named
+[minibars][5].
+
+Please be mindful of how this library works: it brings in the full libv8 JS VM to your ruby environment. Each
+`Context` is a full blown JS machine (memory management, JIT, etc). This fork does not support attaching ruby
+functions to the JS VM.
+
+Note on security: do not compile untrusted Handlebars templates. We compile Handlebars template by building ad-hoc
+javascript statements, a bad actor could perform an SQL-injection like attack using the v8 environment for bad things.
+
+## Usage
+
+### Simple stuff
+
+    require 'smolbars'
+    smolbars = Smolbars::Context.new
+    template = smolbars.compile("{{say}} {{what}}")
+    template.call(:say => "Hey", :what => "Yuh!") #=> "Hey Yuh!"
+
+### Helpers
+
+You must write helpers with JavaScript. The JavaScript code should include calls to the Handlebars class registration
+function.
+
+	require 'smolbars'
+	helper = %Q{
+		Handlebars.registerHelper("nthTimes", function(n, options){
+		  var buffer = "";
+
+		  for(var i = 0; i < n; i++) {
+			buffer += options.fn();
+		  }
+
+		  return buffer;
+		});
+	}
+	smolbars = Smolbars::Context.new
+	smolbars.eval(helper)
+	template = smolbars.compile('{{#nthTimes 2}}yep {{/nthTimes}}hurrah!')
+	template.call # 'yep yep hurrah!'
+
+### Partials
+
+You must write partials with JavaScript. The JavaScript code should include calls to the Handlebars class registration
+function.
+
+	require 'smolbars'
+	partial = %Q{
+		Handlebars.registerPartial("legend", "I am {{ who }}");
+	}
+	smolbars = Smolbars::Context.new
+	smolbars.eval(partial)
+	template = smolbars.compile('{{> legend}}')
+	template.call # 'I am Legend!'
+
+### Security
+
+In general, you should not trust user-provided templates: a template can call any method
+(with no arguments) or access any property on any object in the `Smolbars::Context`.
+
+If you'd like to render user-provided templates, you'd want to make sure you do so in a
+sanitized Context, e.g. no filesystem access, read-only or no database access, etc.
+
+You can try setting the timeout on a Smolbars::Context through kwargs that are passed to the
+underlying JS instance
+
+    Smolbars::Context.new(timeout: 500)
+
+## Test
+
+    rspec spec/
+
+
+[1]: https://github.com/rubyjs/mini_racer "mini_racer"
+[2]: https://github.com/wycats/handlebars.js "Handlebars JavaScript templating library"
+[3]: https://github.com/cowboyd/handlebars.rb "Handlebars Ruby library"
+[4]: https://github.com/cowboyd/therubyracer "The Ruby Racer"
+[5]: https://github.com/combinaut/minibars "Minibars"

data/lib/smolbars/context.rb

@@ -0,0 +1,43 @@
+require 'handlebars/source'
+require 'mini_racer'
+require 'securerandom'
+
+module Smolbars
+  class Context
+    def initialize(**kwargs)
+      @@snapshot ||= MiniRacer::Snapshot.new(File.read(Handlebars::Source.bundled_path))
+      @js = MiniRacer::Context.new(kwargs.merge(snapshot: @@snapshot))
+    end
+
+    # Note that this is a hacky JS expression builder. We cannot pass JS AST in to mini_racer so we have to
+    # hope the template passed in does not form invalid Ruby. So don't use templates with backtick characters without
+    # manually escaping them
+    def compile(template)
+      if template.include?("`")
+        raise RuntimeError.new("template cannot contain a backtick character '`'")
+      end
+      handle = fn_handle
+      invocation = %Q{var #{handle} = Handlebars.compile(`#{template}`);}
+      @js.eval(invocation)
+      ::Smolbars::Template.new(self, handle)
+    end
+
+    def eval(*args)
+      @js.eval(*args)
+    end
+
+    def load_pattern(pattern)
+      Dir[pattern].each{ |path| load(path) }
+    end
+
+    def load(path)
+      @js.load(path)
+    end
+
+    private
+
+    def fn_handle
+      "js_fn_#{SecureRandom.hex}"
+    end
+  end
+end

data/lib/smolbars/template.rb

@@ -0,0 +1,17 @@
+module Smolbars
+  class Template
+    def initialize(context, fn)
+      @context, @fn = context, fn
+    end
+
+    def call(*args, **kwargs)
+      if args.length == 0
+        invocation = "%s(%s)" % [@fn, kwargs.to_json]
+      else
+        raise "unsupported"
+        invocation = "%s(%s)" % [@fn, args.to_json]
+      end
+      @context.eval(invocation)
+    end
+  end
+end

data/lib/smolbars/version.rb

@@ -0,0 +1,3 @@
+module Smolbars
+  VERSION = "0.1.0"
+end

data/lib/smolbars.rb

@@ -0,0 +1,2 @@
+require 'smolbars/context'
+require 'smolbars/template'

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: smolbars
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Charles Lowell
+- Xavier Lange
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_racer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: handlebars-source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Uses the actual JavaScript implementation of Handlebars
+email:
+- cowboyd@thefrontside.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.mdown
+- lib/smolbars.rb
+- lib/smolbars/context.rb
+- lib/smolbars/template.rb
+- lib/smolbars/version.rb
+homepage: https://github.com/cowboyd/smolbars.rb
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Ruby bindings for the smolbars.js templating library
+test_files: []