Merge remote-tracking branch 'upstream/pull/1987'

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

diff --git a/app/models/user_block.rb b/app/models/user_block.rb
index f8c05c92ca9e9b5b52e509336201f79142e8fc34..9f32862af52546bfbf4542599d38916af0ca76e8 100644 (file)
--- a/app/models/user_block.rb
+++ b/app/models/user_block.rb
@@ -1,35 +1,83 @@
+# == Schema Information
+#
+# Table name: user_blocks
+#
+#  id            :integer          not null, primary key
+#  user_id       :integer          not null
+#  creator_id    :integer          not null
+#  reason        :text             not null
+#  ends_at       :datetime         not null
+#  needs_view    :boolean          default(FALSE), not null
+#  revoker_id    :integer
+#  created_at    :datetime
+#  updated_at    :datetime
+#  reason_format :enum             default("markdown"), not null
+#
+# Indexes
+#
+#  index_user_blocks_on_user_id  (user_id)
+#
+# Foreign Keys
+#
+#  user_blocks_moderator_id_fkey  (creator_id => users.id)
+#  user_blocks_revoker_id_fkey    (revoker_id => users.id)
+#  user_blocks_user_id_fkey       (user_id => users.id)
+#
+
 class UserBlock < ActiveRecord::Base
   validate :moderator_permissions
 
   belongs_to :user, :class_name => "User", :foreign_key => :user_id
   belongs_to :creator, :class_name => "User", :foreign_key => :creator_id
   belongs_to :revoker, :class_name => "User", :foreign_key => :revoker_id
-  
+
   PERIODS = USER_BLOCK_PERIODS
 
+  ##
+  # scope to match active blocks
+  def self.active
+    where("needs_view or ends_at > ?", Time.now.getutc)
+  end
+
+  ##
+  # return a renderable version of the reason text.
+  def reason
+    RichText.new(self[:reason_format], self[:reason])
+  end
+
   ##
   # returns true if the block is currently active (i.e: the user can't
   # use the API).
   def active?
-    needs_view or ends_at > Time.now.getutc
+    needs_view || ends_at > Time.now.getutc
+  end
+
+  ##
+  # returns true if the block is a "zero hour" block
+  def zero_hour?
+    # if the times differ more than 1 minute we probably have more important issues
+    needs_view && (ends_at.to_i - updated_at.to_i) < 60
   end
 
   ##
   # revokes the block, allowing the user to use the API again. the argument
   # is the user object who is revoking the ban.
   def revoke!(revoker)
-    update_attributes({ :ends_at => Time.now.getutc(),
-                        :revoker_id => revoker.id,
-                        :needs_view => false })
+    update(
+      :ends_at => Time.now.getutc,
+      :revoker_id => revoker.id,
+      :needs_view => false
+    )
   end
 
   private
+
   ##
   # validate that only moderators are allowed to change the
   # block. this should be caught and dealt with in the controller,
   # but i've also included it here just in case.
   def moderator_permissions
-    errors.add(:base, I18n.t('user_block.model.non_moderator_update')) if creator_id_changed? and !creator.moderator?
-    errors.add(:base, I18n.t('user_block.model.non_moderator_revoke')) unless revoker_id.nil? or revoker.moderator?
+    errors.add(:base, I18n.t("user_block.model.non_moderator_update")) if creator_id_changed? && !creator.moderator?
+    errors.add(:base, I18n.t("user_block.model.non_moderator_revoke")) unless revoker_id.nil? || revoker.moderator?
   end
 end