Adapt gamification to profile categorization

* Add point type and point categorization * Adapt point rules for new models * Adapt existing tests * Create a seeds file

Adapt gamification to profile categorization
* Add point type and point categorization * Adapt point rules for new models * Adapt existing tests * Create a seeds file
Hugo Melo
1 parent 09d49988
Showing 15 changed files with 157 additions and 69 deletions Show diff stats
db/migrate/20150924010919_create_gamification_plugin_points_types.rb
db/migrate/20150924011409_create_gamification_plugin_points_categorizations.rb
db/seeds.rb
lib/ext/person.rb
lib/merit/point_rules.rb
models/gamification_plugin/points_categorization.rb
models/gamification_plugin/points_type.rb
test/test_helper.rb
test/unit/article_test.rb
test/unit/comment_test.rb
test/unit/gamification_plugin_points_categorizations_test.rb
test/unit/gamification_plugin_points_types_test.rb
test/unit/person_test.rb
test/unit/point_rules_test.rb
test/unit/profile_test.rb
@@ -0,0 +1,10 @@
+class CreateGamificationPluginPointsTypes < ActiveRecord::Migration
+  def change
+    create_table :gamification_plugin_points_types do |t|
+      t.string :name
+      t.text :description
+
+      t.timestamps
+    end
+  end
+end
@@ -0,0 +1,13 @@
+class CreateGamificationPluginPointsCategorizations < ActiveRecord::Migration
+  def change
+    create_table :gamification_plugin_points_categorizations do |t|
+      t.references :profile
+      t.integer :point_type_id
+      t.integer :weight
+
+      t.timestamps
+    end
+    add_index :gamification_plugin_points_categorizations, :profile_id
+    add_index :gamification_plugin_points_categorizations, :point_type_id, name: 'index_points_categorizations_on_point_type_id'
+  end
+end
@@ -0,0 +1,5 @@
+unless GamificationPlugin::PointsType.count
+  Merit::PointRules::AVAILABLE_RULES.each do |name , setting|
+    GamificationPlugin::PointsType.create! name: name.to_s, description: setting[:description]
+  end
+end
@@ -9,6 +9,7 @@ class Person
     self.points(category: 'profile_completion') == 0 and self.is_profile_complete?
   end
   def is_profile_complete?
-    true
+    # FIXME: FIND OUT A WAY TO CHECK EVERY REGISTRY FIELD
+    false
   end
 end
@@ -9,7 +9,8 @@ module Merit
         to: :author,
         value: 1,
         description: _('Comment author'),
-        default_weight: 150
+        default_weight: 150,
+        condition: lambda {|comment, profile| comment.source.profile == profile},
       },
       comment_article_author: {
         action: 'comment#create',
@@ -17,7 +18,8 @@ module Merit
         to: lambda {|comment| comment.source.author},
         value: 1,
         description: _('Article author of a comment'),
-        default_weight: 50
+        default_weight: 50,
+        condition: lambda {|comment, profile| comment.source.profile == profile},
       },
       comment_article: {
         action: 'comment#create',
@@ -25,7 +27,8 @@ module Merit
         to: lambda {|comment| comment.source},
         value: 1,
         description: _('Source article of a comment'),
-        default_weight: 50
+        default_weight: 50,
+        condition: lambda {|comment, profile| comment.source.profile == profile},
       },
       comment_community: {
         action: 'comment#create',
@@ -34,7 +37,7 @@ module Merit
         value: 1,
         description: _('Article community of a comment'),
         default_weight: 50,
-        condition: lambda {|target| target.profile.community? }
+        condition: lambda {|comment, profile| comment.profile.community? and comment.profile == profile }
       },
       article_author: {
         action: 'article#create',
@@ -42,7 +45,8 @@ module Merit
         to: :author,
         value: 1,
         description: _('Article author'),
-        default_weight: 500
+        default_weight: 500,
+        condition: lambda {|article, profile| article.profile == profile},
       },
       article_community: {
         action: 'article#create',
@@ -51,7 +55,7 @@ module Merit
         value: 1,
         description: _('Article community'),
         default_weight: 600,
-        condition: lambda {|target| target.profile.community? }
+        condition: lambda {|article, profile| article.profile.community? and article.profile == profile }
       },
       vote_voteable_author: {
         action: 'vote#create',
@@ -61,6 +65,7 @@ module Merit
         value: lambda {|vote| vote.vote},
         description: _('Author of a voted content'),
         default_weight: 50,
+        condition: lambda {|vote, profile| vote.voteable.profile == profile }
       },
       vote_voteable: {
         action: 'vote#create',
@@ -69,7 +74,8 @@ module Merit
         profile: lambda {|vote| vote.voteable.profile},
         value: lambda {|vote| vote.vote},
         description: _('Voted content'),
-        default_weight: 50
+        default_weight: 50,
+        condition: lambda {|vote, profile| vote.voteable.profile == profile }
       },
       vote_voter: {
         action: 'vote#create',
@@ -77,7 +83,9 @@ module Merit
         to: lambda {|vote| vote.voter},
         value: lambda {|vote| 1},
         description: _('Voter'),
-        default_weight: 10
+        default_weight: 10,
+        condition: lambda {|vote, profile| vote.voteable.profile == profile }
+
       },
       friends: {
         action: 'friendship#create',
@@ -85,7 +93,8 @@ module Merit
         to: lambda {|friendship| friendship.person},
         value: 1,
         description: _('Friends'),
-        default_weight: 5
+        default_weight: 5,
+        profile_action: false
       },
       profile_completion: {
         action: ['account#create', 'account#update'],
@@ -93,35 +102,42 @@ module Merit
         to: lambda {|user| user.person},
         value: 1,
         description: _('Profile Completion'),
-        default_weight: 5,
+        default_weight: 100,
         model_name: "User",
-        condition: lambda {|user| user.person.profile_completion_score_condition }
+        condition: lambda {|user| user.person.profile_completion_score_condition },
+        profile_action: false
       }
     }
-    def weight(category)
-      settings = Noosfero::Plugin::Settings.new(@environment, GamificationPlugin)
-      settings.settings.fetch(:point_rules, {}).fetch(category.to_s, {}).fetch('weight', AVAILABLE_RULES[category][:default_weight]).to_i
-    end
-
-    def calculate_score(target, category, value)
+    def calculate_score(target, weight, value)
       value = value.call(target) if value.respond_to?(:call)
-      weight(category) * value
+      weight * value
     end
-    def condition(setting, target)
+    def condition(setting, target, profile)
       condition = setting[:condition]
-      condition.present? ? condition.call(target) : true
+      if condition.present?
+        if setting.fetch(:profile_action, true)
+          condition.call(target, profile)
+        else
+          condition.call(target)
+        end
+      else
+        true
+      end
     end
     def initialize(environment=nil)
-      return if environment.nil?
+      #return if environment.nil?
       @environment = environment
+      @environment = Environment.default if environment.nil?
-      AVAILABLE_RULES.each do |category, setting|
-        [setting[:action], setting[:undo_action]].compact.zip([1, -1]).each do |action, signal|
-          score lambda {|target| signal * calculate_score(target, category, setting[:value])}, on: action, to: setting[:to], category: category do |target|
-            condition(setting, target)
+      AVAILABLE_RULES.each do |point_type, setting|
+        GamificationPlugin::PointsCategorization.by_type(point_type).includes(:profile).each do |categorization|
+          [setting[:action], setting[:undo_action]].compact.zip([1, -1]).each do |action, signal|
+            score lambda {|target| signal * calculate_score(target, categorization.weight, setting[:value])}, on: action, to: setting[:to], category: categorization.id.to_s do |target|
+              condition(setting, target, categorization.profile)
+            end
           end
         end
       end
@@ -0,0 +1,10 @@
+class GamificationPlugin::PointsCategorization < Noosfero::Plugin::ActiveRecord
+  belongs_to :profile
+  belongs_to :point_type, class_name: 'GamificationPlugin::PointsType', foreign_key: :point_type_id, dependent: :destroy
+  attr_accessible :profile_id, :profile, :point_type_id, :weight
+
+  validates_presence_of :point_type_id, :weight
+
+  scope :by_type, lambda { |p_type| joins(:point_type).where(gamification_plugin_points_types: {name: p_type}) }
+  scope :by_profile, lambda { |p_profile| joins(:profile).where(profiles: {identifier: p_profile}) }
+end
@@ -0,0 +1,5 @@
+class GamificationPlugin::PointsType < Noosfero::Plugin::ActiveRecord
+  attr_accessible :description, :name
+
+  validates_presence_of :name
+end
 require_relative "../../../test/test_helper"
+
+def create_merit_categorization
+  c = fast_create(Community)
+  Merit::PointRules::AVAILABLE_RULES.each do |name, setting|
+    point_type = GamificationPlugin::PointsType.find_by_name name
+    point_type = GamificationPlugin::PointsType.create name: name, description: setting['description'] if point_type.nil?
+    profile = setting.fetch(:profile_action, true) ? c : nil
+    GamificationPlugin::PointsCategorization.create! point_type_id: point_type.id, profile: profile, weight: setting[:default_weight]
+  end
+  c
+end#
@@ -5,19 +5,20 @@ class ArticleTest &lt; ActiveSupport::TestCase
   def setup
     @person = create_user('testuser').person
     @environment = Environment.default
+    @community = create_merit_categorization
     GamificationPlugin.gamification_set_rules(@environment)
   end
-  attr_accessor :person, :environment
+  attr_accessor :person, :environment, :community
   should 'add merit points to author when create a new article' do
-    create(TextArticle, :profile_id => person.id, :author => person)
+    create(TextArticle, :profile_id => community.id, :author => person)
     assert_equal 1, person.score_points.count
     assert person.score_points.first.action.present?
   end
   should 'subtract merit points to author when destroy an article' do
-    article = create(TextArticle, :profile_id => person.id, :author => person)
+    article = create(TextArticle, :profile_id => @community.id, :author => person)
     assert_equal 1, person.score_points.count
     article.destroy
     assert_equal 2, person.score_points.count
@@ -43,42 +44,45 @@ class ArticleTest &lt; ActiveSupport::TestCase
     assert_equal [1, 2], person.badges.map(&:level)
   end
-  should 'add merit points to article owner when an user like it' do
-    article = create(TextArticle, :name => 'Test', :profile => person, :author => person)
+  should 'add merit points to community article owner when an user like it' do
+    article = create(TextArticle, :name => 'Test', :profile => @community, :author => person)
-    assert_difference 'article.author.points(:category => :vote_voteable_author)', 50 do
+    c = GamificationPlugin::PointsCategorization.by_type(:vote_voteable_author).where(profile_id: @community.id).first
+    assert_difference 'article.author.points(:category => c.id.to_s)', c.weight do
       Vote.create!(:voter => person, :voteable => article, :vote => 1)
     end
   end
   should 'add merit points to article when an user like it' do
-    article = create(TextArticle, :name => 'Test', :profile => person, :author => person)
+    article = create(TextArticle, :name => 'Test', :profile => @community, :author => person)
     article = article.reload
-    assert_difference 'article.points(:category => :vote_voteable)', 50 do
+    c = GamificationPlugin::PointsCategorization.by_type(:vote_voteable).where(profile_id: @community.id).first
+    assert_difference 'article.points(:category => c.id.to_s)', c.weight do
       Vote.create!(:voter => person, :voteable => article, :vote => 1)
     end
   end
   should 'add merit points to community when create a new article' do
-    community = fast_create(Community)
     assert_difference 'community.score_points.count' do
-      create(TextArticle, :profile_id => community.id, :author => person)
+      create(TextArticle, :profile_id => @community.id, :author => person)
     end
   end
   should 'add merit points to voter when he likes an article' do
-    article = create(TextArticle, :name => 'Test', :profile => person, :author => person)
+    article = create(TextArticle, :name => 'Test', :profile => @community, :author => person)
-    assert_difference 'article.author.points(:category => :vote_voter)', 10 do
+    c = GamificationPlugin::PointsCategorization.by_type(:vote_voter).where(profile_id: @community.id).first
+    assert_difference 'article.author.points(:category => c.id.to_s)', c.weight do
       Vote.create!(:voter => person, :voteable => article, :vote => 1)
     end
   end
   should 'add merit points to voter when he dislikes an article' do
-    article = create(TextArticle, :name => 'Test', :profile => person, :author => person)
+    article = create(TextArticle, :name => 'Test', :profile => @community, :author => person)
-    assert_difference 'article.author.points(:category => :vote_voter)', 10 do
+    c = GamificationPlugin::PointsCategorization.by_type(:vote_voter).where(profile_id: @community.id).first
+    assert_difference 'article.author.points(:category => c.id.to_s)', c.weight do
       Vote.create!(:voter => person, :voteable => article, :vote => -1)
     end
   end
@@ -5,11 +5,12 @@ class CommentTest &lt; ActiveSupport::TestCase
   def setup
     @person = create_user('testuser').person
     @author = create_user('testauthoruser').person
-    @article = create(TextileArticle, :profile_id => person.id, :author_id => @author.id)
+    @community = create_merit_categorization
+    @article = create(TextileArticle, :profile_id => @community.id, :author_id => @author.id)
     @environment = Environment.default
     GamificationPlugin.gamification_set_rules(@environment)
   end
-  attr_accessor :person, :article, :environment, :author
+  attr_accessor :person, :article, :environment, :author, :community
   should 'add merit points to author when create a new comment' do
     create(Comment, :source => article, :author_id => person.id)
@@ -67,7 +68,8 @@ class CommentTest &lt; ActiveSupport::TestCase
   should 'add merit points to comment owner when an user like his comment' do
     comment = create(Comment, :source => article, :author_id => person.id)
-    assert_difference 'comment.author.points(:category => :vote_voteable_author)', 50 do
+    c = GamificationPlugin::PointsCategorization.by_type(:vote_voteable_author).where(profile_id: article.profile.id).first
+    assert_difference 'comment.author.points(:category => c.id.to_s)', c.weight do
       Vote.create!(:voter => person, :voteable => comment, :vote => 1)
     end
   end
@@ -84,7 +86,8 @@ class CommentTest &lt; ActiveSupport::TestCase
   should 'subtract merit points from comment owner when an user dislike his comment' do
     comment = create(Comment, :source => article, :author_id => person.id)
-    assert_difference 'comment.author.points(:category => :vote_voteable_author)', -50 do
+    c = GamificationPlugin::PointsCategorization.by_type(:vote_voteable_author).where(profile_id: article.profile.id).first
+    assert_difference 'comment.author.points(:category => c.id.to_s)', -1*c.weight do
       Vote.create!(:voter => person, :voteable => comment, :vote => -1)
     end
   end
@@ -107,7 +110,8 @@ class CommentTest &lt; ActiveSupport::TestCase
   should 'add merit points to voter when he likes a comment' do
     comment = create(Comment, :source => article, :author_id => person.id)
-    assert_difference 'comment.author.points(:category => :vote_voter)', 10 do
+    c = GamificationPlugin::PointsCategorization.by_type(:vote_voter).where(profile_id: community.id).first
+    assert_difference 'comment.author.points(:category => c.id.to_s)', c.weight do
       Vote.create!(:voter => person, :voteable => comment, :vote => 1)
     end
   end
@@ -115,21 +119,24 @@ class CommentTest &lt; ActiveSupport::TestCase
   should 'add merit points to voter when he dislikes a comment' do
     comment = create(Comment, :source => article, :author_id => person.id)
-    assert_difference 'comment.author.points(:category => :vote_voter)', 10 do
+    c = GamificationPlugin::PointsCategorization.by_type(:vote_voter).where(profile_id: community.id).first
+    assert_difference 'comment.author.points(:category => c.id.to_s)', c.weight do
       Vote.create!(:voter => person, :voteable => comment, :vote => -1)
     end
   end
   should 'add merit points to source article when create a comment' do
-    assert_difference 'article.points(:category => :comment_article)', 50 do
+    c = GamificationPlugin::PointsCategorization.by_type(:comment_article).where(profile_id: community.id).first
+    assert_difference 'article.points(:category => c.id.to_s)', c.weight do
       create(Comment, :source => article, :author_id => person.id)
     end
   end
   should 'add merit points to source community when create a comment' do
-    community = fast_create(Community)
-    article = create(TextileArticle, :profile_id => community.id, :author_id => @author.id)
-    assert_difference 'community.points(:category => :comment_community)', 50 do
+    article = create(TextileArticle, :profile_id => community.id, :author_id => author.id)
+
+    c = GamificationPlugin::PointsCategorization.by_type(:comment_community).where(profile_id: community.id).first
+    assert_difference 'community.points(:category => c.id.to_s)', c.weight do
       create(Comment, :source => article, :author_id => person.id)
     end
   end
@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class GamificationPluginPointsCategorizationsTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class GamificationPluginPointsTypesTest < ActiveSupport::TestCase
+  # test "the truth" do
+  #   assert true
+  # end
+end
@@ -4,6 +4,7 @@ class PersonTest &lt; ActiveSupport::TestCase
   def setup
     @environment = Environment.default
+    create_merit_categorization
     GamificationPlugin.gamification_set_rules(@environment)
     @person = create_user('testuser').person
   end
@@ -30,7 +31,8 @@ class PersonTest &lt; ActiveSupport::TestCase
   should 'add points when add someone as a friendly' do
     other_person = create_user("testuserfriend").person
     person.add_friend(other_person)
-    assert_equal 5, person.score_points(:category => :friends).sum(:num_points)
+    c = GamificationPlugin::PointsCategorization.by_type(:friends).first
+    assert_equal 5, person.score_points(:category => c.id.to_s).sum(:num_points)
   end
 end
@@ -4,31 +4,19 @@ class PointRulesTest &lt; ActiveSupport::TestCase
   def setup
     @environment = Environment.default
+    create_merit_categorization
     @point_rules = Merit::PointRules.new(@environment)
   end
   attr_accessor :environment, :point_rules
-  should 'not define rules when environment is nil' do
-    point_rules = Merit::PointRules.new
-    assert point_rules.defined_rules.blank?
-  end
+  #should 'not define rules when environment is nil' do
+    #point_rules = Merit::PointRules.new
+    #assert point_rules.defined_rules.blank?
+  #end
   should 'define rules when environment is present' do
     assert point_rules.defined_rules.present?
   end
-  should 'weight returns the default value when value is not setted in environment' do
-    Merit::PointRules::AVAILABLE_RULES.each do |category, setting|
-      assert_equal setting[:default_weight], point_rules.weight(category)
-    end
-  end
-
-  should 'weight returns value from environment when it is setted' do
-    settings = Noosfero::Plugin::Settings.new(environment, GamificationPlugin, {})
-    settings.set_setting(:point_rules, {'comment_author' => {'weight' => '500'}})
-    settings.save!
-    assert_equal 500, point_rules.weight(:comment_author)
-  end
-
 end
@@ -45,10 +45,12 @@ class ProfileTest &lt; ActiveSupport::TestCase
   end
   should 'update profile level when the score changes' do
+    community = create_merit_categorization
     GamificationPlugin.gamification_set_rules(environment)
+
     person = create_user('testuser').person
     assert_equal 0, person.level
-    create(TextArticle, :profile_id => profile.id, :author => person)
+    create(TextArticle, :profile_id => community.id, :author => person)
     assert_equal 3, person.reload.level
   end
@@ -0,0 +1,10 @@		@@ -0,0 +1,10 @@
	1	+class CreateGamificationPluginPointsTypes < ActiveRecord::Migration
	2	+ def change
	3	+ create_table :gamification_plugin_points_types do \|t\|
	4	+ t.string :name
	5	+ t.text :description
	6	+
	7	+ t.timestamps
	8	+ end
	9	+ end
	10	+end
@@ -0,0 +1,13 @@		@@ -0,0 +1,13 @@
	1	+class CreateGamificationPluginPointsCategorizations < ActiveRecord::Migration
	2	+ def change
	3	+ create_table :gamification_plugin_points_categorizations do \|t\|
	4	+ t.references :profile
	5	+ t.integer :point_type_id
	6	+ t.integer :weight
	7	+
	8	+ t.timestamps
	9	+ end
	10	+ add_index :gamification_plugin_points_categorizations, :profile_id
	11	+ add_index :gamification_plugin_points_categorizations, :point_type_id, name: 'index_points_categorizations_on_point_type_id'
	12	+ end
	13	+end
@@ -0,0 +1,5 @@		@@ -0,0 +1,5 @@
	1	+unless GamificationPlugin::PointsType.count
	2	+ Merit::PointRules::AVAILABLE_RULES.each do \|name , setting\|
	3	+ GamificationPlugin::PointsType.create! name: name.to_s, description: setting[:description]
	4	+ end
	5	+end
@@ -0,0 +1,10 @@		@@ -0,0 +1,10 @@
	1	+class GamificationPlugin::PointsCategorization < Noosfero::Plugin::ActiveRecord
	2	+ belongs_to :profile
	3	+ belongs_to :point_type, class_name: 'GamificationPlugin::PointsType', foreign_key: :point_type_id, dependent: :destroy
	4	+ attr_accessible :profile_id, :profile, :point_type_id, :weight
	5	+
	6	+ validates_presence_of :point_type_id, :weight
	7	+
	8	+ scope :by_type, lambda { \|p_type\| joins(:point_type).where(gamification_plugin_points_types: {name: p_type}) }
	9	+ scope :by_profile, lambda { \|p_profile\| joins(:profile).where(profiles: {identifier: p_profile}) }
	10	+end
@@ -0,0 +1,5 @@		@@ -0,0 +1,5 @@
	1	+class GamificationPlugin::PointsType < Noosfero::Plugin::ActiveRecord
	2	+ attr_accessible :description, :name
	3	+
	4	+ validates_presence_of :name
	5	+end
1	require_relative "../../../test/test_helper"	1	require_relative "../../../test/test_helper"
		2	+
		3	+def create_merit_categorization
		4	+ c = fast_create(Community)
		5	+ Merit::PointRules::AVAILABLE_RULES.each do \|name, setting\|
		6	+ point_type = GamificationPlugin::PointsType.find_by_name name
		7	+ point_type = GamificationPlugin::PointsType.create name: name, description: setting['description'] if point_type.nil?
		8	+ profile = setting.fetch(:profile_action, true) ? c : nil
		9	+ GamificationPlugin::PointsCategorization.create! point_type_id: point_type.id, profile: profile, weight: setting[:default_weight]
		10	+ end
		11	+ c
		12	+end#
@@ -0,0 +1,7 @@		@@ -0,0 +1,7 @@
	1	+require 'test_helper'
	2	+
	3	+class GamificationPluginPointsCategorizationsTest < ActiveSupport::TestCase
	4	+ # test "the truth" do
	5	+ # assert true
	6	+ # end
	7	+end