Skip to content

Commit

Permalink
Renamed everything to kgamble.dev
Browse files Browse the repository at this point in the history
  • Loading branch information
keith-gamble committed Nov 14, 2024
1 parent 175ac48 commit 042abd9
Show file tree
Hide file tree
Showing 23 changed files with 49 additions and 49 deletions.
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Barry-Wehmiller Design Group
Copyright (c) 2024 Keith Gamble

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
6 changes: 3 additions & 3 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ ignitionModule {
// Basic module metadata
name.set("Example Component Library") // The human-readable name shown in the Gateway
fileName.set("Example-Component-Library.modl") // The output file name
id.set("dev.bwdesigngroup.perspective.examples.ExampleComponentLibrary") // Unique module identifier
id.set("dev.kgamble.perspective.examples.ExampleComponentLibrary") // Unique module identifier
moduleVersion.set("${project.version}") // Version from allprojects block
license.set("LICENSE.txt") // License file to include
moduleDescription.set("A module that adds Example React components to Perspective.")
Expand All @@ -44,8 +44,8 @@ ignitionModule {
// Register the module hooks that initialize the module in each scope
hooks.putAll(
mapOf(
"dev.bwdesigngroup.perspective.examples.gateway.ExampleComponentLibraryGatewayHook" to "G",
"dev.bwdesigngroup.perspective.examples.designer.ExampleComponentLibraryDesignerHook" to "D"
"dev.kgamble.perspective.examples.gateway.ExampleComponentLibraryGatewayHook" to "G",
"dev.kgamble.perspective.examples.designer.ExampleComponentLibraryDesignerHook" to "D"
)
)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Copyright 2022 Keith Gamble
* [License information]
*/
package dev.bwdesigngroup.perspective.examples.common;
package dev.kgamble.perspective.examples.common;

/**
* This class contains constant values used across the Example Component Library
Expand All @@ -18,7 +18,7 @@ public class Constants {
* This ID is used in various parts of the module sdk to recognize and
* manage the module.
*/
public static final String MODULE_ID = "dev.bwdesigngroup.perspective.examples.ExampleComponentLibrary";
public static final String MODULE_ID = "dev.kgamble.perspective.examples.ExampleComponentLibrary";

/**
* The URL alias for this module's resources.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dev.bwdesigngroup.perspective.examples.common;
package dev.kgamble.perspective.examples.common;

import java.util.Set;
import com.inductiveautomation.perspective.common.api.BrowserResource;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dev.bwdesigngroup.perspective.examples.common.components.input;
package dev.kgamble.perspective.examples.common.components.input;

import java.util.List;
import java.awt.image.BufferedImage;
Expand All @@ -7,10 +7,10 @@
import com.inductiveautomation.perspective.common.api.ComponentDescriptorImpl;
import com.inductiveautomation.perspective.common.api.ComponentEventDescriptor;

import dev.bwdesigngroup.perspective.examples.common.Constants;
import dev.bwdesigngroup.perspective.examples.common.ExampleComponents;
import dev.bwdesigngroup.perspective.examples.common.utilities.ComponentUtilities;
import dev.bwdesigngroup.perspective.examples.common.utilities.ImageUtilities;
import dev.kgamble.perspective.examples.common.Constants;
import dev.kgamble.perspective.examples.common.ExampleComponents;
import dev.kgamble.perspective.examples.common.utilities.ComponentUtilities;
import dev.kgamble.perspective.examples.common.utilities.ImageUtilities;

/**
* This class describes the Button component to the Java registry.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Copyright 2022 Keith Gamble
* [License information]
*/
package dev.bwdesigngroup.perspective.examples.common.utilities;
package dev.kgamble.perspective.examples.common.utilities;

import com.inductiveautomation.ignition.common.jsonschema.JsonSchema;
import com.inductiveautomation.perspective.common.api.ComponentEventDescriptor;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package dev.bwdesigngroup.perspective.examples.common.utilities;
package dev.kgamble.perspective.examples.common.utilities;

import java.util.Collection;
import java.util.Optional;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Copyright 2022 Keith Gamble
* [License information]
*/
package dev.bwdesigngroup.perspective.examples.common.utilities;
package dev.kgamble.perspective.examples.common.utilities;

import java.awt.image.BufferedImage;
import java.awt.Graphics2D;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package dev.bwdesigngroup.perspective.examples.designer;
package dev.kgamble.perspective.examples.designer;

import javax.swing.Icon;
import java.util.Optional;
Expand All @@ -14,7 +14,7 @@
import com.inductiveautomation.perspective.common.api.ComponentDescriptor;
import com.inductiveautomation.perspective.designer.DesignerComponentRegistry;

import dev.bwdesigngroup.perspective.examples.common.utilities.DelegatingComponentDescriptor;
import dev.kgamble.perspective.examples.common.utilities.DelegatingComponentDescriptor;

/**
* Utility class for registering components with custom icons in the Ignition Designer.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dev.bwdesigngroup.perspective.examples.designer;
package dev.kgamble.perspective.examples.designer;

import com.inductiveautomation.ignition.common.licensing.LicenseState;
import com.inductiveautomation.ignition.common.util.LoggerEx;
Expand All @@ -7,7 +7,7 @@
import com.inductiveautomation.perspective.designer.DesignerComponentRegistry;
import com.inductiveautomation.perspective.designer.api.PerspectiveDesignerInterface;

import dev.bwdesigngroup.perspective.examples.common.components.input.Button;
import dev.kgamble.perspective.examples.common.components.input.Button;

/**
* Designer module hook for the Example Component Library.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package dev.bwdesigngroup.perspective.examples.designer;
package dev.kgamble.perspective.examples.designer;

import javax.swing.Icon;
import java.io.IOException;
Expand Down
2 changes: 1 addition & 1 deletion docker/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ services:
--
-Dia.developer.moduleupload=true
-Dignition.allowunsignedmodules=true
-Dres.path.dev.bwdesigngroup.perspective.examples.ExampleComponentLibrary=/web-resources/build/generated-resources/mounted
-Dres.path.dev.kgamble.perspective.examples.ExampleComponentLibrary=/web-resources/build/generated-resources/mounted
# If a traefik proxy container is not being used, comment out everything below this line (https://github.com/design-group/traefik-proxy)
networks:
Expand Down
16 changes: 8 additions & 8 deletions docs/archive/adding-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,16 +150,16 @@ If your component needs specific styles, add them to `web/src/css/styles.css`.

### 2.1 Create the Java Component Class

Create a new Java file in `common/src/main/java/dev/bwdesigngroup/perspective/examples/common/components/`. For example, `MyNewComponent.java`:
Create a new Java file in `common/src/main/java/dev/kgamble/perspective/examples/common/components/`. For example, `MyNewComponent.java`:

```java
package dev.bwdesigngroup.perspective.examples.common.components;
package dev.kgamble.perspective.examples.common.components;

import java.util.List;
import com.inductiveautomation.perspective.common.api.ComponentDescriptor;
import com.inductiveautomation.perspective.common.api.ComponentDescriptorImpl;
import dev.bwdesigngroup.perspective.examples.common.Constants;
import dev.bwdesigngroup.perspective.examples.common.ExampleComponents;
import dev.kgamble.perspective.examples.common.Constants;
import dev.kgamble.perspective.examples.common.ExampleComponents;

public class MyNewComponent {
// This should match the ID used in the TypeScript component class
Expand Down Expand Up @@ -200,10 +200,10 @@ Create a JSON schema file for your component's properties in `common/src/main/re

### 3.1 Update the Gateway Hook

Modify `gateway/src/main/java/dev/bwdesigngroup/perspective/examples/gateway/ExampleComponentLibraryGatewayHook.java` to register your new component:
Modify `gateway/src/main/java/dev/kgamble/perspective/examples/gateway/ExampleComponentLibraryGatewayHook.java` to register your new component:

```java
import dev.bwdesigngroup.perspective.examples.common.components.MyNewComponent;
import dev.kgamble.perspective.examples.common.components.MyNewComponent;

public class ExampleComponentLibraryGatewayHook extends AbstractGatewayModuleHook {
@Override
Expand Down Expand Up @@ -232,10 +232,10 @@ public class ExampleComponentLibraryGatewayHook extends AbstractGatewayModuleHoo

### 4.1 Update the Designer Hook

Modify `designer/src/main/java/dev/bwdesigngroup/perspective/examples/designer/ExampleComponentLibraryDesignerHook.java` to register your new component:
Modify `designer/src/main/java/dev/kgamble/perspective/examples/designer/ExampleComponentLibraryDesignerHook.java` to register your new component:

```java
import dev.bwdesigngroup.perspective.examples.common.components.MyNewComponent;
import dev.kgamble.perspective.examples.common.components.MyNewComponent;

public class ExampleComponentLibraryDesignerHook extends AbstractDesignerModuleHook {
private void init() {
Expand Down
2 changes: 1 addition & 1 deletion docs/archive/environment-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ It is possible to map your built js files into the gateway, so that you dont nee
commands:
# ... other commands
--
-Dres.path.dev.bwdesigngroup.perspective.examples.ExampleComponentLibrary=/web-resources/build/generated-resources/mounted
-Dres.path.dev.kgamble.perspective.examples.ExampleComponentLibrary=/web-resources/build/generated-resources/mounted
```

The reason that this is mounted at the `./web` level, instead of all the way down to the mounted content, is because when the webpack copy happens if you do a `clean` first it will delete the `build` directory inside of `./web` which will throw off permissions on the finally created content. This just makes it easier to ensure that you have consistent permissions the whole time.
Expand Down
6 changes: 3 additions & 3 deletions docs/archive/faq/groovy-vs-kotlin.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ allprojects {
ignitionModule {
name = "Example Component Library"
fileName = "Example-Component-Library.modl"
id = "dev.bwdesigngroup.perspective.examples.ExampleComponentLibrary"
id = "dev.kgamble.perspective.examples.ExampleComponentLibrary"
moduleVersion = version
license = "LICENSE.txt"
moduleDescription = "A module that adds Example React components to Perspective."
Expand All @@ -98,8 +98,8 @@ ignitionModule {
moduleDependencies = [ "com.inductiveautomation.perspective": "GD" ]
hooks = [
"dev.bwdesigngroup.perspective.examples.gateway.ExampleComponentLibraryGatewayHook": "G",
"dev.bwdesigngroup.perspective.examples.designer.ExampleComponentLibraryDesignerHook": "D"
"dev.kgamble.perspective.examples.gateway.ExampleComponentLibraryGatewayHook": "G",
"dev.kgamble.perspective.examples.designer.ExampleComponentLibraryDesignerHook": "D"
]
applyInductiveArtifactRepo = true
Expand Down
6 changes: 3 additions & 3 deletions docs/archive/module-build-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ ignitionModule {
// Basic module information
name.set("Example Component Library")
fileName.set("Example-Component-Library.modl")
id.set("dev.bwdesigngroup.perspective.examples.ExampleComponentLibrary")
id.set("dev.kgamble.perspective.examples.ExampleComponentLibrary")
moduleVersion.set("${project.version}")

// Module requirements
Expand All @@ -79,8 +79,8 @@ ignitionModule {
moduleDependencies.put("com.inductiveautomation.perspective", "GD")
hooks.putAll(
mapOf(
"dev.bwdesigngroup.perspective.examples.gateway.ExampleComponentLibraryGatewayHook" to "G",
"dev.bwdesigngroup.perspective.examples.designer.ExampleComponentLibraryDesignerHook" to "D"
"dev.kgamble.perspective.examples.gateway.ExampleComponentLibraryGatewayHook" to "G",
"dev.kgamble.perspective.examples.designer.ExampleComponentLibraryDesignerHook" to "D"
)
)
}
Expand Down
8 changes: 4 additions & 4 deletions docs/archive/naming-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ The module ID follows a reverse domain name pattern and is defined in multiple l

```kotlin
ignitionModule {
id.set("dev.bwdesigngroup.perspective.examples.ExampleComponentLibrary")
id.set("dev.kgamble.perspective.examples.ExampleComponentLibrary")
}
```

2. **Constants** (`Constants.java`):

```java
public static final String MODULE_ID = "dev.bwdesigngroup.perspective.examples.ExampleComponentLibrary";
public static final String MODULE_ID = "dev.kgamble.perspective.examples.ExampleComponentLibrary";
```

### Module URL Alias
Expand Down Expand Up @@ -107,7 +107,7 @@ public static final Set<BrowserResource> BROWSER_RESOURCES = Set.of(
## Package Structure

```
dev.bwdesigngroup.perspective.examples
dev.kgamble.perspective.examples
├── common
│ ├── Constants.java
│ ├── components
Expand All @@ -122,7 +122,7 @@ dev.bwdesigngroup.perspective.examples

### Naming Patterns

1. **Base Package**: `dev.bwdesigngroup.perspective.examples`
1. **Base Package**: `dev.kgamble.perspective.examples`
2. **Component Categories**: `components.{category}`
3. **Utility Classes**: `utilities`
4. **Hook Classes**: `{scope}.hooks`
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/2-Development/1-docker-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ services:
GATEWAY_RESTORE_DISABLED: "false"
command: >
--
-Dres.path.dev.bwdesigngroup.perspective.examples.ExampleComponentLibrary=/web-resources/build/generated-resources/mounted
-Dres.path.dev.kgamble.perspective.examples.ExampleComponentLibrary=/web-resources/build/generated-resources/mounted
```
## Usage
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/4-Guides/2-build-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ ignitionModule {
// Module definition
name.set("Example Component Library")
fileName.set("Example-Component-Library.modl")
id.set("dev.bwdesigngroup.perspective.examples")
id.set("dev.kgamble.perspective.examples")

// Project scope mapping
projectScopes.putAll(
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/4-Guides/3-naming-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Consistent naming is crucial for maintainable code and proper module functionali
Example:

```java
dev.bwdesigngroup.perspective.examples.ExampleComponentLibrary
dev.kgamble.perspective.examples.ExampleComponentLibrary
```

:::info Why This Pattern?
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dev.bwdesigngroup.perspective.examples.gateway;
package dev.kgamble.perspective.examples.gateway;

import java.util.Optional;

Expand All @@ -9,8 +9,8 @@
import com.inductiveautomation.perspective.common.api.ComponentRegistry;
import com.inductiveautomation.perspective.gateway.api.PerspectiveContext;

import dev.bwdesigngroup.perspective.examples.common.Constants;
import dev.bwdesigngroup.perspective.examples.common.components.input.Button;
import dev.kgamble.perspective.examples.common.Constants;
import dev.kgamble.perspective.examples.common.components.input.Button;

/**
* Gateway module hook for the Example Component Library.
Expand Down
4 changes: 2 additions & 2 deletions web/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion web/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@design-group/example-components",
"name": "@kgamble/example-components",
"version": "0.0.1",
"description": "A collection of example React components",
"main": "dist/index.js",
Expand Down

0 comments on commit 042abd9

Please sign in to comment.