require "spec_helper"

describe Apipie::ParamDescription do

  let(:dsl_data) { ActionController::Base.send(:_apipie_dsl_data_init) }

  let(:resource_desc) do
    Apipie::ResourceDescription.new(UsersController, "users")
  end

  let(:method_desc) do
    Apipie::MethodDescription.new(:show, resource_desc, dsl_data)
  end

  describe "metadata" do

    it "should return 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
      meta = {
        :lenght => 32,
        :weight => '830g'
      }
      param = Apipie::ParamDescription.new(method_desc, :some_param, String, :meta => meta)
      expect(param.to_json[:metadata]).to eq(meta)
    end

  end

  describe "show option" do

    it "should return 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
      param = Apipie::ParamDescription.new(method_desc, :some_param, String, :show => true)
      expect(param.to_json[:show]).to eq(true)

      param = Apipie::ParamDescription.new(method_desc, :some_param, String, :show => false)
      expect(param.to_json[:show]).to eq(false)
    end

  end

  describe "full_name" do
    context "with no nested parameters" do

      it "should return name" do
        param = Apipie::ParamDescription.new(method_desc, :some_param, String)
        expect(param.to_json[:full_name]).to eq('some_param')
      end

    end

    context "with nested parameters" do

      it "should return 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)

        expect(nested_param.to_json[:full_name]).to eq('parent[nested]')
      end

      context "with the parent parameter set to not show" do

        it "should return 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)

          expect(nested_param.to_json[:full_name]).to eq('nested')
        end

      end
    end
  end

  describe "manual validation text" do
    it "should allow 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
      param = Apipie::ParamDescription.new(method_desc, :hidden_param, nil, :validations => ["> 0", "< 5"])

      expect(param.validations).to include("\n<p>&gt; 0</p>\n")
      expect(param.validations).to include("\n<p>&lt; 5</p>\n")
    end
  end

  describe "validator selection" do

    it "should allow 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
      expect { Apipie::ParamDescription.new(method_desc, :param, :unknown) }.to raise_error(RuntimeError, /Validator.*not found/)
    end

    it "should pick 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)
    end

  end

  describe 'validate' do
    context 'when allow_blank is ignored, as it was before 0.7.0' do
      before do
        Apipie.configuration.ignore_allow_blank_false = true
      end

      context 'when the parameter is a boolean' do
        it "should not throw an exception when passed false" do
          expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate(false) }.to_not raise_error
        end

        it "should throw an exception when passed an empty value" do
          expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate('') }.to raise_error(Apipie::ParamInvalid)
        end
      end

      context 'when the parameter is a string' do
        context 'when allow_blank is specified as true' do
          it "should throw an exception when passed an empty value" do
            expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: true).validate('') }.to_not raise_error
          end
        end
        context 'when allow_blank is specified as false' do
          it "should throw an exception when passed an empty value" do
            expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('') }.to_not raise_error
          end
        end
        context 'when allow_blank is not specified' do
          it "should throw an exception when passed an empty value" do
            expect { Apipie::ParamDescription.new(method_desc, :param, String).validate('') }.to_not raise_error
          end
        end
      end

      after do
        Apipie.configuration.ignore_allow_blank_false = false
      end
    end

    context 'when the parameter is a boolean' do
      it "should not throw an exception when passed false" do
        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate(false) }.to_not raise_error
      end

      it "should still not throw an exception when passed false with explicit allow_blank: false" do
        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean, allow_blank: false).validate(false) }.to_not raise_error
      end

      it "should throw an exception when passed an empty value" do
        expect { Apipie::ParamDescription.new(method_desc, :param, :boolean).validate('') }.to raise_error(Apipie::ParamInvalid)
      end
    end

    context "when the parameter is a custom type with ignore_allow_blank? returning true" do
      it "should not throw an exception when passed a blank but valid value" do
        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool).validate(false) }.to_not raise_error
      end

      it "should still not throw an exception when passed false with explicit allow_blank: false" do
        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool, allow_blank: false).validate(false) }.to_not raise_error
      end

      it "should throw an exception when passed an invalid but blank value" do
        expect { Apipie::ParamDescription.new(method_desc, :param, :custom_bool).validate("") }.to raise_error(Apipie::ParamInvalid)
      end
    end

    context 'when the parameter is a string' do
      context 'when allow_blank is specified as true' do
        it "should throw an exception when passed an empty value" do
          expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: true).validate('') }.to_not raise_error
        end
      end
      context 'when allow_blank is specified as false' do
        it "should throw an exception when passed an empty value" do
          expect { Apipie::ParamDescription.new(method_desc, :param, String, allow_blank: false).validate('') }.to raise_error(Apipie::ParamInvalid)
        end
      end
      context 'when allow_blank is not specified' do
        it "should throw an exception when passed an empty value" do
          expect { Apipie::ParamDescription.new(method_desc, :param, String).validate('') }.to raise_error(Apipie::ParamInvalid)
        end
      end
    end
  end

  describe "concern substitution" do

    let(:concern_dsl_data) { dsl_data.merge(:from_concern => true) }

    let(:concern_resource_desc) do
      Apipie::ResourceDescription.new(ConcernsController, "concerns")
    end

    let(:concern_method_desc) do
      Apipie::MethodDescription.new(:show, concern_resource_desc, concern_dsl_data)
    end

    it "should replace 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
      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
      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
      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
      param = Apipie::ParamDescription.new(concern_method_desc, :param, String)
      expect(param.name).to eq(:param)
    end
  end


  describe "required_by_default config option" do
    context "parameters required by default" do

      before { Apipie.configuration.required_by_default = true }

      it "should set 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
        param = Apipie::ParamDescription.new(method_desc, :optional, String, :required => false)
        expect(param.required).to be false
      end

    end

    context "parameters optional by default" do

      before { Apipie.configuration.required_by_default = false }

      it "should set 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
        param = Apipie::ParamDescription.new(method_desc, :required, String, 'description','required' => true)
        expect(param.required).to be true
      end

    end

  end

  describe "required params on given actions" do
    let(:method_desc) do
      Apipie::MethodDescription.new(:create, resource_desc, dsl_data)
    end

    context "when the param is required for current action" do
      it "should set 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
        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
        param = Apipie::ParamDescription.new(method_desc, :required, String, 'description','required' => :update)
        expect(param.required).to be false
      end
    end
  end

  describe "required params in action aware validator" do

    subject { method_description.params[:user].validator.params_ordered }

    let(:required) do
      subject.find_all(&:required).map(&:name)
    end

    let(:allowed_nil) do
      subject.find_all(&:allow_nil).map(&:name)
    end

    context "with resource creation" do

      let(:method_description) do
        Apipie.get_method_description(UsersController, :create)
      end

      it "makes the param required" do
        expect(required).to include :name
        expect(required).to include :pass
      end

      it "doesn't allow nil" do
        expect(allowed_nil).not_to include :name
        expect(allowed_nil).not_to include :pass
      end
    end

    context "with resource update" do

      let(:method_description) do
        Apipie.get_method_description(UsersController, :update)
      end

      it "doesn't make the param required" do
        expect(required).not_to include :name
        expect(required).not_to include :pass
      end

      it "doesn't allow nil" do
        expect(allowed_nil).not_to include :name
        expect(allowed_nil).not_to include :pass
      end

      it "doesn't touch params with explicitly set allow_nil" do
        expect(allowed_nil).not_to include :membership
      end
    end

    context "with explicitly setting action type in param group" do
      let(:method_description) do
        Apipie.get_method_description(UsersController, :admin_create)
      end

      it "makes the param required" do
        expect(required).to include :name
        expect(required).to include :pass
      end

      it "doesn't allow nil" do
        expect(allowed_nil).not_to include :name
        expect(allowed_nil).not_to include :pass
      end
    end
  end


  describe 'sub params' do

    context 'with HashValidator' do

      subject do
        Apipie::ParamDescription.new(method_desc, :param, Hash) do
          param :answer, Fixnum
        end
      end

      it "should include 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
        expect(sub_param[:name]).to eq("answer")
        expect(sub_param[:full_name]).to eq("param[answer]")
      end

    end

    context 'with NestedValidator' do

      subject do
        Apipie::ParamDescription.new(method_desc, :param, Array) do
          param :answer, Fixnum
        end
      end

      it "should include 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
        expect(sub_param[:name]).to eq("answer")
        expect(sub_param[:full_name]).to eq("param[answer]")
      end

    end

    context 'with flat validator' do

      subject do
        Apipie::ParamDescription.new(method_desc, :param, String)
      end

      it "should include the nested params in the json" do
        expect(subject.to_json[:params]).to be_nil
      end

    end

  end

  describe "Array with classes" do
    it "should be valid for objects included in class array" do
      param = Apipie::ParamDescription.new(method_desc, :param, [Fixnum, String])
      expect { param.validate("1") }.not_to raise_error
      expect { param.validate(Fixnum) }.to raise_error(Apipie::ParamInvalid)
    end
  end

end