ruler 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+  gem "mocha"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Joshua Smith
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,59 @@
+= ruler
+
+Ruler is a simple module providing a DSL that helps with defining facts and rules.  While ruler is not a prolog or a
+full-fledged production rule system, it might become one someday.
+
+== How To Use It
+
+You use it whenever you would have a long set of nested if/else blocks or other kinds of conditional logic.
+	require 'rubygems'
+        require 'ruler'
+	class TeaDrinker
+	include Ruler
+	attr_accessor :tea
+
+	def make_iced_tea
+	  puts "Making tea"
+	end
+
+	def drink_iced_tea
+	  puts "Ahhhhhhh"
+	end
+
+	def thirsty?
+	  true
+	end
+
+	def tea_check outside_temp
+   	  ruleset do
+	   fact :it_is_hot, outside_temp >= 100.0
+	   fact :iced_tea_made, true
+	   fact :no_iced_tea, notf(:iced_tea_made)
+	   fact :am_thirsty, self.thirsty?
+
+	   rule [:it_is_hot, :am_thirsty, :no_iced_tea] do
+	   	make_iced_tea
+	   end
+
+	   rule [:it_is_hot, :am_thirsty, :iced_tea_made] do
+	   	drink_iced_tea
+	   end
+          end
+	end
+	end
+
+== Contributing to ruler
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Joshua Smith. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ruler"
+  gem.homepage = "http://github.com/BlueFrogGaming/ruler"
+  gem.license = "MIT"
+  gem.summary = %Q{Ruby DSL to help with rules and facts}
+  gem.description = %Q{Longer description of your gem}
+  gem.email = "kognate@gmail.com"
+  gem.authors = ["Joshua Smith"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruler #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/example.rb

@@ -0,0 +1,44 @@
+
+require 'rubygems'
+require 'lib/ruler'
+
+class TeaDrinker
+  include Ruler
+  attr_accessor :tea
+
+  def initialize
+    @DEBUG = true
+  end
+
+  def make_iced_tea
+      puts "Making tea"
+    end
+
+  def drink_iced_tea
+      puts "Ahhhhhhh"
+    end
+
+  def thirsty?
+      true
+    end
+
+  def tea_check outside_temp
+      ruleset do
+         fact :it_is_hot  do outside_temp >= 100.0 end
+         fact :iced_tea_made, true
+         fact :no_iced_tea, notf(:iced_tea_made)
+         fact :am_thirsty, self.thirsty?
+
+         rule [:it_is_hot, :am_thirsty, :no_iced_tea] do
+        make_iced_tea
+           end
+
+         rule [:it_is_hot, :am_thirsty, :iced_tea_made] do
+        drink_iced_tea
+           end
+          end
+    end
+  end
+
+t = TeaDrinker.new
+puts t.tea_check 190.0

data/lib/ruler.rb

@@ -0,0 +1,133 @@
+# This module provides a set of methods to manage and run sets of facts and rules.
+# These rules take an array of fact names and all of the facts are true
+# the block passed to the rule is executed.  By default, only one rule can fire in a given ruleset.
+# Each ruleset can have a default_rule which is executed if no rule fires (and the ruleset only allows
+# one rule to fire)
+
+# Author::    Josh Smith (josh@bluefroggaming.com)
+# Copyright:: (c) 2011 Blue Frog Gaming, All Rights Reserved
+# License:: This file has no public license.  
+
+class BadDefaultRule < StandardError
+end
+
+module Ruler
+# This module uses thread local storage and should be threadsafe. 
+#
+# A ruleset is the method that wraps all calls to fact and rule.
+# A ruleset takes two arguments, the first is a boolean that determins if
+# more than one rule can fire.  If this value is true, that ruleset allows only one
+# rule to fire (this is the default). If this value is false,  all rules that evaluate to
+# true will fire.  rulesets can also include a default_rule, which behaves as a normal rule
+# that is always true.  The default_rule obeys the ruleset's singletary status
+# A short example:
+#
+#      result = ruleset do
+#            fact :is_true, true
+#            fact :water_is_wet, true
+#            fact :cannot_push_on_a_rope, true
+#  
+#            fact :do_not_mess_with_jim do
+#               false
+#            end
+#            fact :pi_greater_than_four do
+#               Math::PI > 4
+#             end
+#
+#           rule [:is_true, :water_is_wet, :do_not_mess_with_jim] do
+#             rand()
+#           end
+#           
+#           rule [:cannot_push_on_a_rope, :water_is_wet, :is_true] do
+#              42
+#           end
+#           
+#           default_rule do
+#              100
+#           end
+#         end
+# puts result
+
+  def ruleset singletary = true,&blk
+    Thread.current[:singletary] = singletary
+    Thread.current[:rulematched] = nil
+    Thread.current[:working_memory] = {}
+    yield
+  end
+
+# multi_ruleset is a helper function to define rulesets that allow
+# more than one rule to fire  
+  def multi_ruleset &blk
+    ruleset false,&blk
+  end
+
+# a fact takes a symbol name and either a value or a block. 
+# for example:
+#     fact :factname, true
+#     fact :otherfactname do
+#               some_computation_that_evaluates_to_true_or_false
+#     end
+# 
+# Facts may be defined anywhere in the ruleset. due to the 
+# evaluation order, facts that appear after the last rule 
+# will never be used.
+  def fact name, dval = nil, &blk
+    if dval.nil?
+      Thread.current[:working_memory][name] = yield
+    else
+      Thread.current[:working_memory][name] = dval
+    end
+  end
+
+
+# allows for a fact to be NOT another fact.  
+# for example:
+#     fact :one, 10 == 10
+#     fact :notfone, not(:one)
+  def notf name
+    not(Thread.current[:working_memory][name])
+  end
+
+# a rule takes a list of fact names and a block.  Rules are evaluated in the order
+# they appear in the ruleset and are evaluated at execution time.  If all of the facts are true, then
+# that rule is fired. If the ruleset is singletary, only one rule (the first rule to be true)
+# may fire.  
+# rules may also have docstrings.  These aren't really used yet,
+# but they will be and they provide a nice alternative to commenting.
+# For example:
+#      rule [:one_fact, :two_facts], "this is the docstring" do
+#          some_method
+#      end
+# there is no check to see if fact names are valid,  and facts can be (re)defined
+#inside of rules.  Fact names are false if they are not defined.
+  def rule vlist,docstr = nil,&blk
+    dbg = lambda {|va|  puts "|=-\t#{va} = #{Thread.current[:working_memory][va]}" }
+    if @DEBUG
+      puts "---------------------------------------"
+      puts vlist.join(" & ")
+      puts "======================================="
+      vlist.each {|v| dbg.call(v) }
+      puts "---------------------------------------"
+    end
+    if Thread.current[:singletary] && Thread.current[:rulematched]
+      Thread.current[:rulematched]
+    else
+      
+      Thread.current[:rulematched] = if vlist.inject(true) {|k,v| k ? k && Thread.current[:working_memory][v] : false }
+                                       yield 
+                                     end
+    end
+  end
+
+# the default_rule is simple a rule that is always true.  This is mostly syntactic-sugar to represent
+# a rule that should fire if no others fire. You cannot have a default rule if you allow more
+# than one match.  The BadDefaultRule exception is raised.
+  def default_rule &blk
+    raise BadDefaultRule.new("Can't have a default rule when multiple matches are allowed") unless Thread.current[:singletary]
+    if Thread.current[:singletary] && !Thread.current[:rulematched]
+      yield
+    else
+      Thread.current[:rulematched]
+    end
+  end
+end

data/spec/ruler_spec.rb

@@ -0,0 +1,191 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'ruler'
+
+class Rules
+  include Ruler
+  def initialize
+    #@DEBUG = true
+  end
+  
+  def test_one
+    ruleset do
+    
+      fact :firstone, true
+      
+      rule [:firstone] do
+        true
+      end
+
+      default_rule do
+        false
+      end
+    end
+  end
+
+  def test_two
+    ruleset do
+      fact :firstone, true
+      
+      rule [:firstone] do
+        self.should_fire
+        "this should be here"
+      end
+      
+      rule [:firstone] do
+        self.should_not_fire
+        "this should not be here"
+      end
+    end
+
+  end
+
+  def test_three
+    ruleset do
+
+      fact :firstone, true
+      fact :secondone, true
+      fact :thirdone, false
+      fact :fourthone, (1 == 1)
+      fact :fifthone, (2 == 2)
+      fact :sixthone, true
+
+      rule [:firstone,:secondone,:thirdone, :fourthone, :fifthone] do
+        false
+      end
+      
+      rule [:firstone,:secondone,:sixthone, :fourthone, :fifthone] do
+        true
+      end
+    end
+  end
+
+  def test_four
+    ruleset do
+      fact :firstone do
+        true || true || false
+      end
+      fact :secondone, true
+      fact :thirdone, true
+      
+      rule [:firstone, :secondone, :thirdone] do
+        true
+      end
+    end
+  end
+
+  def test_five
+    ruleset do
+      fact :firstone, false
+
+      rule [:firstone] do
+        false
+      end
+      
+      default_rule do
+        true
+      end
+    end
+  end
+
+  def test_six
+    ruleset do
+      fact :firstone, false
+      fact :secondone, notf(:firstone)
+      
+      rule [:secondone] do
+        true
+      end
+    end
+  end
+
+  def test_seven
+    multi_ruleset do
+      fact :firstone, true
+      fact :secondone, true
+      
+      rule [:firstone] do
+        self.test_seven_multi
+        true
+      end
+
+      rule [:secondone] do
+        self.test_seven_multi
+        true
+      end
+    end
+  end
+
+  def test_eight
+    ruleset do
+      fact :firstone, true
+
+      rule [:firstone],"""
+This is the documentation for this rule.
+It can be on multiple lines if you 
+do it right. This is a ruby limitation,
+I think.
+""" do 
+        true
+      end
+    end
+  end
+
+  def test_nine
+    multi_ruleset do
+      default_rule do
+        true
+      end
+    end
+  end
+end
+
+describe Rules do
+  it "should process a simple rule" do
+    r = Rules.new
+    r.test_one.should be(true)
+  end
+
+  it "should only process the first matching rule" do
+    r = Rules.new
+    r.expects(:should_fire)
+    r.test_two.should == "this should be here"
+  end
+
+  it "should process rules with several conditions" do
+    r = Rules.new
+    r.test_three.should be(true)
+  end
+
+  it "should handle ORs" do
+    r = Rules.new
+    r.test_four.should be(true)
+  end
+
+  it "should respect the default rule" do
+    r = Rules.new
+    r.test_five.should be(true)
+  end
+
+  it "should run correctly with notf" do
+    r = Rules.new
+    r.test_six.should be(true)
+  end
+
+  it "should run multi_rulesets" do
+    r = Rules.new
+    r.expects(:test_seven_multi).twice
+    r.test_seven.should be(true)
+  end
+
+  it "should run even with docstrings" do
+    r = Rules.new
+    r.test_eight.should be(true)
+  end
+
+  it "should throw if there is a defualt rule in a multimatch" do
+    r = Rules.new
+    lambda { r.test_nine.should}.should raise_error
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'ruler'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+   config.mock_with :mocha  
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification 
+name: ruler
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Joshua Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-31 00:00:00 -05:00
+default_executable: example.rb
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  name: rspec
+  requirement: *id001
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  requirement: *id002
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  requirement: *id003
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  requirement: *id004
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: mocha
+  requirement: *id005
+  type: :development
+description: Longer description of your gem
+email: kognate@gmail.com
+executables: 
+- example.rb
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/example.rb
+- lib/ruler.rb
+- spec/ruler_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/BlueFrogGaming/ruler
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby DSL to help with rules and facts
+test_files: 
+- spec/ruler_spec.rb
+- spec/spec_helper.rb