directed-edge 0.1.3 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/directed-edge.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{directed-edge}
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Directed Edge"]
-  s.date = %q{2010-04-09}
+  s.date = %q{2010-04-25}
   s.description = %q{Bindings for the Directed Edge webservices API}
   s.email = %q{info@directededge.com}
   s.extra_rdoc_files = [

data/lib/directed_edge.rb

@@ -55,6 +55,22 @@ module DirectedEdge
     end
   end
 
+  class CollectionHash < Hash
+    def initialize(type)
+      @type = type
+    end
+    def [](key)
+      self[key] = @type.new unless include? key
+      super(key)
+    end
+    def each
+      super { |key, value| yield(key, value) unless value.empty? }
+    end
+    def empty?
+      each { |key, value| return false } ; true
+    end
+  end
+
   # Base class used for Database and Item that has some basic resource
   # grabbing functionality.
 
@@ -92,26 +108,6 @@ module DirectedEdge
       values
     end
 
-    # Returns a hash of the elements from the document matching the given
-    # element name.  If the specified attribute is present, its value will
-    # be assigned to the hash, otherwise the default value given will be
-    # used.
-
-    def hash_from_document(document, element, attribute, default=0)
-      values = {}
-      document.elements.each("//#{element}") do |v|
-        value = v.attribute(attribute).to_s || default
-        if value.empty?
-          values[v.text] = default
-        elsif value.to_i.to_s == value.to_s
-          values[v.text] = value.to_i
-        else
-          values[v.text] = value.to_s
-        end
-      end
-      values
-    end
-
     # Normalizes the parameters in an argument hash to a standard form
     # so that they can be passed off to the web services API -- e.g.
     # :foo_bar to 'fooBar'
@@ -328,13 +324,13 @@ module DirectedEdge
       @database = database
 
       @id = id
-      @links = {}
+      @links = CollectionHash.new(Hash)
       @tags = Set.new
       @preselected = []
       @blacklisted = Set.new
       @properties = {}
 
-      @links_to_remove = Set.new
+      @links_to_remove = CollectionHash.new(Set)
       @tags_to_remove = Set.new
       @preselected_to_remove = Set.new
       @blacklisted_to_remove = Set.new
@@ -363,9 +359,13 @@ module DirectedEdge
 
     # Creates an item if it does not already exist in the database or overwrites
     # an existing item if one does.
+    #
+    # This has been deprecated as it's not set up to properly support link types.
+    # use new / save instead.
 
     def create(links={}, tags=Set.new, properties={})
-      @links = links
+      warn 'DirectedEdge::Item::create has been deprecated. Use new / save instead.'
+      @links[''] = links
       @tags = tags
       @properties = properties
 
@@ -390,6 +390,8 @@ module DirectedEdge
 
         put(complete_document, 'add')
 
+        ### CHECKING LINKS_TO_REMOVE.EMPTY? ISN'T CORRECT ANYMORE
+
         if !@links_to_remove.empty? ||
             !@tags_to_remove.empty? ||
             !@preselected_to_remove.empty? ||
@@ -410,13 +412,11 @@ module DirectedEdge
     # will be discarded.
 
     def reload
-      document = read_document
-
-      @links = hash_from_document(document, 'link', 'weight')
-      @tags = Set.new(list_from_document(document, 'tag'))
-      @preselected = list_from_document(document, 'preselected')
-      @blacklisted = Set.new(list_from_document(document, 'blacklisted'))
-      @properties = {}
+      @links.clear
+      @tags.clear
+      @preselected.clear
+      @blacklisted.clear
+      @properties.clear
 
       @links_to_remove.clear
       @tags_to_remove.clear
@@ -424,17 +424,15 @@ module DirectedEdge
       @blacklisted_to_remove.clear
       @properties_to_remove.clear
 
-      document.elements.each('//property') do |element|
-        @properties[element.attribute('name').value] = element.text
-      end
-      @cached = true
+      @cached = false
+      read
     end
 
     # Returns a set of items that are linked to from this item.
 
-    def links
+    def links(type='')
       read
-      @links
+      @links[type.to_s]
     end
 
     # Returns a set containing all of this item's tags.
@@ -515,27 +513,27 @@ module DirectedEdge
     # item is saved.  Otherwise the link will be ignored as the engine tries
     # to detect 'broken' links that do not terminate at a valid item.
 
-    def link_to(other, weight=0)
+    def link_to(other, weight=0, type='')
       raise RangeError if (weight < 0 || weight > 10)
-      @links_to_remove.delete(other)
-      @links[other.to_s] = weight
+      @links_to_remove[type.to_s].delete(other)
+      @links[type.to_s][other.to_s] = weight
     end
 
     # Deletes a link from this item to other.
     #
     # The changes will not be reflected in the database until save is called.
 
-    def unlink_from(other)
-      @links_to_remove.add(other.to_s) unless @cached
-      @links.delete(other.to_s)
+    def unlink_from(other, type='')
+      @links_to_remove[type.to_s].add(other.to_s) unless @cached
+      @links[type.to_s].delete(other.to_s)
     end
 
     # If there is a link for "other" then it returns the weight for the given
     # item.  Zero indicates that no weight is assigned.
 
-    def weight_for(other)
+    def weight_for(other, type='')
       read
-      @links[other.to_s]
+      @links[type.to_s][other.to_s]
     end
 
     # Adds a tag to this item.
@@ -639,10 +637,18 @@ module DirectedEdge
     # already cached.
 
     def read
-      if !@cached
+      unless @cached
         begin
           document = read_document
-          @links.merge!(hash_from_document(document, 'link', 'weight'))
+
+          document.elements.each('//link') do |link_element|
+            type = link_element.attribute('type')
+            type = type ? type.to_s : ''
+            weight = link_element.attribute('weight').to_s.to_i
+            target = link_element.text
+            @links[type][target] = weight unless @links[type][target]
+          end
+
           @tags.merge(list_from_document(document, 'tag'))
           @preselected.concat(list_from_document(document, 'preselected'))
           @blacklisted.merge(list_from_document(document, 'blacklisted'))
@@ -652,7 +658,10 @@ module DirectedEdge
             @properties[name] = element.text unless @properties.has_key?(name)
           end
 
-          @links_to_remove.each { |link| @links.delete(link) }
+          @links_to_remove.each do |type, links|
+            links.each { |link, weight| @links[type].delete(link) }
+          end
+
           @tags_to_remove.each { |tag| @tags.delete(tag) }
           @preselected_to_remove.each { |p| @preselected.delete(p) }
           @blacklisted_to_remove.each { |b| @blacklisted.delete(b) }
@@ -665,8 +674,8 @@ module DirectedEdge
           @properties_to_remove.clear
 
           @cached = true
-        rescue
-          puts "Couldn't read \"#{@id}\" from the database."
+        rescue => ex
+          puts "Couldn't read \"#{@id}\" from the database, #{ex}"
         end
       end
     end
@@ -689,7 +698,15 @@ module DirectedEdge
 
     def removal_document
       item = setup_document(REXML::Document.new)
-      @links_to_remove.each { |link| item.add_element('link').add_text(link.to_s) }
+
+      @links_to_remove.each do |type, links|
+        links.each do |link|
+          element = item.add_element('link')
+          element.add_attribute(type) unless type.empty?
+          element.add_text(link.to_s)
+        end
+      end
+
       @tags_to_remove.each { |tag| item.add_element('tag').add_text(tag.to_s) }
       @preselected_to_remove.each { |p| item.add_element('preselected').add_text(p.to_s) }
       @blacklisted_to_remove.each { |b| item.add_element('blacklisted').add_text(b.to_s) }
@@ -701,10 +718,13 @@ module DirectedEdge
 
     def insert_item(document)
       item = setup_document(document)
-      @links.each do |link, weight|
-        element = item.add_element('link')
-        element.add_attribute('weight', weight.to_s) if weight != 0
-        element.add_text(link.to_s)
+      @links.each do |type, links|
+        links.each do |link, weight|
+          element = item.add_element('link')
+          element.add_attribute('type', type) unless type.empty?
+          element.add_attribute('weight', weight.to_s) unless weight == 0
+          element.add_text(link.to_s)
+        end
       end
       @tags.each { |tag| item.add_element('tag').add_text(tag.to_s) }
       @preselected.each { |p| item.add_element('preselected').add_text(p.to_s) }

data/test/test_directed_edge.rb

@@ -1,4 +1,5 @@
 require 'helper'
+require 'pp'
 
 # Defines a multithreaded "each"
 
@@ -85,13 +86,17 @@ class TestDirectedEdge < Test::Unit::TestCase
 
   def test_items
     first_item = DirectedEdge::Item.new(@database, 'test_1')
-    first_item.create
+    first_item.save
 
     second_item = DirectedEdge::Item.new(@database, 'test_2')
-    second_item.create([first_item])
+    second_item.link_to(first_item)
+    second_item.save
 
     third_item = DirectedEdge::Item.new(@database, 'test_3')
-    third_item.create([first_item, second_item], 'test_tag')
+    third_item.link_to(first_item)
+    third_item.link_to(second_item)
+    third_item.add_tag('test_tag')
+    third_item.save
 
     assert_equal('test_1', first_item.name)
 
@@ -115,8 +120,8 @@ class TestDirectedEdge < Test::Unit::TestCase
     # Make sure that the third item is linked to both the first and second items
 
     assert_equal(2, third_item.links.length)
-    assert(third_item.links.include?(first_item))
-    assert(third_item.links.include?(second_item))
+    assert(third_item.links.include?(first_item.to_s))
+    assert(third_item.links.include?(second_item.to_s))
 
     # Make sure that the first and second items show up in the related items for
     # the third item
@@ -230,13 +235,34 @@ class TestDirectedEdge < Test::Unit::TestCase
     assert(!item.properties.include?('test_property_1'))
   end
 
+  def test_link_types
+    first = DirectedEdge::Item.new(@database, 'item_1')
+    second = DirectedEdge::Item.new(@database, 'item_2')
+    first.save
+    second.save
+
+    first.link_to(second, 0, :test)
+    first.save
+
+    first = DirectedEdge::Item.new(@database, 'item_1')
+    second = DirectedEdge::Item.new(@database, 'item_2')
+
+    first.save
+    first.reload
+    second.reload
+
+    assert(first.links(:test).include?('item_2'))
+    assert(!first.links.include?('item_2'))
+  end
+
   def test_load
     return if ENV['NO_LOAD_TEST']
 
     def run_load_test(prefix, count)
       (1..count).concurrently do |i|
         item = DirectedEdge::Item.new(@database, "test_item_#{prefix}_#{i}")
-        item.create([], ['test_tag'])
+        item.add_tag('test_tag')
+        item.save
       end
       (1..count).concurrently do |i|
         item = DirectedEdge::Item.new(@database, "test_item_#{prefix}_#{i}")
@@ -372,10 +398,10 @@ class TestDirectedEdge < Test::Unit::TestCase
 
   def test_blacklisted
     customer = DirectedEdge::Item.new(@database, 'customer1')
-    first = customer.recommended.first
+    first = customer.recommended(['product']).first
     customer.add_blacklisted(first)
     customer.save
-    assert_not_equal(customer.recommended.first, first)
+    assert(!customer.recommended(['product']).include?(first))
 
     assert(customer.blacklisted.include?(first))
     customer.reload
@@ -386,6 +412,6 @@ class TestDirectedEdge < Test::Unit::TestCase
     assert(!customer.blacklisted.include?(first))
     customer.reload
     assert(!customer.blacklisted.include?(first))
-    assert_equal(customer.recommended.first, first)
+    assert(customer.recommended(['product']).include?(first))
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 3
-  version: 0.1.3
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Directed Edge
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-09 00:00:00 +02:00
+date: 2010-04-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency