opal-rails 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aee279d2054d467d1e1c9088a1342fe8d75e7ec2affce2504b61b9b885cdb38b
-  data.tar.gz: 4828f47994349fff41a915fd3e21ea7b83052b3eb1ca5c56d3b09fe77676f22d
+  metadata.gz: 875fb1f95adc2d5c12870d36c2fbd91b527d7d3361c97bb11651f83cb5206a93
+  data.tar.gz: 1640ba02072c130623acc881a00b91702720a21d6894c1bca9a2c44fdd0be7ff
 SHA512:
-  metadata.gz: 44de5b40a2352e01fe1f830f35a79ffa4509078002bef98689fbd4827ed5e53b34b141155dddd982515debc70b018c1eece879ca2957bcbfc9c81bca9600b764
-  data.tar.gz: 8b89cfd6f4778b746f8977f0bb20729766603b97840b56068bfa3ad04113aa8ac9cd2859616885b226c0252dd4114e00b2053aaee828715cbcd0bf94e49b7e5e
+  metadata.gz: 54b2acdaa18cd7354ab49623b951aa2c23f3a1da08bbebd5bddefbc18e56688b9777d7b1afb6c8648a200f335d24bf796d9d7dc2f87d47f2cc9f7a0bac3aa0ff
+  data.tar.gz: 471d1b6825196c2fe29310bf674fba3c0117452218bc8f56722435f81513e673e72a2ebce8f698d524973f15d5d4ead2acb6917b6eccdb5b98ada75463114cb1

data/.github/workflows/build.yml

@@ -11,10 +11,11 @@ on:
 jobs:
   build:
     strategy:
+      fail-fast: false
       matrix:
-        ruby: ['2.7', '3.0'] # ['3.1'] - enable once Rails 7.0.1 is released
+        ruby: ['3.0', '3.1', '3.2']
         rails: ['rails_6_0', 'rails_6_1', 'rails_7_0']
-        opal: ['opal_1_0', 'opal_1_3', 'opal_1_4']
+        opal: ['opal_1_0', 'opal_1_3', 'opal_1_7']
     runs-on: ubuntu-latest
 
     steps:

data/Appraisals

@@ -7,8 +7,8 @@ ENV['OPAL_VERSION'] = nil # ensure the env is clean
 github = -> repo_name { "https://github.com/#{repo_name}.git" }
 
 {
-  opal_1_4: -> gemfile do
-    gemfile.gem 'opal', '~> 1.4.0'
+  opal_1_7: -> gemfile do
+    gemfile.gem 'opal', '~> 1.7.0'
     gemfile.gem 'opal-sprockets'
   end,
 

data/CHANGELOG.md

@@ -18,7 +18,11 @@ Whitespace conventions:
 - 1 spaces before normal text
  -->
 
+## [2.0.3](https://github.com/opal/opal-rails/compare/v2.0.2...v2.0.3) - 2021-12-29
 
+### Added
+
+- Add HAML 6 support
 
 ## [2.0.2](https://github.com/opal/opal-rails/compare/v2.0.1...v2.0.2) - 2021-12-29
 

data/README.md

@@ -23,10 +23,10 @@ In your `Gemfile`
 gem 'opal-rails'
 ```
 
-Add `app/assets/javascript` to your asset-pipeline manifest in `app/assets/config/manifest.js`:
+Run `opal:install` Rails generator to add `app/assets/javascript` to your asset-pipeline manifest in `app/assets/config/manifest.js`:
 
 ```
-bin/rails opal:install
+bin/rails g opal:install
 ```
 
 
@@ -34,31 +34,36 @@ bin/rails opal:install
 
 #### For the compiler
 
-Add your configuration for the compiler:
+The following automatically gets added to your configuration for the compiler when running the `opal:install` Rails generator:
 
 `config/initializers/opal.rb`
 
 ```ruby
 # Compiler options
-Rails.application.config.opal.method_missing_enabled   = true
-Rails.application.config.opal.const_missing_enabled    = true
-Rails.application.config.opal.arity_check_enabled      = true
-Rails.application.config.opal.freezing_stubs_enabled   = true
-Rails.application.config.opal.dynamic_require_severity = :ignore
+Rails.application.configure do
+  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
+end
 ```
 
 Check out the full list of the available configuration options at: [lib/opal/config.rb](https://github.com/opal/opal/blob/master/lib/opal/config.rb).
 
 #### For template assigns
 
-Add your configuration for rendering assigns when using the template handler from actions:
+You may optionally add configuration for rendering assigns when using the template handler from actions:
 
 `config/initializers/opal.rb`
 
 ```ruby
-Rails.application.config.opal.assigns_in_templates = true
-Rails.application.config.opal.assigns_in_templates = :locals # only locals
-Rails.application.config.opal.assigns_in_templates = :ivars # only instance variables
+Rails.application.configure do
+  # ...
+  config.opal.assigns_in_templates = true
+  config.opal.assigns_in_templates = :locals # only locals
+  config.opal.assigns_in_templates = :ivars # only instance variables
+end
 ```
 
 
@@ -69,6 +74,42 @@ Local and instance variables will be sent down to the view after converting thei
 
 ### Basic example
 
+#### Rails 7 example
+
+This example assumes Rails 7 and having followed the [Installation](#installation) instructions.
+
+1- Delete `app/javascript/application.js`
+
+2- Enable the following lines in the generated `app/assets/javascript/application.js.rb` below `require "opal"`:
+
+```ruby
+puts "hello world!"
+require "native"
+$$[:document].addEventListener :DOMContentLoaded do
+  $$[:document][:body][:innerHTML] = '<h2>Hello World!</h2>'
+end
+```
+
+3- Run `rails g scaffold welcome`
+
+4- Run `rails db:migrate`
+
+5- Clear `app/views/welcomes/index.html.erb` (empty its content)
+
+6- Run `rails s`
+
+7- Visit `http://localhost:3000/welcomes`
+
+In the browser webpage, you should see:
+
+<h2>Hello World!</h2>
+
+Also, you should see `hello world!` in the browser console.
+
+#### Rails 5 example
+
+This example assumes Rails 5.
+
 1. Rename `app/assets/javascripts/application.js` to `app/assets/javascripts/application.js.rb`
 2. Replace the Sprockets directives with plain requires
 
@@ -88,7 +129,7 @@ require_tree '.'
 puts "hello world!"
 ```
 
-### A more extensive example
+#### A more extensive Rails 5 example
 
 ```ruby
 require 'opal'
@@ -166,12 +207,16 @@ post.find('.comments').html = comments_html
 
 #### Instance and local variables in templates
 
-By default `opal-rails` will forward any instance and local variable you'll pass to the template.
+By default `opal-rails`, will NOT forward any instance and local variable you'll pass to the template.
 
-This behavior can be disabled by setting `Rails.application.config.opal.assigns_in_templates` to `false` in `config/initializers/assets.rb`:
+This behavior can be enabled by setting `Rails.application.config.opal.assigns_in_templates` to `true` in `config/initializers/assets.rb`:
 
 ```ruby
-Rails.application.config.opal.assigns_in_templates = false
+Rails.application.configure do
+  # ...
+  config.opal.assigns_in_templates = true
+  # ...
+end
 ```
 
 
@@ -293,7 +338,7 @@ bin/rails s # will start the sandbox app server
 
 ## License
 
-© 2012-2021 Elia Schito
+© 2012-2022 Elia Schito
 
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to deal

data/gemfiles/{rails_6_0_opal_1_4.gemfile → rails_6_0_opal_1_7.gemfile}

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "net-smtp"
 gem "rails", "~> 6.0.0"
-gem "opal", "~> 1.4.0"
+gem "opal", "~> 1.7.0"
 gem "opal-sprockets"
 
 gemspec path: "../"

data/gemfiles/{rails_6_1_opal_1_4.gemfile → rails_6_1_opal_1_7.gemfile}

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "net-smtp"
 gem "rails", "~> 6.1.0"
-gem "opal", "~> 1.4.0"
+gem "opal", "~> 1.7.0"
 gem "opal-sprockets"
 
 gemspec path: "../"

data/gemfiles/{rails_7_0_opal_1_4.gemfile → rails_7_0_opal_1_7.gemfile}

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "net-smtp"
 gem "rails", "~> 7.0.0"
-gem "opal", "~> 1.4.0"
+gem "opal", "~> 1.7.0"
 gem "opal-sprockets"
 
 gemspec path: "../"

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

@@ -8,5 +8,5 @@ require "opal"
 #
 #   require "native"
 #   $$[:document].addEventListener :DOMContentLoaded do
-#     $$[:document][:body][:innerHTML] += '<h2>Hello World!</h2>'
+#     $$[:document][:body][:innerHTML] = '<h2>Hello World!</h2>'
 #   end

data/lib/opal/rails/haml5_filter.rb

@@ -0,0 +1,28 @@
+module Haml::Filters::Opal
+  include Haml::Filters::Base
+
+  def mime_type
+    ::Opal::Config.esm ? 'module' : 'text/javascript'
+  end
+
+  def render_with_options ruby, options
+    text = ::Opal.compile(ruby)
+
+    if options[:format] == :html5
+      type = ''
+    else
+      type = " type=#{options[:attr_wrapper]}#{mime_type}#{options[:attr_wrapper]}"
+    end
+
+    text.rstrip!
+    text.gsub!("\n", "\n    ")
+
+    <<HTML
+<script#{type}>
+  //<![CDATA[
+    #{text}
+  //]]>
+</script>
+HTML
+  end
+end

data/lib/opal/rails/haml6_filter.rb

@@ -0,0 +1,23 @@
+require "haml"
+require "haml/filters"
+require "haml/filters/base"
+
+module Haml
+  class Filters
+    class Opal < Base
+      def mime_type
+      end
+      
+      def compile(node)
+        template = [:multi]
+        template << [:static, "<script type='#{mime_type}'>\n"]
+        template << [:static, ::Opal.compile(node.value[:text]) ]
+        template << [:static, "\n</script>"]
+        template
+      end
+    end
+    ::Opal::Config.esm ? 'module' : 'text/javascript'
+  end
+end
+
+Haml::Filters.registered[:opal] ||= Haml::Filters::Opal

data/lib/opal/rails/haml_filter.rb

@@ -1,24 +1,9 @@
-module Haml::Filters::Opal
-  include Haml::Filters::Base
+require 'haml'
 
-  def render_with_options ruby, options
-    text = ::Opal.compile(ruby)
+haml_version = Haml::VERSION.to_i
 
-    if options[:format] == :html5
-      type = ''
-    else
-      type = " type=#{options[:attr_wrapper]}text/javascript#{options[:attr_wrapper]}"
-    end
-
-    text.rstrip!
-    text.gsub!("\n", "\n    ")
-
-    <<HTML
-<script#{type}>
-  //<![CDATA[
-    #{text}
-  //]]>
-</script>
-HTML
-  end
+if haml_version < 6
+  require 'opal/rails/haml5_filter'
+else
+  require 'opal/rails/haml6_filter'
 end

data/lib/opal/rails/version.rb

@@ -1,5 +1,5 @@
 module Opal
   module Rails
-    VERSION = '2.0.2'
+    VERSION = '2.0.3'
   end
 end

data/opal-rails.gemspec

@@ -35,10 +35,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'opal',                '~> 1.0'
   spec.add_dependency 'opal-sprockets',      '~> 1.0'
 
+  spec.add_development_dependency 'haml'
+
   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 'cuprite'
   spec.add_development_dependency 'rspec-rails'
   spec.add_development_dependency 'appraisal', '~> 2.1'
   spec.add_development_dependency 'sqlite3'

data/spec/integration/haml_filter_spec.rb

@@ -0,0 +1,7 @@
+RSpec.describe 'HAML filter', type: :feature, js: true do
+  it 'works' do
+    visit '/application/haml_filter'
+    wait_for_dom_ready
+    expect(page.evaluate_script('Opal.gvars.haml_filter')).to eq("working")
+  end
+end

data/spec/spec_helper.rb

@@ -94,4 +94,24 @@ RSpec.configure do |config|
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
   Kernel.srand config.seed
+
+  # Configure Capybara
+  Capybara.javascript_driver = :cuprite
+  Capybara.register_driver(:cuprite) do |app|
+    Capybara::Cuprite::Driver.new(app,
+      window_size: [1200, 800],
+      browser_options: { 'no-sandbox': nil },
+      inspector: ENV['INSPECTOR'],
+      headless: !ENV['NO_HEADLESS'],
+      timeout: 20,
+      url_blacklist: [],
+    )
+  end
+
+  Capybara.register_server :puma do |app, port, host|
+    require 'rack/handler/puma'
+    Rack::Handler::Puma.run(app, Host: host, Port: port, Threads: "0:4", Silent: true)
+  end
+
+  Capybara.default_max_wait_time = 5
 end

data/spec/support/capybara.rb

@@ -1,14 +1,5 @@
 require 'capybara/rspec'
-require 'capybara/apparition'
-
-Capybara.javascript_driver = :apparition
-
-Capybara.register_server :puma do |app, port, host|
-  require 'rack/handler/puma'
-  Rack::Handler::Puma.run(app, Host: host, Port: port, Threads: "0:4", Silent: true)
-end
-
-Capybara.default_max_wait_time = 5
+require 'capybara/cuprite'
 
 module OpalHelper
   def compile_opal(code)

data/test_apps/app/application_controller.rb

@@ -12,6 +12,11 @@ puts 'hello from a script tag!'
 </script>
 HTML
 
+HAML = <<~HAML
+:opal
+  $haml_filter = :working
+HAML
+
 WITH_ASSIGNMENTS = File.read "#{__dir__}/assets/javascripts/with_assignments.js.rb"
 
 require_relative '../../app/helpers/opal_helper'
@@ -23,6 +28,7 @@ class ApplicationController < ActionController::Base
   self.view_paths = [ActionView::FixtureResolver.new(
     'layouts/application.html.erb'         => LAYOUT,
     'application/index.html.erb'           => INDEX,
+    'application/haml_filter.html.haml'    => HAML,
     'application/with_assignments.js.opal' => WITH_ASSIGNMENTS,
   )]
 
@@ -43,6 +49,9 @@ class ApplicationController < ActionController::Base
 
     render type: :js, locals: { local_var: 'i am local' }
   end
+
+  def haml_filter
+  end
 end
 
 Rails.logger = Logger.new(STDOUT) if $DEBUG

data/test_apps/app/assets/javascripts/with_assignments.js.rb

@@ -1,4 +1,4 @@
-return {
+{
   number_var: @number_var,
   string_var: @string_var,
   array_var:  @array_var,

data/test_apps/rails.rb

@@ -5,6 +5,7 @@ require 'rails/all'
 require 'action_view/testing/resolvers'
 
 require 'opal-rails' # our gem
+require 'opal/rails/haml_filter'
 
 module RailsApp
   class Application < Rails::Application
@@ -30,10 +31,11 @@ module RailsApp
     routes.append do
       get '/' => 'application#index'
       get '/application/with_assignments' => 'application#with_assignments'
+      get '/application/haml_filter' => 'application#haml_filter'
 
       # just to reduce noise
-      get '/apple-touch-icon-precomposed.png' => -> { [404,{},[]] }
-      get '/favicon.ico' => -> { [404,{},[]] }
+      get '/apple-touch-icon-precomposed.png' => proc { [404,{},[]] }
+      get '/favicon.ico' => proc { [404,{},[]] }
     end
 
     config.assets.debug = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-rails
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Elia Schito
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-29 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -72,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: execjs
   requirement: !ruby/object:Gem::Requirement
@@ -115,7 +129,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.25'
 - !ruby/object:Gem::Dependency
-  name: apparition
+  name: cuprite
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -214,14 +228,14 @@ files:
 - gemfiles/rails_6_0_opal_1_0.gemfile
 - gemfiles/rails_6_0_opal_1_1.gemfile
 - gemfiles/rails_6_0_opal_1_3.gemfile
-- gemfiles/rails_6_0_opal_1_4.gemfile
+- gemfiles/rails_6_0_opal_1_7.gemfile
 - gemfiles/rails_6_1_opal_1_0.gemfile
 - gemfiles/rails_6_1_opal_1_1.gemfile
 - gemfiles/rails_6_1_opal_1_3.gemfile
-- gemfiles/rails_6_1_opal_1_4.gemfile
+- gemfiles/rails_6_1_opal_1_7.gemfile
 - gemfiles/rails_7_0_opal_1_0.gemfile
 - gemfiles/rails_7_0_opal_1_3.gemfile
-- gemfiles/rails_7_0_opal_1_4.gemfile
+- gemfiles/rails_7_0_opal_1_7.gemfile
 - lib/assets/javascripts/opal_ujs.js.rb
 - lib/generators/opal/assets/assets_generator.rb
 - lib/generators/opal/assets/templates/javascript.js.rb
@@ -232,6 +246,8 @@ files:
 - lib/opal-rails.rb
 - lib/opal/rails.rb
 - lib/opal/rails/engine.rb
+- lib/opal/rails/haml5_filter.rb
+- lib/opal/rails/haml6_filter.rb
 - lib/opal/rails/haml_filter.rb
 - lib/opal/rails/slim_filter.rb
 - lib/opal/rails/template_handler.rb
@@ -239,6 +255,7 @@ files:
 - opal-rails.gemspec
 - spec/helpers/opal_helper_spec.rb
 - spec/integration/assigns_spec.rb
+- spec/integration/haml_filter_spec.rb
 - spec/integration/js_spec.rb
 - spec/integration/source_map_spec.rb
 - spec/spec_helper.rb
@@ -276,13 +293,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Rails bindings for opal JS engine
 test_files:
 - spec/helpers/opal_helper_spec.rb
 - spec/integration/assigns_spec.rb
+- spec/integration/haml_filter_spec.rb
 - spec/integration/js_spec.rb
 - spec/integration/source_map_spec.rb
 - spec/spec_helper.rb