charty 0.2.6 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63e13663e8213e077993e52b906b630c35a1f7f9a224abb99fd206bb700659c2
-  data.tar.gz: d7fd53056c32c18bf5af6b1e1a4b2a29bfe652a427b338087d3cab538a0797ba
+  metadata.gz: d885d476eadfadd3f76f138707ffaf6166eec006b4528fb19c3acce0b97b1c85
+  data.tar.gz: 0630f23f19b65177f3b6dc238717a81a019f9dfa40a40c143d71dcc5c5f760f0
 SHA512:
-  metadata.gz: cc4da146432f688eb52dd382ea516e02ab84ef7143453c80fa5bc14fef55851728550ee58fe98c1c3a5e9a1eac0f33dcfb702356bc7c0f344ceaf85f87400435
-  data.tar.gz: f519610073317c3fafd42b97ad5e96d124265f6a7d79a54023995cf82d1fe84624d4f914c26e3eef644ad280110400fe1cdac275ec5e32145d7e4b652ef47891
+  metadata.gz: 535a69b8d794ccbd30b4328f3188c8a8b50c850cfd84285f79b31162296a9d981313e561ea1089a68be3368b7eb1c83ccc3cb2ff511b8f79aef77e544e261bbe
+  data.tar.gz: 804de2468433db38b5381bcbccab4c28e84c7592bce5c5a98a539ce99c589449759e65ffe7f2e808bd3c5cb5e002ee2219219111561f66f590dbb0ac2c0757bc

data/charty.gemspec

@@ -27,6 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "red-colors", ">= 0.3.0"
+  spec.add_dependency "red-datasets", ">= 0.1.2"
   spec.add_dependency "red-palette", ">= 0.5.0"
 
   spec.add_dependency "matplotlib", ">= 1.2.0"
@@ -36,10 +37,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", ">= 1.16"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "test-unit"
-  spec.add_development_dependency "red-datasets", ">= 0.1.2"
   spec.add_development_dependency "daru"
   spec.add_development_dependency "matrix" # need for daru on Ruby > 3.0
   spec.add_development_dependency "activerecord"
   spec.add_development_dependency "sqlite3"
   spec.add_development_dependency "iruby", ">= 0.7.0"
+  spec.add_development_dependency "csv"
 end

data/examples/bar_plot.rb

@@ -0,0 +1,19 @@
+# This example generates box_plot results in README.md
+
+require "charty"
+require "datasets"
+require "matplotlib"
+
+Charty::Backends.use(:pyplot)
+Matplotlib.use(:agg)
+
+penguins = Datasets::Penguins.new
+
+Charty.bar_plot(data: penguins, x: :species, y: :body_mass_g)
+      .save("penguins_species_body_mass_g_bar_plot_v.png")
+
+Charty.bar_plot(data: penguins, x: :body_mass_g, y: :species)
+      .save("penguins_species_body_mass_g_bar_plot_h.png")
+
+Charty.bar_plot(data: penguins, x: :species, y: :body_mass_g, color: :sex)
+      .save("penguins_species_body_mass_g_sex_bar_plot_v.png")

data/examples/box_plot.rb

@@ -0,0 +1,17 @@
+require "charty"
+require "datasets"
+require "matplotlib"
+
+Charty::Backends.use(:pyplot)
+Matplotlib.use(:agg)
+
+penguins = Datasets::Penguins.new
+
+Charty.box_plot(data: penguins, x: :species, y: :body_mass_g)
+      .save("penguins_species_body_mass_g_box_plot_v.png")
+
+Charty.box_plot(data: penguins, x: :body_mass_g, y: :species)
+      .save("penguins_species_body_mass_g_box_plot_h.png")
+
+Charty.box_plot(data: penguins, x: :species, y: :body_mass_g, color: :sex)
+      .save("penguins_species_body_mass_g_sex_box_plot_v.png")

data/examples/scatter_plot.rb

@@ -0,0 +1,17 @@
+require "charty"
+require "datasets"
+require "matplotlib"
+
+Charty::Backends.use(:pyplot)
+Matplotlib.use(:agg)
+
+penguins = Datasets::Penguins.new
+
+Charty.scatter_plot(data: penguins, x: :body_mass_g, y: :flipper_length_mm)
+      .save("penguins_body_mass_g_flipper_length_mm_scatter_plot.png")
+
+Charty.scatter_plot(data: penguins, x: :body_mass_g, y: :flipper_length_mm, color: :species)
+      .save("penguins_body_mass_g_flipper_length_mm_species_scatter_plot.png")
+
+Charty.scatter_plot(data: penguins, x: :body_mass_g, y: :flipper_length_mm, color: :species, style: :sex)
+      .save("penguins_body_mass_g_flipper_length_mm_species_sex_scatter_plot.png")

data/lib/charty.rb

@@ -3,7 +3,9 @@ require_relative "charty/version"
 require "colors"
 require "palette"
 
+require_relative "charty/cache_dir"
 require_relative "charty/util"
+require_relative "charty/iruby_helper"
 require_relative "charty/dash_pattern_generator"
 require_relative "charty/backends"
 require_relative "charty/backend_methods"

data/lib/charty/backends/plotly.rb

@@ -2,6 +2,10 @@ require "json"
 require "securerandom"
 require "tmpdir"
 
+require_relative "plotly_helpers/html_renderer"
+require_relative "plotly_helpers/notebook_renderer"
+require_relative "plotly_helpers/plotly_renderer"
+
 module Charty
   module Backends
     class Plotly
@@ -130,10 +134,8 @@ module Charty
 
         if orient == :v
           x, y = bar_pos, values
-          x = group_names unless group_names.nil?
         else
           x, y = values, bar_pos
-          y = group_names unless group_names.nil?
         end
 
         trace = {
@@ -237,9 +239,9 @@ module Charty
           }
 
           if orient == :v
-            trace.update(y: values, x: group_keys)
+            trace.update(y: values, x: group_keys.map(&:to_s))
           else
-            trace.update(x: values, y: group_keys)
+            trace.update(x: values, y: group_keys.map(&:to_s))
           end
 
           trace
@@ -558,6 +560,62 @@ module Charty
         end
       end
 
+      PLOTLY_HISTNORM = {
+        count: "".freeze,
+        frequency: "density".freeze,
+        density: "probability density".freeze,
+        probability: "probability".freeze
+      }.freeze
+
+      def univariate_histogram(hist, name, variable_name, stat,
+                               alpha, color, key_color, color_mapper,
+                               _multiple, _element, _fill, _shrink)
+        value_axis = variable_name
+        case value_axis
+        when :x
+          weights_axis = :y
+          orientation = :v
+        else
+          weights_axis = :x
+          orientation = :h
+        end
+
+        mid_points = hist.edges.each_cons(2).map {|a, b| a + (b - a) / 2 }
+
+        trace = {
+          type: :bar,
+          name: name.to_s,
+          value_axis => mid_points,
+          weights_axis => hist.weights,
+          orientation: orientation,
+          opacity: alpha
+        }
+
+        if color.nil?
+          trace[:marker] = {
+            color: key_color.to_rgb.to_hex_string
+          }
+        else
+          trace[:marker] = {
+            color: color_mapper[color].to_rgb.to_hex_string
+          }
+        end
+
+        @traces << trace
+
+        @layout[:bargap] = 0.05
+
+        if @traces.length > 1
+          @layout[:barmode] = "overlay"
+          @layout[:showlegend] = true
+        end
+      end
+
+      def set_title(title)
+        @layout[:title] ||= {}
+        @layout[:title][:text] = title
+      end
+
       def set_xlabel(label)
         @layout[:xaxis] ||= {}
         @layout[:xaxis][:title] = label
@@ -602,6 +660,29 @@ module Charty
         @layout[:yaxis][:range] = [min, max]
       end
 
+      def set_xscale(scale)
+        scale = check_scale_type(scale, :xscale)
+        @layout[:xaxis] ||= {}
+        @layout[:xaxis][:type] = scale
+      end
+
+      def set_yscale(scale)
+        scale = check_scale_type(scale, :yscale)
+        @layout[:yaxis] ||= {}
+        @layout[:yaxis][:type] = scale
+      end
+
+      private def check_scale_type(val, name)
+        case
+        when :linear, :log
+          val
+        else
+          raise ArgumentError,
+                "Invalid #{name} type: %p" % val,
+                caller
+        end
+      end
+
       def disable_xaxis_grid
         # do nothing
       end
@@ -699,7 +780,7 @@ module Charty
 
       def render(element_id: nil, format: nil, notebook: false)
         case format
-        when :html, "html"
+        when :html, "html", nil
           format = "text/html"
         when :png, "png"
           format = "image/png"
@@ -708,7 +789,7 @@ module Charty
         end
 
         case format
-        when "text/html", nil
+        when "text/html"
           # render html after this case cause
         when "image/png", "image/jpeg"
           image_data = render_image(format, element_id: element_id, notebook: false)
@@ -722,32 +803,54 @@ module Charty
                 "Unsupported mime type to render: %p" % format
         end
 
-        # TODO: size should be customizable
-        html = <<~HTML
-          <div id="%{id}" style="width: 100%%; height:525px;"></div>
-          <script type="text/javascript">
-            requirejs(["plotly"], function (Plotly) {
-              Plotly.newPlot("%{id}", %{data}, %{layout});
-            });
-          </script>
-        HTML
-
         element_id = SecureRandom.uuid if element_id.nil?
 
-        html %= {
-          id: element_id,
-          data: JSON.dump(@traces),
-          layout: JSON.dump(@layout)
-        }
-
+        renderer = PlotlyHelpers::HtmlRenderer.new(full_html: !notebook)
+        html = renderer.render({data: @traces, layout: @layout}, element_id: element_id)
         if notebook
-          IRubyOutput.prepare
-          ["text/html", html]
+          [format, html]
         else
           html
         end
       end
 
+      def render_mimebundle(include: [], exclude: [])
+        types = case
+               when IRubyHelper.vscode?,
+                 IRubyHelper.nteract?
+                 [:plotly_mimetype]
+               else
+                 [:plotly_mimetype, :notebook]
+               end
+        bundle = Util.filter_map(types) { |type|
+          case type
+          when :plotly_mimetype
+            render_plotly_mimetype_bundle
+          when :notebook
+            render_notebook_bundle
+          end
+        }.to_h
+        bundle
+      end
+
+      private def render_plotly_mimetype_bundle
+        renderer = PlotlyHelpers::PlotlyRenderer.new
+        obj = renderer.render({data: @traces, layout: @layout})
+        [ "application/vnd.plotly.v1+json", obj ]
+      end
+
+      private def render_notebook_bundle
+        renderer = self.class.notebook_renderer
+        renderer.activate
+        html = renderer.render({data: @traces, layout: @layout})
+        [ "text/html", html ]
+      end
+
+      # for new APIs
+      def self.notebook_renderer
+        @notebook_renderer ||= PlotlyHelpers::NotebookRenderer.new
+      end
+
       private def render_image(format=nil, filename: nil, element_id: nil, notebook: false,
                        title: nil, width: nil, height: nil)
         format = "image/png" if format.nil?

data/lib/charty/backends/plotly_helpers/html_renderer.rb

@@ -0,0 +1,203 @@
+require "datasets/downloader"
+require "json"
+require "securerandom"
+
+module Charty
+  module Backends
+    module PlotlyHelpers
+      class HtmlRenderer
+        def initialize(use_cdn: true,
+                       full_html: false,
+                       requirejs: true)
+          @use_cdn = use_cdn
+          @full_html = full_html
+          @requirejs = requirejs
+        end
+
+        PLOTLY_URL = "https://plot.ly".freeze
+        PLOTLY_LATEST_CDN_URL = "https://cdn.plot.ly/plotly-latest.min.js".freeze
+        MATHJAX_CDN_URL = ("https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js").freeze
+
+        DEFAULT_WIDTH = "100%".freeze
+        DEFAULT_HEIGHT = 525
+
+        def render(figure, element_id: nil, post_script: nil)
+          element_id = SecureRandom.uuid if element_id.nil?
+          plotly_html_div = build_plotly_html_div(figure, element_id, post_script)
+
+          if @full_html
+            <<~END_HTML % {div: plotly_html_div}
+              <!DOCTYPE html>
+              <html>
+              <head><meta charset="utf-8" /></head>
+              <body>
+                %{div}
+              </body>
+              </html>
+            END_HTML
+          else
+            plotly_html_div
+          end
+        end
+
+        private def build_plotly_html_div(figure, element_id, post_script)
+          layout = figure.fetch(:layout, {})
+
+          json_data = JSON.dump(figure.fetch(:data, []))
+          json_layout = JSON.dump(layout)
+          json_frames = JSON.dump(figure[:frames]) if figure.key?(:frames)
+
+          # TODO: config and responsive support
+
+          template = layout.fetch(:template, {}).fetch(:layout, {})
+          div_width = layout.fetch(:width, template.fetch(:width, DEFAULT_WIDTH))
+          div_height = layout.fetch(:height, template.fetch(:height, DEFAULT_HEIGHT))
+
+          div_width  = "#{div_width}px"  if Float(div_width, exception: false)
+          div_height = "#{div_height}px" if Float(div_height, exception: false)
+
+          # TODO: showLink and showSendToCloud support
+          base_url_line = "window.PLOTLYENV.BASE_URL = '%{url}';" % {url: PLOTLY_URL}
+
+          ## build script body
+
+          # TODO: post_script support
+          then_post_script = ""
+          if post_script
+            ary = Array.try_convert(post_script)
+            post_script = ary || [post_script]
+            post_script.each do |ps|
+              next if ps.nil?
+              then_post_script << '.then(function(){ %{post_script} })' % {
+                post_script: ps % {plot_id: element_id}
+              }
+            end
+          end
+
+          then_addframes = ""
+          then_animate = ""
+          if json_frames
+            then_addframes = <<~END_ADDFRAMES % {id: element_id, frames: json_frames}
+              .then(function(){
+                Plotly.addFrames('%{id}', {frames});
+              })
+            END_ADDFRAMES
+
+            # TODO: auto_play support
+          end
+
+          json_config = JSON.dump({}) # TODO: config support
+
+          script = <<~END_SCRIPT
+            if (document.getElementById("%{id}")) {
+              Plotly.newPlot("%{id}", %{data}, %{layout}, %{config})%{then_addframes}%{then_animate}%{then_post_script};
+            }
+          END_SCRIPT
+          script = script % {
+            id: element_id,
+            data: json_data,
+            layout: json_layout,
+            config: json_config,
+            then_addframes: then_addframes,
+            then_animate: then_animate,
+            then_post_script: then_post_script
+          }
+
+          ## Handle loading/initializing plotlyjs
+
+          case
+          when @requirejs
+            include_plotlyjs = :require
+            include_mathjax = false
+          when @use_cdn
+            include_plotlyjs = :cdn
+            include_mathjax = :cdn
+          else
+            include_plotlyjs = true
+            include_mathjax = :cdn
+          end
+
+          case include_plotlyjs
+          when :require
+            require_start = 'require(["plotly"], function (Plotly) {'
+            require_end   = '});'
+          when :cdn
+            load_plotlyjs = <<~END_LOAD_PLOTLYJS % {win_config: window_plotly_config, url: PLOTLY_LATEST_CDN_URL}
+              %{win_config}
+              <script src="%{url}"></script>
+            END_LOAD_PLOTLYJS
+          when true
+            load_plotlyjs = <<~END_LOAD_PLOTLYJS % {win_config: window_plotly_config, script: get_plotlyjs}
+              %{win_config}
+              <script type="text/javascript">%{script}</script>
+            END_LOAD_PLOTLYJS
+          end
+
+          ## Handle loading/initializing MathJax
+
+          mathjax_tmplate = %Q[<script src="%{url}?config=TeX-AMS-MML_SVG"></script>]
+          case include_mathjax
+          when :cdn
+            mathjax_script = mathjax_tmplate % {url: MATHJAX_CDN_URL}
+            mathjax_script << <<~END_SCRIPT % {mathjax_config: mathjax_config}
+              <script type="text/javascript">%{mathjax_config}</script>
+            END_SCRIPT
+          else
+            mathjax_script = ""
+          end
+
+          div_template = <<~END_DIV
+            <div>
+              %{mathjax_script}
+              %{load_plotlyjs}
+              <div id="%{id}" class="plotly-graph-div" style="height: %{height}; width: %{width};"></div>
+              <script type="text/javascript">
+                %{require_start}
+                  window.PLOTLYENV = window.PLOTLYENV || {};
+                  %{base_url_line}
+                  %{script}
+                %{require_end}
+              </script>
+            </div>
+          END_DIV
+
+          plotly_html_div = div_template % {
+            mathjax_script: mathjax_script,
+            load_plotlyjs: load_plotlyjs,
+            id: element_id,
+            height: div_height,
+            width: div_width,
+            require_start: require_start,
+            base_url_line: base_url_line,
+            script: script,
+            require_end: require_end
+          }
+          plotly_html_div.strip!
+
+          plotly_html_div
+        end
+
+        private def window_plotly_config
+          %Q(window.PlotlyConfig = {MathJaxConfig: 'local'};)
+        end
+
+        private def mathjax_config
+          %Q(if (window.MathJax) { MathJax.Hub.Config({SVG: {font: "STIX-Web"}}); })
+        end
+
+        private def get_plotlyjs
+          cache_path = CacheDir.path("plotly.min.js")
+          unless cache_path.exist?
+            download_plotlyjs(cache_path)
+          end
+          cache_path.read
+        end
+
+        private def download_plotlyjs(output_path)
+          downloader = Datasets::Downloader.new(PLOTLY_LATEST_CDN_URL)
+          downloader.download(output_path)
+        end
+      end
+    end
+  end
+end