/*
 * Copyright 2008 JRimum Project
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by
 * applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
 * OF ANY KIND, either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * Created at: 30/03/2008 - 18:22:39
 * 
 * ================================================================================
 * 
 * Direitos autorais 2008 JRimum Project
 * 
 * Licenciado sob a Licença Apache, Versão 2.0 ("LICENÇA"); você não pode usar
 * esse arquivo exceto em conformidade com a esta LICENÇA. Você pode obter uma
 * cópia desta LICENÇA em http://www.apache.org/licenses/LICENSE-2.0 A menos que
 * haja exigência legal ou acordo por escrito, a distribuição de software sob
 * esta LICENÇA se dará “COMO ESTÁ”, SEM GARANTIAS OU CONDIÇÕES DE QUALQUER
 * TIPO, sejam expressas ou tácitas. Veja a LICENÇA para a redação específica a
 * reger permissões e limitações sob esta LICENÇA.
 * 
 * Criado em: 30/03/2008 - 18:22:39
 * 
 */

package org.jrimum.vallia.digitoverificador;


import static org.apache.commons.lang.StringUtils.isNotBlank;
import static org.apache.commons.lang.StringUtils.replaceChars;
import static org.jrimum.utilix.text.Strings.fillWithZeroLeft;

import java.util.regex.Pattern;

import org.jrimum.utilix.Exceptions;

/**
 * <p>
 * O cálculo do dígito verificador do CNPJ é realizado em duas etapas e é
 * auxiliado pela rotina de módulo 11.
 * </p>
 * <p>
 * Abaixo é demonstrado como esse cálculo é feito:
 * </p>
 * <h3>Exemplo para um número hipotético 11.222.333/0001-XX:</h3>
 * <p>
 * Primeiramente obtém-se um número R, calculado através da rotina de módulo 11,
 * a partir dos doze primeiros números do CNPJ, nesse caso 112223330001. <br />
 * Para obter o primeiro dígito verificador deve-se seguir a seguinte lógica: <br />
 * <br />
 * Se o número R for menor que 2, o dígito terá valor 0 (zero); senão, será a
 * subtração do valor do módulo (11) menos o valor do número R, ou seja,
 * <code>DV = 11 - R</code>.
 * </p>
 * <p>
 * Para obter o segundo dígito verificador é da mesma forma do primeiro, porém
 * deve ser calculado a partir dos treze primeiros números do CNPJ, ou seja,
 * 112223330001 + primeiro dígito.
 * </p>
 * <p>
 * Obs.: O limite mínimo e máximo do módulo 11 são 2 e 9, respectivamente.
 * </p>
 * 
 * @see Modulo
 * 
 * @author <a href="http://gilmatryx.googlepages.com/">Gilmar P.S.L</a>
 * @author <a href="mailto:misaelbarreto@gmail.com">Misael Barreto</a>
 * @author <a href="mailto:romulomail@gmail.com">Rômulo Augusto</a>
 * @author <a href="http://www.nordestefomento.com.br">Nordeste Fomento
 *         Mercantil</a>
 * 
 * @since 0.2
 * 
 * @version 0.2
 */
public class CNPJDV extends AbstractDigitoVerificador {

	/**
	 * <p>
	 * Liminte mínimo do para cálculo no módulo 11.
	 *</p>
	 */
	private static final int LIMITE_MINIMO = 2;

	/**
	 * <p>
	 * Liminte máximo do para cálculo no módulo 11.
	 *</p>
	 */
	private static final int LIMITE_MAXIMO = 9;

	/**
	 * <p>
	 * Expressão regular para validação dos doze primeiros números do CNPJ sem
	 * formatação: <tt>"############"</tt>.
	 * </p>
	 */
	private static final String REGEX_CNPJ_DV = "\\d{12}";

	/**
	 * <p>
	 * Expressão regular para validação dos doze primeiros números do CNPJ
	 * formatado: <tt>"##.###.###/####"</tt>.
	 * </p>
	 */
	private static final String REGEX_CNPJ_DV_FORMATTED = "\\d{2}\\.\\d{3}\\.\\d{3}\\/\\d{4}";

	/**
	 * @see org.jrimum.vallia.digitoverificador.AbstractDigitoVerificador#calcule(long)
	 * @since 0.2
	 */
	@Override
	public int calcule(long numero) {

		return calcule(fillWithZeroLeft(numero, 12));
	}

	/**
	 * <p>
	 * </p>
	 * @see org.jrimum.vallia.digitoverificador.AbstractDigitoVerificador#calcule(java.lang.String)
	 * @since 0.2
	 */
	@Override
	public int calcule(String numero) throws IllegalArgumentException {

		int dv1 = 0;
		int dv2 = 0;
		
		numero = removaFormatacao(numero);

		if (isFormatoValido(numero)) {

			dv1 = calculeDigito(numero);
			dv2 = calculeDigito(numero + dv1);
			
		} else {
			
			Exceptions.throwIllegalArgumentException(
				"O CNPJ [ " + numero
				+ " ] deve conter apenas números, sendo eles no formato ##.###.###/#### ou ############ !");
		}

		return Integer.parseInt(dv1 + "" + dv2);
	}

	/**
	 * Método null-safe que remove a formatação da String, com a intenção de deixar
	 * apenas números.
	 * 
	 * @param numero - CNPJ que pode estar formatado.
	 * @return Número CNPJ sem formatação.
	 */
	private String removaFormatacao(String numero) {
		
		numero = replaceChars(numero, ".", "");
		numero = replaceChars(numero, "/", "");
		
		return numero;
	}
	
	/**
	 * <p>
	 * Verifica se o número passado está em um formato aceitável para a realização do cálculo,
	 * ou seja:
	 * </p>
	 * <ul>
	 * 	<li>Não é null</li>
	 * 	<li>Não é vazio</li>
	 *  <li>Apenas números</li>
	 *  <li>Não é somente zeros</li>
	 *  <li>Está no formato ##.###.###/#### ou ############</li>
	 * </ul>
	 * 
	 * @param numero - CNPJ para ser validado
	 * @return <code>true</code> caso o número esteja em um formato válido; <code>false</code>, 
	 * caso contrário.
	 */
	private boolean isFormatoValido(String numero) {
		
		boolean isValido = false;
		
		if (isNotBlank(numero)) {
			
			boolean formatoValido = (Pattern.matches(REGEX_CNPJ_DV, numero) || Pattern.matches(REGEX_CNPJ_DV_FORMATTED, numero));

			if (formatoValido) {
				
				isValido = Long.parseLong(numero) > 0;
			}
		}
		
		return isValido;
	}

	/**
	 * <p>
	 * Método auxiliar para o cálculo do dígito verificador.
	 * </p>
	 * <p>
	 * Calcula os dígitos separadamente.
	 * </p>
	 * 
	 * @param numero
	 *            - número a partir do qual será extraído o dígito verificador.
	 * @return Um número que faz parte de um dígito verificador.
	 * @throws IllegalArgumentException
	 *             caso o número não esteja no formatador desejável.
	 * 
	 * @since 0.2
	 */
	private int calculeDigito(String numero) throws IllegalArgumentException {

		int dv = 0;
		int resto = 0;

		resto = Modulo.calculeMod11(numero, LIMITE_MINIMO, LIMITE_MAXIMO);

		if (resto >= 2) {

			dv = TipoDeModulo.MODULO11.valor() - resto;
		}

		return dv;
	}

}
