jsrb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d11a911afb7baddbd00ec547cd0b5679be9873a7
-  data.tar.gz: 0e28f797a62a8f8b640039b13f8ab54203e12602
+SHA256:
+  metadata.gz: 5b2cff3db7ac17a89b029bc7782e8735b7f9959c4595804c39537af8d6232077
+  data.tar.gz: b7700dc452ea93b9ba17cbf381bb79acfd00747f6e653b309cf24174811598d3
 SHA512:
-  metadata.gz: 31518c3f3adceb687937556bec2c598db034812662c48505616acd46462fed85a0ce1448b2aaea336ec3b3c5cf43605956079b3a1b6516a8035f6ce5265b837a
-  data.tar.gz: d29797e2528c20b83ed3f54573a0cde76f665b6aa9773f6860481187461c2ec1f597c9505dae97f4ef35204f519464a5d27ee095439deb136910b9290315f2fa
+  metadata.gz: 934089fa92db021a2d90e738286de40dbc094286a5f0f4ed281626bd6d666b66d25d643ac4f117289b616c3c4b8d173fac5dcb86d29a645df7cf415c8c4e4939
+  data.tar.gz: 9a1de7b3fd7a00e7facb9c633352e06a142ccb01680d819bba30d3f56c7be226682a00693098068ad85fee4a76ef83a3246377e2c85e5399553b6794adf6defb

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/README.md

@@ -1,14 +1,294 @@
-[![CircleCI](https://circleci.com/gh/effective-spa/jsrb.svg?style=svg)](https://circleci.com/gh/effective-spa/jsrb) [![codecov](https://codecov.io/gh/effective-spa/jsrb/branch/master/graph/badge.svg)](https://codecov.io/gh/effective-spa/jsrb) [![Maintainability](https://api.codeclimate.com/v1/badges/8bf4666ed7b983f01519/maintainability)](https://codeclimate.com/github/effective-spa/jsrb/maintainability)
-
-**This library is still development version. It's currently not recommended to be used in production environment.**
+[![CircleCI](https://circleci.com/gh/effective-spa/jsrb.svg?style=svg)](https://circleci.com/gh/effective-spa/jsrb) [![codecov](https://codecov.io/gh/effective-spa/jsrb/branch/master/graph/badge.svg)](https://codecov.io/gh/effective-spa/jsrb) [![Maintainability](https://api.codeclimate.com/v1/badges/8bf4666ed7b983f01519/maintainability)](https://codeclimate.com/github/effective-spa/jsrb/maintainability) [![Gem Version](https://badge.fury.io/rb/jsrb.svg)](https://badge.fury.io/rb/jsrb)
 
 # Jsrb
 
 Jsrb is a template engine to generate JavaScript code in simple Ruby DSL.
 
-## Usage
+# Getting Started
+
+Jsrb handler works in jsrb files, which contain `.js.jsrb` extension. All ruby syntax is available and `jsrb` is provided in it. You can construct JavaScript code via `jsrb`.
+
+```rb
+name = jsrb.var!(:name) { 'foo' }
+ary = jsrb.var! :ary
+obj = jsrb.var! :obj
+result = jsrb.var!
+# var name = 'foo';
+# var ary;
+# var obj;
+# var _v1; <- auto generate variable name
+
+ary.set!([1, 2, 3])
+# ary = [1, 2, 3];
+
+obj.set!(
+  name: name,
+  profile: {
+    age: 20,
+    sex: 'm'
+  }
+)
+# obj = {
+#   name: name,
+#   profile: {
+#     age: 20,
+#     sex: 'm'
+#   }
+# };
+
+result.set! (obj.name + "(" + obj.profile.age + ")")
+# _v1 = obj.name + "(" + obj.profile.age + ")";
+
+ary.set! ary.map { |x| x * 2 }
+# ary = ary.map(function(x) {
+#  return x * 2;
+# });
+
+jsrb.if!(ary[1] === 4) {
+  result.set! 'four'
+}.elsif(ary[1] === 2) {
+  result.set! 'two'
+}.else {
+  result.set! 'other'
+}
+# // the actual output doesn't looks like this, but will be better code in regard to variable scope.
+# if (ary[1] === 4) {
+#   _v1 = 'four'
+# } else if (ary[1] === 2) {
+#   _v1 = 'two'
+# } else {
+#   _v1 = 'other'
+# }
+
+result.set! jsrb.expr.Date.new!
+# _v1 = new Date;
+
+jsrb.expr.console.log('hello').as_statement!
+# console.log('hello');
+```
+
+# Usage
+
+## Statements
+
+### Variable declaration
+
+`jsrb.var!` pushes a **VariableDeclaration** into current context.
+
+```rb
+# with variable name and initializer
+jsrb.var!('varname') { 100 }
+# var varname = 100;
+
+# without initializer
+jsrb.var!('varname')
+# var varname;
+
+# variable name is auto-generated if not specified
+jsrb.var!
+# var _v1;
+
+# var! returns Jsrb::ExprChain instance, so that you can
+# assign value with `.set!` method.
+a = jsrb.var!
+a.set! 100
+# var _v1;
+# v1 = 100;
+```
+
+### If statement, and conditional expression
+
+`jsrb.if!` pushes an **IfStatement** into current context, `jsrb.if` to build **a conditional expression**.
+
+```rb
+# start with `#if!`
+# and chain `#elsif` to add next case.
+# Note that this is a statement, not expression.
+jsrb.if!(v === 1) {
+  # ..
+}.elsif(v === 2) {
+  # ..
+}.else {
+  # ..
+}
+
+# if you don't need else clause, close with `#end`
+jsrb.if!(v === 1) {
+  # ..
+}.end
+
+# if you want to regard this as an expression, use `#if` without exclamation.
+v.set! jsrb.if(v === 1) {
+  # ..
+}.else {
+  # ..
+}
+```
+
+### Assignment statement
+
+`ExprChain#set!` pushes an **assignment statement** (ExpressionStatement of AssignmentExpression).
+
+```rb
+a = jsrb.var! :a
+a.set! 100
+# var a;
+# a = 100;
+```
+
+### Expression statement
+
+`ExprChain#as_statement!` pushes an **ExpressionStatement** of the left hand side of chain.
+
+```rb
+get_elements = jsrb.expr['getElements']
+get_elements.('.foo').forEach { |n| n.delete.() }.as_statement!
+# getElements('.foo').forEach(function(n) { return n.delete(); });
+```
+
+## Expression chain
+
+Expression chain (`ExprChain` class) is an utility class to construct JavaScript expressions.
+
+### Initialize with wrapping a ruby value
+
+`jsrb.expr` create a new `ExprChain` instance, taking an initial value optionally.
+Some methods in jsrb automatically convert ruby expression to ExprChain.
+
+```rb
+x = jsrb.var! :x
+
+x.set! jsrb.expr(100)
+# x = 100;
+# set! automatically wrap with ExprChain.
+x.set! 100
+# x = 100;
+# If you need to compare by operator with another ExprChain,
+# you have to wrap first.
+x.set!(jsrb.expr(100) < jsrb.expr.y)
+# x.set!(100 < jsrb.expr.y) will fail.
+```
+
+### Chains
+
+#### Member expression
+
+`ExprChain#[], #member!, #..` constructs **MemberExpression**.
+`#[]` and `#member!` is safe. `#..` can be used only if the name has no conflict.
+
+```rb
+x = jsrb.var! :x
+
+obj = jsrb.expr['someObj']
+# jsrb.expr with no argument constructs empty chain,
+# in which every member chain will be an identifier.
+x.set! obj.field
+# x = someObj['field'];
+x.set! obj['field']
+# x = someObj['field'];
+x.set! obj.member! 'field'
+# x = someObj['field'];
+
+x.set! obj.send # NOTE that this is interpreted as a ruby Object's method, and causes an error.
+```
+
+#### Function Call
+
+`ExprChain#call, so #.(), #.. with argument or block` constructs **CallExpression**.
+
+```rb
+x = jsrb.var! :x
+console = jsrb.expr['console']
+
+# using call method
+console.log.('foo').as_statement!
+# console.log('foo')
+console.log.call('foo').as_statement!
+# console.log('foo')
+
+# using dynamic method
+# if #..() has at least one argument or block, it will be a call expression.
+console.log('foo').as_statement!
+# console.log('foo')
+x.map { |item| item.field }.as_statement!
+# x.map(function(item) { return item.field; });
+```
+
+#### Operators
+
+Any ruby-overridable and JS-existing operators are overridden for chaining.
+Supported operators are: `** + - * / % >> << & ^ | <= < > >= == === != ! && ||`.
+
+```rb
+x = jsrb.var! :x
+a = jsrb.expr['a']
+
+x.set!(a === 1)
+# x = a === 1;
+
+x.set!(a * a)
+# x = a * a;
+
+x.set!(3 * a) # raises an error because Fixnum does not accept ExprChain as RHS.
+```
+
+#### New
+
+`ExprChain#new!` constructs **NewExpression**.
+
+```rb
+x = jsrb.var! :x
+
+x.set! jsrb.expr['Date'].new!
+# x = new Date;
+```
+
+#### Function expression
+
+`ExprChain#for_all!` constructs **FunctionExpression**. You can also construct it from Proc directly or passing a block.
+
+```rb
+ary = jsrb.var! :ary, [1, 2, 3]
+
+ary.map((jsrb.expr['x'] * 2).for_all!('x')).as_statement!
+# ary.map(function(x) { return x * 2; });
+
+ary.map { |x| x * 2 }.as_statement!
+# ary.map(function(x) { return x * 2; });
+
+ary.map(->(x) { x * 2 }).as_statement!
+# ary.map(function(x) { return x * 2; });
+```
+
+# Conversion
+
+Every Ruby's generic value will be converted to Javascript value by following rule:
+
+|Ruby value|JavaScript|
+|---|---|
+| finite `100` | `100` |
+| NaN `Float::NAN` | `NaN` |
+| +Infinity `Float::INFINITY` | `Number.POSITIVE_INFINITY` |
+| -Infinity `Float::INFINITY` | `Number.NEGATIVE_INFINITY` |
+| `true` | `true` |
+| `false` | `false` |
+| `:foo` | `"foo"` |
+| `"foo"` | `"foo"` |
+| `nil` | `null` |
+| `[1, 2, 3]` | `[1, 2, 3]` |
+| `{ foo: 'bar' }` | `{ "foo": "bar" }` |
+| `->(x, y, z) { x + y + z }` | `function (x, y, z) { return x + y + z; }` |
+
+# Customize Chain
+
+You can add custom chain methods in `ExprChain` via `Jsrb::ExprChain.#add_custom_chain`.
+
+```rb
+Jsrb::ExprChain.add_custom_chain('log_here', '__tap_log__')
 
-TODO
+jsrb.expr['foo']['bar'].log_here.as_statement!
+# __tap_log__(foo['bar']);
+```
 
 ## Contributing
 

data/jsrb.gemspec

@@ -4,6 +4,7 @@ lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'jsrb/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = 'jsrb'
   spec.version       = Jsrb::VERSION
@@ -18,7 +19,7 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
       'public gem pushes.'
@@ -35,6 +36,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'stitch-rb', '~> 0.0.8'
 
   spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rails', '~> 5.0', '>= 5.0.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end
+# rubocop:enable Metrics/BlockLength

data/lib/jsrb/railtie.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Jsrb
+  class Handler
+    cattr_accessor :default_format
+    self.default_format = Mime[:js]
+
+    def self.call(template)
+      %(jsrb = Jsrb::Base.new; #{template.source}; jsrb.generate_code)
+    end
+  end
+
+  class Railtie < ::Rails::Railtie
+    initializer :server_component do
+      ActiveSupport.on_load :action_view do
+        ActionView::Template.register_template_handler :jsrb, Jsrb::Handler
+      end
+
+      ActiveSupport.on_load :action_controller do
+        ActionController::Renderers.add :jsrb do |obj, _options|
+          send_data obj.to_s, type: Mime[:js]
+        end
+      end
+    end
+  end
+end

data/lib/jsrb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Jsrb
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/jsrb.rb

@@ -10,3 +10,4 @@ require 'jsrb/not_fast_generator'
 require 'jsrb/js_statement_context'
 require 'jsrb/expr_chain'
 require 'jsrb/cond_chain'
+require 'jsrb/railtie' if defined?(Rails::Railtie)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsrb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shun MIZUKAMI
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-09 00:00:00.000000000 Z
+date: 2019-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -58,6 +58,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -110,6 +131,7 @@ files:
 - lib/jsrb/expr_chain.rb
 - lib/jsrb/js_statement_context.rb
 - lib/jsrb/not_fast_generator.rb
+- lib/jsrb/railtie.rb
 - lib/jsrb/vendor/escodegen.browser.js
 - lib/jsrb/version.rb
 homepage: https://github.com/effective-spa/jsrb
@@ -133,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: generates JavaScript code with Ruby DSL