rools 0.1.3 → 0.1.4

data/CHANGELOG

@@ -1,9 +1,17 @@
-- 0.1.1
-	Added RuleConsequenceError
-	
+- 0.1.4
+	* Removed "examples" folder since my RDoc kung-fu cannot be denied and the examples were redundant
+	* Added Rools::open to rools.rb
+	* Added pscp.rb to create SshPublishers on Win32 with PuttySCP
+	* Added Rools::RuleSet#assert return codes, :pass and :fail
+	* Added stop and fail methods to RuleSet, Rules, and DefaultParameterProc
+	* Built Gem under Ruby 1.8.2 to fix yaml bug for RubyForge distribution
+
+- 0.1.3
+	Finished most documentation
+	Tweaked the rakefile
+		
 - 0.1.2
 	Added RAKEFILE, README, CHANGELOG
 	
-- 0.1.3
-	Finished most documentation
-	Tweaked the rakefile
+- 0.1.1
+	Added RuleConsequenceError

data/RAKEFILE

@@ -5,13 +5,12 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 require 'pscp'
 
-PACKAGE_VERSION = '0.1.3'
+PACKAGE_VERSION = '0.1.4'
 
 PACKAGE_FILES = FileList[
   'README',
   'CHANGELOG',
   'RAKEFILE',
-  'lib/rools.rb',
   'lib/**/*.rb'
 ].to_a
 
@@ -21,7 +20,7 @@ ENV['RUBYFORGE_USER'] = "ssmoot@rubyforge.org"
 ENV['RUBYFORGE_PROJECT'] = "/var/www/gforge-projects/#{PROJECT}"
 
 desc 'Release Files'
-task :default => [:rdoc, :gem]
+task :default => [:rdoc]
 
 # Generate the RDoc documentation
 rd = Rake::RDocTask.new do |rdoc|
@@ -63,5 +62,4 @@ end
 desc "Publish RDOC to RubyForge"
 task :rubyforge => [:rdoc, :gem] do
   Rake::SshDirPublisher.new(ENV['RUBYFORGE_USER'], ENV['RUBYFORGE_PROJECT'], 'doc').upload
-  Rake::SshFilePublisher.new(ENV['RUBYFORGE_USER'], ENV['RUBYFORGE_PROJECT'], 'pkg', "#{PROJECT}-#{PACKAGE_VERSION}.gem").upload  
 end

data/README

@@ -1,4 +1,5 @@
-= rools -- A pure-ruby rules engine
+:nodoc: YOU SHOULD NOT BE VIEWING THIS FILE DIRECTLY. PLEASE USE: gem_server
+= Rools -- A pure ruby rules-engine
 
 Rools is a rules engine for abstracting business logic and program-flow. It's ideally suited to processing applications where the business logic undergoes frequent modification.
 

data/lib/rools.rb

@@ -1,5 +1,15 @@
+require 'rools/errors'
+require 'rools/default_parameter_proc'
 require 'rools/rule_set'
+require 'rools/rule'
 
-# Test Documentation
+# All classes are contained in the Rools module
 module Rools
+  
+  @@rule_sets = {}
+  
+  # open aliases Rools::RuleSet.new, and caches RuleSets loaded by path
+  def self.open(path = nil, &b)
+    path.nil? ? Rools::RuleSet.new(path, &b) : (@@rule_sets[path] ||= Rools::RuleSet.new(path))
+  end
 end

data/lib/rools/default_parameter_proc.rb

@@ -47,5 +47,14 @@ module Rools
       return @working_object if @working_object && args.size == 0
     end
     
+    # Stops the current assertion. Does not indicate failure.
+    def stop(message = nil)
+      @rule.stop(message)
+    end
+    
+    # Stops the current assertion and change status to :fail
+    def fail(message = nil)
+      @rule.fail(message)
+    end
   end
 end

data/lib/rools/rule.rb

@@ -103,5 +103,15 @@ module Rools
         raise RuleConsequenceError.new(rule, e)
       end
     end
+    
+    # Stops the current assertion. Does not indicate failure.
+    def stop(message = nil)
+      @rule_set.stop(message)
+    end
+    
+    # Stops the current assertion and change status to :fail
+    def fail(message = nil)
+      @rule_set.fail(message)
+    end
   end
 end

data/lib/rools/rule_set.rb

@@ -3,6 +3,10 @@ require 'rools/rule'
 
 module Rools
   class RuleSet
+  
+    PASS = :pass
+    FAIL = :fail
+    
     # You can pass a set of Rools::Rules with a block parameter,
     # or you can pass a file-path to evaluate.
     def initialize(file = nil, &b)
@@ -52,9 +56,22 @@ module Rools
        (@dependencies[@extend_rule_name] ||= []) << Rule.new(self, name, b)
     end
     
+    # Stops the current assertion. Does not indicate failure.
+    def stop(message = nil)
+      @assert = false
+    end
+    
+    # Stops the current assertion and change status to :fail
+    def fail(message = nil)
+      @status = FAIL
+      @assert = false
+    end
+    
     # Used to create a working-set of rules for an object, and evaluate it
-    # against them.
+    # against them. Returns a status, simply PASS or FAIL
     def assert(obj)
+      @status = PASS
+      @assert = true
       
       # create a working-set of all parameter-matching, non-dependent rules
       available_rules = @rules.values.select { |rule| rule.parameters_match?(obj) }
@@ -100,13 +117,17 @@ module Rools
             
           end # available_rules.each
           
-        end while(matches)
+        end while(matches && @assert)
         
       rescue RuleConsequenceError => rce
         # RuleConsequenceErrors are allowed to break out of the current assertion,
         # then the inner error is bubbled-up to the asserting code.
         raise rce.inner_error
       end
+      
+      @assert = false
+      
+      return status
     end # def assert
     
   end # class RuleSet

metadata

@@ -1,58 +1,53 @@
-!ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.10
 specification_version: 1
 name: rools
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
-date: 2005-12-12 00:00:00 -06:00
+  version: 0.1.4
+date: 2005-12-14
 summary: A Rules Engine written in Ruby
 require_paths: 
-- lib
+  - lib
 email: ssmoot@gmail.com; bauer.mail@gmail.com
 homepage: http://substantiality.net
 rubyforge_project: rools
-description: Can be used for program-flow, ideally suited to processing applications
+description: "Can be used for program-flow, ideally suited to processing applications"
 autorequire: rools
 default_executable: 
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
+    - 
+      - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
   version: 
 platform: ruby
-signing_key: 
-cert_chain: 
 authors: 
-- Sam Smoot
-- Scott Bauer
+  - Sam Smoot
+  - Scott Bauer
 files: 
-- README
-- CHANGELOG
-- RAKEFILE
-- lib/rools.rb
-- lib/rools/default_parameter_proc.rb
-- lib/rools/errors.rb
-- lib/rools/rule.rb
-- lib/rools/rule_set.rb
+  - README
+  - CHANGELOG
+  - RAKEFILE
+  - lib/rools.rb
+  - lib/rools/default_parameter_proc.rb
+  - lib/rools/errors.rb
+  - lib/rools/rule.rb
+  - lib/rools/rule_set.rb
 test_files: []
-
 rdoc_options: 
-- --line-numbers
-- --inline-source
-- --main
-- README
+  - "--line-numbers"
+  - "--inline-source"
+  - "--main"
+  - README
 extra_rdoc_files: 
-- README
-- CHANGELOG
-- RAKEFILE
+  - README
+  - CHANGELOG
+  - RAKEFILE
 executables: []
-
 extensions: []
-
 requirements: 
-- none
-dependencies: []
-
+  - none
+dependencies: []