grape 1.6.1 → 1.7.0

data/spec/grape/middleware/versioner/header_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Middleware::Versioner::Header do
   subject { described_class.new(app, **(@options || {})) }
 
@@ -48,7 +46,7 @@ describe Grape::Middleware::Versioner::Header do
 
     it 'is nil if not provided' do
       status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor')
-      expect(env['api.format']).to be nil
+      expect(env['api.format']).to be_nil
       expect(status).to eq(200)
     end
 
@@ -66,7 +64,7 @@ describe Grape::Middleware::Versioner::Header do
 
         it 'is nil if not provided' do
           status, _, env = subject.call('HTTP_ACCEPT' => 'application/vnd.vendor-v1')
-          expect(env['api.format']).to be nil
+          expect(env['api.format']).to be_nil
           expect(status).to eq(200)
         end
       end
@@ -328,4 +326,20 @@ describe Grape::Middleware::Versioner::Header do
       end
     end
   end
+
+  context 'with missing vendor option' do
+    subject do
+      Class.new(Grape::API) do
+        version 'v1', using: :header
+      end
+    end
+
+    def app
+      subject
+    end
+
+    it 'fails' do
+      expect { versioned_get '/', 'v1', using: :header }.to raise_error Grape::Exceptions::MissingVendorOption
+    end
+  end
 end

data/spec/grape/middleware/versioner/param_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Middleware::Versioner::Param do
   subject { described_class.new(app, **options) }
 

data/spec/grape/middleware/versioner/path_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Middleware::Versioner::Path do
   subject { described_class.new(app, **options) }
 

data/spec/grape/middleware/versioner_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Middleware::Versioner do
   let(:klass) { described_class }
 

data/spec/grape/named_api_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe 'A named API' do
   subject(:api_name) { NamedAPI.endpoints.last.options[:for].to_s }
 

data/spec/grape/parser_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Parser do
   subject { described_class }
 

data/spec/grape/path_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   describe Path do
     describe '#initialize' do

data/spec/grape/presenters/presenter_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   module Presenters
     module PresenterSpec

data/spec/grape/request_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 module Grape
   describe Request do
     let(:default_method) { 'GET' }

data/spec/grape/util/inheritable_setting_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 module Grape
   module Util
     describe InheritableSetting do

data/spec/grape/util/inheritable_values_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 module Grape
   module Util
     describe InheritableValues do

data/spec/grape/util/reverse_stackable_values_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 module Grape
   module Util
     describe ReverseStackableValues do

data/spec/grape/util/stackable_values_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 module Grape
   module Util
     describe StackableValues do

data/spec/grape/util/strict_hash_configuration_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
 module Grape
   module Util
     describe 'StrictHashConfiguration' do

data/spec/grape/validations/attributes_doc_spec.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+describe Grape::Validations::ParamsScope::AttributesDoc do
+  shared_examples 'an optional doc attribute' do |attr|
+    it 'does not mention it' do
+      expected_opts.delete(attr)
+      validations.delete(attr)
+
+      expect(subject.first['nested[engine_age]']).not_to have_key(attr)
+    end
+  end
+
+  let(:api) { Class.new(Grape::API::Instance) }
+  let(:scope) do
+    params = nil
+    api_instance = api
+
+    # just to get nested params
+    Grape::Validations::ParamsScope.new(type: Hash, api: api) do
+      params = Grape::Validations::ParamsScope.new(element: 'nested',
+                                                   type: Hash,
+                                                   api: api_instance,
+                                                   parent: self)
+    end
+
+    params
+  end
+
+  let(:validations) do
+    {
+      presence: true,
+      desc: 'Age of...',
+      documentation: 'Age is...',
+      default: 1
+    }
+  end
+
+  let(:doc) { described_class.new(api, scope) }
+
+  describe '#extract_details' do
+    subject { doc.extract_details(validations) }
+
+    it 'cleans up doc attrs needed for documentation only' do
+      subject
+
+      expect(validations[:desc]).to be_nil
+      expect(validations[:documentation]).to be_nil
+    end
+
+    it 'does not clean up doc attrs mandatory for validators' do
+      subject
+
+      expect(validations[:presence]).not_to be_nil
+      expect(validations[:default]).not_to be_nil
+    end
+
+    it 'tells when attributes are required' do
+      subject
+
+      expect(doc.required).to be_truthy
+    end
+  end
+
+  describe '#document' do
+    subject do
+      doc.extract_details validations
+      doc.document attrs
+    end
+
+    let(:attrs) { %w[engine_age car_age] }
+    let(:valid_values) { [1, 3, 5, 8] }
+
+    let!(:expected_opts) do
+      {
+        required: true,
+        desc: validations[:desc],
+        documentation: validations[:documentation],
+        default: validations[:default],
+        type: 'Integer',
+        values: valid_values
+      }
+    end
+
+    before do
+      doc.type = Integer
+      doc.values = valid_values
+    end
+
+    context 'documentation is enabled' do
+      subject do
+        super()
+        api.namespace_stackable(:params)
+      end
+
+      it 'documents attributes' do
+        expect(subject.first).to eq('nested[engine_age]' => expected_opts,
+                                    'nested[car_age]' => expected_opts)
+      end
+
+      it_behaves_like 'an optional doc attribute', :default
+      it_behaves_like 'an optional doc attribute', :documentation
+      it_behaves_like 'an optional doc attribute', :desc
+      it_behaves_like 'an optional doc attribute', :type do
+        before { doc.type = nil }
+      end
+      it_behaves_like 'an optional doc attribute', :values do
+        before { doc.values = nil }
+      end
+
+      context 'false as a default value' do
+        before { validations[:default] = false }
+
+        it 'is still documented' do
+          doc = subject.first['nested[engine_age]']
+
+          expect(doc).to have_key(:default)
+          expect(doc[:default]).to be(false)
+        end
+      end
+
+      context 'nil as a default value' do
+        before { validations[:default] = nil }
+
+        it 'is still documented' do
+          doc = subject.first['nested[engine_age]']
+
+          expect(doc).to have_key(:default)
+          expect(doc[:default]).to be_nil
+        end
+      end
+
+      context 'the description key instead of desc' do
+        let!(:desc) { validations.delete(:desc) }
+
+        before { validations[:description] = desc }
+
+        it 'adds the given description' do
+          expect(subject.first['nested[engine_age]'][:desc]).to eq(desc)
+        end
+      end
+    end
+
+    context 'documentation is disabled' do
+      before { api.namespace_inheritable :do_not_document, true }
+
+      it 'does not document attributes' do
+        subject
+
+        expect(api.namespace_stackable(:params)).to eq([])
+      end
+    end
+  end
+end

data/spec/grape/validations/attributes_iterator_spec.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::AttributesIterator do
 end

data/spec/grape/validations/instance_behaivour_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe 'Validator with instance variables' do
   let(:validator_type) do
     Class.new(Grape::Validations::Validators::Base) do

data/spec/grape/validations/multiple_attributes_iterator_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
 describe Grape::Validations::MultipleAttributesIterator do
   describe '#each' do
     subject(:iterator) { described_class.new(validator, scope, params) }