Simplify a number of object model methods
[rails.git] / app / models / note.rb
index e36884ec16d32bd3bb6f1f59f6385b5d9fdd9c76..27357e58a86830620d6f5224f9a32a7ab7c000ae 100644 (file)
@@ -1,10 +1,7 @@
 class Note < ActiveRecord::Base
   include GeoRecord
 
-  has_many :comments, :class_name => "NoteComment",
-                      :foreign_key => :note_id,
-                      :order => :created_at,
-                      :conditions => "visible = true AND body IS NOT NULL"
+  has_many :comments, -> { where(:visible => true).order(:created_at) }, :class_name => "NoteComment", :foreign_key => :note_id
 
   validates_presence_of :id, :on => :update
   validates_uniqueness_of :id
@@ -12,54 +9,56 @@ class Note < ActiveRecord::Base
   validates_numericality_of :longitude, :only_integer => true
   validates_presence_of :closed_at if :status == "closed"
   validates_inclusion_of :status, :in => ["open", "closed", "hidden"]
+  validate :validate_position
 
-  def self.create_bug(lat, lon)
-    note = Note.new(:lat => lat, :lon => lon, :status => "open")
-    raise OSM::APIBadUserInput.new("The note is outside this world") unless note.in_world?
+  scope :visible, -> { where("status != 'hidden'") }
+  scope :invisible, -> { where("status = 'hidden'") }
 
-    return note
+  after_initialize :set_defaults
+
+  # Sanity check the latitude and longitude and add an error if it's broken
+  def validate_position
+    errors.add(:base, "Note is not in the world") unless in_world?
   end
 
+  # Close a note
   def close
     self.status = "closed"
     self.closed_at = Time.now.getutc
-
     self.save
   end
 
-  def flatten_comment(separator_char, upto_timestamp = :nil)
-    resp = ""
-    comment_no = 1
-    self.comments.each do |comment|
-      next if upto_timestamp != :nil and comment.created_at > upto_timestamp
-      resp += (comment_no == 1 ? "" : separator_char)
-      resp += comment.body if comment.body
-      resp += " [ " 
-      resp += comment.author_name if comment.author_name
-      resp += " " + comment.created_at.to_s + " ]"
-      comment_no += 1
-    end
+  # Reopen a note
+  def reopen
+    self.status = "open"
+    self.closed_at = nil
+    self.save
+  end
 
-    return resp
+  # Check if a note is visible
+  def visible?
+    status != "hidden"
   end
 
-  def visible
-    return status != "hidden"
+  # Check if a note is closed
+  def closed?
+    not closed_at.nil?
   end
 
+  # Return the author object, derived from the first comment
   def author
     self.comments.first.author
   end
 
+  # Return the author IP address, derived from the first comment
   def author_ip
     self.comments.first.author_ip
   end
 
-  def author_id
-    self.comments.first.author_id
-  end
+private
 
-  def author_name
-    self.comments.first.author_name
+  # Fill in default values for new notes
+  def set_defaults
+    self.status = "open" unless self.attribute_present?(:status)
   end
 end