rulebook 0.3.3 → 0.4.0

data/lib/rulebook/class_methods.rb

@@ -0,0 +1,6 @@
+class Rulebook
+  module ClassMethods
+    # Finds or creates an instrance of Rulebook
+    def rulebook; @rulebook ||= Rulebook.new; end
+  end
+end

data/lib/rulebook/core_ext/module.rb

@@ -0,0 +1,24 @@
+require 'meta_tools'
+
+#++
+# Should this be class Object?
+# Is there really a difference?
+#--
+class Module
+  # This declares that the current class has a rulebook 
+  # with rules that it wants it's instances to follow.
+  #
+  # I picked this name because the probability of someone needing the method 
+  # 'follows_the_rules!' (with a bang) is slim... hopefully.
+  #
+  # This adds the following method:
+  #   User#rulebook
+  #     Returns the RuleBook instance that contains the defined rules. 
+  def follows_the_rules!
+    extend(MetaTools)
+    include(MetaTools)
+    
+    extend(Rulebook::ClassMethods)
+    include(Rulebook::InstanceMethods)
+  end
+end

data/lib/rulebook/instance_methods.rb

@@ -0,0 +1,41 @@
+class Rulebook
+  module InstanceMethods
+    def method_missing(meth, *args, &blk)
+      # Classes and instances find their rulebook differently.
+      begin
+        rulebook = self.class.rulebook
+      rescue NoMethodError
+        rulebook = metaclass.rulebook
+      end
+
+      rules = rulebook.rules_that_match_against(meth)
+      unless rules.nil?
+        rules.each do |rule|
+          # =S Run all matched rules or run first matched rule...?
+          # rule = rules.first
+
+          captures = rule[meth].captures || []
+          block = rule.block
+        
+          # Remove the possibility of optional arguments
+          arity = block.arity == -1 ? 0 : block.arity
+
+          # Define the method
+          meta_def(meth) do |*args|
+            instance_exec(*(captures + args).take(arity), &block)
+          end 
+
+          # klass = self.class
+          # klass.send(:define_method, meth) do |*args|
+          #   instance_exec(*(captures + args).take(arity), &block)
+          # end 
+        
+          # Call the method and return the result
+          return send(meth, *args, &block)
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/rulebook/rule.rb

@@ -0,0 +1,18 @@
+class Rulebook
+  # This class creates an instance of a Rule, which holds the
+  # Regexp to match against and the block to run when matched
+  class Rule
+    attr :block
+    
+    def initialize(what_to_capture, &block)
+      # TODO: Match more than Regexp. Strings and Symbols pls.
+      raise(TypeError, 'what_to_capture must be of type Regexp') unless what_to_capture.is_a?(Regexp)
+      raise(ArgumentError, 'a block is needed') unless block_given?
+      @what_to_capture, @block = what_to_capture, block
+    end
+    
+    def [](query); query.to_s.downcase.match(@what_to_capture); end
+    alias_method :match_against, :[]
+    def matches_against?(query); !self[query].nil?; end
+  end
+end

data/rulebook.gemspec

@@ -1,61 +1,81 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{rulebook}
-  s.version = "0.3.3"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Lewis"]
-  s.date = %q{2010-05-10}
-  s.description = %q{Lets you define methods with regex for dynamic methods}
+  s.date = %q{2011-04-30}
+  s.description = %q{Allows you to define a set of 'rules' or dynamic methods to apply to a class.}
   s.email = %q{c00lryguy@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.md",
-     "TODO"
+    "README.md"
   ]
   s.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_rules.rb",
-     "test/test_ryguy.rb",
-     "test/test_user.rb"
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "examples/simple.rb",
+    "lib/rulebook.rb",
+    "lib/rulebook/class_methods.rb",
+    "lib/rulebook/core_ext/module.rb",
+    "lib/rulebook/instance_methods.rb",
+    "lib/rulebook/rule.rb",
+    "rulebook.gemspec",
+    "test/helper.rb",
+    "test/test_chevy.rb",
+    "test/test_rule.rb"
   ]
   s.homepage = %q{http://github.com/c00lryguy/rulebook}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
-  s.summary = %q{Allows you to define a set of 'rules' or dynamic methods to apply to a class}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Define methods with regex for dynamic methods.}
   s.test_files = [
+    "examples/simple.rb",
     "test/helper.rb",
-     "test/test_chevy.rb",
-     "test/test_class_methods.rb",
-     "test/test_rules.rb",
-     "test/test_ryguy.rb",
-     "test/test_user.rb"
+    "test/test_chevy.rb",
+    "test/test_rule.rb"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<meta_tools>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<riot>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_runtime_dependency(%q<meta_tools>, ["> 0.1"])
+      s.add_development_dependency(%q<rake>, ["> 0.0.0"])
+      s.add_development_dependency(%q<riot>, ["> 0.0.0"])
     else
+      s.add_dependency(%q<meta_tools>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<riot>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<meta_tools>, ["> 0.1"])
+      s.add_dependency(%q<rake>, ["> 0.0.0"])
+      s.add_dependency(%q<riot>, ["> 0.0.0"])
     end
   else
+    s.add_dependency(%q<meta_tools>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<riot>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<meta_tools>, ["> 0.1"])
+    s.add_dependency(%q<rake>, ["> 0.0.0"])
+    s.add_dependency(%q<riot>, ["> 0.0.0"])
   end
 end
 

data/test/helper.rb

@@ -1,12 +1,14 @@
 require 'rubygems'
-require 'shoulda'
-require 'test/unit'
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
-require 'rulebook'
-
-class Test::Unit::TestCase
+require 'riot'
 
+# Stupid non-colored Windows terminal
+class Riot::IOReporter
+  def red(msg);    msg; end
+  def green(msg);  msg; end
+  def yellow(msg); msg; end
 end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rulebook'

data/test/test_chevy.rb

@@ -1,69 +1,56 @@
-require 'helper'
-
-class TestChevy < Test::Unit::TestCase
-    class Engine
-        attr_accessor :state
-        
-        def initialize
-            @state = "off"
-        end
-        
-        rules do
-            rule(/is_(.*)/) do |state|
-                @state = state.gsub(/_/, " ")
-            end
-        end
-    end
-
-    context 'A Chevy engine checked with #state_is?' do
-        setup do
-            @chevy = Engine.new
-            class << @chevy
-                def state_is?(state)
-                    @state == state
-                end
-            end
-        end
-        
-        should 'be off' do
-            assert @chevy.state_is?('off')
-        end
-        
-        should 'be idling' do
-            @chevy.is_idling
-            assert @chevy.state_is?('idling')
-        end
-        
-        should 'be broken as usual' do
-            @chevy.is_broken_as_usual
-            assert @chevy.state_is?('broken as usual')
-        end
-    end
-    
-    context 'A Chevy engine checked with custom rule' do
-        setup do
-            @chevy = Engine.new
-            class << @chevy
-                rules do
-                    rule(/is_(.*)?/) do |state|
-                        @state == state
-                    end
-                end
-            end
-        end
-        
-        should 'be off' do
-            assert @chevy.is_off?
-        end
-        
-        should 'be idling' do
-            @chevy.is_idling
-            assert @chevy.is_idling?
-        end
-        
-        should 'be broken as usual' do
-            @chevy.is_broken_as_usual
-            assert @chevy.is_broken_as_usual?
-        end
-    end
-end
+require 'helper'
+
+class Engine
+  follows_the_rules!
+  
+  attr_accessor :state
+  
+  def initialize
+    @state = :off
+  end
+
+  rulebook.add(/is_(off|idle|broken)/) do |state|
+    @state = state.to_sym
+    self
+  end
+
+  rulebook.add(/is_(off|idle|broken)\?/) do |state|
+    @state == state.to_sym
+  end
+end
+
+context "A Chevy engine" do
+  setup { Engine.new }
+
+  context "that is off" do
+    asserts_topic.assigns(:state, :off)
+    asserts(:state).equals(:off)
+  end
+
+  context "that is idle" do
+    setup { topic.is_idle }
+    asserts_topic.assigns(:state, :idle)
+    asserts(:state).equals(:idle)
+  end
+
+  context "that is broken as usual" do
+    setup { topic.is_broken }
+    asserts_topic.assigns(:state, :broken)
+  end
+
+  context "checked with custom rule" do
+    context "that is off" do
+      asserts(:is_off?)
+    end
+
+    context "that is idle" do
+      setup { topic.is_idle }
+      asserts(:is_idle?)
+    end
+
+    context "that is broken as usual" do
+      setup { topic.is_broken }
+      asserts(:is_broken?)
+    end
+  end
+end 

data/test/test_rule.rb

@@ -0,0 +1,10 @@
+require 'helper'
+
+context "A rule all on it's lonesome" do
+  setup do
+    Rulebook::Rule.new(/is_lonely/) { "='(" }
+  end
+  asserts("that this rule truly is alone") { topic.matches_against?(:is_lonely) }
+  denies("an awkward method") { topic.matches_against?(:is_surrounded_by_other_rule_friends) }
+  asserts("this works with Strings") { topic.matches_against?("is_lonely") }
+end

metadata

@@ -1,83 +1,176 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rulebook
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  segments:
+  - 0
+  - 4
   - 0
-  - 3
-  - 3
-  version: 0.3.3
+  prerelease: false
 platform: ruby
-authors: 
+authors:
 - Ryan Lewis
-autorequire: 
+autorequire: !!null 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-10 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
-description: Lets you define methods with regex for dynamic methods
+date: 2011-04-30 00:00:00.000000000 -04:00
+default_executable: !!null 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: meta_tools
+  requirement: &31472964 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+        segments:
+        - 0
+  type: :runtime
+  prerelease: false
+  version_requirements: *31472964
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &31472496 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+        segments:
+        - 0
+  type: :development
+  prerelease: false
+  version_requirements: *31472496
+- !ruby/object:Gem::Dependency
+  name: riot
+  requirement: &31472040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+        segments:
+        - 0
+  type: :development
+  prerelease: false
+  version_requirements: *31472040
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &31471572 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+        segments:
+        - 0
+  type: :development
+  prerelease: false
+  version_requirements: *31471572
+- !ruby/object:Gem::Dependency
+  name: meta_tools
+  requirement: &31471092 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0.1'
+        segments:
+        - 0
+        - 1
+  type: :runtime
+  prerelease: false
+  version_requirements: *31471092
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &31470552 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+        segments:
+        - 0
+        - 0
+        - 0
+  type: :development
+  prerelease: false
+  version_requirements: *31470552
+- !ruby/object:Gem::Dependency
+  name: riot
+  requirement: &31470000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+        segments:
+        - 0
+        - 0
+        - 0
+  type: :development
+  prerelease: false
+  version_requirements: *31470000
+description: Allows you to define a set of 'rules' or dynamic methods to apply to
+  a class.
 email: c00lryguy@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - README.md
-- TODO
-files: 
+files:
 - .document
-- .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- TODO
 - VERSION
+- examples/simple.rb
 - lib/rulebook.rb
+- lib/rulebook/class_methods.rb
+- lib/rulebook/core_ext/module.rb
+- lib/rulebook/instance_methods.rb
+- lib/rulebook/rule.rb
 - rulebook.gemspec
 - test/helper.rb
 - test/test_chevy.rb
-- test/test_class_methods.rb
-- test/test_rules.rb
-- test/test_ryguy.rb
-- test/test_user.rb
+- test/test_rule.rb
 has_rdoc: true
 homepage: http://github.com/c00lryguy/rulebook
-licenses: []
-
-post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+licenses:
+- MIT
+post_install_message: !!null 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
+      hash: 224911955
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.6
-signing_key: 
+rubyforge_project: !!null 
+rubygems_version: 1.3.7
+signing_key: !!null 
 specification_version: 3
-summary: Allows you to define a set of 'rules' or dynamic methods to apply to a class
-test_files: 
+summary: Define methods with regex for dynamic methods.
+test_files:
+- examples/simple.rb
 - test/helper.rb
 - test/test_chevy.rb
-- test/test_class_methods.rb
-- test/test_rules.rb
-- test/test_ryguy.rb
-- test/test_user.rb
+- test/test_rule.rb