clipsruby 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b86283884e46ed71a0e4db078683c2443b9f1baf9220ab0a5e9f90eef02b0ba
-  data.tar.gz: 0632d1971aedb15f695e0d43400113f45693fba7db6547d6497887df81c019a4
+  metadata.gz: 75e4ce843f3549eb6b8508d4d97ab8193dc8434acab30659af50871953759991
+  data.tar.gz: 5372088f0743df5a5e3e94833bb7334608bfe85c0ede4879476e3a014eeb034d
 SHA512:
-  metadata.gz: e72f8a5f5eae7b0befcfcfe5fd850a62cdef2c984f5a6cbbfcfab52190adcfa90a5c5af5a7ef028ee573105f4aacfd5ead750bbae7c496bde05e0eedb07df3b9
-  data.tar.gz: c08ddb4e2559ee1bf6113e6866ff7c75880801201a740292fe6ba3109fe9a7806f1074bdd6b2a6093bacb27c83bd24dff8979e45cb2d137f82e7a3de3ce6c9d6
+  metadata.gz: e3700fb8eb942640cd698985ecf00190ad447b89dfeed35df3125924e577de0be0f6b56695a1f0e2adfc078b2cdc7655bbdf08c22f40624eb305d4d539da2fd5
+  data.tar.gz: 7626b936453007c332c1cc1f191e449ce3c68f9447281a595fceef524a0cc9bc5a5c603d2afd5553887049d380c6297d0a8e27e9256f9fc54330722cdaaf8ba5

data/README.md

@@ -0,0 +1,124 @@
+# clipsruby
+
+## Description
+
+Use the CLIPS programming language from within Ruby
+
+## API
+
+### `CLIPS.create_environment`
+### `CLIPS::Environment.new`
+
+Create a new CLIPS environment in which you may define Rules,
+assert Facts, and instantiate Objects.
+
+```ruby
+env = CLIPS.create_environment
+env2 = CLIPS::Environment.new
+```
+
+### `CLIPS::Environment.assert_string`
+### `CLIPS::Environment#assert_string`
+
+Assert a string as a Fact in the CLIPS environment.
+
+```ruby
+fact = CLIPS::Environment.assert_string(env, "(foo bar)")
+fact2 = env.assert_string("(bat baz)")
+```
+
+### `CLIPS::Environment.assert_hash`
+### `CLIPS::Environment#assert_hash`
+
+Asserts a Deftemplate fact into the CLIPS environment
+
+```ruby
+fact = CLIPS::Environment.assert_hash(env, :my_deftemplate, a: 1, b: "asdf", c: :C)
+fact2 = env.assert_hash(:my_deftemplate, d: 4.5, e: :asdf)
+```
+
+### `CLIPS::Environment.find_all_facts`
+### `CLIPS::Environment#find_all_facts`
+
+A light wrapper around the CLIPS find-all-facts function. Accepts a fact set template and query,
+returns Facts in the environment that match as Ruby objects.
+
+```ruby
+CLIPS::Environment.find_all_facts(env, "(?f my_deftemplate)")
+env.find_all_facts("(?f my_deftemplate)")
+CLIPS::Environment.find_all_facts(env, "(?f my_deftemplate)", "(eq ?f:b \"asdf\")")
+env.find_all_facts("(?f my_deftemplate)", "(= ?f:a 1)")
+```
+
+### `CLIPS::Environment._eval`
+### `CLIPS::Environment#_eval`
+
+Evaluates a passed string in the CLIPS environment and returns the results.
+
+```ruby
+CLIPS::Environment._eval(env, "(find-all-facts ((?f my_deftemplate)) TRUE)")
+env._eval("(find-all-facts ((?f my_deftemplate)) TRUE)")
+```
+
+### `CLIPS::Environment.build`
+### `CLIPS::Environment#build`
+
+Build the constructs in the env as defined in a string
+
+```ruby
+CLIPS::Environment.build(env, "(deftemplate my_template (slot a) (slot b) (slot c))")
+env.build("(defrule do-a-thing (my_template (a ?a)) => (println \"a: \" ?a))")
+```
+
+### `CLIPS::Environment.add_udf`
+### `CLIPS::Environment#add_udf`
+
+Adds a ruby method as a User Defined Function (udf) to the CLIPS environment
+
+```ruby
+class CLIPS::Environment
+	def foo(a, b=2)
+		a + b
+	end
+	
+	def bar(word)
+		"You said #{word}!"
+	end
+end
+
+env.add_udf(:foo)
+CLIPS::Environment.add_udf(env, :bar)
+```
+
+### `CLIPS::Environment.run`
+### `CLIPS::Environment#run`
+
+Runs the rules engine, executing items on the agenda.
+Optionally may take the number of items to run from the agenda as an argument.
+
+```ruby
+CLIPS::Environment.run(env, 1)
+CLIPS::Environment.run(env)
+env.run(1)
+env.run
+```
+
+### `CLIPS::Environment.facts`
+### `CLIPS::Environment#facts`
+
+Print all Facts defined in the CLIPS environment
+
+```ruby
+CLIPS::Environment.facts(env)
+env.facts
+```
+
+### `CLIPS::Environment::Fact.deftemplate_name`
+### `CLIPS::Environment::Fact#deftemplate_name`
+
+Returns the name of the Deftemplate for a fact as a symbol
+
+```ruby
+CLIPS::Environment::Fact.deftemplate_name(fact)
+fact.deftemplate_name
+```

data/ext/clipsruby/clipsruby.c

@@ -323,8 +323,10 @@ static VALUE clips_environment_static_assert_hash(VALUE self, VALUE environment,
 	return clips_environment_assert_hash(environment, deftemplate_name, hash);
 }
 
-static void CLIPSValue_to_VALUE(CLIPSValue *from, VALUE *value, Environment *env)
+static void CLIPSValue_to_VALUE(CLIPSValue *from, VALUE *value, VALUE *rbEnvironment)
 {
+	Environment *env;
+	TypedData_Get_Struct(*rbEnvironment, Environment, &Environment_type, env);
 	switch (from->header->type)
 	{
 		case VOID_TYPE:
@@ -338,7 +340,7 @@ static void CLIPSValue_to_VALUE(CLIPSValue *from, VALUE *value, Environment *env
 			for (size_t i = 0; i < from->multifieldValue->length; i++)
 			{
 				VALUE innerValue;
-				CLIPSValue_to_VALUE(&from->multifieldValue->contents[i], &innerValue, env);
+				CLIPSValue_to_VALUE(&from->multifieldValue->contents[i], &innerValue, rbEnvironment);
 				rb_ary_push(*value, innerValue);
 			}
 			break;
@@ -358,8 +360,13 @@ static void CLIPSValue_to_VALUE(CLIPSValue *from, VALUE *value, Environment *env
 		case INSTANCE_NAME_TYPE:
 			*value = rb_str_new2(from->lexemeValue->contents);
 			break;
-		case EXTERNAL_ADDRESS_TYPE:
 		case FACT_ADDRESS_TYPE:
+			*value =
+				TypedData_Wrap_Struct(rb_const_get(CLASS_OF(*rbEnvironment), rb_intern("Fact")), &Fact_type, from->factValue);
+
+			rb_iv_set(*value, "@environment", *rbEnvironment);
+			break;
+		case EXTERNAL_ADDRESS_TYPE:
 		case INSTANCE_ADDRESS_TYPE:
 		default:
 			WriteString(env,STDERR,"Unsupported data type returned from function\n");
@@ -368,8 +375,10 @@ static void CLIPSValue_to_VALUE(CLIPSValue *from, VALUE *value, Environment *env
 	}
 }
 
-static void UDFValue_to_VALUE(UDFValue *from, VALUE *value, Environment *env)
+static void UDFValue_to_VALUE(UDFValue *from, VALUE *value, VALUE *rbEnvironment)
 {
+	Environment *env;
+	TypedData_Get_Struct(*rbEnvironment, Environment, &Environment_type, env);
 	switch (from->header->type)
 	{
 		case VOID_TYPE:
@@ -383,7 +392,7 @@ static void UDFValue_to_VALUE(UDFValue *from, VALUE *value, Environment *env)
 			VALUE innerValue;
 			for (size_t i = 0; i < from->multifieldValue->length; i++)
 			{
-				CLIPSValue_to_VALUE(&from->multifieldValue->contents[i], &innerValue, env);
+				CLIPSValue_to_VALUE(&from->multifieldValue->contents[i], &innerValue, rbEnvironment);
 				rb_ary_push(*value, innerValue);
 			}
 			break;
@@ -403,8 +412,13 @@ static void UDFValue_to_VALUE(UDFValue *from, VALUE *value, Environment *env)
 		case INSTANCE_NAME_TYPE:
 			*value = rb_str_new2(from->lexemeValue->contents);
 			break;
-		case EXTERNAL_ADDRESS_TYPE:
 		case FACT_ADDRESS_TYPE:
+			*value =
+				TypedData_Wrap_Struct(rb_const_get(CLASS_OF(*rbEnvironment), rb_intern("Fact")), &Fact_type, from->factValue);
+
+			rb_iv_set(*value, "@environment", *rbEnvironment);
+			break;
+		case EXTERNAL_ADDRESS_TYPE:
 		case INSTANCE_ADDRESS_TYPE:
 		default:
 			WriteString(env,STDERR,"Unsupported data type returned from function\n");
@@ -423,11 +437,11 @@ void UDFGenericFunction(
 	VALUE *current_argv = argv;
 	UDFValue theArg;
 	VALUE method = (VALUE)(context->context);
-	VALUE theValue;
+	VALUE rbEnvironment = rb_funcall(method, rb_intern("receiver"), 0);
 	while (UDFHasNextArgument(context))
 	{
 		UDFNextArgument(context, ANY_TYPE_BITS, &theArg);
-		UDFValue_to_VALUE(&theArg, current_argv, theEnv);
+		UDFValue_to_VALUE(&theArg, current_argv, &rbEnvironment);
 		current_argv++;
 	}
 	// Call the method on the object with the provided arguments
@@ -570,7 +584,7 @@ static VALUE clips_environment_run(int argc, VALUE *argv, VALUE environment) {
 
 	TypedData_Get_Struct(environment, Environment, &Environment_type, env);
 
-	return NUM2INT(Run(env, NUM2INT(integer)));
+	return INT2NUM(Run(env, NUM2INT(integer)));
 }
 
 static VALUE clips_environment_static_run(int argc, VALUE *argv, VALUE klass) {
@@ -584,7 +598,63 @@ static VALUE clips_environment_static_run(int argc, VALUE *argv, VALUE klass) {
 
 	TypedData_Get_Struct(environment, Environment, &Environment_type, env);
 
-	return NUM2INT(Run(env, NUM2INT(integer)));
+	return INT2NUM(Run(env, NUM2INT(integer)));
+}
+
+static VALUE clips_environment_eval(VALUE self, VALUE string)
+{
+	Environment *env;
+	CLIPSValue output;
+	VALUE toReturn;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	switch(Eval(env, StringValueCStr(string), &output))
+	{
+		case EE_NO_ERROR:
+			break;
+		case EE_PROCESSING_ERROR:
+			rb_warn("`eval` failed!");
+			break;
+		case EE_PARSING_ERROR:
+			rb_warn("`eval` failed! Could not parse string correctly.");
+			break;
+	}
+
+	CLIPSValue_to_VALUE(&output, &toReturn, &self);
+
+	return toReturn;
+}
+
+static VALUE clips_environment_static_eval(VALUE self, VALUE rbEnvironment, VALUE string)
+{
+	return clips_environment_eval(rbEnvironment, string);
+}
+
+static VALUE clips_environment_find_all_facts(int argc, VALUE *argv, VALUE environment) {
+	VALUE fact_set_template, query;
+
+	rb_scan_args(argc, argv, "11", &fact_set_template, &query);
+	if (NIL_P(query)) {
+		query = rb_str_new_cstr("TRUE");
+	}
+
+	return clips_environment_eval(
+		environment,
+		rb_sprintf("(find-all-facts (%s) %s)", StringValueCStr(fact_set_template), StringValueCStr(query)));
+}
+
+static VALUE clips_environment_static_find_all_facts(int argc, VALUE *argv, VALUE klass) {
+	VALUE rbEnvironment, fact_set_template, query;
+
+	rb_scan_args(argc, argv, "21", &rbEnvironment, &fact_set_template, &query);
+	if (NIL_P(query)) {
+		query = rb_str_new_cstr("TRUE");
+	}
+
+	return clips_environment_eval(
+		rbEnvironment,
+		rb_sprintf("(find-all-facts (%s) %s)", StringValueCStr(fact_set_template), StringValueCStr(query)));
 }
 
 void Init_clipsruby(void)
@@ -606,6 +676,10 @@ void Init_clipsruby(void)
 	rb_define_method(rbEnvironment, "add_udf", clips_environment_add_udf, -1);
 	rb_define_singleton_method(rbEnvironment, "run", clips_environment_static_run, -1);
 	rb_define_method(rbEnvironment, "run", clips_environment_run, -1);
+	rb_define_singleton_method(rbEnvironment, "_eval", clips_environment_static_eval, 2);
+	rb_define_method(rbEnvironment, "_eval", clips_environment_eval, 1);
+	rb_define_singleton_method(rbEnvironment, "find_all_facts", clips_environment_static_find_all_facts, -1);
+	rb_define_method(rbEnvironment, "find_all_facts", clips_environment_find_all_facts, -1);
 
 	VALUE rbFact = rb_define_class_under(rbEnvironment, "Fact", rb_cObject);
 	rb_define_singleton_method(rbFact, "deftemplate_name", clips_environment_fact_static_deftemplate_name, 1);

metadata

@@ -1,22 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: clipsruby
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Ryan Johnston
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-03 00:00:00.000000000 Z
+date: 2024-09-05 00:00:00.000000000 Z
 dependencies: []
 description: Calling the CLIPS programming language from within Ruby
 email: mrryanjohnston@gmail.com
 executables: []
 extensions:
 - ext/clipsruby/extconf.rb
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- README.md
 - ext/clipsruby/agenda.c
 - ext/clipsruby/agenda.h
 - ext/clipsruby/analysis.c