clips 0 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d2d574cceb27423714c8425c620c823b64e9f9ac
-  data.tar.gz: bdda1bd12c1ba6d79d4df4fe8202590b2737de8e
+SHA256:
+  metadata.gz: 3d39db49bfb6f9123fa8c21e90eb2fb6b898e24cffb22e95bbdcb3245314e9f6
+  data.tar.gz: e8ecc9cfdc1d829d4c30491c0fcadf79e924d8e03ac07bab9c56bc7fcd72b3a4
 SHA512:
-  metadata.gz: 493022213d08b3d21be2e859355e7cd22cc1c8625093187126d092030632fe306939d874e4bc9c75a4e392f32803e7b19bf559210623b36d5e8189400b49973f
-  data.tar.gz: 97cb6aa55b88e7b4e14a1bd1ae2e246bc509f9934e0b896c1d4078f8eab0f5c8dd08ec5bed67580e298b8def3bd52ac88d5ab8eb6b5a6ee9915f9f8e4bd12f86
+  metadata.gz: 2a79b726cf9b0ef5be8dbefa531b61ebebb85427827a6ffa345ff56fcce9fb67197d631d785ae0ad31b616d2650d792a6ce96556e6f57da9df1c6b33bd393bbb
+  data.tar.gz: 671637f65a5c8a854f70be32769e8aa5985b60dc6845646a9230d5d47d54d9e99c67a26a691d0fdfbfb9cd8902d315118be682f9a6d88ffda8984c1a29f1a9ea

data/.rspec

@@ -1,3 +1,4 @@
 --format documentation
 --color
---require spec_helper
+--require test_helper
+-I test

data/README.md

@@ -1,8 +1,46 @@
-# Clips
+# CLIPS for Ruby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/clips`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a reimplemtation of the [CLIPS](http://www.clipsrules.net/) engine in Ruby, as well as a DSL for working with CLIPS rules.
 
-TODO: Delete this and the text above, and describe your gem
+The inference engine portion of this implementation has been structured to resemble Ruby's standard Set class. While this doesn't mirror the syntax used by the CLIPS language, it does stay true to the underlying functionality of the engine (ie. no duplicate facts).
+
+The C implementation of CLIPS includes a command line shell, however this implementation does not. There are a million ways to make a shell-like interface in Ruby, none of which are appropriate to be included in this gem.
+
+## Usage
+
+```ruby
+require 'clips'
+
+clips = CLIPS.new
+clips.add 'rule1', CLIPS::Rule.new(:foo, :actions => :bar)
+clips.add :rule2, CLIPS::Rule.new(:bar) { puts "Rule 2!" }
+clips.add :foo
+
+clips.run	# => "Rule 2!"
+clips.facts	# => #<Set: {[:foo], [:bar]}>
+```
+
+## Facts and Rules
+
+Facts are represented by Arrays, and Rules are instances of the Rule class. The first element of a fact must always be a Symbol. Rule names can be given as Symbols or Strings, and are converted to Symbols internally.
+
+## Default Facts
+
+Named sets of default facts can be added to the engine. When `reset` is called, the default facts are asserted as facts.
+
+```ruby
+clips.default_facts['my_defaults'] = Set[[:foo], [:bar]]
+clips.facts	# => #<Set: {}>
+...
+clips.reset
+clips.facts	# => #<Set: {[:foo], [:bar]}>
+```
+
+To remove a set of default facts, use the normal Hash `delete` method.
+
+```ruby
+clips.default_facts.delete('my_defaults')
+```
 
 ## Installation
 
@@ -20,16 +58,8 @@ Or install it yourself as:
 
     $ gem install clips
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/bfoz/clips.
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `clips.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

data/Rakefile

@@ -1,6 +1,23 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:test).tap do |task|
+    # task.pattern = FileList['test/**{,/*/**}/*.rb'].exclude('test/**{,/*/**}/*helper.rb')
+    task.pattern = 'test/**{,/*/**}/*.rb'
+end
 
-task :default => :spec
+task :default => :test
+
+task :temp do
+	require 'clips'
+    clips = CLIPS.new
+    # clips.add 'rule1', CLIPS::Rule.new(:foo, :actions => :bar)
+    clips.add :foo
+
+    # rule2 = CLIPS::Rule.new(:bar) do
+    # rule2 = CLIPS::Rule.new(:foo) { puts "Rule 2!" }
+    clips.add :rule2, CLIPS::Rule.new(:foo) { puts "Rule 2!" }
+
+    puts clips.run	# => "Rule 2!"
+    p clips.facts	# => #<Set: {[:foo], [:bar]}>
+end

data/clips.gemspec

@@ -2,23 +2,24 @@ lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "clips"
-  spec.version       = '0'
-  spec.authors       = ["Brandon Fosdick"]
-  spec.email         = ["bfoz@bfoz.net"]
+    spec.name          = "clips"
+    spec.version       = '0.1'
+    spec.authors       = ["Brandon Fosdick"]
+    spec.email         = ["bfoz@bfoz.net"]
 
-  spec.summary       = %q{The CLIPS engine reimplemented in Ruby}
-  spec.description   = %q{The C Language Integrated Production System (CLIPS), but in Ruby}
-  spec.homepage      = "http://github.com/bfoz/clips-ruby"
+    spec.summary       = %q{The CLIPS engine reimplemented in Ruby}
+    spec.description   = %q{The C Language Integrated Production System (CLIPS), but in Ruby}
+    spec.homepage      = "http://github.com/bfoz/clips-ruby"
+    spec.license       = "BSD"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+    spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+        f.match(%r{^(test|spec|features)/})
+    end
+    spec.bindir        = "bin"
+    spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+    spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+    spec.add_development_dependency "bundler", "~> 1.16"
+    spec.add_development_dependency "rake", "~> 10.0"
+    spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/clips.rb

@@ -1,5 +1,121 @@
-require "clips/version"
+require 'set'
 
-module Clips
-  # Your code goes here...
+require_relative 'clips/rule'
+
+class CLIPS
+    # @return [Set]	The currently activated Facts awaiting processing
+    attr_reader :activations
+
+    # @return [Set]	The Rules waiting to be processed
+    attr_reader :agenda
+
+    # @return [Hash]	The set of facts that will be instantiated on each reset
+    attr_reader :default_facts
+
+    # @return [Set]	Just the Facts
+    attr_reader :facts
+
+    # @return [Hash]	The set of Rules and their names
+    attr_reader :rules
+
+    def initialize
+	@activations = Set.new
+	@agenda = Set.new
+	@default_facts = Hash.new
+	@facts = Set.new
+	@rules = Hash.new
+    end
+
+    # @overload add(name, rule)
+    #   Add the named {Rule}
+    #   @param [String]	name 	The name of the {Rule}
+    #   @param [Rule]	rule 	The {Rule} to add
+    #   @return [CLIPS]
+    # @overload add(*fields)
+    #   Add a fact using the given field values
+    #   @return [CLIPS]
+    def add(*fields)
+	if (2==fields.length) and fields.last&.is_a?(Rule)
+	    self.rules[fields.first.to_sym] ||= fields.last
+	else	# Assume the item to be a Fact
+	    fields[0] = fields.first.to_sym
+	    # Add the new Fact to the activations list for processing during the next call to run()
+	    self.activations.add(fields)
+	    self.facts.add(fields)
+	    fields
+	# else
+	#     raise ArgumentError.new("Invalid fact")
+	end
+	self
+    end
+
+    # Remove all Facts and return self
+    # @return [CLIPS]
+    def clear
+	self.activations.clear
+	self.agenda.clear
+	self.default_facts.clear
+	self.facts.clear
+	self.rules.clear
+	self
+    end
+
+    # Remove the given fact
+    # @return [CLIPS]
+    def delete(*fact)
+    	fact[0] = fact.first.to_sym
+	if self.facts.delete?(fact)
+	    self.activations.delete(fact)
+	end
+	self
+    end
+
+    # Delete everything but the rules, then add the default facts
+    # @return [CLIPS]	self
+    def reset
+	self.activations.clear
+	self.agenda.clear
+	self.facts.clear
+
+	self.default_facts.each do |name, fact_set|
+	    fact_set.each {|fact| self.add(*fact)}
+	end
+
+	self
+    end
+
+    # @param [Integer] limit	The maximum number of rules that will fire before the function returns. The limit is disabled if nil.
+    # @return [Integer]	The number of rules that were fired
+    def run(limit=nil)
+	self.rules.each do |name, rule|
+	    self.agenda.add(rule) if rule.patterns.empty?
+	end
+
+	rule_counter = 0
+	begin
+	    # If all of a Rule's patterns match, and any of those patterns are on the activation list, then fire the Rule
+	    self.rules.each do |name, rule|
+		activated = false
+		_all = rule.patterns.all? do |pattern|
+		    activated = true if not activated and self.activations.include?(pattern)
+		    self.facts.include?(pattern)
+		end
+		self.agenda.add(rule) if activated and _all
+	    end
+
+	    self.activations.clear	# All activations have been processed, so clear the Set
+
+	    # Fire all of the Rules on the agenda in salience-order
+	    sorted_agenda = self.agenda.sort {|a,b| b.salience <=> a.salience}
+	    self.agenda.clear
+	    sorted_agenda.each do |rule|
+		rule.run!(self)
+		rule_counter += 1
+
+		break if rule_counter == limit
+	    end
+	end until self.agenda.empty? and self.activations.empty?
+
+	rule_counter
+    end
 end

data/lib/clips/rule.rb

@@ -0,0 +1,30 @@
+class CLIPS; end
+
+class CLIPS::Rule
+    attr_reader :actions
+    attr_reader :block
+    attr_reader :patterns
+    attr_reader :salience
+
+    def initialize(*args, actions:[], patterns:[], salience:0, &block)
+	@actions = [actions].flatten(1)
+	@block = block
+	@patterns = patterns
+	@salience = salience
+
+	@patterns.push args unless args.empty?
+    end
+
+    # Assumes that the patterns have already been checked
+    # @param [CLIPS]	environment	The thing with all of the facts
+    # @param [Array]	patterns	The matching patterns that triggered this {Rule}
+    def run!(environment, *patterns)
+	if @block
+	    @block.call(*patterns)
+	else
+	    self.actions.each do |action|
+		environment.add(action)
+	    end
+	end
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clips
 version: !ruby/object:Gem::Version
-  version: '0'
+  version: '0.1'
 platform: ruby
 authors:
 - Brandon Fosdick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-05 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,8 +69,10 @@ files:
 - bin/setup
 - clips.gemspec
 - lib/clips.rb
+- lib/clips/rule.rb
 homepage: http://github.com/bfoz/clips-ruby
-licenses: []
+licenses:
+- BSD
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -88,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: The CLIPS engine reimplemented in Ruby