apipie-rails 1.4.0 → 1.4.2

data/spec/lib/apipie/generator/swagger/param_description/builder_spec.rb

@@ -145,6 +145,36 @@ describe Apipie::Generator::Swagger::ParamDescription::Builder do
             /is optional but default value is not specified/
           ).to_stderr
         end
+
+        context 'and param is a prop desc' do
+          let(:param_description) do
+            Apipie.prop(:param, 'object', param_description_options, [])
+          end
+
+          context 'with a delegated controller method' do
+            let(:method_desc) do
+              Apipie::Generator::Swagger::MethodDescription::Decorator.new(
+                Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
+              )
+            end
+
+            it 'warns' do
+              expect { subject }.to output(
+                /is optional but default value is not specified/
+              ).to_stderr
+            end
+          end
+
+          context 'with a nil controller method' do
+            let(:method_desc) { nil }
+
+            it 'warns' do
+              expect { subject }.to output(
+                /is optional but default value is not specified/
+              ).to_stderr
+            end
+          end
+        end
       end
     end
   end

data/spec/lib/apipie/generator/swagger/param_description/type_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 describe Apipie::Generator::Swagger::ParamDescription::Type do
   let(:validator_options) { {} }
   let(:param_description_options) { {}.merge(validator_options) }
-  let(:with_null) { false }
   let(:http_method) { :GET }
   let(:path) { '/api' }
   let(:validator) { String }
@@ -63,9 +62,11 @@ describe Apipie::Generator::Swagger::ParamDescription::Type do
     )
   end
 
+  let(:controller_method) { 'index' }
+
   let(:type_definition) do
     described_class.
-      new(param_description, with_null: with_null, controller_method: 'index').
+      new(param_description, with_null: false, controller_method: controller_method).
       to_hash
   end
 
@@ -178,6 +179,32 @@ describe Apipie::Generator::Swagger::ParamDescription::Type do
       it 'outputs a hash without internal typespec warning' do
         expect { subject }.to output(/is a generic Hash without an internal type specification/).to_stderr
       end
+
+      context 'and param is a prop desc' do
+        let(:param_description) do
+          Apipie.prop(param_description_name, 'object', {}, [])
+        end
+
+        context 'with a delegated controller method' do
+          let(:controller_method) do
+            Apipie::Generator::Swagger::MethodDescription::Decorator.new(
+              method_desc
+            )
+          end
+
+          it 'outputs a hash without internal typespec warning' do
+            expect { subject }.to output(/is a generic Hash without an internal type specification/).to_stderr
+          end
+        end
+
+        context 'and controller method is nil' do
+          let(:controller_method) { nil }
+
+          it 'outputs a hash without internal typespec warning' do
+            expect { subject }.to output(/is a generic Hash without an internal type specification/).to_stderr
+          end
+        end
+      end
     end
   end
 end

data/spec/lib/apipie/method_description_spec.rb

@@ -58,7 +58,7 @@ describe Apipie::MethodDescription do
         )
       end
 
-      it 'should be ordered' do
+      it 'is ordered' do
         expect(json_params).to eq(%w[a b c])
       end
 
@@ -75,7 +75,7 @@ describe Apipie::MethodDescription do
           )
         end
 
-        it 'should ignore response-only parameters' do
+        it 'ignores response-only parameters' do
           expect(json_params).to eq(%w[a c])
         end
       end

data/spec/lib/apipie/param_description_spec.rb

@@ -14,12 +14,12 @@ describe Apipie::ParamDescription do
 
   describe "metadata" do
 
-    it "should return nil when no metadata is provided" do
+    it "returns nil when no metadata is provided" do
       param = Apipie::ParamDescription.new(method_desc, :some_param, String)
       expect(param.to_json[:metadata]).to eq(nil)
     end
 
-    it "should return the metadata" do
+    it "returns the metadata" do
       meta = {
         :length => 32,
         :weight => '830g'
@@ -32,12 +32,12 @@ describe Apipie::ParamDescription do
 
   describe "show option" do
 
-    it "should return true when show option is not provided" do
+    it "returns true when show option is not provided" do
       param = Apipie::ParamDescription.new(method_desc, :some_param, String)
       expect(param.to_json[:show]).to eq(true)
     end
 
-    it "should return the show option" do
+    it "returns the show option" do
       param = Apipie::ParamDescription.new(method_desc, :some_param, String, :show => true)
       expect(param.to_json[:show]).to eq(true)
 
@@ -50,7 +50,7 @@ describe Apipie::ParamDescription do
   describe "full_name" do
     context "with no nested parameters" do
 
-      it "should return name" do
+      it "returns name" do
         param = Apipie::ParamDescription.new(method_desc, :some_param, String)
         expect(param.to_json[:full_name]).to eq('some_param')
       end
@@ -59,7 +59,7 @@ describe Apipie::ParamDescription do
 
     context "with nested parameters" do
 
-      it "should return the parameter's name nested in the parents name" do
+      it "returns the parameter's name nested in the parents name" do
         parent_param = Apipie::ParamDescription.new(method_desc, :parent, String)
         nested_param = Apipie::ParamDescription.new(method_desc, :nested, String, :parent => parent_param)
 
@@ -68,7 +68,7 @@ describe Apipie::ParamDescription do
 
       context "with the parent parameter set to not show" do
 
-        it "should return just the parameter's name" do
+        it "returns just the parameter's name" do
           parent_param = Apipie::ParamDescription.new(method_desc, :parent, String, :show => false)
           nested_param = Apipie::ParamDescription.new(method_desc, :nested, String, :parent => parent_param)
 
@@ -80,13 +80,13 @@ describe Apipie::ParamDescription do
   end
 
   describe "manual validation text" do
-    it "should allow manual text" do
+    it "allows manual text" do
       param = Apipie::ParamDescription.new(method_desc, :hidden_param, nil, :validations => "must be foo")
 
       expect(param.validations).to include("\n<p>must be foo</p>\n")
     end
 
-    it "should allow multiple items" do
+    it "allows multiple items" do
       param = Apipie::ParamDescription.new(method_desc, :hidden_param, nil, :validations => ["> 0", "< 5"])
 
       expect(param.validations).to include("\n<p>&gt; 0</p>\n")
@@ -96,16 +96,16 @@ describe Apipie::ParamDescription do
 
   describe "validator selection" do
 
-    it "should allow nil validator" do
+    it "allows nil validator" do
       param = Apipie::ParamDescription.new(method_desc, :hidden_param, nil)
       expect(param.validator).to be_nil
     end
 
-    it "should throw exception on unknown validator" do
+    it "throws exception on unknown validator" do
       expect { Apipie::ParamDescription.new(method_desc, :param, :unknown) }.to raise_error(RuntimeError, /Validator.*not found/)
     end
 
-    it "should pick type validator" do
+    it "picks type validator" do
       expect(Apipie::Validator::BaseValidator).to receive(:find).and_return(:validator_instance)
       param = Apipie::ParamDescription.new(method_desc, :param, String)
       expect(param.validator).to eq(:validator_instance)
@@ -137,7 +137,7 @@ describe Apipie::ParamDescription do
         context 'when validation value is false' do
           let(:validation_value) { false }
 
-          it 'should not raise an error' do
+          it 'does not raise an error' do
             expect { subject }.not_to raise_error
           end
         end
@@ -145,7 +145,7 @@ describe Apipie::ParamDescription do
         context 'when validation value is an empty string' do
           let(:validation_value) { '' }
 
-          it 'should raise an error' do
+          it 'raises an error' do
             expect { subject }.to raise_error(Apipie::ParamInvalid)
           end
         end
@@ -157,7 +157,7 @@ describe Apipie::ParamDescription do
         context 'when validation value is false' do
           let(:validation_value) { false }
 
-          it 'should not raise an error' do
+          it 'does not raise an error' do
             expect { subject }.not_to raise_error
           end
         end
@@ -165,7 +165,7 @@ describe Apipie::ParamDescription do
         context 'when validation value is true' do
           let(:validation_value) { true }
 
-          it 'should not raise an error' do
+          it 'does not raise an error' do
             expect { subject }.not_to raise_error
           end
         end
@@ -173,7 +173,7 @@ describe Apipie::ParamDescription do
         context 'when validation value is an empty string' do
           let(:validation_value) { '' }
 
-          it 'should raise an error' do
+          it 'raises an error' do
             expect { subject }.to raise_error(Apipie::ParamInvalid)
           end
         end
@@ -185,14 +185,14 @@ describe Apipie::ParamDescription do
         context 'when validation value is empty string' do
           let(:validation_value) { '' }
 
-          it 'should not raise an error' do
+          it 'does not raise an error' do
             expect { subject }.not_to raise_error
           end
 
           context 'when allow_blank is specified as true' do
             let(:allow_blank) { true }
 
-            it 'should not raise an error' do
+            it 'does not raise an error' do
               expect { subject }.not_to raise_error
             end
           end
@@ -206,14 +206,14 @@ describe Apipie::ParamDescription do
       context 'when validation value' do
         let(:validation_value) { false }
 
-        it 'should not raise an error' do
+        it 'does not raise an error' do
           expect { subject }.not_to raise_error
         end
 
         context 'when allow_blank is false' do
           let(:allow_blank) { false }
 
-          it 'should not raise an error' do
+          it 'does not raise an error' do
             expect { subject }.not_to raise_error
           end
         end
@@ -221,7 +221,7 @@ describe Apipie::ParamDescription do
         context 'when allow_blank is true' do
           let(:allow_blank) { true }
 
-          it 'should not raise an error' do
+          it 'does not raise an error' do
             expect { subject }.not_to raise_error
           end
         end
@@ -230,7 +230,7 @@ describe Apipie::ParamDescription do
       context 'when validation value is empty string' do
         let(:validation_value) { '' }
 
-        it 'should raise an error' do
+        it 'raises an error' do
           expect { subject }.to raise_error(Apipie::ParamInvalid)
         end
       end
@@ -242,7 +242,7 @@ describe Apipie::ParamDescription do
       context 'when validation value is false' do
         let(:validation_value) { false }
 
-        it 'should not raise an error' do
+        it 'does not raise an error' do
           expect { subject }.not_to raise_error
         end
       end
@@ -250,7 +250,7 @@ describe Apipie::ParamDescription do
       context 'when validation value is true' do
         let(:validation_value) { true }
 
-        it 'should not raise an error' do
+        it 'does not raise an error' do
           expect { subject }.not_to raise_error
         end
       end
@@ -258,7 +258,7 @@ describe Apipie::ParamDescription do
       context 'when validation value is an empty string' do
         let(:validation_value) { '' }
 
-        it 'should raise an error' do
+        it 'raises an error' do
           expect { subject }.to raise_error(Apipie::ParamInvalid)
         end
       end
@@ -275,14 +275,14 @@ describe Apipie::ParamDescription do
         context 'when a blank but valid value is passed' do
           let(:validation_value) { false }
 
-          it 'should not raise an error' do
+          it 'does not raise an error' do
             expect { subject }.not_to raise_error
           end
 
           context 'when allow_blank is false' do
             let(:allow_blank) { false }
 
-            it 'should not raise an error' do
+            it 'does not raise an error' do
               expect { subject }.not_to raise_error
             end
           end
@@ -291,7 +291,7 @@ describe Apipie::ParamDescription do
         context 'when a blank but invalid value is passed' do
           let(:validation_value) { '' }
 
-          it 'should raise an error' do
+          it 'raises an error' do
             expect { subject }.to raise_error(Apipie::ParamInvalid)
           end
         end
@@ -304,7 +304,7 @@ describe Apipie::ParamDescription do
       context 'when a blank but invalid value is passed' do
         let(:validation_value) { '' }
 
-        it 'should raise an error' do
+        it 'raises an error' do
           expect { subject }.to raise_error(Apipie::ParamInvalid)
         end
       end
@@ -315,7 +315,7 @@ describe Apipie::ParamDescription do
         context 'when and empty string is given' do
           let(:validation_value) { '' }
 
-          it 'should not raise an error' do
+          it 'does not raise an error' do
             expect { subject }.not_to raise_error
           end
         end
@@ -335,27 +335,27 @@ describe Apipie::ParamDescription do
       Apipie::MethodDescription.new(:show, concern_resource_desc, concern_dsl_data)
     end
 
-    it "should replace string parameter name with colon prefix" do
+    it "replaces string parameter name with colon prefix" do
       param = Apipie::ParamDescription.new(concern_method_desc, ":string_subst", String)
       expect(param.name).to eq("string")
     end
 
-    it "should replace symbol parameter name" do
+    it "replaces symbol parameter name" do
       param = Apipie::ParamDescription.new(concern_method_desc, :concern, String)
       expect(param.name).to eq(:user)
     end
 
-    it "should keep original value for strings without colon prefixes" do
+    it "keeps original value for strings without colon prefixes" do
       param = Apipie::ParamDescription.new(concern_method_desc, "string_subst", String)
       expect(param.name).to eq("string_subst")
     end
 
-    it "should keep the original value when a string can't be replaced" do
+    it "keeps the original value when a string can't be replaced" do
       param = Apipie::ParamDescription.new(concern_method_desc, ":param", String)
       expect(param.name).to eq(":param")
     end
 
-    it "should keep the original value when a symbol can't be replaced" do
+    it "keeps the original value when a symbol can't be replaced" do
       param = Apipie::ParamDescription.new(concern_method_desc, :param, String)
       expect(param.name).to eq(:param)
     end
@@ -366,12 +366,12 @@ describe Apipie::ParamDescription do
 
       before { Apipie.configuration.required_by_default = true }
 
-      it "should set param as required by default" do
+      it "sets param as required by default" do
         param = Apipie::ParamDescription.new(method_desc, :required_by_default, String)
         expect(param.required).to be true
       end
 
-      it "should be possible to set param as optional" do
+      it "is possible to set param as optional" do
         param = Apipie::ParamDescription.new(method_desc, :optional, String, :required => false)
         expect(param.required).to be false
       end
@@ -382,12 +382,12 @@ describe Apipie::ParamDescription do
 
       before { Apipie.configuration.required_by_default = false }
 
-      it "should set param as optional by default" do
+      it "sets param as optional by default" do
         param = Apipie::ParamDescription.new(method_desc, :optional_by_default, String)
         expect(param.required).to be false
       end
 
-      it "should be possible to set param as required" do
+      it "is possible to set param as required" do
         param = Apipie::ParamDescription.new(method_desc, :required, String, 'description','required' => true)
         expect(param.required).to be true
       end
@@ -402,21 +402,21 @@ describe Apipie::ParamDescription do
     end
 
     context "when the param is required for current action" do
-      it "should set param as required" do
+      it "sets param as required" do
         param = Apipie::ParamDescription.new(method_desc, :required, String, 'description','required' => :create)
         expect(param.required).to be true
       end
     end
 
     context "when the param is required for multiple actions" do
-      it "should set param as required if it match current action" do
+      it "sets param as required if it match current action" do
         param = Apipie::ParamDescription.new(method_desc, :required, String, 'description','required' => [:update, :create])
         expect(param.required).to be true
       end
     end
 
     context "when the param is not required for current action" do
-      it "should set param as not required" do
+      it "sets param as not required" do
         param = Apipie::ParamDescription.new(method_desc, :required, String, 'description','required' => :update)
         expect(param.required).to be false
       end
@@ -500,7 +500,7 @@ describe Apipie::ParamDescription do
         end
       end
 
-      it "should include the nested params in the json" do
+      it "includes the nested params in the json" do
         sub_params = subject.to_json[:params]
         expect(sub_params.size).to eq(1)
         sub_param = sub_params.first
@@ -518,7 +518,7 @@ describe Apipie::ParamDescription do
         end
       end
 
-      it "should include the nested params in the json" do
+      it "includes the nested params in the json" do
         sub_params = subject.to_json[:params]
         expect(sub_params.size).to eq(1)
         sub_param = sub_params.first
@@ -534,7 +534,7 @@ describe Apipie::ParamDescription do
         Apipie::ParamDescription.new(method_desc, :param, String)
       end
 
-      it "should include the nested params in the json" do
+      it "includes the nested params in the json" do
         expect(subject.to_json[:params]).to be_nil
       end
 
@@ -543,7 +543,7 @@ describe Apipie::ParamDescription do
   end
 
   describe "Array with classes" do
-    it "should be valid for objects included in class array" do
+    it "is valid for objects included in class array" do
       param = Apipie::ParamDescription.new(method_desc, :param, [Integer, String])
       expect { param.validate("1") }.not_to raise_error
       expect { param.validate(Integer) }.to raise_error(Apipie::ParamInvalid)

data/spec/lib/apipie/param_group_spec.rb

@@ -20,7 +20,7 @@ describe "param groups" do
     expect(user_create_params.map(&:to_s).sort).to eq(%w[membership name pass])
   end
 
-  it "should allow adding additional params to group" do
+  it "allows adding additional params to group" do
     user_create_desc = Apipie["users#create"].params[:user]
     user_create_params = user_create_desc.validator.params_ordered.map(&:name)
     expect(user_create_params.map(&:to_s).sort).to eq(%w[membership name pass permalink])
@@ -43,16 +43,16 @@ describe "param groups" do
     expect(arch_v1_params.sort_by(&:to_s)).to eq(arch_v2_params.sort_by(&:to_s))
   end
 
-  it "should replace parameter name in a group when it comes from concern" do
+  it "replaces parameter name in a group when it comes from concern" do
     expect(Apipie["overridden_concern_resources#update"].params.key?(:user)).to eq(true)
   end
 
-  it "shouldn't replace parameter name in a group redefined in the controller" do
+  it "does not replace parameter name in a group redefined in the controller" do
     expect(Apipie["overridden_concern_resources#create"].params.key?(:concern)).to eq(true)
     expect(Apipie["overridden_concern_resources#create"].params.key?(:user)).to eq(false)
   end
 
-it "shouldn't replace name of a parameter defined in the controller" do
+it "does not replace name of a parameter defined in the controller" do
     expect(Apipie["overridden_concern_resources#custom"].params.key?(:concern)).to eq(true)
     expect(Apipie["overridden_concern_resources#custom"].params.key?(:user)).to eq(false)
   end

data/spec/lib/apipie/resource_description_spec.rb

@@ -25,7 +25,7 @@ describe Apipie::ResourceDescription do
         )
       end
 
-      it 'should be ordered' do
+      it 'is ordered' do
         expect(methods.keys).to eq([:a, :b, :c])
       end
     end
@@ -63,7 +63,7 @@ describe Apipie::ResourceDescription do
           )
         end
 
-        it 'should be ordered' do
+        it 'is ordered' do
           expect(methods_as_json.map { |h| h[:name] }).to eq(%w[a b c])
         end
       end

data/spec/lib/apipie/validator_spec.rb

@@ -20,22 +20,22 @@ describe Apipie::Validator do
 
     context "expected type" do
 
-      it "should return hash for type Hash" do
+      it "returns hash for type Hash" do
         validator = Apipie::Validator::TypeValidator.new(params_desc, Hash)
         expect(validator.expected_type).to eq('hash')
       end
 
-      it "should return array for type Array" do
+      it "returns array for type Array" do
         validator = Apipie::Validator::TypeValidator.new(params_desc, Array)
         expect(validator.expected_type).to eq('array')
       end
 
-      it "should return numeric for type Numeric" do
+      it "returns numeric for type Numeric" do
         validator = Apipie::Validator::TypeValidator.new(params_desc, Numeric)
         expect(validator.expected_type).to eq('numeric')
       end
 
-      it "should return string by default" do
+      it "returns string by default" do
         validator = Apipie::Validator::TypeValidator.new(params_desc, Symbol)
         expect(validator.expected_type).to eq('string')
       end
@@ -43,7 +43,7 @@ describe Apipie::Validator do
     end
 
     describe 'NumberValidator' do
-      it 'should expect a Numeric type' do
+      it 'expects a Numeric type' do
         validator = Apipie::Validator::BaseValidator.find(params_desc, :number, nil, nil)
         expect(validator.expected_type).to eq('numeric')
       end
@@ -86,7 +86,7 @@ describe Apipie::Validator do
     end
 
     describe '#validate' do
-      it "should validate by object class" do
+      it "validates by object class" do
         expect(validator_instance.validate("1")).to be_truthy
         expect(validator_instance.validate(1)).to be_truthy
         expect(validator_instance.validate(true)).to be_truthy
@@ -104,21 +104,21 @@ describe Apipie::Validator do
   end
 
   describe 'ArrayClassValidator' do
-    it "should validate by object class" do
+    it "validates by object class" do
       validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Integer, String])
       expect(validator.validate("1")).to be_truthy
       expect(validator.validate(1)).to be_truthy
       expect(validator.validate({ 1 => 1 })).to be_falsey
     end
 
-    it "should have a valid description" do
+    it "has a valid description" do
       validator = Apipie::Validator::ArrayClassValidator.new(params_desc, [Float, String])
       expect(validator.description).to eq('Must be one of: <code>Float</code>, <code>String</code>.')
     end
   end
 
   describe 'RegexpValidator' do
-    it "should validate by object class" do
+    it "validates by object class" do
       validator = Apipie::Validator::RegexpValidator.new(params_desc, /^valid( extra)*$/)
       expect(validator.validate("valid")).to be_truthy
       expect(validator.validate("valid extra")).to be_truthy
@@ -126,14 +126,14 @@ describe Apipie::Validator do
       expect(validator.validate("invalid")).to be_falsey
     end
 
-    it "should have a valid description" do
+    it "has a valid description" do
       validator = Apipie::Validator::RegexpValidator.new(params_desc, /^valid( extra)*$/)
       expect(validator.description).to eq('Must match regular expression <code>/^valid( extra)*$/</code>.')
     end
   end
 
   describe 'EnumValidator' do
-    it "should validate by object class" do
+    it "validates by object class" do
       validator = Apipie::Validator::EnumValidator.new(params_desc, ['first', 'second & third'])
       expect(validator.validate("first")).to be_truthy
       expect(validator.validate("second & third")).to be_truthy
@@ -141,7 +141,7 @@ describe Apipie::Validator do
       expect(validator.validate({ 1 => 1 })).to be_falsey
     end
 
-    it "should have a valid description" do
+    it "has a valid description" do
       validator = Apipie::Validator::EnumValidator.new(params_desc, ['first', 'second & third'])
       expect(validator.description).to eq('Must be one of: <code>first</code>, <code>second &amp; third</code>.')
     end