rkneufeld-fuzzy-realty 0.3.1 → 0.4.0

data/VERSION.yml

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

data/lib/TODO

@@ -1,2 +1,29 @@
-Listing Model needs:
-* "location" as string
+Stef, this is what I have:
+
+require fuzzy_realty then issue a query like so:
+query = FuzzyRealty::Query.new
+query << FuzzyRealty::Parameter(:"symbol type", value)
+...
+FuzzyRealty::ExpertSystem.scores(listings_array,query)
+
+you will receive an array of hashes arranged like so:
+[ {:listing => #<...>, :score => ###}, ...]
+
+
+Parameters
+==========
+Parameters are init'd with a symbol type and value
+| Type      | Valid Values                                                   |
+| :sqft     | Any Numeric                                                    |
+| :style    | One of %W{Bungalow Bi-level Split-level Two-story Condominium} |
+| :location | One of %W{A B C D}                                             |
+| :price    | Any Numeric                                                    |
+* Values for style and location are very sensitive atm, anything not in the two will likely not work or even error out (i've tried to avoid the erroring out)
+
+Listings
+========
+What i expect out of a listing is that it has the following properties that can be read from it:
+*price
+*sqft
+*location
+*style

data/lib/fuzzy_realty.rb

@@ -2,7 +2,6 @@ require 'stubs.rb'
 require 'scores_table.rb'
 require 'weights.rb'
 require 'rulebase.rb'
-require 'rulebase.rb'
 
 # If set this flag will turn on debugging printouts
 #$debug = true;
@@ -17,7 +16,7 @@ module FuzzyRealty
         score = 0
         query.params.each do |param|
           #calculate score modifier of parameter using indexed method
-          change = FuzzyRealty::METHODS[param.type].call(listing,param)
+          change = FuzzyRealty::RULES[param.type].call(listing,param.desired)
           # if score is bad and parameter is required then reduce it further
           change = (change < 0.70 and param.required) ? (change - 1) : change
           
@@ -30,9 +29,10 @@ module FuzzyRealty
   end
 end
 
+#When running the library directly calculate an example
 if __FILE__ == $0
   listings = []
-  10000.times do |i|
+  100.times do |i|
     listings << FuzzyRealty::Listing.new({
       :price => 20_000 + rand(250_000),
       :sqft => 300 + rand(2000),
@@ -40,7 +40,7 @@ if __FILE__ == $0
       :style => %W{Bungalow Bi-level Split-level Two-story Condominium}[rand(5)]
     })
   end
-  # The user wants price around 110k and in location A, 
+  
   parameters = []
   parameters << FuzzyRealty::Parameter.new(:price,250000)
   parameters << FuzzyRealty::Parameter.new(:location, 'A',true)

data/lib/rulebase.rb

@@ -1,16 +1,17 @@
 module FuzzyRealty
-  METHODS = {
+  RULES = {
     # Not yet implemented
-    :bathroom => 1,
-    :garage => 1,
-    :deck => 1,
+    #:bathrooms => ,
+    #:bedrooms => ,
+    #:garage => ,
+    #:deck => ,
     
     # Price is match when desired is 90-105%  of actual. Otherwise give a
     # reduced factor.
     :price => 
-      lambda do |listing,param| 
+      lambda do |listing,desired| 
         puts "Called price" if $debug
-        actual,desired = listing.price.to_f, param.desired
+        actual = listing.price.to_f
         result = if (desired*0.90..desired*1.05) === actual
           1.0
         else 
@@ -23,17 +24,17 @@ module FuzzyRealty
     # Location calc. does lookup to find score for desired and actual
     ## Currently just return 1 if exact, 0 otherwise
     :location => 
-      lambda do |listing,param|
+      lambda do |listing,desired|
         puts "Called location" if $debug
         # Perform a quick lookup (i.e. FuzzyRealty::LOCN[:A][:A] => 1.0)
-        puts FuzzyRealty::LOCN[param.desired.to_sym][listing.location.to_sym] if $debug
-        FuzzyRealty::LOCN[param.desired.to_sym][listing.location.to_sym]
+        puts FuzzyRealty::LOCN[desired.to_sym][listing.location.to_sym] if $debug
+        FuzzyRealty::LOCN[desired.to_sym][listing.location.to_sym]
       end,
       
     :sqft => 
-      lambda do |listing,param|
+      lambda do |listing,desired|
                 puts "Called sqft" if $debug
-        actual, desired = listing.sqft, param.desired
+        actual = listing.sqft
         result = if (actual + 50) >= desired
           1.0
         elsif (actual + 150) >= desired
@@ -49,9 +50,9 @@ module FuzzyRealty
     # Style's follow lookup table similar to Location
 
     :style => 
-      lambda do |listing,param|
+      lambda do |listing,desired|
                 puts "Called style" if $debug
-        desired = FuzzyRealty::STYLE[:Symbol][param.desired]
+        desired = FuzzyRealty::STYLE[:Symbol][desired]
         actual  = FuzzyRealty::STYLE[:Symbol][listing.style]
         puts FuzzyRealty::STYLE[desired][actual] if $debug
         FuzzyRealty::STYLE[desired][actual]

data/lib/stubs.rb

@@ -7,16 +7,37 @@ module FuzzyRealty
   end
   
   class Query
-    attr_accessor :params
-    def initialize(params)
+    attr_reader :params
+    def initialize(params=[])
       @params = params
     end
+    def << (param)
+      if !param.is_a?(Parameter)
+        raise "Attempting to add non-Parameter to Query" 
+      end
+      @params << param
+        
+    end
   end
   
   class Parameter
-    attr_accessor :required, :type, :desired, :style
+    attr_reader :type, :desired, :required
     def initialize(type,desired,required=false)
-      @required,@type,@desired = required, type, desired
+      if !Parameter.valid_types.contains(type)
+        raise "Attempting to create non-existant Parameter type" 
+      end
+      @type     = type
+      @desired  = desired
+      @required = required
+    end
+    def self.valid_types
+      FuzzyRealty::WEIGHTS.each_key.to_a
     end
   end
+end
+
+class Array
+  def contains(value)
+    self.any? {|array_value| array_value == value }
+  end
 end

data/lib/weights.rb

@@ -9,6 +9,7 @@ module FuzzyRealty
     :location => 25,
     :style => 18
   }
+  
   def self.max_score
     WEIGHTS.inject(0) {|sum,n| sum + n[1]}
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rkneufeld-fuzzy-realty
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Ryan Neufeld