ruby2js 4.0.1 → 4.1.0

data/lib/ruby2js/filter/stimulus.rb

@@ -51,8 +51,10 @@ module Ruby2JS
         @stim_classes = Set.new
         stim_walk(node)
 
-        prepend_list << (@options[:import_from_skypack] ?
-          STIMULUS_IMPORT_SKYPACK : STIMULUS_IMPORT)
+        if modules_enabled?
+          prepend_list << (@options[:import_from_skypack] ?
+            STIMULUS_IMPORT_SKYPACK : STIMULUS_IMPORT)
+        end
 
         nodes = body
         if nodes.length == 1 and nodes.first&.type == :begin

data/lib/ruby2js/filter/tagged_templates.rb

@@ -15,17 +15,19 @@ module Ruby2JS
 
         tagged_methods = @options[:template_literal_tags] || [:html, :css]
 
-        if tagged_methods.include?(method) && !args.empty?
+        if tagged_methods.include?(method) && args.length == 1
           strnode = process args.first
           if strnode.type == :str
             # convert regular strings to literal strings
             strnode = strnode.updated(:dstr, [s(:str, strnode.children.first.chomp("\n"))])
-          else
+          elsif strnode.type == :dstr
             # for literal strings, chomp a newline off the end
             if strnode.children.last.type == :str && strnode.children.last.children[0].end_with?("\n")
              children = [*strnode.children.take(strnode.children.length - 1), s(:str, strnode.children.last.children[0].chomp)]
              strnode = s(:dstr, *children)
             end
+          else
+            return super
           end
 
           S(:taglit, s(:sym, method), strnode)

data/lib/ruby2js/rails.rb

@@ -1,63 +1,10 @@
-# Example usage:
-#
-#   $ echo "gem 'ruby2js', require: 'ruby2js/rails'" >> Gemfile
-#   $ bundle update
-#   $ rails generate controller Say hello
-#   $ echo 'alert "Hello world!"' > app/views/say/hello.js.rb
-#   $ rails server
-#   $ curl http://localhost:3000/say/hello.js
-#
-# Using an optional filter:
-#
-#   $ echo 'require "ruby2js/filter/functions"' > config/initializers/ruby2js.rb
-#
-# Asset Pipeline:
-#
-#  Ruby2JS registers ".rb.js" extension.
-#  You can add "ruby_thing.js.rb" to your app/javascript folder
-#  and '= require ruby_thing' from other js sources.
-#
-#  (options are not yet supported, but by requiring the appropriate files
-#   as shown above, you can configure proejct wide.)
-require 'ruby2js'
+require 'rails'
+require_relative './sprockets'
 
-module Ruby2JS
-  module Rails
-    class Template
-      cattr_accessor :default_format
-      self.default_format = Mime[:js]
-      def self.call(template, source)
-        "Ruby2JS.convert(#{template.source.inspect}, file: source).to_s"
-      end
+class Ruby2JSRailtie < Rails::Railtie
+  rake_tasks do
+    Dir[File.expand_path('../tasks/*.rake', __dir__)].each do |file|
+      load file
     end
-
-    ActiveSupport.on_load(:action_view) do
-      ActionView::Template.register_template_handler :rb, Template
-    end
-
-    class SprocketProcessor
-      def initialize(file = nil)
-        @file = file
-      end
-      def render(context , _)
-        context = context.instance_eval { binding } unless context.is_a? Binding
-        Ruby2JS.convert(File.read(@file), binding: context).to_s
-      end
-    end
-
-    class Engine < ::Rails::Engine
-      engine_name "ruby2js"
-
-      config.app_generators.javascripts true
-      config.app_generators.javascript_engine :rb
-
-      config.assets.configure do |env|
-        env.register_mime_type 'text/ruby', extensions: ['.js.rb', '.rb']
-        env.register_transformer 'text/ruby', 'text/javascript', SprocketProcessor
-        env.register_preprocessor 'text/javascript', SprocketProcessor
-      end
-    end
-
   end
-
 end

data/lib/ruby2js/serializer.rb

@@ -303,11 +303,11 @@ module Ruby2JS
     def vlq(*mark)
       if @mark[0] == mark[0]
         return if @mark[-3..-1] == mark[-3..-1]
-        @mappings << ',' unless @mappings == ''
+        @mappings += ',' unless @mappings == ''
       end
 
       while @mark[0] < mark[0]
-        @mappings << ';'
+        @mappings += ';'
         @mark[0] += 1
         @mark[1] = 0
       end
@@ -322,16 +322,21 @@ module Ruby2JS
           data = diff << 1
         end
 
-        encoded = ''
-
-        begin
-          digit = data & 0b11111
-          data >>= 5
-          digit |= 0b100000 if data > 0
-          encoded << BASE64[digit]
-        end while data > 0
+        if data <= 0b11111
+          # workaround https://github.com/opal/opal/issues/575
+          encoded = BASE64[data]
+        else
+          encoded = ''
+
+          begin
+            digit = data & 0b11111
+            data >>= 5
+            digit |= 0b100000 if data > 0
+            encoded += BASE64[digit]
+          end while data > 0
+        end
 
-        @mappings << encoded
+        @mappings += encoded
       end
     end
 

data/lib/ruby2js/sprockets.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+require 'sprockets/source_map_utils'
+require 'ruby2js'
+require 'ruby2js/version'
+
+module Ruby2JS
+  module SprocketsTransformer
+    include Sprockets
+    VERSION = '1'
+
+    @@options = {}
+
+    def self.options=(options)
+      @@options = options
+    end
+
+    def self.cache_key
+      @cache_key ||= "#{name}:#{Ruby2JS::VERSION::STRING}:#{VERSION}".freeze
+    end
+
+    def self.call(input)
+      data = input[:data]
+
+      js, map = input[:cache].fetch([self.cache_key, data]) do
+        result = Ruby2JS.convert(data, {**@@options, file: input[:filename]})
+        [result.to_s, result.sourcemap.transform_keys {|key| key.to_s}]
+      end
+
+      map = SourceMapUtils.format_source_map(map, input)
+      map = SourceMapUtils.combine_source_maps(input[:metadata][:map], map)
+
+      { data: js, map: map }
+    end
+  end
+end
+
+Sprockets.register_mime_type 'application/ruby', extensions: ['.rb', '.js.rb']
+
+Sprockets.register_transformer 'application/ruby', 'application/javascript',
+  Ruby2JS::SprocketsTransformer

data/lib/ruby2js/version.rb

@@ -1,8 +1,8 @@
 module Ruby2JS
   module VERSION #:nodoc:
     MAJOR = 4
-    MINOR = 0
-    TINY  = 1
+    MINOR = 1
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/tasks/README.md

@@ -0,0 +1,4 @@
+This directory contains rails install tasks and a test program which will run
+the rails examples from the docs/src/_examples/rails directory.
+
+run `./testrails.rb` for usage instructions.

data/lib/tasks/install/app/javascript/elements/index.js

@@ -0,0 +1,2 @@
+function importAll(r) { r.keys().forEach(r) }
+importAll(require.context("elements", true, /_elements?\.js(\.rb)?$/))

data/lib/tasks/install/config/webpack/loaders/ruby2js.js

@@ -0,0 +1,20 @@
+const { environment } = require('@rails/webpacker')
+
+module.exports = {
+  test: /\.js\.rb$/,
+  use: [
+    {
+      loader: "babel-loader",
+      options: environment.loaders.get('babel').use[0].options
+    },
+
+    {
+      loader: "@ruby2js/webpack-loader",
+      options: {
+        autoexports: "default",
+        eslevel: 2021,
+        filters: ["esm", "functions"]
+      }
+    }
+  ]
+}

data/lib/tasks/install/litelement.rb

@@ -0,0 +1,9 @@
+@ruby2js_options = {filters: ['lit-element']}
+@yarn_add='lit-element'
+eval IO.read "#{__dir__}/webpacker.rb"
+
+directory File.expand_path("app/javascript/elements", __dir__),
+  Rails.root.join('app/javascript/elements').to_s
+
+append_to_file Rails.root.join('app/javascript/packs/application.js').to_s,
+  "\nimport 'elements'\n"

data/lib/tasks/install/preact.rb

@@ -0,0 +1,3 @@
+@ruby2js_options = {filters: ['react']}
+@yarn_add='preact'
+eval IO.read "#{__dir__}/webpacker.rb"

data/lib/tasks/install/react.rb

@@ -0,0 +1,2 @@
+@ruby2js_options = {filters: ['react']}
+eval IO.read "#{__dir__}/webpacker.rb"

data/lib/tasks/install/stimulus-sprockets.rb

@@ -0,0 +1,32 @@
+create_file Rails.root.join('config/initializers/ruby2js.rb').to_s,
+  <<~CONFIG
+    require 'ruby2js/filter/esm'
+    require 'ruby2js/filter/functions'
+    require 'ruby2js/filter/stimulus'
+
+    Ruby2JS::SprocketsTransformer.options = {
+      autoexports: :default,
+      eslevel: 2020
+    }
+
+    require 'stimulus/importmap_helper'
+
+    module Stimulus::ImportmapHelper
+      def find_javascript_files_in_tree(path)
+         exts = {'.js' => '.js', '.jsm' => '.jsm'}.merge(
+           Sprockets.mime_exts.map {|key, value|
+             next unless Sprockets.transformers[value]["application/javascript"]
+             [key, '.js']
+           }.compact.to_h)
+
+         Dir[path.join('**/*')].map {|file|
+           file_ext, web_ext = Sprockets::PathUtils.match_path_extname(file, exts)
+           next unless file_ext
+
+           next unless File.file? file
+
+           Pathname.new(file.chomp(file_ext) + web_ext)
+         }.compact
+      end
+    end
+  CONFIG

data/lib/tasks/install/stimulus-webpacker.rb

@@ -0,0 +1,5 @@
+@ruby2js_options = {filters: ['stimulus'], eslevel: 2022}
+eval IO.read "#{__dir__}/webpacker.rb"
+
+insert_into_file Rails.root.join("app/javascript/controllers/index.js").to_s,
+  '(\\.rb)?', after: '_controller\\.js'

data/lib/tasks/install/webpacker.rb

@@ -0,0 +1,80 @@
+#
+# These instructions can be used standalone or in combination with other
+# instructions.
+#
+# If used standalone on a repository which did not previously have the Ruby2JS
+# webpack loader configured, it will add the '.js.rb' extension to
+# `config/webpacker.yml`, install the Ruby2JS webpack-loader and add a minimal
+# configuration which runs the Ruby2JS webpack loader then the babel loader to
+# `config/webpacker.yml`.
+#
+# Other instructions can require these instructions.  If they set the
+# @ruby2js_options instance variable before they do so, the options provided
+# will be merged and/or override the ones in the base configuration.  
+#
+# If these instructions are run against a Rails application that was
+# previously configured, the @ruby2js_options provided, if any, will be merged
+# with the options found in the configuration.
+#
+
+# default options
+options = @ruby2js_options || {}
+
+# define .js.rb as a extension to webpacker
+insert_into_file Rails.root.join("config/webpacker.yml").to_s,
+  "    - .js.rb\n", after: "\n    - .js\n"
+
+# install webpack loader
+run "yarn add @ruby2js/webpack-loader #{@yarn_add}"
+
+target = Rails.root.join("config/webpack/loaders/ruby2js.js").to_s
+
+# default config
+if not File.exist? target
+  # may be called via eval, or directly.  Resolve source either way.
+  source_paths.unshift __dir__
+  source_paths.unshift File.dirname(caller.first)
+  directory "config/webpack/loaders", File.dirname(target)
+end
+
+# load config
+insert_into_file Rails.root.join("config/webpack/environment.js").to_s,
+  "environment.loaders.prepend('ruby2js', require('./loaders/ruby2js'))\n"
+
+# read current configuration
+before = IO.read(target)
+
+# extract indentation and options
+match = /^(\s*)options: (\{.*?\n\1\})/m.match(before)
+
+# evaluate base options.  Here it is handy that Ruby's syntax for hashes is
+# fairly close to JavaScript's object literals.  May run into problems in the
+# future if there ever is a need for {"x": y} as that would need to be
+# {"x" => y} in Ruby.
+base = eval(match[2])
+
+# Merge the options, initially having the new options override the original
+# options.
+merged = base.merge(options)
+
+# Intelligently combine options if they are the same type.
+options.keys.each do |key|
+  next unless base[key]
+
+  if options[key].is_a? Array and base[key].is_a? Array
+    merged[key] = (base[key] + options[key]).uniq
+  elsif options[key].is_a? Numeric and base[key].is_a? Numeric
+    merged[key] = [base[key], options[key]].max
+  elsif options[key].is_a? Hash and base[key].is_a? Hash
+    merged[key] = base[key].merge(options[key])
+  end
+end
+
+# Serialize options as JavaScript, matching original indentation.
+replacement =  Ruby2JS.convert(merged.inspect + "\n").to_s.
+  gsub(/^/, match[1]).strip
+
+# Update configuration
+unless before.include? replacement
+  gsub_file target, match[2].to_s, replacement
+end

data/lib/tasks/nodetest.js

@@ -0,0 +1,47 @@
+// minimal sanity test to verify usage of Ruby2JS under Node
+
+const assert = require('assert');
+
+const Ruby2JS = require('@ruby2js/ruby2js');
+// const Ruby2JS =
+// require('/home/rubys/git/ruby2js/docs/src/demo/ruby2js.js');
+
+function to_js(string, options={}) {
+  return Ruby2JS.convert(string, options).toString()
+}
+
+assert.strictEqual(
+  to_js('foo = 1'),
+  'var foo = 1');
+
+assert.strictEqual(
+  to_js('foo = 1', {eslevel: 2015}),
+  'let foo = 1');
+
+assert.strictEqual(
+  to_js('foo.empty?', {filters: ['functions']}),
+  'foo.length == 0');
+
+let ast = Ruby2JS.convert('String', {file: 'a.rb'}).ast
+assert.strictEqual(ast.constructor, Ruby2JS.AST.Node)
+assert.strictEqual(ast.type, "const")
+assert.strictEqual(ast.children.length, 2)
+assert.strictEqual(ast.children[0], Ruby2JS.nil)
+assert.strictEqual(ast.children[1], "String")
+
+let sourcemap = Ruby2JS.convert('a=1', {file: 'a.rb'}).sourcemap
+assert.strictEqual(sourcemap.version, 3)
+assert.strictEqual(sourcemap.file, 'a.rb')
+assert.strictEqual(sourcemap.sources.length, 1)
+assert.strictEqual(sourcemap.sources[0], 'a.rb')
+assert.strictEqual(sourcemap.mappings, 'QAAE')
+
+console.log(to_js(`
+class C < LitElement
+  def render
+    x.empty?
+    '<h1>title</h1>'
+  end
+end
+
+`, {eslevel: 2020, filters: ['lit-element', 'esm', 'functions']}))

data/lib/tasks/ruby2js_tasks.rake

@@ -0,0 +1,47 @@
+Thor::Actions::WARNINGS[:unchanged_no_flag] = 'unchanged'
+
+def template(location)
+  system "#{RbConfig.ruby} #{Rails.root.join("bin")}/rails app:template " + 
+    "LOCATION=#{File.expand_path(location, __dir__)}"
+end
+
+namespace :ruby2js do
+  namespace :install do
+    desc "Install Ruby2JS with LitElement support"
+    task :litelement do
+      template 'install/litelement.rb'
+    end
+
+    desc "Install Ruby2JS with Preact support"
+    task :preact do
+      template 'install/preact.rb'
+    end
+
+    desc "Install Ruby2JS with React support"
+    task :react do
+      template 'install/react.rb'
+      Rake::Task['webpacker:install:react'].invoke
+    end
+
+    namespace :stimulus do
+      desc "Install Ruby2JS with Stimulus Sprockets support"
+      task :sprockets => :"stimulus:install:asset_pipeline" do
+        template 'install/stimulus-sprockets.rb'
+      end
+
+      desc "Install Ruby2JS with Stimulus Webpacker support"
+      task :webpacker => :"stimulus:install" do
+        template 'install/stimulus-webpacker.rb'
+      end
+    end
+  end
+end
+
+namespace :webpacker do
+  namespace :install do
+    desc "Install everything needed for Ruby2JS"
+    task :ruby2js do
+      template 'install/webpacker.rb'
+    end
+  end
+end