rulebook 0.0.2 → 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.md
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Lewis
+
+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/README.md

@@ -0,0 +1,61 @@
+# rulebook
+
+Allows you to define a set of 'rules' or dynamic methods to apply to a class
+
+## Install
+
+    > gem update --system
+    > gem install rulebook
+
+## Example
+
+    require 'rulebook'
+    
+    class User
+        follows_rules
+        attr :name, :title
+        
+        def initialize(name)
+            @name = name
+            @title = :user
+        end
+        
+        rule /is_(admin|moderator|super_user|user)/ do |title|
+            @title = title.to_sym
+        end
+    end
+    
+You can now do things like
+
+    users = [
+        User.new('Ryan'),
+        User.new('Natale'),
+        User.new('Joe'),
+        User.new('Monica'),
+        User.new('Matt'),
+        User.new('Jess')
+    ].shuffle
+    
+    users[0].is_admin
+    users[1].is_moderator
+    users[2].is_super_user
+    
+    users.each do |user|
+        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
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Ryan Lewis. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rulebook"
+    gem.summary = %Q{Allows you to define a set of 'rules' or dynamic methods to apply to a class}
+    gem.description = %Q{Lets you define methods with regex for dynamic methods}
+    gem.email = "c00lryguy@gmail.com"
+    gem.homepage = "http://github.com/c00lryguy/rulebook"
+    gem.authors = ["Ryan Lewis"]
+    # gem.add_development_dependency "riot", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = false
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rulebook #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+begin
+    require 'reek/rake/task'
+
+    Reek::Rake::Task.new do |t|
+        t.fail_on_error = true
+        t.verbose = true
+    end
+rescue LoadError
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/rulebook.rb

@@ -1,60 +1,73 @@
-module RuleBook
-    module ClassMethods
-        # make the 'rule' method private so it cannot be accessed
-        # outside of the class the follows_rules method was called in
-        private
-            def rule(match, &block)
-                raise(ArgumentError, "block not given") unless block_given?
-                raise(TypeError, "match must be of type Regexp") unless match.class == Regexp
-                
-                Rule.new(self, match, block)
-            end
+class RuleBook  
+    class Rule
+        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)
+            @what_to_capture, @block = what_to_capture, block
+        end
+        
+        def matches_against?(query)
+            !match_against(query).nil?
+        end
+        
+        def match_against(query)
+            query.to_s.match(@what_to_capture)
+        end
     end
+end
+
+class RuleBook
+    attr :rules
     
-    module InstanceMethods
-        def method_missing(meth, *args)
-            matched_rules = []
-            Rule.list_for(self.class).each do |rule|
-                match = meth.to_s.match(rule.match)
-                if match.nil?
-                    next
-                else
-                    matched_rules << rule
-                end
-            end
-            
-            if matched_rules.empty?
-                super
-            else
-                matched_rules.each do |rule|
-                    blk = rule.block
-                    match = meth.to_s.match(rule.match)
-                    instance_exec(match, &blk)
-                end
-            end
-        end
+    def initialize
+        @rules = []
     end
     
-    class Rule
-        class << self
-            # Rule.list looks better than Rule.rules
-            def list; @rules ||= {}; end
-            # Rule.for() looks better than Rule.list[]
-            def list_for(parent); list[parent]; end
+    def add_rule(what_to_capture, &block)
+        @rules << Rule.new(what_to_capture, &block)
+    end
+    
+    def find_rules_that_match_against(query)
+        @rules.find_all { |rule| !query.to_s.match(rule.what_to_capture).nil? }
+    end
+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)
+            end
         end
         
-        attr :match, :block
-        def initialize(parent, match, block)
-            @match, @block = match, block
-            Rule.list[parent] ||= []
-            Rule.list[parent] << self
+        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
         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
-        extend RuleBook::ClassMethods
-        include RuleBook::InstanceMethods
+        const_set('RULEBOOK', RuleBook.new)
+        extend RuleBook::Mixin::ClassMethods
+        include RuleBook::Mixin::InstanceMethods
     end
 end

data/rulebook.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rulebook}
+  s.version = "0.1.1"
+
+  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.description = %q{Lets you define methods with regex for dynamic methods}
+  s.email = %q{c00lryguy@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/rulebook.rb",
+     "rulebook.gemspec",
+     "test/helper.rb",
+     "test/test_chevy.rb",
+     "test/test_ryguy.rb",
+     "test/test_user.rb"
+  ]
+  s.homepage = %q{http://github.com/c00lryguy/rulebook}
+  s.rdoc_options = ["--charset=UTF-8"]
+  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.test_files = [
+    "test/helper.rb",
+     "test/test_chevy.rb",
+     "test/test_ryguy.rb",
+     "test/test_user.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
+    else
+    end
+  else
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,12 @@
+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
+    
+end

data/test/test_chevy.rb

@@ -0,0 +1,66 @@
+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(/_/, " ")
+        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
+                rule(/is_(.*)?/) do |state|
+                    @state == state
+                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

data/test/test_ryguy.rb

@@ -0,0 +1,44 @@
+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(/_/, ' ')
+        end
+    end
+    
+    context 'Ryguy' do
+        setup do
+            @ryguy = Ryguy.new
+            @ryguy.is_awesome
+            @ryguy.is_a_bear
+            @ryguy.is_superfly
+            @ryguy.is_a_programmer
+            @ryguy.is_fantastic
+            @ryguy.is_a_master_of_the_ancient_chinese_art_of_karate
+        end
+        
+        should 'be awesome, superfly, and fantastic' do
+            assert_same_elements(
+                ['awesome', 'superfly', 'fantastic'],
+                @ryguy.adjectives
+            )
+        end
+        
+        should 'be a bear, a programmer, and a master of karate' do
+            assert_same_elements(
+                ['bear', 'programmer', 'master of the ancient chinese art of karate'],
+                @ryguy.nouns
+            )
+        end
+    end
+end

data/test/test_user.rb

@@ -0,0 +1,44 @@
+require 'helper'
+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
+        end
+    end
+    
+    context 'A User instance' do
+        setup do
+            @ryguy = User.new
+            @ryguy.is_male
+            @ryguy.is_5_foot_8
+            @ryguy.has_brown_eyes
+            @ryguy.was_born_january_15th_1991
+        end
+        
+        should 'be valid' do
+            assert_equal :male, @ryguy.gender
+            assert_equal '5-8', @ryguy.height
+            assert_equal :brown, @ryguy.eye_color
+            assert_equal Date.parse('January 15th, 1991'), @ryguy.date_of_birth
+            assert_equal 19, @ryguy.age
+        end
+    end
+end

metadata

@@ -4,38 +4,49 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
-  - 2
-  version: 0.0.2
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
-- c00lryguy
+- Ryan Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-02 00:00:00 -04:00
+date: 2010-04-25 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
-description: Apply rules to classes for defining dynamic methods
-email: 
-- c00lryguy+rulebook@gmail.com
+description: Lets you define methods with regex for dynamic methods
+email: c00lryguy@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README.md
 files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
 - lib/rulebook.rb
+- rulebook.gemspec
+- test/helper.rb
+- test/test_chevy.rb
+- test/test_ryguy.rb
+- test/test_user.rb
 has_rdoc: true
-homepage: 
+homepage: http://github.com/c00lryguy/rulebook
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -58,6 +69,9 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Make your classes follow the rules
-test_files: []
-
+summary: Allows you to define a set of 'rules' or dynamic methods to apply to a class
+test_files: 
+- test/helper.rb
+- test/test_chevy.rb
+- test/test_ryguy.rb
+- test/test_user.rb