refactor(rspec): split convenient service and primitive helpers

marian13 · Sep 26, 2023 · 860357b · 860357b
1 parent 7d214a5
commit 860357b
Show file tree

Hide file tree

Showing 16 changed files with 70 additions and 37 deletions.
diff --git a/lib/convenient_service/rspec.rb b/lib/convenient_service/rspec.rb
@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "rspec/primitive_helpers"
 require_relative "rspec/helpers"
 
 require_relative "rspec/primitive_matchers"

diff --git a/lib/convenient_service/rspec/helpers.rb b/lib/convenient_service/rspec/helpers.rb
@@ -3,7 +3,6 @@
 require_relative "helpers/classes"
 
 require_relative "helpers/ignoring_exception"
-require_relative "helpers/in_threads"
 require_relative "helpers/stub_service"
 require_relative "helpers/wrap_method"
 
@@ -13,10 +12,9 @@ module Helpers
       include Support::Concern
 
       included do
-        include Helpers::IgnoringException
-        include Helpers::InThreads
-        include Helpers::StubService
-        include Helpers::WrapMethod
+        include IgnoringException
+        include StubService
+        include WrapMethod
       end
     end
   end

diff --git a/lib/convenient_service/rspec/helpers/classes.rb b/lib/convenient_service/rspec/helpers/classes.rb
@@ -1,6 +1,4 @@
 # frozen_string_literal: true
 
-require_relative "classes/ignoring_exception"
-require_relative "classes/in_threads"
 require_relative "classes/stub_service"
 require_relative "classes/wrap_method"
diff --git a/lib/convenient_service/rspec/helpers/ignoring_exception.rb b/lib/convenient_service/rspec/helpers/ignoring_exception.rb
@@ -5,7 +5,7 @@ module RSpec
     module Helpers
       module IgnoringException
         def ignoring_exception(...)
-          Classes::IgnoringException.call(...)
+          RSpec::PrimitiveHelpers::Classes::IgnoringException.call(...)
         end
       end
     end

diff --git a/lib/convenient_service/rspec/matchers.rb b/lib/convenient_service/rspec/matchers.rb
@@ -14,11 +14,11 @@ module Matchers
       include Support::Concern
 
       included do
-        include Matchers::CallChainNext
-        include Matchers::DelegateTo
-        include Matchers::Export
-        include Matchers::IncludeModule
-        include Matchers::Results
+        include CallChainNext
+        include DelegateTo
+        include Export
+        include IncludeModule
+        include Results
       end
     end
   end

diff --git a/lib/convenient_service/rspec/primitive_helpers.rb b/lib/convenient_service/rspec/primitive_helpers.rb
@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "primitive_helpers/classes"
+
+require_relative "primitive_helpers/ignoring_exception"
+require_relative "primitive_helpers/in_threads"
+
+module ConvenientService
+  module RSpec
+    module PrimitiveHelpers
+      include Support::Concern
+
+      included do
+        include IgnoringException
+        include InThreads
+      end
+    end
+  end
+end
diff --git a/lib/convenient_service/rspec/primitive_helpers/classes.rb b/lib/convenient_service/rspec/primitive_helpers/classes.rb
@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "classes/ignoring_exception"
+require_relative "classes/in_threads"
diff --git a/...pec/helpers/classes/ignoring_exception.rb → ...ive_helpers/classes/ignoring_exception.rb b/...pec/helpers/classes/ignoring_exception.rb → ...ive_helpers/classes/ignoring_exception.rb
@@ -4,7 +4,7 @@
 
 module ConvenientService
   module RSpec
-    module Helpers
+    module PrimitiveHelpers
       module Classes
         class IgnoringException < Support::Command
           ##
@@ -30,7 +30,7 @@ def initialize(exception, &block)
 
           ##
           # @return [ConvenientService::Support::UniqueValue]
-          # @raise [ConvenientService::RSpec::Helpers::Classes::IgnoringException::Exceptions::IgnoredExceptionIsNotRaised]
+          # @raise [ConvenientService::RSpec::PrimitiveHelpers::Classes::IgnoringException::Exceptions::IgnoredExceptionIsNotRaised]
           #
           # @note Rescue `StandardError`, NOT `Exception`.
           # @see https://thoughtbot.com/blog/rescue-standarderror-not-exception

diff --git a/.../classes/ignoring_exception/exceptions.rb → .../classes/ignoring_exception/exceptions.rb b/.../classes/ignoring_exception/exceptions.rb → .../classes/ignoring_exception/exceptions.rb
@@ -2,7 +2,7 @@
 
 module ConvenientService
   module RSpec
-    module Helpers
+    module PrimitiveHelpers
       module Classes
         class IgnoringException < Support::Command
           module Exceptions

diff --git a/...rvice/rspec/helpers/classes/in_threads.rb → ...c/primitive_helpers/classes/in_threads.rb b/...rvice/rspec/helpers/classes/in_threads.rb → ...c/primitive_helpers/classes/in_threads.rb
@@ -2,7 +2,7 @@
 
 module ConvenientService
   module RSpec
-    module Helpers
+    module PrimitiveHelpers
       module Classes
         # @internal
         #   TODO: Specs.

diff --git a/lib/convenient_service/rspec/primitive_helpers/ignoring_exception.rb b/lib/convenient_service/rspec/primitive_helpers/ignoring_exception.rb
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ConvenientService
+  module RSpec
+    module PrimitiveHelpers
+      module IgnoringException
+        def ignoring_exception(...)
+          Classes::IgnoringException.call(...)
+        end
+      end
+    end
+  end
+end
diff --git a/...nient_service/rspec/helpers/in_threads.rb → ...ice/rspec/primitive_helpers/in_threads.rb b/...nient_service/rspec/helpers/in_threads.rb → ...ice/rspec/primitive_helpers/in_threads.rb
@@ -2,7 +2,7 @@
 
 module ConvenientService
   module RSpec
-    module Helpers
+    module PrimitiveHelpers
       module InThreads
         def in_threads(...)
           Classes::InThreads.call(...)

diff --git a/lib/convenient_service/rspec/primitive_matchers.rb b/lib/convenient_service/rspec/primitive_matchers.rb
@@ -22,19 +22,19 @@ module PrimitiveMatchers
       include Support::Concern
 
       included do
-        include PrimitiveMatchers::BeDescendantOf
-        include PrimitiveMatchers::BeDirectDescendantOf
-        include PrimitiveMatchers::CacheItsValue
-        include PrimitiveMatchers::DelegateTo
-        include PrimitiveMatchers::ExtendModule
-        include PrimitiveMatchers::HaveAbstractMethod
-        include PrimitiveMatchers::HaveAliasMethod
-        include PrimitiveMatchers::HaveAttrAccessor
-        include PrimitiveMatchers::HaveAttrReader
-        include PrimitiveMatchers::HaveAttrWriter
-        include PrimitiveMatchers::IncludeModule
-        include PrimitiveMatchers::PrependModule
-        include PrimitiveMatchers::SingletonPrependModule
+        include BeDescendantOf
+        include BeDirectDescendantOf
+        include CacheItsValue
+        include DelegateTo
+        include ExtendModule
+        include HaveAbstractMethod
+        include HaveAliasMethod
+        include HaveAttrAccessor
+        include HaveAttrReader
+        include HaveAttrWriter
+        include IncludeModule
+        include PrependModule
+        include SingletonPrependModule
       end
     end
   end

diff --git a/...ses/ignoring_exception/exceptions_spec.rb → ...ses/ignoring_exception/exceptions_spec.rb b/...ses/ignoring_exception/exceptions_spec.rb → ...ses/ignoring_exception/exceptions_spec.rb
@@ -4,7 +4,7 @@
 
 require "convenient_service"
 
-RSpec.describe ConvenientService::RSpec::Helpers::Classes::IgnoringException::Exceptions do
+RSpec.describe ConvenientService::RSpec::PrimitiveHelpers::Classes::IgnoringException::Exceptions do
   include ConvenientService::RSpec::PrimitiveMatchers::BeDescendantOf
 
   specify { expect(described_class::IgnoredExceptionIsNotRaised).to be_descendant_of(ConvenientService::Exception) }

diff --git a/...elpers/classes/ignoring_exception_spec.rb → ...elpers/classes/ignoring_exception_spec.rb b/...elpers/classes/ignoring_exception_spec.rb → ...elpers/classes/ignoring_exception_spec.rb
@@ -5,7 +5,7 @@
 require "convenient_service"
 
 # rubocop:disable RSpec/NestedGroups, RSpec/MultipleMemoizedHelpers
-RSpec.describe ConvenientService::RSpec::Helpers::Classes::IgnoringException do
+RSpec.describe ConvenientService::RSpec::PrimitiveHelpers::Classes::IgnoringException do
   include ConvenientService::RSpec::Matchers::DelegateTo
 
   example_group "instance methods" do
@@ -22,9 +22,9 @@
           TEXT
         end
 
-        it "raises `ConvenientService::RSpec::Helpers::Classes::IgnoringException::Exceptions::IgnoredExceptionIsNotRaised`" do
+        it "raises `ConvenientService::RSpec::PrimitiveHelpers::Classes::IgnoringException::Exceptions::IgnoredExceptionIsNotRaised`" do
           expect { command_result }
-            .to raise_error(ConvenientService::RSpec::Helpers::Classes::IgnoringException::Exceptions::IgnoredExceptionIsNotRaised)
+            .to raise_error(ConvenientService::RSpec::PrimitiveHelpers::Classes::IgnoringException::Exceptions::IgnoredExceptionIsNotRaised)
             .with_message(exception_message)
         end
       end

diff --git a/spec/lib/convenient_service/support/thread_safe_counter_spec.rb b/spec/lib/convenient_service/support/thread_safe_counter_spec.rb
@@ -6,8 +6,8 @@
 
 # rubocop:disable RSpec/NestedGroups, RSpec/MultipleMemoizedHelpers
 RSpec.describe ConvenientService::Support::ThreadSafeCounter do
-  include ConvenientService::RSpec::Helpers::IgnoringException
-  include ConvenientService::RSpec::Helpers::InThreads
+  include ConvenientService::RSpec::PrimitiveHelpers::IgnoringException
+  include ConvenientService::RSpec::PrimitiveHelpers::InThreads
 
   let(:counter) { described_class.new(initial_value: initial_value, min_value: min_value, max_value: max_value) }
   let(:initial_value) { 0 }