engrrajonahmed/aviortui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: engrrajonahmed:data/file
Branches Tags
engrrajonahmed:main
engrrajonahmed:state/m1
engrrajonahmed:essential/file
engrrajonahmed:data/file
engrrajonahmed:root/file
..
compare: engrrajonahmed:main
Branches Tags
engrrajonahmed:state/m1
engrrajonahmed:essential/file
engrrajonahmed:data/file
engrrajonahmed:root/file
engrrajonahmed:main

No commits in common. "data/file" and "main" have entirely different histories.
data/file ... main

7 changed files with 0 additions and 540 deletions
Show Stats Expand all files Collapse all files

34
data/cabinet/cabinet.go
View File

@ -1,34 +0,0 @@
/*
|--------------------------------------------------------------------------
| Description
|--------------------------------------------------------------------------
|
| Name:
| - Cabinet
|
| Purpose:
| - Provides a centralized coordination point for framework-owned and
| software-owned data ledgers, determining the appropriate ledger for
| resource registration and access.
|
|--------------------------------------------------------------------------
*/
/*
|--------------------------------------------------------------------------
| Credit
|--------------------------------------------------------------------------
|
| Contributor:
| - Rajon Ahmed
| - Blockonite
|
|--------------------------------------------------------------------------
*/
package cabinet
import (
_ "go/module/data/framework/ledger"
_ "go/module/data/software/ledger"
)

53
data/framework/ledger/ledger.go
View File

@ -1,53 +0,0 @@
/*
|--------------------------------------------------------------------------
| Description
|--------------------------------------------------------------------------
|
| Name:
| - Ledger
|
| Purpose:
| - Registers framework-owned resources and resolves each resource to
| its responsible handler.
|
|--------------------------------------------------------------------------
*/
/*
|--------------------------------------------------------------------------
| Credit
|--------------------------------------------------------------------------
|
| Contributor:
| - Rajon Ahmed
| - Blockonite
|
|--------------------------------------------------------------------------
*/
package ledger
import (
"go/module/data/framework/metadata"
// Additional framework resources.
// e.g.: "go/module/data/framework/glossary"
)
// Initialize the framework resource ledger.
func init() {
obrimLedger()
}
// Register all framework resource handlers.
func obrimLedger() {
obrimLedgerRegister()
}
// Register all framework handlers with Retriever.
func obrimLedgerRegister() {
// Framework metadata resource.
metadata.ObrimHandlerJson()
// Additional framework resources.
// e.g.: glossary.ObrimHandlerJson()
}

192
data/framework/metadata/handler.go
View File

@ -1,192 +0,0 @@
/*
|--------------------------------------------------------------------------
| Description
|--------------------------------------------------------------------------
|
| Name:
| - Handler
|
| Purpose:
| - Provides access to embedded framework metadata resources through
| resource-specific retrieval and parsing logic.
|
|--------------------------------------------------------------------------
*/
/*
|--------------------------------------------------------------------------
| Credit
|--------------------------------------------------------------------------
|
| Contributor:
| - Rajon Ahmed
| - Blockonite
|
|--------------------------------------------------------------------------
*/
package metadata
import (
"embed"
"encoding/json"
"sync"
"go/module/essential/visible/service/helper/retriever"
)
// ObrimHandlerResource is the registered JSON resource identifier.
const ObrimHandlerResource = "framework/metadata"
// Success result codes.
const (
ObrimHandlerCodeSuccessLoaded = "SUCCESS_RESOURCE_LOADED"
)
// Failure result codes.
const (
ObrimHandlerCodeFailureNotFound = "FAILURE_RESOURCE_NOT_FOUND"
ObrimHandlerCodeFailureLoad = "FAILURE_RESOURCE_LOAD"
ObrimHandlerCodeFailureParse = "FAILURE_RESOURCE_PARSE"
)
// handlerResourceFile is the embedded JSON resource filename.
const handlerResourceFile = "resource.json"
// handlerEmbeddedResource stores the embedded JSON resource.
//
//go:embed resource.json
var handlerEmbeddedResource embed.FS
// obrimHandlerCacheMutex protects the resource cache.
var obrimHandlerCacheMutex sync.RWMutex
// obrimHandlerCachedResource stores the parsed resource for the application lifetime.
var obrimHandlerCachedResource map[string]any
// ObrimHandlerPayload defines the successful payload structure.
type ObrimHandlerPayload struct {
Resource string `json:"resource"`
Data map[string]any `json:"data"`
}
// ObrimHandlerOutput defines the standardized utility output.
type ObrimHandlerOutput struct {
Status bool `json:"status"`
Code string `json:"code"`
Payload *ObrimHandlerPayload `json:"payload"`
}
// ObrimHandlerJson registers the JSON handler callback with Retriever.
func ObrimHandlerJson() {
retriever.ObrimRetrieverJsonRegister(
ObrimHandlerResource,
obrimHandlerFetch,
)
}
// obrimHandler is the internal handler entry function.
func obrimHandler() ObrimHandlerOutput {
return obrimHandlerFetch()
}
// obrimHandlerFetch loads, parses, caches, and returns the complete JSON resource.
func obrimHandlerFetch() ObrimHandlerOutput {
if cached, ok := obrimHandlerCache(); ok {
return obrimHandlerOutput(
true,
ObrimHandlerCodeSuccessLoaded,
cached,
)
}
data, err := obrimHandlerLoad()
if err != nil {
return obrimHandlerOutput(
false,
ObrimHandlerCodeFailureLoad,
nil,
)
}
resource, err := obrimHandlerParse(data)
if err != nil {
return obrimHandlerOutput(
false,
ObrimHandlerCodeFailureParse,
nil,
)
}
obrimHandlerCache(resource)
return obrimHandlerOutput(
true,
ObrimHandlerCodeSuccessLoaded,
resource,
)
}
// obrimHandlerCache retrieves or stores the parsed JSON resource cache.
func obrimHandlerCache(resource ...map[string]any) (map[string]any, bool) {
obrimHandlerCacheMutex.Lock()
defer obrimHandlerCacheMutex.Unlock()
switch len(resource) {
case 0:
if obrimHandlerCachedResource == nil {
return nil, false
}
return obrimHandlerCachedResource, true
default:
obrimHandlerCachedResource = resource[0]
return obrimHandlerCachedResource, true
}
}
// obrimHandlerEmbed returns the embedded JSON resource filesystem.
func obrimHandlerEmbed() embed.FS {
return handlerEmbeddedResource
}
// obrimHandlerLoad loads the embedded JSON resource.
func obrimHandlerLoad() ([]byte, error) {
return obrimHandlerEmbed().ReadFile(handlerResourceFile)
}
// obrimHandlerParse parses the embedded JSON resource.
func obrimHandlerParse(data []byte) (map[string]any, error) {
resource := make(map[string]any)
if err := json.Unmarshal(data, &resource); err != nil {
return nil, err
}
return resource, nil
}
// obrimHandlerOutput builds the standardized utility output.
func obrimHandlerOutput(
status bool,
code string,
resource map[string]any,
) ObrimHandlerOutput {
if !status || resource == nil {
return ObrimHandlerOutput{
Status: false,
Code: code,
Payload: nil,
}
}
return ObrimHandlerOutput{
Status: true,
Code: code,
Payload: &ObrimHandlerPayload{
Resource: ObrimHandlerResource,
Data: resource,
},
}
}

8
data/framework/metadata/resource.json
View File

@ -1,8 +0,0 @@
{
"framework": {
"regular": "Framework Regular",
"lower": "frameworklower",
"upper": "FRAMEWORKUPPER",
"version": "0.0.0"
}
}

53
data/software/ledger/ledger.go
View File

@ -1,53 +0,0 @@
/*
|--------------------------------------------------------------------------
| Description
|--------------------------------------------------------------------------
|
| Name:
| - Ledger
|
| Purpose:
| - Registers software-owned resources and resolves each resource to
| its responsible handler.
|
|--------------------------------------------------------------------------
*/
/*
|--------------------------------------------------------------------------
| Credit
|--------------------------------------------------------------------------
|
| Contributor:
| - Rajon Ahmed
| - Blockonite
|
|--------------------------------------------------------------------------
*/
package ledger
import (
"go/module/data/software/metadata"
// Additional software resources.
// e.g.: "go/module/data/software/glossary"
)
// Initialize the software resource ledger.
func init() {
obrimLedger()
}
// Register all software resource handlers.
func obrimLedger() {
obrimLedgerRegister()
}
// Register all software handlers with Retriever.
func obrimLedgerRegister() {
// software metadata resource.
metadata.ObrimHandlerJson()
// Additional software resources.
// e.g.: glossary.ObrimHandlerJson()
}

192
data/software/metadata/handler.go
View File

@ -1,192 +0,0 @@
/*
|--------------------------------------------------------------------------
| Description
|--------------------------------------------------------------------------
|
| Name:
| - Handler
|
| Purpose:
| - Provides access to embedded software metadata resources through
| resource-specific retrieval and parsing logic.
|
|--------------------------------------------------------------------------
*/
/*
|--------------------------------------------------------------------------
| Credit
|--------------------------------------------------------------------------
|
| Contributor:
| - Rajon Ahmed
| - Blockonite
|
|--------------------------------------------------------------------------
*/
package metadata
import (
"embed"
"encoding/json"
"sync"
"go/module/essential/visible/service/helper/retriever"
)
// ObrimHandlerResource is the registered JSON resource identifier.
const ObrimHandlerResource = "framework/metadata"
// Success result codes.
const (
ObrimHandlerCodeSuccessLoaded = "SUCCESS_RESOURCE_LOADED"
)
// Failure result codes.
const (
ObrimHandlerCodeFailureNotFound = "FAILURE_RESOURCE_NOT_FOUND"
ObrimHandlerCodeFailureLoad = "FAILURE_RESOURCE_LOAD"
ObrimHandlerCodeFailureParse = "FAILURE_RESOURCE_PARSE"
)
// handlerResourceFile is the embedded JSON resource filename.
const handlerResourceFile = "resource.json"
// handlerEmbeddedResource stores the embedded JSON resource.
//
//go:embed resource.json
var handlerEmbeddedResource embed.FS
// obrimHandlerCacheMutex protects the resource cache.
var obrimHandlerCacheMutex sync.RWMutex
// obrimHandlerCachedResource stores the parsed resource for the application lifetime.
var obrimHandlerCachedResource map[string]any
// ObrimHandlerPayload defines the successful payload structure.
type ObrimHandlerPayload struct {
Resource string `json:"resource"`
Data map[string]any `json:"data"`
}
// ObrimHandlerOutput defines the standardized utility output.
type ObrimHandlerOutput struct {
Status bool `json:"status"`
Code string `json:"code"`
Payload *ObrimHandlerPayload `json:"payload"`
}
// ObrimHandlerJson registers the JSON handler callback with Retriever.
func ObrimHandlerJson() {
retriever.ObrimRetrieverJsonRegister(
ObrimHandlerResource,
obrimHandlerFetch,
)
}
// obrimHandler is the internal handler entry function.
func obrimHandler() ObrimHandlerOutput {
return obrimHandlerFetch()
}
// obrimHandlerFetch loads, parses, caches, and returns the complete JSON resource.
func obrimHandlerFetch() ObrimHandlerOutput {
if cached, ok := obrimHandlerCache(); ok {
return obrimHandlerOutput(
true,
ObrimHandlerCodeSuccessLoaded,
cached,
)
}
data, err := obrimHandlerLoad()
if err != nil {
return obrimHandlerOutput(
false,
ObrimHandlerCodeFailureLoad,
nil,
)
}
resource, err := obrimHandlerParse(data)
if err != nil {
return obrimHandlerOutput(
false,
ObrimHandlerCodeFailureParse,
nil,
)
}
obrimHandlerCache(resource)
return obrimHandlerOutput(
true,
ObrimHandlerCodeSuccessLoaded,
resource,
)
}
// obrimHandlerCache retrieves or stores the parsed JSON resource cache.
func obrimHandlerCache(resource ...map[string]any) (map[string]any, bool) {
obrimHandlerCacheMutex.Lock()
defer obrimHandlerCacheMutex.Unlock()
switch len(resource) {
case 0:
if obrimHandlerCachedResource == nil {
return nil, false
}
return obrimHandlerCachedResource, true
default:
obrimHandlerCachedResource = resource[0]
return obrimHandlerCachedResource, true
}
}
// obrimHandlerEmbed returns the embedded JSON resource filesystem.
func obrimHandlerEmbed() embed.FS {
return handlerEmbeddedResource
}
// obrimHandlerLoad loads the embedded JSON resource.
func obrimHandlerLoad() ([]byte, error) {
return obrimHandlerEmbed().ReadFile(handlerResourceFile)
}
// obrimHandlerParse parses the embedded JSON resource.
func obrimHandlerParse(data []byte) (map[string]any, error) {
resource := make(map[string]any)
if err := json.Unmarshal(data, &resource); err != nil {
return nil, err
}
return resource, nil
}
// obrimHandlerOutput builds the standardized utility output.
func obrimHandlerOutput(
status bool,
code string,
resource map[string]any,
) ObrimHandlerOutput {
if !status || resource == nil {
return ObrimHandlerOutput{
Status: false,
Code: code,
Payload: nil,
}
}
return ObrimHandlerOutput{
Status: true,
Code: code,
Payload: &ObrimHandlerPayload{
Resource: ObrimHandlerResource,
Data: resource,
},
}
}

8
data/software/metadata/resource.json
View File

@ -1,8 +0,0 @@
{
"software": {
"regular": "Software Regular",
"lower": "softwarelower",
"upper": "SOFTWAREUPPER",
"version": "0.0.0"
}
}