Add CHANGELOG.

Minor changes/fixes in some modules.

Author: cabol

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+## [0.1.0](https://github.com/cabol/shards/tree/0.1.0) (2016-05-18)
+**Closed issues:**
+
+- Operation of the `shards:info/2` does not match [\#8](https://github.com/cabol/shards/issues/8)
+
+**Merged pull requests:**
+
+- Fix README. [\#7](https://github.com/cabol/shards/pull/7) ([cabol](https://github.com/cabol))
+- Refactor `shards_local` to handle `state` and avoid to call ETS control table. [\#6](https://github.com/cabol/shards/pull/6) ([cabol](https://github.com/cabol))
+- Implemented distributed shards. [\#5](https://github.com/cabol/shards/pull/5) ([cabol](https://github.com/cabol))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

src/shards.app.src

@@ -10,6 +10,6 @@
   {licenses, ["MIT"]},
   {links, [
     {"GitHub", "https://github.com/cabol/shards"},
-    {"Docs", "http://cabol.github.io/shards"}
+    {"Docs", "http://cabol.github.io/posts/2016/04/14/sharding-support-for-ets.html"}
   ]}
 ]}.

src/shards.erl

@@ -79,7 +79,8 @@
 
 -export([
   state/1,
-  type/1,
+  module/1,
+  tab_type/1,
   n_shards/1,
   list/1
 ]).
@@ -992,34 +993,43 @@ pick_one(Key, Nodes) ->
 -spec state(TabName) -> State when
   TabName :: atom(),
   State   :: state().
-state(TabName) ->
-  shards_local:state(TabName).
+state(TabName) -> shards_local:state(TabName).
+
+%% @doc
+%% Returns the module used by the given table.
+%% <ul>
+%% <li>`TabNameOrState': Table name or State.</li>
+%% </ul>
+%% @end
+-spec module(TabNameOrState) -> Type when
+  TabNameOrState :: state() | atom(),
+  Type           :: shards_local:type().
+module({Module, _, _}) -> Module;
+module(TabName)        -> module(state(TabName)).
 
 %% @doc
 %% Returns the table type.
 %% <ul>
-%% <li>`TabName': Table name.</li>
+%% <li>`TabNameOrState': Table name or State.</li>
 %% </ul>
 %% @end
--spec type(TabName) -> Type when
-  TabName :: atom(),
-  Type    :: atom().
-type(TabName) ->
-  {_, Type, _} = state(TabName),
-  Type.
+-spec tab_type(TabNameOrState) -> Type when
+  TabNameOrState :: state() | atom(),
+  Type           :: shards_local:type().
+tab_type({_, Type, _}) -> Type;
+tab_type(TabName)      -> tab_type(state(TabName)).
 
 %% @doc
 %% Returns the number of shards.
 %% <ul>
-%% <li>`TabName': Table name.</li>
+%% <li>`TabNameOrState': Table name or State.</li>
 %% </ul>
 %% @end
--spec n_shards(TabName) -> NumShards when
-  TabName   :: atom(),
-  NumShards :: pos_integer().
-n_shards(TabName) ->
-  {_, _, NumShards} = state(TabName),
-  NumShards.
+-spec n_shards(TabNameOrState) -> NumShards when
+  TabNameOrState :: state() | atom(),
+  NumShards      :: pos_integer().
+n_shards({_, _, NumShards}) -> NumShards;
+n_shards(TabName)           -> n_shards(state(TabName)).
 
 %% @doc
 %% Returns the list of shard names associated to the given `TabName'.
@@ -1031,5 +1041,4 @@ n_shards(TabName) ->
 -spec list(TabName) -> ShardTabNames when
   TabName       :: atom(),
   ShardTabNames :: [atom()].
-list(TabName) ->
-  shards_local:list(TabName, n_shards(TabName)).
+list(TabName) -> shards_local:list(TabName, n_shards(TabName)).

src/shards_local.erl

@@ -141,12 +141,12 @@
 %% Defines the `shards' local state:
 %% <ul>
 %% <li>`Module': Module to use: `shards_local' | `shards_dist'.</li>
-%% <li>`Type': Table type.</li>
+%% <li>`TableType': Table type.</li>
 %% <li>`NumShards': Number of ETS shards/fragments.</li>
 %% </ul>
 -type state() :: {
   Module    :: shards_local | shards_dist,
-  Type      :: type(),
+  TableType :: type(),
   NumShards :: pos_integer()
 }.
 
@@ -1229,7 +1229,7 @@ list(TabName, NumShards) ->
 %% </ul>
 %% @end
 -spec state(TabName :: atom()) -> state().
-state(TabName) ->
+state(TabName) when is_atom(TabName) ->
   ets:lookup_element(TabName, '$shards_state', 2).
 
 %%%===================================================================

test/test_helper.erl

@@ -432,12 +432,17 @@ init_shards(Scope) ->
     {n_shards, 5}, {scope, Scope}, sharded_duplicate_bag
   ]),
 
+  Mod = case Scope of
+    g -> shards_dist;
+    _ -> shards_local
+  end,
+
   DefaultShards = ?N_SHARDS,
   shards_created(?SHARDS_TABS),
-  {_, set, 2} = shards:state(?SET),
-  {_, duplicate_bag, 5} = shards:state(?DUPLICATE_BAG),
-  {_, ordered_set, DefaultShards} = shards:state(?ORDERED_SET),
-  {_, sharded_duplicate_bag, 5} =
+  {Mod, set, 2} = shards:state(?SET),
+  {Mod, duplicate_bag, 5} = shards:state(?DUPLICATE_BAG),
+  {Mod, ordered_set, DefaultShards} = shards:state(?ORDERED_SET),
+  {Mod, sharded_duplicate_bag, 5} =
     shards:state(?SHARDED_DUPLICATE_BAG),
   duplicate_bag =
     ets:info(shards_local:shard_name(?SHARDED_DUPLICATE_BAG, 0), type),
@@ -453,7 +458,7 @@ init_shards(Scope) ->
   ok.
 
 cleanup_shards() ->
-  {Mod, _, _} = shards:state(?SET),
+  Mod = shards:module(?SET),
   cleanup_shards_(Mod).
 
 cleanup_shards_(shards_local) ->