Factor index_spec type out into riak_kv_backend

It's bad practice to copy and paste the same type spec to a bunch of
different modules, especially in a case like this where it's part of a
defined behavior.

Author: nickelization

src/riak_kv_backend.erl

@@ -31,9 +31,12 @@
                                        any() |
                                        no_return()).
 
+-type index_spec() :: {add, Index, SecondaryKey} | {remove, Index, SecondaryKey}.
+
 -export_type([fold_buckets_fun/0,
               fold_keys_fun/0,
-              fold_objects_fun/0]).
+              fold_objects_fun/0,
+              index_spec/0]).
 
 %% These are just here to make the callback specs more succinct and readable
 -type state() :: term().
@@ -54,12 +57,11 @@
     {ok, Value :: term(), state()} |
     {ok, not_found, state()} |
     {error, term(), state()}.
-%% TODO pull all the copy-pasted index_spec() type specs into this mod and use in the callback spec
--callback put(riak_object:bucket(), riak_object:key(), IndexSpecs :: term(), Value :: binary(),
+-callback put(riak_object:bucket(), riak_object:key(), [index_spec()], Value :: binary(),
               state()) ->
     {ok, state()} |
     {error, term(), state()}.
--callback delete(riak_object:bucket(), riak_object:key(), IndexSpecs :: term(), state()) ->
+-callback delete(riak_object:bucket(), riak_object:key(), [index_spec()], state()) ->
     {ok, state()} |
     {error, term(), state()}.
 

src/riak_kv_bitcask_backend.erl

@@ -222,10 +222,10 @@ get(Bucket, Key, #state{ref=Ref, key_vsn=KVers}=State) ->
 %% NOTE: The bitcask backend does not currently support
 %% secondary indexing and the_IndexSpecs parameter
 %% is ignored.
--type index_spec() :: {add, Index, SecondaryKey} | {remove, Index, SecondaryKey}.
--spec put(riak_object:bucket(), riak_object:key(), [index_spec()], binary(), state()) ->
-                 {ok, state()} |
-                 {error, term(), state()}.
+-spec put(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()],
+          binary(), state()) ->
+    {ok, state()} |
+    {error, term(), state()}.
 put(Bucket, PrimaryKey, _IndexSpecs, Val,
     #state{ref=Ref, key_vsn=KeyVsn}=State) ->
     BitcaskKey = make_bk(KeyVsn, Bucket, PrimaryKey),
@@ -240,8 +240,8 @@ put(Bucket, PrimaryKey, _IndexSpecs, Val,
 %% NOTE: The bitcask backend does not currently support
 %% secondary indexing and the_IndexSpecs parameter
 %% is ignored.
--spec delete(riak_object:bucket(), riak_object:key(), [index_spec()], state()) ->
-                    {ok, state()}.
+-spec delete(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()], state()) ->
+    {ok, state()}.
 delete(Bucket, Key, _IndexSpecs,
        #state{ref=Ref, key_vsn=KeyVsn}=State) ->
     BitcaskKey = make_bk(KeyVsn, Bucket, Key),

src/riak_kv_eleveldb_backend.erl

@@ -171,10 +171,10 @@ get(Bucket, Key, #state{read_opts=ReadOpts,
     end.
 
 %% @doc Insert an object into the eleveldb backend.
--type index_spec() :: {add, Index, SecondaryKey} | {remove, Index, SecondaryKey}.
--spec put(riak_object:bucket(), riak_object:key(), [index_spec()], binary(), state()) ->
-                 {ok, state()} |
-                 {error, term(), state()}.
+-spec put(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()],
+          binary(), state()) ->
+    {ok, state()} |
+    {error, term(), state()}.
 put(Bucket, PrimaryKey, IndexSpecs, Val, #state{ref=Ref,
                                                 write_opts=WriteOpts,
                                                 legacy_indexes=WriteLegacy,
@@ -307,9 +307,9 @@ fixed_index_status(#state{fixed_indexes=Fixed}) ->
     Fixed.
 
 %% @doc Delete an object from the eleveldb backend
--spec delete(riak_object:bucket(), riak_object:key(), [index_spec()], state()) ->
-                    {ok, state()} |
-                    {error, term(), state()}.
+-spec delete(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()], state()) ->
+    {ok, state()} |
+    {error, term(), state()}.
 delete(Bucket, PrimaryKey, IndexSpecs, #state{ref=Ref,
                                               write_opts=WriteOpts,
                                               fixed_indexes=FixedIndexes}=State) ->

src/riak_kv_memory_backend.erl

@@ -203,9 +203,8 @@ get(Bucket, Key, State=#state{data_ref=DataRef,
     end.
 
 %% @doc Insert an object into the memory backend.
--type index_spec() :: {add, Index, SecondaryKey} | {remove, Index, SecondaryKey}.
--spec put(riak_object:bucket(), riak_object:key(), [index_spec()], binary(), state()) ->
-                 {ok, state()}.
+-spec put(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()],
+          binary(), state()) -> {ok, state()}.
 put(Bucket, PrimaryKey, IndexSpecs, Val, State=#state{data_ref=DataRef,
                                                       index_ref=IndexRef,
                                                       max_memory=MaxMemory,
@@ -253,7 +252,7 @@ put(Bucket, PrimaryKey, IndexSpecs, Val, State=#state{data_ref=DataRef,
                      put_obj_size=Size}}.
 
 %% @doc Delete an object from the memory backend
--spec delete(riak_object:bucket(), riak_object:key(), [index_spec()], state()) ->
+-spec delete(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()], state()) ->
                     {ok, state()}.
 delete(Bucket, Key, IndexSpecs, State=#state{data_ref=DataRef,
                                              index_ref=IndexRef,

src/riak_kv_multi_backend.erl

@@ -228,10 +228,10 @@ get(Bucket, Key, State) ->
 
 %% @doc Insert an object with secondary index
 %% information into the kv backend
--type index_spec() :: {add, Index, SecondaryKey} | {remove, Index, SecondaryKey}.
--spec put(riak_object:bucket(), riak_object:key(), [index_spec()], binary(), state()) ->
-                 {ok, state()} |
-                 {error, term(), state()}.
+-spec put(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()],
+          binary(), state()) ->
+    {ok, state()} |
+    {error, term(), state()}.
 put(Bucket, PrimaryKey, IndexSpecs, Value, State) ->
     {Name, Module, SubState} = get_backend(Bucket, State),
     case Module:put(Bucket, PrimaryKey, IndexSpecs, Value, SubState) of
@@ -244,7 +244,7 @@ put(Bucket, PrimaryKey, IndexSpecs, Value, State) ->
     end.
 
 %% @doc Delete an object from the backend
--spec delete(riak_object:bucket(), riak_object:key(), [index_spec()], state()) ->
+-spec delete(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()], state()) ->
                     {ok, state()} |
                     {error, term(), state()}.
 delete(Bucket, Key, IndexSpecs, State) ->

src/riak_kv_multi_prefix_backend.erl

@@ -273,10 +273,10 @@ get(Bucket, Key, State) ->
 
 %% @doc Insert an object with secondary index
 %% information into the kv backend
--type index_spec() :: {add, Index, SecondaryKey} | {remove, Index, SecondaryKey}.
--spec put(riak_object:bucket(), riak_object:key(), [index_spec()], binary(), state()) ->
-                 {ok, state()} |
-                 {error, term(), state()}.
+-spec put(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()],
+          binary(), state()) ->
+    {ok, state()} |
+    {error, term(), state()}.
 put(Bucket, PrimaryKey, IndexSpecs, Value, State) ->
     {Name, Module, SubState} = get_backend(Bucket, State),
     case Module:put(Bucket, PrimaryKey, IndexSpecs, Value, SubState) of
@@ -289,9 +289,9 @@ put(Bucket, PrimaryKey, IndexSpecs, Value, State) ->
     end.
 
 %% @doc Delete an object from the backend
--spec delete(riak_object:bucket(), riak_object:key(), [index_spec()], state()) ->
-                    {ok, state()} |
-                    {error, term(), state()}.
+-spec delete(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()], state()) ->
+    {ok, state()} |
+    {error, term(), state()}.
 delete(Bucket, Key, IndexSpecs, State) ->
     {Name, Module, SubState} = get_backend(Bucket, State),
     case Module:delete(Bucket, Key, IndexSpecs, SubState) of

src/riak_kv_yessir_backend.erl

@@ -266,9 +266,8 @@ make_get_return_val(RObj, false = _WantsBinary, #state{op_get = Gets} = S) ->
     {ok, RObj, S#state{op_get = Gets + 1}}.
 
 %% @doc Store an object, yes, sir!
--type index_spec() :: {add, Index, SecondaryKey} | {remove, Index, SecondaryKey}.
--spec put(riak_object:bucket(), riak_object:key(), [index_spec()], binary(), state()) ->
-                 {ok, state()}.
+-spec put(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()],
+          binary(), state()) -> {ok, state()}.
 put(_Bucket, _PKey, _IndexSpecs, _Val, #state{op_put = Puts} = S) ->
     {ok, S#state{op_put = Puts + 1}}.
 
@@ -286,8 +285,8 @@ put_object(Bucket, PKey, _IndexSpecs, RObj, #state{op_put = Puts} = S) ->
     {{ok, S#state{op_put = Puts + 1}}, EncodedVal}.
 
 %% @doc Delete an object, yes, sir!
--spec delete(riak_object:bucket(), riak_object:key(), [index_spec()], state()) ->
-                    {ok, state()}.
+-spec delete(riak_object:bucket(), riak_object:key(), [riak_kv_backend:index_spec()], state()) ->
+    {ok, state()}.
 delete(_Bucket, _Key, _IndexSpecs, #state{op_delete = Deletes} = S) ->
     {ok, S#state{op_delete = Deletes + 1}}.