site_tour: set triggers for groups

Victor Costa
1 parent 73d17ca1
Showing 9 changed files with 65 additions and 13 deletions Show diff stats
plugins/site_tour/controllers/site_tour_plugin_admin_controller.rb
plugins/site_tour/lib/site_tour_plugin.rb
plugins/site_tour/lib/site_tour_plugin/tour_block.rb
plugins/site_tour/public/main.js
plugins/site_tour/test/functional/site_tour_plugin_admin_controller_test.rb
plugins/site_tour/views/blocks/tour.html.erb
plugins/site_tour/views/box_organizer/site_tour_plugin/_tour_block.html.erb
plugins/site_tour/views/site_tour_plugin_admin/index.html.erb
plugins/site_tour/views/tour_actions.html.erb
@@ -10,11 +10,15 @@ class SiteTourPluginAdminController &lt; AdminController
     @settings = Noosfero::Plugin::Settings.new(environment, SiteTourPlugin, settings)
     @settings.actions_csv = convert_to_csv(@settings.actions)
+    @settings.group_triggers_csv = convert_to_csv(@settings.group_triggers)
     if request.post?
-      @settings.actions = convert_from_csv(settings[:actions_csv])
+      @settings.actions = convert_actions_from_csv(settings[:actions_csv])
       @settings.settings.delete(:actions_csv)
+      @settings.group_triggers = convert_group_triggers_from_csv(settings[:group_triggers_csv])
+      @settings.settings.delete(:group_triggers_csv)
+
       @settings.save!
       session[:notice] = 'Settings succefully saved.'
       redirect_to :action => 'index'
@@ -25,14 +29,22 @@ class SiteTourPluginAdminController &lt; AdminController
   def convert_to_csv(actions)
     CSV.generate do |csv|
-      (@settings.actions||[]).each { |action| csv << action.values }
+      (actions||[]).each { |action| csv << action.values }
     end
   end
-  def convert_from_csv(actions_csv)
+  def convert_actions_from_csv(actions_csv)
+    return [] if actions_csv.blank?
     CSV.parse(actions_csv).map do |action|
       {:language => action[0], :group_name => action[1], :selector => action[2], :description => action[3]}
     end
   end
+  def convert_group_triggers_from_csv(group_triggers_csv)
+    return [] if group_triggers_csv.blank?
+    CSV.parse(group_triggers_csv).map do |group|
+      {:group_name => group[0], :selector => group[1], :event => group[2]}
+    end
+  end
+
 end
@@ -29,7 +29,7 @@ class SiteTourPlugin &lt; Noosfero::Plugin
       settings = Noosfero::Plugin::Settings.new(environment, SiteTourPlugin)
       actions = (settings.actions||[]).select {|action| action[:language] == language}
-      render(:file => 'tour_actions', :locals => { :actions => actions, :js_file => js_file})
+      render(:file => 'tour_actions', :locals => { :actions => actions, :group_triggers => settings.group_triggers, :js_file => js_file})
     end
   end
 class SiteTourPlugin::TourBlock < Block
   settings_items :actions, :type => Array, :default => [{:group_name => 'tour_plugin', :selector => '.site-tour-plugin_tour-block .tour-button', :description => _('Click to start tour!')}]
+  settings_items :group_triggers, :type => Array, :default => []
   settings_items :display_button, :type => :boolean, :default => true
-  attr_accessible :actions, :display_button
+  attr_accessible :actions, :display_button, :group_triggers
   before_save do |block|
     block.actions.reject! {|i| i[:group_name].blank? && i[:selector].blank? && i[:description].blank?}
+    block.group_triggers.reject! {|i| i[:group_name].blank? && i[:selector].blank? && i[:event].blank?}
   end
   def self.description
 var siteTourPlugin = (function() {
   var actions = [];
+  var groupTriggers = [];
   var userData = {};
+  var intro;
   function hasMark(name) {
     return jQuery.cookie("_noosfero_.sitetour." + name) ||
@@ -19,7 +21,7 @@ var siteTourPlugin = (function() {
     jQuery('.site-tour-plugin').removeAttr('data-intro data-intro-name data-step');
   }
-  function configureIntro(force) {
+  function configureIntro(force, actions) {
     clearAll();
     for(var i=0; i<actions.length; i++) {
       var action = actions[i];
@@ -38,20 +40,43 @@ var siteTourPlugin = (function() {
     }
   }
+  function actionsOnload() {
+    var groups = jQuery.map(groupTriggers, function(g) { return g.name; });
+    return jQuery.grep(actions, function(n, i) { return jQuery.inArray(n.name, groups); });
+  }
+
+  function actionsByGroup(group) {
+    return jQuery.grep(actions, function(n, i) { return n.name===group });
+  }
+
+  function forceParam() {
+    return jQuery.deparam.querystring()['siteTourPlugin']==='force';
+  }
+
   return {
     add: function (name, selector, text, step) {
       actions.push({name: name, selector: selector, text: text, step: step});
     },
+    addGroupTrigger: function(name, selector, ev) {
+      groupTriggers.push({name: name, selector: selector, event: ev});
+      plugin = this;
+      var handler = function() {
+        configureIntro(forceParam(), actionsByGroup(name));
+        intro.start();
+        jQuery(document).off(ev, selector, handler);
+      };
+      jQuery(document).on(ev, selector, handler);
+    },
     start: function(data, force) {
-      force = typeof force !== 'undefined' ? force : false;
+      force = typeof force !== 'undefined' ? force : false || forceParam();
       userData = data;
-      var intro = introJs();
+      intro = introJs();
       intro.onafterchange(function(targetElement) {
         var name = jQuery(targetElement).attr('data-intro-name');
         mark(name);
       });
-      configureIntro(force);
+      configureIntro(force, actionsOnload());
       intro.start();
     },
     force: function() {
@@ -62,6 +87,6 @@ var siteTourPlugin = (function() {
 jQuery( document ).ready(function( $ ) {
   $(window).bind('userDataLoaded', function(event, data) {
-    siteTourPlugin.start(data, jQuery.deparam.querystring()['siteTourPlugin']==='force');
+    siteTourPlugin.start(data);
   });
 });
@@ -17,6 +17,13 @@ class SiteTourPluginAdminControllerTest &lt; ActionController::TestCase
     assert_equal [{:language => 'en', :group_name => 'tour_plugin', :selector => '.tour-button', :description => 'Click'}], @settings.actions
   end
+  should 'parse csv and save group triggers array in plugin settings' do
+    group_triggers_csv = "tour_plugin,.tour-button,mouseenter"
+    post :index, :settings => {"group_triggers_csv" => group_triggers_csv}
+    @settings = Noosfero::Plugin::Settings.new(environment.reload, SiteTourPlugin)
+    assert_equal [{:group_name => 'tour_plugin', :selector => '.tour-button', :event => 'mouseenter'}], @settings.group_triggers
+  end
+
   should 'do not store actions_csv' do
     actions_csv = "en,tour_plugin,.tour-button,Click"
     post :index, :settings => {"actions_csv" => actions_csv}
@@ -7,5 +7,5 @@
 <% edit_mode = controller.send(:boxes_editor?) && controller.send(:uses_design_blocks?) %>
 <% unless edit_mode %>
-  <%= render :file => 'tour_actions', :locals => {:actions => block.actions} %>
+  <%= render :file => 'tour_actions', :locals => {:actions => block.actions, :group_triggers => block.group_triggers} %>
 <% end %>
@@ -3,7 +3,7 @@
 <%= labelled_form_field check_box(:block, :display_button) + _('Display help button'), '' %>
-<strong><%= _('Actions') %></strong>
+<strong><%= _('Tooltip Actions') %></strong>
 <div id='edit-tour-block'>
   <ul class='list-header'>
     <li class='list-name'><%= _('Group Name') %></li>
@@ -3,6 +3,7 @@
 <%= form_for(:settings) do |f| %>
   <%= labelled_form_field _('Tooltips (CSV format: language, group name, selector, description)'), f.text_area(:actions_csv, :style => 'width: 100%', :class => 'actions-csv') %>
+  <%= labelled_form_field _('Group Triggers (CSV format: group name, selector, event (e.g. mouseenter, click))'), f.text_area(:group_triggers_csv, :style => 'width: 100%', :class => 'groups-csv', :rows => 7) %>
   <% button_bar do %>
     <%= submit_button(:save, _('Save'), :cancel => {:controller => 'plugins', :action => 'index'}) %>
@@ -5,8 +5,13 @@
 <script>
   jQuery( document ).ready(function( $ ) {
   <% actions.each_with_index do |action, index| %>
-    <%= "siteTourPlugin.add('#{j action[:group_name]}','#{j action[:selector]}', '#{j action[:description]}', #{index + 1});" %>
+    <%= "siteTourPlugin.add('#{j action[:group_name]}', '#{j action[:selector]}', '#{j action[:description]}', #{index + 1});" %>
   <% end %>
+
+  <% (group_triggers||[]).each_with_index do |group, index| %>
+    <%= "siteTourPlugin.addGroupTrigger('#{j group[:group_name]}', '#{j group[:selector]}', '#{j group[:event]}');" %>
+  <% end %>
+
   });
 </script>
 <% end %>
	@@ -29,7 +29,7 @@ class SiteTourPlugin < Noosfero::Plugin		@@ -29,7 +29,7 @@ class SiteTourPlugin < Noosfero::Plugin
29	settings = Noosfero::Plugin::Settings.new(environment, SiteTourPlugin)	29	settings = Noosfero::Plugin::Settings.new(environment, SiteTourPlugin)
30	actions = (settings.actions\|\|[]).select {\|action\| action[:language] == language}	30	actions = (settings.actions\|\|[]).select {\|action\| action[:language] == language}
31		31
32	- render(:file => 'tour_actions', :locals => { :actions => actions, :js_file => js_file})	32	+ render(:file => 'tour_actions', :locals => { :actions => actions, :group_triggers => settings.group_triggers, :js_file => js_file})
33	end	33	end
34	end	34	end
35		35
	@@ -17,6 +17,13 @@ class SiteTourPluginAdminControllerTest < ActionController::TestCase		@@ -17,6 +17,13 @@ class SiteTourPluginAdminControllerTest < ActionController::TestCase
17	assert_equal [{:language => 'en', :group_name => 'tour_plugin', :selector => '.tour-button', :description => 'Click'}], @settings.actions	17	assert_equal [{:language => 'en', :group_name => 'tour_plugin', :selector => '.tour-button', :description => 'Click'}], @settings.actions
18	end	18	end
19		19
		20	+ should 'parse csv and save group triggers array in plugin settings' do
		21	+ group_triggers_csv = "tour_plugin,.tour-button,mouseenter"
		22	+ post :index, :settings => {"group_triggers_csv" => group_triggers_csv}
		23	+ @settings = Noosfero::Plugin::Settings.new(environment.reload, SiteTourPlugin)
		24	+ assert_equal [{:group_name => 'tour_plugin', :selector => '.tour-button', :event => 'mouseenter'}], @settings.group_triggers
		25	+ end
		26	+
20	should 'do not store actions_csv' do	27	should 'do not store actions_csv' do
21	actions_csv = "en,tour_plugin,.tour-button,Click"	28	actions_csv = "en,tour_plugin,.tour-button,Click"
22	post :index, :settings => {"actions_csv" => actions_csv}	29	post :index, :settings => {"actions_csv" => actions_csv}
	@@ -7,5 +7,5 @@		@@ -7,5 +7,5 @@
7	<% edit_mode = controller.send(:boxes_editor?) && controller.send(:uses_design_blocks?) %>	7	<% edit_mode = controller.send(:boxes_editor?) && controller.send(:uses_design_blocks?) %>
8		8
9	<% unless edit_mode %>	9	<% unless edit_mode %>
10	- <%= render :file => 'tour_actions', :locals => {:actions => block.actions} %>	10	+ <%= render :file => 'tour_actions', :locals => {:actions => block.actions, :group_triggers => block.group_triggers} %>
11	<% end %>	11	<% end %>
	@@ -3,7 +3,7 @@		@@ -3,7 +3,7 @@
3		3
4	<%= labelled_form_field check_box(:block, :display_button) + _('Display help button'), '' %>	4	<%= labelled_form_field check_box(:block, :display_button) + _('Display help button'), '' %>
5		5
6	-<strong><%= _('Actions') %></strong>	6	+<strong><%= _('Tooltip Actions') %></strong>
7	<div id='edit-tour-block'>	7	<div id='edit-tour-block'>
8	<ul class='list-header'>	8	<ul class='list-header'>
9	<li class='list-name'><%= _('Group Name') %></li>	9	<li class='list-name'><%= _('Group Name') %></li>
	@@ -3,6 +3,7 @@		@@ -3,6 +3,7 @@
3	<%= form_for(:settings) do \|f\| %>	3	<%= form_for(:settings) do \|f\| %>
4		4
5	<%= labelled_form_field _('Tooltips (CSV format: language, group name, selector, description)'), f.text_area(:actions_csv, :style => 'width: 100%', :class => 'actions-csv') %>	5	<%= labelled_form_field _('Tooltips (CSV format: language, group name, selector, description)'), f.text_area(:actions_csv, :style => 'width: 100%', :class => 'actions-csv') %>
		6	+ <%= labelled_form_field _('Group Triggers (CSV format: group name, selector, event (e.g. mouseenter, click))'), f.text_area(:group_triggers_csv, :style => 'width: 100%', :class => 'groups-csv', :rows => 7) %>
6		7
7	<% button_bar do %>	8	<% button_bar do %>
8	<%= submit_button(:save, _('Save'), :cancel => {:controller => 'plugins', :action => 'index'}) %>	9	<%= submit_button(:save, _('Save'), :cancel => {:controller => 'plugins', :action => 'index'}) %>