rspec-request_describer 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f663222473fe59484bc2e7b66a12a0f00edbd594fe8c7213b25e65c09e301b5e
-  data.tar.gz: ff27bc035f85f243c1fbd9724f215329b700cabb963e99a23d3a795226c5d868
+  metadata.gz: 813d1506690f4cf7e4d0857dcdf1435fef147991f7ed62c38bf84c9cde8b7939
+  data.tar.gz: 0f4344c220644c8219596c95131fa0a39b550ed1495c93a438cd04f5e5f86f1f
 SHA512:
-  metadata.gz: f4f0580c22c26f5c1d3ce15f7f14d7e24fba46bfb7b471b5d84c7d634965f5d981e467740e1484e6bfc5a081176439e0e608fcd151de317c673c8870e9d7c535
-  data.tar.gz: 219b07cde7c240ba1a2b42cb5ba433c7fec176f5bc32397ca09389dd774a3b214539f5e35d03410b0a9bdeb902fe339c2513aa2a7696fc46f8b14bd103a43db9
+  metadata.gz: b01cd40a7f9e7053ee8b513adb33457d64701eb5afe710ecc22e784f300710a14f822d99d6568bcb43a46ca79f73c8b8e0e2d09396bc344f43a97d474cd4a8b0
+  data.tar.gz: 6aee8e0079e15f6e16061ef34289a7d2c7271591cb65fccf3772c83c1db0a0832e2a47ba52586db6dea756abcce3bbec9cb9ad5d7b7b1fe326c7c6958ac981de

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 0.5.0 - 2024-03-28
+
+### Added
+
+- Raise friendly error on incorrect `describe` usage.
+
 ## 0.4.0 - 2023-07-10
 
 ### Added

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-request_describer (0.4.0)
+    rspec-request_describer (0.5.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -3,7 +3,7 @@
 [![test](https://github.com/r7kamura/rspec-request_describer/actions/workflows/test.yml/badge.svg)](https://github.com/r7kamura/rspec-request_describer/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/rspec-request_describer.svg)](https://rubygems.org/gems/rspec-request_describer)
 
-An RSpec plugin to write self-documenting request-specs.
+RSpec plugin to write self-documenting request-specs.
 
 This gem is designed for:
 
@@ -111,7 +111,7 @@ end
 ### path parameters
 
 You can embed variables in URL path like `/users/:user_id`.
-In this example, the returned value of `user_id` method will be emobeded as its real value.
+In this example, the returned value of `user_id` method will be embedded as its real value.
 
 ```ruby
 # `subject` will be `get("/users/#{user_id}")`.

data/lib/rspec/request_describer/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module RequestDescriber
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.5.0'.freeze
   end
 end

data/lib/rspec/request_describer.rb

@@ -2,6 +2,8 @@ require 'rspec/request_describer/version'
 
 module RSpec
   module RequestDescriber
+    class IncorrectDescribe < StandardError; end
+
     RESERVED_HEADER_NAMES = %w[
       content-type
       host
@@ -62,7 +64,10 @@ module RSpec
 
           let(:endpoint_segments) do
             current_example = ::RSpec.respond_to?(:current_example) ? ::RSpec.current_example : example
-            current_example.full_description.match(/(#{::Regexp.union(SUPPORTED_METHODS)}) (\S+)/).to_a
+            match = current_example.full_description.match(/(#{::Regexp.union(SUPPORTED_METHODS)}) (\S+)/)
+            raise IncorrectDescribe, 'Please use the format "METHOD /path" for the describe' unless match
+
+            match.to_a
           end
 
           # @return [String] e.g. `"get"`

data/spec/rspec/request_describer_spec.rb

@@ -138,4 +138,10 @@ RSpec.describe RSpec::RequestDescriber do
       )
     end
   end
+
+  context 'when the test case is under the top-level describe unexpectedly' do
+    it 'handles the error' do
+      expect { subject }.to raise_error(RSpec::RequestDescriber::IncorrectDescribe)
+    end
+  end
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: rspec-request_describer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2024-03-28 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email:
 - r7kamura@gmail.com
 executables: []
@@ -36,7 +36,7 @@ homepage: https://github.com/r7kamura/rspec-request_describer
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,8 +51,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: An RSpec plugin to write self-documenting request-specs.
 test_files: