Fix rubocop warning

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

diff --git a/app/models/changeset.rb b/app/models/changeset.rb
index 0a0b6462bc30db8ef691c1600de9647a2941085b..d57086a8e040062af55313a99cbb8b8dd477ab60 100644 (file)
--- a/app/models/changeset.rb
+++ b/app/models/changeset.rb
@@ -1,7 +1,34 @@
+# == Schema Information
+#
+# Table name: changesets
+#
+#  id          :bigint(8)        not null, primary key
+#  user_id     :bigint(8)        not null
+#  created_at  :datetime         not null
+#  min_lat     :integer
+#  max_lat     :integer
+#  min_lon     :integer
+#  max_lon     :integer
+#  closed_at   :datetime         not null
+#  num_changes :integer          default(0), not null
+#
+# Indexes
+#
+#  changesets_bbox_idx                (min_lat,max_lat,min_lon,max_lon) USING gist
+#  changesets_closed_at_idx           (closed_at)
+#  changesets_created_at_idx          (created_at)
+#  changesets_user_id_created_at_idx  (user_id,created_at)
+#  changesets_user_id_id_idx          (user_id,id)
+#
+# Foreign Keys
+#
+#  changesets_user_id_fkey  (user_id => users.id)
+#
+

 class Changeset < ActiveRecord::Base
 class Changeset < ActiveRecord::Base

-  require 'xml/libxml'
+  require "xml/libxml"

 
 

-  belongs_to :user
+  belongs_to :user, :counter_cache => true

 
   has_many :changeset_tags
 
 
   has_many :changeset_tags
 


@@ -12,21 +39,24 @@ class Changeset < ActiveRecord::Base
   has_many :old_ways
   has_many :old_relations
 
   has_many :old_ways
   has_many :old_relations
 

-  validates_presence_of :id, :on => :update
-  validates_presence_of :user_id, :created_at, :closed_at, :num_changes
-  validates_uniqueness_of :id
-  validates_numericality_of :id, :on => :update, :integer_only => true
-  validates_numericality_of :min_lat, :max_lat, :min_lon, :max_lat, :allow_nil => true, :integer_only => true
-  validates_numericality_of :user_id,  :integer_only => true
-  validates_numericality_of :num_changes, :integer_only => true, :greater_than_or_equal_to => 0
+  has_many :comments, -> { where(:visible => true).order(:created_at) }, :class_name => "ChangesetComment"
+  has_and_belongs_to_many :subscribers, :class_name => "User", :join_table => "changesets_subscribers", :association_foreign_key => "subscriber_id"

 
 

-  before_save :update_closed_at
+  validates :id, :uniqueness => true, :presence => { :on => :update },
+                 :numericality => { :on => :update, :integer_only => true }
+  validates :user_id, :presence => true,
+                      :numericality => { :integer_only => true }
+  validates :num_changes, :presence => true,
+                          :numericality => { :integer_only => true,
+                                             :greater_than_or_equal_to => 0 }
+  validates :created_at, :closed_at, :presence => true
+  validates :min_lat, :max_lat, :min_lon, :max_lat, :allow_nil => true,
+                                                    :numericality => { :integer_only => true }

 
 

-  # over-expansion factor to use when updating the bounding box
-  EXPAND = 0.1
+  before_save :update_closed_at

 
   # maximum number of elements allowed in a changeset
 
   # maximum number of elements allowed in a changeset

-  MAX_ELEMENTS = 50000
+  MAX_ELEMENTS = 10000

 
   # maximum time a changeset is allowed to be open for.
   MAX_TIME_OPEN = 1.day
 
   # maximum time a changeset is allowed to be open for.
   MAX_TIME_OPEN = 1.day


@@ -43,30 +73,26 @@ class Changeset < ActiveRecord::Base
     # note that this may not be a hard limit - due to timing changes and
     # concurrency it is possible that some changesets may be slightly
     # longer than strictly allowed or have slightly more changes in them.
     # note that this may not be a hard limit - due to timing changes and
     # concurrency it is possible that some changesets may be slightly
     # longer than strictly allowed or have slightly more changes in them.

-    return ((closed_at > Time.now.getutc) and (num_changes <= MAX_ELEMENTS))
+    ((closed_at > Time.now.getutc) && (num_changes <= MAX_ELEMENTS))

   end
 
   def set_closed_time_now
   end
 
   def set_closed_time_now

-    if is_open?
-      self.closed_at = Time.now.getutc
-    end
+    self.closed_at = Time.now.getutc if is_open?

   end
 
   end
 

-  def self.from_xml(xml, create=false)
-    begin
-      p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR)
-      doc = p.parse
+  def self.from_xml(xml, create = false)
+    p = XML::Parser.string(xml, :options => XML::Parser::Options::NOERROR)
+    doc = p.parse

 
 

-      doc.find('//osm/changeset').each do |pt|
-        return Changeset.from_xml_node(pt, create)
-      end
-      raise OSM::APIBadXMLError.new("changeset", xml, "XML doesn't contain an osm/changeset element.")
-    rescue LibXML::XML::Error, ArgumentError => ex
-      raise OSM::APIBadXMLError.new("changeset", xml, ex.message)
+    doc.find("//osm/changeset").each do |pt|
+      return Changeset.from_xml_node(pt, create)

     end
     end

+    raise OSM::APIBadXMLError.new("changeset", xml, "XML doesn't contain an osm/changeset element.")
+  rescue LibXML::XML::Error, ArgumentError => e
+    raise OSM::APIBadXMLError.new("changeset", xml, e.message)

   end
 
   end
 

-  def self.from_xml_node(pt, create=false)
+  def self.from_xml_node(pt, create = false)

     cs = Changeset.new
     if create
       cs.created_at = Time.now.getutc
     cs = Changeset.new
     if create
       cs.created_at = Time.now.getutc


@@ -77,95 +103,62 @@ class Changeset < ActiveRecord::Base
       cs.num_changes = 0
     end
 
       cs.num_changes = 0
     end
 

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

     end
 
     end
 

-    return cs
+    cs

   end
 
   ##
   # returns the bounding box of the changeset. it is possible that some
   # or all of the values will be nil, indicating that they are undefined.
   def bbox
   end
 
   ##
   # returns the bounding box of the changeset. it is possible that some
   # or all of the values will be nil, indicating that they are undefined.
   def bbox

-    @bbox ||= [ min_lon, min_lat, max_lon, max_lat ]
+    @bbox ||= BoundingBox.new(min_lon, min_lat, max_lon, max_lat)

   end
 
   def has_valid_bbox?
   end
 
   def has_valid_bbox?

-    not bbox.include? nil
+    bbox.complete?

   end
 
   ##
   end
 
   ##

-  # returns area of the changset bbox as a rough comparitive quantity for use of changset displays
-  def area
-     if has_valid_bbox?
-       (max_lon - min_lon) * (max_lat - min_lat)
-     else
-       0
-     end
-  end
+  # expand the bounding box to include the given bounding box.
+  def update_bbox!(bbox_update)
+    bbox.expand!(bbox_update)

 
 

-  ##
-  # expand the bounding box to include the given bounding box. also,
-  # expand a little bit more in the direction of the expansion, so that
-  # further expansions may be unnecessary. this is an optimisation
-  # suggested on the wiki page by kleptog.
-  def update_bbox!(array)
-    # ensure that bbox is cached and has no nils in it. if there are any
-    # nils, just use the bounding box update to write over them.
-    @bbox = bbox.zip(array).collect { |a, b| a.nil? ? b : a }
-
-    # only try to update the bbox if there is a value for every coordinate
-    # which there will be from the previous line as long as both array and
-    # bbox are all non-nil. 
-    if has_valid_bbox? and array.all?
-      # FIXME - this looks nasty and violates DRY... is there any prettier
-      # way to do this?
-      @bbox[0] = [-180 * GeoRecord::SCALE, array[0] + EXPAND * (@bbox[0] - @bbox[2])].max if array[0] < @bbox[0]
-      @bbox[1] = [ -90 * GeoRecord::SCALE, array[1] + EXPAND * (@bbox[1] - @bbox[3])].max if array[1] < @bbox[1]
-      @bbox[2] = [ 180 * GeoRecord::SCALE, array[2] + EXPAND * (@bbox[2] - @bbox[0])].min if array[2] > @bbox[2]
-      @bbox[3] = [  90 * GeoRecord::SCALE, array[3] + EXPAND * (@bbox[3] - @bbox[1])].min if array[3] > @bbox[3]
-      
-      # update active record. rails 2.1's dirty handling should take care of
-      # whether this object needs saving or not.
-      self.min_lon, self.min_lat, self.max_lon, self.max_lat = @bbox
-    end
+    # update active record. rails 2.1's dirty handling should take care of
+    # whether this object needs saving or not.
+    self.min_lon, self.min_lat, self.max_lon, self.max_lat = @bbox.to_a if bbox.complete?

   end
 
   ##
   # the number of elements is also passed in so that we can ensure that
   end
 
   ##
   # the number of elements is also passed in so that we can ensure that

-  # a single changeset doesn't contain too many elements. this, of course,
-  # destroys the optimisation described in the bbox method above.
+  # a single changeset doesn't contain too many elements.

   def add_changes!(elements)
     self.num_changes += elements
   end
 
   def add_changes!(elements)
     self.num_changes += elements
   end
 

-  def tags_as_hash
-    return tags
-  end
-

   def tags
     unless @tags
       @tags = {}
   def tags
     unless @tags
       @tags = {}

-      self.changeset_tags.each do |tag|
+      changeset_tags.each do |tag|

         @tags[tag.k] = tag.v
       end
     end
     @tags
   end
 
         @tags[tag.k] = tag.v
       end
     end
     @tags
   end
 

-  def tags=(t)
-    @tags = t
-  end
+  attr_writer :tags

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

-    @tags = Hash.new unless @tags
+    @tags ||= {}

 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.
 
     # duplicate tags are now forbidden, so we can't allow values
     # in the hash to be overwritten.

-    raise OSM::APIDuplicateTagsError.new("changeset", self.id, k) if @tags.include? k
+    raise OSM::APIDuplicateTagsError.new("changeset", id, k) if @tags.include? k

 
     @tags[k] = v
   end
 
     @tags[k] = v
   end


@@ -174,14 +167,14 @@ class Changeset < ActiveRecord::Base
     # do the changeset update and the changeset tags update in the
     # same transaction to ensure consistency.
     Changeset.transaction do
     # do the changeset update and the changeset tags update in the
     # same transaction to ensure consistency.
     Changeset.transaction do

-      self.save!
+      save!

 
       tags = self.tags
 
       tags = self.tags

-      ChangesetTag.delete_all(:changeset_id => self.id)
+      ChangesetTag.where(:changeset_id => id).delete_all

 
 

-      tags.each do |k,v|
+      tags.each do |k, v|

         tag = ChangesetTag.new
         tag = ChangesetTag.new

-        tag.changeset_id = self.id
+        tag.changeset_id = id

         tag.k = k
         tag.v = v
         tag.save!
         tag.k = k
         tag.v = v
         tag.save!


@@ -194,59 +187,13 @@ class Changeset < ActiveRecord::Base
   # that would make it more than 24h long, in which case clip to
   # 24h, as this has been decided is a reasonable time limit.
   def update_closed_at
   # that would make it more than 24h long, in which case clip to
   # 24h, as this has been decided is a reasonable time limit.
   def update_closed_at

-    if self.is_open?
-      if (closed_at - created_at) > (MAX_TIME_OPEN - IDLE_TIMEOUT)
-        self.closed_at = created_at + MAX_TIME_OPEN
-      else
-        self.closed_at = Time.now.getutc + IDLE_TIMEOUT
-      end
-    end
-  end
-
-  def to_xml
-    doc = OSM::API.new.get_xml_doc
-    doc.root << to_xml_node()
-    return doc
-  end
-
-  def to_xml_node(user_display_name_cache = nil)
-    el1 = XML::Node.new 'changeset'
-    el1['id'] = self.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.user_id)
-      # use the cache if available
-    elsif self.user.data_public?
-      user_display_name_cache[self.user_id] = self.user.display_name
-    else
-      user_display_name_cache[self.user_id] = nil
-    end
-
-    el1['user'] = user_display_name_cache[self.user_id] unless user_display_name_cache[self.user_id].nil?
-    el1['uid'] = self.user_id.to_s if self.user.data_public?
-
-    self.tags.each do |k,v|
-      el2 = XML::Node.new('tag')
-      el2['k'] = k.to_s
-      el2['v'] = v.to_s
-      el1 << el2
+    if is_open?
+      self.closed_at = if (closed_at - created_at) > (MAX_TIME_OPEN - IDLE_TIMEOUT)
+                         created_at + MAX_TIME_OPEN
+                       else
+                         Time.now.getutc + IDLE_TIMEOUT
+                       end

     end
     end

-
-    el1['created_at'] = self.created_at.xmlschema
-    el1['closed_at'] = self.closed_at.xmlschema unless is_open?
-    el1['open'] = is_open?.to_s
-
-    el1['min_lon'] = (bbox[0].to_f / GeoRecord::SCALE).to_s unless bbox[0].nil?
-    el1['min_lat'] = (bbox[1].to_f / GeoRecord::SCALE).to_s unless bbox[1].nil?
-    el1['max_lon'] = (bbox[2].to_f / GeoRecord::SCALE).to_s unless bbox[2].nil?
-    el1['max_lat'] = (bbox[3].to_f / GeoRecord::SCALE).to_s unless bbox[3].nil?
-
-    # NOTE: changesets don't include the XML of the changes within them,
-    # they are just structures for tagging. to get the osmChange of a
-    # changeset, see the download method of the controller.
-
-    return el1

   end
 
   ##
   end
 
   ##


@@ -255,14 +202,10 @@ class Changeset < ActiveRecord::Base
   # bounding box, only the tags of the changeset.
   def update_from(other, user)
     # ensure that only the user who opened the changeset may modify it.
   # bounding box, only the tags of the changeset.
   def update_from(other, user)
     # ensure that only the user who opened the changeset may modify it.

-    unless user.id == self.user_id
-      raise OSM::APIUserChangesetMismatchError.new
-    end
+    raise OSM::APIUserChangesetMismatchError unless user.id == user_id

 
     # can't change a closed changeset
 
     # can't change a closed changeset

-    unless is_open?
-      raise OSM::APIChangesetAlreadyClosedError.new(self)
-    end
+    raise OSM::APIChangesetAlreadyClosedError, self unless is_open?

 
     # copy the other's tags
     self.tags = other.tags
 
     # copy the other's tags
     self.tags = other.tags