adhonorem 1.0.0

data/spec/models/badge_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+require 'rails_helper'
+require_relative '../helpers/badge_instantiator'
+
+RSpec.describe AdHonorem::Badge do
+  it 'inherits StaticRecord::Base' do
+    expect(AdHonorem::Badge.where(name: 'Normal badge').first).to be_a(NormalBadge)
+  end
+
+  context 'without user context' do
+    it 'requires a context User to be set' do
+      badge = AdHonorem::Badge.find('normal_badge')
+      expect { badge.progress }.to raise_error(AdHonorem::NoContext)
+      expect { badge.complete? }.to raise_error(AdHonorem::NoContext)
+      expect { badge.trigger(:visit_paris) }.to raise_error(AdHonorem::NoContext)
+    end
+  end
+
+  context 'with user context' do
+    before(:each) do
+      instantiate_badges
+    end
+
+    it 'works with user set' do
+      expect { @normal_badge.progress }.not_to raise_error
+    end
+
+    it 'allows to check badge completion' do
+      expect(@normal_badge.complete?).to be false
+    end
+
+    it 'allows to check specific objective completion' do
+      @two_objectives_badge.trigger(:use_longbow)
+      expect(@two_objectives_badge.complete?(:use_longbow)).to be true
+    end
+
+    it 'allows to check specific objective completion' do
+      @two_objectives_badge.trigger(:use_longbow)
+      expect(@two_objectives_badge.complete?(:use_longbow)).to be true
+    end
+  end
+
+  context 'when dispatching an event' do
+    it 'triggers checkers that hooked to dispatched event' do
+      user = User.create(name: 'Dispatch')
+      data = { weapon_used: 'bow' }
+      badge = AdHonorem::Badge.find('parametered_badge').set_context(user)
+
+      res = AdHonorem::Badge.dispatch(user, :mastered_a_weapon, data: data)
+      expect(badge.complete?(:master_bow)).to be true
+      expect(badge.complete?(:master_sword)).to be false
+      expect(badge.complete?).to be false
+      expect(res[:completed_step].include?('ParameteredBadge#master_bow'))
+      expect(res[:failed_check].include?('ParameteredBadge#master_sword'))
+
+      res = AdHonorem::Badge.dispatch(user, :mastered_a_weapon, data: data.merge(weapon_used: 'sword'))
+      expect(badge.complete?(:master_sword)).to be true
+      expect(badge.complete?).to be true
+      expect(res[:completed_badge].include?('ParameteredBadge#master_sword'))
+      expect(res[:already_done].include?('ParameteredBadge#master_bow'))
+    end
+  end
+end

data/spec/models/badge_trigger_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'rails_helper'
+require_relative '../helpers/badge_instantiator'
+
+RSpec.describe AdHonorem::Badge do
+  before(:each) do
+    instantiate_badges
+  end
+
+  context 'when triggering a badge step-checker' do
+    it 'returns :triggered when a step-checker returns true but it\'s not fulfilled yet' do
+      expect(@two_objectives_badge.trigger(:use_sword)).to eql(:triggered)
+    end
+
+    it 'returns :failed_check when a step-checker returns false' do
+      expect(@conditionnal_badge.trigger(:whoami)).to eql(:failed_check)
+    end
+
+    it 'can succeed when conditions match' do
+      darth_vader = User.create(name: 'Darth Vader')
+      @conditionnal_badge.set_context(darth_vader)
+      expect(@conditionnal_badge.trigger(:whoami)).to eql(:completed_badge)
+    end
+
+    it 'returns :completed_step when all conditions for an objective are fulfilled' do
+      expect(@two_objectives_badge.trigger(:use_longbow)).to eql(:completed_step)
+    end
+
+    it 'returns :completed_badge when all conditions for all objectives are fulfilled' do
+      expect(@normal_badge.trigger(:visit_paris)).to eql(:completed_badge)
+    end
+
+    it 'returns :already_done when a badge is alreay unlocked' do
+      expect(@normal_badge.trigger(:visit_paris)).to eql(:completed_badge)
+      expect(@normal_badge.trigger(:visit_paris)).to eql(:already_done)
+    end
+
+    it 'returns :legacy_badge when a badge is legacy' do
+      expect(@legacy_badge.trigger(:try_me)).to eql(:legacy_badge)
+    end
+
+    it 'allows to trigger an objective several times in a row' do
+      expect(@two_objectives_badge.trigger(:use_sword, {amount: 5})).to eql(:completed_step)
+      expect(@two_objectives_badge.complete?(:use_sword)).to be true
+    end
+
+    it 'allows to pass any data to the checkers' do
+      data = { weapon_used: 'bow' }
+      expect(@parametered_badge.trigger(:master_sword, data: data)).to eql(:failed_check)
+      expect(@parametered_badge.trigger(:master_bow, data: data)).to eql(:completed_step)
+    end
+  end
+end

data/spec/models/meta_badge_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+require 'rails_helper'
+
+RSpec.describe AdHonorem::Badge do
+  before(:each) do
+    name = (0...50).map { ('a'..'z').to_a[rand(26)] }.join
+    @user = User.create(name: name)
+    @meta_badge = AdHonorem::Badge.find('meta_badge').set_context(@user)
+    @sub_one = AdHonorem::Badge.find('sub_badge_one').set_context(@user)
+    @sub_two = AdHonorem::Badge.find('sub_badge_two').set_context(@user)
+  end
+
+  it 'returns next locked badge' do
+    expect(@meta_badge.send(:next_sub_badge).class).to eql(SubBadgeOne)
+    @user.update(level: 10)
+    @meta_badge.trigger(:level_up)
+    expect(@meta_badge.send(:next_sub_badge).class).to eql(SubBadgeTwo)
+  end
+
+  it 'delegates objective checks to all locked badge' do
+    @user.update(level: 10)
+    @meta_badge.trigger(:level_up)
+    expect(@sub_one.complete?).to be true
+    expect(@sub_two.complete?).to be false
+    expect(@meta_badge.complete?).to be false
+
+    @user.update(level: 15)
+    @meta_badge.trigger(:level_up)
+    expect(@sub_two.complete?).to be false
+    expect(@meta_badge.complete?).to be false
+
+    @user.update(level: 20)
+    @meta_badge.trigger(:level_up)
+    expect(@sub_two.complete?).to be true
+    expect(@meta_badge.complete?).to be true
+  end
+
+  it 'works with event hooking' do
+    @user.update(level: 10)
+    expect(@sub_one.complete?).to be false
+    res = AdHonorem::Badge.dispatch(@user, :level_up)
+    expect(@sub_one.complete?).to be true
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,15 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../test_app/config/environment', __FILE__)
+
+abort('Running in production mode!') if Rails.env.production?
+require 'spec_helper'
+require 'rspec/rails'
+
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+RSpec.configure do |config|
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.order = :random
+end

data/spec/test_app/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/test_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/test_app/app/models/badges/conditionnal_badge.rb

@@ -0,0 +1,20 @@
+class ConditionnalBadge < AdHonorem::Badge
+  attribute :slug,          'conditionnal_badge'
+  attribute :name,          'Conditionnal badge'
+  attribute :description,   'This is a conditionnal badge'
+  attribute :category,      'General'
+  attribute :points,        10
+  attribute :icon_locked,   Rails.root.join('public', 'badges', 'locked', 'conditionnal.png')
+  attribute :icon_unlocked, Rails.root.join('public', 'badges', 'unlocked', 'conditionnal.png')
+  attribute :legacy,        false
+
+  def initialize
+    super
+
+    add_objective(:whoami, 'I am your father', 'You must be called Darth Vader to finish me')
+  end
+
+  def whoami(user, params)
+    user.name == 'Darth Vader'
+  end
+end

data/spec/test_app/app/models/badges/legacy_badge.rb

@@ -0,0 +1,20 @@
+class LegacyBadge < AdHonorem::Badge
+  attribute :slug,          'legacy_badge'
+  attribute :name,          'Legacy badge'
+  attribute :description,   'This is a legacy badge'
+  attribute :category,      'General'
+  attribute :points,        10
+  attribute :icon_locked,   Rails.root.join('public', 'badges', 'locked', 'legacy.png')
+  attribute :icon_unlocked, Rails.root.join('public', 'badges', 'unlocked', 'legacy.png')
+  attribute :legacy,        true
+
+  def initialize
+    super
+
+    add_objective(:try_me, 'Alpha tester', 'Granted to heroes who tested the alpha')
+  end
+
+  def try_me(user, params)
+    true
+  end
+end

data/spec/test_app/app/models/badges/meta_badge.rb

@@ -0,0 +1,19 @@
+class MetaBadge < AdHonorem::Badge
+  attribute :slug,          'meta_badge'
+  attribute :name,          'Meta badge'
+  attribute :description,   'This is a meta badge'
+  attribute :category,      'General'
+  attribute :points,        10
+  attribute :icon_locked,   Rails.root.join('public', 'badges', 'locked', 'meta.png')
+  attribute :icon_unlocked, Rails.root.join('public', 'badges', 'unlocked', 'meta.png')
+  attribute :legacy,        true
+
+  hook :level_up, to: :level_up
+
+  def initialize
+    super
+
+    add_sub_badge(:sub_badge_one)
+    add_sub_badge(:sub_badge_two)
+  end
+end

data/spec/test_app/app/models/badges/meta_children/sub_badge_one.rb

@@ -0,0 +1,20 @@
+class SubBadgeOne < AdHonorem::Badge
+  attribute :slug,          'sub_badge_one'
+  attribute :name,          'Sub badge one'
+  attribute :description,   'This is the first sub badge'
+  attribute :category,      'General'
+  attribute :points,        10
+  attribute :icon_locked,   Rails.root.join('public', 'badges', 'locked', 'sub_badge_one.png')
+  attribute :icon_unlocked, Rails.root.join('public', 'badges', 'unlocked', 'sub_badge_one.png')
+  attribute :legacy,        false
+
+  def initialize
+    super
+
+    add_objective(:level_up, 'Ding', 'Reach level 10')
+  end
+
+  def level_up(user, params)
+    user.level >= 10
+  end
+end

data/spec/test_app/app/models/badges/meta_children/sub_badge_two.rb

@@ -0,0 +1,20 @@
+class SubBadgeTwo < AdHonorem::Badge
+  attribute :slug,          'sub_badge_two'
+  attribute :name,          'Sub badge two'
+  attribute :description,   'This is the second sub badge'
+  attribute :category,      'General'
+  attribute :points,        10
+  attribute :icon_locked,   Rails.root.join('public', 'badges', 'locked', 'sub_badge_two.png')
+  attribute :icon_unlocked, Rails.root.join('public', 'badges', 'unlocked', 'sub_badge_two.png')
+  attribute :legacy,        false
+
+  def initialize
+    super
+
+    add_objective(:level_up, 'Ding!', 'Reach level 20')
+  end
+
+  def level_up(user, params)
+    user.level >= 20
+  end
+end

data/spec/test_app/app/models/badges/normal_badge.rb

@@ -0,0 +1,20 @@
+class NormalBadge < AdHonorem::Badge
+  attribute :slug,          'normal_badge'
+  attribute :name,          'Normal badge'
+  attribute :description,   'This is a normal badge'
+  attribute :category,      'General'
+  attribute :points,        10
+  attribute :icon_locked,   Rails.root.join('public', 'badges', 'locked', 'normal.png')
+  attribute :icon_unlocked, Rails.root.join('public', 'badges', 'unlocked', 'normal.png')
+  attribute :legacy,        false
+
+  def initialize
+    super
+
+    add_objective(:visit_paris, 'Visit Paris', 'Go to Paris')
+  end
+
+  def visit_paris(user, params)
+    true
+  end
+end

data/spec/test_app/app/models/badges/parametered_badge.rb

@@ -0,0 +1,33 @@
+class ParameteredBadge < AdHonorem::Badge
+  attribute :slug,          'parametered_badge'
+  attribute :name,          'Parametered badge'
+  attribute :description,   'This is a parametered_badge badge'
+  attribute :category,      'General'
+  attribute :points,        10
+  attribute :icon_locked,   Rails.root.join('public', 'badges', 'locked', 'parametered_badge.png')
+  attribute :icon_unlocked, Rails.root.join('public', 'badges', 'unlocked', 'parametered_badge.png')
+  attribute :legacy,        false
+
+  hook :mastered_a_weapon, to: [:master_sword, :master_bow]
+
+  def initialize
+    super
+
+    add_objective(:master_sword, 'Master sword', 'You shall learn the ancient secrets of chivalry')
+    add_objective(:master_bow, 'Master bow', 'You shall learn the ancient secrets of archery')
+  end
+
+  def master_sword(user, params)
+    weapon_checker('sword', params[:weapon_used])
+  end
+
+  def master_bow(user, params)
+    weapon_checker('bow', params[:weapon_used])
+  end
+
+  private
+
+  def weapon_checker(weapon_to_master, weapon_used)
+    weapon_to_master == weapon_used
+  end
+end

data/spec/test_app/app/models/badges/two_objectives_badge.rb

@@ -0,0 +1,25 @@
+class TwoObjectivesBadge < AdHonorem::Badge
+  attribute :slug,          'two_objectives_badge'
+  attribute :name,          'Two Objectives badge'
+  attribute :description,   'This is a two-objectives badge'
+  attribute :category,      'General'
+  attribute :points,        10
+  attribute :icon_locked,   Rails.root.join('public', 'badges', 'locked', 'two_objectives.png')
+  attribute :icon_unlocked, Rails.root.join('public', 'badges', 'unlocked', 'two_objectives.png')
+  attribute :legacy,        false
+
+  def initialize
+    super
+
+    add_objective(:use_longbow, 'Longbow', 'Use your longbow for the first time')
+    add_objective(:use_sword, 'Sword', 'Use your sword 5 times', 5)
+  end
+
+  def use_longbow(user, params)
+    true
+  end
+
+  def use_sword(user, params)
+    true
+  end
+end

data/spec/test_app/app/models/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/test_app/config/application.rb

@@ -0,0 +1,16 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'active_record/railtie'
+require 'action_controller/railtie'
+require 'action_mailer/railtie'
+require 'action_view/railtie'
+require 'sprockets/railtie'
+
+Bundler.require(*Rails.groups)
+require 'adhonorem'
+
+module TestApp
+  class Application < Rails::Application
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end

data/spec/test_app/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/test_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/test_app/config/environments/development.rb

@@ -0,0 +1,20 @@
+Rails.application.configure do
+  config.cache_classes = false
+
+  config.eager_load = false
+
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  config.action_mailer.raise_delivery_errors = false
+
+  config.active_support.deprecation = :log
+
+  config.active_record.migration_error = :page_load
+
+  config.assets.debug = true
+
+  config.assets.digest = true
+
+  config.assets.raise_runtime_errors = true
+end

data/spec/test_app/config/environments/production.rb

@@ -0,0 +1,25 @@
+Rails.application.configure do
+  config.cache_classes = true
+
+  config.eager_load = true
+
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  config.assets.js_compressor = :uglifier
+  config.assets.compile = false
+
+  config.assets.digest = true
+
+  config.log_level = :debug
+
+  config.i18n.fallbacks = true
+
+  config.active_support.deprecation = :notify
+
+  config.log_formatter = ::Logger::Formatter.new
+
+  config.active_record.dump_schema_after_migration = false
+end

data/spec/test_app/config/environments/test.rb

@@ -0,0 +1,21 @@
+Rails.application.configure do
+  config.cache_classes = true
+
+  config.eager_load = false
+
+  config.serve_static_files   = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  config.action_dispatch.show_exceptions = false
+
+  config.action_controller.allow_forgery_protection = false
+
+  config.action_mailer.delivery_method = :test
+
+  config.active_support.test_order = :random
+
+  config.active_support.deprecation = :stderr
+end

data/spec/test_app/config/initializers/adhonorem.rb

@@ -0,0 +1,3 @@
+AdHonorem.configure do |config|
+  config.user_class = 'User'
+end

data/spec/test_app/config/initializers/assets.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.version = '1.0'

data/spec/test_app/config/initializers/cookies_serializer.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/test_app/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/test_app/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/test_app/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/spec/test_app/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_test_app_session'

data/spec/test_app/config/initializers/wrap_parameters.rb

@@ -0,0 +1,3 @@
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end

data/spec/test_app/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  mount AdHonorem::Engine => '/ad-honorem'
+end

data/spec/test_app/db/migrate/20170103065319_create_users.rb

@@ -0,0 +1,10 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name
+      t.integer :level
+
+      t.timestamps null: false
+    end
+  end
+end

data/spec/test_app/db/migrate/20170103065400_create_adhonorem_progress.rb

@@ -0,0 +1,10 @@
+class CreateAdhonoremProgress < ActiveRecord::Migration
+  def change
+    create_table :adhonorem_progresses do |t|
+      t.integer :user_id
+      t.string :objective_slug
+      t.integer :numeric_progress, default: 0
+    end
+    bind_static_record :adhonorem_progresses, :badge
+  end
+end

data/spec/test_app/db/migrate/20170103065401_create_adhonorem_achievement.rb

@@ -0,0 +1,12 @@
+class CreateAdhonoremAchievement < ActiveRecord::Migration
+  def change
+    create_table :adhonorem_achievements do |t|
+      t.integer :user_id
+      t.integer :state, default: 0
+      t.datetime :unlocked_at
+
+      t.timestamps null: false
+    end
+    bind_static_record :adhonorem_achievements, :badge
+  end
+end

data/spec/test_app/db/schema.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20170103065401) do
+
+  create_table "adhonorem_achievements", force: :cascade do |t|
+    t.integer  "user_id"
+    t.integer  "state",                    default: 0
+    t.datetime "unlocked_at"
+    t.datetime "created_at",                           null: false
+    t.datetime "updated_at",                           null: false
+    t.string   "badge_static_record_type"
+  end
+
+  create_table "adhonorem_progresses", force: :cascade do |t|
+    t.integer "user_id"
+    t.string  "objective_slug"
+    t.integer "numeric_progress",         default: 0
+    t.string  "badge_static_record_type"
+  end
+
+  create_table "users", force: :cascade do |t|
+    t.string   "name"
+    t.integer  "level"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+end