kudos 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88b2bc3c5627913f22f9bc36b10acfc596e4e576535ab447bc31ff30bad45443
+  data.tar.gz: afc5348c4da73d71993684035eefb0d89248e6ded717faca5f6e6739c65e1c8d
+SHA512:
+  metadata.gz: 34a55fcdfcb296a27b206e8c962053deef49b94b278e41cafc0b7e156d098224191aca358434828a931dc0aba187117f1ea75c209f6f9093886787c3fbfd09b0
+  data.tar.gz: a8e04bb860c279878d447191bc738a3ef12104645ab6d97602c9f2e558c57a5a7c04bf301c7940c5035e448d7316c20c57886059acad8571f5b2f918b71f2f94

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Bogdanov Anton
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,80 @@
+# Kudos
+Reputation engine for Rails application similar to World of Warcraft achievements system.
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+gem 'kudos'
+```
+
+And then for generating migration and models execute:
+```bash
+$ bundle install
+$ rails g kudos:active_record
+$ rails db:migrate
+```
+
+If you would like to attach achievements not to User model, run instead
+```bash
+$ rails g kudos:active_record ModelName
+```
+
+## Сonfiguration
+
+```ruby
+class User < ApplicationRecord
+  include Kudos::Achievementable
+  ...
+end
+```
+
+## Generating achievements
+
+### Achievements database records
+
+```ruby
+general_group = Kudos::AchievementGroup.create(name: { en: 'General' })
+
+Kudos::Achievement.create(
+  award_name: 'fantasy_team_create',
+  points: 5,
+  kudos_achievement_group: general_group
+)
+```
+
+### Describe award rules
+
+For one rank achievements conditions for awarding can be defined like
+```ruby
+class Achievement < Kudos::Achievement
+  award_for :fantasy_team_create do |achievements, user|
+    achievement = achievements.first
+    user.award(achievement: achievement) unless user.awarded?(achievement: achievement)
+  end
+end
+```
+
+For multi-rank achievements conditions for awarding can be defined like
+```ruby
+class Achievement < Kudos::Achievement
+  award_for :lineup_points do |achievements, lineup|
+    user = lineup.user
+    achievements.each do |achievement|
+      if !user.awarded?(achievement: achievement) && lineup.points >= (achievement.rank * 10)
+        user.award(achievement: achievement)
+      end
+    end
+  end
+end
+```
+
+## Usage
+
+For awarding user just call this code in callback or by any event generator
+```ruby
+Achievement.award(:fantasy_team_create, user)
+```
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/models/concerns/kudos/achievementable.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Kudos
+  module Achievementable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :kudos_users_achievements,
+               class_name: 'Kudos::Users::Achievement',
+               dependent: :destroy
+
+      has_many :kudos_achievements, through: :kudos_users_achievements
+    end
+
+    def award(achievement:)
+      object = kudos_users_achievements.find_or_initialize_by(kudos_achievement_id: achievement.id)
+      return if object.rank.to_i > achievement.rank.to_i
+
+      object.update!(
+        {
+          rank: achievement.rank,
+          points: object.points.to_i + achievement.points,
+          title: achievement.title,
+          description: achievement.description
+        }.compact
+      )
+    end
+
+    def awarded?(achievement:)
+      kudos_users_achievements.find_by({ kudos_achievement_id: achievement.id, rank: achievement.rank }.compact)
+    end
+  end
+end

data/app/models/concerns/kudos/uuidable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kudos
+  module Uuidable
+    extend ActiveSupport::Concern
+
+    included do
+      after_initialize :generate_uuid
+    end
+
+    def generate_uuid
+      self.uuid ||= SecureRandom.uuid
+    end
+  end
+end

data/app/models/kudos/achievement.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kudos
+  class Achievement < Kudos::ApplicationRecord
+    self.table_name = :kudos_achievements
+
+    include Kudos
+    include Kudos::Uuidable
+
+    belongs_to :kudos_achievement_group, class_name: 'Kudos::AchievementGroup'
+
+    has_many :kudos_users_achievements,
+             class_name: 'Kudos::Users::Achievement',
+             foreign_key: :kudos_achievement_id,
+             dependent: :destroy
+
+    has_many :users, through: :kudos_users_achievements
+  end
+end

data/app/models/kudos/achievement_group.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kudos
+  class AchievementGroup < ApplicationRecord
+    self.table_name = :kudos_achievement_groups
+
+    include Kudos::Uuidable
+
+    belongs_to :parent,
+               class_name: 'Kudos::AchievementGroup',
+               foreign_key: :parent_id,
+               inverse_of: :children,
+               optional: true
+
+    has_many :children,
+             class_name: 'Kudos::AchievementGroup',
+             foreign_key: :parent_id,
+             inverse_of: :parent,
+             dependent: :nullify
+
+    has_many :kudos_achievements,
+             class_name: 'Kudos::Achievement',
+             foreign_key: :kudos_achievement_group_id,
+             dependent: :destroy
+  end
+end

data/app/models/kudos/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Kudos
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/kudos/users/achievement.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kudos
+  module Users
+    class Achievement < ApplicationRecord
+      self.table_name = :kudos_users_achievements
+
+      belongs_to :user, class_name: '::User'
+      belongs_to :kudos_achievement, class_name: 'Kudos::Achievement'
+
+      scope :unread, -> { where(notified: false) }
+    end
+  end
+end

data/db/migrate/20221130175843_create_kudos_tables.rb

@@ -0,0 +1,43 @@
+class CreateKudosTables < ActiveRecord::Migration[7.0]
+  def self.up
+    enable_extension 'pgcrypto' unless extensions.include?('pgcrypto')
+    enable_extension 'uuid-ossp' unless extensions.include?('uuid-ossp')
+
+    create_table :kudos_achievement_groups do |t|
+      t.uuid :uuid, null: false, index: { unique: true }
+      t.bigint :parent_id, index: true
+      t.integer :position, null: false, default: 0
+      t.jsonb :name, null: false, default: {}
+      t.timestamps
+    end
+
+    create_table :kudos_achievements do |t|
+      t.uuid :uuid, null: false, index: { unique: true }
+      t.string :award_name, null: false, index: true
+      t.integer :rank
+      t.integer :points
+      t.jsonb :title, null: false, default: {}
+      t.jsonb :description, null: false, default: {}
+      t.references :kudos_achievement_group, null: false, index: true, foreign_key: true
+      t.timestamps
+    end
+
+    create_table :kudos_users_achievements do |t|
+      t.references :user, null: false, foreign_key: true
+      t.references :kudos_achievement, null: false, foreign_key: true
+      t.boolean :notified, null: false, default: false
+      t.integer :rank
+      t.integer :points
+      t.jsonb :title, null: false, default: {}
+      t.jsonb :description, null: false, default: {}
+      t.timestamps
+    end
+    add_index :kudos_users_achievements, [:user_id, :kudos_achievement_id], unique: true, name: 'kudos_users_achievements_unique_index'
+  end
+
+  def self.down
+    drop_table :kudos_achievement_groups
+    drop_table :kudos_achievements
+    drop_table :kudos_users_achievements
+  end
+end

data/lib/generators/kudos/active_record_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+
+module Kudos
+  module Generators
+    class ActiveRecordGenerator < ::Rails::Generators::Base
+      include ::Rails::Generators::Migration
+      desc 'Generates migration for kudos tables'
+
+      source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+      argument :name, type: :string, default: 'User'
+
+      def self.next_migration_number(dirname)
+        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+
+      def self.migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]" if requires_migration_number?
+      end
+
+      def self.requires_migration_number?
+        Rails::VERSION::MAJOR.to_i >= 6
+      end
+
+      def create_migration_file
+        @user_model_name = name.underscore
+
+        migration_template 'migration.erb', 'db/migrate/create_kudos_tables.rb'
+        template 'achievement_group.erb', 'app/models/kudos/achievement_group.rb'
+        template 'achievement.erb', 'app/models/kudos/achievement.rb'
+        template 'users_achievement.erb', 'app/models/kudos/users/achievement.rb'
+        template 'achievementable.erb', 'app/models/concerns/kudos/achievementable.rb'
+        template 'uuidable.erb', 'app/models/concerns/kudos/uuidable.rb'
+      end
+
+      def migration_version
+        self.class.migration_version
+      end
+    end
+  end
+end

data/lib/generators/kudos/templates/achievement.erb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Kudos
+  class Achievement < Kudos::ApplicationRecord
+    self.table_name = :kudos_achievements
+
+    include Kudos
+    include Kudos::Uuidable
+
+    belongs_to :kudos_achievement_group, class_name: 'Kudos::AchievementGroup'
+
+    has_many :kudos_<%= @user_model_name %>s_achievements,
+             class_name: 'Kudos::<%= @user_model_name.capitalize %>s::Achievement',
+             foreign_key: :kudos_achievement_id,
+             dependent: :destroy
+
+    has_many :<%= @user_model_name %>s, through: :kudos_<%= @user_model_name %>s_achievements
+  end
+end

data/lib/generators/kudos/templates/achievement_group.erb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Kudos
+  class AchievementGroup < ApplicationRecord
+    self.table_name = :kudos_achievement_groups
+
+    include Kudos::Uuidable
+
+    belongs_to :parent,
+               class_name: 'Kudos::AchievementGroup',
+               foreign_key: :parent_id,
+               inverse_of: :children,
+               optional: true
+
+    has_many :children,
+             class_name: 'Kudos::AchievementGroup',
+             foreign_key: :parent_id,
+             inverse_of: :parent,
+             dependent: :nullify
+
+    has_many :kudos_achievements,
+             class_name: 'Kudos::Achievement',
+             foreign_key: :kudos_achievement_group_id,
+             dependent: :destroy
+  end
+end

data/lib/generators/kudos/templates/achievementable.erb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Kudos
+  module Achievementable
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :kudos_<%= @user_model_name %>s_achievements,
+               class_name: 'Kudos::<%= @user_model_name.capitalize %>s::Achievement',
+               dependent: :destroy
+
+      has_many :kudos_achievements, through: :kudos_<%= @user_model_name %>s_achievements
+    end
+
+    def award(achievement:)
+      object = kudos_<%= @user_model_name %>s_achievements.find_or_initialize_by(kudos_achievement_id: achievement.id)
+      return if object.rank.to_i > achievement.rank.to_i
+
+      object.update!(
+        {
+          rank: achievement.rank,
+          points: object.points.to_i + achievement.points,
+          title: achievement.title,
+          description: achievement.description
+        }.compact
+      )
+    end
+
+    def awarded?(achievement:)
+      kudos_<%= @user_model_name %>s_achievements.find_by({ kudos_achievement_id: achievement.id, rank: achievement.rank }.compact)
+    end
+  end
+end

data/lib/generators/kudos/templates/migration.erb

@@ -0,0 +1,43 @@
+class CreateKudosTables < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    enable_extension 'pgcrypto' unless extensions.include?('pgcrypto')
+    enable_extension 'uuid-ossp' unless extensions.include?('uuid-ossp')
+
+    create_table :kudos_achievement_groups do |t|
+      t.uuid :uuid, null: false, index: { unique: true }
+      t.bigint :parent_id, index: true
+      t.integer :position, null: false, default: 0
+      t.jsonb :name, null: false, default: {}
+      t.timestamps
+    end
+
+    create_table :kudos_achievements do |t|
+      t.uuid :uuid, null: false, index: { unique: true }
+      t.string :award_name, null: false, index: true
+      t.integer :rank
+      t.integer :points
+      t.jsonb :title, null: false, default: {}
+      t.jsonb :description, null: false, default: {}
+      t.references :kudos_achievement_group, null: false, index: true, foreign_key: true
+      t.timestamps
+    end
+
+    create_table :kudos_<%= @user_model_name %>s_achievements do |t|
+      t.references :<%= @user_model_name %>, null: false, foreign_key: true
+      t.references :kudos_achievement, null: false, foreign_key: true
+      t.boolean :notified, null: false, default: false
+      t.integer :rank
+      t.integer :points
+      t.jsonb :title, null: false, default: {}
+      t.jsonb :description, null: false, default: {}
+      t.timestamps
+    end
+    add_index :kudos_users_achievements, [:<%= @user_model_name %>_id, :kudos_achievement_id], unique: true, name: 'kudos_users_achievements_unique_index'
+  end
+
+  def self.down
+    drop_table :kudos_achievement_groups
+    drop_table :kudos_achievements
+    drop_table :kudos_users_achievements
+  end
+end

data/lib/generators/kudos/templates/users_achievement.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Kudos
+  module <%= @user_model_name.capitalize %>s
+    class Achievement < ApplicationRecord
+      self.table_name = :kudos_<%= @user_model_name %>s_achievements
+
+      belongs_to :<%= @user_model_name %>, class_name: '::<%= @user_model_name.capitalize %>'
+      belongs_to :kudos_achievement, class_name: 'Kudos::Achievement'
+
+      scope :unread, -> { where(notified: false) }
+    end
+  end
+end

data/lib/generators/kudos/templates/uuidable.erb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kudos
+  module Uuidable
+    extend ActiveSupport::Concern
+
+    included do
+      after_initialize :generate_uuid
+    end
+
+    def generate_uuid
+      self.uuid ||= SecureRandom.uuid
+    end
+  end
+end

data/lib/kudos/engine.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Kudos
+  class Engine < ::Rails::Engine
+    isolate_namespace Kudos
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+  end
+end

data/lib/kudos/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Kudos
+  VERSION = '0.1.0'
+end

data/lib/kudos.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'kudos/version'
+require 'kudos/engine'
+
+module Kudos
+  def self.included(base)
+    base.class_eval do
+      extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def awards
+      @awards ||= {}
+    end
+
+    def award_for(award_name, &block)
+      awards[award_name] = block
+    end
+
+    def award(award_name, *attributes)
+      achievements = Kudos::Achievement.where(award_name: award_name).order(rank: :asc)
+      awards[award_name].call(achievements, *attributes)
+    end
+  end
+end

data/lib/tasks/kudos_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :kudos do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: kudos
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bogdanov Anton
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.39'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Achievements engine for Rails application similar to World of Warcraft
+  achievements system.
+email:
+- kortirso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/concerns/kudos/achievementable.rb
+- app/models/concerns/kudos/uuidable.rb
+- app/models/kudos/achievement.rb
+- app/models/kudos/achievement_group.rb
+- app/models/kudos/application_record.rb
+- app/models/kudos/users/achievement.rb
+- db/migrate/20221130175843_create_kudos_tables.rb
+- lib/generators/kudos/active_record_generator.rb
+- lib/generators/kudos/templates/achievement.erb
+- lib/generators/kudos/templates/achievement_group.erb
+- lib/generators/kudos/templates/achievementable.erb
+- lib/generators/kudos/templates/migration.erb
+- lib/generators/kudos/templates/users_achievement.erb
+- lib/generators/kudos/templates/uuidable.erb
+- lib/kudos.rb
+- lib/kudos/engine.rb
+- lib/kudos/version.rb
+- lib/tasks/kudos_tasks.rake
+homepage: https://github.com/kortirso/kudos
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kortirso/kudos
+  source_code_uri: https://github.com/kortirso/kudos
+  changelog_uri: https://github.com/kortirso/kudos/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Achievements engine for Rails application
+test_files: []