react-obsidian 0.0.1

package/example/ios/example.xcodeproj/xcshareddata/xcschemes/example.xcscheme

@@ -0,0 +1,88 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "1210"
+   version = "1.3">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "13B07F861A680F5B00A75B9A"
+               BuildableName = "example.app"
+               BlueprintName = "example"
+               ReferencedContainer = "container:example.xcodeproj">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES">
+      <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "00E356ED1AD99517003FC87E"
+               BuildableName = "exampleTests.xctest"
+               BlueprintName = "exampleTests"
+               ReferencedContainer = "container:example.xcodeproj">
+            </BuildableReference>
+         </TestableReference>
+      </Testables>
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "13B07F861A680F5B00A75B9A"
+            BuildableName = "example.app"
+            BlueprintName = "example"
+            ReferencedContainer = "container:example.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <BuildableProductRunnable
+         runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "13B07F861A680F5B00A75B9A"
+            BuildableName = "example.app"
+            BlueprintName = "example"
+            ReferencedContainer = "container:example.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

package/example/ios/example.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Workspace
+   version = "1.0">
+   <FileRef
+      location = "group:example.xcodeproj">
+   </FileRef>
+   <FileRef
+      location = "group:Pods/Pods.xcodeproj">
+   </FileRef>
+</Workspace>

package/example/ios/exampleTests/Info.plist

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>en</string>
+	<key>CFBundleExecutable</key>
+	<string>$(EXECUTABLE_NAME)</string>
+	<key>CFBundleIdentifier</key>
+	<string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>$(PRODUCT_NAME)</string>
+	<key>CFBundlePackageType</key>
+	<string>BNDL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>1.0</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1</string>
+</dict>
+</plist>

package/example/ios/exampleTests/exampleTests.m

@@ -0,0 +1,65 @@
+#import <UIKit/UIKit.h>
+#import <XCTest/XCTest.h>
+
+#import <React/RCTLog.h>
+#import <React/RCTRootView.h>
+
+#define TIMEOUT_SECONDS 600
+#define TEXT_TO_LOOK_FOR @"Welcome to React"
+
+@interface exampleTests : XCTestCase
+
+@end
+
+@implementation exampleTests
+
+- (BOOL)findSubviewInView:(UIView *)view matching:(BOOL(^)(UIView *view))test
+{
+  if (test(view)) {
+    return YES;
+  }
+  for (UIView *subview in [view subviews]) {
+    if ([self findSubviewInView:subview matching:test]) {
+      return YES;
+    }
+  }
+  return NO;
+}
+
+- (void)testRendersWelcomeScreen
+{
+  UIViewController *vc = [[[RCTSharedApplication() delegate] window] rootViewController];
+  NSDate *date = [NSDate dateWithTimeIntervalSinceNow:TIMEOUT_SECONDS];
+  BOOL foundElement = NO;
+
+  __block NSString *redboxError = nil;
+#ifdef DEBUG
+  RCTSetLogFunction(^(RCTLogLevel level, RCTLogSource source, NSString *fileName, NSNumber *lineNumber, NSString *message) {
+    if (level >= RCTLogLevelError) {
+      redboxError = message;
+    }
+  });
+#endif
+
+  while ([date timeIntervalSinceNow] > 0 && !foundElement && !redboxError) {
+    [[NSRunLoop mainRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.1]];
+    [[NSRunLoop mainRunLoop] runMode:NSRunLoopCommonModes beforeDate:[NSDate dateWithTimeIntervalSinceNow:0.1]];
+
+    foundElement = [self findSubviewInView:vc.view matching:^BOOL(UIView *view) {
+      if ([view.accessibilityLabel isEqualToString:TEXT_TO_LOOK_FOR]) {
+        return YES;
+      }
+      return NO;
+    }];
+  }
+
+#ifdef DEBUG
+  RCTSetLogFunction(RCTDefaultLogFunction);
+#endif
+
+  XCTAssertNil(redboxError, @"RedBox error: %@", redboxError);
+  XCTAssertTrue(foundElement, @"Couldn't find element with text '%@' in %d seconds", TEXT_TO_LOOK_FOR, TIMEOUT_SECONDS);
+}
+
+
+@end

package/example/metro.config.js

@@ -0,0 +1,44 @@
+/**
+ * Metro configuration for React Native
+ * https://github.com/facebook/react-native
+ *
+ * @format
+ */
+
+const path = require('path');
+const exclusionList = require('metro-config/src/defaults/exclusionList');
+const root = path.resolve(__dirname, '..');
+const pj = require('../package.json');
+const modules = Object.keys({
+  ...pj.peerDependencies,
+});
+
+module.exports = {
+  projectRoot: __dirname,
+  watchFolders: [root],
+
+  // We need to make sure that only one version is loaded for peerDependencies
+  // So we blacklist them at the root, and alias them to the versions in example's node_modules
+  resolver: {
+    blacklistRE: exclusionList(
+      modules.map(
+        m => new RegExp(`^${escape(path.join(root, 'node_modules', m))}\\/.*$`),
+      ),
+    ),
+
+    extraNodeModules: modules.reduce((acc, name) => {
+      acc[name] = path.join(__dirname, 'node_modules', name);
+      return acc;
+    }, {}),
+  },
+
+  transformer: {
+    // eslint-disable-next-line require-await
+    getTransformOptions: async () => ({
+      transform: {
+        experimentalImportSupport: true,
+        inlineRequires: true,
+      },
+    }),
+  },
+};

package/example/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "ReactNativeExample",
+  "version": "0.0.1",
+  "private": true,
+  "scripts": {
+    "android": "react-native run-android",
+    "ios": "react-native run-ios",
+    "start": "react-native start",
+    "test": "jest",
+    "lint": "eslint ."
+  },
+  "dependencies": {
+    "react": "17.0.2",
+    "react-native": "0.66.2"
+  },
+  "devDependencies": {
+    "@babel/core": "7.16.0",
+    "@babel/plugin-proposal-decorators": "7.16.0",
+    "@babel/plugin-proposal-class-properties": "7.16.0",
+    "@babel/preset-typescript": "7.16.0",
+    "@babel/runtime": "7.16.0",
+    "@types/react-native": "0.66.3",
+    "@react-native-community/eslint-config": "2.0.0",
+    "babel-jest": "26.6.3",
+    "eslint": "7.14.0",
+    "jest": "26.6.3",
+    "metro-react-native-babel-preset": "0.66.2",
+    "react-test-renderer": "17.0.2",
+    "typescript": "^4.4.4",
+    "react-obsidian": "../"
+  },
+  "jest": {
+    "preset": "react-native"
+  }
+}

package/example/tsconfig.json

@@ -0,0 +1,45 @@
+{
+  "include": [
+    "**/*",
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "babel.config.js",
+    "metro.config.js",
+    "jest.config.js"
+  ],
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "lib": [
+      "es2017",
+    ],
+    "moduleResolution": "node",
+    "outDir": "./dist",
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "strict": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noImplicitOverride": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "forceConsistentCasingInFileNames": true,
+    "jsx": "react-native",
+    "esModuleInterop": true,
+    "isolatedModules": true,
+    "resolveJsonModule": true,
+    "experimentalDecorators": true,
+    "allowJs": true,
+    "allowSyntheticDefaultImports": true,
+    "types": ["reflect-metadata", "jest"],
+    "emitDecoratorMetadata": true,
+    "baseUrl": "./",
+    "paths": {
+      "@Obsidian": ["../src/@types/obsidian.d.ts"]
+    }
+  }
+}

package/jest.config.js

@@ -0,0 +1,12 @@
+const config = {
+  resetMocks: true,
+  resetModules: true,
+  roots: [
+    'node_modules',
+    'src',
+    'transformers',
+    'test',
+  ],
+};
+
+module.exports = config;

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "react-obsidian",
+  "version": "0.0.1",
+  "description": "Dependency injection framework for React and React Native applications",
+  "main": "src/index.ts",
+  "directories": {
+    "test": "test"
+  },
+  "dependencies": {
+    "hoist-non-react-statics": "3.x.x",
+    "reflect-metadata": "~0.1.13"
+  },
+  "peerDependencies": {
+    "react": "*"
+  },
+  "devDependencies": {
+    "@babel/core": "7.16.x",
+    "@babel/generator": "7.16.x",
+    "@babel/plugin-proposal-class-properties": "7.16.x",
+    "@babel/plugin-proposal-decorators": "7.16.x",
+    "@babel/preset-env": "7.16.x",
+    "@babel/preset-react": "7.16.x",
+    "@babel/preset-typescript": "7.16.x",
+    "@babel/types": "7.16.x",
+    "@johanblumenberg/ts-mockito": "1.x.x",
+    "@testing-library/react": "^12.1.2",
+    "@types/hoist-non-react-statics": "^3.3.1",
+    "@types/jest": "26.x.x",
+    "@types/lodash": "^4.14.176",
+    "@types/react": "^17.0.34",
+    "@types/react-dom": "^17.0.11",
+    "@types/react-test-renderer": "17.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.3.0",
+    "@typescript-eslint/parser": "^5.3.0",
+    "eslint": "^7.32.0",
+    "eslint-config-airbnb-typescript": "^16.0.0",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-import-newlines": "^1.1.5",
+    "eslint-plugin-jsx-a11y": "^6.4.1",
+    "eslint-plugin-react": "^7.26.1",
+    "eslint-plugin-react-hooks": "^4.2.0",
+    "jest": "26.x.x",
+    "lodash": "^4.17.21",
+    "react": "17.0.2",
+    "react-dom": "17.0.2",
+    "typescript": "^4.4.4"
+  },
+  "scripts": {
+    "prepack": "npm run lint && tsc --project tsconfig.prod.json",
+    "lint": "npx eslint src transformers test --ignore-pattern '*.d.ts' --ext .ts,.tsx,.js",
+    "pretest": "tsc",
+    "test": "npx jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wix-incubator/react-obsidian.git"
+  },
+  "keywords": [
+    "react",
+    "react-native",
+    "dependency-injection",
+    "typescript",
+    "ioc"
+  ],
+  "contributors": [
+    {
+      "name": "Artal Druk"
+    },
+    {
+      "name": "Guy Carmeli"
+    }
+  ],
+  "author": "Guy Carmeli",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/wix-incubator/react-obsidian/issues"
+  },
+  "homepage": "https://github.com/wix-incubator/react-obsidian#readme"
+}

package/src/@types/obsidian.d.ts

@@ -0,0 +1,19 @@
+import ObjectGraph from '../graph/ObjectGraph';
+
+type Constructable<T> = {
+  new(...args: any): T;
+};
+
+type GraphClass<T extends ObjectGraph<P>, P> = {
+  new(props?: P): T;
+};
+
+type Scope = string | number | symbol;
+
+type Constructor = { new(...args: any[]): any };
+
+type GraphType = { new(...args: any[]): ObjectGraph };
+
+type ServiceLocator<Clazz> = {
+  [Key in keyof Clazz]: Function
+};

package/src/GraphProperties.ts

@@ -0,0 +1,11 @@
+export default class GraphProperties {
+  private unmangledToMangledPropKeys = new Map<string, string>();
+
+  add(mangledPropertyKey: string, unmangledPropertyKey: string) {
+    this.unmangledToMangledPropKeys.set(unmangledPropertyKey, mangledPropertyKey);
+  }
+
+  getMangledProperty(unmangledProperty: string): string | undefined {
+    return this.unmangledToMangledPropKeys.get(unmangledProperty);
+  }
+}

package/src/Obsidian.ts

@@ -0,0 +1,18 @@
+import { Constructable, ServiceLocator } from '@Obsidian';
+import graphRegistry from './graph/registry/GraphRegistry';
+import ObjectGraph from './graph/ObjectGraph';
+import { GraphMiddleware } from './graph/registry/GraphMiddleware';
+
+export default class Obsidian {
+  obtain<T extends ObjectGraph<P>, P = any>(Graph: Constructable<T>, props?: P): ServiceLocator<T> {
+    return graphRegistry.resolve(Graph, props) as unknown as ServiceLocator<T>;
+  }
+
+  addGraphMiddleware(middleware: GraphMiddleware) {
+    graphRegistry.addGraphMiddleware(middleware);
+  }
+
+  clearGraphMiddlewares() {
+    graphRegistry.clearGraphMiddlewares();
+  }
+}

package/src/ProvidedPropertiesStore.ts

@@ -0,0 +1,22 @@
+import GraphProperties from './GraphProperties';
+import Graph from './graph/Graph';
+
+class ProvidedPropertiesStore {
+  private readonly providedPropertiesForGraph: Map<string, GraphProperties> = new Map();
+
+  getMangledProperty(graph: Graph, unmangledProp: string): string | undefined {
+    return this.providedPropertiesForGraph.get(graph.name)?.getMangledProperty(unmangledProp);
+  }
+
+  set(graph: Graph, mangledProperty: string, unmangledProperty: string) {
+    const graphProperties = this.providedPropertiesForGraph.get(graph.name) ?? new GraphProperties();
+    graphProperties.add(mangledProperty, unmangledProperty);
+    this.providedPropertiesForGraph.set(graph.name, graphProperties);
+  }
+
+  clear(graph: Graph) {
+    this.providedPropertiesForGraph.delete(graph.name);
+  }
+}
+
+export default new ProvidedPropertiesStore();

package/src/Provides.ts

@@ -0,0 +1,16 @@
+import { Scope } from '@Obsidian';
+import Graph from './graph/Graph';
+import providedPropertiesStore from './ProvidedPropertiesStore';
+
+interface ProvidesParams {
+  scope?: Scope;
+  name: string;
+}
+
+function Provides({ name }: Partial<ProvidesParams> = {}) {
+  return function provide(graph: Graph, propertyKey: string, descriptor: PropertyDescriptor) {
+    providedPropertiesStore.set(graph, propertyKey, name!);
+    return descriptor;
+  };
+}
+export default Provides;

package/src/ReferenceCounter.ts

@@ -0,0 +1,20 @@
+class ReferenceCounter {
+  private readonly references = new WeakMap<object, number>();
+
+  retain(object: any) {
+    const count = this.references.get(object) ?? 0;
+    this.references.set(object, count + 1);
+  }
+
+  release<T extends object>(object: T, onReleased: (_object: T) => void) {
+    const count = this.references.get(object)!;
+    if (count === 1) {
+      onReleased(object);
+      this.references.delete(object);
+    } else {
+      this.references.set(object, count - 1);
+    }
+  }
+}
+
+export default new ReferenceCounter();

package/src/ScopedValuesRegistry.ts

@@ -0,0 +1,26 @@
+import { Scope } from '@Obsidian';
+
+class ScopedValuesRegistry {
+  private readonly values: Map<string, any> = new Map();
+
+  has(scope: Scope, property: string): boolean {
+    return this.values.has(scope.toString() + property);
+  }
+
+  get(scope: Scope, property: string): any {
+    if (this.values.has(scope.toString() + property)) {
+      return this.values.get(scope.toString() + property);
+    }
+    throw new Error(`Property ${property} does not exist`);
+  }
+
+  set(scope: Scope, property: string, value: any) {
+    this.values.set(scope.toString() + property, value);
+  }
+
+  clear(scope: Scope, property: string) {
+    this.values.delete(scope.toString() + property);
+  }
+}
+
+export default new ScopedValuesRegistry();

package/src/decorators/Graph.ts

@@ -0,0 +1,20 @@
+import { Constructable, Scope } from '@Obsidian';
+import 'reflect-metadata';
+import graphRegistry from '../graph/registry/GraphRegistry';
+import ObjectGraph from '../graph/ObjectGraph';
+
+interface GraphParams {
+  scope: Scope | undefined;
+  subgraphs: Constructable<ObjectGraph>[];
+}
+
+export default function Graph({
+  scope,
+  subgraphs = [],
+}: Partial<GraphParams> = {}) {
+  return <T extends ObjectGraph>(constructor: Constructable<T>) => {
+    Reflect.defineMetadata('scope', scope, constructor);
+    graphRegistry.register(constructor, scope, subgraphs);
+    return constructor;
+  };
+}

package/src/decorators/injectClass.ts

@@ -0,0 +1,28 @@
+import { Constructable } from '@Obsidian';
+import graphRegistry from '../graph/registry/GraphRegistry';
+import ObjectGraph from '../graph/ObjectGraph';
+
+const injectionMetadataKey = 'injectionMetadata';
+
+export function Injectable<T extends { new(...args: any[]): any }>(Graph: Constructable<ObjectGraph>): any {
+  return (Target: T) => {
+    const proxy = {
+      construct(target: any, args: any[], newTarget: any): new() => {} {
+        const keysToInject: string[] = Reflect.getMetadata(injectionMetadataKey, target) ?? [];
+
+        const createdObject = Reflect.construct(target, args, newTarget);
+        const graph = graphRegistry.resolve(Graph);
+        for (const key of keysToInject) {
+          Reflect.set(createdObject, key, graph.retrieve(key));
+        }
+        return createdObject;
+      },
+    };
+    return new Proxy(Target, proxy);
+  };
+}
+
+export function Inject(target: Object, propertyKey: string) {
+  const keysToInject = Reflect.getMetadata(injectionMetadataKey, target.constructor) ?? new Set();
+  Reflect.defineMetadata(injectionMetadataKey, keysToInject.add(propertyKey), target.constructor);
+}

package/src/graph/Graph.ts

@@ -0,0 +1,7 @@
+import PropertyRetrieverDelegate from './PropertyRetrieverDelegate';
+
+interface Graph extends PropertyRetrieverDelegate {
+  get name(): string;
+}
+
+export default Graph;

package/src/graph/ObjectGraph.ts

@@ -0,0 +1,19 @@
+import { Scope } from '@Obsidian';
+import Graph from './Graph';
+import PropertyRetriever from './PropertyRetriever';
+
+export default abstract class ObjectGraph<T = unknown> implements Graph {
+  // TODO? rename scope to singleInstance
+  public scope!: Scope;
+  private propertyRetriever = new PropertyRetriever(this);
+  get name(): string {
+    return this.constructor.name;
+  }
+
+  // eslint-disable-next-line no-useless-constructor, no-unused-vars, no-empty-function
+  constructor(protected props?: T) {}
+
+  retrieve<Dependency>(property: string, receiver?: unknown): Dependency | undefined {
+    return this.propertyRetriever.retrieve(property, receiver) as Dependency | undefined;
+  }
+}

package/src/graph/PropertyRetriever.ts

@@ -0,0 +1,36 @@
+import graphRegistry from './registry/GraphRegistry';
+import Graph from './Graph';
+import providedPropertiesStore from '../ProvidedPropertiesStore';
+
+export default class PropertyRetriever {
+  constructor(private graph: Graph) { }
+
+  retrieve(property: string, receiver?: unknown): unknown | undefined {
+    const mangledPropertyKey = providedPropertiesStore.getMangledProperty(this.graph, property);
+    if (mangledPropertyKey && mangledPropertyKey in this.graph) {
+      const proxiedGraph = new Proxy(this.graph, {
+        get(graph: Graph, dependencyName: string) {
+          return graph.retrieve(dependencyName);
+        },
+      });
+      return Reflect.get(this.graph, mangledPropertyKey, receiver)(proxiedGraph);
+    }
+
+    const results = this.getFromSubgraphs(property, receiver);
+    if (results.length === 1) return results[0];
+    if (results.length > 1) {
+      throw new Error(
+        `Multiple subgraphs provide the property ${property}.`
+        + 'You should probably provide a unique name to one of the providers: @Provide({name: \'uniqueName\')})',
+      );
+    }
+    return undefined;
+  }
+
+  private getFromSubgraphs(property: string, receiver: unknown): unknown[] {
+    const subgraphs = graphRegistry.getSubgraphs(this.graph);
+    return subgraphs
+      .map((subgraph: Graph) => subgraph.retrieve(property, receiver))
+      .filter((result) => result !== undefined);
+  }
+}

package/src/graph/PropertyRetrieverDelegate.ts

@@ -0,0 +1,5 @@
+interface PropertyRetrieverDelegate {
+  retrieve: (property: string, receiver?: unknown) => unknown | undefined;
+}
+
+export default PropertyRetrieverDelegate;