opal-rails 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1667d89f71ac1e122af6ac49faa4de25629c6d05c6c8fa3efa3dac2dcac905e7
-  data.tar.gz: 875c55723b127a58a9419d2ee1c5c7bf563504d38b271c0377b9f745499c96ad
+  metadata.gz: 9689895c742592771f0b6486befa7cbca683f1cde5a61ae52ec7091ca39c0411
+  data.tar.gz: d48912a6dcd903b1465a045ded9084307b53930558a6b9dfbe4c3622e7c5ae42
 SHA512:
-  metadata.gz: c46c91b5f4b67cd7c085ffcf66a40c094cbbb1fe33cc3fd6adf7e5b7a168d6fac2085dbd0242e8e0cf7fbeeee75aff578d8fa189ad34d83b1c00d5827818c7f4
-  data.tar.gz: ede7e20e01eacc30da85dcda3409b7cabdd83c64c3f29f13c455a83c7dd6063f1e19ed6db389e8d8a792b870ccc8974066f1ec59bd687bcfb8f12cc3be494511
+  metadata.gz: 8621d6d34f9cf5b9901c7912a8a2f16b9b265f82f4ea7a6e87aef4f10206406d4bedb20e6bacb5545218fb70d05c8b41838912f5c8ed1250037d56e39caa1bcf
+  data.tar.gz: 1b858592dd83f05228e75d49c03bc4c33893e2657c396602734c6fc78fb27fc623e5bb6fce17026997f9dc76fcd81175059e663f53d6310a39519a98cb952517

data/CHANGELOG.md

@@ -21,6 +21,21 @@ Whitespace conventions:
 
 
 
+## [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/README.md

@@ -1,7 +1,7 @@
 # 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)
@@ -40,9 +40,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).
 
 
 

data/lib/opal/rails/engine.rb

@@ -12,6 +12,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

@@ -2,21 +2,28 @@ 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
+
+          if config.assign_locals_in_templates?
             code << JSON.parse(local_assigns.to_json).map { |key, val| "\#{key} = \#{val.inspect};" }.join
+          end
+
+          if config.assign_instance_variables_in_templates?
             code << JSON.parse(@_assigns.to_json).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 = '1.1.0'
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Elia Schito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-07 00:00:00.000000000 Z
+date: 2019-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -271,7 +271,6 @@ files:
 - spec/integration/assigns_spec.rb
 - spec/integration/js_spec.rb
 - spec/integration/source_map_spec.rb
-- spec/integration/template_spec.rb
 - spec/spec_helper.rb
 - spec/support/capybara.rb
 - spec/support/reset_assets_cache.rb
@@ -313,7 +312,6 @@ test_files:
 - spec/integration/assigns_spec.rb
 - spec/integration/js_spec.rb
 - spec/integration/source_map_spec.rb
-- spec/integration/template_spec.rb
 - spec/spec_helper.rb
 - spec/support/capybara.rb
 - spec/support/reset_assets_cache.rb

data/spec/integration/template_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-
-describe 'template handler' do
-  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
-end