Style/PreferredHashMethods-20220909233727

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-09-05 23:37:11 UTC using RuboCop version 1.36.0.
+# on 2022-09-09 23:38:13 UTC using RuboCop version 1.36.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,7 +14,7 @@ Gemspec/DeprecatedAttributeAssignment:
   Exclude:
     - 'apipie-rails.gemspec'
 
-# Offense count: 4
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation, Include.
 # Include: **/*.gemspec
@@ -1231,6 +1231,20 @@ Rails/RakeEnvironment:
   Exclude:
     - 'lib/tasks/apipie.rake'
 
+# Offense count: 18
+# This cop supports safe autocorrection (--autocorrect).
+Rails/RootPathnameMethods:
+  Exclude:
+    - 'lib/apipie/configuration.rb'
+    - 'lib/apipie/dsl_definition.rb'
+    - 'lib/tasks/apipie.rake'
+    - 'spec/controllers/apipies_controller_spec.rb'
+    - 'spec/dummy/config/initializers/apipie.rb'
+    - 'spec/lib/application_spec.rb'
+    - 'spec/lib/extractor/writer_spec.rb'
+    - 'spec/lib/rake_spec.rb'
+    - 'spec/lib/swagger/rake_swagger_spec.rb'
+
 # Offense count: 4
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: EnforcedStyle.
@@ -1709,22 +1723,6 @@ Style/PerlBackrefs:
   Exclude:
     - 'lib/apipie/extractor.rb'
 
-# Offense count: 27
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: short, verbose
-Style/PreferredHashMethods:
-  Exclude:
-    - 'lib/apipie/apipie_module.rb'
-    - 'lib/apipie/application.rb'
-    - 'lib/apipie/dsl_definition.rb'
-    - 'lib/apipie/extractor/writer.rb'
-    - 'lib/apipie/method_description.rb'
-    - 'lib/apipie/param_description.rb'
-    - 'lib/apipie/resource_description.rb'
-    - 'lib/apipie/validator.rb'
-    - 'spec/lib/param_group_spec.rb'
-
 # Offense count: 5
 # This cop supports safe autocorrection (--autocorrect).
 Style/Proc:
@@ -1924,7 +1922,7 @@ Style/StringConcatenation:
     - 'lib/apipie/extractor/writer.rb'
     - 'lib/apipie/swagger_generator.rb'
 
-# Offense count: 1314
+# Offense count: 1311
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes

lib/apipie/apipie_module.rb

@@ -70,11 +70,11 @@ def self.api_base_url(version = nil)
   end
 
   def self.app_info_version_valid?(version)
-    version && self.configuration.app_info.has_key?(version)
+    version && self.configuration.app_info.key?(version)
   end
 
   def self.api_base_url_version_valid?(version)
-    version && self.configuration.api_base_url.has_key?(version)
+    version && self.configuration.api_base_url.key?(version)
   end
 
   def self.record(record)

lib/apipie/application.rb

@@ -147,7 +147,7 @@ def add_param_group(controller, name, &block)
 
     def get_param_group(controller, name)
       key = "#{controller.name}##{name}"
-      if @param_groups.has_key?(key)
+      if @param_groups.key?(key)
         return @param_groups[key]
       else
         raise "param group #{key} not defined"
@@ -198,7 +198,7 @@ def get_resource_description(resource, version = nil)
           version = crumbs.first
         end
         version ||= Apipie.configuration.default_version
-        if @resource_descriptions.has_key?(version)
+        if @resource_descriptions.key?(version)
           return @resource_descriptions[version][crumbs.last]
         end
       else
@@ -373,7 +373,7 @@ def active_dsl?
     def get_resource_name(klass)
       if klass.class == String
         klass
-      elsif @controller_to_resource_id.has_key?(klass)
+      elsif @controller_to_resource_id.key?(klass)
         @controller_to_resource_id[klass]
       elsif Apipie.configuration.namespaced_resources? && klass.respond_to?(:controller_path)
         return nil if klass == ActionController::Base
@@ -408,9 +408,9 @@ def translate(str, locale)
     # Make sure that the version/resource_name/method_name are valid combination
     # resource_name and method_name can be nil
     def valid_search_args?(version, resource_name, method_name)
-      return false unless self.resource_descriptions.has_key?(version)
+      return false unless self.resource_descriptions.key?(version)
       if resource_name
-        return false unless self.resource_descriptions[version].has_key?(resource_name)
+        return false unless self.resource_descriptions[version].key?(resource_name)
         if method_name
           resource_description = self.resource_descriptions[version][resource_name]
           return false unless resource_description.valid_method_name?(method_name)

lib/apipie/dsl_definition.rb

@@ -246,14 +246,14 @@ def _apipie_define_validators(description)
               if Apipie.configuration.validate_presence?
                 method_params.each do |_, param|
                   # check if required parameters are present
-                  raise ParamMissing.new(param) if param.required && !params.has_key?(param.name)
+                  raise ParamMissing.new(param) if param.required && !params.key?(param.name)
                 end
               end
 
               if Apipie.configuration.validate_value?
                 method_params.each do |_, param|
                   # params validations
-                  param.validate(params[:"#{param.name}"]) if params.has_key?(param.name)
+                  param.validate(params[:"#{param.name}"]) if params.key?(param.name)
                 end
               end
 
@@ -272,7 +272,7 @@ def _apipie_define_validators(description)
                 @api_params ||= {}
                 method_params.each do |_, param|
                   # params processing
-                  @api_params[param.as] = param.process_value(params[:"#{param.name}"]) if params.has_key?(param.name)
+                  @api_params[param.as] = param.process_value(params[:"#{param.name}"]) if params.key?(param.name)
                 end
               end
             end

lib/apipie/extractor/writer.rb

@@ -103,7 +103,7 @@ def ordered_call(call)
         call = call.stringify_keys
         ordered_call = OrderedHash.new
         %w[title verb path versions query request_data response_data code show_in_doc recorded].each do |k|
-          next unless call.has_key?(k)
+          next unless call.key?(k)
           ordered_call[k] = case call[k]
                      when ActiveSupport::HashWithIndifferentAccess
                        convert_file_value(call[k]).to_hash
@@ -134,8 +134,8 @@ def merge_old_new_examples
         old_examples = self.load_recorded_examples
         merged_examples = []
         (new_examples.keys + old_examples.keys).uniq.each do |key|
-          if new_examples.has_key?(key)
-            if old_examples.has_key?(key)
+          if new_examples.key?(key)
+            if old_examples.key?(key)
               records = deep_merge_examples(new_examples[key], old_examples[key])
             else
               records = new_examples[key]

lib/apipie/method_description.rb

@@ -58,7 +58,7 @@ def initialize(method, resource, dsl_data)
       @params_ordered = ParamDescription.unify(@params_ordered)
       @headers = dsl_data[:headers]
 
-      @show = if dsl_data.has_key? :show
+      @show = if dsl_data.key? :show
         dsl_data[:show]
       else
         true

lib/apipie/param_description.rb

@@ -71,7 +71,7 @@ def initialize(method_description, name, validator, desc_or_options = nil, optio
       @request_only = (@options[:only_in] == :request)
       raise ArgumentError.new("'#{@options[:only_in]}' is not a valid value for :only_in") if (!@response_only && !@request_only) && @options[:only_in].present?
 
-      @show = if @options.has_key? :show
+      @show = if @options.key? :show
         @options[:show]
       else
         true
@@ -212,7 +212,7 @@ def self.merge(target_params, source_params)
     # action awareness is being inherited from ancestors (in terms of
     # nested params)
     def action_aware?
-      if @options.has_key?(:action_aware)
+      if @options.key?(:action_aware)
         return @options[:action_aware]
       elsif @parent
         @parent.action_aware?
@@ -237,7 +237,7 @@ def as_action
     # crate/update actions.
     def action_awareness
       if action_aware?
-        if !@options.has_key?(:allow_nil)
+        if !@options.key?(:allow_nil)
           if @required
             @allow_nil = false
           else
@@ -268,7 +268,7 @@ def preformat_text(text)
     end
 
     def is_required?
-      if @options.has_key?(:required)
+      if @options.key?(:required)
         if (@options[:required] == true) || (@options[:required] == false)
           @options[:required]
         else

lib/apipie/resource_description.rb

@@ -71,7 +71,7 @@ def method_description(method_name)
     end
 
     def remove_method_description(method_name)
-      if @_methods.has_key?(method_name)
+      if @_methods.key?(method_name)
         @_methods.delete(method_name)
       end
     end

lib/apipie/validator.rb

@@ -347,10 +347,10 @@ def validate(value)
         if @hash_params
           @hash_params.each do |k, p|
             if Apipie.configuration.validate_presence?
-              raise ParamMissing.new(p) if p.required && !value.has_key?(k)
+              raise ParamMissing.new(p) if p.required && !value.key?(k)
             end
             if Apipie.configuration.validate_value?
-              p.validate(value[k]) if value.has_key?(k)
+              p.validate(value[k]) if value.key?(k)
             end
           end
         end
@@ -360,7 +360,7 @@ def validate(value)
       def process_value(value)
         if @hash_params && value
           return @hash_params.each_with_object({}) do |(key, param), api_params|
-            if value.has_key?(key)
+            if value.key?(key)
               api_params[param.as] = param.process_value(value[key])
             end
           end

spec/lib/param_group_spec.rb

@@ -43,17 +43,17 @@
   end
 
   it "should replace parameter name in a group when it comes from concern" do
-    expect(Apipie["overridden_concern_resources#update"].params.has_key?(:user)).to eq(true)
+    expect(Apipie["overridden_concern_resources#update"].params.key?(:user)).to eq(true)
   end
 
   it "shouldn't replace parameter name in a group redefined in the controller" do
-    expect(Apipie["overridden_concern_resources#create"].params.has_key?(:concern)).to eq(true)
-    expect(Apipie["overridden_concern_resources#create"].params.has_key?(:user)).to eq(false)
+    expect(Apipie["overridden_concern_resources#create"].params.key?(:concern)).to eq(true)
+    expect(Apipie["overridden_concern_resources#create"].params.key?(:user)).to eq(false)
   end
 
 it "shouldn't replace name of a parameter defined in the controller" do
-    expect(Apipie["overridden_concern_resources#custom"].params.has_key?(:concern)).to eq(true)
-    expect(Apipie["overridden_concern_resources#custom"].params.has_key?(:user)).to eq(false)
+    expect(Apipie["overridden_concern_resources#custom"].params.key?(:concern)).to eq(true)
+    expect(Apipie["overridden_concern_resources#custom"].params.key?(:user)).to eq(false)
   end
 
 end