vega 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30bfea4df021c4f5b65530adbc1c83f5a07f5bf323faf0b25e817f9b8e2d56b7
-  data.tar.gz: 06ab9a178a4edfea2a0360a95dd33eca2e3197bbdd196bb764c52114028ea511
+  metadata.gz: 455e0c4c1814906c620cc31ddd7ded69330f51b8722abfe23f895ab0bd0e47b0
+  data.tar.gz: 2264a6053aa5588decd30420935452f9c7426d707f5564ff05644e473a463296
 SHA512:
-  metadata.gz: f6e7098cdb5660031ab98e3838c9bb68d25bf338614fd41e0fe2b31588aef2c4953cce0059a61c0338075533de5a17076a050cf75ff95e52a2a0d46611dd6954
-  data.tar.gz: 9d79099d412b36555e9cacb5594d5022706760ea05a880606920b326b77a09f2d373433dc1f82dde49d451c3a76f035f8b6d7de1c197a1361c8735faee90919f
+  metadata.gz: f08e7e57fc295a1f43c5ea0766c69582e6a4ece29dec97beefce16ace22665a3b09d26b9c0c1166628a0454d67f2f0e4f12a0e64d8edf2963c7980f9cb10dc09
+  data.tar.gz: 9e0f2da88f1fe97adb15d8135fd66b3b55782e2c103c7f26cd0290fddc0383ff3b7b4911240da7ce6dbd72da2ad06d6e544c4d512444bccd25f3edb1121b3009

data/CHANGELOG.md

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

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

@@ -50,5 +50,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

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vega
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-24 00:00:00.000000000 Z
+date: 2021-11-06 00:00:00.000000000 Z
 dependencies: []
 description:
 email: andrew@ankane.org
@@ -19,7 +19,6 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- config/importmap.rb
 - lib/vega.rb
 - lib/vega/base_chart.rb
 - lib/vega/chart.rb

data/config/importmap.rb

@@ -1 +0,0 @@
-pin_all_from File.expand_path("../vendor/assets/javascripts", __dir__)