ryquest 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b32ac1fdb4ae871b7e52a0df4179d982cc3a9a8bd8bc6bac8e7ea17b2858a81c
+  data.tar.gz: 80cf2f367cf8b5f321891be62fe74386f74c53b48af98309442c422e9f7c0b23
+SHA512:
+  metadata.gz: '0415958de921a0769182be9f4fa46b13937203818b88b688d8099ad744f2ad5b0da24cd00f9db2349503badb65b33daf7c50aa3f05ebc97ce80e59d872f829ec'
+  data.tar.gz: b2a4c736dc8c802ed6d482a6ace36dc7cd2f2a01b2c374a9b6d93f94265e4fedd938f926d975a0750bf087a7116d395719c46ff8ea5a441847eb277cf3aae2a8

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/.local
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.cache/
+.irb_history
+.bash_history
+.byebug_history
+
+# rspec failure tracking
+.rspec_status
+
+# Editor file
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - /bin/**
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/MethodDefParentheses:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - /app/spec/**/**/**/**/**/**/*.rb
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/Dockerfile

@@ -0,0 +1,9 @@
+##
+# Base - basic image use to run dev tools
+#
+FROM ruby:3.0.2
+
+WORKDIR /app
+
+ADD . .
+RUN bundle install

data/Gemfile

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+## CORE
+# Include dependencies
+gemspec
+
+## TEST
+# Get some tools (included by rails) in order to run test
+gem 'activesupport', '~> 6.1.4'
+# Framework
+gem 'rspec', '~> 3.10.0'
+# Coverage
+gem 'simplecov', '~> 0.19.1'
+
+## DEV TOOLS
+# Breakpoint
+gem 'byebug', '~> 11.1.3'
+# Linter
+gem 'rubocop', '~> 1.21.0'
+# Documentation
+gem 'yard', '~> 0.9.26'

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    ryquest (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.21.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.12.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  aarch64-linux
+
+DEPENDENCIES
+  activesupport (~> 6.1.4)
+  byebug (~> 11.1.3)
+  rspec (~> 3.10.0)
+  rubocop (~> 1.21.0)
+  ryquest!
+  simplecov (~> 0.19.1)
+  yard (~> 0.9.26)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Pierre Guego
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+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 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.

data/Makefile

@@ -0,0 +1,45 @@
+##
+# Simplify docker usage
+#
+container = gem_ryquest
+option = -ti --rm --user $(shell id -u):$(shell id -g) -v $(shell pwd):/app -e HOME=/app
+
+.PHONY: doc
+args = $(filter-out $@,$(MAKECMDGOALS))
+%:
+	@:
+
+# build the docker image
+install:
+	@ docker build -t $(container) .
+
+# run the test inside container
+test:
+	@ docker run ${option} ${container} rspec $(args)
+
+# display linter error
+lint:
+	@ docker run $(option) ${container} rubocop ${args}
+
+# documentation compilation
+doc:
+	@ docker run $(option) $(container) yardoc --list-undoc $(args)
+
+# exec the commande in the container: make exec bash
+exec:
+	@ docker run $(option) $(container) $(args)
+
+# remove everything created by makefile command
+clean:
+	- rm -rf doc
+	- rm -rf coverage
+	- rm -rf .bundle
+	- rm -rf .yardoc
+	- rm -rf .cache
+	- rm -rf .local
+	- rm .rspec_status
+	- rm .byebug_history
+	- rm .irb_history
+	- rm .bash_history
+	- docker image rm ruby:3.0.2
+	- docker image rm $(container)

data/README.md

@@ -0,0 +1,135 @@
+# Ryquest
+
+*(d)R(spec)y(re)quest*
+
+Improve `type: :request` DSL provided by `rspec-rails`.
+
+Testing controller with `type: :request` can lead to duplication in description and test.
+```ruby
+  describe 'GET /path' do
+    it 'should ...' do
+      get '/path'
+      expect(response).to # ...
+    end
+  end
+```
+
+Ryquest remove this duplication by using parents description to setup the test.
+```ruby
+  describe 'GET /path' do
+    it 'should ...' do
+      expect(response!).to # ...
+    end
+  end
+```
+
+## Requirements
+
+- ryquest ~> 1.0: rspec-rails ~> 5.0
+
+*Note: ryquest should be able to run with older version of rspec-rails but behaviour is not garented.*
+
+## Installation
+
+1. Add `ryquest` to your application in `:test` env
+  ```ruby
+    gem 'ryquest', '~> 1.0', require: false, groupe: :test
+  ```
+2. Setup `ryquest` in `spec/rails_helper.rb` file
+  ```ruby
+    # Add additional requires below this line. Rails is not loaded until this point!
+    require 'ryquest'
+  ```
+
+## Usage
+
+### Basic request
+
+Ryquest use parent's description in order to setup the test.
+It dig through all the test parents and stop on the first description which can be use to setup a request.
+
+A valid parent's description is compose by:
+1. An HTTP verbs: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`
+2. A path: `/user/comments`
+
+Use `response!` to launch the request and get the result (same than `response` result).
+Value is cached so it can be use several time without launch the request again.
+
+```ruby
+  describe 'POST /user/comments' do # not used
+    describe 'GET /user/comments' do # response! stop here and use this description
+      it 'should list user comments' do
+        expect(response!).to have_http_status :ok
+        expect(JSON.parse(response!.body)).to eq ['comment_1', 'comment_2']
+
+        # equivalent to
+        get '/user/comments'
+
+        expect(response).to have_http_status :ok
+        expect(JSON.parse(response.body)).to eq ['comment_1', 'comment_2']
+      end
+    end
+  end
+```
+
+*Note:*
+- *`response!` can launch only one request per test, other request must be setup trought rspec-rails way.*
+- *if `get`, `post`, ... is use before `response!`, `response!` will return the `get`, `post`, ... result.*
+
+### With headers and params
+
+To use specific headers and params with `response!`, put their value in `let` variables `headers` and `params`.
+`response!` automaticaly include theses values in the request if they exists.
+
+```ruby
+  let(:headers) { { 'Authorization' => 'token' } }
+  let(:params) { { title: 'lorem', content: 'ipsum' } }
+
+  describe 'POST /user/comments' do
+    it 'should create a new comment' do
+      expect { response! }.to change { Comment.count }.by 1
+
+      # equivalent to
+      expect { post '/user/comments', headers: headers, params: params }.to change { Comment.count }.by 1
+    end
+  end
+```
+
+### With route parameters
+
+`response!` handle route parameters by looking for a `let` variable with the same parameter name.
+
+*Note: if variable have an `id` method it will use it instead convert the variable to string.*
+
+```ruby
+  let(:comment) { create :comment }
+
+  describe 'DELETE /user/comments/:comment' do
+    it 'should delete the comment' do
+      response!
+
+      expect { Comment.find comment.id }.to raise_error ActiveRecord::RecordNotFound
+
+      # equivalent to
+      delete "/user/comments/${comment.id}"
+
+      expect { Comment.find comment.id }.to raise_error ActiveRecord::RecordNotFound
+    end
+  end
+```
+
+### Helper
+
+* `json!` call `response!` and return the body parsed into hash from json.
+  ```ruby
+    describe 'GET /user/comments' do
+      it 'should list user comments' do
+        expect(json!).to eq ['comment_1', 'comment_2']
+
+        # equivalent to
+        get '/user/comments'
+
+        expect(JSON.parse(response.body)).to eq ['comment_1', 'comment_2']
+      end
+    end
+  ```

data/lib/ryquest/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# Root module
+module Ryquest
+  # Ryquest version number: major.minor.maintenance
+  VERSION = '1.0.0'
+end

data/lib/ryquest.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Context to include to get request DSL improvment
+RSpec.shared_context 'ryquest helper' do # rubocop:disable Metrics/BlockLength
+  let(:headers) { nil }
+  let(:params) { nil }
+
+  # Execute request described in example description and return #response value.
+  # Example description must be formated as: "VERB /path".
+  #
+  # Request will not be launch if it not exist or response already have a value.
+  #
+  # VERB can be: GET, POST, PUT, PATCH, DELETE
+  #
+  # To add specific body or headers define them with `let(:headers/:params) { { key: :value } }
+  #
+  # Params path can be send as: 'VERB /path/:param',
+  # :param will be replaced by `param` value (let, method, ...) or their `id` value.
+  #
+  # @return [ActionDispatch::TestResponse] the #response value
+  def response!
+    match = match_verb
+    return response if response || match.nil?
+
+    verb = match[1]
+    path = match[2]
+
+    send verb.downcase, build_path(path), params: params, headers: headers
+    response
+  end
+
+  # @return [Hash] the #response!.body parsed from json
+  def json!; JSON.parse response!.body end
+
+  private
+
+  # Find request http verb and path in the parents example description.
+  # @return [MatchData] verb in [0] path in [1]
+  def match_verb
+    match = nil
+
+    self.class.parent_groups.each do |parent|
+      match = parent.description.match /^(GET|POST|PATCH|PUT|DELETE) (.+)/
+      break if match
+    end
+
+    match
+  end
+
+  # Replace params path with their value.
+  # Use param path #id if present.
+  # @return [String]
+  def build_path path
+    return path if path.exclude? ':'
+
+    path.scan(/:(\w+\b)/).flatten.each do |match|
+      value = send match
+      value = value.id if value.respond_to? :id
+
+      path = path.gsub ":#{match}", value.to_s
+    end
+
+    path
+  end
+end
+
+# Include the context when using the type: :request option
+RSpec.configure { |config| config.include_context 'ryquest helper', type: :request }

data/ryquest.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/ryquest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ryquest'
+  spec.version       = Ryquest::VERSION
+  spec.authors       = ['Pierre Guego']
+  spec.email         = ['pierre.guego@champagne-terroir.fr']
+
+  spec.summary       = 'Improve type request DSL from rspec-rails.'
+  spec.homepage      = 'https://github.com/faljie/ryquest'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.5.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency 'example-gem', '~> 1.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: ryquest
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pierre Guego
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-03 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- pierre.guego@champagne-terroir.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- lib/ryquest.rb
+- lib/ryquest/version.rb
+- ryquest.gemspec
+homepage: https://github.com/faljie/ryquest
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/faljie/ryquest
+  source_code_uri: https://github.com/faljie/ryquest
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Improve type request DSL from rspec-rails.
+test_files: []