Merge pull request #11 from mayashavin/improvements

Author: mayashavin

docs/url-docs/content/en/usage/transformations.md

@@ -30,7 +30,9 @@ const transArr = Transformer.transform({
   },
   gravity: 'auto',
   chaining: [{
-    effect: 'grayscale'
+    effect: {
+      name: 'grayscale'
+    }
   }]
 })
 

docs/url-docs/content/en/usage/transformer.md

@@ -5,6 +5,11 @@
   "workspaces": [
     "packages/*"
   ],
+  "husky": {
+    "hooks": {
+      "pre-commit": "yarn test:unit"
+    }
+  },
   "scripts": {
     "build": "lerna run build --stream",
     "prelint": "yarn build",
@@ -15,10 +20,14 @@
     "release": "lerna publish --conventional-commits",
     "pretest": "yarn build && jest --rootDir __tests__",
     "test": "lerna run test --stream",
+    "test:unit": "yarn test:url",
     "pretest:ci": "yarn pretest",
     "test:ci": "lerna run test:ci --stream",
     "prettier": "yarn prettier --write .",
-    "changelog": "node scripts/changelog.js"
+    "changelog": "node scripts/changelog.js",
+    "test:url": "npm --prefix packages/url run test:unit",
+    "bundlewatch:url": "npm --prefix packages/url run bundlewatch",
+    "doc-dev:url": "npm --prefix docs/url-docs run dev"
   },
   "author": "Maya Shavin <[email protected]>",
   "license": "MIT",
@@ -33,7 +42,8 @@
     "jest": "^26.6.3",
     "lerna": "^3.22.1",
     "prettier": "^2.1.2",
-    "typescript": "^4.0.5"
+    "typescript": "^4.0.5",
+    "husky": "^4.3.0"
   },
   "keywords": [
     "cloudinary",

package.json

@@ -0,0 +1,104 @@
+import { computeConditionExpression, computeCondition, condition } from '../lib/transformers/condition'
+
+describe('Condition modifier', () => {
+  describe('condition()', () => {
+    it('should return empty string if nothing passed', () => {
+      expect(condition()).toBe('')
+    });
+
+    it('should return empty string if condition.if does not exist', () => {
+      expect(condition({
+        if: {
+          transformations: [{ rotate: 20 }]
+        }
+      })).toBe('')
+    });
+
+    it('should return if condition string', () => {
+      expect(condition({
+        if: {
+          expression: [{
+            characteristic: "width",
+            operator: 'equal',
+            value: 200
+          }],
+          transformations: [{ rotate: 20 }]
+        }
+      })).toEqual(['if_w_eq_200/a_20/if_end'])
+    });
+
+    it('should return if and else condition string', () => {
+      expect(condition({
+        if: {
+          expression: [{
+            characteristic: "width",
+            operator: 'equal',
+            value: 200
+          }],
+          transformations: [{ rotate: 20 }]
+        },
+        else: {
+          transformations: [{
+            resize: {
+              width: 120,
+              height: 120,
+              type: 'fill'
+            }
+          }]
+        }
+      })).toEqual(['if_w_eq_200/a_20/if_else/c_fill,w_120,h_120/if_end'])
+    });
+    it('should return if value expression with mapped', () => {
+      expect(condition({
+        if: {
+          expression: [{
+            characteristic: "width",
+            operator: 'equal',
+            value: 'shoes'
+          }],
+          transformations: [{ rotate: 20 }]
+        },
+      })).toEqual(['if_w_eq_!shoes!/a_20/if_end'])
+    });
+  });
+
+  describe('computeConditionExpression()', () => {
+    it('should map all characteristic together', () => {
+      expect(computeConditionExpression({
+        characteristic: ['width', 'height'],
+        operator: 'include',
+        value: 'shoes'
+      })).toBe('w:h_in_!shoes!')
+    });
+  });
+
+  describe('computeCondition()', () => {
+    it('should map multiple conditions together', () => {
+      expect(computeCondition({
+        expression: [{
+          characteristic: 'aspectRatio',
+          operator: 'greaterThan',
+          value: 3
+        }, {
+          characteristic: 'width',
+          operator: 'greaterOrEqual',
+          value: 300
+        }, {
+          characteristic: 'height',
+          operator: 'lessThan',
+          value: 20
+        }],
+        transformations: [{
+          resize: {
+            width: 300,
+            height: 200,
+            type: 'crop'
+          }
+        }]
+      })).toEqual({
+        expression: 'ar_gt_3_and_w_gte_300_and_h_lt_20',
+        transformations: 'c_crop,w_300,h_200'
+      })
+    });
+  });
+});

packages/url/__tests__/condition.test.ts

@@ -0,0 +1,11 @@
+import { customFunction } from '../lib/transformers/customFunc'
+
+describe('customFunc', () => {
+  it('should return empty string if there is no type or source', () => {
+    expect(customFunction({ source: '', type: 'remote' })).toBe('')
+  });
+
+  it('should return formatted custome Function', () => {
+    expect(customFunction({ type: 'remote', source: 'my_example'})).toBe('fn_remote:my_example')
+  });
+});

packages/url/__tests__/customFunction.test.ts

@@ -1,4 +1,7 @@
-import { buildUrl, buildVideoUrl, getConfig, setConfig } from '../lib/index'
+import { buildImageUrl, buildUrl, buildVideoUrl, extractPublicId, getConfig, RESOURCE_TYPES, setConfig, Transformer } from '../lib/index'
+import { RESOURCE_TYPES as OriginalResourceTypes, STORAGE_TYPES as OriginalStorageTypes, ROTATION_MODES as OriginalRotationModes, STORAGE_TYPES, ROTATION_MODES } from '../lib/constants'
+import { extractPublicId as originalExtractPublicId } from '../lib/url'
+import { transform, toTransformationStr } from '../lib/transformers'
 
 describe('General tests', () => {
   it('configurations', () => {
@@ -12,6 +15,13 @@ describe('General tests', () => {
   })
 
   describe('buildUrl()', () => {
+    it('should return default transformation', () => {
+      expect(buildUrl('example', {
+        cloud: {
+          cloudName: 'demo'
+        }
+      })).toBe('https://res.cloudinary.com/demo/image/upload/q_auto,f_auto/example')
+    });
     it('should return right url with configurations', () => {
       setConfig({
         cloudName: 'm'
@@ -48,6 +58,24 @@ describe('General tests', () => {
         cloudName: 'm'
       })
     });
+})
+
+  describe('buildVideoUrl()', () => {
+    it('should return url with default config when no cloud', () => {
+      setConfig({
+        cloudName: 'demo'
+      })
+
+      expect(buildVideoUrl('example', { transformations: {} })).toBe('https://res.cloudinary.com/demo/video/upload/q_auto,f_auto/example')
+    });
+
+    it('should return url with default config', () => {
+      setConfig({
+        cloudName: 'demo'
+      })
+
+      expect(buildVideoUrl('example', {})).toBe('https://res.cloudinary.com/demo/video/upload/q_auto,f_auto/example')
+    });
 
     it('should return right url format for video', () => {
       expect(buildVideoUrl('example', {
@@ -63,5 +91,61 @@ describe('General tests', () => {
       })).toEqual('https://res.cloudinary.com/demo/video/upload/c_scale,w_200,q_auto,f_auto/example') 
 
     })
-  })
+  });
+
+  describe('buildImageUrl()', () => {
+    
+    it('should return url with default config when no cloud', () => {
+      setConfig({
+        cloudName: 'demo'
+      })
+
+      expect(buildImageUrl('example', { transformations: {} })).toBe('https://res.cloudinary.com/demo/image/upload/q_auto,f_auto/example')
+    });
+    it('should return url with default config', () => {
+      setConfig({
+        cloudName: 'demo'
+      })
+
+      expect(buildImageUrl('example', {})).toBe('https://res.cloudinary.com/demo/image/upload/q_auto,f_auto/example')
+    });
+
+    it('should return url with cloud config', () => {
+
+      expect(buildImageUrl('example', {
+        cloud: {
+          cloudName: 'demo'
+        },
+        transformations: {
+          rotate: 10,
+        }
+      })).toBe('https://res.cloudinary.com/demo/image/upload/q_auto,a_10,f_auto/example')
+    });
+  });
+
+  describe('exports', () => {
+    it('should export resourceTypes', () => {
+      expect(RESOURCE_TYPES).toEqual(OriginalResourceTypes)
+    });
+
+    it('should export extractPublicId', () => {
+      expect(extractPublicId).toEqual(extractPublicId)
+    });
+
+    it('should export STORAGE_TYPES', () => {
+      expect(STORAGE_TYPES).toEqual(OriginalStorageTypes)
+    });
+
+    it('should export ROTATION_MODES', () => {
+      expect(ROTATION_MODES).toEqual(OriginalRotationModes)
+    });
+
+    it('should export transform', () => {
+      expect(Transformer.transform).toEqual(transform)
+    });
+
+    it('should export toTransformationStr', () => {
+      expect(Transformer.toString).toEqual(toTransformationStr)
+    });
+  });
 })