opal-rails 1.0.1 → 2.0.1

data/bin/sandbox

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+gem_name="$(ruby -rpathname -e"puts Pathname(ARGV.first).join('../..').expand_path.glob('*.gemspec').first.basename('.gemspec')" -- $0)"
+
+# Stay away from the bundler env of the containing extension.
+function unbundled {
+  ruby -rbundler -e'b = proc {system *ARGV}; Bundler.respond_to?(:with_unbundled_env) ? Bundler.with_unbundled_env(&b) : Bundler.with_clean_env(&b)' -- $@
+}
+
+rm -rf ./sandbox
+unbundled bundle exec rails new sandbox \
+  --skip-bundle \
+  --skip-git \
+  --skip-keeps \
+  --skip-rc \
+  --skip-spring \
+  --skip-test \
+  $@
+
+if [ ! -d "sandbox" ]; then
+  echo 'sandbox rails application failed'
+  exit 1
+fi
+
+cd ./sandbox
+cat <<RUBY >> Gemfile
+gem '$gem_name', path: '..'
+RUBY
+
+unbundled bundle install --gemfile Gemfile
+unbundled bin/rails webpacker:install
+
+
+cd .. # Back to the project root.
+bin/sandbox-setup # Run any custom setup.
+
+echo
+echo "🚀 Sandbox app successfully created for $gem_name!"
+

data/bin/sandbox-setup

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+
+root = Pathname('sandbox')
+
+system 'bin/rails g opal:install'
+system 'bin/rails g controller home index -f'
+
+root.join('config/routes.rb').write <<~RUBY
+  Rails.application.routes.draw do
+    root to: "home#index"
+  end
+RUBY

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install bundler --conservative
+
+bundle update

data/gemfiles/rails_6_0_opal_1_0.gemfile

@@ -2,11 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "c_lexer"
 gem "rails", "~> 6.0.0"
 gem "opal", "~> 1.0.0"
-gem "opal-rspec", git: "https://github.com/opal/opal-rspec.git", branch: :master
-gem "opal-jquery", git: "https://github.com/opal/opal-jquery.git", branch: :master
 gem "opal-sprockets"
 
 gemspec path: "../"

data/gemfiles/rails_6_0_opal_1_1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0.0"
+gem "opal", "~> 1.1.0"
+gem "opal-sprockets"
+
+gemspec path: "../"

data/gemfiles/rails_6_1_opal_1_0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+gem "opal", "~> 1.0.0"
+gem "opal-sprockets"
+
+gemspec path: "../"

data/gemfiles/rails_6_1_opal_1_1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+gem "opal", "~> 1.1.0"
+gem "opal-sprockets"
+
+gemspec path: "../"

data/lib/assets/javascripts/opal_ujs.js.rb

@@ -1,4 +1 @@
-require 'jquery'
-require 'jquery_ujs'
-require 'opal'
-require 'opal-jquery'
+warn "`opal_ujs` is deprecated and no longer works"

data/lib/generators/opal/assets/assets_generator.rb

@@ -0,0 +1,7 @@
+class Opal::AssetsGenerator < ::Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def copy_opal
+    template 'javascript.js.rb', File.join('app/assets/javascripts', class_path, "#{file_name}.js.rb")
+  end
+end

data/lib/generators/opal/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/opal/install/install_generator.rb

@@ -0,0 +1,14 @@
+class Opal::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  def configure_sprockets
+    append_to_file 'app/assets/config/manifest.js', '//= link_directory ../javascript .js'
+    template "application.js.rb", "app/assets/javascript/application.js.rb"
+    template "initializer.rb", "config/initializers/opal.rb"
+
+    # Add the javascript tag to the application head tag
+    gsub_file 'app/views/layouts/application.html.erb', %r{(\n *)</head>},
+      '\1  <%= javascript_include_tag "application", "data-turbolinks-track": "reload" %>' \
+      '\1</head>'
+  end
+end

data/lib/generators/opal/install/templates/application.js.rb

@@ -0,0 +1,12 @@
+require "opal"
+
+# Uncomment the following to print out you're hello-world with Opal:
+#
+#   puts "hello world!"
+#
+# The following will append a hello-world to your <body> element:
+#
+#   require "native"
+#   $$[:document].addEventListener :DOMContentLoaded do
+#     $$[:document][:body][:innerHTML] += '<h2>Hello World!</h2>'
+#   end

data/lib/generators/opal/install/templates/initializer.rb

@@ -0,0 +1,22 @@
+# Check out the full list of the available configuration options at
+# https://github.com/opal/opal/blob/master/lib/opal/config.rb
+
+Rails.application.configure do
+  # We suggest keeping the configuration above as default for all environments,
+  # disabling some of them might slightly reduce the bundle size or reduce performance
+  # by degrading some ruby features.
+  config.opal.method_missing_enabled   = true
+  config.opal.const_missing_enabled    = true
+  config.opal.arity_check_enabled      = true
+  config.opal.freezing_stubs_enabled   = true
+  config.opal.dynamic_require_severity = :ignore
+
+  # To enable passing assigns from the controller to the opal template handler
+  # change the following configuration to one of these values:
+  #
+  #   - true    # both locals and instance variables
+  #   - :locals # only locals
+  #   - :ivars  # only instance variables
+  #
+  config.opal.assigns_in_templates = false
+end

data/lib/opal/rails.rb

@@ -1,9 +1,5 @@
 require 'opal'
-require 'opal-jquery'
-require 'opal-activesupport'
 
 require 'opal/rails/engine'
 require 'opal/rails/template_handler'
 require 'opal/rails/version'
-
-require 'jquery-rails'

data/lib/opal/rails/engine.rb

@@ -1,6 +1,5 @@
 require 'rails'
-require 'opal/sprockets/server'
-require 'opal/sprockets/processor'
+require 'opal/sprockets'
 
 module Opal
   module Rails
@@ -12,6 +11,14 @@ module Opal
       config.opal.dynamic_require_severity = :ignore
       config.opal.assigns_in_templates = true
 
+      def (config.opal).assign_locals_in_templates?
+        assigns_in_templates == true || assigns_in_templates == :locals
+      end
+
+      def (config.opal).assign_instance_variables_in_templates?
+        assigns_in_templates == true || assigns_in_templates == :ivars
+      end
+
       # Cache eager_load_paths now, otherwise the assets dir is added
       # and its .rb files are eagerly loaded.
       config.eager_load_paths

data/lib/opal/rails/template_handler.rb

@@ -1,22 +1,31 @@
+require 'active_support/json'
+
 module Opal
   module Rails
     class TemplateHandler
 
-      def self.call(template)
-        new.call(template)
+      def self.call(template, source = template.source)
+        new.call(template, source)
       end
 
-      def call(template)
-        escaped = template.source.gsub(':', '\:')
+      def call(template, source = template.source)
+        escaped = source.gsub(':', '\:')
         string = '%q:' + escaped + ':'
 
         <<-RUBY
+          config = ::Rails.application.config.opal
+
           code = []
           code << 'Object.new.instance_eval {'
-          if ::Rails.application.config.opal.assigns_in_templates
-            code << JSON.parse(local_assigns.to_json).map { |key, val| "\#{key} = \#{val.inspect};" }.join
-            code << JSON.parse(@_assigns.to_json).map { |key, val| "@\#{key} = \#{val.inspect};" }.join
+
+          if config.assign_locals_in_templates?
+            code << ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(local_assigns)).map { |key, val| "\#{key} = \#{val.inspect};" }.join
           end
+
+          if config.assign_instance_variables_in_templates?
+            code << ActiveSupport::JSON.decode(ActiveSupport::JSON.encode(@_assigns)).map { |key, val| "@\#{key} = \#{val.inspect};" }.join
+          end
+
           code << #{string}
           code << '}'
           Opal.compile(code.join("\n"))

data/lib/opal/rails/version.rb

@@ -1,5 +1,5 @@
 module Opal
   module Rails
-    VERSION = '1.0.1'
+    VERSION = '2.0.1'
   end
 end

data/opal-rails.gemspec

@@ -1,41 +1,46 @@
-# coding: utf-8
-$:.push File.expand_path('../lib', __FILE__)
-require 'opal/rails/version'
-
-Gem::Specification.new do |s|
-  s.name        = 'opal-rails'
-  s.version     = Opal::Rails::VERSION
-  s.authors     = ['Elia Schito']
-  s.email       = ['elia@schito.me']
-  s.homepage    = 'https://github.com/opal/opal-rails#readme'
-  s.summary     = %q{Rails bindings for opal JS engine}
-  s.description = %q{Rails bindings for opal JS engine}
-  s.license     = 'MIT-LICENSE'
-
-  s.rubyforge_project = 'opal-rails'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
-
-  required_ruby_version = '>= 2.3'
-
-  s.add_dependency 'rails',               '>= 5.1', '< 6.1'
-  s.add_dependency 'sprockets-rails',     '>= 2.3.3', '< 4.0'
-  s.add_dependency 'jquery-rails'
-
-  s.add_dependency 'opal',                '~> 1.0.0'
-  s.add_dependency 'opal-jquery',         '~> 0.4.4'
-  s.add_dependency 'opal-sprockets',      '~> 0.4.6'
-  s.add_dependency 'opal-activesupport',  '>= 0.0.5'
-
-  s.add_development_dependency 'execjs'
-  s.add_development_dependency 'launchy'
-  s.add_development_dependency 'capybara', '~> 3.25'
-  s.add_development_dependency 'apparition'
-  s.add_development_dependency 'rspec-rails'
-  s.add_development_dependency 'appraisal', '~> 2.1'
-  s.add_development_dependency 'sqlite3'
-  s.add_development_dependency 'puma'
+# frozen_string_literal: true
+
+require_relative 'lib/opal/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'opal-rails'
+  spec.version     = Opal::Rails::VERSION
+  spec.authors     = ['Elia Schito']
+  spec.email       = ['elia@schito.me']
+
+  spec.summary     = %q{Rails bindings for opal JS engine}
+  spec.description = %q{Rails bindings for opal JS engine}
+  spec.homepage    = 'https://github.com/opal/opal-rails#readme'
+  spec.license     = 'MIT-LICENSE'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/opal/opal-rails#readme'
+  spec.metadata['changelog_uri'] = 'https://github.com/opal/opal-rails/blob/master/CHANGELOG.md'
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  files = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files = files.grep_v(%r{^(test|spec|features)/})
+  spec.test_files = files.grep(%r{^(test|spec|features)/})
+  spec.bindir = "exe"
+  spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails',               '>= 6.0', '< 7'
+  spec.add_dependency 'sprockets-rails',     '>= 3.0'
+
+  spec.add_dependency 'opal',                '~> 1.0'
+  spec.add_dependency 'opal-sprockets',      '~> 1.0'
+
+  spec.add_development_dependency 'execjs'
+  spec.add_development_dependency 'launchy'
+  spec.add_development_dependency 'capybara', '~> 3.25'
+  spec.add_development_dependency 'apparition'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'appraisal', '~> 2.1'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'puma'
 end

data/spec/helpers/opal_helper_spec.rb

@@ -1,7 +1,9 @@
 require 'spec_helper'
 
-describe OpalHelper, type: :helper do
-  # subject(:helper) { double(javascript_include_tag: '<super>').extend described_class }
+# We need the view type because helpers specs are to are too minimalistic
+# and are missing some initialization stuff.
+describe OpalHelper, :js, type: :view do
+  let(:helper) { view }
 
   describe '#opal_tag' do
     it 'compiles to js' do
@@ -20,17 +22,29 @@ describe OpalHelper, type: :helper do
     # sprockets-rails v3 sets Rails.application.assets to nil in production mode
     allow(Rails.application).to receive(:assets).and_return(nil)
 
-    loading_code = %Q{Opal.require("application");}
+    loading_code = [
+      %<if(window.Opal && Opal.modules["application"]){Opal.loaded(typeof(OpalLoaded) === "undefined" ? [] : OpalLoaded);>,
+      %<Opal.require("application");}>,
+    ].join("\n")
+
     escaped_loading_code = ERB::Util.h loading_code
+    loading_code_in_script_tag = [
+      %(<script>), %(//<![CDATA[), loading_code, %(//]]>), %(</script>),
+    ].join("\n")
+
+    expect(helper.javascript_include_tag('application', debug: true)).to include(loading_code_in_script_tag)
+    expect(helper.javascript_include_tag('application', debug: true)).not_to include(escaped_loading_code)
 
-    expect(helper.javascript_include_tag('application', debug: true)).to  include(escaped_loading_code)
     expect(helper.javascript_include_tag('application', debug: false)).to include(escaped_loading_code)
+    expect(helper.javascript_include_tag('application', debug: false)).not_to include(loading_code_in_script_tag)
+
     expect(helper.javascript_include_tag('application', skip_opal_loader: true)).not_to include(escaped_loading_code)
-    expect(helper.javascript_include_tag('application', skip_opal_loader: true)).not_to include(escaped_loading_code)
+    expect(helper.javascript_include_tag('application', skip_opal_loader: false)).to include(loading_code_in_script_tag)
+
+    expect(helper.javascript_include_tag('application', force_opal_loader_tag: true, debug: true)).to include(loading_code_in_script_tag)
+    expect(helper.javascript_include_tag('application', force_opal_loader_tag: true, debug: false)).to include(loading_code_in_script_tag)
 
-    expect(helper.javascript_include_tag('application', force_opal_loader_tag: true, debug: true)).to  include(loading_code)
-    expect(helper.javascript_include_tag('application', force_opal_loader_tag: true, debug: false)).to include(loading_code)
-    expect(helper.javascript_include_tag('application', force_opal_loader_tag: true, skip_opal_loader: true)).not_to include(loading_code)
-    expect(helper.javascript_include_tag('application', force_opal_loader_tag: true, skip_opal_loader: true)).not_to include(loading_code)
+    expect(helper.javascript_include_tag('application', force_opal_loader_tag: true, skip_opal_loader: true)).not_to include(escaped_loading_code)
+    expect(helper.javascript_include_tag('application', force_opal_loader_tag: true, skip_opal_loader: true)).to include(loading_code_in_script_tag)
   end
 end

data/spec/integration/assigns_spec.rb

@@ -7,7 +7,7 @@ describe 'controller assignments' do
       Rails.application.config.opal.assigns_in_templates = true
     end
 
-    it 'are in the template' do
+    it 'has them in the template' do
       source = get_source_of '/application/with_assignments.js'
       assignments = opal_eval(source)
 
@@ -29,7 +29,7 @@ describe 'controller assignments' do
       Rails.application.config.opal.assigns_in_templates = false
     end
 
-    it 'are not in the template' do
+    it 'has not them in the template' do
       source = get_source_of '/application/with_assignments.js'
       assignments = opal_eval(source)
       {
@@ -45,6 +45,62 @@ describe 'controller assignments' do
     end
   end
 
+  context 'when :locals' do
+    before do
+      Rails.application.config.opal.assigns_in_templates = :locals
+    end
+
+    it 'has only locals in the template' do
+      source = get_source_of '/application/with_assignments.js'
+      assignments = opal_eval(source)
+      {
+        :number_var => 1234,
+        :string_var => 'hello',
+        :array_var  => [1,'a'],
+        :hash_var   => {:a => 1, :b => 2},
+        :object_var => {:contents => 'json representation'},
+      }.each_pair do |ivar, assignment|
+        expect(assignments[ivar]).not_to eq(assignment)
+      end
+      {
+        :local_var  => 'i am local',
+      }.each_pair do |ivar, assignment|
+        expect(assignments[ivar]).to eq(assignment)
+      end
+    end
+  end
+
+  context 'when :ivars' do
+    before do
+      Rails.application.config.opal.assigns_in_templates = :ivars
+    end
+
+    it 'has only ivars in the template' do
+      source = get_source_of '/application/with_assignments.js'
+      assignments = opal_eval(source)
+      {
+        :number_var => 1234,
+        :string_var => 'hello',
+        :array_var  => [1,'a'],
+        :hash_var   => {:a => 1, :b => 2},
+        :object_var => {:contents => 'json representation'},
+      }.each_pair do |ivar, assignment|
+        expect(assignments[ivar]).to eq(assignment)
+      end
+      {
+        :local_var  => 'i am local',
+      }.each_pair do |ivar, assignment|
+        expect(assignments[ivar]).not_to eq(assignment)
+      end
+    end
+  end
+
+  it 'has the correct content type' do
+    get '/application/with_assignments.js'
+    expect(response).to be_successful
+    expect(response.headers['Content-Type']).to eq('text/javascript; charset=utf-8')
+  end
+
   def get_source_of path
     get path
     response.should be_successful