rcharts 0.1.0

data/app/helpers/rcharts/graph_helper/series/point.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module RCharts
+  module GraphHelper
+    module Series
+      # :nodoc:
+      Point = Struct.new(:x, :y) do
+        def to_s = "#{x},#{y}"
+
+        def +(other) = Point.new(x + other.x, y + other.y)
+
+        def -(other) = Point.new(x - other.x, y - other.y)
+
+        def control(previous_point, next_point, smoothing: 1.0, reverse: false)
+          (self + handle_offset(previous_point, next_point, smoothing:, reverse:)).then do |control|
+            clamp(control, (reverse ? previous_point : next_point))
+          end
+        end
+
+        def incomplete?
+          x.nil? || y.nil?
+        end
+
+        def complete?
+          !incomplete?
+        end
+
+        protected
+
+        def handle_offset(previous_point, next_point, smoothing: 1.0, reverse: false)
+          (next_point - previous_point).handle_position(smoothing: smoothing, reverse: reverse,
+                                                        extremum: extremum?(previous_point, next_point))
+        end
+
+        def handle_position(smoothing: 1.0, reverse: false, extremum: false)
+          Point.new(Math.cos(angle(reverse:)) * length(smoothing:),
+                    extremum ? 0 : Math.sin(angle(reverse:)) * length(smoothing:))
+        end
+
+        private
+
+        def angle(reverse: false) = Math.atan2(y, x) + (reverse ? Math::PI : 0)
+
+        def length(smoothing: 1.0) = Math.sqrt((x**2) + (y**2)) * smoothing
+
+        def extremum?(previous_point, next_point) = (y - previous_point.y) * (next_point.y - y) <= 0
+
+        def clamp(control, limit)
+          Point.new(clamp_point(:x, control, limit), clamp_point(:y, control, limit))
+        end
+
+        def clamp_point(point, control, limit)
+          control[point].clamp(*[self[point], limit[point]].minmax)
+        end
+      end
+    end
+  end
+end

data/app/helpers/rcharts/graph_helper/series/scatter_element.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module RCharts
+  module GraphHelper
+    module Series
+      class ScatterElement < PathElement # :nodoc:
+        attribute :marker_size, :float, default: 10
+        attribute :marker_margin, :float, default: 2
+        attribute :marker_id
+
+        private
+
+        def tags
+          series_tag
+        end
+
+        def series_tag
+          tag.g do
+            definitions_tag + path_tag
+          end
+        end
+
+        def path_tag
+          tag.g do
+            points.select(&:complete?).each do |point|
+              concat marker_for(point)
+            end
+          end
+        end
+
+        def definitions_tag
+          tag.defs do
+            cross_tag unless marker_id
+          end
+        end
+
+        def cross_tag
+          tag.symbol id:, x:, y:, width:, height: do
+            line_tag + line_tag(invert_x: true)
+          end
+        end
+
+        def line_tag(invert_x: false)
+          tag.line x1: invert_x ? marker_size : marker_margin, x2: invert_x ? marker_margin : marker_size, y1:, y2:,
+                   class: 'series-path'
+        end
+
+        def marker_for(point)
+          tag.use href: marker_id || "##{id}", x: Percentage.new(point.x), y: Percentage.new(point.y),
+                  class: ['series-path', color_class]
+        end
+
+        def id
+          [id_hash, :marker].join('-')
+        end
+
+        def x
+          total_size / -2
+        end
+
+        def y
+          total_size / -2
+        end
+
+        def width
+          total_size
+        end
+
+        def height
+          total_size
+        end
+
+        def y1
+          marker_margin
+        end
+
+        def y2
+          marker_size
+        end
+
+        def total_size
+          marker_size + marker_margin
+        end
+      end
+    end
+  end
+end

data/app/helpers/rcharts/graph_helper/series/series_builder.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module RCharts
+  module GraphHelper
+    module Series
+      # = \Series Builder
+      class SeriesBuilder < ElementBuilder
+        ##
+        # :attr_accessor:
+        attribute :name
+
+        ##
+        # :attr_accessor: index
+        attribute :index, :integer, default: 0
+
+        attribute :composition, default: -> { Graph::Composition.new }
+        attribute :series_options, default: -> { {} }
+        attribute :id_hash, :string, default: -> { SecureRandom.hex(4) }
+
+        # Renders the series as a line plot. Passes through <tt>:data</tt>, and <tt>:aria</tt>,
+        # and <tt>:class</tt> options to the tag builder.
+        #   <%= graph_for @sales do |graph| %>
+        #     <%= graph.series do |series| %>
+        #       <%= series.line smooth: 0.12 %>
+        #     <% end %>
+        #   <% end %>
+        #
+        # ==== Options
+        # [<tt>:smooth</tt>] Smoothing factor for the line.
+        # [<tt>:axis</tt>] The axis for the series. Defaults to the first continuous axis.
+        # [<tt>:inline_axis</tt>] The axis for the categories. Defaults to the first discrete axis.
+        def line(**)
+          path_tag(**)
+        end
+
+        # Renders the series as an area plot. Passes through <tt>:data</tt>, and <tt>:aria</tt>,
+        # and <tt>:class</tt> options to the tag builder.
+        #   <%= graph_for @sales do |graph| %>
+        #     <%= graph.series do |series| %>
+        #       <%= series.area smooth: 0.12 %>
+        #     <% end %>
+        #   <% end %>
+        #
+        # ==== Options
+        # [<tt>:smooth</tt>] Smoothing factor for the area.
+        # [<tt>:axis</tt>] The axis for the series. Defaults to the first continuous axis.
+        # [<tt>:inline_axis</tt>] The axis for the categories. Defaults to the first discrete axis.
+        def area(**)
+          area_tag(sign: :positive, **) + area_tag(sign: :negative, **)
+        end
+
+        # Renders the series as a scatter plot. Passes through <tt>:data</tt>, and <tt>:aria</tt>,
+        # and <tt>:class</tt> options to the tag builder.
+        #   <%= graph_for @sales do |graph| %>
+        #     <%= graph.series do |series| %>
+        #       <%= series.scatter %>
+        #     <% end %>
+        #   <% end %>
+        # ==== Options
+        # [<tt>:marker_size</tt>] Size of the markers. Defaults to <tt>10.0</tt>.
+        # [<tt>:marker_margin</tt>] Margin around the marker symbol. Defaults to <tt>2.0</tt>.
+        # [<tt>:marker_id</tt>] ID of a custom marker symbol (a <tt><symbol></tt> element).
+        # [<tt>:axis</tt>] The axis for the series. Defaults to the first continuous axis.
+        # [<tt>:inline_axis</tt>] The axis for the categories. Defaults to the first discrete axis.
+        def scatter(**)
+          scatter_tag(**)
+        end
+
+        private
+
+        def path_tag(axis: nil, inline_axis: nil, **)
+          resolve_axis :continuous, axis do |continuous_axis|
+            resolve_axis :discrete, inline_axis do |discrete_axis|
+              render PathElement.new(series: current_points(discrete_axis, continuous_axis),
+                                     horizontal: discrete_axis.horizontal?, series_options:, index:, id_hash:, **)
+            end
+          end
+        end
+
+        def area_tag(sign: nil, axis: nil, inline_axis: nil, **)
+          resolve_axis :continuous, axis do |continuous_axis|
+            resolve_axis :discrete, inline_axis do |discrete_axis|
+              render AreaElement.new(series: current_points(discrete_axis, continuous_axis, signed: sign),
+                                     previous_series: previous_points(discrete_axis, continuous_axis, signed: sign),
+                                     mask_series: mask_points(discrete_axis, continuous_axis),
+                                     block_position: block_position(continuous_axis),
+                                     horizontal: discrete_axis.horizontal?,
+                                     series_options:, index:, id_hash:, **)
+            end
+          end
+        end
+
+        def scatter_tag(axis: nil, inline_axis: nil, **)
+          resolve_axis :continuous, axis do |continuous_axis|
+            resolve_axis :discrete, inline_axis do |discrete_axis|
+              render ScatterElement.new(series: current_points(discrete_axis, continuous_axis),
+                                        horizontal: discrete_axis.horizontal?,
+                                        series_options:, index:, id_hash:, **)
+            end
+          end
+        end
+
+        def current_points(inline_axis, block_axis, signed: nil)
+          series(block_axis, signed:).to_h do |key, value|
+            [inline_axis.position_for(key), value.try { block_axis.position_for(it) }]
+          end
+        end
+
+        def previous_points(inline_axis, block_axis, signed: nil)
+          return [] if series(block_axis, signed:) == previous_series(block_axis, signed:)
+
+          previous_series(block_axis, signed:).to_h do |key, value|
+            [inline_axis.position_for(key), block_axis.position_for(value)]
+          end
+        end
+
+        def series(block_axis, signed: nil)
+          composition.signed(signed)
+                     .then { block_axis.stacked? ? it.stacked : it }
+                     .then { it[name] }
+        end
+
+        def previous_series(block_axis, signed: nil)
+          composition.signed(signed)
+                     .then { block_axis.stacked? ? it.stacked(exclude_current: true) : it }
+                     .then { it[name] }
+        end
+
+        def mask_points(inline_axis, block_axis)
+          composition.sum_complete.to_h do |key, value|
+            [inline_axis.position_for(key), value.try { block_axis.position_for(it) }]
+          end
+        end
+
+        def block_position(block_axis)
+          block_axis.position_for([block_axis.adjusted_minimum, 0].max)
+        end
+
+        def resolve_axis(type, name = nil, &)
+          (name ? composition.axes.fetch(*name) : composition.axes.public_send(type)).then(&)
+        end
+      end
+    end
+  end
+end

data/app/helpers/rcharts/graph_helper/tooltips/entry_builder.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RCharts
+  module GraphHelper
+    module Tooltips
+      # = Tooltip Entry Builder
+      class EntryBuilder < ElementBuilder
+        ##
+        # :attr_accessor:
+        attribute :value
+
+        ##
+        # :attr_accessor:
+        attribute :name
+
+        ##
+        # :attr_accessor: index
+        attribute :index, :integer, default: 0
+
+        attribute :series_options, default: -> { {} }
+
+        # Renders the symbol associated with the series. You can override this on a per-series basis using
+        # <tt>:series_options</tt> with GraphHelper#graph_for.
+        # To change the global set of symbols and colors, see RCharts.symbol_for and RCharts.color_class_for.
+        #   <%= graph_for @sales do |graph| %>
+        #     <%= graph.legend do |series| %>
+        #       <%= series.symbol %>
+        #       <%= series.name %>
+        #     <% end %>
+        #   <% end %>
+        def symbol
+          tag.span symbol_character, class: ['series-symbol', color_class]
+        end
+
+        private
+
+        def color_class
+          series_options.fetch(:color_class, RCharts.color_class_for(index))
+        end
+
+        def symbol_character
+          series_options.fetch(:symbol, RCharts.symbol_for(index))
+        end
+      end
+    end
+  end
+end

data/app/helpers/rcharts/graph_helper/tooltips/foreign_object_element.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module RCharts
+  module GraphHelper
+    module Tooltips
+      class ForeignObjectElement < Element # :nodoc:
+        attribute :inline_position, :'rcharts/percentage', default: Percentage::MIN
+        attribute :inline_axis, :'rcharts/symbol'
+        attribute :index, :integer, default: 0
+        attribute :values_count, :integer, default: 0
+
+        private
+
+        def tags(&)
+          tag.foreignObject width:, height:, x:, y:, class: 'tooltip-object' do
+            container_tag(&)
+          end
+        end
+
+        def container_tag(&)
+          tag.div class: ['tooltip-container', { 'anchor-end' => anchor_bottom?, 'justify-end' => anchor_right? }], &
+        end
+
+        def x
+          return unless horizontal_inline_axis?
+
+          anchor_right? ? Percentage::MIN : inline_position
+        end
+
+        def y
+          return if horizontal_inline_axis?
+
+          anchor_bottom? ? Percentage::MIN : inline_position
+        end
+
+        def width
+          return Percentage::MAX unless horizontal_inline_axis?
+
+          anchor_left? ? Percentage::MAX - inline_position : inline_position
+        end
+
+        def height
+          return Percentage::MAX if horizontal_inline_axis?
+
+          anchor_top? ? Percentage::MAX - inline_position : inline_position
+        end
+
+        def anchor_right?
+          return true unless horizontal_inline_axis?
+
+          first_half? == false
+        end
+
+        def anchor_left?
+          return false unless horizontal_inline_axis?
+
+          first_half?
+        end
+
+        def anchor_top?
+          return false if horizontal_inline_axis?
+
+          first_half?
+        end
+
+        def anchor_bottom?
+          return false if horizontal_inline_axis?
+
+          first_half? == false
+        end
+
+        def horizontal_inline_axis?
+          inline_axis == :x
+        end
+
+        def first_half?
+          return if values_count.zero? # rubocop:disable Style/ReturnNilInPredicateMethodDefinition
+
+          index < values_count / 2.0
+        end
+      end
+    end
+  end
+end

data/app/helpers/rcharts/graph_helper/tooltips/hover_target_element.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RCharts
+  module GraphHelper
+    module Tooltips
+      class HoverTargetElement < Element # :nodoc:
+        attribute :inline_position, :'rcharts/percentage', default: Percentage::MIN
+        attribute :inline_size, :'rcharts/percentage', default: Percentage::MIN
+        attribute :inline_axis, :'rcharts/symbol'
+
+        private
+
+        def tags(&)
+          tag.rect x:, y:, width:, height:, class: 'tooltip-hover-target'
+        end
+
+        def x
+          inline_position - (inline_size / 2) if horizontal_inline_axis?
+        end
+
+        def y
+          inline_position - (inline_size / 2) unless horizontal_inline_axis?
+        end
+
+        def width
+          horizontal_inline_axis? ? inline_size : Percentage::MAX
+        end
+
+        def height
+          horizontal_inline_axis? ? Percentage::MAX : inline_size
+        end
+
+        def horizontal_inline_axis?
+          inline_axis == :x
+        end
+      end
+    end
+  end
+end

data/app/helpers/rcharts/graph_helper/tooltips/marker_element.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module RCharts
+  module GraphHelper
+    module Tooltips
+      class MarkerElement < Element # :nodoc:
+        attribute :inline_position, :'rcharts/percentage'
+        attribute :inline_axis, :'rcharts/symbol'
+
+        private
+
+        def tags(&)
+          tag.line x1:, x2:, y1:, y2:, class: 'tooltip-marker'
+        end
+
+        def x1
+          horizontal_inline_axis? ? inline_position : Percentage::MIN
+        end
+
+        def x2
+          horizontal_inline_axis? ? inline_position : Percentage::MAX
+        end
+
+        def y1
+          horizontal_inline_axis? ? Percentage::MIN : inline_position
+        end
+
+        def y2
+          horizontal_inline_axis? ? Percentage::MAX : inline_position
+        end
+
+        def horizontal_inline_axis?
+          inline_axis == :x
+        end
+      end
+    end
+  end
+end

data/app/helpers/rcharts/graph_helper/tooltips/tooltip_builder.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RCharts
+  module GraphHelper
+    module Tooltips
+      # = Tooltip Builder
+      class TooltipBuilder < ElementBuilder
+        ##
+        # :attr_accessor:
+        attribute :name
+
+        attribute :values, default: -> { {} }
+        attribute :series_options, default: -> { {} }
+
+        # Renders one or more series present in the data. For each series yields an EntryBuilder which
+        # contains the index, key, and value. See EntryBuilder for details.
+        #   <%= graph_for @annual_sales do |graph| %>
+        #     <%= graph.tooltips do |category| %>
+        #       <h4><%= category.name %></h4>
+        #       <%= category.series do |series| %>
+        #         <%= series.name %>
+        #         <%= series.value %>
+        #       <% end %>
+        #     <% end %>
+        #   <% end %>
+        def series(**, &)
+          capture do
+            series_options.each_key.with_index do |key, index|
+              concat series_tag(key, index, **, &)
+            end
+          end
+        end
+
+        private
+
+        def series_tag(name, index, **, &)
+          tag.div(**) do
+            render EntryBuilder.new(name:, value: values[name], index:, series_options: series_options[name]), &
+          end
+        end
+      end
+    end
+  end
+end

data/app/helpers/rcharts/graph_helper/tooltips/tooltip_element.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RCharts
+  module GraphHelper
+    module Tooltips
+      class TooltipElement < Element # :nodoc:
+        attribute :inline_position, :'rcharts/percentage', default: Percentage::MIN
+        attribute :inline_size, :'rcharts/percentage', default: Percentage::MIN
+        attribute :inline_axis, :'rcharts/symbol'
+        attribute :index, :integer, default: 0
+        attribute :values_count, :integer, default: 0
+
+        def tags(&)
+          tag.g class: 'tooltip' do
+            hover_target_tag + marker_tag + tooltip_tag(&)
+          end
+        end
+
+        private
+
+        def tooltip_tag(&)
+          foreign_object_tag do
+            content_tag(&)
+          end
+        end
+
+        def foreign_object_tag(&)
+          render ForeignObjectElement.new(inline_position:, inline_axis:, index:, values_count:), &
+        end
+
+        def content_tag(&)
+          tag.div class: 'tooltip-content', &
+        end
+
+        def marker_tag
+          render MarkerElement.new(inline_position:, inline_axis:)
+        end
+
+        def hover_target_tag
+          render HoverTargetElement.new(inline_position:, inline_size:, inline_axis:)
+        end
+      end
+    end
+  end
+end