glimmer-libui-cc-graphs_and_charts 0.1.8 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5c81413f717dac087558fbed16937659603f9bb6a4a2b849cadf31bade1750c
-  data.tar.gz: c76f09ab3cff5d2486c45c59841ed1bacff95ad6d7b63033e01965318adef73e
+  metadata.gz: 263ed1c13a5130568949ac82714104e494a4e8ffd1ded95fec7d14110d5fc364
+  data.tar.gz: 2eea70d52135a1381d2ae30c2fb03dac37f5a07c0f74ba94875ea8a5fb82b867
 SHA512:
-  metadata.gz: 82239ec1af1f0186761ac787f94d2f5756abc9cc17ea67dbaf5f38f9b27c35cc834c947f46df19309bee5f425d9a764a0ed335163bcc764a2e84b44d6ebf7b4a
-  data.tar.gz: 65c1a640f16352f4ec249bff010824872b4c7bea47d818d7264fc4c2b9c57ab40307f32fa0f22c449944d3d7ab51cd07d4ae513e12255d2a7da9de4cb6e46fe3
+  metadata.gz: 8cf72862f552c4d9de06163653465ea4cf4779f371080b8fb4a345fa1bce9315ad190e12c8cdffaf71ae546d43510804d1574e12a7080e30a35901e3e842d947
+  data.tar.gz: cff63fd75943908ee9084e821c7a6a32d517c729796cbdc705f4928431f27540d904c0ea1080c9248a0542a43cbc660e652d07b0cb69e8e641153956d1354e47

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 0.2.1
+
+- Fix clipped text of grid markers when they include 1000 displayed as 1K
+
+## 0.2.0
+
+- Initial implementation of `bar_chart` custom control
+- New `examples/graphs_and_charts/basic_bar_chart.rb`
+
 ## 0.1.8
 
 - Fix the display of grid marker lines when passing `values` with non-Integer y-axis values (especially max y-axis value being non-Integer). It now shows highest grid marker having a non-Integer value while keeping smaller values as Integer (e.g. 1, 2, 3, 3.75).

data/README.md

@@ -1,10 +1,12 @@
-# Graphs and Charts 0.1.8 (Alpha)
+# Graphs and Charts 0.2.1 (Alpha)
 ## [Glimmer DSL for LibUI](https://github.com/AndyObtiva/glimmer-dsl-libui) Custom Controls
 [![Gem Version](https://badge.fury.io/rb/glimmer-libui-cc-graphs_and_charts.svg)](http://badge.fury.io/rb/glimmer-libui-cc-graphs_and_charts)
 [![Join the chat at https://gitter.im/AndyObtiva/glimmer](https://badges.gitter.im/AndyObtiva/glimmer.svg)](https://gitter.im/AndyObtiva/glimmer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Graphs and Charts (Custom Controls) for [Glimmer DSL for LibUI](https://github.com/AndyObtiva/glimmer-dsl-libui)
 
+![bar chart](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-bar-chart.png)
+
 ![line graph](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-line-graph-relative.png)
 
 ## Setup
@@ -12,7 +14,7 @@ Graphs and Charts (Custom Controls) for [Glimmer DSL for LibUI](https://github.c
 Add this line to Bundler `Gemfile`:
 
 ```ruby
-gem 'glimmer-libui-cc-graphs_and_charts', '~> 0.1.8'
+gem 'glimmer-libui-cc-graphs_and_charts', '~> 0.2.1'
 ```
 
 Run:
@@ -31,6 +33,89 @@ However, if you prefer to load all graphs and charts, add this line to your Ruby
 require 'glimmer-libui-cc-graphs_and_charts'
 ```
 
+### Bar Chart
+
+To load the `bar_chart` custom control, add this line to your Ruby file:
+
+```ruby
+require 'glimmer/view/bar_chart'
+```
+
+This makes the `bar_chart` [Glimmer DSL for LibUI Custom Control](https://github.com/AndyObtiva/glimmer-dsl-libui#custom-components) available in the Glimmer GUI DSL.
+You can then nest `bar_chart` under `window` or some container like `vertical_box`. By the way, `bar_chart` is implemented on top of the [`area` Glimmer DSL for LibUI control](https://github.com/AndyObtiva/glimmer-dsl-libui#area-api).
+
+`values` are a `Hash` map of `String` x-axis values to `Numeric` y-axis values.
+
+```ruby
+bar_chart(
+  width: 900,
+  height: 300,
+  values: {
+    'Jan' => 30,
+    'Feb' => 49,
+    'Mar' => 58,
+    'Apr' => 63,
+    'May' => 72,
+    'Jun' => 86,
+    'Jul' => 95,
+    'Aug' => 100,
+    'Sep' => 84,
+    'Oct' => 68,
+    'Nov' => 52,
+    'Dec' => 36,
+  }
+)
+```
+
+![basic bar chart](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-bar-chart.png)
+
+Look into [lib/glimmer/view/bar_chart.rb](/lib/glimmer/view/bar_chart.rb) to learn about all supported options.
+
+**Basic Bar Chart Example:**
+
+[examples/graphs_and_charts/basic_bar_chart.rb](/examples/graphs_and_charts/basic_bar_chart.rb)
+
+```ruby
+require 'glimmer-dsl-libui'
+require 'glimmer/view/bar_chart'
+
+class BasicBarChart
+  include Glimmer::LibUI::Application
+  
+  body {
+    window('Basic Bar Chart', 900, 300) { |main_window|
+      @bar_chart = bar_chart(
+        width: 900,
+        height: 300,
+        values: {
+          'Jan' => 30,
+          'Feb' => 49,
+          'Mar' => 58,
+          'Apr' => 63,
+          'May' => 72,
+          'Jun' => 86,
+          'Jul' => 95,
+          'Aug' => 100,
+          'Sep' => 84,
+          'Oct' => 68,
+          'Nov' => 52,
+          'Dec' => 36,
+        }
+      )
+      
+      on_content_size_changed do
+        @bar_chart.width = main_window.content_size[0]
+        @bar_chart.height = main_window.content_size[1]
+      end
+    }
+  }
+end
+
+BasicBarChart.launch
+```
+
+![basic bar chart](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-bar-chart.png)
+
 ### Line Graph
 
 To load the `line_graph` custom control, add this line to your Ruby file:
@@ -51,36 +136,36 @@ Note that you can use in absolute mode or relative mode for determining x-axis v
 It supports any `Numeric` y-axis values in addition to `Time` x-axis values.
 
 ```ruby
-      @line_graph = line_graph(
-        width: 900,
-        height: 300,
-        lines: [
-          {
-            name: 'Stock 1',
-            stroke: [163, 40, 39, thickness: 2],
-            values: {
-              Time.new(2030, 12, 1) => 80,
-              Time.new(2030, 12, 2) => 36,
-              Time.new(2030, 12, 4) => 10,
-              Time.new(2030, 12, 5) => 60,
-              Time.new(2030, 12, 6) => 20,
-            },
-            x_value_format: -> (time) {time.strftime("%a %d %b %Y %T GMT")},
-          },
-          {
-            name: 'Stock 2',
-            stroke: [47, 109, 104, thickness: 2],
-            values: {
-              Time.new(2030, 12, 1) => 62,
-              Time.new(2030, 12, 2) => 0,
-              Time.new(2030, 12, 3) => 90,
-              Time.new(2030, 12, 5) => 0,
-              Time.new(2030, 12, 7) => 17,
-            },
-            x_value_format: -> (time) {time.strftime("%a %d %b %Y %T GMT")},
-          },
-        ],
-      )
+line_graph(
+  width: 900,
+  height: 300,
+  lines: [
+    {
+      name: 'Stock 1',
+      stroke: [163, 40, 39, thickness: 2],
+      values: {
+        Time.new(2030, 12, 1) => 80,
+        Time.new(2030, 12, 2) => 36,
+        Time.new(2030, 12, 4) => 10,
+        Time.new(2030, 12, 5) => 60,
+        Time.new(2030, 12, 6) => 20,
+      },
+      x_value_format: -> (time) {time.strftime("%a %d %b %Y %T GMT")},
+    },
+    {
+      name: 'Stock 2',
+      stroke: [47, 109, 104, thickness: 2],
+      values: {
+        Time.new(2030, 12, 1) => 62,
+        Time.new(2030, 12, 2) => 0,
+        Time.new(2030, 12, 3) => 90,
+        Time.new(2030, 12, 5) => 0,
+        Time.new(2030, 12, 7) => 17,
+      },
+      x_value_format: -> (time) {time.strftime("%a %d %b %Y %T GMT")},
+    },
+  ],
+)
 ```
 
 ![basic line graph](/screenshots/glimmer-libui-cc-graphs_and_charts-mac-basic-line-graph.png)

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.2.1

data/examples/graphs_and_charts/basic_bar_chart.rb

@@ -0,0 +1,39 @@
+# This line is only needed when running the example from inside the project directory
+$LOAD_PATH.prepend(File.expand_path(File.join(__dir__, '..', '..', 'lib'))) if File.exist?(File.join(__dir__, '..', '..', 'lib'))
+
+require 'glimmer-dsl-libui'
+require 'glimmer/view/bar_chart'
+
+class BasicBarChart
+  include Glimmer::LibUI::Application
+  
+  body {
+    window('Basic Bar Chart', 900, 300) { |main_window|
+      @bar_chart = bar_chart(
+        width: 900,
+        height: 300,
+        values: {
+          'Jan' => 30,
+          'Feb' => 49,
+          'Mar' => 58,
+          'Apr' => 63,
+          'May' => 72,
+          'Jun' => 86,
+          'Jul' => 95,
+          'Aug' => 100,
+          'Sep' => 84,
+          'Oct' => 68,
+          'Nov' => 52,
+          'Dec' => 36,
+        }
+      )
+      
+      on_content_size_changed do
+        @bar_chart.width = main_window.content_size[0]
+        @bar_chart.height = main_window.content_size[1]
+      end
+    }
+  }
+end
+
+BasicBarChart.launch

data/glimmer-libui-cc-graphs_and_charts.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: glimmer-libui-cc-graphs_and_charts 0.1.8 ruby lib
+# stub: glimmer-libui-cc-graphs_and_charts 0.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "glimmer-libui-cc-graphs_and_charts".freeze
-  s.version = "0.1.8".freeze
+  s.version = "0.2.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2023-12-26"
+  s.date = "2023-12-29"
   s.description = "Graphs and Charts (Custom Controls) for Glimmer DSL for LibUI, like Line Graph.".freeze
   s.email = "andy.am@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -24,15 +24,17 @@ Gem::Specification.new do |s|
     "LICENSE.txt",
     "README.md",
     "VERSION",
+    "examples/graphs_and_charts/basic_bar_chart.rb",
     "examples/graphs_and_charts/basic_line_graph.rb",
     "examples/graphs_and_charts/basic_line_graph_relative.rb",
     "glimmer-libui-cc-graphs_and_charts.gemspec",
     "lib/glimmer-libui-cc-graphs_and_charts.rb",
+    "lib/glimmer/view/bar_chart.rb",
     "lib/glimmer/view/line_graph.rb"
   ]
   s.homepage = "http://github.com/AndyObtiva/glimmer-libui-cc-graphs_and_charts".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.5.1".freeze
+  s.rubygems_version = "3.5.3".freeze
   s.summary = "Graphs and Charts - Glimmer DSL for LibUI Custom Controls".freeze
 
   s.specification_version = 4

data/lib/glimmer/view/bar_chart.rb

@@ -0,0 +1,249 @@
+require 'glimmer-dsl-libui'
+
+module Glimmer
+  module View
+    # General-Purpose Bar Chart Custom Control
+    class BarChart
+      class << self
+        def interpret_color(color_object)
+          # TODO refactor move this method to somewhere common like Glimmer module
+          @color_cache ||= {}
+          @color_cache[color_object] ||= Glimmer::LibUI.interpret_color(color_object)
+        end
+      end
+    
+      include Glimmer::LibUI::CustomControl
+      
+      DEFAULT_CHART_PADDING_WIDTH = 5.0
+      DEFAULT_CHART_PADDING_HEIGHT = 5.0
+      DEFAULT_CHART_GRID_MARKER_PADDING_WIDTH = 37.0
+      DEFAULT_CHART_BAR_PADDING_WIDTH_PERCENTAGE = 30.0
+      
+      DEFAULT_CHART_STROKE_GRID = [185, 184, 185]
+      DEFAULT_CHART_STROKE_MARKER = [185, 184, 185]
+      DEFAULT_CHART_STROKE_MARKER_LINE = [217, 217, 217, thickness: 1, dashes: [1, 1]]
+      
+      DEFAULT_CHART_COLOR_BAR = [92, 122, 190]
+      DEFAULT_CHART_COLOR_MARKER_TEXT = [96, 96, 96]
+      
+      DEFAULT_CHART_FONT_MARKER_TEXT = {family: "Arial", size: 14}
+      
+      option :width, default: 600
+      option :height, default: 200
+      
+      option :chart_padding_width, default: DEFAULT_CHART_PADDING_WIDTH
+      option :chart_padding_height, default: DEFAULT_CHART_PADDING_HEIGHT
+      option :chart_grid_marker_padding_width, default: DEFAULT_CHART_GRID_MARKER_PADDING_WIDTH
+      option :chart_bar_padding_width_percentage, default: DEFAULT_CHART_BAR_PADDING_WIDTH_PERCENTAGE
+      
+      option :chart_stroke_grid, default: DEFAULT_CHART_STROKE_GRID
+      option :chart_stroke_marker, default: DEFAULT_CHART_STROKE_MARKER
+      option :chart_stroke_marker_line, default: DEFAULT_CHART_STROKE_MARKER_LINE
+      
+      option :chart_color_bar, default: DEFAULT_CHART_COLOR_BAR
+      option :chart_color_marker_text, default: DEFAULT_CHART_COLOR_MARKER_TEXT
+      
+      option :chart_font_marker_text, default: DEFAULT_CHART_FONT_MARKER_TEXT
+      
+      # Hash map of x-axis values (String) to y-axis values (Numeric)
+      # Example:
+      # {
+      #   '1' => 38,
+      #   '2' => 83,
+      #   '3' => 48,
+      #   '4' => 83,
+      #   '5' => 92,
+      #   '6' => 13,
+      #   '7' => 03,
+      # }
+      option :values, default: {}
+      
+      attr_reader :bar_width_including_padding
+      
+      after_body do
+        observe(self, :values) do
+          clear_drawing_cache
+          body_root.queue_redraw_all
+        end
+        observe(self, :width) do
+          clear_drawing_cache
+        end
+        observe(self, :height) do
+          clear_drawing_cache
+        end
+      end
+  
+      body {
+        area { |chart_area|
+          on_draw do
+            calculate_dynamic_options
+            chart_background
+            grid_lines
+            bars
+          end
+        }
+      }
+      
+      private
+      
+      def clear_drawing_cache
+        @y_resolution = nil
+        @bar_width_including_padding = nil
+        @grid_marker_points = nil
+        @grid_marker_number_values = nil
+        @grid_marker_numbers = nil
+        @chart_stroke_marker_values = nil
+        @mod_values = nil
+      end
+      
+      def calculate_dynamic_options
+        calculate_bar_width_including_padding
+      end
+      
+      def calculate_bar_width_including_padding
+        return if values.empty?
+        
+        @bar_width_including_padding ||= begin
+          value = width_drawable / (values.size - 1).to_f
+          [value, width_drawable].min
+        end
+      end
+      
+      def bar_width
+        @bar_width_including_padding*((100.0 - chart_bar_padding_width_percentage)/100.0)
+      end
+      
+      def bar_padding_width
+        @bar_width_including_padding*(chart_bar_padding_width_percentage/100.0)
+      end
+      
+      def width_drawable
+        width - 2.0*chart_padding_width - chart_grid_marker_padding_width
+      end
+      
+      def height_drawable
+        height - 2.0*chart_padding_height
+      end
+      
+      def chart_background
+        rectangle(0, 0, width, height) {
+          fill 255, 255, 255
+        }
+      end
+  
+      def grid_lines
+        line(chart_padding_width, chart_padding_height, chart_padding_width, height - chart_padding_height) {
+          stroke chart_stroke_grid
+        }
+        line(chart_padding_width, height - chart_padding_height, width - chart_padding_width, height - chart_padding_height) {
+          stroke chart_stroke_grid
+        }
+        grid_marker_number_font = chart_font_marker_text.merge(size: 11)
+        @grid_marker_number_values ||= []
+        @grid_marker_numbers ||= []
+        @chart_stroke_marker_values ||= []
+        @mod_values ||= []
+        grid_marker_points.each_with_index do |marker_point, index|
+          @grid_marker_number_values[index] ||= begin
+            value = (grid_marker_points.size - index).to_i
+            value = y_value_max if !y_value_max.nil? && y_value_max.to_i != y_value_max && index == 0
+            value
+          end
+          grid_marker_number_value = @grid_marker_number_values[index]
+          @grid_marker_numbers[index] ||= (grid_marker_number_value >= 1000) ? "#{grid_marker_number_value / 1000}K" : grid_marker_number_value.to_s
+          grid_marker_number = @grid_marker_numbers[index]
+          @chart_stroke_marker_values[index] ||= BarChart.interpret_color(chart_stroke_marker).tap do |color_hash|
+            color_hash[:thickness] = (index != grid_marker_points.size - 1 ? 2 : 1) if color_hash[:thickness].nil?
+          end
+          chart_stroke_marker_value = @chart_stroke_marker_values[index]
+          @mod_values[index] ||= begin
+            mod_value_multiplier = ((grid_marker_points.size / max_marker_count) + 1)
+            [(5 * mod_value_multiplier), 1].max
+          end
+          mod_value = @mod_values[index]
+          comparison_value = (mod_value > 2) ? 0 : 1
+          if mod_value > 2
+            if grid_marker_number_value % mod_value == comparison_value
+              line(marker_point[:x], marker_point[:y], marker_point[:x] + 4, marker_point[:y]) {
+                stroke chart_stroke_marker_value
+              }
+            end
+          else
+            line(marker_point[:x], marker_point[:y], marker_point[:x] + 4, marker_point[:y]) {
+              stroke chart_stroke_marker_value
+            }
+          end
+          if grid_marker_number_value % mod_value == comparison_value && grid_marker_number_value != grid_marker_points.size
+            line(marker_point[:x], marker_point[:y], marker_point[:x] + width - chart_padding_width, marker_point[:y]) {
+              stroke chart_stroke_marker_line
+            }
+          end
+          if grid_marker_number_value % mod_value == comparison_value || grid_marker_number_value != grid_marker_number_value.to_i
+            grid_marker_number_width = estimate_width_of_text(grid_marker_number, grid_marker_number_font)
+            text(marker_point[:x] + 4 + 3, marker_point[:y] - 6, grid_marker_number_width) {
+              string(grid_marker_number) {
+                font grid_marker_number_font
+                color chart_color_marker_text
+              }
+            }
+          end
+        end
+      end
+      
+      def grid_marker_points
+        if @grid_marker_points.nil?
+          if values.any?
+            chart_y_max = [y_value_max, 1].max
+            current_chart_height = (height - chart_padding_height * 2)
+            y_value_count = chart_y_max.ceil
+            @grid_marker_points = chart_y_max.to_i.times.map do |marker_index|
+              x = chart_padding_width
+              y_value = y_value_count - marker_index
+              scaled_y_value = y_value.to_f * y_resolution.to_f
+              y = height - chart_padding_height - scaled_y_value
+              {x: x, y: y}
+            end
+          end
+        end
+
+        @grid_marker_points
+      end
+      
+      def max_marker_count
+        [(0.15*height).to_i, 1].max
+      end
+      
+      def bars
+        values.each_with_index do |(x_value, y_value), index|
+          x = chart_grid_marker_padding_width + chart_padding_width + (index * bar_width_including_padding) + bar_padding_width
+          bar_height = y_value * y_resolution
+          y = height - chart_padding_height - bar_height
+          rectangle(x, y, bar_width, bar_height) {
+            fill chart_color_bar
+          }
+        end
+      end
+      
+      # this is the multiplier that we must multiply by the relative y value
+      def y_resolution
+        # TODO in the future, we will use the y range, but today, we assume it starts at 0
+        @y_resolution ||= height_drawable.to_f / y_value_max.to_f
+      end
+      
+      def y_value_max
+        if @y_value_max.nil?
+          @y_value_max = values.values.max.to_f
+        end
+        @y_value_max
+      end
+      
+      def estimate_width_of_text(text_string, font_properties)
+        # TODO refactor move this method to somewhere common like Glimmer module
+        font_size = font_properties[:size] || 16
+        estimated_font_width = 0.62 * font_size
+        text_string.chars.size * estimated_font_width
+      end
+      
+    end
+  end
+end

data/lib/glimmer/view/line_graph.rb

@@ -142,7 +142,6 @@ module Glimmer
         @grid_marker_numbers = nil
         @graph_stroke_marker_values = nil
         @mod_values = nil
-        @estimated_widths_of_text = nil
       end
       
       def calculate_dynamic_options
@@ -554,7 +553,7 @@ module Glimmer
       
       def estimate_width_of_text(text_string, font_properties)
         font_size = font_properties[:size] || 16
-        estimated_font_width = 0.6 * font_size
+        estimated_font_width = 0.62 * font_size
         text_string.chars.size * estimated_font_width
       end
       

data/lib/glimmer-libui-cc-graphs_and_charts.rb

@@ -1,4 +1,5 @@
 $LOAD_PATH.unshift(File.expand_path('..', __FILE__))
 
 require 'glimmer-dsl-libui'
+require 'glimmer/view/bar_chart'
 require 'glimmer/view/line_graph'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimmer-libui-cc-graphs_and_charts
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.1
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-26 00:00:00.000000000 Z
+date: 2023-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glimmer-dsl-libui
@@ -80,10 +80,12 @@ files:
 - LICENSE.txt
 - README.md
 - VERSION
+- examples/graphs_and_charts/basic_bar_chart.rb
 - examples/graphs_and_charts/basic_line_graph.rb
 - examples/graphs_and_charts/basic_line_graph_relative.rb
 - glimmer-libui-cc-graphs_and_charts.gemspec
 - lib/glimmer-libui-cc-graphs_and_charts.rb
+- lib/glimmer/view/bar_chart.rb
 - lib/glimmer/view/line_graph.rb
 homepage: http://github.com/AndyObtiva/glimmer-libui-cc-graphs_and_charts
 licenses:
@@ -104,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.1
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Graphs and Charts - Glimmer DSL for LibUI Custom Controls