heuristics 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in heuristics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Peter Haza
+
+MIT License
+
+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,75 @@
+# Heuristics
+
+This gem allows you to define a set of conditions and test values against them.
+A typical simple example can look like this:
+
+    require 'chronic' # Excellent date lib to recognise dates
+    Heuristics.define(:field_tester) do
+    	assume_default :integer
+
+      assume(:string)	{ condition { value.instance_of? String } }
+    	assume(:hash)		{ condition { value.instance_of? Hash } }
+      assume(:date) { conditino { Chronic.parse(value) != nil } }
+    end
+
+Then you can use it like this
+
+    # Returns :string
+    Heuristics.test(:field_tester, 'abc')
+
+    # Returns :date
+    Heuristics.test(:field_tester, '23.09.1985')
+
+    # Falls back to :integer per assume_default. None of the other assumptions returned trus
+    Heuristics.test(:field_tester, [])
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'heuristics'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heuristics
+
+## Usage
+
+    # Creates a new heuristic named :field_tester
+    Heuristics.define(:field_tester) do
+    
+      # Default value to return if no assumptions match
+      assume_default :integer
+
+      # An assumption that will return :string if all conditions return true
+      assume(:string)	{ condition { value.instance_of? String } }
+
+      # Assummption with multiple conditions. Returns :hash_with_values
+      # if all conditions return true
+      assume(:hash_with_values)		do
+        condition { value.instance_of? Hash }
+        condition { value.keys.size > 0 }
+      }
+
+      # An assumption that will return :date if all conditions return true
+      assume(:date) { conditino { Chronic.parse(value) != nil } }
+    end
+    
+    
+    # Test a value against heuristic named :field_tester
+    # Returns :hash_with_values in this case
+    Heuristics.test(:field_tester, {a: 1})
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'lib/heuristics'
+  t.test_files = FileList['test/lib/heuristics/*_test.rb']
+  t.verbose = false
+end
+task :default => :test

data/heuristics.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'heuristics/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "heuristics"
+  gem.version       = Heuristics::VERSION
+  gem.authors       = ["Peter Haza"]
+  gem.email         = ["peter.haza@gmail.com"]
+  gem.description   = %q{This gem allows you to define a set of conditions and test values against them.}
+  gem.summary       = %q{This gem allows you to define a set of conditions and test values against them.}
+  gem.homepage      = ""
+	
+	gem.add_development_dependency "rake"
+	gem.add_development_dependency "chronic"
+	gem.add_dependency "docile"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+	
+end

data/lib/heuristics/builder.rb

@@ -0,0 +1,18 @@
+module Heuristics
+	class Builder
+		attr_reader :tests, :default
+		
+		def initialize
+			@tests = {}
+		end
+		
+		def assume(type, &block)
+			raise "An assumption with the name '#{type}' already exists" unless @tests[type].nil?
+			@tests[type] = Docile.dsl_eval(ConditionEvaluator.new, &block)
+		end
+		
+		def assume_default(type)
+			@default = type
+		end
+	end 
+end

data/lib/heuristics/condition_evaluator.rb

@@ -0,0 +1,20 @@
+require 'ostruct'
+
+module Heuristics
+	class ConditionEvaluator		
+		
+		def initialize
+			@conditions = []
+		end
+		
+		def condition(&block)
+			@conditions << Proc.new(&block)
+		end
+		
+		def check(value)
+			context = OpenStruct.new(value: value)
+			
+			@conditions.map{|cond| context.instance_eval(&cond) rescue false}.reject{|v| v}.length == 0
+		end
+	end
+end

data/lib/heuristics/tester.rb

@@ -0,0 +1,11 @@
+module Heuristics
+	class Tester
+		def initialize(builder)
+			@builder = builder
+		end
+		
+		def test(value)
+			@builder.tests.map{|k, e| e.check(value) ? k : nil }.reject(&:nil?).first || @builder.default
+		end
+	end
+end

data/lib/heuristics/version.rb

@@ -0,0 +1,3 @@
+module Heuristics
+  VERSION = "0.0.1"
+end

data/lib/heuristics.rb

@@ -0,0 +1,25 @@
+require 'docile'
+require 'heuristics/builder'
+require 'heuristics/condition_evaluator'
+require 'heuristics/tester'
+require 'heuristics/version'
+
+module Heuristics	
+	class << self
+		@@testers = {}
+		
+		def define(name, &block)
+			raise "A heuristic with the name '#{name}' already exists" unless @@testers[name].nil?
+			@@testers[name] = Tester.new(Docile.dsl_eval(Builder.new, &block))
+		end
+		
+		def test(name, value)
+			unless @@testers.key? name
+				raise "Heuristic named #{name} hasn't been defined."
+			else
+				@@testers[name].test(value)
+			end
+		end
+		
+	end
+end

data/test/lib/heuristics/builder_test.rb

@@ -0,0 +1,13 @@
+require_relative '../../test_helper'
+
+describe Heuristics::Builder do
+  it 'should respond to #tests' do
+		Heuristics::Builder.new.must_respond_to :tests
+  end
+	
+	it 'must allow setting a default assumption' do
+		b = Heuristics::Builder.new
+		b.assume_default :string
+		b.default.must_equal :string
+	end
+end

data/test/lib/heuristics/functional_test.rb

@@ -0,0 +1,77 @@
+require_relative '../../test_helper'
+
+describe Heuristics do
+	before do
+		# @default = Heuristics.define do
+		# 	
+		# 	assume_default :string
+		# 	
+		# 	assume :integer do
+		# 		condition { value =~ /\A\d+\Z/ }
+		# 	end
+		# 	
+		# 	assume :email do
+		# 		condition { value =~ /\A.*@.*\Z/}
+		# 	end
+		# 	
+		# 	assume :date_of_birth do
+		# 		require 'chronic'
+		# 		
+		# 		condition { Chronic.parse(value) }
+		# 	end
+		# 	
+		# 	assume :phone_number do
+		# 		condition { value.starts_with? '+353' } and
+		# 		condition { value.scan(/\d/).length > 5 }
+		# 	end
+		# end
+	end
+	
+	it 'should allow to use external libs for testing' do
+		require 'chronic'
+		Heuristics.define(:external_lib_test) { assume(:date) { condition { Chronic.parse(value) != nil } } }
+		Heuristics.test(:external_lib_test, '23.09.85').must_equal :date
+	end
+	
+	it 'should return default if no assumptions are true' do
+		Heuristics.define(:default_test) { assume_default :string; assume(:email) { condition { false } } }
+		Heuristics.test(:default_test, 1).must_equal :string
+	end
+	
+	it 'should return nil if no default is set' do
+		Heuristics.define(:default_test2) { assume(:nothing) { condition { false } } }
+		Heuristics.test(:default_test2, 1).must_be :nil?
+	end
+	
+	it 'should return the first true assumption' do
+		Heuristics.define(:assumption_test) do 
+			assume_default :integer
+			assume(:string)	{ condition { value.instance_of? String } }
+			assume(:hash)		{ condition { value.instance_of? String } }
+		end
+		Heuristics.test(:assumption_test, 'abc').must_equal :string
+	end
+	
+	it 'should support complex types' do
+		Heuristics.define(:complex_test) { assume_default :integer; assume(:test) { condition { value[:hepp] } } }
+		Heuristics.test(:complex_test, []).must_equal :integer
+	end
+	
+	it 'should raise an exception if trying to create a heuristic with a name that already exists ' do
+		proc {
+			Heuristics.define(:duplicate_heuristic_test) { assume_default :integer }
+			Heuristics.define(:duplicate_heuristic_test) { assume_default :integer }
+			}.must_raise RuntimeError
+	end
+	
+	it 'should raise an exception if trying to create an assumption with a name that already exists' do
+		proc { 
+			Heuristics.define(:duplicate_assumption_test) do 
+				assume_default :integer
+				assume(:test) { condition { true } }
+				assume(:test) { condition { true } }
+			end
+		}.must_raise RuntimeError
+	end
+	
+end

data/test/lib/heuristics/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../../test_helper'
+
+describe Heuristics do
+  it "must be defined" do
+    Heuristics::VERSION.wont_be_nil
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/heuristics', __FILE__)

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: heuristics
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Haza
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: rake
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: chronic
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: docile
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: This gem allows you to define a set of conditions and test values against
+  them.
+email:
+- peter.haza@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- heuristics.gemspec
+- lib/heuristics.rb
+- lib/heuristics/builder.rb
+- lib/heuristics/condition_evaluator.rb
+- lib/heuristics/tester.rb
+- lib/heuristics/version.rb
+- test/lib/heuristics/builder_test.rb
+- test/lib/heuristics/functional_test.rb
+- test/lib/heuristics/version_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: This gem allows you to define a set of conditions and test values against
+  them.
+test_files:
+- test/lib/heuristics/builder_test.rb
+- test/lib/heuristics/functional_test.rb
+- test/lib/heuristics/version_test.rb
+- test/test_helper.rb
+has_rdoc: