Cleanup trailing whitespace

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

diff --git a/app/models/relation.rb b/app/models/relation.rb
index 76cd86729cdc8ed3d3ce16600b799eb9b5813bdc..464766802b902c269511d29665181742155ba77c 100644 (file)
--- a/app/models/relation.rb
+++ b/app/models/relation.rb
@@ -1,28 +1,36 @@
 class Relation < ActiveRecord::Base
   require 'xml/libxml'
 class Relation < ActiveRecord::Base
   require 'xml/libxml'

-  
+

   include ConsistencyValidations
   include ConsistencyValidations

-  
-  set_table_name 'current_relations'
+  include NotRedactable
+  include ObjectMetadata
+
+  self.table_name = "current_relations"

 
   belongs_to :changeset
 
 
   belongs_to :changeset
 

-  has_many :old_relations, :foreign_key => 'id', :order => 'version'
+  has_many :old_relations, -> { order(:version) }

 
 

-  has_many :relation_members, :foreign_key => 'id', :order => 'sequence_id'
-  has_many :relation_tags, :foreign_key => 'id'
+  has_many :relation_members, -> { order(:sequence_id) }
+  has_many :relation_tags

 
   has_many :containing_relation_members, :class_name => "RelationMember", :as => :member
 
   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 :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_numericality_of :id, :on => :update, :integer_only => true
   validates_numericality_of :changeset_id, :version, :integer_only => true
   validates_associated :changeset
   validates_uniqueness_of :id
   validates_inclusion_of :visible, :in => [ true, false ]
   validates_numericality_of :id, :on => :update, :integer_only => true
   validates_numericality_of :changeset_id, :version, :integer_only => true
   validates_associated :changeset

-  
+
+  scope :visible, -> { where(:visible => true) }
+  scope :invisible, -> { where(:visible => false) }
+  scope :nodes, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Node", :member_id => ids.flatten }) }
+  scope :ways, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Way", :member_id => ids.flatten }) }
+  scope :relations, ->(*ids) { joins(:relation_members).where(:current_relation_members => { :member_type => "Relation", :member_id => ids.flatten }) }
+

   TYPES = ["node", "way", "relation"]
 
   def self.from_xml(xml, create=false)
   TYPES = ["node", "way", "relation"]
 
   def self.from_xml(xml, create=false)


@@ -33,6 +41,7 @@ class Relation < ActiveRecord::Base
       doc.find('//osm/relation').each do |pt|
         return Relation.from_xml_node(pt, create)
       end
       doc.find('//osm/relation').each do |pt|
         return Relation.from_xml_node(pt, create)
       end

+      raise OSM::APIBadXMLError.new("node", xml, "XML doesn't contain an osm/relation element.")

     rescue LibXML::XML::Error, ArgumentError => ex
       raise OSM::APIBadXMLError.new("relation", xml, ex.message)
     end
     rescue LibXML::XML::Error, ArgumentError => ex
       raise OSM::APIBadXMLError.new("relation", xml, ex.message)
     end


@@ -45,28 +54,38 @@ class Relation < ActiveRecord::Base
     relation.version = pt['version']
     raise OSM::APIBadXMLError.new("relation", pt, "Changeset id is missing") if pt['changeset'].nil?
     relation.changeset_id = pt['changeset']
     relation.version = pt['version']
     raise OSM::APIBadXMLError.new("relation", pt, "Changeset id is missing") if pt['changeset'].nil?
     relation.changeset_id = pt['changeset']

-    
+

     unless create
       raise OSM::APIBadXMLError.new("relation", pt, "ID is required when updating") if pt['id'].nil?
       relation.id = pt['id'].to_i
     unless create
       raise OSM::APIBadXMLError.new("relation", pt, "ID is required when updating") if pt['id'].nil?
       relation.id = pt['id'].to_i

-      # .to_i will return 0 if there is no number that can be parsed. 
+      # .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
       raise OSM::APIBadUserInput.new("ID of relation cannot be zero when updating.") if relation.id == 0
     end
       # We want to make sure that there is no id with zero anyway
       raise OSM::APIBadUserInput.new("ID of relation cannot be zero when updating.") if relation.id == 0
     end

-    
+

     # We don't care about the timestamp nor the visibility as these are either
     # We don't care about the timestamp nor the visibility as these are either

-    # set explicitly or implicit in the action. The visibility is set to true, 
+    # set explicitly or implicit in the action. The visibility is set to true,

     # and manually set to false before the actual delete.
     relation.visible = true
 
     # and manually set to false before the actual delete.
     relation.visible = true
 

+    # Start with no tags
+    relation.tags = Hash.new
+
+    # Add in any tags from the XML

     pt.find('tag').each do |tag|
       raise OSM::APIBadXMLError.new("relation", pt, "tag is missing key") if tag['k'].nil?
       raise OSM::APIBadXMLError.new("relation", pt, "tag is missing value") if tag['v'].nil?
       relation.add_tag_keyval(tag['k'], tag['v'])
     end
 
     pt.find('tag').each do |tag|
       raise OSM::APIBadXMLError.new("relation", pt, "tag is missing key") if tag['k'].nil?
       raise OSM::APIBadXMLError.new("relation", pt, "tag is missing value") if tag['v'].nil?
       relation.add_tag_keyval(tag['k'], tag['v'])
     end
 

+    # need to initialise the relation members array explicitly, as if this
+    # isn't done for a new relation then @members attribute will be nil,
+    # and the members will be loaded from the database instead of being
+    # empty, as intended.
+    relation.members = Array.new
+

     pt.find('member').each do |member|
     pt.find('member').each do |member|

-      #member_type = 
+      #member_type =

       logger.debug "each member"
       raise OSM::APIBadXMLError.new("relation", pt, "The #{member['type']} is not allowed only, #{TYPES.inspect} allowed") unless TYPES.include? member['type']
       logger.debug "after raise"
       logger.debug "each member"
       raise OSM::APIBadXMLError.new("relation", pt, "The #{member['type']} is not allowed only, #{TYPES.inspect} allowed") unless TYPES.include? member['type']
       logger.debug "after raise"


@@ -88,33 +107,10 @@ class Relation < ActiveRecord::Base
   end
 
   def to_xml_node(visible_members = nil, changeset_cache = {}, user_display_name_cache = {})
   end
 
   def to_xml_node(visible_members = nil, changeset_cache = {}, user_display_name_cache = {})

-    el1 = XML::Node.new 'relation'
-    el1['id'] = self.id.to_s
-    el1['visible'] = self.visible.to_s
-    el1['timestamp'] = self.timestamp.xmlschema
-    el1['version'] = self.version.to_s
-    el1['changeset'] = self.changeset_id.to_s
-
-    if changeset_cache.key?(self.changeset_id)
-      # use the cache if available
-    else
-      changeset_cache[self.changeset_id] = self.changeset.user_id
-    end
-
-    user_id = changeset_cache[self.changeset_id]
+    el = XML::Node.new 'relation'
+    el['id'] = self.id.to_s

 
 

-    if user_display_name_cache.key?(user_id)
-      # use the cache if available
-    elsif self.changeset.user.data_public?
-      user_display_name_cache[user_id] = self.changeset.user.display_name
-    else
-      user_display_name_cache[user_id] = nil
-    end
-
-    if not user_display_name_cache[user_id].nil?
-      el1['user'] = user_display_name_cache[user_id]
-      el1['uid'] = user_id.to_s
-    end
+    add_metadata_to_xml_node(el, self, changeset_cache, user_display_name_cache)

 
     self.relation_members.each do |member|
       p=0
 
     self.relation_members.each do |member|
       p=0


@@ -130,72 +126,28 @@ class Relation < ActiveRecord::Base
         end
       end
       if p
         end
       end
       if p

-        e = XML::Node.new 'member'
-        e['type'] = member.member_type.downcase
-        e['ref'] = member.member_id.to_s 
-        e['role'] = member.member_role
-        el1 << e
+        member_el = XML::Node.new 'member'
+        member_el['type'] = member.member_type.downcase
+        member_el['ref'] = member.member_id.to_s
+        member_el['role'] = member.member_role
+        el << member_el

        end
     end
 
        end
     end
 

-    self.relation_tags.each do |tag|
-      e = XML::Node.new 'tag'
-      e['k'] = tag.k
-      e['v'] = tag.v
-      el1 << e
-    end
-    return el1
-  end 
-
-  def self.find_for_nodes(ids, options = {})
-    if ids.empty?
-      return []
-    else
-      self.with_scope(:find => { :joins => "INNER JOIN current_relation_members AS crm ON crm.id = current_relations.id", :conditions => "crm.member_type = 'Node' AND crm.member_id IN (#{ids.join(',')})" }) do
-        return self.find(:all, options)
-      end
-    end
-  end
-
-  def self.find_for_ways(ids, options = {})
-    if ids.empty?
-      return []
-    else
-      self.with_scope(:find => { :joins => "INNER JOIN current_relation_members AS crm ON crm.id = current_relations.id", :conditions => "crm.member_type = 'Way' AND crm.member_id IN (#{ids.join(',')})" }) do
-        return self.find(:all, options)
-      end
-    end
-  end
+    add_tags_to_xml_node(el, self.relation_tags)

 
 

-  def self.find_for_relations(ids, options = {})
-    if ids.empty?
-      return []
-    else
-      self.with_scope(:find => { :joins => "INNER JOIN current_relation_members AS crm ON crm.id = current_relations.id", :conditions => "crm.member_type = 'Relation' AND crm.member_id IN (#{ids.join(',')})" }) do
-        return self.find(:all, options)
-      end
-    end
+    return el

   end
 
   # FIXME is this really needed?
   def members
   end
 
   # FIXME is this really needed?
   def members

-    unless @members
-      @members = Array.new
-      self.relation_members.each do |member|
-        @members += [[member.member_type,member.member_id,member.member_role]]
-      end
+    @members ||= self.relation_members.map do |member|
+      [member.member_type, member.member_id, member.member_role]

     end
     end

-    @members

   end
 
   def tags
   end
 
   def tags

-    unless @tags
-      @tags = Hash.new
-      self.relation_tags.each do |tag|
-        @tags[tag.k] = tag.v
-      end
-    end
-    @tags
+    @tags ||= Hash[self.relation_tags.collect { |t| [t.k, t.v] }]

   end
 
   def members=(m)
   end
 
   def members=(m)


@@ -206,9 +158,9 @@ class Relation < ActiveRecord::Base
     @tags = t
   end
 
     @tags = t
   end
 

-  def add_member(type,id,role)
-    @members = Array.new unless @members
-    @members += [[type,id.to_i,role]]
+  def add_member(type, id, role)
+    @members ||= []
+    @members << [type, id.to_i, role]

   end
 
   def add_tag_keyval(k, v)
   end
 
   def add_tag_keyval(k, v)


@@ -222,29 +174,28 @@ class Relation < ActiveRecord::Base
   end
 
   ##
   end
 
   ##

-  # updates the changeset bounding box to contain the bounding box of 
+  # updates the changeset bounding box to contain the bounding box of

   # the element with given +type+ and +id+. this only works with nodes
   # and ways at the moment, as they're the only elements to respond to
   # the :bbox call.
   def update_changeset_element(type, id)
     element = Kernel.const_get(type.capitalize).find(id)
     changeset.update_bbox! element.bbox
   # the element with given +type+ and +id+. this only works with nodes
   # and ways at the moment, as they're the only elements to respond to
   # the :bbox call.
   def update_changeset_element(type, id)
     element = Kernel.const_get(type.capitalize).find(id)
     changeset.update_bbox! element.bbox

-  end    
+  end

 
   def delete_with_history!(new_relation, user)
     unless self.visible
       raise OSM::APIAlreadyDeletedError.new("relation", new_relation.id)
     end
 
 
   def delete_with_history!(new_relation, user)
     unless self.visible
       raise OSM::APIAlreadyDeletedError.new("relation", new_relation.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.
     Relation.transaction do
       self.lock!
       check_consistency(self, new_relation, user)
       # This will check to see if this relation is used by another relation
     # provide repeatable reads for the used-by checks. this means it
     # shouldn't be possible to get race conditions.
     Relation.transaction do
       self.lock!
       check_consistency(self, new_relation, user)
       # This will check to see if this relation is used by another relation

-      rel = RelationMember.find(:first, :joins => :relation, 
-                                :conditions => [ "visible = ? AND member_type='Relation' and member_id=? ", true, self.id ])
+      rel = RelationMember.joins(:relation).where("visible = ? AND member_type = 'Relation' and member_id = ? ", true, self.id).first

       raise OSM::APIPreconditionFailedError.new("The relation #{new_relation.id} is used in relation #{rel.relation.id}.") unless rel.nil?
 
       self.changeset_id = new_relation.changeset_id
       raise OSM::APIPreconditionFailedError.new("The relation #{new_relation.id} is used in relation #{rel.relation.id}.") unless rel.nil?
 
       self.changeset_id = new_relation.changeset_id


@@ -270,7 +221,7 @@ class Relation < ActiveRecord::Base
       save_with_history!
     end
   end
       save_with_history!
     end
   end

-  
+

   def create_with_history(user)
     check_create_consistency(self, user)
     unless self.preconditions_ok?
   def create_with_history(user)
     check_create_consistency(self, user)
     unless self.preconditions_ok?


@@ -282,9 +233,9 @@ class Relation < ActiveRecord::Base
   end
 
   def preconditions_ok?(good_members = [])
   end
 
   def preconditions_ok?(good_members = [])

-    # These are hastables that store an id in the index of all 
+    # These are hastables that store an id in the index of all

     # the nodes/way/relations that have already been added.
     # the nodes/way/relations that have already been added.

-    # If the member is valid and visible then we add it to the 
+    # If the member is valid and visible then we add it to the

     # relevant hash table, with the value true as a cache.
     # Thus if you have nodes with the ids of 50 and 1 already in the
     # relation, then the hash table nodes would contain:
     # relevant hash table, with the value true as a cache.
     # Thus if you have nodes with the ids of 50 and 1 already in the
     # relation, then the hash table nodes would contain:


@@ -302,7 +253,7 @@ class Relation < ActiveRecord::Base
         # use reflection to look up the appropriate class
         model = Kernel.const_get(m[0].capitalize)
         # get the element with that ID
         # use reflection to look up the appropriate class
         model = Kernel.const_get(m[0].capitalize)
         # get the element with that ID

-        element = model.find(:first, :conditions =>["id = ?", m[1]])
+        element = model.where(:id => m[1]).first

 
         # and check that it is OK to use.
         unless element and element.visible? and element.preconditions_ok?
 
         # and check that it is OK to use.
         unless element and element.visible? and element.preconditions_ok?


@@ -322,8 +273,8 @@ class Relation < ActiveRecord::Base
 
   ##
   # if any members are referenced by placeholder IDs (i.e: negative) then
 
   ##
   # if any members are referenced by placeholder IDs (i.e: negative) then

-  # this calling this method will fix them using the map from placeholders 
-  # to IDs +id_map+. 
+  # this calling this method will fix them using the map from placeholders
+  # to IDs +id_map+.

   def fix_placeholders!(id_map, placeholder_id = nil)
     self.members.map! do |type, id, role|
       old_id = id.to_i
   def fix_placeholders!(id_map, placeholder_id = nil)
     self.members.map! do |type, id, role|
       old_id = id.to_i


@@ -338,7 +289,7 @@ class Relation < ActiveRecord::Base
   end
 
   private
   end
 
   private

-  
+

   def save_with_history!
     Relation.transaction do
       # have to be a little bit clever here - to detect if any tags
   def save_with_history!
     Relation.transaction do
       # have to be a little bit clever here - to detect if any tags


@@ -355,9 +306,9 @@ class Relation < ActiveRecord::Base
         key = old_tag.k
         # if we can match the tags we currently have to the list
         # of old tags, then we never set the tags_changed flag. but
         key = old_tag.k
         # if we can match the tags we currently have to the list
         # of old tags, then we never set the tags_changed flag. but

-        # if any are different then set the flag and do the DB 
+        # if any are different then set the flag and do the DB

         # update.
         # update.

-        if tags.has_key? key 
+        if tags.has_key? key

           tags_changed |= (old_tag.v != tags[key])
 
           # remove from the map, so that we can expect an empty map
           tags_changed |= (old_tag.v != tags[key])
 
           # remove from the map, so that we can expect an empty map


@@ -372,15 +323,15 @@ class Relation < ActiveRecord::Base
       # if there are left-over tags then they are new and will have to
       # be added.
       tags_changed |= (not tags.empty?)
       # if there are left-over tags then they are new and will have to
       # be added.
       tags_changed |= (not tags.empty?)

-      RelationTag.delete_all(:id => self.id)
+      RelationTag.delete_all(:relation_id => self.id)

       self.tags.each do |k,v|
         tag = RelationTag.new
       self.tags.each do |k,v|
         tag = RelationTag.new

+        tag.relation_id = self.id

         tag.k = k
         tag.v = v
         tag.k = k
         tag.v = v

-        tag.id = self.id

         tag.save!
       end
         tag.save!
       end

-      
+

       # same pattern as before, but this time we're collecting the
       # changed members in an array, as the bounding box updates for
       # elements are per-element, not blanked on/off like for tags.
       # same pattern as before, but this time we're collecting the
       # changed members in an array, as the bounding box updates for
       # elements are per-element, not blanked on/off like for tags.


@@ -402,10 +353,11 @@ class Relation < ActiveRecord::Base
       # members may be in a different order and i don't feel like implementing
       # a longest common subsequence algorithm to optimise this.
       members = self.members
       # members may be in a different order and i don't feel like implementing
       # a longest common subsequence algorithm to optimise this.
       members = self.members

-      RelationMember.delete_all(:id => self.id)
+      RelationMember.delete_all(:relation_id => self.id)

       members.each_with_index do |m,i|
         mem = RelationMember.new
       members.each_with_index do |m,i|
         mem = RelationMember.new

-        mem.id = [self.id, i]
+        mem.relation_id = self.id
+        mem.sequence_id = i

         mem.member_type = m[0]
         mem.member_id = m[1]
         mem.member_role = m[2]
         mem.member_type = m[0]
         mem.member_id = m[1]
         mem.member_role = m[2]


@@ -426,7 +378,7 @@ class Relation < ActiveRecord::Base
       # bounding box. this is similar to how the map call does things and is
       # reasonable on the assumption that adding or removing members doesn't
       # materially change the rest of the relation.
       # bounding box. this is similar to how the map call does things and is
       # reasonable on the assumption that adding or removing members doesn't
       # materially change the rest of the relation.

-      any_relations = 
+      any_relations =

         changed_members.collect { |id,type| type == "relation" }.
         inject(false) { |b,s| b or s }
 
         changed_members.collect { |id,type| type == "relation" }.
         inject(false) { |b,s| b or s }
 


@@ -435,7 +387,7 @@ class Relation < ActiveRecord::Base
                          # FIXME: check for tag changes along with element deletions and
                          # make sure that the deleted element's bounding box is hit.
                          self.members
                          # FIXME: check for tag changes along with element deletions and
                          # make sure that the deleted element's bounding box is hit.
                          self.members

-                       else 
+                       else

                          changed_members
                        end
       update_members.each do |type, id, role|
                          changed_members
                        end
       update_members.each do |type, id, role|