SearchQueryParser

SearchQueryParser

SearchQueryParser é um analisador (e marcador) de consulta de mecanismo de pesquisa simples, semelhante ao Google, para Swift. Ele pega uma string de pesquisa e constrói sua árvore de sintaxe abstrata. Este pacote é aplicável para uso com o Search Kit da Apple para destacar os resultados encontrados.

Características

• Sem scanner (sem lexer)
• Suporte à sintaxe booleana (AND ("&"), OR ("|"), NOT ("!") operadores lógicos)
• Curingas de prefixo e sufixo ("*")
• Pesquisas de frases
• Tolerante a erros de sintaxe de consulta de pesquisa
• Fornece recursos para localizar termos de pesquisa em um texto de entrada

Gramática da consulta de pesquisa

Formulário Backus-Naur (BNF):

 Query = Sweeping-Mute-And-Term, ⧚’?, EOF ;
Sweeping-Mute-And-Term = Mute-And-Term, { ⧚’?, Mute-And-Term }* ;
Mute-And-Term = Or-Term, Or-Term* ;
Or-Term = And-Term, {⧚?, (‘|’ | “OR”), And-Term }* ;
And-Term = Not-Term, {⧚?, (‘&’ | “AND”), Not-Term }* ;
Not-Term = ⧚?, (’!’ | “NOT”), Not-Term | Primary-Term ;
Primary-Term = ⧚?, ’(‘ ⧚?, Mute-And-Term, ⧚? ‘)’ |
               ⧚?, “‘“ ⧚?, Phrase, ⧚? “‘“ |
               ⧚?, Prefix-Wildcard-Search-Term |
               ⧚?, Suffix-Wildcard-Search-Term |
               ⧚?, Search-Term ;
Phrase = Search-Term, { ⧚, Search-Term }* ;
Prefix-Wildcard-Search-Term = ‘*’, Search-Term ;
Suffix-Wildcard-Search-Term = Search-Term, ‘*’ ;
Search-Term = Letter | Letter, Search-Term ;
Letter = Alpha | Digit | ‘_’ ;
⧚’ = ⧚-(“*” | “!” | “&” | “(“ | “)” | “””)
⧚ = { ? any-character ?-Letter }+ ;
Alpha = ? alpha-character ? ;
Digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;

Casos de uso

Imprima a árvore de sintaxe abstrata de uma consulta de pesquisa

import SearchQueryParser

func printQueryAST ( _ query : String ) {
    guard let parser = SearchQueryParser ( query ) , let ast = parser . astRoot
    else {
        print ( " Couldn't parse " )
        return
    }
    print ( " AST: ( ast ) " )
}

printQueryAST ( " foo bar " )

Destacar correspondências de consulta de pesquisa

import SearchQueryParser

func highlightSearchQueryMatches ( query : String , in text : NSMutableAttributedString ) {
    guard let queryTerms = SearchQueryParser ( query )
    else {
        print ( " No matches found " )
        return
    }
    let tokensProvider = SearchTextScanner ( text . string )
    guard let applicator = SearchQueryApplicator ( searchQueryTerms : queryTerms ,
                                                 textTokens : tokensProvider )
    else {
        print ( " Nothing was marked " )
        return
    }
    applicator . markedRanges . forEach { range in
        text . addAttribute ( . backgroundColor , value : NSColor . yellow , range : range )
    }
}
let text = NSMutableAttributedString ( string : " Lorem ipsum ... " )
highlightSearchQueryMatches ( query : " foo & bar " , in : text ) 

Instalação

Pacote Swift como dependência no Xcode 11+

1. Vá para "Arquivo" -> "Pacotes Swift" -> "Adicionar Dependência de Pacote"
2. Cole o URL do repositório do Search Query Parser no campo de pesquisa:

https://github.com/SerhiyButz/SearchQueryParser.git

3. Clique em "Avançar"

4. Certifique-se de que o campo "Regras" esteja definido como algo assim: "Versão: Até o próximo principal: 1.3.0"

5. Clique em "Avançar" para finalizar

Para mais informações, confira aqui.

CocoaPods

Adicione o seguinte ao seu Podfile:

 platform :osx , '10.12'

target 'YOUR-TARGET' do
  use_frameworks!
  pod 'SearchQueryParser' , :git => 'https://github.com/SerhiyButz/SearchQueryParser.git'
end

Em seguida, execute pod install .

Licença

Este projeto está licenciado sob a licença do MIT.