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> وإنشاء مجموعة من القواعد للسمات المعلنة في الحقائق.

تتبع القواعد هيكل البيانات المعلنة في الحقائق. سيتم تنفيذ قاعدة لكل سمة.

توفر وظيفة إنشاء القاعدة وسيطتين، الأولى هي attributes والثانية events .

يمكنك استخدام تعبير منطقي لكل اختبار وتنفيذ الإجراء الذي تريده، أو يمكنك استخدام الحدث when then لاختبار الإجراء وتنفيذه بناءً على النتيجة. يعد هذا خيارًا جيدًا للاختبار الديناميكي.

بعد إنشاء مثيل وتسجيل القواعد، يمكنك ببساطة تنفيذ طريقة التشغيل عن طريق تمرير القواعد المحددة كمعلمة. في نهاية الاختبارات، إذا لم يكن هناك خطأ يقاطع تدفق الاختبارات، فسيتم إرجاع قيمة منطقية.

• true لقد مرت جميع الظروف.
• false واحد أو فشل كل الشروط.

 // ... 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']

• lessOrEqual

 // 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 . تقوم بإرجاع وعد بنتيجة منطقية من الاختبار الذي تم إجراؤه.

• متى

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

المساهمة

Grule هو في إصدار أولي دون العديد من الميزات حتى الآن، ولكن لا تتردد في إرسال اقتراحك أو فتح العلاقات العامة.