grule

JSON 内のルールを検証するためのシンプルかつ強力なメカニズム。

_{Hiukky によって❤︎ で構築されました}

について

Grule は、JSON スキームを使用して値に対して条件をテストするための最小限のメカニズムです。その主な目的は、Rete メカニズムとして機能し、すべての操作をパフォーマンス的かつ簡単な方法で解決することです。

インストール

NPM の使用

npm i grule

糸を使う

yarn add grule

使用

ルールスキームを設定するには、以下の手順に従ってください。

インスタンスを作成する

テスト インスタンスを作成するには、エンジンに電力を供給するための大量のファクトが必要になります。

 // Import Engine
import { Grule } from 'grule'

// Create an type
type IUser = {
  id : number
  name : string
}

// Create metadata
const metadata : IUser = {
  id : 3 ,
  name : 'test' ,
}

// Create instance
const grule = new Grule < IUser > ( metadata )

購読ルール

エンジンのインスタンスを作成し、ファクトを事前にロードした後、次のステップはルールを登録することです。ルールを登録するには、 IRules <T>インターフェイスをインポートし、ファクトで宣言された属性のルールのセットを作成する必要があります。

ルールは、ファクトで宣言されたデータの構造に従います。属性ごとにルールが実行されます。

ルール作成関数は 2 つの引数を提供します。1 つ目はattributes 、2 つ目はevents 。

各テストに論理式を使用して必要なアクションを実行することも、 whenおよびthenイベントを使用してテストし、結果に基づいてアクションを実行することもできます。これは動的テストに適したオプションです。

インスタンスを作成してルールを登録した後は、パラメータとして定義されたルールを渡すだけで run メソッドを実行できます。テストの終了時に、テストのフローを中断するエラーがなければ、ブール値が返されます。

• trueすべての条件が合格しました。
• false条件の 1 つまたはすべてが失敗しました。

 // ... Previous code

// Create Rules
const rules : IRules < IUser > = ( { id , name } , { when } ) => ( {
  id : when ( id . diff ( 1 ) ) . then ( ( ) => {
    throw new Error ( 'User not allowed.' )
  } ) ,
  name : name . in ( [ 'foo' , 'test' ] ) ,
} )

// Enroll rules
grule . run ( rules )

前のフローをよりきれいな方法で単純化することもできます。 (最終的なコード例)

 // Import Engine
import { Grule } from 'grule'

// Create an type
type IUser = {
  id : number
  name : string
}

// Create instance
new Grule < IUser > ( {
  id : 3 ,
  name : 'test' ,
} ) . run ( ( { id , name } , { when } ) => ( {
  id : when ( id . diff ( 1 ) ) . then ( ( ) => {
    throw new Error ( 'User not allowed.' )
  } ) ,
  name : name . in ( [ 'foo' , 'test' ] ) ,
} ) ) 

利用可能な方法

属性の場合

各属性には、テストに使用できる 9 つのメソッドがあります。

• 少ない

 // Type: less(value: ILess): boolean
// Acceptable: ['number', 'bigint']

• 以下または等しい

 // Type: lessOrEqual(value: ILess): boolean
// Acceptable: ['number', 'bigint']

• より大きな

 // Type: greater(value: IGreater): boolean
// Acceptable: ['number', 'bigint']

• 大きいか等しい

 // Type: greaterOrEqual(value: IGreater): boolean
// Acceptable: ['number', 'bigint']

• 等しい

 // Type: equal(value: IEqual): boolean
// Acceptable: ['bigint', 'boolean', 'number', 'string', 'date']

• 差分

 // Type: diff(value: IEqual): boolean
// Acceptable: ['bigint', 'boolean', 'number', 'string', 'date']

• で

 // Type: in(value: In): boolean
// Acceptable: ['bigint', 'boolean', 'number', 'string', 'array']

• 入っていない

 // Type: notIn(value: In): boolean
// Acceptable: ['bigint', 'boolean', 'number', 'string', 'array']

• 評価

 // Type: eval(operator: IOperatorsList, arg1: A): boolean
// Acceptable: [Idle]

イベント用

Grule には現在、 when以外のイベントが 1 つだけあります。実行されたテストのブール結果を含む Promise を返します。

• いつ

 // Type: when(test: boolean): Promise<boolean>
// Acceptable: ['boolean']

貢献する

Grule はまだ多くの機能が備わっていない初期バージョンですが、お気軽に提案を送信したり、PR をオープンしたりできます。