Merge remote-tracking branch 'origin/main' into main

README.md

@@ -5,24 +5,22 @@ Projeto criado para realizar a manipulação de todos os dados possíveis dentro
 ``` go get -u github.com/Darklabel91/CNJ_Validate ```
 
 ## Data Struct
-Os dados de retorno podem ser ```string```, ```bool```, ```AnalysisCNJ``` ou ```CNJNumber``` , essas últimas são composta por:
+Os dados de retorno podem ser ```string```, ```bool```, ```AnalysisCNJ``` ou ```DecomposedCNJ``` , essas últimas são composta por:
 
 ``` 
 type AnalysisCNJ struct {
-	ReceivedCNJ string    `json:"received_cnj,omitempty"`
-	ValidCNJ    bool      `json:"valid_cnj,omitempty"`
-	CorrectCNJ  string    `json:"correct_cnj,omitempty"`
-	ValidDigit  string    `json:"valid_digit,omitempty"`
-	Segment1    string    `json:"segment1,omitempty"`
-	Segment2    string    `json:"segment2,omitempty"`
-	SourceUnit1 string    `json:"source_unit1,omitempty"`
-	SourceUnit2 string    `json:"source_unit2,omitempty"`
-	Court1      string    `json:"court1,omitempty"`
-	Court2      string    `json:"court2,omitempty"`
-	Detailed    CNJNumber `json:"detailed"`
+	ReceivedCNJ      string        `json:"received_cnj,omitempty"`
+	ValidCNJ         bool          `json:"valid_cnj,omitempty"`
+	SegmentName      string        `json:"segmentName,omitempty"`
+	SegmentShort     string        `json:"segment_short,omitempty"`
+	SourceUnitType   string        `json:"source_unit_type,omitempty"`
+	SourceUnitNumber string        `json:"source_unit_number,omitempty"`
+	CourtType        string        `json:"court_type,omitempty"`
+	CourtNumber      string        `json:"court_number,omitempty"`
+	Detailed         DecomposedCNJ `json:"Detailed"`
 }
 
-type CNJNumber struct {
+type DecomposedCNJ struct {
 	LawsuitNumber  string `json:"lawsuit_number,omitempty"`
 	VerifyingDigit string `json:"verifying_digit,omitempty"`
 	ProtocolYear   string `json:"protocol_year,omitempty"`
@@ -37,14 +35,12 @@ type CNJNumber struct {
 ### AnalysisCNJ
 - ReceivedCNJ: o cnj passado como parâmetro [0001327-64.2018.8.26.0158]
 - ValidCNJ: informa '''true''' caso o *ReceivedCNJ* tenha o dígito verificador como válido [true]
-- CorrectCNJ: informa o CNJ com o dígito verificador válido [0001327-64.2018.8.26.0158]
-- ValidDigit: informa o dígito verificador correto para o *ReceivedCNJ* [64]
-- Segment1: informa o seguimento do ramo da justiça correspondente [Justiça dos Estados e do Distrito Federal e Territórios]
-- Segment2: informa a sigla do seguimento da justiça correspondente [Justiça Comum]
-- SourceUnit1: informa o tipo da unidade de origem [foro]
-- SourceUnit2: informa a unidade de origem [0158]
-- Court1: informa o tipo de corte de origem [unidade federativa]
-- Court2: informa a unidade da corte de origem [26]
+- SegmentName: informa o seguimento do ramo da justiça correspondente [Justiça dos Estados e do Distrito Federal e Territórios]
+- SegmentShort: informa a sigla do seguimento da justiça correspondente [Justiça Comum]
+- SourceUnitType: informa o tipo da unidade de origem [foro]
+- SourceUnitNumber: informa a unidade de origem [0158]
+- CourtType: informa o tipo de corte de origem [unidade federativa]
+- CourtNumber: informa a unidade da corte de origem [26]
 - Detailed: retorna a estrutura do CNJNumber
 
 ### CNJNumber
@@ -120,17 +116,15 @@ Files created
 
 ### Main Function:
 - AnalyzeCNJ(cnj string) retorna a estrutura *AnalysisCNJ* necessitando apenas de um CNJ no formato *NNNNNNN-DD.AAAA.J.CT.0000* ou *NNNNNNNDDAAAAJCT0000* retorna erro caso qualquer verificação seja inválida.
-- AnalyzeCNJCSV(rawFilePath string, separator rune, nameResultFolder string) retorna um CSV com a estrutura *AnalysisCNJ* necessitando do caminho onde está o arquivo para leitura (devendo ter apenas uma coluna com os números CNJ), o separador (','), e o nome da pasta em que os arquivos devem retornar
 - CNJWrite(number Structs.AnalysisCNJ) retorna uma frase para demostrar a organização das informações, necessita de um *AnalysisCNJ*
+- AnalyzeCNJCSV(rawFilePath string, separator rune, nameResultFolder string) retorna um CSV com a estrutura *AnalysisCNJ* necessitando do caminho onde está o arquivo para leitura (devendo ter apenas uma coluna com os números CNJ), o separador (','), e o nome da pasta em que os arquivos devem retornar
+
 
 ### Suport Functions:
-- ReturnStructCNJ(cnj string): retorna *Structs.CNJNumber*, retorna erro caso o cnj esteja fora do padrão
-- OriginCourt(cnj string): retorna o *Court1* e *Court2*, retorna erro caso a sequência seja inválida
-- Segment(cnj string): retorna o *Segment1* e *Segment2*, retorna erro caso o a sequência seja inválida
-- SourceUnit(cnj string): retorna o *SourceUnit1* e *SourceUnit2*, retorna erro caso a sequência seja inválida
-- ValidateCNJ(cnj string): retorna *true* caso o cnj sejá válido e o dígito verificador
-- ReturnValidCNJ(cnj string): retorna o CNJ com o dígito verificador correto
-- ValidVD(cnj string): retorna o dígito verificador correto
+-  DecomposeCNJ(cnj string) retorna *[DecomposedCNJ](https://pkg.go.dev/github.com/Darklabel91/CNJ_Validate/CNJ#DecomposedCNJ)* necessitando de um CNJ no formato *NNNNNNN-DD.AAAA.J.CT.0000* ou *NNNNNNNDDAAAAJCT0000*
+-  GetOriginCourt(court string, segment Segment) retorna [OriginCourt](https://pkg.go.dev/github.com/Darklabel91/CNJ_Validate/CNJ#OriginCourt) necessitando do códgigo do tribunal (composto por dois dígitos) e um *[Segment](https://pkg.go.dev/github.com/Darklabel91/CNJ_Validate/CNJ#Segment)*
+- GetSourceUnit(sourceUnit string, segment Segment) retorna *[SourceUnit](https://pkg.go.dev/github.com/Darklabel91/CNJ_Validate/CNJ#SourceUnit)* necessitando do código da unidade (composto por 4 dígitos) e um *[Segment](https://pkg.go.dev/github.com/Darklabel91/CNJ_Validate/CNJ#Segment)*
+- ValidateCNJ(cnj string) retorna um *True* para uma sequência CNJ válida no formato *NNNNNNN-DD.AAAA.J.CT.0000* ou *NNNNNNNDDAAAAJCT0000* 
 
 ## Considerações
 A) Esse projeto foi criado de forma voluntária, você pode contribuir de qualquer modo. Se encontrar uma falha, não hesite em criar um “issue” ou  procure corrigir você mesma(o) o erro e dar um “pull request”.