Transforming simple ruby files into a ruby gem

blake · December 4, 2018, 3:09am

Glad to here you are working on your first plugin . I would look at the examples of other plugins and see how they do the ruby side of things.

I don’t think your plugin actually needs to have a Gemfile, but you need to specify all of your dependencies and sub-dependencies inside of your plugin.rb file. Discourse will then install all of the gems when it loads the plugin. See this example:

github.com

xfalcox/discourse-backups-to-dropbox/blob/master/plugin.rb

# name: discourse-backups-to-dropbox
# about: Backups discourse backups in dropbox
# version: 0.0.2
# authors: Rafael dos Santos Silva <xfalcox@gmail.com>
# url: https://github.com/xfalcox/discourse-backups-to-dropbox

gem 'public_suffix', '2.0.5', {require: false }
gem 'domain_name', '0.5.20170404', {require: false }

gem 'addressable', '2.5.1', {require: false }
gem 'http_parser.rb', '0.6.0', {require: false }
gem 'http-cookie', '1.0.3', {require: false }
gem 'http-form_data', '1.0.1', {require: false }

gem 'http', '2.0.3', {require: false }

gem 'dropbox-sdk-v2', '0.0.3', { require: false }

enabled_site_setting :discourse_backups_to_dropbox_enabled

This file has been truncated. show original

Any files your plugin uses you can put inside of the “lib” folder and then require them inside of plugin.rb.

github.com

discourse/discourse-data-explorer/blob/main/plugin.rb#L579


      
          # frozen_string_literal: true
          
          # name: discourse-data-explorer
          # about: Allows you to make SQL queries against your live database, allowing for up-to-the-minute stats reporting.
          # meta_topic_id: 32566
          # version: 0.3
          # authors: Riking
          # url: https://github.com/discourse/discourse-data-explorer
          
          enabled_site_setting :data_explorer_enabled
          
          register_asset "stylesheets/explorer.scss"
          
          register_svg_icon "caret-down"
          register_svg_icon "caret-right"
          register_svg_icon "chevron-left"
          register_svg_icon "exclamation-circle"
          register_svg_icon "info"
          register_svg_icon "pencil-alt"
          register_svg_icon "upload"
          
          add_admin_route "explorer.title", "explorer"
          
          module ::DiscourseDataExplorer
            PLUGIN_NAME = "discourse-data-explorer"
          
            # This should always match the max value for the
            # data_explorer_query_result_limit site setting
            QUERY_RESULT_MAX_LIMIT = 10_000
          end
          
          require_relative "lib/discourse_data_explorer/engine"
          
          after_initialize do
            require_relative "app/jobs/scheduled/delete_hidden_queries"
            require_relative "lib/discourse_data_explorer/data_explorer"
            require_relative "lib/discourse_data_explorer/parameter"
            require_relative "lib/discourse_data_explorer/queries"
            require_relative "lib/discourse_data_explorer/query_group_bookmarkable"
          
            GlobalSetting.add_default(:max_data_explorer_api_reqs_per_10_seconds, 2)
          
            # Available options:
            #   - warn
            #   - warn+block
            #   - block
            GlobalSetting.add_default(:max_data_explorer_api_req_mode, "warn")
          
            add_to_class(:guardian, :user_is_a_member_of_group?) do |group|
              return false if !current_user
              return true if current_user.admin?
              current_user.group_ids.include?(group.id)
            end
          
            add_to_class(:guardian, :user_can_access_query?) do |query|
              return false if !current_user
              return true if current_user.admin?
              query.groups.blank? || query.groups.any? { |group| user_is_a_member_of_group?(group) }
            end
          
            add_to_class(:guardian, :group_and_user_can_access_query?) do |group, query|
              return false if !current_user
              return true if current_user.admin?
              user_is_a_member_of_group?(group) && query.groups.exists?(id: group.id)
            end
          
            add_to_serializer(
              :group_show,
              :has_visible_data_explorer_queries,
              include_condition: -> { scope.user_is_a_member_of_group?(object) },
            ) { DiscourseDataExplorer::Query.for_group(object).exists? }
          
            register_bookmarkable(DiscourseDataExplorer::QueryGroupBookmarkable)
          
            add_api_key_scope(
              :discourse_data_explorer,
              { run_queries: { actions: %w[discourse_data_explorer/query#run], params: %i[id] } },
            )
          
            require_relative "lib/report_generator"
            require_relative "lib/result_to_markdown"
            reloadable_patch do
              if defined?(DiscourseAutomation)
                add_automation_scriptable("recurring_data_explorer_result_pm") do
                  queries =
                    DiscourseDataExplorer::Query
                      .where(hidden: false)
                      .map { |q| { id: q.id, translated_name: q.name } }
                  field :recipients, component: :email_group_user, required: true
                  field :query_id, component: :choices, required: true, extra: { content: queries }
                  field :query_params, component: :"key-value", accepts_placeholders: true
                  field :skip_empty, component: :boolean
          
                  version 1
                  triggerables [:recurring]
          
                  script do |_, fields, automation|
                    recipients = Array(fields.dig("recipients", "value")).uniq
                    query_id = fields.dig("query_id", "value")
                    query_params = fields.dig("query_params", "value") || {}
                    skip_empty = fields.dig("skip_empty", "value") || false
          
                    unless SiteSetting.data_explorer_enabled
                      Rails.logger.warn "#{DiscourseDataExplorer::PLUGIN_NAME} - plugin must be enabled to run automation #{automation.id}"
                      next
                    end
          
                    if recipients.blank?
                      Rails.logger.warn "#{DiscourseDataExplorer::PLUGIN_NAME} - couldn't find any recipients for automation #{automation.id}"
                      next
                    end
          
                    DiscourseDataExplorer::ReportGenerator
                      .generate(query_id, query_params, recipients, { skip_empty: })
                      .each do |pm|
                        begin
                          utils.send_pm(pm, automation_id: automation.id, prefers_encrypt: false)
                        rescue ActiveRecord::RecordNotSaved => e
                          Rails.logger.warn "#{DiscourseDataExplorer::PLUGIN_NAME} - couldn't send PM for automation #{automation.id}: #{e.message}"
                        end
                      end
                  end
                end
              end
            end
          end

This file has been truncated. show original

Topic		Replies	Views
Rails plugin generator Announcements	50	12597	August 20, 2021
Package a Discourse plugin as a gem Developers plugin-guides , how-to	4	544	July 27, 2023
Developing Discourse Plugins - Part 1 - Create a basic plugin Developer Guides plugin-guides , tutorial	32	79656	July 8, 2025
Discourse Plugins and Rails 6 config/initializers Question Dev	22	2845	November 22, 2020
Requiring external gems Dev	9	1726	August 28, 2023

Transforming simple ruby files into a ruby gem

Related topics