foobara-spec-helpers 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0f6a1006e69b2a292438a457245727c5cf82c3ba46d4d9fbc591b5f2f6cc8ea
+  data.tar.gz: 5b9bfe81386aac886b40afb214a7e552e1f9da9136f3d32c61a9d98c5f4b57a7
+SHA512:
+  metadata.gz: 400e0ef3c6c607a5da9b09bf81c1b1dc5bc5aefdbc28509566ee6c6541e6817aa6ecac3f4c382fdd4e27625773094d9efb1ff0b290cd95125044fc2d55f3e9bb
+  data.tar.gz: f94444dc58209f31d597969507bd49173e506b3257e7b526924ed0f3548891a2141b03abd84f5aed23adc8dab14810a3178af98a430f5a722c2daaea71d2b7e1

data/LICENSE.txt

@@ -0,0 +1,8 @@
+foobara-spec-helpers is dual licensed under your choice of the Apache-2.0 license and the MIT license.
+
+Apache-2.0 License: LICENSE-APACHE.txt or https://www.apache.org/licenses/LICENSE-2.0.txt
+MIT License: LICENSE-MIT.txt or https://opensource.org/licenses/MIT
+
+This is equivalent to the following SPDX License Expression: Apache-2.0 OR MIT
+
+Copyright (c) 2023 Miles Georgi

data/lib/foobara/spec_helpers/all.rb

@@ -0,0 +1,2 @@
+# TODO: replace this with Util.require_directory when Util is in its own repository.
+Dir["#{__dir__}/**/*.rb"].each { |f| require f }

data/lib/foobara/spec_helpers/any.rb

@@ -0,0 +1,9 @@
+RSpec::Matchers.define :any do |expectation|
+  match do |actual|
+    actual.any? { |item| expectation === item }
+  end
+
+  failure_message do |actual|
+    "expected that at least one element in #{actual} would match #{expected}"
+  end
+end

data/lib/foobara/spec_helpers/class.rb

@@ -0,0 +1,44 @@
+module RspecHelpers
+  module StubClass
+    module ClassMethods
+      def stub_class(name, superclass = nil, which: :class, &)
+        name = name.to_s if name.is_a?(::Symbol)
+
+        unless metadata.key?(:foobara_stubbed_modules)
+          set = metadata[:foobara_stubbed_modules] = Set.new
+
+          after do
+            names = set.sort_by { |s| -s.count(":") }
+
+            names.each do |module_name|
+              Foobara::Util.remove_constant(module_name)
+            end
+
+            set.clear
+          end
+        end
+
+        metadata[:foobara_stubbed_modules] << name
+
+        Foobara::Util.make_class(name, superclass, which:, &)
+      end
+
+      def stub_module(name, &)
+        stub_class(name, which: :module, &)
+      end
+    end
+
+    def stub_class(name, superclass = nil, &)
+      self.class.stub_class(name, superclass, &)
+    end
+
+    def stub_module(name, &)
+      self.class.stub_module(name, &)
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include RspecHelpers::StubClass
+  c.extend RspecHelpers::StubClass::ClassMethods
+end

data/lib/foobara/spec_helpers/expectations.rb

@@ -0,0 +1,23 @@
+module RspecHelpers
+  module Expectations
+    def is_expected_to_raise(*, &)
+      is_expected_to raise_error(*, &)
+    end
+
+    def is_expected_to_not_raise(*, &)
+      is_expected_to_not raise_error(*, &)
+    end
+
+    def is_expected_to(expectation)
+      expect { subject }.to expectation
+    end
+
+    def is_expected_to_not(expectation)
+      expect { subject }.to_not expectation
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include RspecHelpers::Expectations
+end

data/lib/foobara/spec_helpers/stubs.rb

@@ -0,0 +1,88 @@
+module RspecHelpers
+  module Stubs
+    module ClassMethods
+      def stub_env_vars(env_vars)
+        env_vars.each_pair do |env_var, value|
+          stub_env_var(env_var, value)
+        end
+      end
+
+      def stub_env_var(env_var, value)
+        before do
+          stub_env_var(env_var, value)
+        end
+      end
+    end
+
+    def stub_env_vars(env_vars)
+      env_vars.each_pair do |env_var, value|
+        stub_env_var(env_var, value)
+      end
+    end
+
+    def stub_env_var(env_var, value)
+      env_var = env_var.to_s
+
+      unless self.class.metadata[:env_stubbed]
+        install_env_stubs
+      end
+
+      self.class.metadata[:env_stubbed][env_var] = value
+    end
+
+    private
+
+    def install_env_stubs
+      env_stubbed = {}
+
+      self.class.metadata[:env_stubbed] = env_stubbed
+      self.class.after do
+        self.class.metadata.delete(:env_stubbed)
+      end
+
+      allow(ENV).to receive(:fetch).and_wrap_original do |original_method, key, default|
+        if env_stubbed.key?(key)
+          env_stubbed[key]
+        else
+          original_method.call(key, default)
+        end
+      end
+      allow(ENV).to receive(:[]).and_wrap_original do |original_method, key|
+        if env_stubbed.key?(key)
+          env_stubbed[key]
+        else
+          original_method.call(key)
+        end
+      end
+      allow(ENV).to receive(:each).and_wrap_original do |original_method, &block|
+        original_method.call(&block)
+        env_stubbed.each(&block)
+
+        ENV
+      end
+      allow(ENV).to receive(:each_key).and_wrap_original do |original_method, &block|
+        original_method.call(&block)
+        env_stubbed.each_key(&block)
+
+        ENV
+      end
+      allow(ENV).to receive(:each_value).and_wrap_original do |original_method, &block|
+        original_method.call(&block)
+        env_stubbed.each_value(&block)
+
+        ENV
+      end
+      allow(ENV).to receive(:keys).and_wrap_original do |original_method, &block|
+        original_method.call(&block) | env_stubbed.keys
+      end
+      allow(ENV).to receive(:values).and_wrap_original do |original_method, &block|
+        original_method.call(&block) | env_stubbed.values
+      end
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.extend RspecHelpers::Stubs::ClassMethods
+  c.include RspecHelpers::Stubs
+end

data/lib/foobara/spec_helpers/version.rb

@@ -0,0 +1,5 @@
+module Foobara
+  module SpecHelpers
+    VERSION = "0.0.3".freeze
+  end
+end

data/lib/foobara/spec_helpers.rb

@@ -0,0 +1,6 @@
+require_relative "spec_helpers/version"
+
+module Foobara
+  module SpecHelpers
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: foobara-spec-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Miles Georgi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: foobara-util
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- azimux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- lib/foobara/spec_helpers.rb
+- lib/foobara/spec_helpers/all.rb
+- lib/foobara/spec_helpers/any.rb
+- lib/foobara/spec_helpers/class.rb
+- lib/foobara/spec_helpers/expectations.rb
+- lib/foobara/spec_helpers/stubs.rb
+- lib/foobara/spec_helpers/version.rb
+homepage: https://github.com/foobara/spec-helpers
+licenses:
+- Apache-2.0
+- MIT
+metadata:
+  homepage_uri: https://github.com/foobara/spec-helpers
+  source_code_uri: https://github.com/foobara/spec-helpers
+  changelog_uri: https://github.com/foobara/spec-helpers/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Common spec helpers used in various Foobara projects.
+test_files: []