rspec-request_describer 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb25f4acd8dc319c2dffca1e50b4fd19e9bae956b7d677dfa09ea438544628c3
-  data.tar.gz: 22ee332cdbac790b599aa6a344dd600a47a57c2a7cc40b21a0e8786fba36a2f4
+  metadata.gz: 813d1506690f4cf7e4d0857dcdf1435fef147991f7ed62c38bf84c9cde8b7939
+  data.tar.gz: 0f4344c220644c8219596c95131fa0a39b550ed1495c93a438cd04f5e5f86f1f
 SHA512:
-  metadata.gz: 17863cbb7b007fd4bba582748b1b899d02a20eafa1767f58a3020036489d58032e96b97df9c5d1a48b0745365f479b808fc5b92a0f19b809381ecb3029f91558
-  data.tar.gz: 0354a83be4bf146da8eeb26ad338b733338e24ef0efd2fa79059d64750e8c0543544f07df2f9a8e38085c5b8e1877b79f2ee25be80d59fc3d453077d3d4bbd4f
+  metadata.gz: b01cd40a7f9e7053ee8b513adb33457d64701eb5afe710ecc22e784f300710a14f822d99d6568bcb43a46ca79f73c8b8e0e2d09396bc344f43a97d474cd4a8b0
+  data.tar.gz: 6aee8e0079e15f6e16061ef34289a7d2c7271591cb65fccf3772c83c1db0a0832e2a47ba52586db6dea756abcce3bbec9cb9ad5d7b7b1fe326c7c6958ac981de

data/.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  rspec:
+    uses: r7kamura/workflows/.github/workflows/ruby-rspec.yml@main
+    with:
+      ruby-version: 2.7.4
+  rubocop:
+    uses: r7kamura/workflows/.github/workflows/ruby-rubocop.yml@main
+    with:
+      ruby-version: 2.7.4

data/CHANGELOG.md

@@ -1,19 +1,32 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+## Unreleased
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## 0.5.0 - 2024-03-28
 
-## v0.3.2 - 2020-02-15
+### Added
+
+- Raise friendly error on incorrect `describe` usage.
+
+## 0.4.0 - 2023-07-10
+
+### Added
+
+- Support HEAD HTTP method.
+
+## 0.3.2 - 2020-02-15
+
+### Removed
 
 - Remove runtime gem dependency on actionpack.
 
-## v0.3.1 - 2019-05-08
+## 0.3.1 - 2019-05-08
+
+### Fixed
 
 - Fix env calculation timing.
 
-## v0.3.0 - 2019-05-05
+## 0.3.0 - 2019-05-05
 
 ### Added
 

data/Gemfile

@@ -3,5 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rspec-request_describer.gemspec
 gemspec
 
+gem 'rake'
 gem 'rspec'
 gem 'rubocop'

data/Gemfile.lock

@@ -1,60 +1,20 @@
 PATH
   remote: .
   specs:
-    rspec-request_describer (0.2.2)
-      actionpack (>= 5.0.0)
+    rspec-request_describer (0.5.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (5.2.2)
-      actionview (= 5.2.2)
-      activesupport (= 5.2.2)
-      rack (~> 2.0)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.2)
-      activesupport (= 5.2.2)
-      builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activesupport (5.2.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
     ast (2.4.0)
-    builder (3.2.3)
-    concurrent-ruby (1.1.3)
-    crass (1.0.4)
     diff-lcs (1.3)
-    erubi (1.7.1)
-    i18n (1.1.1)
-      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
-    loofah (2.2.3)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
     parallel (1.12.1)
     parser (2.5.3.0)
       ast (~> 2.4.0)
     powerpack (0.1.2)
-    rack (2.0.6)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -77,20 +37,16 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.7)
-  rake (~> 10.0)
+  rake
   rspec
   rspec-request_describer!
   rubocop
 
 BUNDLED WITH
-   1.17.1
+   2.2.29

data/README.md

@@ -1,9 +1,9 @@
 # RSpec::RequestDescriber
 
-[![CircleCI](https://circleci.com/gh/r7kamura/rspec-request_describer.svg?style=svg)](https://circleci.com/gh/r7kamura/rspec-request_describer)
+[![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:
 
@@ -39,11 +39,15 @@ Include `RSpec::RequestDescriber` to your example groups like this:
 ```ruby
 require 'rspec/request_describer'
 
-RSpec.configuration.include RSpec::RequestDescriber, type: :request
+RSpec.configure do |config|
+  config.include RSpec::RequestDescriber, type: :request
+end
 ```
 
 ## Usage
 
+Note that this is an example in a Rails app.
+
 ### subject
 
 `RSpec::RequestDescriber` provides `subject` from its top-level description.
@@ -51,7 +55,10 @@ RSpec.configuration.include RSpec::RequestDescriber, type: :request
 ```ruby
 # subject will be `get('/users')`.
 RSpec.describe 'GET /users' do
-  it { is_expected.to eq(200) }
+  it 'returns 200' do
+    subject
+    expect(response).to have_http_status(200)
+  end
 end
 ```
 
@@ -66,7 +73,11 @@ RSpec.describe 'GET /users' do
     before do
       headers['Authorization'] = 'token 12345'
     end
-    it { is_expected.to eq(200) }
+
+    it 'returns 200' do
+      subject
+      expect(response).to have_http_status(200)
+    end
   end
 end
 ```
@@ -83,21 +94,24 @@ RSpec.describe 'GET /users' do
       params['sort'] = 'id'
     end
 
-    it 'returns users in ID order' do
-      is_expected.to eq(200)
-
-      users = JSON.parse(response.body)
-      expect(users[0]['id']).to eq(1)
-      expect(users[1]['id']).to eq(2)
+    it 'returns 200 with expected JSON body' do
+      subject
+      expect(response).to have_http_status(200)
+      expect(response.parsed_body).to match(
+        [
+          hash_including('id' => 1),
+          hash_including('id' => 2),
+        ]
+      )
     end
   end
 end
 ```
 
-### variables in URL path
+### path parameters
 
-You can embed variables in URL path like `/users/:id`.
-In this example, the returned value of `id` method will be emobeded as its real value.
+You can embed variables in URL path like `/users/:user_id`.
+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}")`.
@@ -110,6 +124,9 @@ RSpec.describe 'GET /users/:user_id' do
     user.id
   end
 
-  it { is_expected.to eq(200) }
+  it 'returns 200' do
+    subject
+    expect(response).to have_http_status(200)
+  end
 end
 ```

data/lib/rspec/request_describer/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module RequestDescriber
-    VERSION = '0.3.2'.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
@@ -11,6 +13,7 @@ module RSpec
     SUPPORTED_METHODS = %w[
       DELETE
       GET
+      HEAD
       PATCH
       POST
       PUT
@@ -61,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/rspec-request_describer.gemspec

@@ -15,7 +15,4 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
 end

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,51 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: rspec-request_describer
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Ryo Nakamura
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+date: 2024-03-28 00:00:00.000000000 Z
+dependencies: []
+description:
 email:
 - r7kamura@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -64,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
@@ -79,8 +51,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: An RSpec plugin to write self-documenting request-specs.
 test_files:

data/.circleci/config.yml

@@ -1,46 +0,0 @@
-jobs:
-  rspec:
-    docker:
-      - image: ruby:2.5.3
-    steps:
-      - checkout
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-            - v1-dependencies-
-      - run:
-          command: bundle install --jobs=4 --retry=3 --path vendor/bundle
-          name: bundle install
-      - save_cache:
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-          paths:
-            - ./vendor/bundle
-      - run:
-          command: bundle exec rspec
-          name: rspec
-  rubocop:
-    docker:
-      - image: ruby:2.5.3
-    steps:
-      - checkout
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-            - v1-dependencies-
-      - run:
-          command: bundle install --jobs=4 --retry=3 --path vendor/bundle
-          name: bundle install
-      - save_cache:
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-          paths:
-            - ./vendor/bundle
-      - run:
-          command: bundle exec rubocop
-          name: rubocop
-version: 2
-workflows:
-  version: 2
-  test:
-    jobs:
-      - rspec
-      - rubocop