vega 0.2.1 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30bfea4df021c4f5b65530adbc1c83f5a07f5bf323faf0b25e817f9b8e2d56b7
-  data.tar.gz: 06ab9a178a4edfea2a0360a95dd33eca2e3197bbdd196bb764c52114028ea511
+  metadata.gz: 7c067bc284fb8cb8d590bc3840e1903c6da0ba49f55f9c0cc784d88358d0ff5c
+  data.tar.gz: 22268adc67db09659c8b7701f893f6df63cbd34810845b6bdcd8a359364b0df1
 SHA512:
-  metadata.gz: f6e7098cdb5660031ab98e3838c9bb68d25bf338614fd41e0fe2b31588aef2c4953cce0059a61c0338075533de5a17076a050cf75ff95e52a2a0d46611dd6954
-  data.tar.gz: 9d79099d412b36555e9cacb5594d5022706760ea05a880606920b326b77a09f2d373433dc1f82dde49d451c3a76f035f8b6d7de1c197a1361c8735faee90919f
+  metadata.gz: 5257af439bd6fdb7530a3c036a75449fedb7b2a28efe0aa426761588f07e150de7327ce52dd8e138aebacb87c3ffdf7a484356d021395b37567c01217d0f4931
+  data.tar.gz: b360e400d2adb00623c8ec32b1d169260959e6a7b62f4d6723329aefc5177cfb8d60bb07d2d31c966d1442a126e787007bc0dae75eb0846eaf3cadcbc562ed0b

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 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
+- Removed automatic pinning for `importmap-rails` (still experimental)
+
 ## 0.2.1 (2021-10-24)
 
 - Added support for `nil` height

data/README.md

@@ -13,12 +13,12 @@ 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 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"
@@ -70,8 +78,8 @@ For Sinatra and other web frameworks, include the Vega JavaScript files on pages
 
 ```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="https://cdn.jsdelivr.net/npm/vega-lite@5.2.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/vega-embed@6.20.5"></script>
 ```
 
 ## Getting Started
@@ -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

@@ -34,8 +34,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.1"
+  VERSION = "0.2.5"
 end