vega 0.2.0 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81ef88e1766446a7d367331b58abcc2113a05cc3a914891dc81f5f82a026070f
-  data.tar.gz: 31f67095fcebf1cafa5bf8e50b81bf8a6830082d43bb383a7b6c299034907d24
+  metadata.gz: a585bb036b731a2eb4408f72112bba1d64d574e8cc11e12dd22b5df392340f25
+  data.tar.gz: 6d703da07e6ae89275f2999e46285df66825703fecccc352ee9747d3e167dad0
 SHA512:
-  metadata.gz: fbd22ed80b972dbbc1ab134755a4903b255b328963a8533e7e7cae29403cd1ac81aca3f84f8a0b0f42e93515a18d85a5ec582193a3a1d020f79527a66b8fd1aa
-  data.tar.gz: 19fad72d73ceddfaf669e3a0c0a970bdaeac5996018522e3acffca488533723e4e79a9609741399aefc1480a74891ac8f2b4db1a62540f107694fcc3e25e0a8d
+  metadata.gz: 2d5a50065d7b9cc715046d7f61cc406be7847e2ad91b0578b0de555e7659665f311034b1adfcfa31bd9f96e15fff240f6df6b6b4bb502d240fdf373711244e65
+  data.tar.gz: 297c9d86387858617ee12afb5fd44ae46929ea63c74f601240b8c53a79e50e0b6876496014caaa724f57b98eb20137309312657c7eb5f89250b0c1c70f6c73e3

data/CHANGELOG.md

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

data/README.md

@@ -16,9 +16,9 @@ Add this line to your application’s Gemfile:
 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 6 / Webpacker](#rails-6--webpacker)
 - [Rails 5 / Sprockets](#rails-5--sprockets)
 - [iRuby](#iruby)
@@ -26,7 +26,15 @@ The follow the instructions for how you plan to use it:
 
 ### Rails 7 / Importmap
 
-Add to `app/javascript/application.js`:
+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"
@@ -307,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"},
   # ...
 }
@@ -331,11 +339,43 @@ 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 `app/javascript/application.js`:
+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"

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, {}]
+    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

@@ -3,9 +3,8 @@ module Vega
     # for assets
 
     # for importmap
-    if defined?(Importmap)
-      initializer "vega.importmap", after: "importmap" do |app|
-        app.importmap.draw(Engine.root.join("config/importmap.rb"))
+    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/lite_chart.rb

@@ -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

@@ -32,10 +32,10 @@ module Vega
         <script>
           require.config({
             paths: {
-              'vega': 'https://cdn.jsdelivr.net/npm/vega@5.21.0?noext',
-              'vega-util': 'https://cdn.jsdelivr.net/npm/vega-util@1.17.0?noext',
-              'vega-lite': 'https://cdn.jsdelivr.net/npm/vega-lite@5.1.1?noext',
-              'vega-embed': 'https://cdn.jsdelivr.net/npm/vega-embed@6.19.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-util', 'vega-lite', 'vega-embed'], function(vega, vegaUtil, vegaLite, vegaEmbed) {
@@ -52,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.2.0"
+  VERSION = "0.2.4"
 end