Fix most auto-correctable rubocop issues
[rails.git] / app / models / node.rb
index ce2bd5c..7d2219d 100644 (file)
@@ -3,177 +3,161 @@ class Node < ActiveRecord::Base
 
   include GeoRecord
   include ConsistencyValidations
+  include NotRedactable
+  include ObjectMetadata
 
-  set_table_name 'current_nodes'
+  self.table_name = "current_nodes"
 
   belongs_to :changeset
 
-  has_many :old_nodes, :foreign_key => :id
+  has_many :old_nodes, -> { order(:version) }
 
   has_many :way_nodes
   has_many :ways, :through => :way_nodes
 
-  has_many :node_tags, :foreign_key => :id
-  
+  has_many :node_tags
+
   has_many :old_way_nodes
-  has_many :ways_via_history, :class_name=> "Way", :through => :old_way_nodes, :source => :way
+  has_many :ways_via_history, :class_name => "Way", :through => :old_way_nodes, :source => :way
 
   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
-  has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation, :extend => ObjectFinder
+  has_many :containing_relations, :class_name => "Relation", :through => :containing_relation_members, :source => :relation
 
   validates_presence_of :id, :on => :update
-  validates_presence_of :timestamp,:version,  :changeset_id
+  validates_presence_of :timestamp, :version,  :changeset_id
   validates_uniqueness_of :id
-  validates_inclusion_of :visible, :in => [ true, false ]
+  validates_inclusion_of :visible, :in => [true, false]
   validates_numericality_of :latitude, :longitude, :changeset_id, :version, :integer_only => true
   validates_numericality_of :id, :on => :update, :integer_only => true
   validate :validate_position
   validates_associated :changeset
 
+  scope :visible, -> { where(:visible => true) }
+  scope :invisible, -> { where(:visible => false) }
+
   # 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
-
-  #
-  # Search for nodes matching tags within bounding_box
-  #
-  # Also adheres to limitations such as within max_number_of_nodes
-  #
-  def self.search(bounding_box, tags = {})
-    min_lon, min_lat, max_lon, max_lat = *bounding_box
-    # @fixme a bit of a hack to search for only visible nodes
-    # couldn't think of another to add to tags condition
-    #conditions_hash = tags.merge({ 'visible' => 1 })
-  
-    # using named placeholders http://www.robbyonrails.com/articles/2005/10/21/using-named-placeholders-in-ruby
-    #keys = []
-    #values = {}
-
-    #conditions_hash.each do |key,value|
-    #  keys <<  "#{key} = :#{key}"
-    #  values[key.to_sym] = value
-    #end 
-    #conditions = keys.join(' AND ')
-    find_by_area(min_lat, min_lon, max_lat, max_lon,
-                    :conditions => {:visible => true},
-                    :limit => APP_CONFIG['max_number_of_nodes']+1)  
+    errors.add(:base, "Node is not in the world") unless in_world?
   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
-      p.string = xml
-      doc = p.parse
-
-      doc.find('//osm/node').each do |pt|
-        return Node.from_xml_node(pt, create)
-      end
-    rescue LibXML::XML::Error => ex
-      raise OSM::APIBadXMLError.new("node", xml, ex.message)
+  def self.from_xml(xml, create = false)
+    p = XML::Parser.string(xml)
+    doc = p.parse
+
+    doc.find('//osm/node').each do |pt|
+      return Node.from_xml_node(pt, create)
     end
+    fail OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/node element.")
+  rescue LibXML::XML::Error, ArgumentError => ex
+    raise OSM::APIBadXMLError.new("node", xml, ex.message)
   end
 
-  def self.from_xml_node(pt, create=false)
+  def self.from_xml_node(pt, create = false)
     node = Node.new
-    
-    raise OSM::APIBadXMLError.new("node", pt, "lat missing") if pt['lat'].nil?
-    raise OSM::APIBadXMLError.new("node", pt, "lon missing") if pt['lon'].nil?
-    node.lat = pt['lat'].to_f
-    node.lon = pt['lon'].to_f
+
+    fail OSM::APIBadXMLError.new("node", pt, "lat missing") if pt['lat'].nil?
+    fail OSM::APIBadXMLError.new("node", pt, "lon missing") if pt['lon'].nil?
+    node.lat = OSM.parse_float(pt['lat'], OSM::APIBadXMLError, "node", pt, "lat not a number")
+    node.lon = OSM.parse_float(pt['lon'], OSM::APIBadXMLError, "node", pt, "lon not a number")
+    fail OSM::APIBadXMLError.new("node", pt, "Changeset id is missing") if pt['changeset'].nil?
     node.changeset_id = pt['changeset'].to_i
 
-    raise OSM::APIBadUserInput.new("The node is outside this world") unless node.in_world?
+    fail OSM::APIBadUserInput.new("The node is outside this world") unless node.in_world?
 
     # version must be present unless creating
-    raise OSM::APIBadXMLError.new("node", pt, "Version is required when updating") unless create or not pt['version'].nil?
+    fail OSM::APIBadXMLError.new("node", pt, "Version is required when updating") unless create || !pt['version'].nil?
     node.version = create ? 0 : pt['version'].to_i
 
     unless create
-      if pt['id'] != '0'
-        node.id = pt['id'].to_i
-      end
+      fail OSM::APIBadXMLError.new("node", pt, "ID is required when updating.") if pt['id'].nil?
+      node.id = pt['id'].to_i
+      # .to_i will return 0 if there is no number that can be parsed.
+      # We want to make sure that there is no id with zero anyway
+      fail OSM::APIBadUserInput.new("ID of node cannot be zero when updating.") if node.id == 0
     end
 
-    # visible if it says it is, or as the default if the attribute
-    # is missing.
-    node.visible = pt['visible'].nil? or pt['visible'] == 'true'
+    # We don't care about the time, as it is explicitly set on create/update/delete
+    # We don't care about the visibility as it is implicit based on the action
+    # and set manually before the actual delete
+    node.visible = true
 
-    if create
-      node.timestamp = Time.now
-    else
-      if pt['timestamp']
-        node.timestamp = Time.parse(pt['timestamp'])
-      end
-    end
-
-    tags = []
+    # Start with no tags
+    node.tags = {}
 
+    # Add in any tags from the XML
     pt.find('tag').each do |tag|
-      node.add_tag_key_val(tag['k'],tag['v'])
+      fail OSM::APIBadXMLError.new("node", pt, "tag is missing key") if tag['k'].nil?
+      fail OSM::APIBadXMLError.new("node", pt, "tag is missing value") if tag['v'].nil?
+      node.add_tag_key_val(tag['k'], tag['v'])
     end
 
-    return node
+    node
   end
 
   ##
   # the bounding box around a node, which is used for determining the changeset's
   # bounding box
   def bbox
-    [ longitude, latitude, longitude, latitude ]
+    BoundingBox.new(longitude, latitude, longitude, latitude)
   end
 
   # Should probably be renamed delete_from to come in line with update
   def delete_with_history!(new_node, user)
-    unless self.visible
-      raise OSM::APIAlreadyDeletedError.new
+    unless visible
+      fail OSM::APIAlreadyDeletedError.new("node", new_node.id)
     end
 
-    # need to start the transaction here, so that the database can 
+    # need to start the transaction here, so that the database can
     # provide repeatable reads for the used-by checks. this means it
     # shouldn't be possible to get race conditions.
     Node.transaction do
+      self.lock!
       check_consistency(self, new_node, user)
-      if WayNode.find(:first, :joins => "INNER JOIN current_ways ON current_ways.id = current_way_nodes.id", :conditions => [ "current_ways.visible = ? AND current_way_nodes.node_id = ?", true, self.id ])
-        raise OSM::APIPreconditionFailedError.new
-      elsif RelationMember.find(:first, :joins => "INNER JOIN current_relations ON current_relations.id=current_relation_members.id", :conditions => [ "visible = ? AND member_type='node' and member_id=? ", true, self.id])
-        raise OSM::APIPreconditionFailedError.new
-      else
-        self.changeset_id = new_node.changeset_id
-        self.visible = false
-        
-        # update the changeset with the deleted position
-        changeset.update_bbox!(bbox)
-        
-        save_with_history!
-      end
+      ways = Way.joins(:way_nodes).where(:visible => true, :current_way_nodes => { :node_id => id }).order(:id)
+      fail OSM::APIPreconditionFailedError.new("Node #{id} is still used by ways #{ways.collect(&:id).join(",")}.") unless ways.empty?
+
+      rels = Relation.joins(:relation_members).where(:visible => true, :current_relation_members => { :member_type => "Node", :member_id => id }).order(:id)
+      fail OSM::APIPreconditionFailedError.new("Node #{id} is still used by relations #{rels.collect(&:id).join(",")}.") unless rels.empty?
+
+      self.changeset_id = new_node.changeset_id
+      self.tags = {}
+      self.visible = false
+
+      # update the changeset with the deleted position
+      changeset.update_bbox!(bbox)
+
+      save_with_history!
     end
   end
 
   def update_from(new_node, user)
-    check_consistency(self, new_node, user)
+    Node.transaction do
+      self.lock!
+      check_consistency(self, new_node, user)
 
-    # update changeset with *old* position first
-    changeset.update_bbox!(bbox);
+      # update changeset first
+      self.changeset_id = new_node.changeset_id
+      self.changeset = new_node.changeset
 
-    # FIXME logic needs to be double checked
-    self.changeset_id = new_node.changeset_id
-    self.latitude = new_node.latitude 
-    self.longitude = new_node.longitude
-    self.tags = new_node.tags
-    self.visible = true
+      # update changeset bbox with *old* position first
+      changeset.update_bbox!(bbox)
 
-    # update changeset with *new* position
-    changeset.update_bbox!(bbox);
+      # FIXME logic needs to be double checked
+      self.latitude = new_node.latitude
+      self.longitude = new_node.longitude
+      self.tags = new_node.tags
+      self.visible = true
 
-    save_with_history!
+      # update changeset bbox with *new* position
+      changeset.update_bbox!(bbox)
+
+      save_with_history!
+    end
   end
-  
+
   def create_with_history(user)
     check_create_consistency(self, user)
-    self.id = nil
     self.version = 0
     self.visible = true
 
@@ -185,69 +169,42 @@ class Node < ActiveRecord::Base
 
   def to_xml
     doc = OSM::API.new.get_xml_doc
-    doc.root << to_xml_node()
-    return doc
+    doc.root << to_xml_node
+    doc
   end
 
-  def to_xml_node(user_display_name_cache = nil)
-    el1 = XML::Node.new 'node'
-    el1['id'] = self.id.to_s
-    el1['lat'] = self.lat.to_s
-    el1['lon'] = self.lon.to_s
-    el1['version'] = self.version.to_s
-    el1['changeset'] = self.changeset_id.to_s
-    
-    user_display_name_cache = {} if user_display_name_cache.nil?
-
-    if user_display_name_cache and user_display_name_cache.key?(self.changeset.user_id)
-      # use the cache if available
-    elsif self.changeset.user.data_public?
-      user_display_name_cache[self.changeset.user_id] = self.changeset.user.display_name
-    else
-      user_display_name_cache[self.changeset.user_id] = nil
-    end
+  def to_xml_node(changeset_cache = {}, user_display_name_cache = {})
+    el = XML::Node.new 'node'
+    el['id'] = id.to_s
 
-    if not user_display_name_cache[self.changeset.user_id].nil?
-      el1['user'] = user_display_name_cache[self.changeset.user_id]
-      el1['uid'] = self.changeset.user_id.to_s
-    end
+    add_metadata_to_xml_node(el, self, changeset_cache, user_display_name_cache)
 
-    self.tags.each do |k,v|
-      el2 = XML::Node.new('tag')
-      el2['k'] = k.to_s
-      el2['v'] = v.to_s
-      el1 << el2
+    if self.visible?
+      el['lat'] = lat.to_s
+      el['lon'] = lon.to_s
     end
 
-    el1['visible'] = self.visible.to_s
-    el1['timestamp'] = self.timestamp.xmlschema
-    return el1
+    add_tags_to_xml_node(el, node_tags)
+
+    el
   end
 
   def tags_as_hash
-    return tags
+    tags
   end
 
   def tags
-    unless @tags
-      @tags = {}
-      self.node_tags.each do |tag|
-        @tags[tag.k] = tag.v
-      end
-    end
-    @tags
+    @tags ||= Hash[node_tags.collect { |t| [t.k, t.v] }]
   end
 
-  def tags=(t)
-    @tags = t 
-  end 
+  attr_writer :tags
 
-  def add_tag_key_val(k,v)
-    @tags = Hash.new unless @tags
+  def add_tag_key_val(k, v)
+    @tags = {} unless @tags
 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.
-    raise OSM::APIDuplicateTagsError.new("node", self.id, k) if @tags.include? k
+    fail OSM::APIDuplicateTagsError.new("node", id, k) if @tags.include? k
 
     @tags[k] = v
   end
@@ -262,14 +219,14 @@ class Node < ActiveRecord::Base
   ##
   # dummy method to make the interfaces of node, way and relation
   # more consistent.
-  def fix_placeholders!(id_map)
+  def fix_placeholders!(_id_map, _placeholder_id = nil)
     # nodes don't refer to anything, so there is nothing to do here
   end
-  
+
   private
 
   def save_with_history!
-    t = Time.now
+    t = Time.now.getutc
     Node.transaction do
       self.version += 1
       self.timestamp = t
@@ -277,14 +234,14 @@ class Node < ActiveRecord::Base
 
       # Create a NodeTag
       tags = self.tags
-      NodeTag.delete_all(['id = ?', self.id])
-      tags.each do |k,v|
+      NodeTag.delete_all(:node_id => id)
+      tags.each do |k, v|
         tag = NodeTag.new
-        tag.k = k 
-        tag.v = v 
-        tag.id = self.id
+        tag.node_id = id
+        tag.k = k
+        tag.v = v
         tag.save!
-      end 
+      end
 
       # Create an OldNode
       old_node = OldNode.from_node(self)
@@ -298,5 +255,4 @@ class Node < ActiveRecord::Base
       changeset.save!
     end
   end
-  
 end