added goal stat calculation

Author: elmuerte

app/controllers/discourse_kofi/payments_controller.rb

@@ -33,7 +33,7 @@ def index
           payment_types: SiteSetting.kofi_dashboard_types.split("|")
         )
 
-      if visible_details.exclude?("include_unknown")
+      if visible_details.exclude?("include_unknown_users")
         query = query.where("user_id is not null")
       end
 

app/services/discourse_kofi/payment_stats.rb

@@ -6,11 +6,17 @@ def self.calculate_leaderboard
       leaderboard = []
       if SiteSetting.kofi_leaderboard_count < 1 ||
            SiteSetting.kofi_leaderboard_types.empty? ||
-           SiteSetting.kofi_leaderboard_days < 1
+           SiteSetting.kofi_leaderboard_days == 0
         PluginStore.set(PLUGIN_NAME, :leaderboard, leaderboard)
         return leaderboard
       end
 
+      if SiteSetting.kofi_leaderboard_days == -1
+        timestamp_offset = DateTime.new
+      else
+        timestamp_offset = DateTime.now - SiteSetting.kofi_leaderboard_days.days
+      end
+
       ActiveRecord::Base
         .lease_connection
         .select_all(
@@ -29,7 +35,7 @@ def self.calculate_leaderboard
              ",
           "kofi_leaderboard",
           [
-            DateTime.now - SiteSetting.kofi_leaderboard_days.days,
+            timestamp_offset,
             SiteSetting.kofi_leaderboard_types,
             SiteSetting.kofi_leaderboard_count
           ]
@@ -48,6 +54,34 @@ def self.calculate_leaderboard
       leaderboard
     end
 
+    def self.calculate_goal
+      goal = { progress: 0, target: nil }
+      if SiteSetting.kofi_goal_amount <= 0 || SiteSetting.kofi_goal_types.empty?
+        PluginStore.set(PLUGIN_NAME, :goal, goal)
+        return goal
+      end
+
+      goal[
+        :target
+      ] = SiteSetting.kofi_goal_amount if SiteSetting.kofi_goal_show_amount
+
+      timestamp_offset =
+        DateTime.now - 1.month if SiteSetting.kofi_goal_period == "monthly"
+      timestamp_offset =
+        DateTime.now - 1.year if SiteSetting.kofi_goal_period == "yearly"
+
+      total =
+        Payment
+          .where("timestamp > ?", timestamp_offset)
+          .where(payment_type: SiteSetting.kofi_goal_types.split("|"))
+          .sum(:amount)
+
+      goal[:progress] = (total / SiteSetting.kofi_goal_amount * 100).floor
+
+      PluginStore.set(PLUGIN_NAME, :goal, goal)
+      goal
+    end
+
     def self.calculate_summary
     end
   end

config/locales/server.en.yml

@@ -12,8 +12,12 @@ en:
     kofi_dashboard_anonymous_view: 'What details should be shown for unauthenticated users'
     kofi_dashboard_authenticated_view: 'What should be shown for authenticated users'
     kofi_leaderboard_count: 'Number of donators to show. 0 will disable the leaderboard'
-    kofi_leaderboard_days: 'Number of days to consider for the leaderboard. -1 means since ever'
+    kofi_leaderboard_days: 'Number of days to consider for the leaderboard. -1 means since ever. 0 will disable the leaderboard'
     kofi_leaderboard_types: 'Which payment types to consider for the leaderboard'
+    kofi_goal_amount: 'Goal of payment per period work toward to. 0 disables the goal'
+    kofi_goal_period: 'Period over which the goal should work against'
+    kofi_goal_show_amount: 'Show the target amount. Otherwise it will only show the percentage'
+    kofi_goal_types: 'Which types to consider counting toward the goal'
   kofi:
     payment_type:
       donation: Donation

config/settings.yml

@@ -21,7 +21,7 @@ discourse_kofi:
     type: boolean
     default: true
     client: true
-  kofi_dashboard_totals_types:
+  kofi_dashboard_summary_types:
     type: list
     default: donation|subscription
     client: false
@@ -32,9 +32,19 @@ discourse_kofi:
       - subscription
       - commission
       - shop_order
-  kofi_dashboard_totals_days:
-    default: 365
+  kofi_dashboard_summary_periods:
+    type: list
+    default: 'all time'
     client: false
+    allow_any: false
+    list_type: compact
+    choices:
+      - last 7 days
+      - last month
+      - last year
+      - all time
+      - current month
+      - current year
   kofi_dashboard_count:
     default: 50
     client: true
@@ -55,20 +65,45 @@ discourse_kofi:
       - amount
       - user
       - message
-      - include_unknown
+      - include_unknown_users
   kofi_dashboard_authenticated_view:
     type: list
-    default: user|message|include_unknown
+    default: user|message|include_unknown_users
     client: false
     allow_any: false
     list_type: compact
     choices: *visibility
+  kofi_goal_amount:
+    default: 0
+    client: false
+  kofi_goal_period:
+    default: monthly
+    type: enum
+    choices:
+      - monthly
+      - yearly
+      #- since
+  #kofi_goal_since:
+  #  default: ''
+  #  type: datetime
+  kofi_goal_show_amount:
+    default: false
+    client: false
+  kofi_goal_types:
+    type: list
+    default: donation|subscription
+    client: false
+    allow_any: false
+    list_type: compact
+    choices: *payment_types
   kofi_leaderboard_count:
     default: 10
     client: true
+    min: 0
   kofi_leaderboard_days:
     default: 90
     client: true
+    min: -1
   kofi_leaderboard_types:
     type: list
     default: donation|subscription|commission|shop_order

spec/services/payment_stats_spec.rb

@@ -76,6 +76,61 @@
           { name: "number4" }
         ]
       )
+
+      stored_leaderboard =
+        PluginStore
+          .get(DiscourseKofi::PLUGIN_NAME, :leaderboard)
+          .map { |e| e.symbolize_keys }
+      expect(stored_leaderboard).to eq(leaderboard)
+    end
+  end
+
+  describe "goal" do
+    before(:example) do
+      SiteSetting.kofi_goal_amount = 100
+      Fabricate(:kofi_payment, amount: 10)
+      Fabricate(:kofi_payment, amount: 10, timestamp: DateTime.now - 2.months)
+      Fabricate(:kofi_subscription, amount: 50)
+
+      Fabricate(:kofi_payment, amount: 1000, type: "Commission")
+      Fabricate(:kofi_payment, amount: 1000, timestamp: DateTime.now - 2.years)
+    end
+
+    it "does not calculate a goal when target is 0" do
+      SiteSetting.kofi_goal_amount = 0
+      goal = described_class.calculate_goal
+      expect(goal[:progress]).to eq(0)
+      expect(goal[:target]).to be_nil
+    end
+
+    it "calculates a monthly goal" do
+      goal = described_class.calculate_goal
+      expect(goal[:progress]).to eq(60)
+      expect(goal[:target]).to be_nil
+    end
+
+    it "calculates a yearly goal" do
+      SiteSetting.kofi_goal_period = "yearly"
+      goal = described_class.calculate_goal
+      expect(goal[:progress]).to eq(70)
+      expect(goal[:target]).to be_nil
+    end
+
+    it "target is returned when enabled" do
+      SiteSetting.kofi_goal_show_amount = true
+      goal = described_class.calculate_goal
+      expect(goal[:progress]).to eq(60)
+      expect(goal[:target]).to eq(100)
+
+      stored_goal =
+        PluginStore.get(DiscourseKofi::PLUGIN_NAME, :goal).symbolize_keys
+      expect(stored_goal).to eq(goal)
+    end
+
+    it "progress can go over 100%" do
+      SiteSetting.kofi_goal_amount = 50
+      goal = described_class.calculate_goal
+      expect(goal[:progress]).to eq(120)
     end
   end
 end