rkneufeld-fuzzy-realty 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Neufeld
+
+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.rdoc

@@ -0,0 +1,7 @@
+= fuzzy-realty
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Ryan Neufeld. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "fuzzy-realty"
+    gem.summary = %Q{Fuzzy search for Expert Systems Real Estate site}
+    gem.email = "rkneufeld@gmail.com"
+    gem.homepage = "http://github.com/rkneufeld/fuzzy-realty"
+    gem.authors = ["Ryan Neufeld"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  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 :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fuzzy-realty #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/lib/TODO

@@ -0,0 +1,2 @@
+Listing Model needs:
+* "location" as string

data/lib/fuzzy_realty.rb

@@ -0,0 +1,39 @@
+require 'stubs.rb'
+require 'rulebase.rb'
+
+module FuzzyRealty
+  class ExpertSystem
+    def self.scores(listings, query)
+      
+      scores = []
+      
+      for listing in listings
+        score = 0
+        query.params.each do |param|
+          #calculate score modifier of parameter using indexed method
+          change = FuzzyRealty::METHODS[param.type].call(listing,param)
+          # if score is bad and parameter is required then reduce it further
+          change = (change < 0.70 and param.required) ? (change - 1) : change
+          score += change * FuzzyRealty::WEIGHTS[param.type]
+        end
+        scores << {listing => score}
+      end
+      return scores
+    end
+  end
+
+  # Have a table of ways to calculate the score modifier
+  # --> i.e. price will allow cheaper, sqft will allow bigger, etc.
+end
+
+if __FILE__ == $0
+  # Creating a library of stub models
+  a = FuzzyRealty::Listing.new({:price => 112000, :sqft => 720, :location => 'A'})
+  b = FuzzyRealty::Listing.new({:price => 142000, :sqft => 1420, :location => 'B'})
+  # The user wants price around 110k and in location A, 
+  p1 = FuzzyRealty::Parameter.new(false,:price,110000)
+  p2 = FuzzyRealty::Parameter.new(true,:location, 'A')
+
+  q = FuzzyRealty::Query.new([p1,p2])
+  puts FuzzyRealty::ExpertSystem.scores([a,b],q).inspect
+end

data/lib/rulebase.rb

@@ -0,0 +1,48 @@
+module FuzzyRealty
+  METHODS = {
+    # Price is match when desired is 90-105%  of actual. Otherwise give a
+    # reduced factor.
+    :price => 
+      lambda do |listing,param| 
+        actual,desired = param.desired,listing.price.to_f
+        if (desired*0.90..desired*1.05) === actual
+          1
+        else 
+          1 - ((desired - actual) / actual).abs
+        end
+      end,
+  
+    # Location calc. does lookup to find score for desired and actual
+    ## Currently just return 1 if exact, 0 otherwise
+    :location => 
+      lambda do |listing,param|
+        FuzzyRealty::LOCN[param.desired][listing.location]
+      end
+  }
+  
+  # Chosen weights are largely arbitrary. Expert was consulted for relative ratings, 
+  # but as the knowledge engineer I was forced to pick the crisp values. 
+  # Experimentation with larger user groups would likely show specific values to do 
+  # better 
+  WEIGHTS = {
+    :sqft => 15, 
+    :price => 10, 
+    :location => 25
+  }
+
+  # A is a high-class suburb
+  # B is a middle-class area
+  # C is an older middle-class area
+  # D is a "ghetto"
+  #   A    B      C   D
+  # A 1.0  0.75  0.2  0.0
+  # B 0.75 1.00  0.4  0.1
+  # C 0.2  0.4   1.0  0.6
+  # D 0.0  0.1   0.6  1.0  
+  LOCN = {
+    'A' => {'A' => 1.0,  'B' => 0.75, 'C' => 0.2, 'D' => 0.0}, 
+    'B' => {'A' => 0.75, 'B' => 1.0,  'C' => 0.4, 'D' => 0.1},
+    'C' => {'A' => 0.2,  'B' => 0.4,  'C' => 1.0, 'D' => 0.6},
+    'D' => {'A' => 0.0,  'B' => 0.1,  'C' => 0.6, 'D' => 1.0}
+  }
+end

data/lib/stubs.rb

@@ -0,0 +1,22 @@
+module FuzzyRealty
+  class Listing
+    attr_accessor :price, :sqft, :location
+    def initialize(values={})
+      values.each_key {|k| instance_variable_set(:"@#{k}", values[k])}
+    end
+  end
+  
+  class Query
+    attr_accessor :params
+    def initialize(params)
+      @params = params
+    end
+  end
+  
+  class Parameter
+    attr_accessor :required, :type, :desired
+    def initialize(required,type,desired)
+      @required,@type,@desired = required, type, desired
+    end
+  end
+end

data/test/fuzzy_realty_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class FuzzyRealtyTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fuzzy_realty'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: rkneufeld-fuzzy-realty
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ryan Neufeld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-18 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: rkneufeld@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/TODO
+- lib/fuzzy_realty.rb
+- lib/rulebase.rb
+- lib/stubs.rb
+- test/fuzzy_realty_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rkneufeld/fuzzy-realty
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Fuzzy search for Expert Systems Real Estate site
+test_files: 
+- test/fuzzy_realty_test.rb
+- test/test_helper.rb