Some node documentation

[rails.git] / app / models / node.rb

diff --git a/app/models/node.rb b/app/models/node.rb
index f9210bf0664a88a296a8c41e200d88fb9e8652a2..2a073f5428d4bd0ab32cea436c888963419a99b4 100644 (file)
--- a/app/models/node.rb
+++ b/app/models/node.rb
@@ -1,5 +1,8 @@
-class Node < ActiveRecord::Base
+# The node model represents a current existing node, that is, the latest version. Use OldNode for historical nodes.
+
+class Node < GeoRecord
   require 'xml/libxml'
+
   set_table_name 'current_nodes'
   
   validates_presence_of :user_id, :timestamp
@@ -8,46 +11,23 @@ class Node < ActiveRecord::Base
   validate :validate_position
 
   has_many :old_nodes, :foreign_key => :id
+  has_many :way_nodes
   belongs_to :user
  
-  before_save :update_tile
-
-  def self.find_by_area(minlat, minlon, maxlat, maxlon, options)
-    self.with_scope(:find => {:conditions => OSM.sql_for_area(minlat, minlon, maxlat, maxlon)}) do
-      return self.find(:all, options)
-    end
-  end
-
-  def update_tile
-    self.tile = QuadTile.tile_for_point(lat, lon)
-  end
-
-  def lat=(l)
-    self.latitude = (l * 10000000).round
-  end
-
-  def lon=(l)
-    self.longitude = (l * 10000000).round
-  end
-
-  def lat
-    return self.latitude.to_f / 10000000
-  end
-
-  def lon
-    return self.longitude.to_f / 10000000
-  end
-
+  # Sanity check the latitude and longitude and add an error if it's broken
   def validate_position
     errors.add_to_base("Node is not in the world") unless in_world?
   end
 
+  # Is this node withing -90 > latitude > 90 and -180 > longitude > 180>
+  # * returns true/false
   def in_world?
     return false if self.lat < -90 or self.lat > 90
     return false if self.lon < -180 or self.lon > 180
     return true
   end
 
+  # Read in xml as text and return it's Node object representation
   def self.from_xml(xml, create=false)
     begin
       p = XML::Parser.new
@@ -84,10 +64,7 @@ class Node < ActiveRecord::Base
           tags << [tag['k'],tag['v']]
         end
 
-        tags = tags.collect { |k,v| "#{k}=#{v}" }.join(';')
-        tags = '' if tags.nil?
-
-        node.tags = tags
+        node.tags = Tags.join(tags)
       end
     rescue
       node = nil
@@ -96,6 +73,7 @@ class Node < ActiveRecord::Base
     return node
   end
 
+  # Save this node with the appropriate OldNode object to represent it's history.
   def save_with_history!
     Node.transaction do
       self.timestamp = Time.now
@@ -105,12 +83,14 @@ class Node < ActiveRecord::Base
     end
   end
 
+  # Turn this Node in to a complete OSM XML object with <osm> wrapper
   def to_xml
     doc = OSM::API.new.get_xml_doc
     doc.root << to_xml_node()
     return doc
   end
 
+  # Turn this Node in to an XML Node without the <osm> wrapper.
   def to_xml_node(user_display_name_cache = nil)
     el1 = XML::Node.new 'node'
     el1['id'] = self.id.to_s
@@ -129,25 +109,24 @@ class Node < ActiveRecord::Base
 
     el1['user'] = user_display_name_cache[self.user_id] unless user_display_name_cache[self.user_id].nil?
 
-    Node.split_tags(el1, self.tags)
+    Tags.split(self.tags) do |k,v|
+      el2 = XML::Node.new('tag')
+      el2['k'] = k.to_s
+      el2['v'] = v.to_s
+      el1 << el2
+    end
+
     el1['visible'] = self.visible.to_s
     el1['timestamp'] = self.timestamp.xmlschema
     return el1
   end
 
-  def self.split_tags(el, tags)
-    tags.split(';').each do |tag|
-      parts = tag.split('=')
-      key = ''
-      val = ''
-      key = parts[0].strip unless parts[0].nil?
-      val = parts[1].strip unless parts[1].nil?
-      if key != '' && val != ''
-        el2 = XML::Node.new('tag')
-        el2['k'] = key.to_s
-        el2['v'] = val.to_s
-        el << el2
-      end
+  # Return the node's tags as a Hash of keys and their values
+  def tags_as_hash
+    hash = {}
+    Tags.split(self.tags) do |k,v|
+      hash[k] = v
     end
+    hash
   end
 end