Contents

# frozen_string_literal: true

module Decidim
  module Gamification
    # This class represents a repository of badges. New badges can be
    # registered thanks to its DSL and will be validated prior to being
    # inserted.
    #
    class BadgeRegistry
      # Public: Initializes the badge registry.
      def initialize
        @badges = {}
      end

      # Public: Returns all the registered badges.
      #
      # Returns Array<Badge>.
      def all
        @badges.values
      end

      # Public: Finds a badge given its name.
      #
      # name - The name of the badge to find.
      #
      # Returns a Badge if found or nil otherwise.
      def find(name)
        @badges[name.to_s]
      end

      # Public: Registers a new badge.
      #
      # name   - The name of the badge to register.
      # &block - A block that gets the new badge as argument.
      #
      # Example:
      #     register(:fake){ |badge| badge.levels = [1, 3, 10] }
      #
      # Returns a Badge when registered successfully, raises an exception
      # otherwise.
      def register(name, &block)
        name = name.to_s

        badge = Badge.new(name: name).tap do |object|
          object.instance_eval(&block)
        end

        badge.validate!

        @badges[name] = badge
      end

      # Public: Unregisters a previously registered badge.
      #
      # name - The name of the badge to unregister.
      #
      # Returns the deleted Badge if found, nil otherwise.
      def unregister(name)
        @badges.delete(name.to_s)
      end
    end
  end
end

Version data entries

65 entries across 65 versions & 1 rubygems

Version	Path
decidim-core-0.15.0	lib/decidim/gamification/badge_registry.rb
decidim-core-0.14.4	lib/decidim/gamification/badge_registry.rb
decidim-core-0.14.3	lib/decidim/gamification/badge_registry.rb
decidim-core-0.14.2	lib/decidim/gamification/badge_registry.rb
decidim-core-0.14.1	lib/decidim/gamification/badge_registry.rb