vega 0.2.2 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455e0c4c1814906c620cc31ddd7ded69330f51b8722abfe23f895ab0bd0e47b0
-  data.tar.gz: 2264a6053aa5588decd30420935452f9c7426d707f5564ff05644e473a463296
+  metadata.gz: 12a40c67ddedf70381a6a20c4224bf028910fbf92e6c44c13ca31e5a2465d1a9
+  data.tar.gz: 1e33341d2b573078e6ee30984b8c7ba15638a26d1678c426eaf5ddb248796b8f
 SHA512:
-  metadata.gz: f08e7e57fc295a1f43c5ea0766c69582e6a4ece29dec97beefce16ace22665a3b09d26b9c0c1166628a0454d67f2f0e4f12a0e64d8edf2963c7980f9cb10dc09
-  data.tar.gz: 9e0f2da88f1fe97adb15d8135fd66b3b55782e2c103c7f26cd0290fddc0383ff3b7b4911240da7ce6dbd72da2ad06d6e544c4d512444bccd25f3edb1121b3009
+  metadata.gz: f3f04599a9a099d2572b0778ef6d7043993eb15bb46412ef8c31e6e2dff2bd6188ca20851969fd16d9dd1203c7ca6d36ef5ba437ab5e138344ba9564878aa813
+  data.tar.gz: caab809560db84c55fc8015804468e97b5bf5c7a89139436c9bc70b0229775f2b39db5c31109b783ab02e31a1fb0c27b5769e0d70165c005ddf594ff88e63495

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.2.6 (2022-02-02)
+
+- Added `vega_chart` helper
+- Added `nonce` option
+- Added `to_html` method
+
+## 0.2.5 (2022-01-22)
+
+- Updated Vega-Lite to 5.2.0 and Vega-Embed to 6.20.5
+
+## 0.2.4 (2022-01-15)
+
+- Support for `importmap-rails` is no longer experimental
+- Fixed asset precompilation error with `importmap-rails`
+
+## 0.2.3 (2021-11-15)
+
+- Updated Vega-Embed to 6.20.1 to fix spec version warnings
+- Fixed error with iRuby
+
 ## 0.2.2 (2021-11-06)
 
 - Added experimental support for exporting charts

data/README.md

@@ -13,12 +13,13 @@ Works with Rails, iRuby, and other frameworks
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'vega'
+gem "vega"
 ```
 
-The follow the instructions for how you plan to use it:
+Then follow the instructions for how you plan to use it:
 
-- [Rails 7 / Importmap](#rails-7--importmap) (experimental)
+- [Rails 7 / Importmap](#rails-7--importmap)
+- [Rails 7 / esbuild or Webpack](#rails-7--esbuild-or-webpack)
 - [Rails 6 / Webpacker](#rails-6--webpacker)
 - [Rails 5 / Sprockets](#rails-5--sprockets)
 - [iRuby](#iruby)
@@ -41,7 +42,24 @@ import "vega"
 import "vega-lite"
 import "vega-embed"
 
-window.dispatchEvent(new Event("vega:load"));
+window.dispatchEvent(new Event("vega:load"))
+```
+
+### Rails 7 / esbuild or Webpack
+
+Run:
+
+```sh
+yarn add vega vega-lite vega-embed
+```
+
+And add to `app/javascript/application.js`:
+
+```js
+import embed from "vega-embed"
+
+window.vegaEmbed = embed
+window.dispatchEvent(new Event("vega:load"))
 ```
 
 ### Rails 6 / Webpacker
@@ -74,12 +92,12 @@ No additional set up is needed.
 
 ### Other
 
-For Sinatra and other web frameworks, include the Vega JavaScript files on pages with charts:
+For Sinatra and other web frameworks, download [Vega](https://cdn.jsdelivr.net/npm/vega@5), [Vega-Lite](https://cdn.jsdelivr.net/npm/vega-lite@5), and [Vega-Embed](https://cdn.jsdelivr.net/npm/vega-embed@6) and include them on pages with charts:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/vega@5.21.0"></script>
-<script src="https://cdn.jsdelivr.net/npm/vega-lite@5.1.1"></script>
-<script src="https://cdn.jsdelivr.net/npm/vega-embed@6.19.1"></script>
+<script src="vega.js"></script>
+<script src="vega-lite.js"></script>
+<script src="vega-embed.js"></script>
 ```
 
 ## Getting Started
@@ -324,7 +342,7 @@ spec = {
 And render it in Rails
 
 ```erb
-<%= Vega.render(spec) %>
+<%= vega_chart spec %>
 ```
 
 Or display it in iRuby
@@ -367,6 +385,29 @@ File.binwrite("chart.pdf", chart.to_pdf)
 
 ## Content Security Policy (CSP)
 
+### Styles and Frames
+
+Enable unsafe inline styles and blob frames on actions that have charts
+
+```ruby
+class ChartsController < ApplicationController
+  content_security_policy only: :index do |policy|
+    policy.style_src :self, :unsafe_inline
+    policy.frame_src :blob
+  end
+end
+```
+
+### Nonce
+
+Automatically add a nonce when configured in Rails with:
+
+```erb
+<%= vega_chart chart %>
+```
+
+### Interpreter
+
 By default, the Vega parser uses the Function constructor, which [can cause issues with CSP](https://vega.github.io/vega/usage/interpreter/).
 
 For Rails 7 / Importmap, add to `config/importmap.rb`:

data/lib/vega/base_chart.rb

@@ -18,14 +18,20 @@ module Vega
     end
     immutable_method :embed_options
 
-    def to_s
-      Spec.new(spec).to_s
+    def to_html(nonce: nil)
+      Spec.new(spec).to_html(nonce: nonce)
     end
+    alias_method :to_s, :to_html
 
     def to_iruby
       Spec.new(spec).to_iruby
     end
 
+    # for https://github.com/SciRuby/iruby/issues/314
+    def to_iruby_mimebundle(**)
+      [[to_iruby].to_h, {}]
+    end
+
     def to_json
       spec.to_json
     end

data/lib/vega/engine.rb

@@ -3,8 +3,8 @@ module Vega
     # for assets
 
     # for importmap
-    if defined?(Importmap)
-      initializer "vega.importmap", after: "importmap" do |app|
+    initializer "vega.importmap" do |app|
+      if defined?(Importmap)
         app.config.assets.precompile << "vega-embed.js"
         app.config.assets.precompile << "vega-interpreter.js"
         app.config.assets.precompile << "vega-lite.js"

data/lib/vega/helper.rb

@@ -0,0 +1,29 @@
+module Vega
+  module Helper
+    def vega_chart(chart, nonce: true)
+      unless chart.is_a?(Vega::BaseChart) || chart.is_a?(Hash)
+        raise TypeError, "expected Vega chart or spec"
+      end
+
+      if nonce == true
+        # Secure Headers also defines content_security_policy_nonce but it takes an argument
+        # Rails 5.2 overrides this method, but earlier versions do not
+        if respond_to?(:content_security_policy_nonce) && (content_security_policy_nonce rescue nil)
+          # Rails 5.2
+          nonce = content_security_policy_nonce
+        elsif respond_to?(:content_security_policy_script_nonce)
+          # Secure Headers
+          nonce = content_security_policy_script_nonce
+        else
+          nonce = nil
+        end
+      end
+
+      if chart.is_a?(Hash)
+        Vega.render(chart, nonce: nonce)
+      else
+        chart.to_html(nonce: nonce)
+      end
+    end
+  end
+end

data/lib/vega/spec.rb

@@ -6,11 +6,12 @@ module Vega
       @spec = spec.transform_keys!(&:to_s)
     end
 
-    def to_s
+    def to_html(nonce: nil)
       html, js = generate_output
+      nonce_html = nonce ? " nonce=\"#{ERB::Util.html_escape(nonce)}\"" : nil
       output = <<~EOS
         #{html}
-        <script>
+        <script#{nonce_html}>
           (function() {
             var createChart = function() { #{js} };
             if ("vegaEmbed" in window) {
@@ -23,6 +24,7 @@ module Vega
       EOS
       output.respond_to?(:html_safe) ? output.html_safe : output
     end
+    alias_method :to_s, :to_html
 
     # TODO only load vega-lite if $schema requires it
     def to_iruby
@@ -34,8 +36,8 @@ module Vega
             paths: {
               'vega': 'https://cdn.jsdelivr.net/npm/vega@5.21.0/build/vega.min',
               'vega-util': 'https://cdn.jsdelivr.net/npm/vega-util@1.17.0/build/vega-util.min',
-              'vega-lite': 'https://cdn.jsdelivr.net/npm/vega-lite@5.1.1/build/vega-lite.min',
-              'vega-embed': 'https://cdn.jsdelivr.net/npm/vega-embed@6.19.1/build/vega-embed.min'
+              'vega-lite': 'https://cdn.jsdelivr.net/npm/vega-lite@5.2.0/build/vega-lite.min',
+              'vega-embed': 'https://cdn.jsdelivr.net/npm/vega-embed@6.20.5/build/vega-embed.min'
             }
           });
           require(['vega', 'vega-util', 'vega-lite', 'vega-embed'], function(vega, vegaUtil, vegaLite, vegaEmbed) {

data/lib/vega/version.rb

@@ -1,3 +1,3 @@
 module Vega
-  VERSION = "0.2.2"
+  VERSION = "0.2.6"
 end

data/lib/vega.rb

@@ -9,6 +9,7 @@ require "vega/base_chart"
 require "vega/chart"
 require "vega/lite_chart"
 require "vega/spec"
+require "vega/helper"
 require "vega/version"
 
 # integrations
@@ -25,8 +26,8 @@ module Vega
       LiteChart.new
     end
 
-    def render(spec)
-      Spec.new(spec).to_s
+    def render(spec, nonce: nil)
+      Spec.new(spec).to_html(nonce: nonce)
     end
 
     def display(spec)
@@ -34,3 +35,9 @@ module Vega
     end
   end
 end
+
+if defined?(ActiveSupport.on_load)
+  ActiveSupport.on_load(:action_view) do
+    include Vega::Helper
+  end
+end