Exploration

.rubocop.yml

@@ -0,0 +1,54 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: true
+  EnabledByDefault: true
+  TargetRubyVersion: 3.2.2
+
+Style/Copyright:
+  Enabled: false
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+Layout/RedundantLineBreak:
+  Enabled: false
+
+Style/MissingElse:
+  Enabled: false
+
+Lint/ConstantResolution:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 129
+
+Metrics/MethodLength:
+  Max: 29
+
+Metrics/AbcSize:
+  Max: 37
+
+Metrics/BlockLength:
+  Max: 12
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Style/MethodCalledOnDoEndBlock:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
+Style/ClassEqualityComparison:
+  Exclude:
+    - 'lib/rspec/memory/trace.rb'
+
+Style/StringHashKeys:
+  Exclude:
+    - 'spec/rspec/memory_spec.rb'

.rubocop_todo.yml

@@ -0,0 +1,52 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-09-17 04:59:27 UTC using RuboCop version 1.56.3.
+# 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: 7
+# Configuration parameters: Include, IgnoredGems, OnlyFor.
+# Include: **/*.gemfile, **/Gemfile, **/gems.rb
+Bundler/GemComment:
+  Exclude:
+    - 'gems.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle, Include.
+# SupportedStyles: Gemfile, gems.rb
+# Include: **/Gemfile, **/gems.rb, **/Gemfile.lock, **/gems.locked
+Bundler/GemFilename:
+  Exclude:
+    - 'gems.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'lib/rspec/memory/trace.rb'
+
+# Offense count: 2
+Lint/StructNewOverride:
+  Exclude:
+    - 'lib/rspec/memory/trace.rb'
+
+# Offense count: 3
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/rspec/memory/matchers/limit_allocations.rb'
+    - 'lib/rspec/memory/trace.rb'
+
+# Offense count: 13
+# Configuration parameters: RequireForNonPublicMethods.
+Style/DocumentationMethod:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/rspec/memory/matchers/limit_allocations.rb'
+    - 'lib/rspec/memory/trace.rb'

.ruby-version

@@ -0,0 +1 @@
+ruby-3.2.2

Guardfile

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+RSPEC_CONFIG = {
+  cmd: 'bundle exec rspec',
+  all_on_start: true,
+  all_after_pass: true,
+  halt_on_fail: true,
+  results_file: '/tmp/.guard_rspec_results-rspec-memory'
+}.freeze
+
+guard :rspec, RSPEC_CONFIG do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  %w[matchers/limit_allocations.rb trace.rb].each do |file_path|
+    watch("lib/rspec/memory/#{file_path}") { 'spec/rspec/memory_spec.rb' }
+  end
+end
+
+RUBOCOP_CONFIG = {
+  cli: '--display-cop-names --parallel',
+  all_on_start: false,
+  halt_on_fail: true
+}.freeze
+
+guard :rubocop, RUBOCOP_CONFIG do
+  watch(/.+\.rb$/)
+  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  watch('Guardfile')
+  watch('rspec-memory.gemspec')
+end

gems.rb

@@ -5,15 +5,23 @@
 
 source 'https://rubygems.org'
 
+ruby '3.2.2'
+
 # Specify your gem's dependencies in rspec-memory.gemspec
 gemspec
 
 group :maintenance, optional: true do
-	gem "bake-gem"
-	gem "bake-modernize"
+  gem 'bake-gem', '~> 0.4.0'
+  gem 'bake-modernize', '~> 0.17.8'
+end
+
+group :development, :test do
+  gem 'covered', '~> 0.25.0', require: false
+  gem 'guard-rspec', '~> 4.7'
+  gem 'guard-rubocop', '~> 1.5'
 end
 
 group :test do
-	gem "bake-test"
-	gem "bake-test-external"
+  gem 'bake-test', '~> 0.2.0'
+  gem 'bake-test-external', '~> 0.3.3'
 end

lib/rspec/memory.rb

@@ -6,5 +6,5 @@
 require_relative 'memory/matchers/limit_allocations'
 
 RSpec.shared_context RSpec::Memory do
-	include RSpec::Memory::Matchers
+  include RSpec::Memory::Matchers
 end

lib/rspec/memory/matchers/limit_allocations.rb

@@ -8,96 +8,98 @@
 require 'rspec/expectations'
 
 module RSpec
-	module Memory
-		module Matchers
-			class LimitAllocations
-				include RSpec::Matchers::Composable
-
-				def initialize(allocations = {}, count: nil, size: nil)
-					@count = count
-					@size = size
-
-					@allocations = {}
-					@errors = []
-
-					allocations.each do |klass, count|
-						self.of(klass, count: count)
-					end
-				end
-
-				def supports_block_expectations?
-					true
-				end
-
-				def of(klass, **limits)
-					@allocations[klass] = limits
-
-					return self
-				end
-
-				private def check(value, limit)
-					case limit
-					when Range
-						unless limit.include? value
-							yield "expected within #{limit}"
-						end
-					when Integer
-						unless value == limit
-							yield "expected exactly #{limit}"
-						end
-					end
-				end
-
-				def matches?(given_proc)
-					return true unless trace = Trace.capture(@allocations.keys, &given_proc)
-
-					if @count or @size
-						# If the spec specifies a total limit, we have a limit which we can enforce which takes all allocations into account:
-						total = trace.total
-
-						check(total.count, @count) do |expected|
-							@errors << "allocated #{total.count} instances, #{total.size} bytes, #{expected} instances"
-						end if @count
-
-						check(total.size, @size) do |expected|
-							@errors << "allocated #{total.count} instances, #{total.size} bytes, #{expected} bytes"
-						end if @size
-					else
-						# Otherwise unspecified allocations are considered an error:
-						trace.ignored.each do |klass, allocation|
-							@errors << "allocated #{allocation.count} #{klass} instances, #{allocation.size} bytes, but it was not specified"
-						end
-					end
-
-					trace.allocated.each do |klass, allocation|
-						next unless acceptable = @allocations[klass]
-
-						check(allocation.count, acceptable[:count]) do |expected|
-							@errors << "allocated #{allocation.count} #{klass} instances, #{allocation.size} bytes, #{expected} instances"
-						end
-
-						check(allocation.size, acceptable[:size]) do |expected|
-							@errors << "allocated #{allocation.count} #{klass} instances, #{allocation.size} bytes, #{expected} bytes"
-						end
-					end
-
-					return @errors.empty?
-				end
-
-				def failure_message
-					"exceeded allocation limit: #{@errors.join(', ')}"
-				end
-			end
-
-			if respond_to?(:ruby2_keywords, true)
-				def limit_allocations(count: nil, size: nil, **allocations)
-					LimitAllocations.new(allocations, count: count, size: size)
-				end
-			else
-				def limit_allocations(*arguments)
-					LimitAllocations.new(*arguments)
-				end
-			end
-		end
-	end
+  module Memory
+    module Matchers
+      class LimitAllocations
+        include RSpec::Matchers::Composable
+
+        def initialize(allocations = {}, count: nil, size: nil)
+          @count = count
+          @size = size
+
+          @allocations = {}
+          @errors = []
+
+          allocations.each do |klass, cnt|
+            of(klass, count: cnt)
+          end
+        end
+
+        def supports_block_expectations?
+          true
+        end
+
+        def of(klass, **limits)
+          @allocations[klass] = limits
+
+          self
+        end
+
+        def matches?(given_proc)
+          return true unless (trace = Trace.capture(@allocations.keys, &given_proc))
+
+          if @count || @size
+            # If the spec specifies a total limit, we have a limit which we can enforce which takes all allocations into account:
+            total = trace.total
+
+            if @count
+              check(total.count, @count) do |expected|
+                @errors << "allocated #{total.count} instances, #{total.size} bytes, #{expected} instances"
+              end
+            end
+
+            if @size
+              check(total.size, @size) do |expected|
+                @errors << "allocated #{total.count} instances, #{total.size} bytes, #{expected} bytes"
+              end
+            end
+          else
+            # Otherwise unspecified allocations are considered an error:
+            trace.ignored.each do |klass, allocation|
+              @errors << "allocated #{allocation.count} #{klass} instances, #{allocation.size} bytes, but it was not specified"
+            end
+          end
+
+          trace.allocated.each do |klass, allocation|
+            next unless (acceptable = @allocations[klass])
+
+            check(allocation.count, acceptable[:count]) do |expected|
+              @errors << "allocated #{allocation.count} #{klass} instances, #{allocation.size} bytes, #{expected} instances"
+            end
+
+            check(allocation.size, acceptable[:size]) do |expected|
+              @errors << "allocated #{allocation.count} #{klass} instances, #{allocation.size} bytes, #{expected} bytes"
+            end
+          end
+
+          @errors.empty?
+        end
+
+        private
+
+        def check(value, limit)
+          case limit
+          when Range
+            yield "expected within #{limit}" unless limit.include? value
+          when Integer
+            yield "expected exactly #{limit}" unless value == limit
+          end
+        end
+
+        def failure_message
+          "exceeded allocation limit: #{@errors.join(', ')}"
+        end
+      end
+
+      if respond_to?(:ruby2_keywords, true)
+        def limit_allocations(count: nil, size: nil, **allocations)
+          LimitAllocations.new(allocations, count:, size:)
+        end
+      else
+        def limit_allocations(*)
+          LimitAllocations.new(*)
+        end
+      end
+    end
+  end
 end