feat(packages/stdlib): add flagsGenerator and bitwise operation functions

packages/stdlib/src/bits/flags/index.test.ts

@@ -0,0 +1,118 @@
+import { describe, it, expect } from 'vitest';
+import { flagsGenerator, and, or, not, has, is, unset, toggle } from './index';
+
+describe('flagsGenerator', () => {
+  it('generate unique flags', () => {
+    const generateFlag = flagsGenerator();
+
+    const flag1 = generateFlag();
+    const flag2 = generateFlag();
+    const flag3 = generateFlag();
+
+    expect(flag1).toBe(1);
+    expect(flag2).toBe(2);
+    expect(flag3).toBe(4);
+  });
+
+  it('throw an error if more than 31 flags are created', () => {
+    const generateFlag = flagsGenerator();
+
+    for (let i = 0; i < 31; i++) {
+      generateFlag();
+    }
+
+    expect(() => generateFlag()).toThrow(RangeError);
+  });
+});
+
+describe('flagsAnd', () => {
+  it('no effect on zero flags', () => {
+    const result = and();
+
+    expect(result).toBe(-1);
+  });
+
+  it('source flag is returned if no flags are provided', () => {
+    const result = and(0b1010);
+
+    expect(result).toBe(0b1010);
+  });
+  
+  it('perform bitwise AND operation on flags', () => {
+    const result = and(0b1111, 0b1010, 0b1100);
+
+    expect(result).toBe(0b1000);
+  });
+});
+
+describe('flagsOr', () => {
+  it('no effect on zero flags', () => {
+    const result = or();
+
+    expect(result).toBe(0);
+  });
+
+  it('source flag is returned if no flags are provided', () => {
+      const result = or(0b1010);
+  
+      expect(result).toBe(0b1010);
+  });
+
+  it('perform bitwise OR operation on flags', () => {
+      const result = or(0b1111, 0b1010, 0b1100);
+  
+      expect(result).toBe(0b1111);
+  });
+});
+
+describe('flagsNot', () => {
+  it('perform bitwise NOT operation on a flag', () => {
+    const result = not(0b101);
+
+    expect(result).toBe(-0b110);
+  });
+});
+
+describe('flagsHas', () => {
+  it('check if a flag has a specific bit set', () => {
+    const result = has(0b1010, 0b1000);
+
+    expect(result).toBe(true);
+  });
+
+  it('check if a flag has a specific bit unset', () => {
+      const result = has(0b1010, 0b0100);
+  
+      expect(result).toBe(false);
+  });
+});
+
+describe('flagsIs', () => {
+  it('check if a flag is set', () => {
+    const result = is(0b1010);
+
+    expect(result).toBe(true);
+  });
+
+  it('check if a flag is unset', () => {
+      const result = is(0);
+  
+      expect(result).toBe(false);
+  });
+});
+
+describe('flagsUnset', () => {
+  it('unset a flag', () => {
+    const result = unset(0b1010, 0b1000);
+
+    expect(result).toBe(0b0010);
+  });
+});
+
+describe('flagsToggle', () => {
+  it('toggle a flag', () => {
+    const result = toggle(0b1010, 0b1000);
+
+    expect(result).toBe(0b0010);
+  });
+});