clipsruby 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bca9526858c7578fb8f1347584b76bdf99c5f8f74d301554751941bd3e3dde8
-  data.tar.gz: '018e3bd14394a440793cd5006c75e2ce6fa0e2395ec2c85304bcb2a4e7757118'
+  metadata.gz: 4e97c3ac1ef91f6eace7ed6f45290fd832c3bf5cf862f0da15bf0c4efd59d3b7
+  data.tar.gz: f33b1fd96f3e2c505e47e23cea1a3244bb50f345382f44ad52f88ef409008c77
 SHA512:
-  metadata.gz: 77e80952f44f747a30e40ebdc433bf46734a5c48e172557c438ec84b94de91ba486ee7791974837442a229c401b06b56658fc33eb2dd9251c617ce3a4eadaab5
-  data.tar.gz: ad93fe9c5b7803738e449a1b373cffde734c84baef745364cfe9f866a5585e82cd757fd750263d2ca02c204f1cff002eb69e04f955ab6fa80f75c7eca197a890
+  metadata.gz: a933862a2f9d59f2efcbdeb3c67c7fb9d0f1b87467a56ed8e8a38d91954a79acbbde5a997b111161444128a891f25d272c6941bf65e688415875147748b427a3
+  data.tar.gz: 17cc9ec2838a396877c30da3201bdf4c9641d13a918555bc2e46f0ec6531983802377a079d529f063ee27ae4d9ef27e47ae734e82eecbdfcf27e6c4cf93b85d1

data/README.md

@@ -4,6 +4,17 @@
 
 Use the CLIPS programming language from within Ruby
 
+## Installation/Usage
+
+This is available as a Ruby gem:
+
+```
+gem install clipsruby
+```
+
+From there, you should be able to `require "clipsruby"` in your code
+and use the below API as described.
+
 ## API
 
 ### `CLIPS.create_environment`
@@ -17,6 +28,17 @@ env = CLIPS.create_environment
 env2 = CLIPS::Environment.new
 ```
 
+### `CLIPS::Environment.batch_star`
+### `env.batch_star`
+
+Pass the path to a file that will be "batched" into the environment,
+allowing many CLIPS commands to be entered at once.
+
+```ruby
+CLIPS::Environment.batch_star(env, "./my-batch.bat")
+env.batch_star("./my-batch.bat")
+```
+
 ### `CLIPS::Environment.assert_string`
 ### `CLIPS::Environment#assert_string`
 
@@ -103,6 +125,28 @@ env.run(1)
 env.run
 ```
 
+### `CLIPS::Environment.clear`
+### `CLIPS::Environment#clear`
+
+Removes constructs and data from the environment.
+
+```ruby
+CLIPS::Environment.clear(env)
+env.clear
+```
+
+### `CLIPS::Environment.reset`
+### `CLIPS::Environment#reset`
+
+Removes all facts and instances.
+Creates facts and instances defined in deffacts and definstances constructs.
+Resets the values of global variables in the specified environment.
+
+```ruby
+CLIPS::Environment.reset(env)
+env.reset
+```
+
 ### `CLIPS::Environment.facts`
 ### `CLIPS::Environment#facts`
 
@@ -132,3 +176,38 @@ Returns the name of the Deftemplate for a fact as a symbol
 CLIPS::Environment::Fact.deftemplate_name(fact)
 fact.deftemplate_name
 ```
+
+### `CLIPS::Environment::Fact.slot_names`
+### `CLIPS::Environment::Fact#slot_names`
+
+Returns an array representing the slot names of a fact
+
+```ruby
+CLIPS::Environment::Fact.slot_names(fact)
+fact.slot_names
+```
+
+### `CLIPS::Environment::Fact.get_slot`
+### `CLIPS::Environment::Fact#get_slot`
+
+Gets the value stored in the specified slot of a fact.
+Can either pass a string or symbol for the slot name argument.
+
+```ruby
+CLIPS::Environment::Fact.get_slot(fact, 'bar')
+fact.get_slot(:foo)
+```
+
+### `CLIPS::Environment::Fact.retract`
+### `CLIPS::Environment::Fact#retract`
+
+Retracts a fact from the environment.
+
+```ruby
+CLIPS::Environment::Fact.retract(fact)
+fact.retract
+```
+
+## Running the tests
+
+Simply do `rake compile` and then `rake test` in order to run the tests.

data/ext/clipsruby/clipsruby.c

@@ -290,6 +290,17 @@ static VALUE clips_environment_assert_hash(VALUE self, VALUE deftemplate_name, V
 	TypedData_Get_Struct(self, Environment, &Environment_type, env);
 
 	FactBuilder *fb = CreateFactBuilder(env, cdeftemplate_name);
+	switch (FBError(env))
+	{
+		case FBE_NO_ERROR:
+			break;
+		case FBE_DEFTEMPLATE_NOT_FOUND_ERROR:
+			rb_warn("Could not assert fact; deftemplate not found!");
+			return Qnil;
+		case FBE_IMPLIED_DEFTEMPLATE_ERROR:
+			rb_warn("Could not assert fact; cannot use assert_hash to create non-deftemplated facts!");
+			return Qnil;
+	}
 	void *args[2] = { (void *)fb, (void *)env };
 	rb_hash_foreach(hash, _clips_environment_assert_hash, (VALUE)args);
 	Fact *fact = FBAssert(fb);
@@ -673,7 +684,7 @@ static VALUE clips_environment_fact_to_h(VALUE self)
 		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);
+		rb_hash_aset(hash, ID2SYM(rb_intern(key.multifieldValue->contents[i].lexemeValue->contents)), innerValue);
 	}
 
 	return hash;
@@ -684,6 +695,140 @@ static VALUE clips_environment_fact_static_to_h(VALUE self, VALUE rbFact)
 	return clips_environment_fact_to_h(rbFact);
 }
 
+static VALUE clips_environment_batch_star(VALUE self, VALUE path)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	if (BatchStar(env, StringValueCStr(path))) {
+		return Qtrue;
+	} else {
+		return Qfalse;
+	}
+}
+
+static VALUE clips_environment_static_batch_star(VALUE self, VALUE rbEnvironment, VALUE path)
+{
+	return clips_environment_batch_star(rbEnvironment, path);
+}
+
+static VALUE clips_environment_clear(VALUE self)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	if (Clear(env)) {
+		return Qtrue;
+	} else {
+		return Qfalse;
+	}
+}
+
+static VALUE clips_environment_static_clear(VALUE self, VALUE rbEnvironment)
+{
+	return clips_environment_clear(rbEnvironment);
+}
+
+static VALUE clips_environment_reset(VALUE self)
+{
+	Environment *env;
+
+	TypedData_Get_Struct(self, Environment, &Environment_type, env);
+
+	Reset(env);
+
+	return Qnil;
+}
+
+static VALUE clips_environment_static_reset(VALUE self, VALUE rbEnvironment)
+{
+	return clips_environment_reset(rbEnvironment);
+}
+
+static VALUE clips_environment_fact_slot_names(VALUE self)
+{
+	Fact *fact;
+	CLIPSValue slot_names;
+	VALUE rbEnvironment = rb_iv_get(self, "@environment");
+
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+
+	FactSlotNames(fact, &slot_names);
+
+	VALUE array;
+
+	CLIPSValue_to_VALUE(&slot_names, &array, &rbEnvironment);
+
+	return array;
+}
+
+static VALUE clips_environment_fact_static_slot_names(VALUE self, VALUE rbFact)
+{
+	return clips_environment_fact_slot_names(rbFact);
+}
+
+static VALUE clips_environment_fact_get_slot(VALUE self, VALUE slot_name)
+{
+	Fact *fact;
+	CLIPSValue slot_value;
+	VALUE rbEnvironment = rb_iv_get(self, "@environment");
+
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+
+	switch (TYPE(slot_name)) {
+		case T_STRING:
+			GetFactSlot(fact, StringValueCStr(slot_name), &slot_value);
+			break;
+		case T_SYMBOL:
+			GetFactSlot(fact, rb_id2name(SYM2ID(slot_name)), &slot_value);
+			break;
+                default:
+			rb_warn("slot name must be string or symbol in call to get_slot!");
+			return Qnil;
+        }
+
+	VALUE out;
+
+	CLIPSValue_to_VALUE(&slot_value, &out, &rbEnvironment);
+
+	return out;
+}
+
+static VALUE clips_environment_fact_static_get_slot(VALUE self, VALUE rbFact, VALUE slot_name)
+{
+	return clips_environment_fact_get_slot(rbFact, slot_name);
+}
+
+static VALUE clips_environment_fact_retract(VALUE self)
+{
+	Fact *fact;
+
+	TypedData_Get_Struct(self, Fact, &Fact_type, fact);
+
+	switch (Retract(fact)) {
+		case RE_NO_ERROR:
+			break;
+		case RE_NULL_POINTER_ERROR:
+			rb_warn("could not retract fact; null pointer error. This could be a bug in clipsruby!");
+			return Qfalse;
+		case RE_COULD_NOT_RETRACT_ERROR:
+			rb_warn("could not retract fact! is pattern matching currently happening with this fact?");
+			return Qfalse;
+		case RE_RULE_NETWORK_ERROR:
+			rb_warn("could not retract fact! An error occurs while the retraction was being processed in the rule network");
+			return Qfalse;
+        }
+
+	return Qtrue;
+}
+
+static VALUE clips_environment_fact_static_retract(VALUE self, VALUE rbFact)
+{
+	return clips_environment_fact_retract(rbFact);
+}
+
 void Init_clipsruby(void)
 {
 	VALUE rbCLIPS = rb_define_module("CLIPS");
@@ -707,12 +852,24 @@ void Init_clipsruby(void)
 	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);
+	rb_define_singleton_method(rbEnvironment, "batch_star", clips_environment_static_batch_star, 2);
+	rb_define_method(rbEnvironment, "batch_star", clips_environment_batch_star, 1);
+	rb_define_singleton_method(rbEnvironment, "clear", clips_environment_static_clear, 1);
+	rb_define_method(rbEnvironment, "clear", clips_environment_clear, 0);
+	rb_define_singleton_method(rbEnvironment, "reset", clips_environment_static_reset, 1);
+	rb_define_method(rbEnvironment, "reset", clips_environment_reset, 0);
 
 	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);
+	rb_define_singleton_method(rbFact, "slot_names", clips_environment_fact_static_slot_names, 1);
+	rb_define_method(rbFact, "slot_names", clips_environment_fact_slot_names, 0);
+	rb_define_singleton_method(rbFact, "get_slot", clips_environment_fact_static_get_slot, 2);
+	rb_define_method(rbFact, "get_slot", clips_environment_fact_get_slot, 1);
+	rb_define_singleton_method(rbFact, "retract", clips_environment_fact_static_retract, 1);
+	rb_define_method(rbFact, "retract", clips_environment_fact_retract, 0);
 
 	VALUE rbInstance = rb_define_class_under(rbEnvironment, "Instance", rb_cObject);
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clipsruby
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Ryan Johnston
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-05 00:00:00.000000000 Z
+date: 2024-09-06 00:00:00.000000000 Z
 dependencies: []
 description: Calling the CLIPS programming language from within Ruby
 email: mrryanjohnston@gmail.com