Merge branch 'master' into openstreetbugs

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

diff --git a/app/models/note.rb b/app/models/note.rb
index e36884ec16d32bd3bb6f1f59f6385b5d9fdd9c76..892ada1aa8a5163d474bbde166ca4b9251f4d1fa 100644 (file)
--- a/app/models/note.rb
+++ b/app/models/note.rb
@@ -4,7 +4,7 @@ class Note < ActiveRecord::Base
   has_many :comments, :class_name => "NoteComment",
                       :foreign_key => :note_id,
                       :order => :created_at,
-                      :conditions => "visible = true AND body IS NOT NULL"
+                      :conditions => { :visible => true }
 
   validates_presence_of :id, :on => :update
   validates_uniqueness_of :id
@@ -12,21 +12,26 @@ 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?
+  # Sanity check the latitude and longitude and add an error if it's broken
+  def validate_position
+    errors.add_to_base("Note is not in the world") unless in_world?
+  end
 
-    return note
+  # Fill in default values for new notes
+  def after_initialize
+    self.status = "open" unless self.attribute_present?(:status)
   end
 
+  # Close a note
   def close
     self.status = "closed"
     self.closed_at = Time.now.getutc
-
     self.save
   end
 
+  # Return a flattened version of the comments for a note
   def flatten_comment(separator_char, upto_timestamp = :nil)
     resp = ""
     comment_no = 1
@@ -43,23 +48,41 @@ class Note < ActiveRecord::Base
     return resp
   end
 
-  def visible
+  # Check if a note is visible
+  def visible?
     return status != "hidden"
   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
 
+  # Return the author id, derived from the first comment
   def author_id
     self.comments.first.author_id
   end
 
+  # Return the author name, derived from the first comment
   def author_name
     self.comments.first.author_name
   end
+
+  # Custom JSON output routine for notes
+  def to_json(options = {})
+    super options.reverse_merge(
+      :methods => [ :lat, :lon ], 
+      :only => [ :id, :status, :created_at ],
+      :include => {
+         :comments => {
+           :only => [ :event, :author_name, :created_at, :body ]
+         }
+      }
+    )
+  end
 end