lucaong / cubdb / 66

99%

master: 99%

Pull #5

travis-ci

[breaking change] improve the select/3 API for key ranges

The previous API had a few shortcomings:

  - There were corner cases for `nil` min_key/max_key, or
  min_key/max_key literally being tuples like `{123, :included}`

  - It was not possible in these corner cases to detect error conditions

  - Mispelling `:included` or `:excluded` would silently fail or lead to
  unexpected results

  - The API was a bit cumbersome in general

The new API is much clearer and removes the shortcomings:

```elixir
{:ok, result} = CubDB.select(db,
  min_key: :foo,
  max_key: {:bar, :excluded}
)
{:ok, result} = CubDB.select(db,
  min_key: :foo,
  max_key: :bar,
  max_key_inclusive: false
)

{:ok, result} = CubDB.select(db,
  min_key: :foo,
  max_key: nil
)
{:ok, result} = CubDB.select(db,
  min_key: :foo
)

{:ok, result} = CubDB.select(db,
  min_key: {nil, :included},
  max_key: :bar
)
{:ok, result} = CubDB.select(db,
  min_key: nil,
  max_key: :bar
)
```

14 of 14 new or added lines in 2 files covered. (100.0%)

475 of 478 relevant lines covered (99.37%)

10656.9 hits per line