clipsruby 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e3ac17e072a0fec194ad7a163acefb487ed0b2d822c04ba71f28e517278fe7a
-  data.tar.gz: 76b21dc4e2c25ae2017d94c064ac33f9bd2e3ff9d6a9b9505e5bd2f298b1d837
+  metadata.gz: 8bca9526858c7578fb8f1347584b76bdf99c5f8f74d301554751941bd3e3dde8
+  data.tar.gz: '018e3bd14394a440793cd5006c75e2ce6fa0e2395ec2c85304bcb2a4e7757118'
 SHA512:
-  metadata.gz: a665cd9fd033552cad6807dea0616cf5ebb9f41e1d07f37357c57d85e3e3db50c4845792626e47d01c8c0a6a1a1454983b8f32979624bfadc0d08388d96cefc1
-  data.tar.gz: 2ac05ff02cbb504aba1eab34cfcd5f7ff4c800cd4021de5bf956edec010725af34a5dcaa531b91b633761f9198b5835316b1b3ca20d639c0860297da5b40e46e
+  metadata.gz: 77e80952f44f747a30e40ebdc433bf46734a5c48e172557c438ec84b94de91ba486ee7791974837442a229c401b06b56658fc33eb2dd9251c617ce3a4eadaab5
+  data.tar.gz: ad93fe9c5b7803738e449a1b373cffde734c84baef745364cfe9f866a5585e82cd757fd750263d2ca02c204f1cff002eb69e04f955ab6fa80f75c7eca197a890

data/README.md

@@ -0,0 +1,134 @@
+# 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.to_h`
+### `CLIPS::Environment::Fact#to_h`
+
+Returns a hash representing the fact slot names and their values
+
+```ruby
+CLIPS::Environment::Fact.to_h(fact)
+fact.to_h
+```
+
+### `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

@@ -350,7 +350,7 @@ static void CLIPSValue_to_VALUE(CLIPSValue *from, VALUE *value, VALUE *rbEnviron
 			} else if (from->lexemeValue == FalseSymbol(env)) {
 				*value = Qfalse;
 			} else {
-				*value = rb_str_new2(from->lexemeValue->contents);
+				*value = ID2SYM(rb_intern(from->lexemeValue->contents));
 			}
 			break;
 		case INTEGER_TYPE:
@@ -402,7 +402,7 @@ static void UDFValue_to_VALUE(UDFValue *from, VALUE *value, VALUE *rbEnvironment
 			} else if (from->lexemeValue == FalseSymbol(env)) {
 				*value = Qfalse;
 			} else {
-				*value = rb_str_new2(from->lexemeValue->contents);
+				*value = ID2SYM(rb_intern(from->lexemeValue->contents));
 			}
 			break;
 		case INTEGER_TYPE:
@@ -437,7 +437,6 @@ 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))
 	{
@@ -602,22 +601,6 @@ static VALUE clips_environment_static_run(int argc, VALUE *argv, VALUE klass) {
 	return INT2NUM(Run(env, NUM2INT(integer)));
 }
 
-/*
-static VALUE clips_environment_find_all_facts(VALUE self)
-{
-	Fact *fact;
-
-	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
-
-	return ID2SYM(rb_intern(DeftemplateName(FactDeftemplate(fact))));
-}
-
-static VALUE clips_environment_static_find_all_facts(VALUE self, VALUE rbFact)
-{
-	return clips_environment_fact_deftemplate_name(rbFact);
-}
-*/
-
 static VALUE clips_environment_eval(VALUE self, VALUE string)
 {
 	Environment *env;
@@ -648,6 +631,59 @@ static VALUE clips_environment_static_eval(VALUE self, VALUE rbEnvironment, VALU
 	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)));
+}
+
+static VALUE clips_environment_fact_to_h(VALUE self)
+{
+	Fact *fact;
+	CLIPSValue key, value;
+	VALUE rbEnvironment = rb_iv_get(self, "@environment");
+
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+
+	FactSlotNames(fact, &key);
+
+	VALUE hash = rb_hash_new();
+	for (size_t i = 0; i < key.multifieldValue->length; i++)
+	{
+		VALUE innerValue;
+		GetFactSlot(fact, key.multifieldValue->contents[i].lexemeValue->contents, &value);
+		CLIPSValue_to_VALUE(&value, &innerValue, &rbEnvironment);
+		rb_hash_aset(hash, rb_str_new2(key.multifieldValue->contents[i].lexemeValue->contents), innerValue);
+	}
+
+	return hash;
+}
+
+static VALUE clips_environment_fact_static_to_h(VALUE self, VALUE rbFact)
+{
+	return clips_environment_fact_to_h(rbFact);
+}
+
 void Init_clipsruby(void)
 {
 	VALUE rbCLIPS = rb_define_module("CLIPS");
@@ -667,20 +703,16 @@ 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, "find_all_facts", clips_environment_static_find_all_facts, 2);
-	rb_define_method(rbEnvironment, "find_all_facts", clips_environment_find_all_facts, 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);
 	rb_define_method(rbFact, "deftemplate_name", clips_environment_fact_deftemplate_name, 0);
-	/*
 	rb_define_singleton_method(rbFact, "to_h", clips_environment_fact_static_to_h, 1);
 	rb_define_method(rbFact, "to_h", clips_environment_fact_to_h, 0);
-	*/
 
 	VALUE rbInstance = rb_define_class_under(rbEnvironment, "Instance", rb_cObject);
 }

metadata

@@ -1,22 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: clipsruby
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Ryan Johnston
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-04 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
@@ -365,6 +367,7 @@ homepage: https://rubygems.org/gems/clipsruby
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://github.com/mrryanjohnston/clipsruby/blob/main/README.md
   source_code_uri: https://github.com/mrryanjohnston/clipsruby
 post_install_message:
 rdoc_options: []