]> git.openstreetmap.org Git - rails.git/blob - app/models/note.rb
Improve formatting of note descriptions in GPX and RSS responses
[rails.git] / app / models / note.rb
1 class Note < ActiveRecord::Base
2   include GeoRecord
3
4   has_many :comments, :class_name => "NoteComment",
5                       :foreign_key => :note_id,
6                       :order => :created_at,
7                       :conditions => { :visible => true }
8
9   validates_presence_of :id, :on => :update
10   validates_uniqueness_of :id
11   validates_numericality_of :latitude, :only_integer => true
12   validates_numericality_of :longitude, :only_integer => true
13   validates_presence_of :closed_at if :status == "closed"
14   validates_inclusion_of :status, :in => ["open", "closed", "hidden"]
15   validate :validate_position
16
17   # Sanity check the latitude and longitude and add an error if it's broken
18   def validate_position
19     errors.add_to_base("Note is not in the world") unless in_world?
20   end
21
22   # Fill in default values for new notes
23   def after_initialize
24     self.status = "open" unless self.attribute_present?(:status)
25   end
26
27   # Close a note
28   def close
29     self.status = "closed"
30     self.closed_at = Time.now.getutc
31     self.save
32   end
33
34   # Return a flattened version of the comments for a note
35   def flatten_comment(separator_char, upto_timestamp = :nil)
36     resp = ""
37     comment_no = 1
38     self.comments.each do |comment|
39       next if upto_timestamp != :nil and comment.created_at > upto_timestamp
40       resp += (comment_no == 1 ? "" : separator_char)
41       resp += comment.body if comment.body
42       resp += " [ " 
43       resp += comment.author_name if comment.author_name
44       resp += " " + comment.created_at.to_s + " ]"
45       comment_no += 1
46     end
47
48     return resp
49   end
50
51   # Check if a note is visible
52   def visible?
53     return status != "hidden"
54   end
55
56   # Return the author object, derived from the first comment
57   def author
58     self.comments.first.author
59   end
60
61   # Return the author IP address, derived from the first comment
62   def author_ip
63     self.comments.first.author_ip
64   end
65
66   # Return the author id, derived from the first comment
67   def author_id
68     self.comments.first.author_id
69   end
70
71   # Return the author name, derived from the first comment
72   def author_name
73     self.comments.first.author_name
74   end
75
76   # Custom JSON output routine for notes
77   def to_json(options = {})
78     super options.reverse_merge(
79       :methods => [ :lat, :lon ], 
80       :only => [ :id, :status, :created_at ],
81       :include => {
82          :comments => {
83            :only => [ :event, :author_name, :created_at, :body ]
84          }
85       }
86     )
87   end
88 end