iruby-chartkick 0.1.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b39050caa3f7e3d2a9b1859b0a3ddd21c851eb9d0afc39e59e03364b2b61417
-  data.tar.gz: b3fac3e8b089bc3dcf2766a84a7544a40b2f6bd569f652445db0bf291b979053
+  metadata.gz: 3c9205612f657c33c8668a8dc7ba9383087bfdf41e2889818db30840fa911857
+  data.tar.gz: '0283547ff021be8b728c25c51600eb0b6847f03311e8f039066eb130677d4426'
 SHA512:
-  metadata.gz: 4bb0ceffc6ce1d7a0febdc9c82ed4a75cb1b26c610f9e0d53654a232b6e26048a594a5a231e67e3c4dc8fc300311a0066d7372c81b354f1b6799042467f41892
-  data.tar.gz: 391b51c7cfc00469515ab17b3dfbff7ac15b79580a47b249d396e5a37253a04017e0f5129eab568efa5f9e9c69ffd1b4f930b64b5775e98888d5a8490e64560f
+  metadata.gz: 7c8a1585cc7343c4abeb65b3be3ae19767ab452b90b48aa7839addf20e23f38987e7e629ce2c6689d909f0c6b17f3b6951eaabac581ec394ba1495a2b0115701
+  data.tar.gz: ec03a4555165519f3455e630e4997150c1d44309c7f00bb6c652ae1c492e857392bfd26aeff56d9f675f5c0998cde1fcba623053dd933ed154e82e4ccb87dfd2

data/.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: build
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  build:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '3.0' ]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake

data/.gitignore

@@ -1,3 +1,4 @@
+/node_modules/
 /.bundle/
 /.yardoc
 /_yardoc/

data/.ruby-version

@@ -1 +1 @@
-2.6.4
+3.0.1

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+### HEAD (not released yet)
+
+### v0.3.1
+* Update javascript (chartkick v.4.1.0 & chart.js v.3.6.0)
+* Update chartkick gem (4.1.0)
+
+### v0.3.0
+
+* Update all javascript (chartkick v.4.0.5 & chart.js v.3.5.1)
+* Use webpack to create javascript bundle
+* Switch from travis to github actions
+
+### v0.2.1
+
+* Only load JS scripts once
+
+### v0.2.0
+
+* Support for area charts
+* Support for scatter plots
+* Support for timeline
+* Support for geo charts
+* Support for column charts
+* Support keyword arguments for charts like height, width etc.
+
+### v0.1.0
+
+* Initial version
+* Support for line chart, bar chart and pie chart

data/Gemfile.lock

@@ -1,47 +1,62 @@
 PATH
   remote: .
   specs:
-    iruby-chartkick (0.1.0)
-      chartkick
+    iruby-chartkick (0.3.1)
+      chartkick (~> 4.1.0)
       iruby
 
 GEM
   remote: https://rubygems.org/
   specs:
-    bond (0.5.1)
-    chartkick (3.2.2)
+    chartkick (4.1.0)
     data_uri (0.1.0)
-    diff-lcs (1.3)
-    iruby (0.4.0)
-      bond (~> 0.5)
+    diff-lcs (1.4.4)
+    ffi (1.15.4)
+    ffi-rzmq (2.0.7)
+      ffi-rzmq-core (>= 1.0.7)
+    ffi-rzmq-core (1.0.7)
+      ffi
+    io-console (0.5.9)
+    irb (1.3.7)
+      reline (>= 0.2.7)
+    iruby (0.7.4)
       data_uri (~> 0.1)
-      mimemagic (~> 0.3)
+      ffi-rzmq
+      irb
+      mime-types (>= 3.3.1)
       multi_json (~> 1.11)
-    mimemagic (0.3.3)
-    multi_json (1.14.1)
-    rake (10.5.0)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+      native-package-installer
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0901)
+    multi_json (1.15.0)
+    native-package-installer (1.1.1)
+    rake (13.0.6)
+    reline (0.2.7)
+      io-console (~> 0.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   bundler
   iruby-chartkick!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.0.2
+   2.2.15

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019 Robin Neumann
+Copyright (c) 2019 Robin Stammer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
-# iruby-chartkick [![Build Status](https://travis-ci.com/Absolventa/iruby-chartkick.svg?branch=master)](https://travis-ci.com/Absolventa/iruby-chartkick)
+# iruby-chartkick [![build](https://github.com/Absolventa/iruby-chartkick/actions/workflows/build.yml/badge.svg)](https://github.com/Absolventa/iruby-chartkick/actions/workflows/build.yml)
 
-You like writing [Ruby within Juypter](https://github.com/SciRuby/iruby/) notebooks?  Awesome, you're not alone - we do so, too ☀️ Since we also fell in love with the handy charting API of [ankane/chartkick](https://github.com/ankane/chartkick), we wrote this little gem bringing them together.
+You like writing [Ruby within Juypter](https://github.com/SciRuby/iruby/) notebooks?  Awesome, you're not alone - we do so, too ☀️ Since we also fell in love with the handy charting API of [ankane/chartkick](https://github.com/ankane/chartkick), we wrote this little gem bringing them together.
 
 `iruby-chartkick` was made for easy plug-n-play plotting data using the awesomeness of chartkick within IRuby-backed Jupyter notebooks.
 
@@ -12,7 +12,7 @@ You like writing [Ruby within Juypter](https://github.com/SciRuby/iruby/) noteb
 
 You can either include the module `IRuby::Chartkick` and use the wrapper methods, like `line_chart`:
 	
-```Ruby
+```ruby
 include IRuby::Chartkick
 		
 data = {
@@ -26,7 +26,7 @@ line_chart(data)
 
 Or you use the chart wrapper classes directly: 
 
-```Ruby
+```ruby
 include IRuby::Chartkick
 		
 data = {
@@ -38,6 +38,99 @@ data = {
 IRuby::Chartkick::LineChart.new(data).plot
 ```
 
-### In a Jupyter notebook:
+### Examples:
 
-![Bildschirmfoto 2019-10-31 um 14 13 27](https://user-images.githubusercontent.com/3685123/67949871-d9688180-fbe8-11e9-9930-ceea4f42bf61.png)
+```ruby
+include IRuby::Chartkick
+
+data = [
+  {
+    name: "Monkeys",
+    data: {
+      2010 => 20,
+      2011 => 190,
+      2012 => 188,
+      2013 => 230,
+      2014 => 422,
+      2015 => 56,
+      2016 => 299,
+      2019 => 100
+    }
+  },
+  {
+    name: "Pirates",
+    data: {
+      2010 => 20,
+      2011 => 90,
+      2012 => 488,
+      2013 => 430,
+      2014 => 122,
+      2015 => 6,
+      2016 => 399,
+      2019 => 500
+    }
+  }
+]
+```
+
+#### LineChart
+
+```ruby
+line_chart(data)
+```
+![LineChart](https://user-images.githubusercontent.com/3856862/136750966-3fe8908d-356c-477e-8c0e-220bc302d07e.png)
+
+```ruby
+line_chart(data, points: false)
+```
+![LineChart](https://user-images.githubusercontent.com/3856862/136767403-a2839f21-d6af-45af-a710-2f9f0ed2203c.png)
+
+```ruby
+line_chart(data, points: false, width: "700px", min: 50, max: 300)
+```
+![LineChart](https://user-images.githubusercontent.com/3856862/136751184-7d96c152-ec1f-490a-9676-0ea16606addf.png)
+
+#### AreaChart
+
+```ruby
+area_chart(data)
+```
+![AreaChart](https://user-images.githubusercontent.com/3856862/136751437-9ceb092c-b1a1-4aee-a868-91a0ac3e9cbc.png)
+
+#### ColumnChart
+
+```ruby
+column_chart(data)
+```
+![ColumnChart](https://user-images.githubusercontent.com/3856862/136751574-252b40cb-b842-41ff-8a25-57695eb4e5b0.png)
+
+#### BarChart
+
+```ruby
+bar_chart(data)
+```
+![BarChart](https://user-images.githubusercontent.com/3856862/136751822-8383166d-894b-42fd-8ea7-fecf00964567.png)
+
+#### ScatterChart
+
+```ruby
+scatter_chart(data)
+```
+![ScatterChart](https://user-images.githubusercontent.com/3856862/136751938-35acbdc7-baee-4262-ac67-1fe1262f071c.png)
+
+#### PieChart
+
+```ruby
+include IRuby::Chartkick
+
+data = [
+  ["Blueberry", 44],
+  ["Strawberry", 23],
+  ["Banana", 22],
+  ["Apple", 21],
+  ["Grape", 13]
+]
+
+pie_chart(data)
+```
+![PieChart](https://user-images.githubusercontent.com/3856862/136752074-d5bc9ecb-b046-4b84-9108-546326125db4.png)

data/iruby-chartkick.gemspec

@@ -5,8 +5,8 @@ require "iruby/chartkick/version"
 Gem::Specification.new do |spec|
   spec.name          = "iruby-chartkick"
   spec.version       = IRuby::Chartkick::VERSION
-  spec.authors       = ["Robin Neumann\n"]
-  spec.email         = ["robin.neumann@posteo.de"]
+  spec.authors       = ["Robin Stammer\n"]
+  spec.email         = ["robin.stammer@posteo.de"]
 
   spec.summary       = %q{Minimalistic wrapper around chartkick to use it within IRuby}
   spec.homepage      = "https://github.com/Absolventa/iruby-chartkick"
@@ -26,9 +26,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "iruby"
-  spec.add_runtime_dependency "chartkick"
+  spec.add_dependency "chartkick", "~> 4.1.0"
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/iruby/chartkick/area_chart.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module IRuby
+  module Chartkick
+    class AreaChart < IRuby::Chartkick::BaseChart
+      def plot(*args)
+        ::IRuby.html(js_prefix + area_chart(@data, **ArgumentModifier[args, self]))
+      end
+    end
+  end
+end

data/lib/iruby/chartkick/bar_chart.rb

@@ -2,8 +2,8 @@
 module IRuby
   module Chartkick
     class BarChart < IRuby::Chartkick::BaseChart
-      def plot
-        ::IRuby.html(js_prefix + bar_chart(@data, id: randomized_dom_id))
+      def plot(*args)
+        ::IRuby.html(js_prefix + bar_chart(@data, **ArgumentModifier[args, self]))
       end
     end
   end

data/lib/iruby/chartkick/base_chart.rb

@@ -4,38 +4,37 @@ module IRuby
     class BaseChart
       include ::Chartkick::Helper
 
+      ArgumentModifier = ->(args, callee) do
+        modified = args.inject({}) do |sum, item|
+          item.each do |k, v|
+            sum[k] = v
+          end
+          sum
+        end
+        modified[:id] = callee.randomized_dom_id
+        modified
+      end
+
       def initialize(data)
         @data = data
       end
 
       def js_prefix
+        return "" if IRuby::Chartkick.js_loaded?
+        IRuby::Chartkick.mark_js_as_loaded
+
         <<-JS
-          <script type="text/javascript">
-            #{adapter_javascript}
-          </script>
-          <script type="text/javascript">
-            #{chartkick_javascript}
+          <script name="iruby-chartkick-charting-engine-loaders" type="text/javascript">
+            #{javascript}
           </script>
         JS
       end
 
-      def javascripts
-        [
-          adapter_javascript,
-          chartkick_javascript
-        ]
-      end
-
-      def adapter_javascript
-        adapter_js_path = File.join(File.dirname(__FILE__), "..", "..", "..", "vendor", "assets", "javascripts", "adapter.js")
+      def javascript
+        adapter_js_path = File.join(File.dirname(__FILE__), "..", "..", "..", "vendor", "assets", "javascripts", "bundle.js")
         File.read(adapter_js_path)
       end
 
-      def chartkick_javascript
-        chartkick_js_path = File.join(File.dirname(__FILE__), "..", "..", "..", "vendor", "assets", "javascripts", "chartkick.js")
-        File.read(chartkick_js_path)
-      end
-
       def randomized_dom_id
         "#{self.class.to_s.downcase.gsub("::", "-")}-#{rand(100000)}"
       end

data/lib/iruby/chartkick/column_chart.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module IRuby
+  module Chartkick
+    class ColumnChart < IRuby::Chartkick::BaseChart
+      def plot(*args)
+        ::IRuby.html(js_prefix + column_chart(@data, **ArgumentModifier[args, self]))
+      end
+    end
+  end
+end

data/lib/iruby/chartkick/geo_chart.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module IRuby
+  module Chartkick
+    class GeoChart < IRuby::Chartkick::BaseChart
+      def plot(*args)
+        ::IRuby.html(js_prefix + geo_chart(@data, **ArgumentModifier[args, self]))
+      end
+    end
+  end
+end

data/lib/iruby/chartkick/line_chart.rb

@@ -2,8 +2,8 @@
 module IRuby
   module Chartkick
     class LineChart < IRuby::Chartkick::BaseChart
-      def plot
-        ::IRuby.html(js_prefix + line_chart(@data, id: randomized_dom_id))
+      def plot(*args)
+        ::IRuby.html(js_prefix + line_chart(@data, **ArgumentModifier[args, self]))
       end
     end
   end

data/lib/iruby/chartkick/pie_chart.rb

@@ -2,8 +2,8 @@
 module IRuby
   module Chartkick
     class PieChart < IRuby::Chartkick::BaseChart
-      def plot
-        ::IRuby.html(js_prefix + pie_chart(@data, id: randomized_dom_id))
+      def plot(*args)
+        ::IRuby.html(js_prefix + pie_chart(@data, **ArgumentModifier[args, self]))
       end
     end
   end

data/lib/iruby/chartkick/scatter_chart.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module IRuby
+  module Chartkick
+    class ScatterChart < IRuby::Chartkick::BaseChart
+      def plot(*args)
+        ::IRuby.html(js_prefix + scatter_chart(@data, **ArgumentModifier[args, self]))
+      end
+    end
+  end
+end

data/lib/iruby/chartkick/timeline.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module IRuby
+  module Chartkick
+    class Timeline < IRuby::Chartkick::BaseChart
+      def plot(*args)
+        ::IRuby.html(js_prefix + timeline(@data, **ArgumentModifier[args, self]))
+      end
+    end
+  end
+end

data/lib/iruby/chartkick/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module IRuby
   module Chartkick
-    VERSION = "0.1.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/iruby/chartkick.rb

@@ -5,20 +5,61 @@ require "iruby/chartkick/version"
 require "iruby/chartkick/base_chart"
 require "iruby/chartkick/line_chart"
 require "iruby/chartkick/bar_chart"
+require "iruby/chartkick/column_chart"
 require "iruby/chartkick/pie_chart"
+require "iruby/chartkick/area_chart"
+require "iruby/chartkick/scatter_chart"
+require "iruby/chartkick/geo_chart"
+require "iruby/chartkick/timeline"
 
 module IRuby
   module Chartkick
-    def line_chart(data)
-      LineChart.new(data).plot
+    class << self
+      def js_loaded?
+        @@js_loaded
+      end
+
+      def mark_js_as_loaded
+        @@js_loaded = true
+      end
+
+      def mark_js_as_unloaded
+        @@js_loaded = false
+      end
+    end
+
+    mark_js_as_unloaded
+
+    def line_chart(data, **args)
+      LineChart.new(data).plot(**args)
+    end
+
+    def bar_chart(data, **args)
+      BarChart.new(data).plot(**args)
+    end
+
+    def column_chart(data, **args)
+      ColumnChart.new(data).plot(**args)
+    end
+
+    def pie_chart(data, **args)
+      PieChart.new(data).plot(**args)
+    end
+
+    def area_chart(data, **args)
+      AreaChart.new(data).plot(**args)
+    end
+
+    def scatter_chart(data, **args)
+      ScatterChart.new(data).plot(**args)
     end
 
-    def bar_chart(data)
-      BarChart.new(data).plot
+    def geo_chart(data, **args)
+      GeoChart.new(data).plot(**args)
     end
 
-    def pie_chart(data)
-      PieChart.new(data).plot
+    def timeline(data, **args)
+      Timeline.new(data).plot(**args)
     end
   end
 end