@osimatic/helpers-js 1.4.27 → 1.4.28

package/index.js

@@ -21,7 +21,7 @@ const { HexColor, RgbColor } = require('./draw');
 const { SocialNetwork } = require('./social_network');
 const { sleep, refresh } = require('./util');
 const { chr, ord, trim, empty } = require('./php.min');
-const { NumberFormatter } = require('./number');
+const { NumberFormatter, Rating } = require('./number');
 const { Password } = require('./user');
 
 // exports plugins "maison"
@@ -52,7 +52,7 @@ const { WebSocket } = require('./web_socket');
 
 module.exports = {
 	Array, Object, Number, String,
-	HTTPClient, Cookie, UrlAndQueryString, IBAN, BankCard, AudioMedia, VideoMedia, UserMedia, PersonName, Email, TelephoneNumber, DateTime, DatePeriod, TimestampUnix, SqlDate, SqlTime, SqlDateTime, Duration, File, CSV, Img, FormHelper, Country, PostalAddress, GeographicCoordinates, Polygon, HexColor, RgbColor, SocialNetwork, NumberFormatter, Password,
+	HTTPClient, Cookie, UrlAndQueryString, IBAN, BankCard, AudioMedia, VideoMedia, UserMedia, PersonName, Email, TelephoneNumber, DateTime, DatePeriod, TimestampUnix, SqlDate, SqlTime, SqlDateTime, Duration, File, CSV, Img, FormHelper, Country, PostalAddress, GeographicCoordinates, Polygon, HexColor, RgbColor, SocialNetwork, NumberFormatter, Rating, Password,
 	Browser, DataTable, Pagination, Navigation, DetailsSubArray, SelectAll, MultipleActionInTable, MultipleActionInDivList, MultiFilesInput, EditValue, FormDate, InputPeriod, ShoppingCart, FlashMessage, CountDown, ImportFromCsv, JwtToken, JwtSession, ApiTokenSession, ListBox, WebRTC, WebSocket, EventBus,
 	sleep, refresh, chr, ord, trim, empty,
 	Chartjs, GoogleCharts, GoogleRecaptcha, GoogleMap, OpenStreetMap

package/number.js

@@ -96,4 +96,29 @@ if (!Number.random) {
 	};
 }
 
-module.exports = { NumberFormatter };
+class Rating {
+	static display(rating, maxRating = 5, imgOn = '★', imgOff = '☆', imgHalf = null) {
+		if (rating == null) {
+			return '';
+		}
+
+		const fullStars = Math.floor(rating);
+		const decimal = rating - fullStars;
+
+		let totalFull = fullStars;
+		let showHalf = false;
+
+		if (imgHalf !== null && decimal >= 0.25 && decimal < 0.75) {
+			showHalf = true;
+		}
+		else if (decimal >= (imgHalf !== null ? 0.75 : 0.5)) {
+			totalFull++;
+		}
+
+		return imgOn.repeat(totalFull)
+			+ (showHalf ? imgHalf : '')
+			+ imgOff.repeat(maxRating - totalFull - (showHalf ? 1 : 0));
+	}
+}
+
+module.exports = { NumberFormatter, Rating };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osimatic/helpers-js",
-  "version": "1.4.27",
+  "version": "1.4.28",
   "main": "main.js",
   "scripts": {
     "test": "jest",

package/tests/number.test.js

@@ -1,4 +1,49 @@
 require('../number');
+const { Rating } = require('../number');
+
+describe('Rating', () => {
+	describe('display', () => {
+		test('should return empty string for null rating', () => {
+			expect(Rating.display(null)).toBe('');
+		});
+
+		test('should display full stars only', () => {
+			expect(Rating.display(3, 5)).toBe('★★★☆☆');
+		});
+
+		test('should round up at 0.5', () => {
+			expect(Rating.display(3.5, 5)).toBe('★★★★☆');
+		});
+
+		test('should round down below 0.5', () => {
+			expect(Rating.display(3.4, 5)).toBe('★★★☆☆');
+		});
+
+		test('should display max rating', () => {
+			expect(Rating.display(5, 5)).toBe('★★★★★');
+		});
+
+		test('should display zero rating', () => {
+			expect(Rating.display(0, 5)).toBe('☆☆☆☆☆');
+		});
+
+		test('should show half star when imgHalf provided and decimal in [0.25, 0.75)', () => {
+			expect(Rating.display(3.5, 5, '★', '☆', '½')).toBe('★★★½☆');
+		});
+
+		test('should round up with imgHalf when decimal >= 0.75', () => {
+			expect(Rating.display(3.8, 5, '★', '☆', '½')).toBe('★★★★☆');
+		});
+
+		test('should round down with imgHalf when decimal < 0.25', () => {
+			expect(Rating.display(3.1, 5, '&#9733;', '&#9734;', '½')).toBe('&#9733;&#9733;&#9733;&#9734;&#9734;');
+		});
+
+		test('should support custom image strings', () => {
+			expect(Rating.display(2, 3, '[on]', '[off]')).toBe('[on][on][off]');
+		});
+	});
+});
 
 describe('NumberFormatter', () => {
 	const { NumberFormatter } = require('../number');