Merge pull request #4204 from DavidKang/feature/rubocop/rubocop_todo

Rubocop friendly cops

.rubocop_todo.yml

@@ -6,62 +6,13 @@
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 19
-# Cop supports --auto-correct.
-Layout/AlignArray:
-  Exclude:
-    - 'src/api/lib/activexml/transport.rb'
-    - 'src/api/lib/xpath_engine.rb'
-    - 'src/api/test/functional/source_controller_test.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedHashRocketStyle, SupportedHashRocketStyles, EnforcedColonStyle, SupportedColonStyles, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
-# SupportedHashRocketStyles: key, separator, table
-# SupportedColonStyles: key, separator, table
-# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/AlignHash:
-  Exclude:
-    - 'src/api/app/views/webui/feeds/commits.atom.builder'
-
-# Offense count: 2
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, IndentationWidth.
-# SupportedStyles: with_first_parameter, with_fixed_indentation
-Layout/AlignParameters:
-  Exclude:
-    - 'src/api/app/views/statistics/rating.xml.builder'
-
-# Offense count: 31
-# Cop supports --auto-correct.
-Layout/ClosingParenthesisIndentation:
-  Exclude:
-    - 'src/api/app/views/statistics/rating.xml.builder'
-    - 'src/api/test/unit/project_test.rb'
-
-# Offense count: 68
-# Cop supports --auto-correct.
-Layout/CommentIndentation:
-  Enabled: false
-
 # Offense count: 78
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: leading, trailing
 Layout/DotPosition:
   Enabled: false
 
-# Offense count: 17
-# Cop supports --auto-correct.
-Layout/EmptyLineAfterMagicComment:
-  Enabled: false
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Layout/EmptyLinesAroundBeginBody:
-  Exclude:
-    - 'src/api/app/controllers/webui/patchinfo_controller.rb'
-
 # Offense count: 35
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.

src/api/Gemfile

@@ -90,7 +90,7 @@ group :production do
   # if you have an account, it can be configured by
   # placing a config/newrelic.yml
   # be aware about the non-OSS license
-#  gem 'newrelic_rpm'
+  #  gem 'newrelic_rpm'
 end
 
 # Gems used only for testing the application and not required in production environments by default.

src/api/app/controllers/configurations_controller.rb

@@ -6,8 +6,8 @@ class ConfigurationsController < ApplicationController
   skip_before_action :validate_params, only: [:update] # we use an array for archs here
 
   validate_action show: {method: :get, response: :configuration}
-# webui is using this route with parameters instead of content
-#  validate_action :update => {:method => :put, :request => :configuration}
+  # webui is using this route with parameters instead of content
+  #  validate_action :update => {:method => :put, :request => :configuration}
 
   # GET /configuration
   # GET /configuration.xml

src/api/app/controllers/source_controller.rb

@@ -645,8 +645,8 @@ def show_package_meta
     pack = Package.get_by_project_and_name(@project_name, @package_name, use_source: false)
 
     if params.has_key?(:meta) || params.has_key?(:rev) || params.has_key?(:view) || pack.nil?
-       # check if this comes from a remote project, also true for _project package
-       # or if meta is specified we need to fetch the meta from the backend
+      # check if this comes from a remote project, also true for _project package
+      # or if meta is specified we need to fetch the meta from the backend
       path = request.path_info
       path += build_query_from_hash(params, [:meta, :rev, :view])
       pass_to_backend path
@@ -1228,9 +1228,9 @@ def package_command_showlinked
       # FIXME: return an empty list for now
       # we could request the links on remote instance via that: but we would need to search also localy and merge ...
 
-#      path = "/search/package/id?match=(@linkinfo/package=\"#{CGI.escape(package_name)}\"+and+@linkinfo/project=\"#{CGI.escape(project_name)}\")"
-#      answer = Backend::Connection.post path
-#      render :text => answer.body, :content_type => 'text/xml'
+      # path = "/search/package/id?match=(@linkinfo/package=\"#{CGI.escape(package_name)}\"+and+@linkinfo/project=\"#{CGI.escape(project_name)}\")"
+      # answer = Backend::Connection.post path
+      # render :text => answer.body, :content_type => 'text/xml'
       render xml: '<collection/>'
       return
     end

src/api/app/controllers/webui/patchinfo_controller.rb

@@ -247,7 +247,6 @@ def new_tracker
       end
       if issue.length > 1
         begin
-
           issueurl = IssueTracker.find_by_name(issue[0])
           if issueurl
             Rails.logger.debug "URL2 #{issueurl.inspect}"

src/api/app/mixins/request_source_diff.rb

@@ -84,11 +84,11 @@ def diff_for_source(spkg, options = {})
           query[:opackage] = @target_package
           query[:rev] = action.source_rev if action.source_rev
         elsif action.source_rev # Use source rev for diffing (if available)
-           # No target package means diffing the source package against itself.
+          # No target package means diffing the source package against itself.
           query[:orev] = 0
           query[:rev] = action.source_rev
         else # Otherwise generate diff for latest source package revision
-             # FIXME: move to Package model
+          # FIXME: move to Package model
           spkg_rev = Directory.find_hashed(project: action.source_project, package: spkg)['rev']
           query[:orev] = 0
           query[:rev] = spkg_rev

src/api/app/models/binary_release.rb

@@ -32,8 +32,8 @@ def self.update_binary_releases(repository, key, time = Time.now)
 
   def self.update_binary_releases_via_json(repository, json, time = Time.now)
     oldlist = where(repository: repository, obsolete_time: nil, modify_time: nil)
-    processed_item = {} # we can not just remove it from relation
-                        # delete would affect the object
+    # we can not just remove it from relation, delete would affect the object.
+    processed_item = {}
 
     BinaryRelease.transaction do
       json.each do |binary|
@@ -59,7 +59,7 @@ def self.update_binary_releases_via_json(repository, json, time = Time.now)
           if entry.binary_disturl                   == binary["disturl"] &&
              entry.binary_supportstatus             == binary["supportstatus"] &&
              entry.binary_buildtime.to_datetime.utc == ::Time.at(binary["buildtime"].to_i).to_datetime.utc
-             # same binary, don't touch
+            # same binary, don't touch
             processed_item[entry.id] = true
             next
           end

src/api/app/models/branch_package.rb

@@ -137,7 +137,7 @@ def create_branch_packages(tprj)
         ret = ActiveXML::Node.new(tpkg.source_file('_link'))
         ret.delete_attribute('project') # its a local link, project name not needed
         linked_package = p[:link_target_package]
-         # user enforce a rename of base package
+        # user enforce a rename of base package
         linked_package = params[:target_package] if params[:target_package] && params[:package] == ret.value('package')
         linked_package += '.' + p[:link_target_project].name.tr(':', '_') if @extend_names
         ret.set_attribute('package', linked_package)

src/api/app/models/bs_request_permission_check.rb

@@ -370,7 +370,7 @@ def cmd_changestate_permissions(opts)
 
   attr_accessor :opts, :req
 
-# check if the request can change state - or throw an APIException if not
+  # check if the request can change state - or throw an APIException if not
   def initialize(_req, _opts)
     self.req = _req
     self.opts = _opts
@@ -379,7 +379,7 @@ def initialize(_req, _opts)
     @write_permission_in_target = false
   end
 
-# Is the user involved in any project or package ?
+  # Is the user involved in any project or package ?
   def require_permissions_in_target_or_source
     unless @write_permission_in_target || @write_permission_in_source
       raise AddReviewNotPermitted, "You have no role in request #{req.number}"
@@ -391,14 +391,14 @@ def extra_permissions_check_changestate
     err =
       case opts[:newstate]
       when 'superseded'
-          # Is the user involved in any project or package ?
+        # Is the user involved in any project or package ?
         unless @write_permission_in_target || @write_permission_in_source
           "You have no role in request #{req.number}"
         end
       when 'accepted'
-          # requires write permissions in all targets, this is already handled in each action check
+      # requires write permissions in all targets, this is already handled in each action check
       when 'revoked'
-          # general revoke permission check based on source maintainership. We don't get here if the user is the creator of request
+        # general revoke permission check based on source maintainership. We don't get here if the user is the creator of request
         unless @write_permission_in_source
           "No permission to revoke request #{req.number}"
         end

src/api/app/models/history_element.rb

@@ -1,5 +1,5 @@
 module HistoryElement
-# This class represents some kind of history element within the build service
+  # This class represents some kind of history element within the build service
   class Base < ApplicationRecord
     belongs_to :user
 

src/api/app/models/issue_tracker.rb

@@ -87,9 +87,9 @@ def update_issues_bugzilla
 
     # skip callbacks to avoid scheduling expensive jobs
 
-# rubocop:disable Rails/SkipsModelValidations
+    # rubocop:disable Rails/SkipsModelValidations
     update_columns(issues_updated: @update_time_stamp)
-# rubocop:enable Rails/SkipsModelValidations
+    # rubocop:enable Rails/SkipsModelValidations
   end
 
   def update_issues_github
@@ -111,9 +111,9 @@ def update_issues_github
     parse_github_issues(ActiveSupport::JSON.decode(response.body))
 
     # we skip callbacks to avoid scheduling expensive jobs
-# rubocop:disable Rails/SkipsModelValidations
+    # rubocop:disable Rails/SkipsModelValidations
     update_columns(issues_updated: mtime - 1.second)
-# rubocop:enable Rails/SkipsModelValidations
+    # rubocop:enable Rails/SkipsModelValidations
   end
 
   def update_issues_cve
@@ -135,9 +135,9 @@ def update_issues_cve
     parser = Nokogiri::XML::SAX::Parser.new(listener)
     parser.parse_io(unzipedio)
     # we skip callbacks to avoid scheduling expensive jobs
-# rubocop:disable Rails/SkipsModelValidations
+    # rubocop:disable Rails/SkipsModelValidations
     update_columns(issues_updated: mtime - 1.second)
-# rubocop:enable Rails/SkipsModelValidations
+    # rubocop:enable Rails/SkipsModelValidations
   end
 
   def update_issues
@@ -162,9 +162,9 @@ def enforced_update_all_issues
     if private_fetch_issues(ids)
       # don't use "last_change_time" from bugzilla, since we may have different clocks
       # and skip callbacks to avoid scheduling expensive jobs
-# rubocop:disable Rails/SkipsModelValidations
+      # rubocop:disable Rails/SkipsModelValidations
       update_columns(issues_updated: @update_time_stamp)
-# rubocop:enable Rails/SkipsModelValidations
+      # rubocop:enable Rails/SkipsModelValidations
       return true
     end
     false
@@ -232,10 +232,10 @@ def parse_single_bugzilla_issue(bugzilla_response)
     end
 
     if bugzilla_response["creation_time"].present?
-# rubocop:disable Rails/Date
-# rubocop bug, this is XMLRPC/DateTime not Rails/Date
+      # rubocop:disable Rails/Date
+      # rubocop bug, this is XMLRPC/DateTime not Rails/Date
       issue.created_at = bugzilla_response["creation_time"].to_time
-# rubocop:enable Rails/Date
+    # rubocop:enable Rails/Date
     else
       issue.created_at = Time.now
     end

src/api/app/models/owner.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 i*-
+
 require 'api_exception'
 
 class Owner

src/api/app/models/package.rb

@@ -1,4 +1,5 @@
 # -*- encoding: utf-8 i*-
+
 require_dependency 'api_exception'
 require 'builder/xchar'
 require 'rexml/document'

src/api/app/views/statistics/latest_updated.xml.builder

@@ -10,7 +10,7 @@ xml.latest_updated do
         :updated => item[0].xmlschema
       )
     else
-    ### item is a project
+      ### item is a project
       xml.project(
         :name => item[1],
         :updated => item[0].xmlschema

src/api/app/views/statistics/rating.xml.builder

@@ -1,14 +1,14 @@
 
 if @package && @project
   xml.rating( @rating[:score],
-    :count => @rating[:count], :project => @project, :package => @package,
-    :user_score => @rating[:user_score]
-  )
+              :count => @rating[:count], :project => @project, :package => @package,
+              :user_score => @rating[:user_score]
+            )
 elsif @project
   xml.rating( @rating[:score],
-    :count => @rating[:count], :project => @project,
-    :user_score => @rating[:user_score]
-  )
+              :count => @rating[:count], :project => @project,
+              :user_score => @rating[:user_score]
+            )
 else
   xml.rating
 end

src/api/app/views/webui/feeds/commits.atom.builder

@@ -1,6 +1,6 @@
 # Don't ask me why atom_feed helper does not work. Reimplementing its logic
 feed_opts = { "xml:lang" => "en-US",
-              "xmlns" => 'http://www.w3.org/2005/Atom' }
+              "xmlns"    => 'http://www.w3.org/2005/Atom' }
 schema_date = "2013-11-22"
 obs_host = URI.parse(::Configuration.obs_url).host
 

src/api/app/views/webui/main/sitemap_projects.builder

@@ -1,6 +1,6 @@
 # rubocop:disable Metrics/LineLength
 xml.urlset(xmlns: "http://www.sitemaps.org/schemas/sitemap/0.9", "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance", "xsi:schemaLocation" => "http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd") do
-# rubocop:enable Metrics/LineLength
+  # rubocop:enable Metrics/LineLength
 
   xml.url do
     xml.loc url_for controller: :main, action: :index, only_path: false

src/api/bin/pry

@@ -1,5 +1,6 @@
 #!/usr/bin/ruby.ruby2.4
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #

src/api/bin/rdoc

@@ -1,5 +1,6 @@
 #!/usr/bin/ruby.ruby2.4
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #

src/api/bin/ri

@@ -1,5 +1,6 @@
 #!/usr/bin/ruby.ruby2.4
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #

src/api/bin/rspec

@@ -1,5 +1,6 @@
 #!/usr/bin/ruby.ruby2.4
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #

src/api/bin/rubocop

@@ -1,5 +1,6 @@
 #!/usr/bin/ruby.ruby2.4
 # frozen_string_literal: true
+
 #
 # This file was generated by Bundler.
 #

src/api/config/environments/production.rb

@@ -29,8 +29,8 @@
 
   config.active_support.deprecation = :log
 
-   # Enable serving of images, stylesheets, and javascripts from an asset server
-   # config.action_controller.asset_host                  = "http://assets.example.com"
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host                  = "http://assets.example.com"
 
   # Full error reports are disabled and caching is turned on
   config.consider_all_requests_local       = false

src/api/config/environments/test.rb

@@ -38,7 +38,7 @@
 
   config.active_support.deprecation = :log
   # Print deprecation notices to the stderr.
-#  config.active_support.deprecation = :stderr
+  #  config.active_support.deprecation = :stderr
 
   config.eager_load = false
 

src/api/db/attribute_descriptions.rb

@@ -11,7 +11,7 @@ def update_all_attrib_type_descriptions
     "Maintained"                      => "Marks this as object as maintained. For instance to find packages automatically when using the maintenance features like \"osc mbranch\".",
     "MaintenanceProject"              => "Mark this project as central maintenance project, which is used to coordinate all official updates.",
     "MaintenanceIdTemplate"           => "Released maintenance updates get an ID on first release. This attribute can be used to modify the default scheme.",
-#    "ScreenShots" => "", # to be dropped?
+    #    "ScreenShots" => "", # to be dropped?
     "ImageTemplates"                  => "Mark this project as source for image templates.",
     "OwnerRootProject"                => "Mark this project as starting point for the package ownership search. Optional values: \"DisableDevel\": don't follow devel project links. \"BugownerOnly\": limit the result to bugowners (ignoring the maintainer role).",
     "RequestCloned"                   => "Use this attribute to reference a request which will get superseded when a new submit request from this project gets created.",

src/api/lib/activexml/transport.rb

@@ -408,7 +408,7 @@ def load_external_url(uri)
           content = response.body
         end
       rescue SocketError, Errno::EINTR, Errno::EPIPE, EOFError, Net::HTTPBadResponse, IOError, Errno::ENETUNREACH,
-        Errno::ETIMEDOUT, Errno::ECONNREFUSED, Timeout::Error => err
+             Errno::ETIMEDOUT, Errno::ECONNREFUSED, Timeout::Error => err
         logger.debug "#{err} when fetching #{uri}"
         http = nil
       end