vega 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 52225cdedf189b9d6c9b589c52fd7bb10d6c9aa1dc17685b920b60fabee42d66
+  data.tar.gz: 82dd13b27708aa6ad57e4358d75c4913e232c8f85b4eb2768598dc53d81f82fd
+SHA512:
+  metadata.gz: c1ed453f8f337c3863dadafe79a8e44a3a22896fc114c6de6e9b3646908deb86b9fb3d76d826a174ee21722a1b2a4ba9905ad13b2594592d074cd3611fa37bbd
+  data.tar.gz: 58be98b855093e3b6f554fc094a85cf5f79dd3efd10304cb5ba0bd05749277a66fba1e4f1e2c502af401cea6b9ca7269f40bdbb6b8d6e8c37033def50bc5119f

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2020-09-26)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020, Andrew Kane.
+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 HOLDER 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/README.md

@@ -0,0 +1,304 @@
+# Vega.rb
+
+Interactive charts for Ruby, powered by [Vega](https://vega.github.io/vega/) and [Vega-Lite](https://vega.github.io/vega-lite/)
+
+Works with Rails, iRuby, and other frameworks
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem 'vega'
+```
+
+The follow the instructions for how you plan to use it:
+
+- [Rails 6 / Webpacker](#rails)
+- [Rails 5 / Sprockets](#rails)
+- [iRuby](#iruby)
+- [Other](#other)
+
+### Rails 6 / Webpacker
+
+Run:
+
+```sh
+yarn add vega vega-lite vega-embed
+```
+
+And add to `app/javascript/packs/application.js`:
+
+```js
+window.vegaEmbed = require("vega-embed").default
+```
+
+### Rails 5 / Sprockets
+
+Add to `app/assets/javascripts/application.js`:
+
+```js
+//= require vega
+//= require vega-lite
+//= require vega-embed
+```
+
+### iRuby
+
+No additional set up is needed.
+
+### Other
+
+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>
+```
+
+## Getting Started
+
+Vega is a visualization grammar, and Vega-Lite is a high-level grammar built on top of it. We recommend using Vega-Lite by default and moving to Vega for advanced use cases.
+
+Create visualizations by chaining together methods:
+
+```ruby
+Vega.lite.data(data).mark("bar").height(200)
+```
+
+There are methods for each of the top-level properties. The docs are a great source of examples:
+
+- [Vega-Lite docs](https://vega.github.io/vega-lite/docs/)
+- [Vega docs](https://vega.github.io/vega/docs/)
+
+## Example
+
+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}
+    ]
+  )
+  .mark(type: "bar", tooltip: true)
+  .encoding(
+    x: {field: "a", type: "ordinal"},
+    y: {field: "b", type: "quantitative"}
+  )
+```
+
+The chart will automatically render in iRuby. For Rails, render it in your view:
+
+```erb
+<%= Vega.lite.data(...) %>
+```
+
+## Vega-Lite
+
+Start a Vega-Lite chart with:
+
+```ruby
+Vega.lite
+```
+
+### Data
+
+[Docs](https://vega.github.io/vega-lite/docs/data.html)
+
+The data source can be an array
+
+```ruby
+data(values: [{x: "A", y: 1}, {x: "B", y: 2}])
+```
+
+Or a URL
+
+```ruby
+data(url: "https://www.example.com")
+```
+
+You can also specify the data format
+
+```ruby
+data(url: "https://www.example.com/data.csv", format: {type: "csv"})
+```
+
+### Transforms
+
+[Docs](https://vega.github.io/vega-lite/docs/transform.html)
+
+```ruby
+transform(bin: true, field: "a", as: "binned a")
+```
+
+### Marks
+
+[Docs](https://vega.github.io/vega-lite/docs/mark.html)
+
+Bar chart
+
+```ruby
+mark("bar")
+```
+
+Line chart
+
+```ruby
+mark("line")
+```
+
+Pie chart
+
+```ruby
+mark("pie")
+```
+
+Area chart
+
+```ruby
+mark("area")
+```
+
+Enable tooltips
+
+```ruby
+mark(type: "bar", tooltip: true)
+```
+
+### Encoding
+
+[Docs](https://vega.github.io/vega-lite/docs/mark.html)
+
+```ruby
+encoding(x: {field: "a", type: "ordinal"})
+```
+
+### Projection
+
+[Docs](https://vega.github.io/vega-lite/docs/projection.html)
+
+```ruby
+projection(type: "albersUsa")
+```
+
+### Configuration
+
+[Docs](https://vega.github.io/vega-lite/docs/config.html)
+
+Set the font
+
+```ruby
+config(font: "Helvetica")
+```
+
+### Top-Level Properties
+
+[Docs](https://vega.github.io/vega-lite/docs/spec.html#top-level)
+
+Set width and height
+
+```ruby
+width(500).height(300)
+```
+
+Set the background color
+
+```ruby
+background("#000")
+```
+
+Set padding
+
+```ruby
+padding(5)
+# or
+padding(left: 5, top: 5, right: 5, bottom: 5)
+```
+
+### Embed Options
+
+[Docs](https://github.com/vega/vega-embed#options)
+
+Set embed options
+
+```ruby
+embed_options(actions: true)
+```
+
+## Vega
+
+You can also use Vega directly. In this case, you don’t need to include Vega-Lite in the JavaScript files.
+
+Start a Vega chart with:
+
+```ruby
+Vega.start
+```
+
+## Spec
+
+You can also create a specification by hand
+
+```ruby
+spec = {
+  "$schema" => "https://vega.github.io/schema/vega-lite/v4.json",
+  "data" => {"url" => "https://www.example.com"},
+  # ...
+}
+```
+
+And render it in Rails
+
+```erb
+<%= Vega.render(spec) %>
+```
+
+Or display it in iRuby
+
+```ruby
+Vega.display(spec)
+```
+
+Get the spec for a chart
+
+```ruby
+chart.spec
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/vega/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)
+- 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
+bundle install
+bundle exec rake test
+```
+
+Resources for contributors:
+
+- [Vega specification](https://vega.github.io/vega/docs/specification/)
+- [Vega-Lite specification](https://vega.github.io/vega-lite/docs/spec.html)

data/lib/vega.rb

@@ -0,0 +1,36 @@
+# stdlib
+require "erb"
+require "json"
+require "securerandom"
+
+# modules
+require "vega/method_helpers"
+require "vega/base_chart"
+require "vega/chart"
+require "vega/lite_chart"
+require "vega/spec"
+require "vega/version"
+
+# integrations
+require "vega/engine" if defined?(Rails)
+
+module Vega
+  class << self
+    # save chart method for now
+    def start
+      Chart.new
+    end
+
+    def lite
+      LiteChart.new
+    end
+
+    def render(spec)
+      Spec.new(spec).to_s
+    end
+
+    def display(spec)
+      IRuby.display(Spec.new(spec))
+    end
+  end
+end

data/lib/vega/base_chart.rb

@@ -0,0 +1,51 @@
+module Vega
+  class BaseChart
+    extend MethodHelpers
+
+    attr_reader :spec
+
+    def initialize
+      @spec = {
+        "$schema": @schema,
+        width: "container",
+        height: "container"
+        # maybe add later
+        # config: {mark: {tooltip: true}}
+      }
+    end
+
+    def embed_options!(value)
+      usermeta!(embedOptions: value)
+      self
+    end
+    immutable_method :embed_options
+
+    def to_s
+      Spec.new(spec).to_s
+    end
+
+    def to_iruby
+      Spec.new(spec).to_iruby
+    end
+
+    private
+
+    def initialize_dup(*)
+      # dup one-level up
+      @spec = @spec.transform_values(&:dup)
+      super
+    end
+
+    def data_value(value)
+      value = value.to_a if defined?(Rover::DataFrame) && value.is_a?(Rover::DataFrame)
+      case value
+      when Array
+        {values: value}
+      when String
+        {url: value}
+      else
+        value
+      end
+    end
+  end
+end

data/lib/vega/chart.rb

@@ -0,0 +1,25 @@
+module Vega
+  class Chart < BaseChart
+    # https://vega.github.io/vega/docs/specification/
+    scalar_methods \
+      :description, :background, :width, :height,
+      :padding, :autosize, :title, :encode
+
+    hash_methods \
+      :config, :usermeta
+
+    array_methods \
+      :signals, :scales, :projections, :axes, :legends, :marks
+
+    def initialize
+      @schema = "https://vega.github.io/schema/vega/v5.json"
+      super()
+    end
+
+    def data!(value)
+      (@spec[:data] ||= []) << data_value(value)
+      self
+    end
+    immutable_method :data
+  end
+end