Download as
Browse Code »

Commit 7843b7953899f98bfbea254b70a83999725245e5

Authored by Rodrigo Souto
1 parent aeaed25f
Exists in master and in 29 other branches add_member_task_reject_details, admin_visible_profile, article-list-template, community_notifications, contact_admin_translation, event_fixes, fix_comments_pagination, fix_rails4_organization_ratings, fix_sign_up_form, follow_step_fix, forum_topic_creation, mirror_block_improvements, multi_env_on_remote_user, new_security, noosfero_spb_ci, organization_ratings_improvements, organization_ratings_link_to_profile_stable-spb-1.3, organization_ratings_translations_fix, profile_api_improvements, ratings_minor_fixes, remote_user_fix, send_email_to_admins, stable-spb-1.3, stable-spb-1.3-fixes, stable-spb-1.4, stable-spb-1.5, suggest_rejected_value, web_steps_improvements, xss_terminate_custom_options

Generic Settings for Plugins 

This patch extends the infra developed on the spaminator branch to build
generic settings for plugin by allowing the setting to be instatiated
with any model that supports settings (and respond to the method
settings).

This way a plugin can have any number of settings over any model
instance like a Profile or an Article and not only the Environment.

!! This might conflict with the commit that introduces this idea !!
!! The commit is 7afc68410de26905e442714857effa3e3a13ad1a        !!
Showing 4 changed files with 101 additions and 0 deletions   Show diff stats
app/models/profile.rb
  Diff comments   View file @7843b79
... ... @@ -140,6 +140,10 @@ class Profile < ActiveRecord::Base
140 140  
141 141 acts_as_having_settings :field => :data
142 142  
  143 + def settings
  144 + data
  145 + end
  146 +
143 147 settings_items :redirect_l10n, :type => :boolean, :default => false
144 148 settings_items :public_content, :type => :boolean, :default => true
145 149 settings_items :description
... ...
config/initializers/plugins.rb
  Diff comments   View file @7843b79
... ... @@ -3,4 +3,5 @@ require 'noosfero/plugin/hot_spot'
3 3 require 'noosfero/plugin/manager'
4 4 require 'noosfero/plugin/active_record'
5 5 require 'noosfero/plugin/mailer_base'
  6 +require 'noosfero/plugin/settings'
6 7 Noosfero::Plugin.init_system if $NOOSFERO_LOAD_PLUGINS
... ...
lib/noosfero/plugin/settings.rb 0 → 100644
  Diff comments   View file @7843b79
... ... @@ -0,0 +1,45 @@
  1 +class Noosfero::Plugin::Settings
  2 +
  3 + def initialize(base, plugin, attributes = nil)
  4 + @base = base
  5 + @plugin = plugin
  6 + attributes ||= {}
  7 + attributes.each do |k,v|
  8 + self.send("#{k}=", v)
  9 + end
  10 + end
  11 +
  12 + def settings
  13 + @base.settings["#{@plugin.public_name}_plugin".to_sym] ||= {}
  14 + end
  15 +
  16 + def method_missing(method, *args, &block)
  17 + if method.to_s =~ /^(.+)=$/
  18 + set_setting($1, args.first)
  19 + elsif method.to_s =~ /^(.+)$/
  20 + get_setting($1)
  21 + end
  22 + end
  23 +
  24 + def get_setting(name)
  25 + if settings[name.to_sym].nil?
  26 + if @plugin.respond_to?("#{name}_default_setting")
  27 + @plugin.send("#{name}_default_setting")
  28 + else
  29 + nil
  30 + end
  31 + else
  32 + settings[name.to_sym]
  33 + end
  34 + end
  35 +
  36 + def set_setting(name, value)
  37 + settings[name.to_sym] = value
  38 + end
  39 +
  40 + def save!
  41 + @base.save!
  42 + end
  43 +
  44 +end
  45 +
... ...
test/unit/plugin_settings_test.rb 0 → 100644
  Diff comments   View file @7843b79
... ... @@ -0,0 +1,51 @@
  1 +require 'test_helper'
  2 +
  3 +class SolarSystemPlugin < Noosfero::Plugin
  4 + def self.secret_default_setting
  5 + 42
  6 + end
  7 +end
  8 +
  9 +class PluginSettingsTest < ActiveSupport::TestCase
  10 +
  11 + def setup
  12 + @environment = Environment.new
  13 + @profile = Profile.new
  14 + @plugin = SolarSystemPlugin
  15 + end
  16 +
  17 + attr_accessor :environment, :profile, :plugin, :settings
  18 +
  19 + should 'store setttings on any model that offers settings' do
  20 + base = environment
  21 + settings = Noosfero::Plugin::Settings.new(base, plugin)
  22 + settings.star = 'sun'
  23 + settings.planets = 8
  24 + assert_equal 'sun', base.settings[:solar_system_plugin][:star]
  25 + assert_equal 8, base.settings[:solar_system_plugin][:planets]
  26 + assert_equal 'sun', settings.star
  27 + assert_equal 8, settings.planets
  28 +
  29 + base = profile
  30 + settings = Noosfero::Plugin::Settings.new(base, plugin)
  31 + settings.star = 'sun'
  32 + settings.planets = 8
  33 + assert_equal 'sun', base.settings[:solar_system_plugin][:star]
  34 + assert_equal 8, base.settings[:solar_system_plugin][:planets]
  35 + assert_equal 'sun', settings.star
  36 + assert_equal 8, settings.planets
  37 + end
  38 +
  39 + should 'save base on save' do
  40 + environment.expects(:save!)
  41 + settings = Noosfero::Plugin::Settings.new(environment, plugin)
  42 + settings.save!
  43 + end
  44 +
  45 + should 'use default value defined on the plugin class' do
  46 + settings = Noosfero::Plugin::Settings.new(profile, plugin)
  47 + assert_equal 42, settings.secret
  48 + end
  49 +
  50 +end
  51 +
... ...