🚨 Linting cleanup

Author: pboling

.rubocop.yml

@@ -1,8 +1,9 @@
+inherit_from: .rubocop_todo.yml
+
 inherit_gem:
   rubocop-lts: rubocop-lts.yml
 
 require:
-  - 'rubocop-md'
   - 'rubocop-performance'
   - 'rubocop-rake'
   - 'rubocop-rspec'
@@ -19,5 +20,5 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
-Layout/LineLength:
+Metrics/LineLength:
   Max: 120

.rubocop_todo.yml

@@ -0,0 +1,70 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-09-23 18:38:21 -0500 using RuboCop version 0.68.1.
+# 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
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 31
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 94
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 25
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 414
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 33
+
+# Offense count: 1
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/shared_contexts/base_hash.rb'
+
+# Offense count: 1
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/snaky_hash/bad_snake_spec.rb'
+
+# Offense count: 5
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/shared_examples/a_snaked_hash.rb'
+
+# Offense count: 1
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/snaky_hash/snake_spec.rb'
+
+# Offense count: 12
+RSpec/MultipleExpectations:
+  Max: 15
+
+# Offense count: 5
+Style/Documentation:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+    - 'lib/snaky_hash/snake.rb'
+    - 'lib/snaky_hash/string_keyed.rb'
+    - 'lib/snaky_hash/symbol_keyed.rb'
+    - 'spec/snaky_hash/snake_spec.rb'

Gemfile

@@ -21,7 +21,8 @@ gem "overcommit", "~> 0.58" if linting
 
 platforms :mri do
   if linting
-    gem "rubocop-md", require: false
+    # Commented out rubocop-md because of the <--rubocop/md--> bug
+    # gem "rubocop-md", require: false
     # Can be added once we reach rubocop-lts >= v10 (i.e. drop Ruby 2.2)
     # gem 'rubocop-packaging', require: false
     gem "rubocop-performance", require: false

Gemfile.lock

@@ -55,8 +55,6 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.6)
     rubocop-lts (8.0.2)
       rubocop-ruby2_2 (~> 1.0.4)
-    rubocop-md (0.4.1)
-      rubocop (>= 0.60)
     rubocop-performance (1.3.0)
       rubocop (>= 0.68.0)
     rubocop-rake (0.5.1)
@@ -101,7 +99,6 @@ DEPENDENCIES
   rspec (~> 3.0)
   rspec-block_is_expected
   rubocop-lts (~> 8.0)
-  rubocop-md
   rubocop-performance
   rubocop-rake
   rubocop-rspec

README.md

@@ -24,13 +24,13 @@ class MySnakedHash < Hashie::Mash
   include SnakyHash::Snake.new(key_type: :string) # or :symbol
 end
 
-snake = MySnakedHash.new(a: 'a', 'b' => 'b', 2 => 2, 'VeryFineHat' => 'Feathers')
+snake = MySnakedHash.new(a: "a", "b" => "b", 2 => 2, "VeryFineHat" => "Feathers")
 snake.a # => 'a'
 snake.b # => 'b'
 snake[2] # 2
 snake.very_fine_hat # => 'Feathers'
 snake[:very_fine_hat] # => 'Feathers'
-snake['very_fine_hat'] # => 'Feathers'
+snake["very_fine_hat"] # => 'Feathers'
 ```
 
 Note above that you can access the values via the string, or symbol.
@@ -45,17 +45,17 @@ You can still access the original un-snaked camel keys.
 And through them you can even use un-snaked camel methods.
 
 ```ruby
-snake.key?('VeryFineHat') # => true
-snake['VeryFineHat'] # => 'Feathers'
+snake.key?("VeryFineHat") # => true
+snake["VeryFineHat"] # => 'Feathers'
 snake.VeryFineHat # => 'Feathers', PLEASE don't do this!!!
-snake['VeryFineHat'] = 'pop' # Please don't do this... you'll get a warning, and it works (for now), but no guarantees.
+snake["VeryFineHat"] = "pop" # Please don't do this... you'll get a warning, and it works (for now), but no guarantees.
 # WARN -- : You are setting a key that conflicts with a built-in method MySnakedHash#VeryFineHat defined in MySnakedHash. This can cause unexpected behavior when accessing the key as a property. You can still access the key via the #[] method.
 # => "pop"
-snake.very_fine_hat = 'pop' # => 'pop', do this instead!!!
+snake.very_fine_hat = "pop" # => 'pop', do this instead!!!
 snake.very_fine_hat # => 'pop'
-snake[:very_fine_hat] = 'moose' # => 'moose', or do this instead!!!
+snake[:very_fine_hat] = "moose" # => 'moose', or do this instead!!!
 snake.very_fine_hat # => 'moose'
-snake['very_fine_hat'] = 'cheese' # => 'cheese', or do this instead!!!
+snake["very_fine_hat"] = "cheese" # => 'cheese', or do this instead!!!
 snake.very_fine_hat # => 'cheese'
 ```
 

Rakefile

@@ -1,31 +1,30 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 # !/usr/bin/env rake
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
 begin
-  require 'rspec/core/rake_task'
+  require "rspec/core/rake_task"
   RSpec::Core::RakeTask.new(:spec)
 rescue LoadError
-  desc 'spec task stub'
+  desc "spec task stub"
   task :spec do
-    warn 'rspec is disabled'
+    warn "rspec is disabled"
   end
 end
-desc 'alias test task to spec'
+desc "alias test task to spec"
 task test: :spec
 
 begin
-  require 'rubocop/rake_task'
+  require "rubocop/rake_task"
   RuboCop::RakeTask.new do |task|
-    task.options = ['-D'] # Display the name of the failing cops
+    task.options = ["-D"] # Display the name of the failing cops
   end
 rescue LoadError
-  desc 'rubocop task stub'
+  desc "rubocop task stub"
   task :rubocop do
-    warn 'RuboCop is disabled'
+    warn "RuboCop is disabled"
   end
 end
 

snaky_hash.gemspec

@@ -45,6 +45,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "rake", ">= 12"
   spec.add_development_dependency "rspec", ">= 3"
-  spec.add_development_dependency "rubocop-lts", "~> 8.0"
   spec.add_development_dependency "rspec-block_is_expected"
+  spec.add_development_dependency "rubocop-lts", "~> 8.0"
 end

spec/shared_examples/a_snaked_hash.rb

@@ -114,4 +114,4 @@
     expect(subject.key?(:"4")).to be false
     expect(subject.key?(4)).to be true
   end
-end
+end

spec/snaky_hash/bad_snake_spec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 RSpec.describe "a bad one" do
-
   subject(:bad_snake) do
     Class.new(Hashie::Mash) do
       include SnakyHash::Snake.new(key_type: :slartibartfarst)

spec/snaky_hash/snake_spec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 RSpec.describe SnakyHash::Snake do
-
   class TheSnakedHash < Hashie::Mash
     include SnakyHash::Snake.new(key_type: :string)
   end
@@ -14,19 +13,19 @@ class TheSnakedHash < Hashie::Mash
 
   it "returns a SnakyHash::Snake from a snake + snake merge" do
     a = TheSnakedHash.new("asd" => "asd")
-    b = TheSnakedHash.new(:zxc => "zxc")
+    b = TheSnakedHash.new(zxc: "zxc")
     expect(a.merge(b)).to be_a(TheSnakedHash)
   end
 
   it "returns a SnakyHash::Snake from a snake + hash merge" do
     a = TheSnakedHash.new("asd" => "asd")
-    b = Hash.new(:zxc => "zxc")
+    b = Hash.new(zxc: "zxc")
     expect(a.merge(b)).to be_a(TheSnakedHash)
   end
 
   it "returns a Hash from a hash + snake merge" do
     a = TheSnakedHash.new("asd" => "asd")
-    b = Hash.new(:zxc => "zxc")
+    b = Hash.new(zxc: "zxc")
     res = b.merge(a)
     expect(res).not_to be_a(TheSnakedHash)
     expect(res).to be_a(Hash)