rspec-request_describer 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f663222473fe59484bc2e7b66a12a0f00edbd594fe8c7213b25e65c09e301b5e
-  data.tar.gz: ff27bc035f85f243c1fbd9724f215329b700cabb963e99a23d3a795226c5d868
+  metadata.gz: de9d2d420aea6eaecc42d619a9b1d8f0088def0dd316a88fa13861b53437ef98
+  data.tar.gz: 17cd3e64fe24ac5f0818f77514ee340cd94dc3c879544ea48bddaed84f425862
 SHA512:
-  metadata.gz: f4f0580c22c26f5c1d3ce15f7f14d7e24fba46bfb7b471b5d84c7d634965f5d981e467740e1484e6bfc5a081176439e0e608fcd151de317c673c8870e9d7c535
-  data.tar.gz: 219b07cde7c240ba1a2b42cb5ba433c7fec176f5bc32397ca09389dd774a3b214539f5e35d03410b0a9bdeb902fe339c2513aa2a7696fc46f8b14bd103a43db9
+  metadata.gz: f0a1c4c9cb78bc8030407b1933c5ce8f63ad42ee2e7eb115639800ef431d6a149c436241fc9b4daecd1e2b3cd9ef21924426da68a70b2a372a5b30b92bd671d0
+  data.tar.gz: 117491f2b88edde6a0f3a7271b99f5223a6389da5624b35bb014408f5b6539e64d5235d66ea01de9599f88007fb58520201e9068210f74ec872aa6052a5199da

data/.rubocop.yml

@@ -1,13 +1,4 @@
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/LineLength:
-  Enabled: false
-
-Metrics/MethodLength:
+Metrics:
   Enabled: false
 
 Style/Documentation:

data/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 ## Unreleased
 
+## 0.6.0 - 2024-08-02
+
+### Changed
+
+- Drop Ruby 2.6- support.
+
+### Fixed
+
+- Reduce some files from gem package.
+- Correct some RuboCop offenses.
+
+## 0.5.0 - 2024-03-28
+
+### Added
+
+- Raise friendly error on incorrect `describe` usage.
+
 ## 0.4.0 - 2023-07-10
 
 ### Added

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:
 
@@ -12,33 +12,18 @@ This gem is designed for:
 
 ## Setup
 
-### Install
-
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rspec-request_describer'
-```
-
-And then execute:
-
-```
-bundle
-```
-
-Or install it yourself as:
-
-```
-gem install rspec-request_describer
+group :test do
+  gem 'rspec-request_describer'
+end
 ```
 
-### Include
-
-Include `RSpec::RequestDescriber` to your example groups like this:
+And then include `RSpec::RequestDescriber`:
 
 ```ruby
-require 'rspec/request_describer'
-
+# spec/rails_helper.rb
 RSpec.configure do |config|
   config.include RSpec::RequestDescriber, type: :request
 end
@@ -46,15 +31,42 @@ end
 
 ## Usage
 
-Note that this is an example in a Rails app.
+Write HTTP method and URL path in the top-level description of your request-specs.
 
-### subject
+```ruby
+# spec/requests/users/index_spec.rb
+RSpec.describe 'GET /users' do
+  it 'returns 200' do
+    subject
+    expect(response).to have_http_status(200)
+  end
+end
+```
 
-`RSpec::RequestDescriber` provides `subject` from its top-level description.
+Internally, `RSpec::RequestDescriber` defines `subject` and some `let` from its top-level description like this:
 
 ```ruby
-# subject will be `get('/users')`.
 RSpec.describe 'GET /users' do
+  subject do
+    __send__(http_method, path, headers:, params:)
+  end
+
+  let(:http_method) do
+    'get'
+  end
+
+  let(:path) do
+    '/users'
+  end
+
+  let(:headers) do
+    {}
+  end
+
+  let(:params) do
+    {}
+  end
+
   it 'returns 200' do
     subject
     expect(response).to have_http_status(200)
@@ -64,10 +76,9 @@ end
 
 ### headers
 
-If you want to modify request headers, change `headers` before calling `subject`.
+If you want to modify request headers, change `headers`:
 
 ```ruby
-# `subject` will be `get('/users', headers: { 'Authorization' => 'token 12345' })`.
 RSpec.describe 'GET /users' do
   context 'with Authorization header' do
     before do
@@ -84,10 +95,9 @@ end
 
 ### params
 
-If you want to modify request parameters, change `params` before calling `subject`.
+If you want to modify request parameters, change `params`:
 
 ```ruby
-# `subject` will be `get('/users', params: { 'sort' => 'id' })`.
 RSpec.describe 'GET /users' do
   context 'with sort parameter' do
     before do
@@ -111,10 +121,9 @@ 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 from `#user_id` method will be embedded as its real value.
 
 ```ruby
-# `subject` will be `get("/users/#{user_id}")`.
 RSpec.describe 'GET /users/:user_id' do
   let(:user) do
     User.create(name: 'alice')

data/Rakefile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'

data/lib/rspec/request_describer/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module RSpec
   module RequestDescriber
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.6.0'
   end
 end

data/lib/rspec/request_describer.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'rspec/request_describer/version'
 
 module RSpec
   module RequestDescriber
+    class IncorrectDescribe < StandardError; end
+
     RESERVED_HEADER_NAMES = %w[
       content-type
       host
@@ -54,7 +58,7 @@ module RSpec
           let(:env) do
             headers.inject({}) do |result, (key, value)|
               key = key.to_s
-              key = 'HTTP_' + key unless RESERVED_HEADER_NAMES.include?(key.downcase)
+              key = "HTTP_#{key}" unless RESERVED_HEADER_NAMES.include?(key.downcase)
               key = key.tr('-', '_').upcase
               result.merge(key => value)
             end
@@ -62,7 +66,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"`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-request_describer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -17,21 +17,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/test.yml"
-- ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/rspec/request_describer.rb
 - lib/rspec/request_describer/version.rb
-- rspec-request_describer.gemspec
-- spec/rspec/request_describer_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/r7kamura/rspec-request_describer
 licenses:
 - MIT
@@ -44,17 +37,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.5.11
 signing_key: 
 specification_version: 4
 summary: An RSpec plugin to write self-documenting request-specs.
-test_files:
-- spec/rspec/request_describer_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.github/workflows/test.yml

@@ -1,17 +0,0 @@
-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/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/Gemfile

@@ -1,8 +0,0 @@
-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,52 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rspec-request_describer (0.4.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    diff-lcs (1.3)
-    jaro_winkler (1.5.1)
-    parallel (1.12.1)
-    parser (2.5.3.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.61.1)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake
-  rspec
-  rspec-request_describer!
-  rubocop
-
-BUNDLED WITH
-   2.2.29

data/rspec-request_describer.gemspec

@@ -1,18 +0,0 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rspec/request_describer/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'rspec-request_describer'
-  spec.version       = RSpec::RequestDescriber::VERSION
-  spec.authors       = ['Ryo Nakamura']
-  spec.email         = ['r7kamura@gmail.com']
-  spec.summary       = 'An RSpec plugin to write self-documenting request-specs.'
-  spec.homepage      = 'https://github.com/r7kamura/rspec-request_describer'
-  spec.license       = 'MIT'
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  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']
-end

data/spec/rspec/request_describer_spec.rb

@@ -1,141 +0,0 @@
-require 'openssl'
-
-RSpec.describe RSpec::RequestDescriber do
-  include RSpec::RequestDescriber
-
-  def get(*args)
-    [__method__, *args]
-  end
-
-  describe 'GET /users' do
-    it 'calls #get' do
-      is_expected.to eq(
-        [
-          :get,
-          '/users',
-          headers: {},
-          params: {}
-        ]
-      )
-    end
-
-    context 'with headers' do
-      let(:headers) do
-        super().merge('Authorization' => 'token 12345')
-      end
-
-      it 'calls #get with HTTP_ prefixed and upper-cased headers' do
-        is_expected.to eq(
-          [
-            :get,
-            '/users',
-            headers: { 'HTTP_AUTHORIZATION' => 'token 12345' },
-            params: {}
-          ]
-        )
-      end
-    end
-
-    context 'with headers including reserved header name' do
-      let(:headers) do
-        super().merge('Https' => 'on')
-      end
-
-      it 'calls #get with headers with non HTTP_ prefixed and upper-cased headers' do
-        is_expected.to eq(
-          [
-            :get,
-            '/users',
-            headers: { 'HTTPS' => 'on' },
-            params: {}
-          ]
-        )
-      end
-    end
-
-    context 'with symbolized keys headers' do
-      let(:headers) do
-        super().merge(AUTHORIZATION: 'token 12345')
-      end
-
-      it 'calls #get with HTTP_ prefixed and stringified keys headers' do
-        is_expected.to eq(
-          [
-            :get,
-            '/users',
-            headers: { 'HTTP_AUTHORIZATION' => 'token 12345' },
-            params: {}
-          ]
-        )
-      end
-    end
-
-    context 'with headers including request body' do
-      before do
-        headers['X-Signature'] = "sha1=#{OpenSSL::HMAC.hexdigest('SHA1', 'secret', request_body.to_s)}"
-      end
-
-      it 'calls #get with HTTP_ prefixed and stringified keys headers' do
-        is_expected.to eq(
-          [
-            :get,
-            '/users',
-            headers: { 'HTTP_X_SIGNATURE' => 'sha1=5d61605c3feea9799210ddcb71307d4ba264225f' },
-            params: {}
-          ]
-        )
-      end
-    end
-
-    context 'with params' do
-      let(:params) do
-        super().merge('sort' => 'id')
-      end
-
-      it 'calls #get with params' do
-        is_expected.to eq(
-          [
-            :get,
-            '/users',
-            headers: {},
-            params: { 'sort' => 'id' }
-          ]
-        )
-      end
-    end
-
-    context 'with symbolized keys params' do
-      let(:params) do
-        super().merge(sort: 'id')
-      end
-
-      it 'calls #get with stringified keys params' do
-        is_expected.to eq(
-          [
-            :get,
-            '/users',
-            headers: {},
-            params: { 'sort' => 'id' }
-          ]
-        )
-      end
-    end
-  end
-
-  describe 'GET /users/:user_id' do
-    let(:user_id) do
-      1
-    end
-
-    it 'calles #get with embeded variable in URL path' do
-      is_expected.to eq(
-        [
-          :get,
-          '/users/1',
-          headers: {},
-          params: {}
-        ]
-      )
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,21 +0,0 @@
-require 'rspec/request_describer'
-
-RSpec.configure do |config|
-  config.expect_with :rspec do |expectations|
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  config.mock_with :rspec do |mocks|
-    mocks.verify_partial_doubles = true
-  end
-
-  config.shared_context_metadata_behavior = :apply_to_host_groups
-
-  config.filter_run_when_matching :focus
-
-  config.disable_monkey_patching!
-
-  config.warnings = true
-
-  config.default_formatter = 'doc' if config.files_to_run.one?
-end