vega 0.1.3 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3b596c09118b82dc1166f6413ff31aae7801b79db73f4dc2e09acab9ccfa21a
-  data.tar.gz: 9ce59baf66bfd278f457a7686d8d8b2e4aa9c6f046d99b1d1184d206b6a680a0
+  metadata.gz: 4e3a67fe76080049bf0aece9305b4b75830595582417ae7f041ffef56accae89
+  data.tar.gz: c8b284392d1d872ab214ee1a25226d0d682f8e39e5099d4c549ee52be803887a
 SHA512:
-  metadata.gz: 79c6c4705a054f0f9b9a4001f10496c1af17440ebf672c77ca856a35c9778c98ed40ce5f31ac90f31b05ec23df9640ff41d070b31b8466e8dec7930b1cf1a56d
-  data.tar.gz: ff0808b2c0cbaac73e266798cb048c6d0884e36b135f76bc5ebe74af5125a42a7e9a7018c22a7077a4c8530be431171cdc3b6d4a9e28a48643a24772b65537f7
+  metadata.gz: 2e9f5e249a6ad941fc37dee172ffdbe9d6d24b20b3376c49557762df5178cdaacdf535cd2d15780aeb0f68865cca23565ae8ecc1c18b47808c4d2c76b78193c1
+  data.tar.gz: dc8fa74465709a9ef563b49747efc27be0d93c04c44668e1d05ff049eb7a686030f4323dfb8c0ec3e10d871777719eb1c2bb52c844b851eaec37d29416712bc8

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 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
+- Removed automatic pinning for `importmap-rails` (still experimental)
+
+## 0.2.1 (2021-10-24)
+
+- Added support for `nil` height
+- Fixed source map warnings
+
+## 0.2.0 (2021-10-23)
+
+- Added experimental support for `importmap-rails`
+- Updated Vega to 5.21.0, Vega-Lite to 5.1.1, and Vega-Embed to 6.19.1
+
 ## 0.1.3 (2021-03-14)
 
 - Added Vega-Interpreter

data/README.md

@@ -6,7 +6,7 @@ Interactive charts for Ruby, powered by [Vega](https://vega.github.io/vega/) and
 
 Works with Rails, iRuby, and other frameworks
 
-[![Build Status](https://github.com/ankane/vega/workflows/build/badge.svg?branch=master)](https://github.com/ankane/vega/actions)
+[![Build Status](https://github.com/ankane/vega-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/vega-ruby/actions)
 
 ## Installation
 
@@ -18,11 +18,32 @@ gem 'vega'
 
 The follow the instructions for how you plan to use it:
 
+- [Rails 7 / Importmap](#rails-7--importmap) (experimental)
 - [Rails 6 / Webpacker](#rails-6--webpacker)
 - [Rails 5 / Sprockets](#rails-5--sprockets)
 - [iRuby](#iruby)
 - [Other](#other)
 
+### Rails 7 / Importmap
+
+Add to `config/importmap.rb`:
+
+```ruby
+pin "vega", to: "vega.js"
+pin "vega-lite", to: "vega-lite.js"
+pin "vega-embed", to: "vega-embed.js"
+```
+
+And add to `app/javascript/application.js`:
+
+```js
+import "vega"
+import "vega-lite"
+import "vega-embed"
+
+window.dispatchEvent(new Event("vega:load"));
+```
+
 ### Rails 6 / Webpacker
 
 Run:
@@ -56,9 +77,9 @@ No additional set up is needed.
 For Sinatra and other web frameworks, include the Vega JavaScript files on pages with charts:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/vega@5.19.1"></script>
-<script src="https://cdn.jsdelivr.net/npm/vega-lite@4.17.0"></script>
-<script src="https://cdn.jsdelivr.net/npm/vega-embed@6.15.1"></script>
+<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>
 ```
 
 ## Getting Started
@@ -294,7 +315,7 @@ You can also create a specification by hand
 
 ```ruby
 spec = {
-  "$schema" => "https://vega.github.io/schema/vega-lite/v4.json",
+  "$schema" => "https://vega.github.io/schema/vega-lite/v5.json",
   "data" => {"url" => "https://www.example.com"},
   # ...
 }
@@ -318,10 +339,48 @@ Get the spec for a chart
 chart.spec
 ```
 
+## Exporting Charts (experimental)
+
+Export charts to PNG, SVG, or PDF. This requires Node.js and npm 7+. Run:
+
+```sh
+yarn add vega-cli vega-lite
+```
+
+For PNG, use:
+
+```ruby
+File.binwrite("chart.png", chart.to_png)
+```
+
+For SVG, use:
+
+```ruby
+File.binwrite("chart.svg", chart.to_svg)
+```
+
+For PDF, use:
+
+```ruby
+File.binwrite("chart.pdf", chart.to_pdf)
+```
+
 ## Content Security Policy (CSP)
 
 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`:
+
+```ruby
+pin "vega-interpreter", to: "vega-interpreter.js"
+```
+
+And add to `app/javascript/application.js`:
+
+```js
+import "vega-interpreter"
+```
+
 For Rails 6 / Webpacker, run:
 
 ```sh
@@ -342,22 +401,22 @@ embed_options(ast: true)
 
 ## History
 
-View the [changelog](https://github.com/ankane/vega/blob/master/CHANGELOG.md)
+View the [changelog](https://github.com/ankane/vega-ruby/blob/master/CHANGELOG.md)
 
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:
 
-- [Report bugs](https://github.com/ankane/vega/issues)
-- Fix bugs and [submit pull requests](https://github.com/ankane/vega/pulls)
+- [Report bugs](https://github.com/ankane/vega-ruby/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/vega-ruby/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
 
 To get started with development:
 
 ```sh
-git clone https://github.com/ankane/vega.git
-cd vega
+git clone https://github.com/ankane/vega-ruby.git
+cd vega-ruby
 bundle install
 bundle exec rake test
 ```

data/lib/vega/base_chart.rb

@@ -26,6 +26,11 @@ module Vega
       Spec.new(spec).to_iruby
     end
 
+    # for https://github.com/SciRuby/iruby/issues/314
+    def to_iruby_mimebundle(**)
+      [[to_iruby].to_h, nil]
+    end
+
     def to_json
       spec.to_json
     end
@@ -50,5 +55,15 @@ module Vega
         value
       end
     end
+
+    def export(cmd)
+      require "open3"
+
+      pkg = cmd.start_with?("vg") ? "vega-cli" : "vega-lite"
+      # use --no to prevent automatic installs
+      stdout, stderr, status = Open3.capture3("npm", "exec", "--no", "--package=#{pkg}", "--", cmd, stdin_data: to_json, binmode: true)
+      raise "Command failed: #{stderr}" unless status.success? && stdout.bytesize > 0
+      stdout
+    end
   end
 end

data/lib/vega/chart.rb

@@ -23,5 +23,17 @@ module Vega
       self
     end
     immutable_method :data
+
+    def to_png
+      export("vg2png")
+    end
+
+    def to_svg
+      export("vg2svg")
+    end
+
+    def to_pdf
+      export("vg2pdf")
+    end
   end
 end

data/lib/vega/engine.rb

@@ -1,5 +1,15 @@
 module Vega
   class Engine < ::Rails::Engine
     # for assets
+
+    # for importmap
+    if defined?(Importmap)
+      initializer "vega.importmap", after: "importmap" do |app|
+        app.config.assets.precompile << "vega-embed.js"
+        app.config.assets.precompile << "vega-interpreter.js"
+        app.config.assets.precompile << "vega-lite.js"
+        app.config.assets.precompile << "vega.js"
+      end
+    end
   end
 end

data/lib/vega/lite_chart.rb

@@ -11,7 +11,7 @@ module Vega
       :transform, :layer, :hconcat, :vconcat, :concat
 
     def initialize
-      @schema = "https://vega.github.io/schema/vega-lite/v4.json"
+      @schema = "https://vega.github.io/schema/vega-lite/v5.json"
       super()
     end
 
@@ -29,5 +29,17 @@ module Vega
         dup.spec!(*args)
       end
     end
+
+    def to_png
+      export("vl2png")
+    end
+
+    def to_svg
+      export("vl2svg")
+    end
+
+    def to_pdf
+      export("vl2pdf")
+    end
   end
 end

data/lib/vega/spec.rb

@@ -11,7 +11,14 @@ module Vega
       output = <<~EOS
         #{html}
         <script>
-          #{js}
+          (function() {
+            var createChart = function() { #{js} };
+            if ("vegaEmbed" in window) {
+              createChart();
+            } else {
+              window.addEventListener("vega:load", createChart, true);
+            }
+          })();
         </script>
       EOS
       output.respond_to?(:html_safe) ? output.html_safe : output
@@ -25,12 +32,13 @@ module Vega
         <script>
           require.config({
             paths: {
-              'vega': 'https://cdn.jsdelivr.net/npm/vega@5.19.1?noext',
-              'vega-lite': 'https://cdn.jsdelivr.net/npm/vega-lite@4.17.0?noext',
-              'vega-embed': 'https://cdn.jsdelivr.net/npm/vega-embed@6.15.1?noext'
+              '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.20.1/build/vega-embed.min'
             }
           });
-          require(['vega', 'vega-lite', 'vega-embed'], function(vega, vegaLite, vegaEmbed) {
+          require(['vega', 'vega-util', 'vega-lite', 'vega-embed'], function(vega, vegaUtil, vegaLite, vegaEmbed) {
             #{js}
           });
         </script>
@@ -44,6 +52,7 @@ module Vega
       id = "chart-#{SecureRandom.hex(16)}" # 2**128 values
       width = @spec["width"].is_a?(Integer) ? "#{@spec["width"]}px" : "100%"
       height = @spec["height"].is_a?(Integer) ? "#{@spec["height"]}px" : "300px"
+      height = "auto" if @spec["height"].nil?
 
       # user can override with usermeta: {embedOptions: ...}
       embed_options = {actions: false}

data/lib/vega/version.rb

@@ -1,3 +1,3 @@
 module Vega
-  VERSION = "0.1.3"
+  VERSION = "0.2.3"
 end

data/licenses/LICENSE-vega.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015-2018, University of Washington Interactive Data Lab
+Copyright (c) 2015-2021, University of Washington Interactive Data Lab
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without