thecore_ui_commons 3.1.10 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87c2966541fdcdcb1beeba67e8fb04468aa7a428dc57d9851b0b2c45e6cba5a6
-  data.tar.gz: '096f7948a603a489ad0873dd63c8dd16c9e054bb5664c3a34d5e076750018cb4'
+  metadata.gz: 5675378f9ff9fbfc745eae4fd8284a7c068440f1594ec13a0f6e4e7b486267c3
+  data.tar.gz: d468bfc1369d418e2053159325b86f0c0fbe960a80f810dcd3d424e93a75eb96
 SHA512:
-  metadata.gz: 4f9014087a7de338543f4540ea5d41d97451a4cf37282ddd1cf539c2bec906e7520e044c19e7948a7fabd3155bc146c52da7aece19fbfd1c30b0b5ba07ac8716
-  data.tar.gz: 28fdcad468147da5faef695eb53c97d90aa5d427e7b57158f801e43e0b86a4787d07b967ce5ab43ac7ac2ff9577ab2a0f9b21d1487f33434aecc87c160bdd439
+  metadata.gz: 9385b2c24d2f9d8cadcadfb89983dcd49d50339590a379597712b5341503565dab84c2e80c456579f0a68e962a48a6cfac70478a37b0ec87795b1f9da00be8da
+  data.tar.gz: 3031a3698af5e067f2c2bc0e26484f2595e2a61b2efead74349a2070f8f3e5c9e5475d10f040c070a149e75cdfe489cac2a16e8cee372ee2592d8cb6a2519483

data/app/assets/javascripts/thecore_ui_commons.js

@@ -1 +1,2 @@
-// This file can be overridden in your engine
+//= require echarts.min.js
+//= require echarts/theme/dark.js

data/lib/echarts/speedometer.rb

@@ -0,0 +1,163 @@
+
+module Echarts
+  module Speedometer
+    # Computes the percentage of a value within a given range.
+    #
+    # @param value [Numeric] The value to compute the percentage for.
+    # @param lower_bound [Numeric] The lower bound of the range.
+    # @param upper_bound [Numeric] The upper bound of the range.
+    # @return [Float] The percentage of the value within the range.
+    def self.compute_percentage(value, lower_bound, upper_bound)
+      (value - lower_bound) / (upper_bound - lower_bound)
+    end
+
+    # Computes the angle for a given value.
+    #
+    # @param value [Float] The value to compute the angle for.
+    # @return [Float] The angle in degrees.
+    def self.compute_angle(value)
+      # Compute the angles from the percentages knowing that the startAngle = 225 and the endAngle = -45 clockwise
+      225 - (value * 270)
+    end
+
+    # Computes the angles for a given value and the minimum and maximum values in percentage.
+    #
+    # @param value_in_percentage [Float] The value in percentage.
+    # @param min_in_percentage [Float] The minimum value in percentage.
+    # @param max_in_percentage [Float] The maximum value in percentage.
+    # @return [Array<Float>] The minimum angle, maximum angle, and value angle in degrees.
+    def self.compute_angles(value_in_percentage, min_in_percentage, max_in_percentage)
+      min_angle = compute_angle(min_in_percentage)
+      max_angle = compute_angle(max_in_percentage)
+      value_angle = compute_angle(value_in_percentage)
+
+      return min_angle, max_angle, value_angle
+    end
+
+    # Computes the color for the gauge chart based on the minimum and maximum values.
+    #
+    # @param min [Numeric] The minimum value.
+    # @param max [Numeric] The maximum value.
+    # @param min_in_percentage [Float] The minimum value in percentage.
+    # @param max_in_percentage [Float] The maximum value in percentage.
+    # @param color_ok [String] The color for values within the range.
+    # @param color_error [String] The color for values outside the range.
+    # @param color_generic [String] The color for generic values.
+    # @return [Array<Array>] An array of color values and their corresponding percentages.
+    def self.compute_color(min, max, min_in_percentage, max_in_percentage, color_ok = "limegreen", color_error = "tomato", color_generic = "dodgerblue")
+      color = []
+      color << [min_in_percentage, color_error] if !min.zero? && (max > min || max.zero?)
+      color << [max_in_percentage, color_ok] if !max.zero? && (max > min || min.zero?)
+      color << [1, max > min ? color_error : ( max == min && max != 0 || max == 0 && min ==0 ? color_generic : color_ok )] 
+
+      color
+    end
+
+    # Computes the options for the gauge chart.
+    #
+    # @param value [Numeric] The value to display on the gauge chart.
+    # @param min [Numeric] The minimum value.
+    # @param max [Numeric] The maximum value.
+    # @param lower_bound [Numeric] The lower bound of the range.
+    # @param upper_bound [Numeric] The upper bound of the range.
+    # @param measure_unit [String] The unit of measurement for the value.
+    # @param name [String] The name of the gauge chart.
+    # @param color_ok [String] The color for values within the range.
+    # @param color_error [String] The color for values outside the range.
+    # @param color_generic [String] The color for generic values.
+    # @return [Hash] The options for the gauge chart.
+    def self.get_config(value, min, max, lower_bound, upper_bound, measure_unit, name, color_ok = "limegreen", color_error = "tomato", color_generic = "dodgerblue")
+      min_in_percentage = compute_percentage(min, lower_bound, upper_bound)
+      max_in_percentage = compute_percentage(max, lower_bound, upper_bound)
+      value_in_percentage = compute_percentage(value, lower_bound, upper_bound)
+
+      color = compute_color(min, max, min_in_percentage, max_in_percentage, color_ok, color_error, color_generic)
+      min_angle, max_angle, value_angle = compute_angles(value_in_percentage, min_in_percentage, max_in_percentage)
+
+      # The gauge chart
+      raw_js_options = {
+        series: [
+          {
+            type: "gauge",
+            min: lower_bound,
+            max: upper_bound,
+            splitNumber: ((upper_bound - lower_bound) / lower_bound).abs,
+            axisLine: {
+              lineStyle: {
+                width: 30,
+                color: color,
+              },
+            },
+            pointer: {
+              itemStyle: {
+                color: "auto",
+              },
+            },
+            axisTick: {
+              distance: -30,
+              length: 8,
+              lineStyle: {
+                color: "#fff",
+                width: 2,
+              },
+            },
+            splitLine: {
+              distance: -30,
+              length: 30,
+              lineStyle: {
+                color: "#fff",
+                width: 4,
+              },
+            },
+            axisLabel: {
+              color: "inherit",
+              distance: 40,
+              fontSize: 20,
+            },
+            detail: {
+              valueAnimation: true,
+              # formatter: "#{value.to_i}#{measure_unit}",
+              color: "inherit",
+            },
+            data: [
+              {
+                value: value,
+                name: name,
+              },
+            ],
+          },
+          # Dummy Gauge to be used to show the min max thresholds
+          {
+            type: "gauge",
+            z: 3,
+            startAngle: min_angle, # Here you can dinamically change the value
+            min: min,
+            endAngle: max_angle, # Here you can dinamically change the value
+            max: max,
+            splitNumber: 1,
+            axisLabel: {
+              distance: -24,
+            },
+            axisTick: {
+              show: false,
+            },
+            axisLine: {
+              lineStyle: {
+                width: 0,
+              },
+            },
+            splitLine: {
+              distance: -12,
+              # length: 50,
+              lineStyle: {
+                width: 0,
+              },
+            },
+          },
+        ],
+      }
+      
+      return raw_js_options
+    end
+  end
+end

data/lib/thecore_ui_commons/version.rb

@@ -1,3 +1,3 @@
 module ThecoreUiCommons
-  VERSION = "3.1.10".freeze
+  VERSION = "3.2.0".freeze
 end

data/lib/thecore_ui_commons.rb

@@ -5,6 +5,7 @@ require "haml-rails"
 require "groupdate"
 # require "apexcharts"
 require "rails_charts"
+require "echarts/speedometer"
 
 require "thecore_ui_commons/engine"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: thecore_ui_commons
 version: !ruby/object:Gem::Version
-  version: 3.1.10
+  version: 3.2.0
 platform: ruby
 authors:
 - Gabriele Tassoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-02 00:00:00.000000000 Z
+date: 2024-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thecore_backend_commons
@@ -142,6 +142,7 @@ files:
 - config/locales/it.yml
 - config/routes.rb
 - db/seeds.rb
+- lib/echarts/speedometer.rb
 - lib/tasks/thecore_ui_commons_tasks.rake
 - lib/thecore_ui_commons.rb
 - lib/thecore_ui_commons/engine.rb