minitest_httplog 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff02c4de4661d1a5d5df25a5127ce92295e7a222ed0a73ab894e594b995326b
-  data.tar.gz: 9b2a45fb2162d25a64c00d6decc6aaee652fda88fe6258d01c5f9641d06f8d81
+  metadata.gz: 6b08a626237c7f9c86893ad915da4326d98f8daacf35fd8dcaa74d18aa11184f
+  data.tar.gz: 9cfff94b91a806937d178c1a6ca461b84d1315f3ee8f8ea1b7ae32299a3e5faa
 SHA512:
-  metadata.gz: bc735417440a196a532a4ddb33e8cd6b83b8348b8f30db3eb5c192b73a632511cd8951c6f580f19549a54cfdd069e4b16f360c5582255eedd2d16cacf5ddebc5
-  data.tar.gz: 39ba57880e054283350301d6eeb141b46351024c43b635fdac4de3c4e5a80efa8a6f8f860b309cc376ca16bdf7f74a05f88a8197e638bd3a6ea1c700915e877a
+  metadata.gz: a379a71fa3d7a2ebb2b2751973b3a6104489349894ee0bd73e5ec74eb4ee6ffb12a8cc17d312b87fdfc7d4ca704d94b79de4302b5bbc81878d2df927215b5244
+  data.tar.gz: 9487ce982a36a5391c859b8db2d3be5d377902d9e821baba7a7d70df22703dbf7109255d5f837a4c648da37f59e983a68ade7b31c3df0a541880db9095675d36

data/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

data/.gitignore

@@ -1,9 +1,69 @@
-/.bundle/
-/.yardoc
-/_yardoc/
+*.rbc
+capybara-*.html
+.rspec
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/db/*.sqlite3-[0-9]*
+/public/system
 /coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-*.gem
+/spec/tmp
+*.orig
+rerun.txt
+pickle-email-*.html
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/master.key
+
+# Only include if you have production secrets in this file, which is no longer a Rails default
+# config/secrets.yml
+
+# dotenv, dotenv-rails
+# TODO Comment out these rules if environment variables can be committed
+.env
+.env*.local
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+# Ignore Byebug command history file.
+.byebug_history
+
+# Ignore node_modules
+node_modules/
+
+# Ignore precompiled javascript packs
+/public/packs
+/public/packs-test
+/public/assets
+
+# Ignore yarn files
+/yarn-error.log
+yarn-debug.log*
+.yarn-integrity
+
+# Ignore uploaded files in development
+/storage/*
+!/storage/.keep
+/public/uploads

data/{LICENSE.txt → LICENSE}

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+MIT License
 
-Copyright (c) 2024 Guilherme Stefanelli
+Copyright (c) 2024 guinaldi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,8 +1,13 @@
 # MinitestHttplog
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/minitest_httplog`. To experiment with that code, run `bin/console` for an interactive prompt.
+Ruby gem designed to detect unmocked HTTP requests during tests using [Minitest](https://github.com/seattlerb/minitest) and [HttpLog](https://github.com/trusche/httplog). It intercepts HTTP requests made during tests and logs failures if any unmocked requests are detected, ensuring all external calls are properly mocked, thus improving the reliability and predictability of tests.
 
-TODO: Delete this and the text above, and describe your gem
+## Features
+
+* Automatic Detection: Automatically intercepts and detects all unmocked HTTP requests during tests.
+* Minitest Integration: Logs failures in Minitest when an unmocked request is detected, ensuring the error is visible in test results.
+* Detailed Logging: Logs detailed messages about unmocked requests, including the HTTP method, URI, and the test name.
+* Easy Configuration: Simple configuration and conditional activation only in the test environment.
 
 ## Installation
 
@@ -22,13 +27,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To use `minitest_httplog` in your tests, you need to require it in your test helper file. This gem will help you detect any unmocked HTTP requests in your tests.
+
+Here's a simple example of how to use it:
+
+1. Add the following line to your test helper file:
+
+```ruby
+require 'minitest/httplog'
+```
+
+2. Now, when you run your tests, `minitest_httplog` will raise an exception log on any HTTP requests and raise an error if they are not mocked.
+
+```console
+Failure:
+test [path]:
+Unmocked HTTP request detected: POST http://test.url during test: test_
+```
+## Configuration
+
+MinitestHttplog provides an option to ignore HTTP requests during specific test scenarios, such as when recording new VCR cassettes. This can be configured by setting the MinitestHttplog.ignore_requests attribute.
+
+Example using VCR gem:
+
+```ruby
+VCR.configure do |config|
+  config.cassette_library_dir = 'test/vcr_cassettes'
+  config.hook_into :webmock
+  config.ignore_localhost = true
+  config.allow_http_connections_when_no_cassette = false
+
+  # Configure VCR to ignore requests during recording
+  config.before_record do |i|
+    MinitestHttplog.ignore_requests = true
+  end
+
+  config.after_record do |i|
+    MinitestHttplog.ignore_requests = false
+  end
+end
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/lib/minitest_httplog/version.rb

@@ -1,3 +1,3 @@
 module MinitestHttplog
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/minitest_httplog.rb

@@ -1,11 +1,12 @@
 require 'httplog'
 require 'minitest'
 
-module HttpLogMinitest
+module MinitestHttplog
   class << self
-    attr_accessor :current_test
+    attr_accessor :current_test, :ignore_requests
 
     def init
+      @ignore_requests = false
       HttpLog.configure do |config|
         config.logger = create_logger_decorator(config.logger)
       end
@@ -42,8 +43,8 @@ module HttpLogMinitest
             uri = extract_uri(message)
             method = extract_method(message)
 
-            if uri && method
-              full_message = "Unmocked HTTP request detected: #{method} #{uri} during test: #{HttpLogMinitest.current_test}"
+            if uri && method && !MinitestHttplog.ignore_requests
+              full_message = "Unmocked HTTP request detected: #{method} #{uri} during test: #{MinitestHttplog.current_test}"
 
               raise Minitest::Assertion, full_message
             end
@@ -64,16 +65,16 @@ module HttpLogMinitest
   end
 end
 
-HttpLogMinitest.init
+MinitestHttplog.init
 
 module Minitest
   class Test
     alias_method :run_without_httplog, :run
 
     def run(*args, &block)
-      HttpLogMinitest.current_test = self.name
+      MinitestHttplog.current_test = self.name
       result = run_without_httplog(*args, &block)
-      HttpLogMinitest.current_test = nil
+      MinitestHttplog.current_test = nil
       result
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest_httplog
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Guilherme Stefanelli
@@ -115,12 +115,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - bin/console

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.6
-before_install: gem install bundler -v 2.1.4