Replace fixed option to introduce new edit modes for blocks

It resolves issue #38 Signed-off-by: Arthur Del Esposte <arthurmde@gmail.com> Signed-off-by: David Carlos <ddavidcarlos1392@gmail.com> Signed-off-by: Gabriela Navarro <navarro1703@gmail.com>

Replace fixed option to introduce new edit modes for blocks
It resolves issue #38 Signed-off-by: Arthur Del Esposte <arthurmde@gmail.com> Signed-off-by: David Carlos <ddavidcarlos1392@gmail.com> Signed-off-by: Gabriela Navarro <navarro1703@gmail.com>
Arthur Esposte
1 parent d50ac31c
Showing 7 changed files with 105 additions and 33 deletions Show diff stats
app/controllers/my_profile/profile_design_controller.rb
app/helpers/boxes_helper.rb
app/models/block.rb
app/views/box_organizer/edit.html.erb
test/functional/profile_design_controller_test.rb
test/unit/block_test.rb
test/unit/boxes_helper_test.rb
@@ -4,11 +4,19 @@ class ProfileDesignController &lt; BoxOrganizerController
   protect 'edit_profile_design', :profile
-  before_filter :protect_fixed_block, :only => [:save, :move_block]
+  before_filter :protect_uneditable_block, :only => [:save]
+  before_filter :protect_fixed_block, :only => [:move_block]
+
+  def protect_uneditable_block
+    block = boxes_holder.blocks.find(params[:id].gsub(/^block-/, ''))
+    if !current_person.is_admin? && !block.editable?
+      render_access_denied
+    end
+  end
   def protect_fixed_block
     block = boxes_holder.blocks.find(params[:id].gsub(/^block-/, ''))
-    if block.fixed && !current_person.is_admin?
+    if !current_person.is_admin? && !block.movable?
       render_access_denied
     end
   end
@@ -190,7 +190,7 @@ module BoxesHelper
       else
         "before-block-#{block.id}"
       end
-    if block.nil? or modifiable?(block)
+    if block.nil? || movable?(block)
       content_tag('div', '&nbsp;', :id => id, :class => 'block-target' ) + drop_receiving_element(id, :url => { :action => 'move_block', :target => id }, :accept => box.acceptable_blocks, :hoverclass => 'block-target-hover')
     else
       ""
@@ -199,14 +199,14 @@ module BoxesHelper
   # makes the given block draggable so it can be moved away.
   def block_handle(block)
-    modifiable?(block) ? draggable_element("block-#{block.id}", :revert => true) : ""
+    movable?(block) ? draggable_element("block-#{block.id}", :revert => true) : ""
   end
   def block_edit_buttons(block)
     buttons = []
     nowhere = 'javascript: return false;'
-    if modifiable?(block)
+    if movable?(block)
       if block.first?
         buttons << icon_button('up-disabled', _("Can't move up anymore."), nowhere)
       else
@@ -229,15 +229,15 @@ module BoxesHelper
           buttons << icon_button('left', _('Move to the opposite side'), { :action => 'move_block', :target => 'end-of-box-' + holder.boxes[1].id.to_s, :id => block.id }, :method => 'post' )
         end
       end
+    end
-      if block.editable?
-        buttons << modal_icon_button(:edit, _('Edit'), { :action => 'edit', :id => block.id })
-      end
+    if editable?(block)
+      buttons << modal_icon_button(:edit, _('Edit'), { :action => 'edit', :id => block.id })
+    end
-      if !block.main?
-        buttons << icon_button(:delete, _('Remove block'), { :action => 'remove', :id => block.id }, { :method => 'post', :confirm => _('Are you sure you want to remove this block?')})
-        buttons << icon_button(:clone, _('Clone'), { :action => 'clone_block', :id => block.id }, { :method => 'post' })
-      end
+    if movable?(block) && !block.main?
+      buttons << icon_button(:delete, _('Remove block'), { :action => 'remove', :id => block.id }, { :method => 'post', :confirm => _('Are you sure you want to remove this block?')})
+      buttons << icon_button(:clone, _('Clone'), { :action => 'clone_block', :id => block.id }, { :method => 'post' })
     end
     if block.respond_to?(:help)
@@ -273,7 +273,11 @@ module BoxesHelper
     classes
   end
-  def modifiable?(block)
-    return !block.fixed || environment.admins.include?(user)
+  def movable?(block)
+    return block.movable? || user.is_admin?
+  end
+
+  def editable?(block)
+    return block.editable? || user.is_admin?
   end
 end
 class Block < ActiveRecord::Base
-  attr_accessible :title, :display, :limit, :box_id, :posts_per_page, :visualization_format, :language, :display_user, :box, :fixed
+  attr_accessible :title, :display, :limit, :box_id, :posts_per_page,
+                  :visualization_format, :language, :display_user,
+                  :box, :edit_modes, :move_modes
   # to be able to generate HTML
   include ActionView::Helpers::UrlHelper
@@ -110,8 +112,14 @@ class Block &lt; ActiveRecord::Base
   # * <tt>'all'</tt>: the block is always displayed
   settings_items :language, :type => :string, :default => 'all'
-  # The block can be configured to be fixed. Only can be edited by environment admins
-  settings_items :fixed, :type => :boolean, :default => false
+  # The block can be configured to define the edition modes options. Only can be edited by environment admins
+  # It can assume the following values:
+  #
+  # * <tt>'all'</tt>: the block owner has all edit options for this block
+  # * <tt>'only_edit'</tt>: the block owner can only edit the block content, but can't move it
+  # * <tt>'none'</tt>: the block owner can't do anything with the block
+  settings_items :edit_modes, :type => :string, :default => 'all'
+  settings_items :move_modes, :type => :string, :default => 'all'
   # returns the description of the block, used when the user sees a list of
   # blocks to choose one to include in the design.
@@ -148,7 +156,11 @@ class Block &lt; ActiveRecord::Base
   # Is this block editable? (Default to <tt>false</tt>)
   def editable?
-    true
+    self.edit_modes == "all"
+  end
+
+  def movable?
+    self.move_modes == "all"
   end
   # must always return false, except on MainBlock clas.
@@ -228,6 +240,21 @@ class Block &lt; ActiveRecord::Base
     }
   end
+  def edit_block_options
+    @edit_options ||= {
+      'all'            => _('Can be modified'),
+      'none'           => _('Cannot be modified')
+    }
+  end
+
+  def move_block_options
+    @move_options ||= {
+      'all'            => _('Can be moved'),
+      'none'           => _('Cannot be moved')
+    }
+  end
+
+
   def duplicate
     duplicated_block = self.dup
     duplicated_block.display = 'never'
@@ -5,12 +5,6 @@
     <%= labelled_form_field(_('Custom title for this block: '), text_field(:block, :title, :maxlength => 20)) %>
-    <% if environment.admins.include?(user) %>
-      <div class="fixed_block">
-        <%= labelled_check_box(_("Fixed"), "block[fixed]", value = "1", checked = @block.fixed) %>
-      </div>
-    <% end %>
-
     <%= render :partial => partial_for_class(@block.class) %>
     <div class="display">
@@ -25,6 +19,15 @@
     <%= labelled_form_field(_('Show for:'), select(:block, :language, [ [ _('all languages'), 'all']] + environment.locales.map {|key, value| [value, key]} )) %>
+    <% if user.is_admin? %>
+      <div class="edit-modes">
+        <%= labelled_form_field _('Edit options:'), select_tag('block[edit_modes]', options_from_collection_for_select(@block.edit_block_options, :first, :last, @block.edit_modes)) %>
+      </div>
+      <div class="move-modes">
+        <%= labelled_form_field _('Move options:'), select_tag('block[move_modes]', options_from_collection_for_select(@block.move_block_options, :first, :last, @block.move_modes)) %>
+      </div>
+    <% end %>
+
     <% button_bar do %>
       <%= submit_button(:save, _('Save')) %>
       <%= modal_close_button(_('Cancel')) %>
@@ -737,9 +737,9 @@ class ProfileDesignControllerTest &lt; ActionController::TestCase
     end
   end
-  test 'should forbid POST to save for fixed blocks' do
+  test 'should forbid POST to save for uneditable blocks' do
     block = profile.blocks.last
-    block.fixed = true
+    block.edit_modes = "none"
     block.save!
     post :save, id: block.id, profile: profile.identifier
@@ -748,7 +748,7 @@ class ProfileDesignControllerTest &lt; ActionController::TestCase
   test 'should forbid POST to move_block for fixed blocks' do
     block = profile.blocks.last
-    block.fixed = true
+    block.move_modes = "none"
     block.save!
     post :move_block, id: block.id, profile: profile.identifier, target: "end-of-box-#{@box3.id}"
@@ -35,6 +35,24 @@ class BlockTest &lt; ActiveSupport::TestCase
     assert Block.new.editable?
   end
+  should 'be editable if edit modes is all' do
+    block = Block.new
+    block.edit_modes = 'all'
+
+    assert block.editable?
+  end
+
+  should 'be movable by default' do
+    assert Block.new.movable?
+  end
+
+  should 'be movable if move modes is all' do
+    block = Block.new
+    block.move_modes = 'all'
+
+    assert block.movable?
+  end
+
   should 'have default titles' do
     b = Block.new
     b.expects(:default_title).returns('my title')
@@ -122,24 +122,24 @@ class BoxesHelperTest &lt; ActionView::TestCase
     display_box_content(box, '')
   end
-  should 'not show move options on block when block is fixed' do
+  should 'not show move options on block when block has no permission to edit' do
     p = create_user_with_blocks
     b = p.blocks.select{|bk| !bk.kind_of?(MainBlock) }[0]
-    b.fixed = true
+    b.move_modes = "none"
     b.save!
     stubs(:environment).returns(p.environment)
     stubs(:user).returns(p)
-    assert_equal false, modifiable?(b)
+    assert_equal false, movable?(b)
   end
-  should 'show move options on block when block is fixed and user is admin' do
+  should 'show move options on block when block has no permission to edit and user is admin' do
     p = create_user_with_blocks
     b = p.blocks.select{|bk| !bk.kind_of?(MainBlock) }[0]
-    b.fixed = true
+    b.edit_modes = "none"
     b.save!
     p.environment.add_admin(p)
@@ -147,7 +147,7 @@ class BoxesHelperTest &lt; ActionView::TestCase
     stubs(:environment).returns(p.environment)
     stubs(:user).returns(p)
-    assert_equal true, modifiable?(b)
+    assert_equal true, movable?(b)
   end
   should 'consider boxes_limit without custom_design' do
@@ -181,4 +181,16 @@ class BoxesHelperTest &lt; ActionView::TestCase
     display_box_content(box, '')
   end
+  should 'only show edit option on block' do
+    p = create_user_with_blocks
+
+    b = p.blocks.select{|bk| !bk.kind_of?(MainBlock) }[0]
+    b.edit_modes = "only_edit"
+    b.save!
+
+    stubs(:environment).returns(p.environment)
+    stubs(:user).returns(p)
+
+    assert_equal false, b.editable?
+  end
 end
1	class Block < ActiveRecord::Base	1	class Block < ActiveRecord::Base
2		2
3	- attr_accessible :title, :display, :limit, :box_id, :posts_per_page, :visualization_format, :language, :display_user, :box, :fixed	3	+ attr_accessible :title, :display, :limit, :box_id, :posts_per_page,
		4	+ :visualization_format, :language, :display_user,
		5	+ :box, :edit_modes, :move_modes
4		6
5	# to be able to generate HTML	7	# to be able to generate HTML
6	include ActionView::Helpers::UrlHelper	8	include ActionView::Helpers::UrlHelper
	@@ -110,8 +112,14 @@ class Block < ActiveRecord::Base		@@ -110,8 +112,14 @@ class Block < ActiveRecord::Base
110	# * <tt>'all'</tt>: the block is always displayed	112	# * <tt>'all'</tt>: the block is always displayed
111	settings_items :language, :type => :string, :default => 'all'	113	settings_items :language, :type => :string, :default => 'all'
112		114
113	- # The block can be configured to be fixed. Only can be edited by environment admins
114	- settings_items :fixed, :type => :boolean, :default => false	115	+ # The block can be configured to define the edition modes options. Only can be edited by environment admins
		116	+ # It can assume the following values:
		117	+ #
		118	+ # * <tt>'all'</tt>: the block owner has all edit options for this block
		119	+ # * <tt>'only_edit'</tt>: the block owner can only edit the block content, but can't move it
		120	+ # * <tt>'none'</tt>: the block owner can't do anything with the block
		121	+ settings_items :edit_modes, :type => :string, :default => 'all'
		122	+ settings_items :move_modes, :type => :string, :default => 'all'
115		123
116	# returns the description of the block, used when the user sees a list of	124	# returns the description of the block, used when the user sees a list of
117	# blocks to choose one to include in the design.	125	# blocks to choose one to include in the design.
	@@ -148,7 +156,11 @@ class Block < ActiveRecord::Base		@@ -148,7 +156,11 @@ class Block < ActiveRecord::Base
148		156
149	# Is this block editable? (Default to <tt>false</tt>)	157	# Is this block editable? (Default to <tt>false</tt>)
150	def editable?	158	def editable?
151	- true	159	+ self.edit_modes == "all"
		160	+ end
		161	+
		162	+ def movable?
		163	+ self.move_modes == "all"
152	end	164	end
153		165
154	# must always return false, except on MainBlock clas.	166	# must always return false, except on MainBlock clas.
	@@ -228,6 +240,21 @@ class Block < ActiveRecord::Base		@@ -228,6 +240,21 @@ class Block < ActiveRecord::Base
228	}	240	}
229	end	241	end
230		242
		243	+ def edit_block_options
		244	+ @edit_options \|\|= {
		245	+ 'all' => _('Can be modified'),
		246	+ 'none' => _('Cannot be modified')
		247	+ }
		248	+ end
		249	+
		250	+ def move_block_options
		251	+ @move_options \|\|= {
		252	+ 'all' => _('Can be moved'),
		253	+ 'none' => _('Cannot be moved')
		254	+ }
		255	+ end
		256	+
		257	+
231	def duplicate	258	def duplicate
232	duplicated_block = self.dup	259	duplicated_block = self.dup
233	duplicated_block.display = 'never'	260	duplicated_block.display = 'never'
	@@ -737,9 +737,9 @@ class ProfileDesignControllerTest < ActionController::TestCase		@@ -737,9 +737,9 @@ class ProfileDesignControllerTest < ActionController::TestCase
737	end	737	end
738	end	738	end
739		739
740	- test 'should forbid POST to save for fixed blocks' do	740	+ test 'should forbid POST to save for uneditable blocks' do
741	block = profile.blocks.last	741	block = profile.blocks.last
742	- block.fixed = true	742	+ block.edit_modes = "none"
743	block.save!	743	block.save!
744		744
745	post :save, id: block.id, profile: profile.identifier	745	post :save, id: block.id, profile: profile.identifier
	@@ -748,7 +748,7 @@ class ProfileDesignControllerTest < ActionController::TestCase		@@ -748,7 +748,7 @@ class ProfileDesignControllerTest < ActionController::TestCase
748		748
749	test 'should forbid POST to move_block for fixed blocks' do	749	test 'should forbid POST to move_block for fixed blocks' do
750	block = profile.blocks.last	750	block = profile.blocks.last
751	- block.fixed = true	751	+ block.move_modes = "none"
752	block.save!	752	block.save!
753		753
754	post :move_block, id: block.id, profile: profile.identifier, target: "end-of-box-#{@box3.id}"	754	post :move_block, id: block.id, profile: profile.identifier, target: "end-of-box-#{@box3.id}"
	@@ -35,6 +35,24 @@ class BlockTest < ActiveSupport::TestCase		@@ -35,6 +35,24 @@ class BlockTest < ActiveSupport::TestCase
35	assert Block.new.editable?	35	assert Block.new.editable?
36	end	36	end
37		37
		38	+ should 'be editable if edit modes is all' do
		39	+ block = Block.new
		40	+ block.edit_modes = 'all'
		41	+
		42	+ assert block.editable?
		43	+ end
		44	+
		45	+ should 'be movable by default' do
		46	+ assert Block.new.movable?
		47	+ end
		48	+
		49	+ should 'be movable if move modes is all' do
		50	+ block = Block.new
		51	+ block.move_modes = 'all'
		52	+
		53	+ assert block.movable?
		54	+ end
		55	+
38	should 'have default titles' do	56	should 'have default titles' do
39	b = Block.new	57	b = Block.new
40	b.expects(:default_title).returns('my title')	58	b.expects(:default_title).returns('my title')