gamification 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff0f5c1e1337b6cf63206c829cc642f095b94621
-  data.tar.gz: c264313d9ed05c33287888e0e9e81ebc99ba4f58
+  metadata.gz: e19cbb64dd5e16388ffd8fd52c48622bc621569b
+  data.tar.gz: 07ebce2bd2b9751f6e21cd0dc6c5e59c5da9d33b
 SHA512:
-  metadata.gz: fb23fabcb4db26e71e7001fb6f2c0e65c8fe2ebd2df47f0acf7b02c624a7b2ea9b3df665672094d1dc8e6b43e733fbd61221e13b07265dff1730d75a2313b6e3
-  data.tar.gz: a344fdd6a6534e4065eaf6794d8e520bbf8ff9db4fd6e757f27a2834eb254928ac5b4b91b16f6516cd4798d6370f10870843575e2c668c0bebf60b62c07c160f
+  metadata.gz: 883c53868ccb30f0eced71df269ca966cd27d19f05e30cae810cd6458eb577ed35e0c9858992e21d4ab2f992e37991ab50979835bfccb1a66dcdbbf32021f65a
+  data.tar.gz: 1a34ab955a1a55eae840c0f2d5546f81cc2a7ee8605970b456642b73a6fcf309386c4322d493e49d4a40844ca117e9064ffaa8772de50817fae183b93159a97f

data/app/controllers/gamification/application_controller.rb

@@ -1,4 +1,4 @@
 module Gamification
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ApplicationController
   end
 end

data/app/controllers/gamification/rewards_controller.rb

@@ -0,0 +1,46 @@
+require_dependency "gamification/application_controller"
+
+module Gamification
+  class RewardsController < ApplicationController
+    def create
+      if rewarding.is_a? ::Gamification::Goal
+        rewarding.complete_for rewardable
+      else
+        rewarding.goals.each do |goal|
+          goal.complete_for rewardable
+        end
+      end
+
+      respond_to do |format|
+        format.json { render json: {}, status: :created }
+        format.html { redirect_to redirect_url }
+      end
+    end
+
+    private
+
+    def redirect_url
+      params[:redirect_url] || request.env['HTTP_REFERER']
+    end
+
+    def rewarding
+      rewarding_model.find reward_params[:rewarding_id]
+    end
+
+    def rewardable
+      rewardable_model.find reward_params[:rewardable_id]
+    end
+
+    def rewarding_model
+      reward_params[:rewarding_type].constantize
+    end
+
+    def rewardable_model
+      reward_params[:rewardable_type].constantize
+    end
+
+    def reward_params
+      params.require(:reward).permit(:rewarding_type, :rewarding_id, :rewardable_type, :rewardable_id)
+    end
+  end
+end

data/app/helpers/gamification/application_helper.rb

@@ -1,4 +1,28 @@
 module Gamification
   module ApplicationHelper
+
+    # Create a form to reward someone for something.
+    #
+    # rewardable - A model that is rewardable (e.g. a user)
+    # options    - A Hash of options:
+    #              :for      - A model that is rewarding (e.g. an article)
+    #              :redirect - A String describing a URL to redirect to.
+    def reward rewardable, options
+      rewarding = options[:for]
+      redirect  = options[:redirect]
+
+      form_tag Gamification::Engine.routes.url_helpers.rewards_path, method: :post do
+        concat hidden_field_tag 'reward[rewarding_type]', rewarding.class.name
+        concat hidden_field_tag 'reward[rewarding_id]', rewarding.id
+        concat hidden_field_tag 'reward[rewardable_type]', rewardable.class.name
+        concat hidden_field_tag 'reward[rewardable_id]', rewardable.id
+
+        if redirect
+          concat hidden_field_tag 'redirect_url', redirect
+        end
+
+        concat submit_tag I18n.t 'gamification.complete'
+      end
+    end
   end
 end

data/app/helpers/gamification/rewards_helper.rb

@@ -0,0 +1,20 @@
+module Gamification
+  module RewardsHelper
+
+    # Present unseen rewards for the given user.
+    #
+    # options - A Hash of options:
+    #           for: A rewardable model.
+    #
+    # Returns HTML.
+    def present_rewards options
+      rewardable = options[:for]
+      rewards      = rewardable.rewards.unseen
+      presentation = render partial: 'gamification/rewards/presentation', locals: { rewards: rewards }
+
+      rewards.see
+
+      presentation
+    end
+  end
+end

data/app/models/gamification/goal.rb

@@ -0,0 +1,5 @@
+module Gamification
+  class Goal < ::ActiveRecord::Base
+    include Concerns::Models::Goal
+  end
+end

data/app/models/gamification/medal.rb

@@ -0,0 +1,5 @@
+module Gamification
+  class Medal < ::ActiveRecord::Base
+    include Concerns::Models::Medal
+  end
+end

data/app/models/gamification/reward.rb

@@ -0,0 +1,5 @@
+module Gamification
+  class Reward < ::ActiveRecord::Base
+    include Concerns::Models::Reward
+  end
+end

data/app/uploaders/gamification/image_uploader.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+require 'carrierwave'
+
+class Gamification::ImageUploader < CarrierWave::Uploader::Base
+
+  # Include MiniMagick support
+  include CarrierWave::MiniMagick
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.class.to_s.underscore}/#{mounted_as}/#{model.id}"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
+  #
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  # Process files as they are uploaded:
+  # process :scale => [200, 300]
+  #
+  # def scale(width, height)
+  #   # do something
+  # end
+
+  # Create different versions of your uploaded files:
+  version :small do
+    process :resize_to_fit => [150, 150]
+  end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  # def extension_white_list
+  #   %w(jpg jpeg gif png)
+  # end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+
+end

data/app/views/gamification/rewards/_presentation.html.erb

@@ -0,0 +1,7 @@
+<% if rewards.any? %>
+  <div class="reward-presentation">
+    <% rewards.each do |reward| %>
+      <%= render reward %>
+    <% end %>
+  </div>
+<% end %>

data/app/views/gamification/rewards/_reward.html.erb

@@ -0,0 +1,9 @@
+<% if reward.medal %>
+  <div class="medal">
+    <div class="image"><%= image_tag reward.medal.image %></div>
+    <div class="name"><%= reward.medal.name %></div>
+    <div class="description"><%= reward.medal.description %></div>
+  </div>
+<% end %>
+
+<div class="points"><%= reward.points %></div>

data/app/views/gamification/scorings/create.html.erb

@@ -0,0 +1,2 @@
+<h1>Scorings#create</h1>
+<p>Find me in app/views/gamification/scorings/create.html.erb</p>

data/config/initializers/routing.rb

@@ -0,0 +1,15 @@
+module Gamification
+  module ApplicationHelper
+
+    # Knowledge base uses the layout of the client application, which causes Rails' url helpers to get confused
+    # and require you to prepend 'main_app' to your own routes. This hack allows developers to keep referring to
+    # routes without a prefix by sending undefined routes to 'main_app' before failing.
+    def method_missing(method, *args, &block)
+      if (method.to_s.end_with?('_path') || method.to_s.end_with?('_url')) && main_app.respond_to?(method)
+        main_app.send(method, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  gamification:
+    complete: 'Complete goals'

data/config/locales/nb.yml

@@ -0,0 +1,35 @@
+nb:
+  activerecord:
+    models:
+      gamification/goal:
+        one: Mål
+        other: Mål
+      gamification/reward:
+        one: Belønning
+        other: Belønninger
+      gamification/medal:
+        one: Medalje
+        other: Medaljer
+    attributes:
+      common: &common
+        created_at: Opprettet
+        updated_at: Sist oppdatert
+      gamification/goal:
+        <<: *common
+        rewarding: Mål for
+        rewarding_id: Mål for
+        rewarding_type: Mål for
+        points: Poeng
+      gamification/reward:
+        <<: *common
+        goal: Mål
+        rewardable: Mottaker
+        rewardable_id: Motakker
+        rewardable_type: Mottaker
+        seen_at: Sett
+      gamification/medal:
+        <<: *common
+        goal: Mål
+        name: Navn
+        image: Bilde
+        description: Beskrivelse

data/config/routes.rb

@@ -1,2 +1,3 @@
 Gamification::Engine.routes.draw do
+  resources :rewards, only: [:create]
 end

data/db/migrate/20140310081749_rename_everything.rb

@@ -0,0 +1,10 @@
+class RenameEverything < ActiveRecord::Migration
+  def change
+    rename_table :gamification_scorings, :gamification_rewards
+    rename_column :gamification_rewards, :subjectable_id, :rewardable_id
+    rename_column :gamification_rewards, :subjectable_type, :rewardable_type
+
+    rename_column :gamification_tasks, :taskable_id, :rewarding_id
+    rename_column :gamification_tasks, :taskable_type, :rewarding_type
+  end
+end

data/db/migrate/20140313134259_create_gamification_medals.rb

@@ -0,0 +1,11 @@
+class CreateGamificationMedals < ActiveRecord::Migration
+  def change
+    create_table :gamification_medals do |t|
+      t.references :task, index: true
+      t.string :name
+      t.string :image
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140314132611_add_description_to_gamification_medals.rb

@@ -0,0 +1,5 @@
+class AddDescriptionToGamificationMedals < ActiveRecord::Migration
+  def change
+    add_column :gamification_medals, :description, :text
+  end
+end

data/db/migrate/20140315142524_rename_gamification_tasks_to_goals.rb

@@ -0,0 +1,7 @@
+class RenameGamificationTasksToGoals < ActiveRecord::Migration
+  def change
+    rename_table :gamification_tasks, :gamification_goals
+    rename_column :gamification_rewards, :task_id, :goal_id
+    rename_column :gamification_medals, :task_id, :goal_id
+  end
+end

data/db/migrate/20140318220723_add_seen_at_to_gamification_rewards.rb

@@ -0,0 +1,9 @@
+class AddSeenAtToGamificationRewards < ActiveRecord::Migration
+  def change
+    change_table :gamification_rewards do |t|
+      t.datetime :seen_at
+    end
+
+    add_index :gamification_rewards, :seen_at, name: 'index_gamification_rewards_on_seen_at'
+  end
+end

data/lib/gamification.rb

@@ -1,5 +1,6 @@
 require "gamification/engine"
 require "gamification/concerns"
+require "gamification/activerecord"
 
 module Gamification
 end

data/lib/gamification/activerecord.rb

@@ -0,0 +1,13 @@
+module Gamification::ActiveRecord
+  module Extensions
+    def rewarding
+      include Gamification::Concerns::Rewarding
+    end
+
+    def rewardable
+      include Gamification::Concerns::Rewardable
+    end
+  end
+end
+
+::ActiveRecord::Base.send :extend, Gamification::ActiveRecord::Extensions if defined?(ActiveRecord)

data/lib/gamification/concerns.rb

@@ -1,3 +1,5 @@
 module Gamification::Concerns
   require "gamification/concerns/models"
+  require "gamification/concerns/rewarding"
+  require "gamification/concerns/rewardable"
 end

data/lib/gamification/concerns/models.rb

@@ -1,4 +1,5 @@
 module Gamification::Concerns::Models
-  require "gamification/concerns/models/task"
-  require "gamification/concerns/models/scoring"
+  require "gamification/concerns/models/goal"
+  require "gamification/concerns/models/reward"
+  require "gamification/concerns/models/medal"
 end

data/lib/gamification/concerns/models/goal.rb

@@ -0,0 +1,44 @@
+module Gamification::Concerns::Models::Goal
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :rewarding, polymorphic: true
+    has_one :medal, dependent: :destroy
+    has_many :rewards, dependent: :destroy
+
+    accepts_nested_attributes_for :medal, allow_destroy: true, reject_if: :all_blank
+
+    # TODO: These should be SQL. But that's hard.
+    scope :completed_by,  ->(subject) { all.select { |goal| goal.completed_by? subject }}
+    scope :incomplete_by, ->(subject) { all.reject { |goal| goal.completed_by? subject }}
+
+    # Determine whether the given subject has completed the goal.
+    #
+    # subject - An ActiveRecord model that can receive rewards.
+    def completed_by? subject
+      !!reward_for(subject)
+    end
+
+    # Complete the goal for the given subject.
+    #
+    # subject - An ActiveRecord model that can receive rewards.
+    def complete_for subject
+      if completed_by? subject
+        raise Completed, "#{self} is already completed for #{subject}"
+      else
+        ::Gamification::Reward.create! goal: self, rewardable: subject
+      end
+    end
+
+    private
+
+    # Find the Reward for the given subject.
+    #
+    # subject - A rewardable model.
+    def reward_for rewardable
+      rewards.find_by rewardable: rewardable
+    end
+
+    class Completed < StandardError; end
+  end
+end

data/lib/gamification/concerns/models/medal.rb

@@ -0,0 +1,13 @@
+require 'carrierwave'
+
+module Gamification
+  module Concerns::Models::Medal
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :goal
+
+      mount_uploader :image, ::Gamification::ImageUploader
+    end
+  end
+end

data/lib/gamification/concerns/models/reward.rb

@@ -0,0 +1,33 @@
+module Gamification::Concerns::Models::Reward
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :goal, class_name: 'Gamification::Goal'
+    belongs_to :rewardable, polymorphic: true, inverse_of: :rewards
+
+    scope :unseen, -> { where seen_at: nil }
+    scope :seen, -> { where.not seen_at: nil }
+
+    scope :with_medals,    -> { all.select &:medal }
+    scope :without_medals, -> { all.reject &:medal }
+
+    validates :rewardable_id, uniqueness: { scope: [:rewardable_type, :goal] }
+
+    delegate :points, to: :goal
+    delegate :medal, to: :goal
+
+    def see
+      touch :seen_at
+    end
+
+    def seen?
+      !!seen_at
+    end
+
+    class << self
+      def see
+        all.map { |reward| reward.see }
+      end
+    end
+  end
+end