opal-rails 1.0.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1667d89f71ac1e122af6ac49faa4de25629c6d05c6c8fa3efa3dac2dcac905e7
-  data.tar.gz: 875c55723b127a58a9419d2ee1c5c7bf563504d38b271c0377b9f745499c96ad
+  metadata.gz: 165e5b957c73079681eae29566b10478bddd1bb0a959d7cc2ce772ffe5778b85
+  data.tar.gz: 4f6dd4337a2f84796852b4ceb87e15decb2ae85afdc1c5012c1f0ab586c08e1c
 SHA512:
-  metadata.gz: c46c91b5f4b67cd7c085ffcf66a40c094cbbb1fe33cc3fd6adf7e5b7a168d6fac2085dbd0242e8e0cf7fbeeee75aff578d8fa189ad34d83b1c00d5827818c7f4
-  data.tar.gz: ede7e20e01eacc30da85dcda3409b7cabdd83c64c3f29f13c455a83c7dd6063f1e19ed6db389e8d8a792b870ccc8974066f1ec59bd687bcfb8f12cc3be494511
+  metadata.gz: 4537a41a8f9c848acbf0a440aa1767d5f40737dca75e62e8711efd860a369a44d8c093c2d981ee759090b135b42720a35953f65a559be21fbd86c04763ed9f8d
+  data.tar.gz: '05853c6bb0945b217118c92af19694771a3b8fe35207fe8c2ca1e4906b652808fab63beb25e0b96efdc00f1c979abfa9e1ad36864afe35ad1e58b94db0bccb58'

data/.github/workflows/{main.yml → build.yml}

@@ -1,13 +1,20 @@
-name: CI
-on: [push]
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - ci-check
+      - "*/ci-check"
+      - master
 
 jobs:
   build:
     strategy:
       matrix:
-        ruby: ['2.5.x', '2.6.x']
-        rails: ['rails_5_1', 'rails_5_2', 'rails_6_0']
-        opal: ['opal_1_0', 'opal_master']
+        ruby: ['2.5.x', '2.6.x', '2.7.x', '3.0.x']
+        rails: ['rails_6_0', 'rails_6_1']
+        opal: ['opal_1_0', 'opal_1_1']
     runs-on: ubuntu-latest
 
     steps:

data/.gitignore

@@ -1,3 +1,4 @@
+/sandbox
 /.bundle/
 /log/*.log
 /pkg/

data/Appraisals

@@ -7,33 +7,24 @@ ENV['OPAL_VERSION'] = nil # ensure the env is clean
 github = -> repo_name { "https://github.com/#{repo_name}.git" }
 
 {
-
-  opal_master: -> gemfile do
-    gemfile.gem 'opal', git: github['opal/opal'], branch: :master
-    gemfile.gem 'opal-rspec', git: github['opal/opal-rspec'], branch: :master
-    gemfile.gem 'opal-sprockets', git: github['opal/opal-sprockets'], branch: :master
+  opal_1_1: -> gemfile do
+    gemfile.gem 'opal', '~> 1.1.0'
+    gemfile.gem 'opal-sprockets'
   end,
 
   opal_1_0: -> gemfile do
     gemfile.gem 'opal', '~> 1.0.0'
-    gemfile.gem 'opal-rspec', git: github['opal/opal-rspec'], branch: :master
-    gemfile.gem 'opal-jquery', git: github['opal/opal-jquery'], branch: :master
     gemfile.gem 'opal-sprockets'
   end,
 
 }.each do |opal_version, gem_opal|
-  appraise "rails_5_1_#{opal_version}" do
-    gem "rails", "~> 5.1.0"
-    gem_opal[self]
-  end if current_ruby >= ruby_2_4_0
-
-  appraise "rails_5_2_#{opal_version}" do
-    gem "rails", "~> 5.2.0"
-    gem_opal[self]
-  end if current_ruby >= ruby_2_4_0
-
   appraise "rails_6_0_#{opal_version}" do
     gem "rails", "~> 6.0.0"
     gem_opal[self]
   end if current_ruby >= ruby_2_5_0
+
+  appraise "rails_6_1_#{opal_version}" do
+    gem "rails", "~> 6.1.0"
+    gem_opal[self]
+  end if current_ruby >= ruby_2_5_0
 end

data/CHANGELOG.md

@@ -20,6 +20,72 @@ Whitespace conventions:
 
 
 
+## [2.0.1](https://github.com/opal/opal-rails/compare/v2.0.0...v2.0.1) - 2021-03-03
+
+
+### Added
+
+- The install generator now will add an `opal.rb` initializer with a default compiler configuration and the template assign support disabled
+
+### Fixed
+
+- The install generator was missing a newline when changing the app layout
+
+
+## [2.0.0](https://github.com/opal/opal-rails/compare/v1.1.2...v2.0.0) - 2021-02-23
+
+*This is a major version, since a number of dependencies are going to be opt-in and support for older Rails
+and Sprockets versions is dropped*
+
+### Added
+
+- Added support for Rails v6.1
+- Added a generator for the initial setup (`bin/rails generate opal:install`) that will configure sprockets and create the main `application.js.rb`
+
+### Changed
+
+- Now the template handler will encode/decode local and instance variables with ActiveSupport::JSON
+
+### Removed
+
+- Removed support for Rails 5.x
+- `opal-jquery` and `opal-activesupport` are no longer dependencies of `opal-rails`, if you need them you'll need to require and setup them manually
+
+
+## [1.1.2](https://github.com/opal/opal-rails/compare/v1.1.1...v1.1.2) - 2019-09-26
+
+
+### Fixed
+
+- Default `skip_onload` to `true` when `javascript_asset_tag` is in debug mode, otherwise some assets may be loaded in the browser after the main source, thus being never loading by the Opal runtime.
+
+
+
+
+## [1.1.1](https://github.com/opal/opal-rails/compare/v1.1.0...v1.1.1) - 2019-09-14
+
+
+### Fixed
+
+- Fix a problem with require order with regards to `opal-sprockets`.
+
+
+
+
+## [1.1.0](https://github.com/opal/opal-rails/compare/v1.0.1...v1.1.0) - 2019-09-14
+
+
+### Added
+
+- Added the ability to pass only locals or only ivars when reproducing assigns in Opal templates, `Rails.application.config.opal.assigns_in_templates` can now be set to `:locals` or `:ivars` in addition to the already possible `true`.
+
+
+### Changed
+
+- The template handler now allows for the new Rails 6 api taking in both the template object and a source argument, but still allows the old behavior
+
+
+
 
 ## [1.0.1](https://github.com/opal/opal-rails/compare/v1.0.0...v1.0.1) - 2019-09-07
 

data/Gemfile

@@ -2,10 +2,13 @@ source 'https://rubygems.org'
 gemspec
 github = -> repo { "https://github.com/#{repo}.git" }
 
-if ENV['OPAL_VERSION'] == 'master'
+case ENV['OPAL_VERSION']
+when 'local'
+  gem 'opal', path: '../opal'
+  gem 'opal-rspec', path: '../opal-rspec'
+  gem 'opal-sprockets', path: '../opal-sprockets'
+  gem 'pry'
+when 'master'
   gem 'opal', git: github['opal/opal'], branch: :master
-  gem 'opal-rspec', git: github['opal/opal-rspec'], branch: :master
   gem 'opal-sprockets', git: github['opal/opal-sprockets'], branch: :master
 end
-
-gem 'c_lexer'

data/README.md

@@ -1,19 +1,20 @@
 # Opal Rails
 
 [![Build Status](https://github.com/opal/opal-rails/workflows/CI/badge.svg)](https://github.com/opal/opal-rails/actions)
-[![Code Climate](https://img.shields.io/codeclimate/github/opal/opal-rails.svg)](https://codeclimate.com/github/opal/opal-rails)
+[![Maintainability](https://api.codeclimate.com/v1/badges/31dda24adcecb836348f/maintainability)](https://codeclimate.com/github/opal/opal-rails/maintainability)
 [![Gem Version](https://badge.fury.io/rb/opal-rails.svg)](http://badge.fury.io/rb/opal-rails)
 ![fun guaranteed](https://img.shields.io/badge/fun-guaranteed-brightgreen.svg)
 ![web scale](http://img.shields.io/badge/webscale-over%209000-green.svg)
 
 _Rails bindings for [Opal](http://opalrb.com). ([Changelog](https://github.com/opal/opal-rails/blob/master/CHANGELOG.md))_
 
-### Looking Webpack support? 👀
+### Looking for Webpack support? 👀
 
 If you want to integrate Opal via Webpack please refer to [opal-webpack-loader](https://github.com/isomorfeus/opal-webpack-loader#installation) installation instructions.
 
 ℹ️ Webpack and ES6 modules are not yet officially supported, but we're working on it thanks to the awesome work done in _opal-webpack-loader_.
 
+
 ## Installation
 
 In your `Gemfile`
@@ -22,28 +23,46 @@ In your `Gemfile`
 gem 'opal-rails'
 ```
 
-or when you build your new Rails app:
+Add `app/assets/javascript` to your asset-pipeline manifest in `app/assets/config/manifest.js`:
 
-```bash
-rails new <app-name> --javascript=opal
+```
+bin/rails opal:install
 ```
 
 
 ### Configuration
 
-Add your configuration in `config/initializers/assets.rb` with the following contents:
+#### For the compiler
+
+Add your configuration for the compiler:
+
+`config/initializers/opal.rb`
 
 ```ruby
 # Compiler options
-Rails.application.config.opal.method_missing           = true
-Rails.application.config.opal.optimized_operators      = true
-Rails.application.config.opal.arity_check              = !Rails.env.production?
-Rails.application.config.opal.const_missing            = true
+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
 ```
 
-For a full list of the available configuration options please refer to: [lib/opal/config.rb](https://github.com/opal/opal/blob/master/lib/opal/config.rb).
+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:
+
+`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
+```
+
+
+Local and instance variables will be sent down to the view after converting their values to JSON.
 
 
 ## Usage
@@ -182,7 +201,6 @@ Of course you need to require `haml-rails` separately since its presence is not
       Element.find('.comments').effect(:fade_in)
     end
   end
-
 ```
 
 
@@ -248,10 +266,34 @@ Opal.use_gem 'cannonbol'
 ```
 
 
+## Contributing
+
+Run the specs:
+
+```
+bin/setup
+bin/rake
+```
+
+Inspect the test app:
+
+```
+bin/rackup
+# visit localhost:9292
+```
+
+Tinker with a sandbox app:
+
+```
+bin/sandbox # will re-create the app
+bin/rails s # will start the sandbox app server
+# visit localhost:3000
+```
+
 
 ## License
 
-© 2012-2019 Elia Schito
+© 2012-2021 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/app/helpers/opal_helper.rb

@@ -10,20 +10,21 @@ module OpalHelper
   end
 
   def javascript_include_tag(*sources)
-    options = sources.extract_options!
+    options = sources.extract_options!.symbolize_keys
+    debug = options[:debug] != false
     skip_loader = options.delete(:skip_opal_loader)
-    skip_onload = options.delete(:force_opal_loader_tag)
+    force_opal_loader_tag = options.delete(:force_opal_loader_tag) || debug
 
-    return super(*sources, options) if skip_loader
+    return super(*sources, options) if skip_loader && !force_opal_loader_tag
 
     script_tags = "".html_safe
     sources.each do |source|
       load_asset_code = Opal::Sprockets.load_asset(source)
       loading_code = "if(window.Opal && Opal.modules[#{source.to_json}]){#{load_asset_code}}"
 
-      if skip_onload
+      if force_opal_loader_tag
         script_tags << super(source, options)
-        script_tags << javascript_tag(loading_code)
+        script_tags << "\n".html_safe + javascript_tag(loading_code)
       else
         script_tags << super(source, options.merge(onload: loading_code))
       end

data/bin/rackup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rackup' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rack", "rackup")

data/bin/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+if %w[e engine].include? ARGV.first
+  ARGV.shift # remove the first argument
+  exec "#{__dir__}/rails-engine", *ARGV
+else
+  exec "#{__dir__}/rails-sandbox", *ARGV
+end

data/bin/rails-engine

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/opal/rails/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rails-sandbox

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+app_root = 'sandbox'
+
+unless File.exist? "#{app_root}/bin/rails"
+  warn 'Creating the sandbox app...'
+  Dir.chdir "#{__dir__}/.." do
+    system "#{__dir__}/sandbox" or begin # rubocop:disable Style/AndOr
+      warn 'Automatic creation of the sandbox app failed'
+      exit 1
+    end
+  end
+end
+
+Dir.chdir app_root
+exec 'bin/rails', *ARGV

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")