refactor(contributes): unify naming && add missing doc && clean up

Author: mydearxym

lib/groupher_server/application.ex

@@ -5,6 +5,7 @@ defmodule GroupherServer.Application do
   # for more information on OTP Applications
   def start(_type, _args) do
     import Supervisor.Spec
+    import Cachex.Spec
 
     # Define workers and child supervisors to be supervised
     children = [
@@ -14,7 +15,22 @@ defmodule GroupherServer.Application do
       supervisor(GroupherServerWeb.Endpoint, []),
       # Start your own worker by calling: GroupherServer.Worker.start_link(arg1, arg2, arg3)
       # worker(GroupherServer.Worker, [arg1, arg2, arg3]),
-      worker(Cachex, [:site_cache, []])
+      worker(Cachex, [
+        :site_cache,
+        [
+          limit:
+            limit(
+              # the limit provided
+              size: 5000,
+              # the policy to use for eviction
+              policy: Cachex.Policy.LRW,
+              # how much to reclaim on bound expiration
+              reclaim: 0.1,
+              # options to pass to the policy
+              options: []
+            )
+        ]
+      ])
     ]
 
     # See https://hexdocs.pm/elixir/Supervisor.html

lib/groupher_server/statistics/delegates/contribute.ex

@@ -12,35 +12,43 @@ defmodule GroupherServer.Statistics.Delegate.Contribute do
   @community_contribute_days get_config(:general, :community_contribute_days)
   @user_contribute_months get_config(:general, :user_contribute_months)
 
+  @doc """
+  update community's contributes record
+  """
   def make_contribute(%Community{id: id}) do
     today = Timex.today() |> Date.to_iso8601()
 
-    with {:ok, contribute} <- ORM.find_by(CommunityContribute, community_id: id, date: today) do
-      contribute |> inc_contribute_count(:community) |> done
-    else
+    case ORM.find_by(CommunityContribute, community_id: id, date: today) do
+      {:ok, contribute} ->
+        contribute |> inc_contribute_count(:community) |> done
+
       {:error, _} ->
         CommunityContribute |> ORM.create(%{community_id: id, date: today, count: 1})
     end
   end
 
+  @doc """
+  update user's contributes record
+  """
   def make_contribute(%User{id: id}) do
     today = Timex.today() |> Date.to_iso8601()
 
-    with {:ok, contribute} <- ORM.find_by(UserContribute, user_id: id, date: today) do
-      contribute |> inc_contribute_count(:user) |> done
-    else
+    case ORM.find_by(UserContribute, user_id: id, date: today) do
+      {:ok, contribute} ->
+        contribute |> inc_contribute_count(:user) |> done
+
       {:error, _} ->
         UserContribute |> ORM.create(%{user_id: id, date: today, count: 1})
     end
   end
 
   @doc """
-  Returns the list of user_contribute by latest 6 months.
+  Returns the list of user_contribute by latest 6 days.
   """
-  def list_contributes(%User{id: id}) do
+  def list_contributes_digest(%User{id: id}) do
     user_id = integerfy(id)
 
-    "user_contributes"
+    UserContribute
     |> where([c], c.user_id == ^user_id)
     |> QueryBuilder.recent_inserted(months: @user_contribute_months)
     |> select([c], %{date: c.date, count: c.count})
@@ -49,13 +57,9 @@ defmodule GroupherServer.Statistics.Delegate.Contribute do
     |> done
   end
 
-  def list_contributes(%Community{id: id}) do
-    %Community{id: id}
-    |> get_contributes()
-    |> to_counts_digest(days: @community_contribute_days)
-    |> done
-  end
-
+  @doc """
+  Returns the list of community_contribute by latest 6 days.
+  """
   def list_contributes_digest(%Community{id: id}) do
     %Community{id: id}
     |> get_contributes()
@@ -66,7 +70,7 @@ defmodule GroupherServer.Statistics.Delegate.Contribute do
   defp get_contributes(%Community{id: id}) do
     community_id = integerfy(id)
 
-    "community_contributes"
+    CommunityContribute
     |> where([c], c.community_id == ^community_id)
     |> QueryBuilder.recent_inserted(days: @community_contribute_days)
     |> select([c], %{date: c.date, count: c.count})

lib/groupher_server/statistics/statistics.ex

@@ -5,14 +5,13 @@ defmodule GroupherServer.Statistics do
 
   alias GroupherServer.Statistics.Delegate.{
     Contribute,
-    Throttle,
     Geo,
-    Status
+    Status,
+    Throttle
   }
 
   # contributes
   defdelegate make_contribute(info), to: Contribute
-  defdelegate list_contributes(info), to: Contribute
   defdelegate list_contributes_digest(community), to: Contribute
 
   # publish Throttle

lib/groupher_server_web/resolvers/statistics_resolver.ex

@@ -6,22 +6,22 @@ defmodule GroupherServerWeb.Resolvers.Statistics do
   # alias Helper.ORM
 
   # tmp for test
-  def list_contributes(_root, %{id: id}, _info) do
-    Statistics.list_contributes(%Accounts.User{id: id})
+  def list_contributes_digest(_root, %{id: id}, _info) do
+    Statistics.list_contributes_digest(%Accounts.User{id: id})
   end
 
-  def list_contributes(%Accounts.User{id: id}, _args, _info) do
-    Statistics.list_contributes(%Accounts.User{id: id})
-  end
-
-  def list_contributes(%CMS.Community{id: id}, _args, _info) do
-    Statistics.list_contributes(%CMS.Community{id: id})
+  def list_contributes_digest(%Accounts.User{id: id}, _args, _info) do
+    Statistics.list_contributes_digest(%Accounts.User{id: id})
   end
 
   def list_contributes_digest(%CMS.Community{id: id}, _args, _info) do
     Statistics.list_contributes_digest(%CMS.Community{id: id})
   end
 
+  # def list_contributes_digest(%CMS.Community{id: id}, _args, _info) do
+  # Statistics.list_contributes_digest(%CMS.Community{id: id})
+  # end
+
   def make_contrubute(_root, %{user_id: user_id}, _info) do
     Statistics.make_contribute(%Accounts.User{id: user_id})
   end

lib/groupher_server_web/schema/account/account_types.ex

@@ -243,7 +243,7 @@ defmodule GroupherServerWeb.Schema.Account.Types do
     end
 
     field :contributes, :contribute_map do
-      resolve(&R.Statistics.list_contributes/3)
+      resolve(&R.Statistics.list_contributes_digest/3)
     end
 
     # TODO, for msg-bell UI

lib/groupher_server_web/schema/cms/cms_types.ex

@@ -314,11 +314,6 @@ defmodule GroupherServerWeb.Schema.CMS.Types do
       middleware(M.ConvertToInt)
     end
 
-    field :contributes, list_of(:contribute) do
-      # TODO add complex here to warning N+1 problem
-      resolve(&R.Statistics.list_contributes/3)
-    end
-
     field :threads_count, :integer do
       resolve(&R.CMS.threads_count/3)
     end

lib/groupher_server_web/schema/statistics/statistics_queries.ex

@@ -9,7 +9,7 @@ defmodule GroupherServerWeb.Schema.Statistics.Queries do
     field :user_contributes, list_of(:user_contribute) do
       arg(:id, non_null(:id))
 
-      resolve(&R.Statistics.list_contributes/3)
+      resolve(&R.Statistics.list_contributes_digest/3)
     end
 
     @desc "list cities geo info"

test/groupher_server/statistics/statistics_test.exs

@@ -20,14 +20,14 @@ defmodule GroupherServer.Test.Statistics do
     alias Statistics.UserContribute
 
     test "list_contributes return empty list when theres no records", ~m(user)a do
-      {:ok, contributes} = Statistics.list_contributes(%User{id: user.id})
+      {:ok, contributes} = Statistics.list_contributes_digest(%User{id: user.id})
       assert contributes.records == []
       assert contributes.total_count == 0
     end
 
     test "list_contributes return proper format ", ~m(user)a do
       Statistics.make_contribute(%User{id: user.id})
-      {:ok, contributes} = Statistics.list_contributes(%User{id: user.id})
+      {:ok, contributes} = Statistics.list_contributes_digest(%User{id: user.id})
       # contributes[0]
       assert contributes |> Map.has_key?(:start_date)
       assert contributes |> Map.has_key?(:end_date)
@@ -56,7 +56,7 @@ defmodule GroupherServer.Test.Statistics do
         }
       ])
 
-      {:ok, contributes} = Statistics.list_contributes(%User{id: user.id})
+      {:ok, contributes} = Statistics.list_contributes_digest(%User{id: user.id})
       assert length(contributes.records) == 1
     end
 
@@ -143,7 +143,7 @@ defmodule GroupherServer.Test.Statistics do
         }
       ])
 
-      {:ok, contributes} = Statistics.list_contributes(%Community{id: community.id})
+      {:ok, contributes} = Statistics.list_contributes_digest(%Community{id: community.id})
       assert length(contributes) == @community_contribute_days + 1
     end
   end

test/helper/cache_test.exs

@@ -22,6 +22,7 @@ defmodule GroupherServer.Test.Helper.Cache do
       assert {:ok, true} = Cache.put(:data, :value)
       assert {:ok, :value} = Cache.get(:data)
 
+      # complex data
       assert {:ok, true} = Cache.put("namespace.aaa.bbb", [1, %{a: "2"}])
       assert {:ok, [1, %{a: "2"}]} = Cache.get("namespace.aaa.bbb")
     end