mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2026-05-14 06:50:25 +00:00
51d0188533
`Option[T]` currently exposes a method `Value()` which is permitted to be called on an option that has a value, and an option that doesn't have a value. This API is awkward because the behaviour if the option doesn't have a value isn't clear to the caller, and, because almost all accesses end up being `.Has()?` then `OK, use .Value()`. `Get() (bool, T)` is added as a better replacement, which both returns whether the option has a value, and the value if present. Most call-sites are rewritten to this form. `ValueOrZeroValue()` is a direct replacement that has the same behaviour that `Value()` had, but describes the behaviour if the value is missing. In addition to the current API being awkward, the core reason for this change is that `Value()` conflicts with the `Value()` function from the `driver.Valuer` interface. If this interface was implemented, it would allow `Option[T]` to be used to represent a nullable field in an xorm bean struct (requires: https://code.forgejo.org/xorm/xorm/pulls/66). _Note:_ changes are extensive in this PR, but are almost all changes are easy, mechanical transitions from `.Has()` to `.Get()`. All of this work was performed by hand. ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [ ] in their respective `*_test.go` for unit tests. - [ ] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] This change will be noticed by a Forgejo user or admin (feature, bug fix, performance, etc.). I suggest to include a release note for this change. - [x] This change is not visible to a Forgejo user or admin (refactor, dependency upgrade, etc.). I think there is no need to add a release note for this change. *The decision if the pull request will be shown in the release notes is up to the mergers / release team.* The content of the `release-notes/<pull request number>.md` file will serve as the basis for the release notes. If the file does not exist, the title of the pull request will be used instead. Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/11218 Reviewed-by: Otto <otto@codeberg.org> Reviewed-by: Gusted <gusted@noreply.codeberg.org> Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net> Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
66 lines
1.9 KiB
Go
66 lines
1.9 KiB
Go
// Copyright 2023 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package bleve
|
|
|
|
import (
|
|
"forgejo.org/modules/optional"
|
|
|
|
"github.com/blevesearch/bleve/v2"
|
|
"github.com/blevesearch/bleve/v2/search/query"
|
|
)
|
|
|
|
// NumericEqualityQuery generates a numeric equality query for the given value and field
|
|
func NumericEqualityQuery(value int64, field string) *query.NumericRangeQuery {
|
|
f := float64(value)
|
|
tru := true // codespell:ignore
|
|
q := bleve.NewNumericRangeInclusiveQuery(&f, &f, &tru, &tru) // codespell:ignore
|
|
q.SetField(field)
|
|
return q
|
|
}
|
|
|
|
// MatchQuery generates a match query for the given phrase, field and analyzer
|
|
func MatchQuery(matchTerm, field, analyzer string, fuzziness int) *query.MatchQuery {
|
|
q := bleve.NewMatchQuery(matchTerm)
|
|
q.FieldVal = field
|
|
q.Analyzer = analyzer
|
|
q.Fuzziness = fuzziness
|
|
return q
|
|
}
|
|
|
|
// MatchPhraseQuery generates a match phrase query for the given phrase, field and analyzer
|
|
func MatchPhraseQuery(matchPhrase, field, analyzer string, autoFuzzy bool, boost float64) *query.MatchPhraseQuery {
|
|
q := bleve.NewMatchPhraseQuery(matchPhrase)
|
|
q.FieldVal = field
|
|
q.Analyzer = analyzer
|
|
q.SetAutoFuzziness(autoFuzzy)
|
|
q.SetBoost(boost)
|
|
return q
|
|
}
|
|
|
|
// BoolFieldQuery generates a bool field query for the given value and field
|
|
func BoolFieldQuery(value bool, field string) *query.BoolFieldQuery {
|
|
q := bleve.NewBoolFieldQuery(value)
|
|
q.SetField(field)
|
|
return q
|
|
}
|
|
|
|
func NumericRangeInclusiveQuery(min, max optional.Option[int64], field string) *query.NumericRangeQuery {
|
|
var minF, maxF *float64
|
|
var minI, maxI *bool
|
|
if has, value := min.Get(); has {
|
|
minF = new(float64)
|
|
*minF = float64(value)
|
|
minI = new(bool)
|
|
*minI = true
|
|
}
|
|
if has, value := max.Get(); has {
|
|
maxF = new(float64)
|
|
*maxF = float64(value)
|
|
maxI = new(bool)
|
|
*maxI = true
|
|
}
|
|
q := bleve.NewNumericRangeInclusiveQuery(minF, maxF, minI, maxI)
|
|
q.SetField(field)
|
|
return q
|
|
}
|