rspec-declarative_requests 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4677665c93037dfeb0de4252fb3d1d7e77c36568b3298882e9c68bcfb60bc5cc
+  data.tar.gz: 5e8dfd0b6807f27d7720ec8dcc1a09fad189cf002f95ecb7032a83aab11cb052
+SHA512:
+  metadata.gz: 810166577b4cf160a7ace109db319d46f59c663fc9b268693e23ba68a82097ae1e4d79a88bdbcbc7be5c79543b4c4692cd57335663e01473c0ca9ab9885ce69d
+  data.tar.gz: 8d6350811086f5fc5504730aa6633070762ed1f3f73a74b4508dfa8f3f02b22bacfbaa1202af48f0c56ed3dd2b26d0407f2b08fdc415dff19b302e15dc27883f

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+

data/Gemfile.lock

@@ -0,0 +1,159 @@
+PATH
+  remote: .
+  specs:
+    rspec-declarative_requests (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    gem-release (2.0.1)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    json (2.2.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    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)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-composable_json_matchers (1.1.1)
+      json (~> 2.0)
+      rspec (~> 3.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      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-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  gem-release
+  rails (~> 5.2)
+  rspec-composable_json_matchers
+  rspec-declarative_requests!
+  rspec-rails
+  sqlite3
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,181 @@
+RSpec::DeclarativeRequests
+==========================
+
+A standardized structure for request specs in Rails.
+
+```ruby
+require 'rails_helper'
+
+RSpec.describe 'Widgets' do
+  describe 'GET /widgets/:id' do
+    let(:id) { FactoryBot.create(:widget).id }
+    it { is_expected.to have_http_status(:ok) }
+  end
+end
+```
+
+Setup
+-----
+
+Add to your `Gemfile` (probably in the `:test` group):
+
+```ruby
+# Gemfile
+group :test do
+  gem 'rspec-declarative_requests'
+end
+```
+
+Include it in your RSpec config:
+
+```ruby
+# spec/rails_helper.rb
+RSpec.configure do |config|
+  # enabled for ALL request specs
+  config.include RSpec::DeclarativeRequests, type: :request
+
+  # OR: enable only for request specs tagged as :declarative
+  config.include RSpec::DeclarativeRequests, type: :request, declarative: true
+end
+```
+
+Or include it straight into the spec:
+
+```ruby
+# spec/requests/whatever_spec.rb
+require 'rails_helper'
+
+RSpec.describe 'Whatever' do
+  include RSpec::DeclarativeRequests
+
+  describe 'GET /whatevers' do
+    # ...
+  end
+end
+```
+
+
+Using `subject`
+---------------
+
+This gem sets the RSpec subject to the _response_, after making the request.
+This allows you do use `is_expected` or `expect(subject)` to check the response.
+
+```ruby
+describe 'GET /thing' do
+  it { is_expected.to be_ok }
+
+  # OR
+
+  it "responds with 200 OK" do
+    expect(subject).to have_http_status(:ok)
+  end
+end
+```
+
+Using `params`
+--------------
+
+There is a `let` for request params that starts as an empty Hash. You can
+either override it:
+
+```ruby
+let(:params) do
+  { my_param: 123 }
+end
+```
+
+Or you can modify it in a `before` block:
+
+```ruby
+before do
+  params[:my_param] = 123
+end
+```
+
+Using `before` blocks, you can do nested contexts:
+
+```ruby
+context 'with a user' do
+  before { params[:user] = { id: 123 } }
+
+  context 'who is cool' do
+    before { params[:user][:is_cool] = true }
+    # ...
+  end
+
+  context 'who is not cool' do
+    before { params[:user][:is_cool] = false }
+    # ...
+  end
+end
+```
+
+Using `headers`
+---------------
+
+There is a `let` for request headers that starts as an empty Hash. This works
+exactly the same as `params` described above.
+
+```ruby
+context 'requesting JSON' do
+  before { headers['Accepts'] = 'application/json' }
+  # ...
+end
+```
+
+Path Interpolation
+------------------
+
+The path in the request description behaves _kind of_ like a Rails route.
+Named segments that start with a `:` will be replaced by the value of the `let`
+(or method) with the same name.
+
+```ruby
+describe 'POST /things/:thing_id' do
+  let(:thing_id) { 4444 }
+  # ...
+end
+```
+
+It's common to want to use an attribute of an object that you already have a
+`let` for. To do that, use the `#` character.
+
+```ruby
+describe 'POST /things/:thing#id' do
+  let(:thing) { FactoryBot.create(:thing) }
+  # ...
+end
+```
+
+Attributes can be chained together.
+
+```ruby
+describe 'POST /things/:user#things#first#id' do
+  let(:user) { FactoryBot.create(:user, :with_things) }
+  # ...
+end
+```
+
+`Hash`s can also be interpolated by their keys, which can be either strings or
+symbols.
+
+```ruby
+describe 'POST /things/:user#things#first#id' do
+  let(:user) do
+    {
+      things: [
+        { id: 1 },
+        { id: 2 },
+      ]
+    }
+  end
+
+  #...
+end
+```
+
+License
+-------
+
+This gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/rspec/declarative_requests/version.rb

@@ -0,0 +1,5 @@
+module RSpec
+  module DeclarativeRequests
+    VERSION = "0.1.0"
+  end
+end

data/lib/rspec/declarative_requests.rb

@@ -0,0 +1,64 @@
+module RSpec::DeclarativeRequests
+  def self.included(example_class)
+    example_class.let(:params) { {} }
+    example_class.let(:headers) { {} }
+    example_class.let(:subject) do
+      PerformRequest.(self)
+      response
+    end
+  end
+
+  class Error < StandardError; end
+
+  module PerformRequest
+    extend self
+
+    HTTP_METHODS = %w(CONNECT DELETE GET HEAD OPTIONS PATCH POST PUT TRACE)
+
+    def call(example)
+      group = ([RSpec.current_example] + example.class.parent_groups).find do |group|
+        HTTP_METHODS.any? do |http_method|
+          group.description.start_with?(http_method + ' ')
+        end
+      end
+
+      if group.nil?
+        raise Error, <<~END_ERROR
+          Could not find an RSpec example group that looks like a request. The
+          describe/context description must start with an uppercase HTTP verb
+          like "GET" or "POST".
+
+          Try something like:
+
+            describe "GET /foo" do
+              it { is_expected.to have_http_status(:ok) }
+            end
+        END_ERROR
+      end
+
+      method, _, path = group.description.partition(/\s+/)
+      example.send(
+        method.downcase,
+        interpolate(path, example),
+        params: example.params,
+        headers: example.headers,
+      )
+    end
+
+    def interpolate(path, example)
+      path.gsub(/\:[a-z_#]+/) do |match|
+        match[1..-1].split('#').reduce(example) do |value, attr|
+          if value.is_a?(Hash)
+            case
+            when value.key?(attr) then value[attr]
+            when value.key?(attr.to_sym) then value[attr.to_sym]
+            else raise Error, "Couldn't find '#{attr}' while interpolating '#{match}' in the request path"
+            end
+          else
+            value.send(attr)
+          end
+        end
+      end
+    end
+  end
+end

data/rspec-declarative_requests.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/declarative_requests/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-declarative_requests"
+  spec.version       = RSpec::DeclarativeRequests::VERSION
+  spec.authors       = ["Tom Dalling"]
+  spec.email         = ["tom" + "@" + "tomdalling.com"]
+
+  spec.summary       = %q{A standardized structure for request specs in Rails.}
+  spec.description   = %q{A standardized structure for request specs in Rails.}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rails", "~> 5.2"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency 'rspec-composable_json_matchers'
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'gem-release'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: rspec-declarative_requests
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Dalling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-composable_json_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A standardized structure for request specs in Rails.
+email:
+- tom@tomdalling.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/rspec/declarative_requests.rb
+- lib/rspec/declarative_requests/version.rb
+- rspec-declarative_requests.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A standardized structure for request specs in Rails.
+test_files: []