Update according to Rubocop conventions

Author: agrberg

.rubocop.yml

@@ -1,14 +1,15 @@
 require: 'rubocop-rspec'
 
 AllCops:
-  TargetRubyVersion: 2.3
+  NewCops: enable
+  TargetRubyVersion: 2.5
 
+Layout/LineLength:
+  Max: 120
+  IgnoredPatterns: ['#.*']
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
-Metrics/LineLength:
-  Max: 120
-  IgnoredPatterns: ['#.*']
 Metrics/MethodLength:
   Max: 25
 

Guardfile

@@ -17,7 +17,7 @@
 #
 # and, you'll have to watch "config/Guardfile" instead of "Guardfile"
 
-# Note: The cmd option is now required due to the increasing number of ways
+# NOTE: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
 #  * bundler binstubs: 'bin/rspec'
@@ -43,7 +43,7 @@ guard :rspec, cmd: 'bundle exec rspec' do
   dsl.watch_spec_files_for(ruby.lib_files)
 end
 
-guard :rubocop, cli: '-RD' do
+guard :rubocop, cli: '-D' do
   watch(/.+\.rb$/)
   watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
 end

cacheable.gemspec

@@ -6,7 +6,6 @@ require 'cacheable/version'
 Gem::Specification.new do |s|
   s.name        = 'cacheable'
   s.version     = Cacheable::VERSION
-  s.date        = '2018-07-31'
   s.summary     = 'Add caching to any Ruby method in a aspect orientated programming approach.'
   s.description = 'Add caching simply without modifying your existing code. '\
                   'Includes configurable options for simple cache invalidation. '\
@@ -16,5 +15,6 @@ Gem::Specification.new do |s|
   s.files       = Dir['lib/**/*', 'README.md', 'cache-adapters.md']
   s.homepage    = 'https://github.com/splitwise/cacheable'
   s.licenses    = 'MIT'
-  s.required_ruby_version = '>= 2.3.0'
+  s.required_ruby_version = '>= 2.5.0'
+  s.metadata = {'rubygems_mfa_required' => 'true'}
 end

lib/cacheable/method_generator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'English'
-
 module Cacheable
   module MethodGenerator
     def cacheable(*original_method_names, **opts)
@@ -66,7 +64,7 @@ def default_key_format
 
     def create_method_names(original_method_name)
       method_name_without_punctuation = original_method_name.to_s.sub(/([?!=])$/, '')
-      punctuation = $LAST_PAREN_MATCH
+      punctuation = Regexp.last_match(-1)
 
       {
         with_cache_method_name: "#{method_name_without_punctuation}_with_cache#{punctuation}",

spec/.rubocop.yml

@@ -1,15 +1,15 @@
 inherit_from: ../.rubocop.yml
 
+Layout/LineLength:
+  Max: 170
+
 # This cop does not like rspec dsl syntax https://github.com/bbatsov/rubocop/pull/4237#issuecomment-291408032
 Lint/AmbiguousBlockAssociation:
   Enabled: false
 
 Metrics/BlockLength:
   Enabled: false
 
-Metrics/LineLength:
-  Max: 170
-
 RSpec/AnyInstance:
   Enabled: false
 
@@ -32,3 +32,7 @@ RSpec/NestedGroups:
 RSpec/SubjectStub:
   Exclude:
     - 'cacheable/cacheable_spec.rb'
+
+Style/RedundantFetchBlock:
+  Exclude:
+    - 'cacheable/cache_adapters/memory_adapter_spec.rb' # Rubocop cannot tell Cache#fetch from Hash#fetch

spec/cacheable/cacheable_spec.rb

@@ -70,15 +70,14 @@
     end
 
     it 'allows access to `super` via a module interceptor' do
-      class BetterString < String
+      better_string = Class.new(String) do
         include Cacheable
 
-        def to_s
+        cacheable def to_s
           "Better #{super}"
         end
-
-        cacheable :to_s
       end
+      stub_const('BetterString', better_string)
 
       better_string = BetterString.new('my string')
       expect(better_string).to receive(:to_s_with_cache).twice.and_call_original
@@ -87,18 +86,21 @@ def to_s
     end
 
     it 'uses the class name to define an interceptor module' do
-      class RealClassName
-        include Cacheable
-      end
-      class_name = RealClassName
+      # This is done specifically this way to be compatible w/ RSpec best practices
+      # Once Cacheable is included in a class, it uses the name of the class to define the
+      # interceptor module. However, it is considered bad practice to create constants in RSpec
+      # so they're typically made with `stub_const`. We need to include Cacheable after the
+      # anonymous class has been created and assigned to the stubbed constant for this order to work.
+      stub_const('RealClassName', Class.new)
+      class_name = RealClassName.include(described_class)
+
       expect(class_name.ancestors.map(&:to_s)).to include("Cacheable::#{class_name}Cacher")
     end
 
     it 'uses the class address to define an interceptor module for anonymous classes' do
-      custom_class = Class.new do
-        include Cacheable
-      end
+      custom_class = Class.new { include Cacheable }
       class_name = custom_class.to_s.tr('#:<>', '')
+
       expect(custom_class.ancestors.map(&:to_s)).to include("Cacheable::#{class_name}Cacher")
     end
 
@@ -107,9 +109,7 @@ class RealClassName
         it "appends #{special_character} to the end of generated method names" do
           method_name = "cacheable_method#{special_character}"
           cacheable_class.class_eval do
-            define_method(method_name) {}
-
-            cacheable method_name
+            cacheable define_method(method_name, -> {})
           end
 
           expect(cacheable_object).to respond_to("cacheable_method_without_cache#{special_character}")
@@ -120,29 +120,10 @@ class RealClassName
 
     context 'when classes are nested' do
       it 'correctly names interceptor modules' do
-        expect do
-          class Outer
-            class Inner
-              include Cacheable
+        stub_const('Outer::Inner', Class.new)
+        Outer::Inner.include(described_class)
 
-              cacheable :outer_method
-
-              def outer_method
-                inner_method
-                'outer_method'
-              end
-
-              def inner_method
-                'inner_method'
-              end
-            end
-          end
-        end.not_to raise_error
-
-        cacheable_instance = Outer::Inner.new
-        expect(cacheable_instance).to receive(:inner_method).once.and_call_original
-
-        2.times { cacheable_instance.outer_method }
+        expect(Outer::Inner.ancestors.map(&:to_s)).to include('Cacheable::OuterInnerCacher')
       end
     end
   end
@@ -163,9 +144,10 @@ def inner_method
   describe 'key generation' do
     context 'without any customization' do
       it 'uses the class name and method name for the cache key' do
-        TotallyRealClassName = cacheable_class
+        stub_const('TotallyRealClassName', cacheable_class)
         cacheable_object = TotallyRealClassName.new
         key = cacheable_object.cacheable_method_key_format
+
         expect(key).to eq([cacheable_object.class.name, cacheable_method])
         expect { cacheable_object.cacheable_method }
           .to change { described_class.cache_adapter.exist?(key) }.from(false).to(true)
@@ -458,8 +440,10 @@ def cache_control_method
     end
 
     it 'uses the class name and method name for the cache key' do
-      AnotherTotallyRealClassName = cacheable_class
-      expect(AnotherTotallyRealClassName.cacheable_method_key_format).to eq([cacheable_class.name, cacheable_method])
+      stub_const('AnotherTotallyRealClassName', cacheable_class)
+      key = AnotherTotallyRealClassName.cacheable_method_key_format
+
+      expect(key).to eq([cacheable_class.name, cacheable_method])
     end
   end