opal-rails 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9327fdd3f720f1807ebcde09f2901c1e017615c9fa8f4f910ec6483ade3216c6
-  data.tar.gz: 0c014f66ab2633363b0ab40afa1b72b4e2c0f09d2e524a202ace14b61d979080
+  metadata.gz: 49586db0f49f4f31e3e289e1f813275e1b81ab083aa5e771887e5e93bc08b83b
+  data.tar.gz: 02d8db2458c45f4fe2554028571288b2664f8cfc64bba320a62d59a9ea120567
 SHA512:
-  metadata.gz: 7e667155ae6975139b8f1e1359733a61cf9b511e591a1663a7ed8a2b2068e9ae7be506798842f48091fd311394c7fcbed6d222c2f1f44f995d06957007adc7e9
-  data.tar.gz: 190642ae14e588b7875d9698f19f1c7b532858cf217d184df759b64d67bfb694d4865cd1d6c1f94915bd7ba1347d6644e081cabd43b7769af4dd4d821647bb50
+  metadata.gz: ec6e2d6ce3226094ef31bcb2b75a5317b7d0a1e05cb3af627022dfd00697787ad1ed6fdd739cfb485a741685e4cfd8b746d3fb29a1e4a29b6bcc1b6163aef362
+  data.tar.gz: eac8d359fbd8589edd16c7df490a619fe9d2e3a09640ab0d1d14ece16cd5f6d1fa31cb2d82f9bacb8ffe8bf6bf164a565ff72181e89f109f45566992d8a72631

data/.github/workflows/build.yml

@@ -0,0 +1,38 @@
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - ci-check
+      - "*/ci-check"
+      - master
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        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:
+    - name: Install libraries
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y sqlite3 libsqlite3-dev
+    - uses: actions/checkout@v1
+    - name: Set up Ruby
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Install Dependencies
+      run: |
+        export BUNDLE_GEMFILE="gemfiles/${{ matrix.rails }}_${{ matrix.opal }}.gemfile"
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Test with Rake
+      run: |
+        export BUNDLE_GEMFILE="gemfiles/${{ matrix.rails }}_${{ matrix.opal }}.gemfile"
+        bundle exec rake

data/.gitignore

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

data/Appraisals

@@ -1,34 +1,30 @@
 current_ruby = Gem::Version.new(RUBY_VERSION)
-ruby_2_2_2 = Gem::Version.new('2.2.2')
 ruby_2_4_0 = Gem::Version.new('2.4.0')
+ruby_2_5_0 = Gem::Version.new('2.5.0')
 
 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"
+  appraise "rails_6_0_#{opal_version}" do
+    gem "rails", "~> 6.0.0"
     gem_opal[self]
-  end if current_ruby >= ruby_2_2_2
+  end if current_ruby >= ruby_2_5_0
 
-  appraise "rails_5_2_#{opal_version}" do
-    gem "rails", "~> 5.2.0"
+  appraise "rails_6_1_#{opal_version}" do
+    gem "rails", "~> 6.1.0"
     gem_opal[self]
-  end if current_ruby >= ruby_2_2_2
+  end if current_ruby >= ruby_2_5_0
 end

data/CHANGELOG.md

@@ -18,6 +18,67 @@ Whitespace conventions:
 - 1 spaces before normal text
  -->
 
+## [2.0](https://github.com/opal/opal-rails/compare/v1.1.2...v2.0.0) - unreleased
+
+*Bumping a major version, since this version will make a number of dependencies opt-in and drop older Rails and Sprockets versions*
+
+### 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
+
+
+### Added
+
+- Added support for Rails v6.0 (Sprockets)
+
 
 
 
@@ -43,6 +104,7 @@ Whitespace conventions:
 
 
 
+
 ## [0.9.5](https://github.com/opal/opal-rails/compare/v0.9.4...v0.9.5) - 2018-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,13 +1,18 @@
 # Opal Rails
 
-[![Build Status](https://secure.travis-ci.org/opal/opal-rails.svg)](http://travis-ci.org/opal/opal-rails)
-[![Code Climate](https://img.shields.io/codeclimate/github/opal/opal-rails.svg)](https://codeclimate.com/github/opal/opal-rails)
+[![Build Status](https://github.com/opal/opal-rails/workflows/CI/badge.svg)](https://github.com/opal/opal-rails/actions)
+[![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 Ruby](http://opalrb.com) engine. ([Changelog](https://github.com/opal/opal-rails/blob/master/CHANGELOG.md))_
+_Rails bindings for [Opal](http://opalrb.com). ([Changelog](https://github.com/opal/opal-rails/blob/master/CHANGELOG.md))_
 
+### 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
@@ -18,10 +23,10 @@ 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
 ```
 
 
@@ -36,9 +41,17 @@ 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.dynamic_require_severity = :ignore
+
+# Other options
+
+# Send local and instance variables down to the view after converting
+# thier value with `.to_json`
+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
 ```
 
-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).
+For a full list of the available configuration options for the compiler please refer to: [lib/opal/config.rb](https://github.com/opal/opal/blob/master/lib/opal/config.rb).
 
 
 
@@ -178,7 +191,6 @@ Of course you need to require `haml-rails` separately since its presence is not
       Element.find('.comments').effect(:fade_in)
     end
   end
-
 ```
 
 
@@ -244,10 +256,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-2016 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")