rulebook 0.1.1 → 0.2.0

data/README.md

@@ -1,18 +1,47 @@
-# rulebook
+# rulebook (0.2.0)
 
-Allows you to define a set of 'rules' or dynamic methods to apply to a class
+Allows you to define a set of 'rules' or dynamic methods to apply to a class.
 
 ## Install
 
     > gem update --system
     > gem install rulebook
 
-## Example
+## _Notice_
+
+The format has changed since version 0.1.1. Check out the example below:
+
+## Simple Example
+
+    require 'rulebook'
+    
+    class User
+        def initialize(name)
+            @name = name
+        end
+        
+        rules do
+            rule /say_(.+)/ do |what_to_say|
+                puts "#{@name} says '#{what_to_say.gsub(/_/, ' ')}'"
+            end
+        end
+    end
+    
+    User.new('Ryan').say_hello_world # => "Ryan says 'hello world'"
+
+## How It Works
+
+When you call the `rules` method in a class, it defines the constant `INSTANCE_RULEBOOK` and sets it to a new `RuleBook` instance; but only if the constant wasn't already defined. This way, it only defines the constant the first time you call the `rules` method.
+
+When the first time `rules` is called in a class, we also include the `RuleBook::InstanceMethods` module which overrides the classes `method_missing`. So when you call an undefined method on your class's instance, we will try to match the method against the rules you've defined in `INSTANCE_RULEBOOK`.
+
+There is also a method called `class_rules` which does the same as rules does, only it defines the `CLASS_RULEBOOK` constance in the class; which is a different `RuleBook` instance. The first time `class_rules` is called, it extends the class with the `RuleBook::ClassMethods` module, which also contains a `method_missing` method.
+
+## Better Example
 
     require 'rulebook'
     
     class User
-        follows_rules
         attr :name, :title
         
         def initialize(name)
@@ -20,8 +49,10 @@ Allows you to define a set of 'rules' or dynamic methods to apply to a class
             @title = :user
         end
         
-        rule /is_(admin|moderator|super_user|user)/ do |title|
-            @title = title.to_sym
+        rules do
+            rule /is_(admin|moderator|super_user|user)/ do |title|
+                @title = title.to_sym
+            end
         end
     end
     
@@ -44,7 +75,49 @@ You can now do things like
         puts "#{user.name} is a #{user.title}"
     end
 
-There are more examples in the example directory and easy to understand tests in the tests directory
+## Class Methods Example
+
+    class Car
+        attr :make, :model
+        
+        def initialize(make, model)
+            @make, @model = make.capitalize, model.capitalize
+        end
+        
+        class_rules do
+            rule /new_([a-z]+)_(.+)/ do |make, model|
+                new(make, model)
+            end
+        end
+    end
+    
+    my_cars = [
+        Car.new_honda_accord,
+        Car.new_dodge_neon,
+        Car.new_volkswagen_beetle
+    ]
+    
+    my_cars.first.make # => "Honda"
+    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
+        end
+    end
+    
+    my_cars.first.is_honda? # => true
+    my_cars.first.is_beetle? # => false
+
+#### There are more examples in the examples and [test][1] directories and [Rubular][2] is a great place to test your Regexp.
 
 ## Note on Patches/Pull Requests
  
@@ -59,3 +132,7 @@ There are more examples in the example directory and easy to understand tests in
 ## Copyright
 
 Copyright (c) 2010 Ryan Lewis. See LICENSE for details.
+
+
+[1]: http://github.com/c00lryguy/rulebook/tree/master/test/
+[2]: http://rubular.com/

data/TODO

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

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/rulebook.rb

@@ -24,8 +24,10 @@ class RuleBook
         @rules = []
     end
     
-    def add_rule(what_to_capture, &block)
-        @rules << Rule.new(what_to_capture, &block)
+    def rule(what_to_capture, &block)
+        rule = Rule.new(what_to_capture, &block)
+        @rules << rule
+        rule
     end
     
     def find_rules_that_match_against(query)
@@ -34,40 +36,55 @@ class RuleBook
 end
 
 class RuleBook
-    # Provides the ClassMethods and InstanceMethods modules that get mixed into
-    # the class that #follows_rules is called in
-    module Mixin
-        module ClassMethods
-            def rule(what_to_capture, &block)
-                rulebook = const_get('RULEBOOK')
-                rulebook.add_rule(what_to_capture, &block)
+    module InstanceMethods
+        def method_missing(meth, *args, &blk)
+            rulebook = self.class.const_get('INSTANCE_RULEBOOK')
+            rules = rulebook.find_rules_that_match_against(meth)
+            
+            unless rules.nil?
+                raise(ArgumentError, 'rules must have a block') unless block_given?
+                rule = rules.first
+                match = rule.match_against(meth)
+                instance_exec(*match.captures, *args, &rule.block)
+            else
+                super
             end
         end
-        
-        module InstanceMethods
-            def method_missing(meth, *args, &blk)
-                rulebook = self.class.const_get('RULEBOOK')
-                rules = rulebook.find_rules_that_match_against(meth)
-                
-                unless rules.nil?
-                    rules.first.tap do |rule|
-                        match = rule.match_against(meth)
-                        instance_exec(*match.captures, *args, &rule.block)
-                    end 
-                else
-                    super
-                end
+    end
+    
+    module ClassMethods
+        def method_missing(meth, *args, &blk)
+            rulebook = const_get('CLASS_NOTEBOOK')
+            rules = rulebook.find_rules_that_match_against(meth)
+            
+            unless rules.nil?
+                raise(ArgumentError, 'rules must have a block') unless block_given?
+                rule = rules.first
+                match = rule.match_against(meth)
+                class_exec(*match.captures, *args, &rule.block)
+            else
+                super
             end
         end
     end
 end
 
 class Module
-    # Mixes in RuleBook::Mixin::ClassMethods and RuleBook::Mixin::InstanceMethods
-    # TODO: allow argument to use other RuleBook instances.. also multiple rulebooks
-    def follows_rules
-        const_set('RULEBOOK', RuleBook.new)
-        extend RuleBook::Mixin::ClassMethods
-        include RuleBook::Mixin::InstanceMethods
+    def rules(&blk)
+        unless const_defined?('INSTANCE_RULEBOOK')
+            const_set('INSTANCE_RULEBOOK', RuleBook.new)
+            include RuleBook::InstanceMethods
+        end
+        
+        const_get('INSTANCE_RULEBOOK').instance_eval(&blk)
+    end
+    
+    def class_rules(&blk)
+        unless const_defined?('CLASS_NOTEBOOK')
+            const_set('CLASS_NOTEBOOK', RuleBook.new)
+            extend RuleBook::ClassMethods
+        end
+        
+        const_get('CLASS_NOTEBOOK').instance_eval(&blk)
     end
 end

data/rulebook.gemspec

@@ -5,16 +5,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rulebook}
-  s.version = "0.1.1"
+  s.version = "0.2.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-25}
+  s.date = %q{2010-04-27}
   s.description = %q{Lets you define methods with regex for dynamic methods}
   s.email = %q{c00lryguy@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.md"
+     "README.md",
+     "TODO"
   ]
   s.files = [
     ".document",
@@ -22,11 +23,13 @@ Gem::Specification.new do |s|
      "LICENSE",
      "README.md",
      "Rakefile",
+     "TODO",
      "VERSION",
      "lib/rulebook.rb",
      "rulebook.gemspec",
      "test/helper.rb",
      "test/test_chevy.rb",
+     "test/test_class_methods.rb",
      "test/test_ryguy.rb",
      "test/test_user.rb"
   ]
@@ -38,6 +41,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/helper.rb",
      "test/test_chevy.rb",
+     "test/test_class_methods.rb",
      "test/test_ryguy.rb",
      "test/test_user.rb"
   ]

data/test/test_chevy.rb

@@ -2,15 +2,16 @@ require 'helper'
 
 class TestChevy < Test::Unit::TestCase
     class Engine
-        follows_rules
         attr :state
         
         def initialize
             @state = "off"
         end
         
-        rule(/is_(.*)/) do |state|
-            @state = state.gsub(/_/, " ")
+        rules do
+            rule(/is_(.*)/) do |state|
+                @state = state.gsub(/_/, " ")
+            end
         end
     end
 
@@ -43,8 +44,10 @@ class TestChevy < Test::Unit::TestCase
         setup do
             @chevy = Engine.new
             class << @chevy
-                rule(/is_(.*)?/) do |state|
-                    @state == state
+                rules do
+                    rule(/is_(.*)?/) do |state|
+                        @state == state
+                    end
                 end
             end
         end

data/test/test_class_methods.rb

@@ -0,0 +1,53 @@
+require 'helper'
+
+class TestClassMethods < Test::Unit::TestCase
+    class Car
+        attr :make, :model
+        
+        def initialize(make, model)
+            @make, @model = make, model
+        end
+        
+        class_rules do
+            rule(/new_([a-z]+)_(.+)/) do |make, model|
+                
+                make.capitalize!
+                model = model.split('_').inject(''){ |result, word|
+                    result << word.capitalize + ' '
+                }.strip
+                new(make, model)
+            end
+        end
+    end
+    
+    should 'be a Ford F150' do
+        @car = Car.new_ford_f150
+        assert_equal @car.make, 'Ford'
+        assert_equal @car.model, 'F150'
+    end
+
+    should 'be a Ford Mustang' do
+        @car = Car.new_ford_mustang
+        assert_equal @car.make, 'Ford'
+        assert_equal @car.model, 'Mustang'
+    end
+    
+    should 'be a Pontiac GTO' do
+        @car = Car.new_pontiac_gto
+        @car.model.upcase!
+        assert_equal @car.make, 'Pontiac'
+        assert_equal @car.model, 'GTO'
+    end
+    
+    should 'be a Toyota Camry' do
+        @car = Car.new_toyota_camry
+        assert_equal @car.make, 'Toyota'
+        assert_equal @car.model, 'Camry'
+    end
+    
+    should 'be a Hyundai Santa Fe' do
+        @car = Car.new_hyundai_santa_fe
+        assert_equal @car.make, 'Hyundai'
+        assert_equal 'Santa Fe', @car.model
+    end
+end

data/test/test_ryguy.rb

@@ -2,17 +2,18 @@ require 'helper'
 
 class TestRyguy < Test::Unit::TestCase
     class Ryguy
-        follows_rules
         attr :nouns, :adjectives
         
-        rule(/is_a_(.*)/) do |noun|
-            @nouns ||= []
-            @nouns << noun.gsub(/_/, ' ')
-        end
-        
-        rule(/is_(.*)/) do |adjective|
-            @adjectives ||= []
-            @adjectives << adjective.gsub(/_/, ' ')
+        rules do
+            rule(/is_a_(.*)/) do |noun|
+                @nouns ||= []
+                @nouns << noun.gsub(/_/, ' ')
+            end
+            
+            rule(/is_(.*)/) do |adjective|
+                @adjectives ||= []
+                @adjectives << adjective.gsub(/_/, ' ')
+            end
         end
     end
     

data/test/test_user.rb

@@ -3,24 +3,25 @@ require 'date'
 
 class TestUser < Test::Unit::TestCase
     class User
-        follows_rules
         attr :gender, :height, :eye_color, :date_of_birth, :age
         
-        rule(/is_(male|female)/) do |gender|
-            @gender = gender.to_sym
-        end
-        
-        rule(/is_(\d+)_foot_(\d+)(_inches)?/) do |feet, inches|
-            @height = "#{feet}-#{inches}"
-        end
-        
-        rule(/has_(amber|blue|brown|gray|grey|green|hazel|red)_eyes/) do |eye_color|
-            @eye_color = eye_color.to_sym
-        end
-        
-        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
+        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
+            
+            rule(/has_(amber|blue|brown|gray|grey|green|hazel|red)_eyes/) do |eye_color|
+                @eye_color = eye_color.to_sym
+            end
+            
+            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
         end
     end
     

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ryan Lewis
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-25 00:00:00 -04:00
+date: 2010-04-27 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -27,17 +27,20 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.md
+- TODO
 files: 
 - .document
 - .gitignore
 - LICENSE
 - README.md
 - Rakefile
+- TODO
 - VERSION
 - lib/rulebook.rb
 - rulebook.gemspec
 - test/helper.rb
 - test/test_chevy.rb
+- test/test_class_methods.rb
 - test/test_ryguy.rb
 - test/test_user.rb
 has_rdoc: true
@@ -73,5 +76,6 @@ summary: Allows you to define a set of 'rules' or dynamic methods to apply to a
 test_files: 
 - test/helper.rb
 - test/test_chevy.rb
+- test/test_class_methods.rb
 - test/test_ryguy.rb
 - test/test_user.rb