vega 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c067bc284fb8cb8d590bc3840e1903c6da0ba49f55f9c0cc784d88358d0ff5c
-  data.tar.gz: 22268adc67db09659c8b7701f893f6df63cbd34810845b6bdcd8a359364b0df1
+  metadata.gz: 12a40c67ddedf70381a6a20c4224bf028910fbf92e6c44c13ca31e5a2465d1a9
+  data.tar.gz: 1e33341d2b573078e6ee30984b8c7ba15638a26d1678c426eaf5ddb248796b8f
 SHA512:
-  metadata.gz: 5257af439bd6fdb7530a3c036a75449fedb7b2a28efe0aa426761588f07e150de7327ce52dd8e138aebacb87c3ffdf7a484356d021395b37567c01217d0f4931
-  data.tar.gz: b360e400d2adb00623c8ec32b1d169260959e6a7b62f4d6723329aefc5177cfb8d60bb07d2d31c966d1442a126e787007bc0dae75eb0846eaf3cadcbc562ed0b
+  metadata.gz: f3f04599a9a099d2572b0778ef6d7043993eb15bb46412ef8c31e6e2dff2bd6188ca20851969fd16d9dd1203c7ca6d36ef5ba437ab5e138344ba9564878aa813
+  data.tar.gz: caab809560db84c55fc8015804468e97b5bf5c7a89139436c9bc70b0229775f2b39db5c31109b783ab02e31a1fb0c27b5769e0d70165c005ddf594ff88e63495

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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

data/README.md

@@ -19,6 +19,7 @@ gem "vega"
 Then follow the instructions for how you plan to use it:
 
 - [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.2.0"></script>
-<script src="https://cdn.jsdelivr.net/npm/vega-embed@6.20.5"></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,9 +18,10 @@ 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

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

data/lib/vega/version.rb

@@ -1,3 +1,3 @@
 module Vega
-  VERSION = "0.2.5"
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vega
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-23 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies: []
 description:
 email: andrew@ankane.org
@@ -23,6 +23,7 @@ files:
 - lib/vega/base_chart.rb
 - lib/vega/chart.rb
 - lib/vega/engine.rb
+- lib/vega/helper.rb
 - lib/vega/lite_chart.rb
 - lib/vega/method_helpers.rb
 - lib/vega/spec.rb