vega 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52225cdedf189b9d6c9b589c52fd7bb10d6c9aa1dc17685b920b60fabee42d66
-  data.tar.gz: 82dd13b27708aa6ad57e4358d75c4913e232c8f85b4eb2768598dc53d81f82fd
+  metadata.gz: 81ef88e1766446a7d367331b58abcc2113a05cc3a914891dc81f5f82a026070f
+  data.tar.gz: 31f67095fcebf1cafa5bf8e50b81bf8a6830082d43bb383a7b6c299034907d24
 SHA512:
-  metadata.gz: c1ed453f8f337c3863dadafe79a8e44a3a22896fc114c6de6e9b3646908deb86b9fb3d76d826a174ee21722a1b2a4ba9905ad13b2594592d074cd3611fa37bbd
-  data.tar.gz: 58be98b855093e3b6f554fc094a85cf5f79dd3efd10304cb5ba0bd05749277a66fba1e4f1e2c502af401cea6b9ca7269f40bdbb6b8d6e8c37033def50bc5119f
+  metadata.gz: fbd22ed80b972dbbc1ab134755a4903b255b328963a8533e7e7cae29403cd1ac81aca3f84f8a0b0f42e93515a18d85a5ec582193a3a1d020f79527a66b8fd1aa
+  data.tar.gz: 19fad72d73ceddfaf669e3a0c0a970bdaeac5996018522e3acffca488533723e4e79a9609741399aefc1480a74891ac8f2b4db1a62540f107694fcc3e25e0a8d

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## 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
+
+## 0.1.2 (2021-02-09)
+
+- Updated Vega to 5.19.1, Vega-Lite to 4.17.0, and Vega-Embed to 6.15.1
+
+## 0.1.1 (2020-09-27)
+
+- Added `repeat`, `resolve`, `spec` and `selection` methods
+- Added `hconcat` and `vconcat` methods
+- Added support for Daru data frames
+
 ## 0.1.0 (2020-09-26)
 
 - First release

data/LICENSE.txt

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2020, Andrew Kane.
+Copyright (c) 2020-2021, Andrew Kane.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/README.md

@@ -2,8 +2,12 @@
 
 Interactive charts for Ruby, powered by [Vega](https://vega.github.io/vega/) and [Vega-Lite](https://vega.github.io/vega-lite/)
 
+[See it in action](https://vega.dokkuapp.com)
+
 Works with Rails, iRuby, and other frameworks
 
+[![Build Status](https://github.com/ankane/vega-ruby/workflows/build/badge.svg?branch=master)](https://github.com/ankane/vega-ruby/actions)
+
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -14,11 +18,24 @@ gem 'vega'
 
 The follow the instructions for how you plan to use it:
 
-- [Rails 6 / Webpacker](#rails)
-- [Rails 5 / Sprockets](#rails)
+- [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 `app/javascript/application.js`:
+
+```js
+import "vega"
+import "vega-lite"
+import "vega-embed"
+
+window.dispatchEvent(new Event("vega:load"));
+```
+
 ### Rails 6 / Webpacker
 
 Run:
@@ -52,9 +69,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.16.1"></script>
-<script src="https://cdn.jsdelivr.net/npm/vega-lite@4.16.2"></script>
-<script src="https://cdn.jsdelivr.net/npm/vega-embed@6.12.2"></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
@@ -78,23 +95,11 @@ Create a bar chart
 
 ```ruby
 Vega.lite
-  .data(
-    values: [
-      {a: "A", b: 28},
-      {a: "B", b: 55},
-      {a: "C", b: 43},
-      {a: "D", b: 91},
-      {a: "E", b: 81},
-      {a: "F", b: 53},
-      {a: "G", b: 19},
-      {a: "H", b: 87},
-      {a: "I", b: 52}
-    ]
-  )
+  .data([{city: "A", sales: 28}, {city: "B", sales: 55}, {city: "C", sales: 43}])
   .mark(type: "bar", tooltip: true)
   .encoding(
-    x: {field: "a", type: "ordinal"},
-    y: {field: "b", type: "quantitative"}
+    x: {field: "city", type: "nominal"},
+    y: {field: "sales", type: "quantitative"}
   )
 ```
 
@@ -116,22 +121,28 @@ Vega.lite
 
 [Docs](https://vega.github.io/vega-lite/docs/data.html)
 
-The data source can be an array
+Data can be an array
 
 ```ruby
-data(values: [{x: "A", y: 1}, {x: "B", y: 2}])
+data([{x: "A", y: 1}, {x: "B", y: 2}])
 ```
 
 Or a URL
 
 ```ruby
-data(url: "https://www.example.com")
+data("https://www.example.com/data.json")
 ```
 
-You can also specify the data format
+Or a Rover data frame
 
 ```ruby
-data(url: "https://www.example.com/data.csv", format: {type: "csv"})
+data(df)
+```
+
+Or a data generator
+
+```ruby
+data(sequence: {start: 0, stop: 10, step: 1, as: "x"})
 ```
 
 ### Transforms
@@ -192,7 +203,51 @@ encoding(x: {field: "a", type: "ordinal"})
 projection(type: "albersUsa")
 ```
 
-### Configuration
+### View Composition
+
+[Docs](https://vega.github.io/vega-lite/docs/composition.html)
+
+Faceting
+
+```ruby
+facet(row: {field: "x"})
+```
+
+Layering
+
+```ruby
+layer(view)
+```
+
+Concatenation
+
+```ruby
+hconcat(view)
+vconcat(view)
+concat(view)
+```
+
+Repeating
+
+```ruby
+repeat(row: ["a", "b", "c"])
+```
+
+Resolving
+
+```ruby
+resolve(scale: {color: "independent"})
+```
+
+### Selections
+
+[Docs](https://vega.github.io/vega-lite/docs/selection.html)
+
+```ruby
+selection(x: {type: "single"})
+```
+
+### Config
 
 [Docs](https://vega.github.io/vega-lite/docs/config.html)
 
@@ -276,24 +331,52 @@ Get the spec for a chart
 chart.spec
 ```
 
+## 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`:
+
+```js
+import "vega-interpreter"
+```
+
+For Rails 6 / Webpacker, run:
+
+```sh
+yarn add vega-interpreter
+```
+
+For Rails 5 / Sprockets, add to `app/assets/javascripts/application.js`:
+
+```js
+//= require vega-interpreter
+```
+
+And set embed options for your charts
+
+```ruby
+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/config/importmap.rb

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

data/lib/vega/base_chart.rb

@@ -2,8 +2,6 @@ module Vega
   class BaseChart
     extend MethodHelpers
 
-    attr_reader :spec
-
     def initialize
       @spec = {
         "$schema": @schema,
@@ -28,6 +26,10 @@ module Vega
       Spec.new(spec).to_iruby
     end
 
+    def to_json
+      spec.to_json
+    end
+
     private
 
     def initialize_dup(*)
@@ -38,6 +40,7 @@ module Vega
 
     def data_value(value)
       value = value.to_a if defined?(Rover::DataFrame) && value.is_a?(Rover::DataFrame)
+      value = value.to_a[0] if defined?(Daru::DataFrame) && value.is_a?(Daru::DataFrame)
       case value
       when Array
         {values: value}

data/lib/vega/chart.rb

@@ -11,6 +11,8 @@ module Vega
     array_methods \
       :signals, :scales, :projections, :axes, :legends, :marks
 
+    attr_reader :spec
+
     def initialize
       @schema = "https://vega.github.io/schema/vega/v5.json"
       super()

data/lib/vega/engine.rb

@@ -1,5 +1,16 @@
 module Vega
   class Engine < ::Rails::Engine
     # for assets
+
+    # 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"
+        app.config.assets.precompile << "vega.js"
+      end
+    end
   end
 end

data/lib/vega/lite_chart.rb

@@ -2,16 +2,16 @@ module Vega
   class LiteChart < BaseChart
     # https://vega.github.io/vega-lite/docs/spec.html
     scalar_methods \
-      :background, :padding, :autosize, :title, :name, :description, :width, :height, :mark
+      :background, :padding, :autosize, :title, :name, :description, :width, :height, :mark, :spec, :repeat
 
     hash_methods \
-      :config, :usermeta, :projection, :datasets, :encoding
+      :config, :usermeta, :projection, :datasets, :encoding, :facet, :resolve, :selection, :view
 
     array_methods \
-      :transform, :layer
+      :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
 
@@ -20,5 +20,14 @@ module Vega
       self
     end
     immutable_method :data
+
+    undef spec
+    def spec(*args)
+      if args.empty?
+        @spec
+      else
+        dup.spec!(*args)
+      end
+    end
   end
 end

data/lib/vega/method_helpers.rb

@@ -25,7 +25,8 @@ module Vega
     def array_methods(*methods)
       methods.each do |method|
         define_method("#{method}!") do |value|
-          (@spec[method] ||= []) << value
+          value = [value] unless value.is_a?(Array)
+          (@spec[method] ||= []).push(*value)
           self
         end
         immutable_method(method)

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.16.1?noext',
-              'vega-lite': 'https://cdn.jsdelivr.net/npm/vega-lite@4.16.2?noext',
-              'vega-embed': 'https://cdn.jsdelivr.net/npm/vega-embed@6.12.2?noext'
+              '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'
             }
           });
-          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>

data/lib/vega/version.rb

@@ -1,3 +1,3 @@
 module Vega
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/licenses/LICENSE-vega-interpreter.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2015-2018, University of Washington Interactive Data Lab
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

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