rulebook 0.2.1 → 0.3.0

data/README.md

@@ -9,7 +9,7 @@ Allows you to define a set of 'rules' or dynamic methods to apply to a class.
 
 ## _Notice_
 
-The format has changed since version 0.1.1. Check out the example below:
+The format is _back_ to what it was before 0.2.2!
 
 ## Simple Example
 
@@ -20,14 +20,12 @@ The format has changed since version 0.1.1. Check out the example below:
             @name = name
         end
         
-        rules do
-            rule /say_(.+)/ do |what_to_say|
-                puts "#{@name} says '#{what_to_say.gsub(/_/, ' ')}'"
-            end
+        rule /say_(.+)/ do |what_to_say|
+            puts "#{@name} says '#{what_to_say.gsub(/_/, ' ')}'"
         end
     end
     
-    User.new('Ryan').say_hello_world # => "Ryan says 'hello world'"
+    User.new('Ryan').say_hello_world # => Ryan says 'hello world'
 
 ## How It Works
 
@@ -49,10 +47,8 @@ There is also a method called `class_rules` which does the same as rules does, o
             @title = :user
         end
         
-        rules do
-            rule /is_(admin|moderator|super_user|user)/ do |title|
-                @title = title.to_sym
-            end
+        rule /is_(admin|moderator|super_user|user)/ do |title|
+            @title = title.to_sym
         end
     end
     
@@ -77,6 +73,8 @@ You can now do things like
 
 ## Class Methods Example
 
+    require 'rulebook'
+    
     class Car
         attr :make, :model
         
@@ -84,10 +82,8 @@ You can now do things like
             @make, @model = make.capitalize, model.capitalize
         end
         
-        class_rules do
-            rule /new_([a-z]+)_(.+)/ do |make, model|
-                new(make, model)
-            end
+        class_rule /new_([a-z]+)_(.+)/ do |make, model|
+            new(make, model)
         end
     end
     
@@ -97,25 +93,40 @@ You can now do things like
         Car.new_volkswagen_beetle
     ]
     
-    my_cars.first.make # => "Honda"
-    my_cars.first.model # => "Accord"
+    p my_cars.first.make # => "Honda"
+    p my_cars.first.model # => "Accord"
 
 ### Now lets add some instance rules
 
     class Car
-        rules do
-            rule /is_(.+)\?/ do |make_or_model|
-                if @make == make_or_model || @model == make_or_model
-                    true
-                else
-                    false
-                end
-            end
+        rule /is_(.+)\?/ do |make_or_model|
+            make_or_model.capitalize!
+            @make == make_or_model || @model == make_or_model
         end
     end
+
+    p my_cars.first.is_honda? # => true
+    p my_cars.first.is_beetle? # => false
+
+## Using outside of class block
+
+Since `rule` and `class_rule` are both class methods,
+you can call them all outside of a class block:
+
+    Car.rule(...){}
+    Car.class_rule(...){}
+
+Since 0.2 you can call the class methods `rules` and `class_rules` to wrap your rules in a block:
+
+    Car.rules do
+        rule(...){}
+    end
+    
+    Car.class_rules do
+        rule(...){}
+    end
     
-    my_cars.first.is_honda? # => true
-    my_cars.first.is_beetle? # => false
+The result is exactly the same.
 
 #### There are more examples in the examples and [test][1] directories and [Rubular][2] is a great place to test your Regexp.
 

data/TODO

@@ -1,2 +1 @@
-# Support for class methods
 # Named captures in Regexp

data/VERSION

@@ -1 +1 @@
-0.2.1
+0.3.0

data/lib/rulebook.rb

@@ -3,7 +3,9 @@ class RuleBook
         attr :what_to_capture, :block
         
         def initialize(what_to_capture, &block)
-            raise(TypeError, 'what_to_capture must be of type Regexp') unless what_to_capture.is_a?(Regexp)
+            raise(TypeError, 'what_to_capture must be of type Regexp') \
+                unless what_to_capture.is_a?(Regexp)
+                
             @what_to_capture, @block = what_to_capture, block
         end
         
@@ -36,12 +38,12 @@ class RuleBook
 end
 
 class RuleBook
-    module InstanceMethods
-        def method_missing(meth, *args, &blk)
+    module IncludeMethods
+        def method_missing(meth, *args, &block)
             rulebook = self.class.const_get('INSTANCE_RULEBOOK')
             rules = rulebook.find_rules_that_match_against(meth)
             
-            unless rules.nil?
+            unless rules.nil? || rules.empty?
                 rule = rules.first
                 match = rule.match_against(meth)
                 instance_exec(*match.captures, *args, &rule.block)
@@ -51,8 +53,8 @@ class RuleBook
         end
     end
     
-    module ClassMethods
-        def method_missing(meth, *args, &blk)
+    module ExtendMethods
+        def method_missing(meth, *args, &block)
             rulebook = const_get('CLASS_NOTEBOOK')
             rules = rulebook.find_rules_that_match_against(meth)
             
@@ -68,23 +70,47 @@ class RuleBook
 end
 
 class Module
-    def rules(&blk)
+    def rule(what_to_capture, &block)
         raise(ArgumentError, 'rules must have a block') unless block_given?
-        unless const_defined?('INSTANCE_RULEBOOK')
-            const_set('INSTANCE_RULEBOOK', RuleBook.new)
-            include RuleBook::InstanceMethods
-        end
         
-        const_get('INSTANCE_RULEBOOK').instance_eval(&blk)
+        setup_rulebook('INSTANCE_RULEBOOK', :include)
+        const_get('INSTANCE_RULEBOOK').rule(what_to_capture, &block)
     end
     
-    def class_rules(&blk)
+    def class_rule(what_to_capture, &block)
+        raise(ArgumentError, 'class_rules must have a block') unless block_given?
+        
+        setup_rulebook('CLASS_NOTEBOOK', :extend)
+        const_get('CLASS_NOTEBOOK').rule(what_to_capture, &block)
+    end
+    
+    def rules(&block)
+        raise(ArgumentError, 'rules must have a block') unless block_given?
+        
+        setup_rulebook('INSTANCE_RULEBOOK', :include)
+        const_get('INSTANCE_RULEBOOK').instance_eval(&block)
+        const_get('INSTANCE_RULEBOOK')
+    end
+    
+    def class_rules(&block)
         raise(ArgumentError, 'class_rules must have a block') unless block_given?
-        unless const_defined?('CLASS_NOTEBOOK')
-            const_set('CLASS_NOTEBOOK', RuleBook.new)
-            extend RuleBook::ClassMethods
-        end
         
-        const_get('CLASS_NOTEBOOK').instance_eval(&blk)
+        setup_rulebook('CLASS_NOTEBOOK', :extend)
+        const_get('CLASS_NOTEBOOK').instance_eval(&block)
+        const_get('CLASS_NOTEBOOK')
+    end
+    
+    private
+    
+    def setup_rulebook(rulebook_constant, extend_or_include)
+        raise(ArgumentError, 'extend_or_include must be :extend or :include') \
+            unless [:extend, :include].include?(extend_or_include)
+            
+        unless const_defined?(rulebook_constant)
+            const_set(rulebook_constant, RuleBook.new)
+            
+            module_name = extend_or_include.to_s.capitalize + 'Methods'
+            send(extend_or_include, RuleBook.const_get(module_name))
+        end
     end
 end

data/rulebook.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rulebook}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Lewis"]
-  s.date = %q{2010-04-27}
+  s.date = %q{2010-04-29}
   s.description = %q{Lets you define methods with regex for dynamic methods}
   s.email = %q{c00lryguy@gmail.com}
   s.extra_rdoc_files = [
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
     "test/helper.rb",
      "test/test_chevy.rb",
      "test/test_class_methods.rb",
+     "test/test_rules.rb",
      "test/test_ryguy.rb",
      "test/test_user.rb"
   ]

data/test/helper.rb

@@ -8,5 +8,5 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rulebook'
 
 class Test::Unit::TestCase
-    
-end
+
+end

data/test/test_rules.rb

@@ -0,0 +1,90 @@
+require 'helper'
+require 'date'
+
+class TestRule < Test::Unit::TestCase
+    class User
+        attr_accessor :name, :gender, :height, :eye_color, :date_of_birth, :age
+    end
+
+
+    class User
+        def User.list
+            @@list ||= []
+        end
+        
+        def initialize
+            User.list << self
+        end
+    end
+
+    # Instance Rules
+    class User
+        rule(/is_your_name_([a-z_]+)\?/) do |name|
+            @name.capitalize == name.capitalize
+        end
+        
+        rules do
+            rule(/is_(male|female)\?/) do |gender|
+                @gender == gender.to_sym
+            end
+        end
+    end
+
+    User.rule(/was_born_([a-z]+_\d+(st|nd|rd|th)?_\d+)/) do |date_of_birth|
+        @date_of_birth = Date.parse(date_of_birth.gsub(/_/, ' '))
+        @age = (Date.today - @date_of_birth).to_i / 365
+    end
+
+    User.rules do
+        rule(/is_(\d+)\?/) do |age|
+            @age == age.to_i
+        end
+    end
+
+    # Class Rules
+    # TODO: two more
+    class User
+        class_rule(/new_(male|female)/) do |gender|
+            instance = new
+            instance.gender = gender.to_sym
+            instance
+        end
+        
+        class_rules do
+            rule(/find_(males|females)/) do |gender|
+                list.find_all { |user| user.gender == gender.to_sym }
+            end
+        end
+    end
+
+
+    context 'Ryan' do
+        setup do
+            @user = User.new_male
+            @user.name = 'Ryan'
+            @user.was_born_jan_15_1991
+        end
+        
+        should 'answer yes to all obvious questions' do
+            assert @user.is_your_name_ryan?
+            assert @user.is_male?
+            assert @user.is_19?
+        end
+        
+        should 'answer no to all silly questions' do
+            refute @user.is_your_name_mark?
+            refute @user.is_female?
+            refute @user.is_21?
+        end
+        
+        teardown do
+            @user = nil
+        end
+    end
+    
+    context 'User list' do
+        should 'should have any females' do
+            assert User.find_females.length == 0
+        end
+    end
+end

data/test/test_user.rb

@@ -1,15 +1,18 @@
 require 'helper'
 require 'date'
-
+    
 class TestUser < Test::Unit::TestCase
+
+    class User
+        attr_accessor :name, :gender, :height, :eye_color, :date_of_birth, :age
+    end
+
     class User
-        attr :gender, :height, :eye_color, :date_of_birth, :age
+        rule(/is_(male|female)/) do |gender|
+            @gender = gender.to_sym
+        end
         
         rules do
-            rule(/is_(male|female)/) do |gender|
-                @gender = gender.to_sym
-            end
-            
             rule(/is_(\d+)_foot_(\d+)(_inches)?/) do |feet, inches|
                 @height = "#{feet}-#{inches}"
             end
@@ -24,7 +27,7 @@ class TestUser < Test::Unit::TestCase
             end
         end
     end
-    
+
     context 'A User instance' do
         setup do
             @ryguy = User.new

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 1
-  version: 0.2.1
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Ryan Lewis
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-27 00:00:00 -04:00
+date: 2010-04-29 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -77,5 +77,6 @@ test_files:
 - test/helper.rb
 - test/test_chevy.rb
 - test/test_class_methods.rb
+- test/test_rules.rb
 - test/test_ryguy.rb
 - test/test_user.rb