auser-aska 0.0.2

data/CHANGELOG

@@ -0,0 +1,2 @@
+v0.0.2 Added buckets of rules
+v0.0.1 First write

data/README

@@ -0,0 +1,60 @@
+= AskA
+  Ari Lerner
+  CitrusByte
+  http://blog.citrusbyte.com
+
+== DESCRIPTION:
+  
+  * Super basic rule-based parser to match given rules
+
+== Basics
+  
+  In your class, add your rule definitions
+  
+  class Car
+    include Aska
+    attr_accessor :x, :y
+    rules :names, <<-EOR
+        x > 0
+        x > y
+        y > 0
+      EOR
+  end
+  
+  Then you can see if the rules are matched with the call
+  
+  @car.rules_valid?(:names)
+  
+  If they do all match, then the rules_valid? will return true, otherwise it will return false
+  
+== INSTALL:
+
+  gem install aska
+
+== ROADMAP
+* v0.0.1 - First release
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Ari Lerner. CitrusByte
+
+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/Rakefile

@@ -0,0 +1,69 @@
+begin
+  require 'echoe'
+  Echoe.new("aska") do |p|
+    p.author = "Ari Lerner"
+    p.email = "ari.lerner@citrusbyte.com"
+    p.summary = "The basics of an expert system"
+    p.url = "http://blog.citrusbyte.com"
+    p.dependencies = []
+    p.install_message =<<-EOM
+
+      Aska - Expert system basics
+      *** Ari Lerner @ <ari.lerner@citrusbyte.com> ***
+
+    EOM
+    p.include_rakefile = true
+  end  
+rescue Exception => e
+  
+end
+
+namespace(:pkg) do
+  ## Rake task to create/update a .manifest file in your project, as well as update *.gemspec
+  desc %{Update ".manifest" with the latest list of project filenames. Respect\
+  .gitignore by excluding everything that git ignores. Update `files` and\
+  `test_files` arrays in "*.gemspec" file if it's present.}
+  task :manifest do
+    list = Dir['**/*'].sort
+    spec_file = Dir['*.gemspec'].first
+    list -= [spec_file] if spec_file
+
+    File.read('.gitignore').each_line do |glob|
+      glob = glob.chomp.sub(/^\//, '')
+      list -= Dir[glob]
+      list -= Dir["#{glob}/**/*"] if File.directory?(glob) and !File.symlink?(glob)
+      puts "excluding #{glob}"
+    end
+
+    if spec_file
+      spec = File.read spec_file
+      spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+        assignment = $1
+        bunch = $2 ? list.grep(/^test\//) : list
+        '%s%%w(%s)' % [assignment, bunch.join(' ')]
+      end
+
+      File.open(spec_file,   'w') {|f| f << spec }
+    end
+    File.open('Manifest', 'w') {|f| f << list.join("\n") }
+  end
+  desc "Build gemspec for github"
+  task :gemspec => :manifest do
+    require "yaml"
+    `rake manifest gem`
+    data = YAML.load(open("aska.gemspec").read).to_ruby
+    File.open("aska.gemspec", "w+") {|f| f << data }
+  end
+  desc "Update gemspec with the time"
+  task :gemspec_update => :gemspec do
+  end
+  desc "Get ready to release the gem"
+  task :prerelease => :gemspec_update do
+    `git add .`
+    `git ci -a -m "Updated gemspec for github"`
+  end
+  desc "Release them gem to the gem server"
+  task :release => :prerelease do
+    `git push origin master`
+  end
+end

data/aska.gemspec

@@ -0,0 +1,38 @@
+Gem::Specification.new do |s|
+  s.name = %q{aska}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new("= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ari Lerner"]
+  s.cert_chain = nil
+  s.date = %q{2008-07-01}
+  s.description = %q{The basics of an expert system}
+  s.email = %q{ari.lerner@citrusbyte.com}
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README", "lib", "lib/aska", "lib/aska.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "README", "Rakefile", "lib", "lib/aska", "lib/aska.rb", "pkg", "spec", "spec/rules_spec.rb", "spec/spec_helper.rb", "aska.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://blog.citrusbyte.com}
+  s.post_install_message = %q{
+Aska - Expert system basics
+*** Ari Lerner @ <ari.lerner@citrusbyte.com> ***
+
+}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Aska", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{aska}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{The basics of an expert system}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/lib/aska.rb

@@ -0,0 +1,83 @@
+$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+
+Dir["aska/**"].each {|a| require a }
+
+module Aska
+  module ClassMethods
+    def rules(name=:rules, str="")
+      r = look_up_rules(name)
+      str.each_line do |line|
+        k = line[/(.+)[=\\\<\>](.*)/, 1].gsub(/\s+/, '')
+        v = line[/(.+)[=\\<>](.*)/, 2].gsub(/\s+/, '')
+        m = line[/[=\\<>]/, 0].gsub(/\s+/, '')
+        
+        create_instance_variable(k)
+        r << {k => [m, v]}
+      end
+    end
+    def create_instance_variable(name)
+      return unless name
+      attr_accessors << name.to_sym
+      eval "attr_accessor :#{name}"
+    end
+    def look_up_rules(name)
+      defined_rules["#{name}"] ||= []
+    end
+    def attr_accessors
+      @attr_accessors ||= []
+    end
+    def defined_rules
+      @defined_rules ||= {}
+    end
+  end
+  
+  module InstanceMethods
+    def rules
+      @rules ||= self.class.defined_rules
+    end
+    def valid_rules?(name=:rules)
+      arr = self.class.look_up_rules(name).collect do |rule|
+        valid_rule?(rule)
+      end
+      arr.reject {|a| a == true }.empty?
+    end
+    def valid_rule?(rule)
+      return false unless rule # Can't apply a rule that is nil, can we?
+      rule.each do |key,value|
+        begin
+          # puts "testing if #{key} (#{self.send(key)}) is #{value[0]} #{get_var(value[1])} [#{value[1]}]"
+          return self.send(key).send(value[0].to_sym, get_var(value[1]))
+        rescue Exception => e
+          return false
+        end
+      end
+    end
+    # Get the variable from the class
+    # If it's defined as an attr_accessor, we know it has been defined as a rule
+    # Otherwise, if we are passing it as a 
+    def get_var(name)
+      attr_accessor?(name) ? self.send(name.to_sym) : (supported_method?(name) ? name.to_sym : name.to_f)
+    end
+    def attr_accessor?(name)
+      self.class.attr_accessors.include?(name.to_sym)
+    end
+    def supported_method?(meth)
+      %w(< > == => =<).include?("#{meth}")
+    end
+    def method_missing(m, *args)
+      if self.class.defined_rules.has_key?("#{m}")
+        self.class.send(:define_method, m) do
+          self.class.look_up_rules(m)
+        end
+        self.send m
+      else
+        super
+      end
+    end
+  end
+  
+  def self.included(receiver)
+    receiver.extend         ClassMethods
+    receiver.send :include, InstanceMethods
+  end
+end

data/spec/rules_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Car
+  include Aska
+  rules :names, <<-EOR
+      x > 0      
+      y > 0
+      x > y
+    EOR
+end
+describe "Rules" do
+  before(:each) do
+    @car = Car.new
+  end
+  it "should be able to define rules as an array and they should be set as the rules on the class" do
+    @car.rules.class.should == Hash
+  end
+  it "should be able to look up the rules based on the name into an array" do
+    @car.names.class.should == Array
+  end
+  describe "parsing" do
+    it "should be able to parse the x > 0 into an array" do
+      @car.names.include?({"x"=>[">","0"]}).should == true
+    end
+    it "should be able to parse y > 0 into an array" do
+      @car.names.include?({"y"=>[">","0"]}).should == true
+    end
+    it "should be able to parse x > y into the hash" do
+      @car.names.include?({"x"=>[">","y"]}).should == true
+    end
+    it "should have 3 rules" do
+      @car.names.size.should == 3
+    end
+    it "should be able to look up the names as a rule" do
+      Car.look_up_rules(:names).should == [{"x"=>[">", "0"]}, {"y"=>[">", "0"]}, {"x"=>[">", "y"]}]
+    end
+  end
+  it "should be able to get the variable associated with the instance and return it" do    
+    @car.x = 4
+    @car.get_var(:x).class.should == @car.x.class
+  end
+  it "should be able to get a number with the instance and return it as a float" do
+    @car.get_var(4).class.should == Float
+  end
+  it "should be able to get the method it's applying as a method symbol" do
+    @car.get_var(:<).class.should == Symbol
+  end
+  it "should be able to retrieve the value of the rule when checking if it's valid" do
+    @car.x = 10
+    @car.valid_rule?({:x => [:==, 10]}).should == true
+  end
+  it "should be able to apply the rules and say that they are not met when they aren't" do
+    @car.valid_rules?(:names).should == false
+  end
+  it "should be able to apply the rules and say they aren't valid when they aren't all met" do
+    @car.x = 5
+    @car.y = 10
+    @car.valid_rules?(:names).should == false
+  end
+  it "should be able to apply the rules and say they aren't valid when they aren't all met" do
+    @car.x = 5
+    @car.y = 0
+    @car.valid_rules?(:names).should == false
+  end
+  it "should be able to apply the rules and say that they are in fact valid" do
+    @car.x = 10
+    @car.y = 5    
+    @car.valid_rules?(:names).should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), *%w[.. lib aska])
+
+%w(test/spec).each do |library|
+  begin
+    require library
+  rescue
+    STDERR.puts "== Cannot run test without #{library}"
+  end
+end
+
+Dir["#{File.dirname(__FILE__)}/helpers/**"].each {|a| require a}

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: auser-aska
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Ari Lerner
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2008-07-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: The basics of an expert system
+email: ari.lerner@citrusbyte.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- LICENSE
+- README
+- lib
+- lib/aska
+- lib/aska.rb
+files: 
+- CHANGELOG
+- LICENSE
+- README
+- Rakefile
+- lib
+- lib/aska
+- lib/aska.rb
+- pkg
+- spec
+- spec/rules_spec.rb
+- spec/spec_helper.rb
+- aska.gemspec
+has_rdoc: true
+homepage: http://blog.citrusbyte.com
+post_install_message: |+
+  
+  Aska - Expert system basics
+  *** Ari Lerner @ <ari.lerner@citrusbyte.com> ***
+  
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Aska
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - "="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: aska
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: The basics of an expert system
+test_files: []
+