Fix more rubocop style issues

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

diff --git a/app/models/trace.rb b/app/models/trace.rb
index a0ec22deeeddef4555d8a4b08eb326bc224fdcc1..157b63f691e05f3105a3db536a50fc8419ecde24 100644 (file)
--- a/app/models/trace.rb
+++ b/app/models/trace.rb
@@ -1,14 +1,22 @@
 class Trace < ActiveRecord::Base
 class Trace < ActiveRecord::Base

-  set_table_name 'gpx_files'
+  self.table_name = "gpx_files"
+
+  belongs_to :user, :counter_cache => true
+  has_many :tags, :class_name => "Tracetag", :foreign_key => "gpx_id", :dependent => :delete_all
+  has_many :points, :class_name => "Tracepoint", :foreign_key => "gpx_id", :dependent => :delete_all
+
+  scope :visible, -> { where(:visible => true) }
+  scope :visible_to, ->(u) { visible.where("visibility IN ('public', 'identifiable') OR user_id = ?", u) }
+  scope :visible_to_all, -> { where(:visibility => %w(public identifiable)) }
+  scope :tagged, ->(t) { joins(:tags).where(:gpx_file_tags => { :tag => t }) }

 
   validates_presence_of :user_id, :name, :timestamp
   validates_presence_of :description, :on => :create
 
   validates_presence_of :user_id, :name, :timestamp
   validates_presence_of :description, :on => :create

-#  validates_numericality_of :latitude, :longitude
-  validates_inclusion_of :public, :inserted, :in => [ true, false]
-  
-  belongs_to :user
-  has_many :tags, :class_name => 'Tracetag', :foreign_key => 'gpx_id', :dependent => :delete_all
-  has_many :points, :class_name => 'Tracepoint', :foreign_key => 'gpx_id', :dependent => :delete_all
+  validates_length_of :name, :maximum => 255
+  validates_length_of :description, :maximum => 255
+  #  validates_numericality_of :latitude, :longitude
+  validates_inclusion_of :inserted, :in => [true, false]
+  validates_inclusion_of :visibility, :in => %w(private public trackable identifiable)

 
   def destroy
     super
 
   def destroy
     super


@@ -18,24 +26,45 @@ class Trace < ActiveRecord::Base
   end
 
   def tagstring
   end
 
   def tagstring

-    return tags.collect {|tt| tt.tag}.join(" ")
+    tags.collect(&:tag).join(", ")

   end
 
   def tagstring=(s)
   end
 
   def tagstring=(s)

-    self.tags = s.split().collect {|tag|
-      tt = Tracetag.new
-      tt.tag = tag
-      tt
-    }
-  end
-  
-  def large_picture= (data)
+    if s.include? ","
+      self.tags = s.split(/\s*,\s*/).select { |tag| tag !~ /^\s*$/ }.collect {|tag|
+        tt = Tracetag.new
+        tt.tag = tag
+        tt
+      }
+    else
+      # do as before for backwards compatibility:
+      self.tags = s.split.collect {|tag|
+        tt = Tracetag.new
+        tt.tag = tag
+        tt
+      }
+    end
+  end
+
+  def public?
+    visibility == "public" || visibility == "identifiable"
+  end
+
+  def trackable?
+    visibility == "trackable" || visibility == "identifiable"
+  end
+
+  def identifiable?
+    visibility == "identifiable"
+  end
+
+  def large_picture=(data)

     f = File.new(large_picture_name, "wb")
     f.syswrite(data)
     f.close
   end
     f = File.new(large_picture_name, "wb")
     f.syswrite(data)
     f.close
   end

-  
-  def icon_picture= (data)
+
+  def icon_picture=(data)

     f = File.new(icon_picture_name, "wb")
     f.syswrite(data)
     f.close
     f = File.new(icon_picture_name, "wb")
     f.syswrite(data)
     f.close


@@ -49,7 +78,7 @@ class Trace < ActiveRecord::Base
     f.close
     data
   end
     f.close
     data
   end

-  
+

   def icon_picture
     f = File.new(icon_picture_name, "rb")
     logger.info "icon picture file: '#{f.path}'"
   def icon_picture
     f = File.new(icon_picture_name, "rb")
     logger.info "icon picture file: '#{f.path}'"


@@ -57,19 +86,17 @@ class Trace < ActiveRecord::Base
     f.close
     data
   end
     f.close
     data
   end

-  
-  # FIXME change to permanent filestore area
+

   def large_picture_name
   def large_picture_name

-    "/home/osm/icons/#{id}.gif"
+    "#{GPX_IMAGE_DIR}/#{id}.gif"

   end
 
   end
 

-  # FIXME change to permanent filestore area

   def icon_picture_name
   def icon_picture_name

-    "/home/osm/icons/#{id}_icon.gif"
+    "#{GPX_IMAGE_DIR}/#{id}_icon.gif"

   end
 
   def trace_name
   end
 
   def trace_name

-    "/home/osm/gpx/#{id}.gpx"
+    "#{GPX_TRACE_DIR}/#{id}.gpx"

   end
 
   def mime_type
   end
 
   def mime_type


@@ -78,17 +105,17 @@ class Trace < ActiveRecord::Base
     bzipped = filetype =~ /bzip2 compressed/
     zipped = filetype =~ /Zip archive/
 
     bzipped = filetype =~ /bzip2 compressed/
     zipped = filetype =~ /Zip archive/
 

-    if gzipped then
+    if gzipped

       mimetype = "application/x-gzip"
       mimetype = "application/x-gzip"

-    elsif bzipped then
+    elsif bzipped

       mimetype = "application/x-bzip2"
     elsif zipped
       mimetype = "application/x-zip"
     else
       mimetype = "application/x-bzip2"
     elsif zipped
       mimetype = "application/x-zip"
     else

-      mimetype = "text/xml"
+      mimetype = "application/gpx+xml"

     end
 
     end
 

-    return mimetype
+    mimetype

   end
 
   def extension_name
   end
 
   def extension_name


@@ -98,9 +125,9 @@ class Trace < ActiveRecord::Base
     zipped = filetype =~ /Zip archive/
     tarred = filetype =~ /tar archive/
 
     zipped = filetype =~ /Zip archive/
     tarred = filetype =~ /tar archive/
 

-    if tarred and gzipped then
+    if tarred && gzipped

       extension = ".tar.gz"
       extension = ".tar.gz"

-    elsif tarred and bzipped then
+    elsif tarred && bzipped

       extension = ".tar.bz2"
     elsif tarred
       extension = ".tar"
       extension = ".tar.bz2"
     elsif tarred
       extension = ".tar"


@@ -114,42 +141,97 @@ class Trace < ActiveRecord::Base
       extension = ".gpx"
     end
 
       extension = ".gpx"
     end
 

-    return extension
+    extension

   end
 
   def to_xml
     doc = OSM::API.new.get_xml_doc
   end
 
   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
   end
 
   def to_xml_node

-    el1 = XML::Node.new 'gpx_file'
-    el1['id'] = self.id.to_s
-    el1['name'] = self.name.to_s
-    el1['lat'] = self.latitude.to_s
-    el1['lon'] = self.longitude.to_s
-    el1['user'] = self.user.display_name
-    el1['public'] = self.public.to_s
-    el1['pending'] = (!self.inserted).to_s
-    el1['timestamp'] = self.timestamp.xmlschema
-    return el1
+    el1 = XML::Node.new "gpx_file"
+    el1["id"] = id.to_s
+    el1["name"] = name.to_s
+    el1["lat"] = latitude.to_s if inserted
+    el1["lon"] = longitude.to_s if inserted
+    el1["user"] = user.display_name
+    el1["visibility"] = visibility
+    el1["pending"] = (!inserted).to_s
+    el1["timestamp"] = timestamp.xmlschema
+
+    el2 = XML::Node.new "description"
+    el2 << description
+    el1 << el2
+
+    tags.each do |tag|
+      el2 = XML::Node.new("tag")
+      el2 << tag.tag
+      el1 << el2
+    end
+
+    el1
+  end
+
+  # Read in xml as text and return it's Node object representation
+  def self.from_xml(xml, create = false)
+    p = XML::Parser.string(xml)
+    doc = p.parse
+
+    doc.find("//osm/gpx_file").each do |pt|
+      return Trace.from_xml_node(pt, create)
+    end
+
+    fail OSM::APIBadXMLError.new("trace", xml, "XML doesn't contain an osm/gpx_file element.")
+  rescue LibXML::XML::Error, ArgumentError => ex
+    raise OSM::APIBadXMLError.new("trace", xml, ex.message)
+  end
+
+  def self.from_xml_node(pt, create = false)
+    trace = Trace.new
+
+    fail OSM::APIBadXMLError.new("trace", pt, "visibility missing") if pt["visibility"].nil?
+    trace.visibility = pt["visibility"]
+
+    unless create
+      fail OSM::APIBadXMLError.new("trace", pt, "ID is required when updating.") if pt["id"].nil?
+      trace.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 trace cannot be zero when updating.") if trace.id == 0
+    end
+
+    # 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
+    trace.visible = true
+
+    description = pt.find("description").first
+    fail OSM::APIBadXMLError.new("trace", pt, "description missing") if description.nil?
+    trace.description = description.content
+
+    pt.find("tag").each do |tag|
+      trace.tags.build(:tag => tag.content)
+    end
+
+    trace

   end
 
   def xml_file
   end
 
   def xml_file

-    # TODO *nix specific, could do to work on windows... would be functionally inferior though - check for '.gz'
+    # TODO: *nix specific, could do to work on windows... would be functionally inferior though - check for '.gz'

     filetype = `/usr/bin/file -bz #{trace_name}`.chomp
     gzipped = filetype =~ /gzip compressed/
     bzipped = filetype =~ /bzip2 compressed/
     zipped = filetype =~ /Zip archive/
     tarred = filetype =~ /tar archive/
 
     filetype = `/usr/bin/file -bz #{trace_name}`.chomp
     gzipped = filetype =~ /gzip compressed/
     bzipped = filetype =~ /bzip2 compressed/
     zipped = filetype =~ /Zip archive/
     tarred = filetype =~ /tar archive/
 

-    if gzipped or bzipped or zipped or tarred then
-      tmpfile = Tempfile.new("trace.#{id}");
+    if gzipped || bzipped || zipped || tarred
+      tmpfile = Tempfile.new("trace.#{id}")

 
 

-      if tarred and gzipped then
+      if tarred && gzipped

         system("tar -zxOf #{trace_name} > #{tmpfile.path}")
         system("tar -zxOf #{trace_name} > #{tmpfile.path}")

-      elsif tarred and bzipped then
+      elsif tarred && bzipped

         system("tar -jxOf #{trace_name} > #{tmpfile.path}")
       elsif tarred
         system("tar -xOf #{trace_name} > #{tmpfile.path}")
         system("tar -jxOf #{trace_name} > #{tmpfile.path}")
       elsif tarred
         system("tar -xOf #{trace_name} > #{tmpfile.path}")


@@ -168,13 +250,13 @@ class Trace < ActiveRecord::Base
       file = File.open(trace_name)
     end
 
       file = File.open(trace_name)
     end
 

-    return file
+    file

   end
 
   def import
     logger.info("GPX Import importing #{name} (#{id}) from #{user.email}")
 
   end
 
   def import
     logger.info("GPX Import importing #{name} (#{id}) from #{user.email}")
 

-    gpx = GPX::File.new(self.xml_file)
+    gpx = GPX::File.new(xml_file)

 
     f_lat = 0
     f_lon = 0
 
     f_lat = 0
     f_lon = 0


@@ -183,8 +265,8 @@ class Trace < ActiveRecord::Base
     # If there are any existing points for this trace then delete
     # them - we check for existing points first to avoid locking
     # the table in the common case where there aren't any.
     # If there are any existing points for this trace then delete
     # them - we check for existing points first to avoid locking
     # the table in the common case where there aren't any.

-    if Tracepoint.find(:first, :conditions => ['gpx_id = ?', self.id])
-      Tracepoint.delete_all(['gpx_id = ?', self.id])
+    if Tracepoint.where(:gpx_id => id).exists?
+      Tracepoint.delete_all(:gpx_id => id)

     end
 
     gpx.points do |point|
     end
 
     gpx.points do |point|


@@ -205,10 +287,10 @@ class Trace < ActiveRecord::Base
     end
 
     if gpx.actual_points > 0
     end
 
     if gpx.actual_points > 0

-      max_lat = Tracepoint.maximum('latitude', :conditions => ['gpx_id = ?', id])
-      min_lat = Tracepoint.minimum('latitude', :conditions => ['gpx_id = ?', id])
-      max_lon = Tracepoint.maximum('longitude', :conditions => ['gpx_id = ?', id])
-      min_lon = Tracepoint.minimum('longitude', :conditions => ['gpx_id = ?', id])
+      max_lat = Tracepoint.where(:gpx_id => id).maximum(:latitude)
+      min_lat = Tracepoint.where(:gpx_id => id).minimum(:latitude)
+      max_lon = Tracepoint.where(:gpx_id => id).maximum(:longitude)
+      min_lon = Tracepoint.where(:gpx_id => id).minimum(:longitude)

 
       max_lat = max_lat.to_f / 10000000
       min_lat = min_lat.to_f / 10000000
 
       max_lat = max_lat.to_f / 10000000
       min_lat = min_lat.to_f / 10000000


@@ -226,6 +308,6 @@ class Trace < ActiveRecord::Base
 
     logger.info "done trace #{id}"
 
 
     logger.info "done trace #{id}"
 

-    return gpx
+    gpx

   end
 end
   end
 end