Merge lp:~zeitgeist/zeitgeist/mostusedwith into lp:zeitgeist/0.1

[Seif Lotfy]

[Seif Lotfy (seif)]

This branch fixes https://bugs.edge.launchpad.net/zeitgeist/+bug/498878
Please take stabs at it

[lp:~zeitgeist/zeitgeist/mostusedwith]

1347. By Seif Lotfy on 2010-02-25

fixed test case

1348. By Seif Lotfy on 2010-02-25

removed second query

1349. By Seif Lotfy on 2010-02-25

merge and fix issues

=== modified file '_zeitgeist/engine/main.py'
--- _zeitgeist/engine/main.py	2010-02-16 19:36:42 +0000
+++ _zeitgeist/engine/main.py	2010-02-25 18:14:12 +0000
@@ -28,7 +28,7 @@
 import logging
 
 from zeitgeist.datamodel import Event as OrigEvent, StorageState, TimeRange, \
-	ResultType, get_timestamp_for_now
+	ResultType, get_timestamp_for_now, Interpretation
 from _zeitgeist.engine.datamodel import Event, Subject	
 from _zeitgeist.engine.extension import ExtensionsCollection, load_class
 from _zeitgeist.engine import constants
@@ -258,7 +258,7 @@
 		return self._find_events(1, *args)
 	
 	def find_related_uris(self, timerange, event_templates, result_event_templates,
-		result_storage_state):
+		result_storage_state, num_results, result_type):
 		"""
 		Return a list of subject URIs commonly used together with events
 		matching the given template, considering data from within the indicated
@@ -273,13 +273,14 @@
 		
 		#templates = event_templates + result_event_templates
 		
-		events = self.find_events( timerange, result_event_templates, 
+		events = self.find_events(timerange, result_event_templates, 
 											result_storage_state, 0, 1)
 		
 		subject_uris = []
 		for event in event_templates:
-			if  not event.subjects[0].uri in subject_uris:
-				subject_uris.append(event.subjects[0].uri)
+			if len(event.subjects) > 0:
+				if  not event.subjects[0].uri in subject_uris:
+					subject_uris.append(event.subjects[0].uri)
 		
 		def create_buckets(events):
 			"""
@@ -293,37 +294,41 @@
 					buckets.append({})
 				buckets[len(buckets)-1][event.subjects[0].uri] = event
 			return buckets
+		
 		buckets = create_buckets(events)
 		
 		keys_counter  = {}
-		keys_subjects = {}
-		min_support = 0
 		
 		for bucket in buckets:
 			counter = 0
 			for event in event_templates:
 				if bucket.has_key(event.subjects[0].uri):
 					counter += 1
+					break
 			if counter > 0:
 				for key in bucket.keys():
 					if not key in subject_uris:
 						if not keys_counter.has_key(key):
 							keys_counter[key] = 0
 						keys_counter[key] += 1
-						min_support += 1
-						keys_subjects[key] = bucket[key]
-		
-		
-		min_support = min_support / len(keys_counter.keys())
 		
 		sets = [[v, k] for k, v in keys_counter.iteritems()]
 		sets.sort()
-		
-		results = []
-		for r in sets:
-			if r[0] >= min_support:
-				results.append(r[1])
-		return results
+		sets.reverse()
+				
+		if result_type == 0:
+			return map(lambda result: result[1], sets[:num_results])
+		elif result_type == 1:
+			events = []
+			for r in sets:
+				event = Event()
+				subject = Subject()
+				subject.uri = r[1]
+				event.set_subjects([subject])
+				events.append(event)
+			events = self.find_events(timerange, events, result_storage_state, num_results, 2)
+			return map(lambda event: event.subjects[0].uri, events)
+		raise NotImplementedError, "Unsupported ResultType."
 	
 	def insert_events(self, events, sender=None):
 		t = time.time()
 
=== modified file '_zeitgeist/engine/remote.py'
--- _zeitgeist/engine/remote.py	2010-01-27 15:08:51 +0000
+++ _zeitgeist/engine/remote.py	2010-02-25 18:14:12 +0000
@@ -4,6 +4,7 @@
 #
 # Copyright © 2009-2010 Siegfried-Angel Gevatter Pujals <[e-mail]>
 # Copyright © 2009 Mikkel Kamstrup Erlandsen <[e-mail]>
+# Copyright © 2010 Seif Lotfy <[e-mail]>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published by
@@ -86,10 +87,10 @@
 		    sender=sender))
 	
 	@dbus.service.method(constants.DBUS_INTERFACE,
-						in_signature="(xx)a("+constants.SIG_EVENT+")a("+constants.SIG_EVENT+")u",
+						in_signature="(xx)a("+constants.SIG_EVENT+")a("+constants.SIG_EVENT+")uuu",
 						out_signature="as")
 	def FindRelatedUris(self, time_range, event_templates,
-		result_event_templates, storage_state):
+		result_event_templates, storage_state, num_events, result_type):
 		"""Warning: This API is EXPERIMENTAL and is not fully supported yet.
 		
 		Get a list of URIs of subjects which frequently occur together
@@ -122,11 +123,16 @@
 		   available. The list of possible values is enumerated in the
 		   :class:`StorageState <zeitgeist.datamodel.StorageState>` class
 		:type storage_state: unsigned 32 bit integer, DBus signature :const:`u`
+		:param num_events: maximal amount of returned events
+		:type num_events: unsigned integer
+		:param result_type: unsigned integer 0 for relevancy 1 for recency
+		:type order: unsigned integer
 		:returns: A list of URIs matching the described criteria
 		:rtype: An array of strings, DBus signature :const:`as`.
 		"""
+		event_templates = map(Event, event_templates)
 		return _engine.find_related_uris(time_range, event_templates,
-			result_event_templates, storage_state)
+			result_event_templates, storage_state, num_events, result_type)
 	
 	@dbus.service.method(constants.DBUS_INTERFACE,
 						in_signature="(xx)a("+constants.SIG_EVENT+")uuu",
 
=== modified file 'test/data/apriori_events.js'
--- test/data/apriori_events.js	2010-02-07 03:44:19 +0000
+++ test/data/apriori_events.js	2010-02-25 18:14:12 +0000
@@ -390,4 +390,4 @@
 			}
 		]
 	}
-]
+]
 \ No newline at end of file
 
=== modified file 'test/engine-test.py'
--- test/engine-test.py	2010-02-10 02:17:34 +0000
+++ test/engine-test.py	2010-02-25 18:14:12 +0000
@@ -490,28 +490,36 @@
 			TimeRange.always(), [], StorageState.Any, 0, ResultType.LeastRecentActor)
 		self.assertEquals([e[0][1] for e in events], ["100", "101", "105"])
 
-	def testRelatedForEvents(self):
-		import_events("test/data/apriori_events.js", self.engine)
-		result = self.engine.find_related_uris(
-			TimeRange.always(), [Event.new_for_values(subject_uri = "i2")], [],
-			StorageState.Any)
+	def testRelatedForEventsSortRelevancy(self):
+		import_events("test/data/apriori_events.js", self.engine)
+		result = self.engine.find_related_uris(
+			TimeRange.always(), [Event.new_for_values(subject_uri = "i2")], [],
+			StorageState.Any, 2, 0)
+		self.assertEquals(result, ["i1", "i3"])
+	
+	def testRelatedForEventsSortRecency(self):
+		import_events("test/data/apriori_events.js", self.engine)
+		result = self.engine.find_related_uris(
+			TimeRange.always(), [Event.new_for_values(subject_uri = "i2")], [],
+			StorageState.Any, 2, 1)
 		self.assertEquals(result, ["i3", "i1"])
 	
 	def testRelatedForMultipleEvents(self):
 		import_events("test/data/apriori_events.js", self.engine)
 		result = self.engine.find_related_uris(
 			TimeRange.always(), [Event.new_for_values(subject_uri = "i1"),
-				Event.new_for_values(subject_uri = "i4")],
-			[], StorageState.Any),
-		self.assertEquals(result, (["i3", "i2"],))
+				Event.new_for_values(subject_uri = "i4")], [],
+			StorageState.Any, 2, 0),
+		self.assertEquals(result, (["i2", "i3"],))
 	
 	def testRelatedForEventsWithManifestation(self):
 		import_events("test/data/apriori_events.js", self.engine)
 		result = self.engine.find_related_uris(TimeRange.always(),
 			[Event.new_for_values(subject_uri = "i4")],
 			[Event.new_for_values(subject_manifestation="stfu:File")],
-			StorageState.Any)
-		self.assertEquals(result, ["i3", "i5", "i1"])
+			StorageState.Any,
+			10, 0)
+		self.assertEquals(result, ["i1", "i5", "i3"])
 
 if __name__ == "__main__":
 	unittest.main()
 
=== modified file 'test/remote-test.py'
--- test/remote-test.py	2010-02-16 09:43:31 +0000
+++ test/remote-test.py	2010-02-25 18:14:12 +0000
@@ -224,9 +224,9 @@
 		
 		def callback(uris):
 			mainloop.quit()
-			self.assertEquals(uris, ["i3", "i2", "i1", "i5"])
+			self.assertEquals(uris, ["i2", "i1", "i5", "i3"])
 		
-		result = self.client.find_related_uris_for_uris(["i4"], callback)
+		result = self.client.find_related_uris_for_uris(["i4"], callback, num_events=4, result_type=0)
 		mainloop.run()
 		
 	def testFindEventsForValues(self):
 
=== modified file 'zeitgeist/client.py'
--- zeitgeist/client.py	2010-02-16 09:43:31 +0000
+++ zeitgeist/client.py	2010-02-25 18:14:12 +0000
@@ -670,8 +670,8 @@
 					error_handler=self._safe_error_handler(error_handler))
 	
 	def find_related_uris_for_events(self, event_templates, uris_reply_handler,
-		time_range = None, result_event_templates=[],
-		storage_state=StorageState.Any, error_handler=None):
+		error_handler=None, time_range = None, result_event_templates=[],
+		storage_state=StorageState.Any, num_events=10, result_type=0):
 		"""
 		Warning: This API is EXPERIMENTAL and is not fully supported yet.
 		
@@ -690,6 +690,10 @@
 		    as subjects of events matching these templates
 		:param storage_state: The returned URIs must have this
 		    :class:`storage state <zeitgeist.datamodel.StorageState>`
+		:param num_events: number of related uris you want to have returned
+		:param result_type: sorting of the results by 
+			0 for relevancy
+			1 for recency
 		:param error_handler: An optional callback in case of errors.
 		    Must take a single argument being the error raised by the
 		    server. The default behaviour in case of errors is to call
@@ -704,15 +708,16 @@
 			time_range = TimeRange.always()
 		
 		self._iface.FindRelatedUris(time_range, event_templates,
-			result_event_templates, storage_state,
+			result_event_templates, storage_state, num_events, result_type,
 			reply_handler=self._safe_reply_handler(uris_reply_handler),
 			error_handler=self._safe_error_handler(error_handler,
 			                                       uris_reply_handler,
-			                                       []))
+			                                       [])
+			)
 	
 	def find_related_uris_for_uris(self, subject_uris, uris_reply_handler,
 		time_range=None, result_event_templates=[],
-		storage_state=StorageState.Any, error_handler=None):
+		storage_state=StorageState.Any,  num_events=10, result_type=0, error_handler=None):
 		"""
 		Warning: This API is EXPERIMENTAL and is not fully supported yet.
 		
@@ -728,6 +733,8 @@
 		                                  time_range=time_range,
 		                                  result_event_templates=result_event_templates,
 		                                  storage_state=storage_state,
+		                                  num_events = num_events,
+		                                  result_type = result_type,
 		                                  error_handler=error_handler)
 	
 	def install_monitor (self, time_range, event_templates,
 
=== modified file 'zeitgeist/datamodel.py'
--- zeitgeist/datamodel.py	2010-01-30 13:35:22 +0000
+++ zeitgeist/datamodel.py	2010-02-25 18:14:12 +0000
@@ -4,7 +4,7 @@
 #
 # Copyright © 2009 Mikkel Kamstrup Erlandsen <[e-mail]>
 # Copyright © 2009 Markus Korn <[e-mail]>
-# Copyright © 2009 Seif Lotfy <[e-mail]>
+# Copyright © 2009-2010 Seif Lotfy <[e-mail]>
 # Copyright © 2009-2010 Siegfried-Angel Gevatter Pujals <[e-mail]>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -532,7 +532,7 @@
 		"ordered ascendently by the popularity of the actor"))
 	MostRecentActor = enum_factory(("The last event of each different actor"))
 	LeastRecentActor = enum_factory(("The first event of each different actor"))
-
+	
 class Subject(list):
 	"""
 	Represents a subject of an :class:`Event`. This class is both used to