feat: support semantic/named colors for color properties #11699

hansemannn · 2020-05-10T08:03:02Z

JIRA: https://jira.appcelerator.org/browse/TIMOB-27895

Notes:

The color lookup is fully backwards compatible for iOS < 11 as well
Android does not have a version limitation, since named colors are available since Android API level 1

This adds the following:

a new Ti.UI.Color proxy on Android
- this brings some parity with iOS (Android doesn't support passing these to color properties directly like iOS does)
- right now the only real API here is the toHex() method that returns the color's hex string as ARRGGBB format
Ti.UI.Android.getColorResource() which can take a numeric argument (for the resource id for the color) or a string argument (for the short color name).
- i.e. Ti.UI.Android.getColorResource(Ti.Android.R.color.darker_gray) or Ti.UI.Android.getColorResource('holo_blue_bright')
- it will return a Ti.UI.Color proxy instance that wraps the underlying android.graphics.Color instance
color properties can have named colors passed in to them (in addition to our existing support for hex strings, rgb(), rgba() and some of the standard web color names like 'cyan', 'magenta', etc)
Ti.UI.fetchSemanticColor() will fall back to using Ti.UI.Android.getColorResource() under the hood if the name isn't in the semantic.colors.json file but there is a Ti.Android.R.color[name] entry (and will still return a valid string to be passed to a color property, should be a hex string in this case).

build · 2020-05-10T08:32:36Z

	Fails
🚫	Tests have failed, see below for more information.

	Messages
📖	💾 Here's the generated SDK zipfile.
📖	🎉 Another contribution from our awesome community member, hansemannn! Thanks again for helping us make Titanium SDK better. 👍
📖	✊ The commits in this PR match our conventions! Feel free to Rebase and Merge this PR when ready.
📖	❌ 1 tests have failed There are 1 tests failing and 698 skipped out of 7367 total tests.

Tests:

Classname	Name	Time	Error
android.emulator.Titanium.Android	activity callbacks (9)	5.012	Error: timeout of 5000ms exceeded at Titanium.<anonymous> (/ti-mocha.js:6535:53120)

Generated by 🚫 dangerJS against 85011fe

sgtcoolguy · 2020-05-11T13:01:09Z

iphone/TitaniumKit/TitaniumKit/Sources/API/Webcolor.m

+
+  if (semanticColors == nil) {
+    NSString *colorsPath = [NSBundle.mainBundle pathForResource:@"semantic.colors" ofType:@"json"];
+    if (![NSFileManager.defaultManager fileExistsAtPath:colorsPath]) {


Do we need to worry about an encrypted version of the file?

Are JSON resource files encrypted as well? Looking at a recent production build, it doesn't seem to.

We don't encrypt JSON files under "Resources". So, we should be okay, but it doesn't hurt to test with a device build just in case.

(We do encrypt our internal bootstrap JSON and app properties JSON though. Our build system is capable of doing this for all JSON files if we wanted to.)

sgtcoolguy · 2020-05-11T13:02:15Z

iphone/TitaniumKit/TitaniumKit/Sources/API/Webcolor.m

+    return nil;
+  }
+
+  NSString *currentTraitCollection = TiApp.controller.traitCollection.userInterfaceStyle == UIUserInterfaceStyleDark ? @"dark" : @"light";


This new chunk of code feels like it should live in the common JS area, but I don't see how we could do that and have it effectively hijack all the possible places where colors are set (i.e. all the proxies with various color properties).

Yep, that was the reason to do it here. And since the JSON only needs to be loaded once, it doesn't cause an overhead to process the array (which wouldn't be a problem on the JS side as well though).

sgtcoolguy · 2020-05-11T13:03:34Z

@hansemannn If you keep the SDK's npm packages up to date while developing, it should use a husky hook to auto-format the source on IOS when you commit.

Otherwise, try npm run format:ios to manually force it to fix formatting on IOS source.

hansemannn · 2020-05-11T15:09:15Z

I updated it, but running npm run format:ios attempted to format 15+ files that I haven't even touched, so I only commited the related ones. Also, for unit tests, I could add it to the mocha-suite, but since I need some resource files for it as well, I would like to consider adding no_tests and perform a pull request to that repo for it.

sgtcoolguy · 2020-05-11T15:49:13Z

@hansemannn You should be able to plop the tests and Resources files into the tests/Resources dir and it'll get looped in.

sgtcoolguy · 2020-05-11T15:52:30Z

Note also, the semantic.colors.json file seems to have broken the actual iOS app build?

[2020-05-11T15:28:31.980Z] [ERROR] : �� �** BUILD FAILED **
[2020-05-11T15:28:31.980Z] [ERROR] : �� �The following build commands failed:
[2020-05-11T15:28:31.980Z] [ERROR] : �� �	CpResource /Users/build/jenkins/workspace/ium-sdk_titanium_mobile_PR-11699/titanium-mobile-mocha-suite/scripts/mocha/build/iphone/semantic.colors.json /Users/build/jenkins/workspace/ium-sdk_titanium_mobile_PR-11699/titanium-mobile-mocha-suite/scripts/mocha/build/iphone/build/Products/Debug-iphonesimulator/mocha.app/semantic.colors.json
[2020-05-11T15:28:31.980Z] [ERROR] : �� �(1 failure)
[2020-05-11T15:28:31.980Z]  
[2020-05-11T15:28:31.980Z] Error: Exited unexpectedly with exit code: 1
[2020-05-11T15:28:31.980Z]     at ChildProcess.prc.on.code (/Users/build/jenkins/workspace/ium-sdk_titanium_mobile_PR-11699/titanium-mobile-mocha-suite/scripts/test.js:467:19)
[2020-05-11T15:28:31.980Z]     at ChildProcess.emit (events.js:198:13)
[2020-05-11T15:28:31.980Z]     at maybeClose (internal/child_process.js:982:16)
[2020-05-11T15:28:31.980Z]     at Socket.stream.socket.on (internal/child_process.js:389:11)
[2020-05-11T15:28:31.980Z]     at Socket.emit (events.js:198:13)
[2020-05-11T15:28:31.980Z]     at Pipe._handle.close (net.js:607:12)
script returned exit code 1

hansemannn · 2020-05-11T20:58:43Z

@sgtcoolguy I will check that one! I thought it might be cool to have a semantic.colors.json in development as well, but it seems like some refs of it are taken over to the app template and cause duplicate resource issues there.

hansemannn · 2020-05-13T17:52:47Z

I'm afraid that I won't be able to update the sample app and remove the demo files from the project before next week, so we may need to close this or hand it over!

hansemannn · 2020-05-17T09:24:27Z

@sgtcoolguy I removed the file again and added a (very basic) mocha test: https://github.com/appcelerator/titanium-mobile-mocha-suite/pull/255

sgtcoolguy · 2020-05-26T17:32:11Z

Relates to #11315

sgtcoolguy · 2020-05-27T14:20:44Z

iphone/TitaniumKit/TitaniumKit/Sources/API/Webcolor.m

+
+  NSString *currentTraitCollection = TiApp.controller.traitCollection.userInterfaceStyle == UIUserInterfaceStyleDark ? @"dark" : @"light";
+
+  return [Webcolor webColorNamed:colorMap[currentTraitCollection]];


I think this will cause an infinite loop...

Alos support ArrayBuffer.isView and BYTES_PER_ELEMENT sniffing pixelmatch does

gets pngjs and browserify zlib working

build · 2020-07-01T19:43:57Z

tests/scripts/test.js

+ **/
+async function getSDKInstallDir() {
+	// TODO: Use fork since we're spawning off another node process
+	const { stdout, _stderr } = await exec(`node "${titanium}" info -o json -t titanium`);


⚠️ tests/scripts/test.js line 79 – '_stderr' is assigned a value but never used. (no-unused-vars)

…rong

build added this to the 9.1.0 milestone May 10, 2020

build requested a review from a team May 10, 2020 08:32

build added community 🔥 ios needs tests 🚨 labels May 10, 2020

hansemannn changed the title ~~chore(ios): handle semantic colors in color helper~~ chore(ios/android): handle semantic colors in color helper May 10, 2020

build requested a review from a team May 10, 2020 12:58

build added the android label May 10, 2020

sgtcoolguy reviewed May 11, 2020

View reviewed changes

sgtcoolguy reviewed May 27, 2020

View reviewed changes

sgtcoolguy force-pushed the TIMOB-27895 branch from 7434575 to c15bf15 Compare May 28, 2020 18:09

sgtcoolguy self-assigned this May 28, 2020

sgtcoolguy added docs feature parity 👯‍♀️ and removed needs tests 🚨 labels May 28, 2020

sgtcoolguy changed the title ~~chore(ios/android): handle semantic colors in color helper~~ feat: support semantic/named colors for color properties May 28, 2020

sgtcoolguy force-pushed the TIMOB-27895 branch 3 times, most recently from 5180ae0 to 226ee8f Compare June 2, 2020 18:05

sgtcoolguy added 25 commits July 1, 2020 15:28

docs(android): add Ti.UI.Android.getColorResource()

95e1fc6

docs: update Ti.UI.Color for android, fix toHex() string details

a555584

docs(ui): note that Ti.UI.fetchSemanticColor can return a String

0accfd1

test: add support for collecting generated images in tests

884150a

test: add image comparison test for view with named system color as bg

8095daf

test: check exact hex values of iOS system colors

15c40b3

test: support diffs for images

512df9e

test: generate diff for mismatching images

5222ee1

chore: ignore test image diff directory

acaaa38

ci(jenkins): archive diff images if any

885a5a1

build(tests): use npm ci to install test dependencies

ab7af02

test: use image from ci server

80f9eb9

test: fix comparison of buffers

0348010

fix(common): copy sliced buffer doesn't extend beyond view now

c22b1e3

Alos support ArrayBuffer.isView and BYTES_PER_ELEMENT sniffing pixelmatch does

test: add tests to verify fixes for Buffer

ee4479f

feat(common): add basic stream shim

70c398a

gets pngjs and browserify zlib working

fix(buffer): add .buffer and #set to Buffer

6992449

test(buffer): add tests for Buffer .buffer and #set

ff1dc34

test: add support for grabbing diff image

8a9c4e1

test: use pngjs, pixelmatch and browserify-zlib to compare images

8a3841e

style(js): don't run eslint on test fake_node_modules

760a1cb

docs(android): fix typo

ac54ee9

refactor(android): just wrap ColorInt in proxy

73c350b

test: port over latest changes to ti.ui.test

e31f0a1

test(android): compare hex strings from getColorResource ignoring case

cbd77c1

sgtcoolguy force-pushed the TIMOB-27895 branch from e98a483 to cbd77c1 Compare July 1, 2020 19:29

build reviewed Jul 1, 2020

View reviewed changes

test: use 12 x 12 view/image, otherwise ios blob pt conversion goes w…

85011fe

…rong

sgtcoolguy mentioned this pull request Jul 2, 2020

fix(ios): report width/height of Blob as pixels, not points #11803

Merged

sgtcoolguy merged commit d136892 into tidev:master Jul 6, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support semantic/named colors for color properties #11699

feat: support semantic/named colors for color properties #11699

hansemannn commented May 10, 2020 •

edited by sgtcoolguy

build commented May 10, 2020 •

edited

sgtcoolguy May 11, 2020

hansemannn May 11, 2020

jquick-axway May 11, 2020

sgtcoolguy May 11, 2020

hansemannn May 11, 2020

sgtcoolguy commented May 11, 2020

hansemannn commented May 11, 2020

sgtcoolguy commented May 11, 2020

sgtcoolguy commented May 11, 2020

hansemannn commented May 11, 2020

hansemannn commented May 13, 2020

hansemannn commented May 17, 2020

sgtcoolguy commented May 26, 2020

sgtcoolguy May 27, 2020

build Jul 1, 2020


		NSString *currentTraitCollection = TiApp.controller.traitCollection.userInterfaceStyle == UIUserInterfaceStyleDark ? @"dark" : @"light";

		return [Webcolor webColorNamed:colorMap[currentTraitCollection]];

feat: support semantic/named colors for color properties #11699

feat: support semantic/named colors for color properties #11699

Conversation

hansemannn commented May 10, 2020 • edited by sgtcoolguy

build commented May 10, 2020 • edited

Tests:

sgtcoolguy May 11, 2020

Choose a reason for hiding this comment

hansemannn May 11, 2020

Choose a reason for hiding this comment

jquick-axway May 11, 2020

Choose a reason for hiding this comment

sgtcoolguy May 11, 2020

Choose a reason for hiding this comment

hansemannn May 11, 2020

Choose a reason for hiding this comment

sgtcoolguy commented May 11, 2020

hansemannn commented May 11, 2020

sgtcoolguy commented May 11, 2020

sgtcoolguy commented May 11, 2020

hansemannn commented May 11, 2020

hansemannn commented May 13, 2020

hansemannn commented May 17, 2020

sgtcoolguy commented May 26, 2020

sgtcoolguy May 27, 2020

Choose a reason for hiding this comment

build Jul 1, 2020

Choose a reason for hiding this comment

hansemannn commented May 10, 2020 •

edited by sgtcoolguy

build commented May 10, 2020 •

edited