auser / aska Goto Github PK

= 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)
  
  Currently, the methods that are supported are: < > == => =< to check the rules against

  Aska will try to call the method name given if the method exists on the object, or it will revert to a self-created attribute (named: METHODNAME_aska, if you are curious). This way it does not overwrite any methods on accident and you have access to the data.
  
  This rewrite does not use eval on each check.
  
  If they do all match, then the rules_valid? will return true, otherwise it will return false
  
  You can check if a set of rules exist with: are_rules?(:rules)
  You can check look up the rules manually with: look_up_rules(:rules)
  
== INSTALL:

  gem install aska

== ROADMAP
* v0.0.4 - Namespace rules
* v0.0.3 - Remove eval from the evaluation of rules
* v0.0.2 - Add buckets for rules
* 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.