Rubocop: consistent access modifier indentation

This is a tough call, both the Rails style (with private/protected) methods indented one level under the keyword, and other places using the standard ruby don't modify identation for access level. I think this strikes a good balance while still being readable. s

Rubocop: consistent access modifier indentation
This is a tough call, both the Rails style (with private/protected) methods indented one level under the keyword, and other places using the standard ruby don't modify identation for access level. I think this strikes a good balance while still being readable. s
Laust Rud Jacobsen
1 parent 1c7cb82a
Showing 31 changed files with 112 additions and 123 deletions Show diff stats
.rubocop.yml
app/controllers/api/v1/stats_controller.rb
app/controllers/application_controller.rb
app/controllers/apps_controller.rb
app/controllers/comments_controller.rb
app/controllers/deploys_controller.rb
app/controllers/notices_controller.rb
app/controllers/problems_controller.rb
app/controllers/users/omniauth_callbacks_controller.rb
app/controllers/users_controller.rb
app/decorators/backtrace_line_decorator.rb
app/decorators/issue_tracker_field_decorator.rb
app/helpers/application_helper.rb
app/helpers/apps_helper.rb
app/interactors/problem_destroy.rb
app/interactors/resolved_problem_clearer.rb
app/mailers/mailer.rb
app/models/app.rb
app/models/backtrace.rb
app/models/comment.rb
@@ -14,3 +14,14 @@ Style/EmptyLineBetweenDefs:
 Style/ExtraSpacing:
   AllowForAlignment: true
+
+Style/IndentationConsistency:
+  # `rails` style:
+  # prescribes that in classes and modules the `protected` and `private`
+  # modifier keywords shall be indented the same as public methods and that
+  # protected and private members shall be indented one step more than the
+  # modifiers.
+   EnforcedStyle: rails
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
@@ -23,9 +23,7 @@ class Api::V1::StatsController &lt; ApplicationController
     end
   end
-  protected
-
-  def require_api_key_or_authenticate_user!
+  protected def require_api_key_or_authenticate_user!
     if params[:api_key].present?
       if (@app = App.where(:api_key => params[:api_key]).first)
         return true
@@ -17,7 +17,7 @@ class ApplicationController &lt; ActionController::Base
     strategy StrongParametersWithEagerAttributesStrategy
   end
-  protected
+protected
   ##
   # Check if the current_user is admin or not and redirect to root url if not
@@ -90,18 +90,18 @@ class AppsController &lt; ApplicationController
     redirect_to edit_app_path(app)
   end
-  protected
-
-    def initialize_subclassed_notification_service
-      # set the app's notification service
-      if params[:app][:notification_service_attributes] && (notification_type = params[:app][:notification_service_attributes][:type])
-        available_notification_classes = [NotificationService] + NotificationService.subclasses
-        notification_class = available_notification_classes.detect{|c| c.name == notification_type}
-        if notification_class.present?
-          app.notification_service = notification_class.new(params[:app][:notification_service_attributes])
-        end
+protected
+
+  def initialize_subclassed_notification_service
+    # set the app's notification service
+    if params[:app][:notification_service_attributes] && (notification_type = params[:app][:notification_service_attributes][:type])
+      available_notification_classes = [NotificationService] + NotificationService.subclasses
+      notification_class = available_notification_classes.detect{|c| c.name == notification_type}
+      if notification_class.present?
+        app.notification_service = notification_class.new(params[:app][:notification_service_attributes])
       end
     end
+  end
     def plug_params(app)
       app.watchers.build if app.watchers.none?
@@ -141,9 +141,7 @@ class AppsController &lt; ApplicationController
       end
     end
-  private
-
-    def app_params
-      params.require(:app).permit!
-    end
+  private def app_params
+    params.require(:app).permit!
+  end
 end
@@ -24,11 +24,11 @@ class CommentsController &lt; ApplicationController
     redirect_to app_problem_path(@app, @problem)
   end
-  protected
+protected
-    def find_app
-      @app = App.find(params[:app_id])
-    end
+  def find_app
+    @app = App.find(params[:app_id])
+  end
     def find_problem
       @problem = @app.problems.find(params[:problem_id])
@@ -16,19 +16,19 @@ class DeploysController &lt; ApplicationController
       page(params[:page]).per(10)
   end
-  private
+private
-    def default_deploy
-      if params[:deploy]
-        {
-          :username     => params[:deploy][:local_username],
-          :environment  => params[:deploy][:rails_env],
-          :repository   => params[:deploy][:scm_repository],
-          :revision     => params[:deploy][:scm_revision],
-          :message      => params[:deploy][:message]
-        }
-      end
+  def default_deploy
+    if params[:deploy]
+      {
+        :username     => params[:deploy][:local_username],
+        :environment  => params[:deploy][:rails_env],
+        :repository   => params[:deploy][:scm_repository],
+        :revision     => params[:deploy][:scm_revision],
+        :message      => params[:deploy][:message]
+      }
     end
+  end
     # handle Heroku's HTTP post deployhook format
     def heroku_deploy
@@ -33,7 +33,7 @@ class NoticesController &lt; ApplicationController
     redirect_to app_problem_path(problem.app, problem)
   end
-  private
+private
   def notice_params
     return @notice_params if @notice_params
@@ -134,12 +134,10 @@ class ProblemsController &lt; ApplicationController
     end
   end
-  protected
-
   ##
   # Redirect :back if no errors selected
   #
-  def need_selected_problem
+  protected def need_selected_problem
     if err_ids.empty?
       flash[:notice] = I18n.t('controllers.problems.flash.no_select_problem')
       redirect_to :back
@@ -39,9 +39,7 @@ class Users::OmniauthCallbacksController &lt; Devise::OmniauthCallbacksController
     end
   end
-  private
-
-  def update_user_with_github_attributes(user, login, token)
+  private def update_user_with_github_attributes(user, login, token)
     user.update_attributes(
       :github_login        => login,
       :github_oauth_token  => token
@@ -51,12 +51,12 @@ class UsersController &lt; ApplicationController
     redirect_to user_path(user)
   end
-  protected
+protected
-    def require_user_edit_priviledges
-      can_edit = current_user == user || current_user.admin?
-      redirect_to(root_path) unless can_edit
-    end
+  def require_user_edit_priviledges
+    can_edit = current_user == user || current_user.admin?
+    redirect_to(root_path) unless can_edit
+  end
   def user_params
     @user_params ||= params[:user] ? params.require(:user).permit(*user_permit_params) : {}
@@ -49,7 +49,7 @@ class BacktraceLineDecorator &lt; Draper::Decorator
       .sub(Backtrace::GEMS_PATH, "<strong>\\1</strong>")
   end
-  private
+private
   def link_to_in_app_source_file(app, text)
     return unless in_app?
@@ -17,9 +17,7 @@ class IssueTrackerFieldDecorator &lt; Draper::Decorator
               :value => issue_tracker.options[key.to_s])
   end
-  private
-
-  def input_field
+  private def input_field
     object == :password ? :password_field : :text_field
   end
 end
@@ -75,11 +75,11 @@ module ApplicationHelper
     end
   end
-  private
+private
-    def total_from_tallies(tallies)
-      tallies.values.inject(0) {|sum, n| sum + n}
-    end
+  def total_from_tallies(tallies)
+    tallies.values.inject(0) {|sum, n| sum + n}
+  end
     def head_size
       4
@@ -36,9 +36,7 @@ module AppsHelper
     @any_deploys
   end
-  private
-
-  def detect_any_apps_with_attributes
+  private def detect_any_apps_with_attributes
     @any_github_repos = @any_issue_trackers = @any_deploys = @any_bitbucket_repos = @any_notification_services = false
     apps.each do |app|
@@ -25,7 +25,7 @@ class ProblemDestroy
     }.count
   end
-  private
+private
   def errs_id
     problem.errs.only(:id).map(&:id)
@@ -15,7 +15,7 @@ class ResolvedProblemClearer
     }
   end
-  private
+private
   def nb_problem_resolved
     @count ||= criteria.count
@@ -58,9 +58,7 @@ class Mailer &lt; ActionMailer::Base
          :subject => "#{@user.name} commented on [#{@app.name}][#{@notice.environment_name}] #{@notice.message.truncate(50)}"
   end
-  private
-
-  def errbit_headers(header)
+  private def errbit_headers(header)
     header.each { |key,value| headers["X-Errbit-#{key}"] = value.to_s }
   end
 end
@@ -188,13 +188,13 @@ class App
     update_attribute(:api_key, SecureRandom.hex)
   end
-  protected
+protected
-    def store_cached_attributes_on_problems
-      Problem.where(:app_id => id).update_all(
-        app_name: name
-      )
-    end
+  def store_cached_attributes_on_problems
+    Problem.where(:app_id => id).update_all(
+      app_name: name
+    )
+  end
     def generate_api_key
       self.api_key ||= SecureRandom.hex
@@ -22,9 +22,7 @@ class Backtrace
     Digest::SHA1.hexdigest(lines.map(&:to_s).join)
   end
-  private
-
-  def generate_fingerprint
+  private def generate_fingerprint
     self.fingerprint = self.class.generate_fingerprint(lines)
   end
 end
@@ -28,11 +28,11 @@ class Comment
     app.emailable? && notification_recipients.any?
   end
-  protected
+protected
-    def increase_counter_cache
-      err.inc(comments_count: 1)
-    end
+  def increase_counter_cache
+    err.inc(comments_count: 1)
+  end
     def decrease_counter_cache
       err.inc(comments_count: -1) if err
@@ -26,11 +26,11 @@ class Deploy
     revision.to_s[0,7]
   end
-  protected
+protected
-    def should_resolve_app_errs?
-      app.resolve_errs_on_deploy?
-    end
+  def should_resolve_app_errs?
+    app.resolve_errs_on_deploy?
+  end
     def store_cached_attributes_on_problems
       Problem.where(:app_id => app.id).update_all(
@@ -124,7 +124,7 @@ class Notice
     message.gsub(/(#<.+?):[0-9a-f]x[0-9a-f]+(>)/, '\1\2')
   end
-  protected
+protected
   def problem_recache
     problem.uncache_notice(self)
@@ -27,7 +27,7 @@ if defined? Flowdock
       flow.push_to_team_inbox(:subject => subject, :content => content(problem, url), :project => project_name(problem), :link => url)
     end
-    private
+  private
     # can only contain alphanumeric characters and underscores
     def project_name(problem)
@@ -57,7 +57,7 @@ class NotificationServices::GtalkService &lt; NotificationService
     client.close unless client.nil?
   end
-  private
+private
   def send_to_users(client, message)
     user_id.tr(' ', ",").tr(';', ",").split(",").map(&:strip).reject(&:empty?).each do |user|
@@ -244,18 +244,18 @@ class Problem
     Problem.where({'$text' => {'$search' => value}})
   end
-  private
-
-    def attribute_count_descrease(name, value)
-      counter = send(name)
-      index = attribute_index(value)
-      if counter[index] && counter[index]['count'] > 1
-        counter[index]['count'] -= 1
-      else
-        counter.delete(index)
-      end
-      counter
+private
+
+  def attribute_count_descrease(name, value)
+    counter = send(name)
+    index = attribute_index(value)
+    if counter[index] && counter[index]['count'] > 1
+      counter[index]['count'] -= 1
+    else
+      counter.delete(index)
     end
+    counter
+  end
     def attribute_index(value)
       Digest::MD5.hexdigest(value.to_s)
@@ -83,9 +83,7 @@ class User
     :auth_token
   end
-  private
-
-  def generate_authentication_token
+  private def generate_authentication_token
     loop do
       token = Devise.friendly_token
       break token unless User.where(authentication_token: token).first
@@ -25,11 +25,11 @@ class Watcher
     user.try(:email) || email
   end
-  protected
+protected
-    def ensure_user_or_email
-      errors.add(:base, "You must specify either a user or an email address") unless user.present? || email.present?
-    end
+  def ensure_user_or_email
+    errors.add(:base, "You must specify either a user or an email address") unless user.present? || email.present?
+  end
     def clear_unused_watcher_type
       case watcher_type
@@ -24,7 +24,7 @@ module AirbrakeApi
         ErrorReport.new(attributes)
       end
-      private
+    private
       def error
         raise AirbrakeApi::ParamsError unless params.key?('errors') && params['errors'].any?
@@ -13,13 +13,11 @@ module Hoptoad
     processor.process_notice(parsed)
   end
-  private
-
-    def self.get_version_processor(version)
-      case version
-      when /2\.[01234]/ then Hoptoad::V2
-      else; raise ApiVersionError
-      end
+  private def self.get_version_processor(version)
+    case version
+    when /2\.[01234]/ then Hoptoad::V2
+    else; raise ApiVersionError
     end
+  end
 end
@@ -6,7 +6,7 @@ module Hoptoad
           rekey(parsed)))
     end
-    private
+  private
     def self.rekey(node)
       case node
@@ -4,23 +4,21 @@
 HoptoadNotifier.module_eval do
   class << self
-    private
+    private def send_notice(notice)
+      # Log the error internally if we are not in a development environment.
+      if configuration.public?
+        app = App.find_or_initialize_by(:name => "Self.Errbit")
+        app.github_repo = "errbit/errbit"
+        app.save!
+        notice.send("api_key=", app.api_key)
-      def send_notice(notice)
-        # Log the error internally if we are not in a development environment.
-        if configuration.public?
-          app = App.find_or_initialize_by(:name => "Self.Errbit")
-          app.github_repo = "errbit/errbit"
-          app.save!
-          notice.send("api_key=", app.api_key)
+        # Create notice internally.
+        report = ErrorReport.new(notice.to_xml)
+        report.generate_notice!
-          # Create notice internally.
-          report = ErrorReport.new(notice.to_xml)
-          report.generate_notice!
-
-          logger.info "Internal error was logged to 'Self.Errbit' app."
-        end
+        logger.info "Internal error was logged to 'Self.Errbit' app."
       end
+    end
   end
 end
	@@ -14,3 +14,14 @@ Style/EmptyLineBetweenDefs:		@@ -14,3 +14,14 @@ Style/EmptyLineBetweenDefs:
14		14
15	Style/ExtraSpacing:	15	Style/ExtraSpacing:
16	AllowForAlignment: true	16	AllowForAlignment: true
		17	+
		18	+Style/IndentationConsistency:
		19	+ # `rails` style:
		20	+ # prescribes that in classes and modules the `protected` and `private`
		21	+ # modifier keywords shall be indented the same as public methods and that
		22	+ # protected and private members shall be indented one step more than the
		23	+ # modifiers.
		24	+ EnforcedStyle: rails
		25	+
		26	+Style/AccessModifierIndentation:
		27	+ EnforcedStyle: outdent
	@@ -17,7 +17,7 @@ class ApplicationController < ActionController::Base		@@ -17,7 +17,7 @@ class ApplicationController < ActionController::Base
17	strategy StrongParametersWithEagerAttributesStrategy	17	strategy StrongParametersWithEagerAttributesStrategy
18	end	18	end
19		19
20	- protected	20	+protected
21		21
22	##	22	##
23	# Check if the current_user is admin or not and redirect to root url if not	23	# Check if the current_user is admin or not and redirect to root url if not
	@@ -33,7 +33,7 @@ class NoticesController < ApplicationController		@@ -33,7 +33,7 @@ class NoticesController < ApplicationController
33	redirect_to app_problem_path(problem.app, problem)	33	redirect_to app_problem_path(problem.app, problem)
34	end	34	end
35		35
36	- private	36	+private
37		37
38	def notice_params	38	def notice_params
39	return @notice_params if @notice_params	39	return @notice_params if @notice_params
	@@ -49,7 +49,7 @@ class BacktraceLineDecorator < Draper::Decorator		@@ -49,7 +49,7 @@ class BacktraceLineDecorator < Draper::Decorator
49	.sub(Backtrace::GEMS_PATH, "<strong>\\1</strong>")	49	.sub(Backtrace::GEMS_PATH, "<strong>\\1</strong>")
50	end	50	end
51		51
52	- private	52	+private
53		53
54	def link_to_in_app_source_file(app, text)	54	def link_to_in_app_source_file(app, text)
55	return unless in_app?	55	return unless in_app?
	@@ -25,7 +25,7 @@ class ProblemDestroy		@@ -25,7 +25,7 @@ class ProblemDestroy
25	}.count	25	}.count
26	end	26	end
27		27
28	- private	28	+private
29		29
30	def errs_id	30	def errs_id
31	problem.errs.only(:id).map(&:id)	31	problem.errs.only(:id).map(&:id)
	@@ -15,7 +15,7 @@ class ResolvedProblemClearer		@@ -15,7 +15,7 @@ class ResolvedProblemClearer
15	}	15	}
16	end	16	end
17		17
18	- private	18	+private
19		19
20	def nb_problem_resolved	20	def nb_problem_resolved
21	@count \|\|= criteria.count	21	@count \|\|= criteria.count
	@@ -124,7 +124,7 @@ class Notice		@@ -124,7 +124,7 @@ class Notice
124	message.gsub(/(#<.+?):[0-9a-f]x[0-9a-f]+(>)/, '\1\2')	124	message.gsub(/(#<.+?):[0-9a-f]x[0-9a-f]+(>)/, '\1\2')
125	end	125	end
126		126
127	- protected	127	+protected
128		128
129	def problem_recache	129	def problem_recache
130	problem.uncache_notice(self)	130	problem.uncache_notice(self)
	@@ -27,7 +27,7 @@ if defined? Flowdock		@@ -27,7 +27,7 @@ if defined? Flowdock
27	flow.push_to_team_inbox(:subject => subject, :content => content(problem, url), :project => project_name(problem), :link => url)	27	flow.push_to_team_inbox(:subject => subject, :content => content(problem, url), :project => project_name(problem), :link => url)
28	end	28	end
29		29
30	- private	30	+ private
31		31
32	# can only contain alphanumeric characters and underscores	32	# can only contain alphanumeric characters and underscores
33	def project_name(problem)	33	def project_name(problem)
	@@ -57,7 +57,7 @@ class NotificationServices::GtalkService < NotificationService		@@ -57,7 +57,7 @@ class NotificationServices::GtalkService < NotificationService
57	client.close unless client.nil?	57	client.close unless client.nil?
58	end	58	end
59		59
60	- private	60	+private
61		61
62	def send_to_users(client, message)	62	def send_to_users(client, message)
63	user_id.tr(' ', ",").tr(';', ",").split(",").map(&:strip).reject(&:empty?).each do \|user\|	63	user_id.tr(' ', ",").tr(';', ",").split(",").map(&:strip).reject(&:empty?).each do \|user\|
	@@ -24,7 +24,7 @@ module AirbrakeApi		@@ -24,7 +24,7 @@ module AirbrakeApi
24	ErrorReport.new(attributes)	24	ErrorReport.new(attributes)
25	end	25	end
26		26
27	- private	27	+ private
28		28
29	def error	29	def error
30	raise AirbrakeApi::ParamsError unless params.key?('errors') && params['errors'].any?	30	raise AirbrakeApi::ParamsError unless params.key?('errors') && params['errors'].any?