Skip to content

Commit

Permalink
new: move Filtering out of elemental (#78)
Browse files Browse the repository at this point in the history
* new: move manipulate.Filter in elemental

* new: added type alias for backward compat

* fixed: lint
  • Loading branch information
primalmotion committed May 2, 2019
1 parent 8f16f6b commit c51fa95
Show file tree
Hide file tree
Showing 18 changed files with 128 additions and 3,100 deletions.
6 changes: 3 additions & 3 deletions context.go
Expand Up @@ -53,7 +53,7 @@ type FinalizerFunc func(o elemental.Identifiable) error
type Context interface {
Count() int
SetCount(count int)
Filter() *Filter
Filter() *elemental.Filter
Finalizer() FinalizerFunc
Version() int
TransactionID() TransactionID
Expand Down Expand Up @@ -103,7 +103,7 @@ type mcontext struct {
pageSize int
parent elemental.Identifiable
countTotal int
filter *Filter
filter *elemental.Filter
parameters url.Values
transactionID TransactionID
namespace string
Expand All @@ -129,7 +129,7 @@ func (c *mcontext) Count() int { return c.countTotal }
func (c *mcontext) SetCount(count int) { c.countTotal = count }

// Filter returns the filter.
func (c *mcontext) Filter() *Filter { return c.filter }
func (c *mcontext) Filter() *elemental.Filter { return c.filter }

// Finalizer returns the finalizer.
func (c *mcontext) Finalizer() FinalizerFunc { return c.createFinalizer }
Expand Down
7 changes: 4 additions & 3 deletions context_test.go
Expand Up @@ -17,6 +17,7 @@ import (
"testing"

. "github.com/smartystreets/goconvey/convey"
"go.aporeto.io/elemental"
testmodel "go.aporeto.io/elemental/test/model"
)

Expand Down Expand Up @@ -72,7 +73,7 @@ func TestMethodNewContextWithFilter(t *testing.T) {

Convey("Given I create a new context with filter", t, func() {

filter := NewFilter()
filter := elemental.NewFilter()
mctx := NewContext(
context.Background(),
ContextOptionFilter(filter),
Expand Down Expand Up @@ -125,7 +126,7 @@ func TestContext_Derive(t *testing.T) {
pageSize: 2,
parent: testmodel.NewList(),
countTotal: 3,
filter: NewFilterComposer().WithKey("k").Equals("v").Done(),
filter: elemental.NewFilterComposer().WithKey("k").Equals("v").Done(),
parameters: url.Values{"a": []string{"b"}},
transactionID: NewTransactionID(),
namespace: "/",
Expand Down Expand Up @@ -171,7 +172,7 @@ func TestContext_Derive(t *testing.T) {

copy := mctx.Derive(
ContextOptionPage(11, 12),
ContextOptionFilter(NewFilterComposer().WithKey("k").Equals("v2").Done()),
ContextOptionFilter(elemental.NewFilterComposer().WithKey("k").Equals("v2").Done()),
).(*mcontext)

Convey("Then the copy should resemble to the original but for the changes", func() {
Expand Down
54 changes: 54 additions & 0 deletions filter.go
@@ -0,0 +1,54 @@
// Copyright 2019 Aporeto Inc.
// 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.

package manipulate

import (
"fmt"

"go.aporeto.io/elemental"
)

// This package provides type mapping for backward compatilility
// as manipulate.Filter moved to elemental.

// Filter is an alias of elemental.Filter
type Filter = elemental.Filter

// FilterKeyComposer is an alias of elemental.FilterKeyComposer
type FilterKeyComposer = elemental.FilterKeyComposer

// FilterParser is an alias of elemental.FilterParser
type FilterParser = elemental.FilterParser

// NewFilter returns a new Filter using the aliased type.
func NewFilter() *Filter {
fmt.Println("DEPRECATED: manipulate.NewFilter is deprecated and aliased to elemental.NewFilter")
return elemental.NewFilter()
}

// NewFilterComposer returns a new FilterKeyComposer using the aliased type.
func NewFilterComposer() FilterKeyComposer {
fmt.Println("DEPRECATED: manipulate.NewFilterComposer is deprecated and aliased to elemental.NewFilterComposer")
return elemental.NewFilter()
}

// NewFilterFromString returns a new NewFilterFromString using the aliased type.
func NewFilterFromString(filter string) (*Filter, error) {
fmt.Println("DEPRECATED: manipulate.NewFilterFromString is deprecated and aliased to elemental.NewFilterFromString")
return elemental.NewFilterFromString(filter)
}

// NewFilterParser returns a new NewFilterParser using the aliased type.
func NewFilterParser(input string) *FilterParser {
fmt.Println("DEPRECATED: manipulate.NewFilterParser is deprecated and aliased to elemental.NewFilterParser")
return elemental.NewFilterParser(input)
}

0 comments on commit c51fa95

Please sign in to comment.