Refactoring of environment model:

* A lot of environment methods were not using settings_items in yours definition. In some cases use the code settings_items instead of define the method entirelly is more appropriated * The method boxes_limit was defined using LayoutTemplate? class in one case and in the other case, using the database. (ActionItem1568)

Refactoring of environment model:
* A lot of environment methods were not using settings_items in yours definition. In some cases use the code settings_items instead of define the method entirelly is more appropriated * The method boxes_limit was defined using LayoutTemplate? class in one case and in the other case, using the database. (ActionItem1568)
Leandro Santos · Joenio Costa
1 parent 202b94a2
Showing 6 changed files with 49 additions and 180 deletions Show diff stats
app/models/environment.rb
app/models/profile.rb
app/views/account/_signup_form.rhtml
app/views/account/blocked.rhtml
lib/acts_as_having_boxes.rb
test/unit/environment_test.rb
@@ -161,15 +161,47 @@ class Environment &lt; ActiveRecord::Base
   # #################################################
  
   # store the Environment settings as YAML-serialized Hash.
-  serialize :settings
+  acts_as_having_settings :field => :settings
  
-  def homepage
-     settings[:homepage]
-  end
+  # the environment's terms of use: every user must accept them before registering.
+  settings_items :terms_of_use, :type => String
+
+  # the environment's terms of enterprise use: every enterprise member must accept them before
+  # registering or activating enterprises.
+  settings_items :terms_of_enterprise_use, :type => String
  
-  # returns a Hash containing the Environment configuration
-  def settings
-    self[:settings] ||= {}
+  # returns the approval method used for this environment. Possible values are:
+  #
+  # Defaults to <tt>:admim</tt>.
+  settings_items :organization_approval_method, :type => Symbol, :default => :admin
+
+  # Whether this environment should force having 'www.' in its domain name or
+  # not. Defauls to false.
+  #
+  # Sets the value of #force_www. <tt>value</tt> must be a boolean.
+  #
+  # See also #default_hostname
+  settings_items :force_www, :default => false
+
+  settings_items :message_for_friend_invitation, :type => String, :default => InviteFriend.mail_template
+  settings_items :message_for_member_invitation, :type => String, :default => InviteMember.mail_template
+  settings_items :activation_blocked_text, :type => String
+  settings_items :message_for_disabled_enterprise, :type => String
+  settings_items :location, :type => String
+  settings_items :layout_template, :type => String, :default => 'default'
+  settings_items :homepage, :type => String
+  settings_items :description, :type => String
+  settings_items :category_types, :type => Array, :default => ['Category']
+  settings_items :enable_ssl
+  settings_items :theme, :type => String, :default => 'default'
+  settings_items :icon_theme, :type => String, :default => 'default'
+  settings_items :local_docs, :type => Array, :default => []
+  settings_items :news_amount_by_folder, :type => Integer, :default => 4
+  settings_items :help_message_to_add_enterprise, :type => String, :default => ''
+  settings_items :tip_message_enterprise_activation_question, :type => String, :default => ''
+
+  def news_amount_by_folder=(amount)
+    settings[:news_amount_by_folder] = amount.to_i
   end
  
   # Enables a feature identified by its name
@@ -201,71 +233,16 @@ class Environment &lt; ActiveRecord::Base
     end
   end
  
-  # the environment's terms of use: every user must accept them before
-  # registering.
-  def terms_of_use
-    self.settings['terms_of_use']
-  end
-
-  # sets the environment's terms of use.
-  def terms_of_use=(value)
-    self.settings['terms_of_use'] = value.blank? ? nil : value
-  end
-
   # returns <tt>true</tt> if this Environment has terms of use to be
   # accepted by users before registration.
   def has_terms_of_use?
-    ! self.settings['terms_of_use'].nil?
-  end
-
-  # the environment's terms of enterprise use: every enterprise member must accept them before
-  # registering or activating enterprises.
-  def terms_of_enterprise_use
-    self.settings['terms_of_enterprise_use']
-  end
-
-  # sets the environment's terms of enterprise use.
-  def terms_of_enterprise_use=(value)
-    self.settings['terms_of_enterprise_use'] = value
+    ! self.terms_of_use.blank?
   end
  
   # returns <tt>true</tt> if this Environment has terms of enterprise use to be
   # accepted by users before registration or activation of enterprises.
   def has_terms_of_enterprise_use?
-    ! self.settings['terms_of_enterprise_use'].blank?
-  end
-
-  def activation_blocked_text
-    self.settings['activation_blocked_text']
-  end
-  
-  def activation_blocked_text= value
-    self.settings['activation_blocked_text'] = value
-  end
-
-  def message_for_disabled_enterprise
-    self.settings['message_for_disabled_enterprise']
-  end
-
-  def message_for_disabled_enterprise=(value)
-    self.settings['message_for_disabled_enterprise'] = value
-  end
-
-  # the environment's default location
-  def location
-    self.settings['location']
-  end
-
-  # sets the environment's location.
-  def location=(value)
-    self.settings['location'] = value
-  end
-
-  # returns the approval method used for this environment. Possible values are:
-  #
-  # Defaults to <tt>:admim</tt>.
-  def organization_approval_method
-    self.settings['organization_approval_method'] || :admin
+    ! self.terms_of_enterprise_use.blank?
   end
  
   # Sets the organization_approval_method. Only accepts the following values:
@@ -292,17 +269,7 @@ class Environment &lt; ActiveRecord::Base
     ].map(&:to_sym)
     raise ArgumentError unless accepted_values.include?(actual_value)
  
-    self.settings['organization_approval_method'] = actual_value
-  end
-
-  # the description of the environment. Normally used in the homepage.
-  def description
-    self.settings[:description]
-  end
-
-  # sets the #description of the environment
-  def description=(value)
-    self.settings[:description] = value
+    self.settings[:organization_approval_method] = actual_value
   end
  
   def terminology
@@ -370,22 +337,6 @@ class Environment &lt; ActiveRecord::Base
     end
   end
  
-  def message_for_friend_invitation
-    self.settings['message_for_friend_invitation'] || InviteFriend.mail_template
-  end
-
-  def message_for_friend_invitation=(value)
-    self.settings['message_for_friend_invitation'] = value
-  end
-
-  def message_for_member_invitation
-    self.settings['message_for_member_invitation'] || InviteMember.mail_template
-  end
-
-  def message_for_member_invitation=(value)
-    self.settings['message_for_member_invitation'] = value
-  end
-
   def custom_enterprise_fields
     self.settings[:custom_enterprise_fields].nil? ? {} : self.settings[:custom_enterprise_fields]
   end
@@ -440,27 +391,6 @@ class Environment &lt; ActiveRecord::Base
     required_fields
   end
  
-  def category_types
-    self.settings[:category_types].nil? ? ['Category'] : self.settings[:category_types]
-  end
-
-  def category_types=(values)
-    self.settings[:category_types] = values
-  end
-
-  # Whether this environment should force having 'www.' in its domain name or
-  # not. Defauls to false.
-  #
-  # See also #default_hostname
-  def force_www
-    settings[:force_www] || false
-  end
-
-  # Sets the value of #force_www. <tt>value</tt> must be a boolean.
-  def force_www=(value)
-    settings[:force_www] = value
-  end
-
   # #################################################
   # Validations
   # #################################################
@@ -512,14 +442,6 @@ class Environment &lt; ActiveRecord::Base
     result
   end
  
-  def enable_ssl
-    settings[:enable_ssl]
-  end
-
-  def enable_ssl=(value)
-    settings[:enable_ssl] = value
-  end
-
   def to_s
     self.name || '?'
   end
@@ -542,10 +464,6 @@ class Environment &lt; ActiveRecord::Base
     end
   end
  
-  def theme
-    self[:theme] || 'default'
-  end
-
   def themes
     if settings[:themes]
       Theme.system_themes.select { |theme| settings[:themes].include?(theme.id) }
@@ -558,21 +476,6 @@ class Environment &lt; ActiveRecord::Base
     settings[:themes] = values.map(&:id)
   end
  
-  def icon_theme
-    settings[:icon_theme] || 'default'
-  end
-  def icon_theme=(theme)
-    settings[:icon_theme] = theme
-  end
-
-  def layout_template
-    settings[:layout_template] || 'default'
-  end
-
-  def layout_template=(value)
-    settings[:layout_template] = value
-  end
-
   def community_template
     Community.find_by_id settings[:community_template_id]
   end
@@ -641,30 +544,6 @@ class Environment &lt; ActiveRecord::Base
     settings[:portal_folders] = folders ? folders.map(&:id) : nil
   end
  
-  def news_amount_by_folder
-    (settings[:news_amount_by_folder] || 4)
-  end
-
-  def news_amount_by_folder=(amount)
-    settings[:news_amount_by_folder] = amount.to_i
-  end
-
-  def help_message_to_add_enterprise
-    self.settings['help_message_to_add_enterprise'] || ''
-  end
-
-  def help_message_to_add_enterprise=(value)
-    self.settings['help_message_to_add_enterprise'] = value
-  end
-
-  def tip_message_enterprise_activation_question
-    self.settings['tip_message_enterprise_activation_question'] || ''
-  end
-
-  def tip_message_enterprise_activation_question=(value)
-    self.settings['tip_message_enterprise_activation_question'] = value
-  end
-
   def portal_news_cache_key
     "home-page-news/#{cache_key}"
   end
@@ -697,12 +576,4 @@ class Environment &lt; ActiveRecord::Base
     end
   end
  
-  def local_docs
-    settings[:local_docs] || []
-  end
-
-  def local_docs=(value)
-    settings[:local_docs] = value
-  end
-
 end
@@ -605,10 +605,6 @@ private :generate_url, :url_options
  
   settings_items :layout_template, :type => String, :default => 'default'
  
-  def boxes_limit
-    LayoutTemplate.find(layout_template).number_of_boxes
-  end
-
   has_many :blogs, :source => 'articles', :class_name => 'Blog'
  
   def blog
@@ -41,7 +41,7 @@
   <%= render :partial => 'profile_editor/person_form', :locals => {:f => f} %>
 <% end %>
  
-<% if @terms_of_use %>
+<% unless @terms_of_use.blank? %>
   <div id='terms-of-use-box' class='formfieldline'>
     <%= _("By clicking on 'I accept the terms of use' below you are agreeing to the %s") %
     link_to_function(_('Terms of use'), nil) do |page|
@@ -9,7 +9,7 @@
 <% end %>
 </p>
  
-<% if @environment.activation_blocked_text.nil? %>
+<% if @environment.activation_blocked_text.blank? %>
   <%= _('Your enterprise has been blocked') %>
 <% else %>
   <%= @environment.activation_blocked_text %>
@@ -29,8 +29,9 @@ module ActsAsHavingBoxes
   # returns 3 unless the class table has a boxes_limit column. In that case
   # return the value of the column. 
   def boxes_limit
-    self[:boxes_limit] || 3
+    LayoutTemplate.find(layout_template).number_of_boxes || 3
   end
+
 end
  
 ActiveRecord::Base.extend(ActsAsHavingBoxes::ClassMethods)
@@ -76,9 +76,8 @@ class EnvironmentTest &lt; Test::Unit::TestCase
     assert_nil v.terms_of_use
     v.terms_of_use = ""
     assert v.save
+    v.reload
     assert !v.has_terms_of_use?
-    id = v.id
-    assert_nil Environment.find(v.id).terms_of_use
   end
  
   def test_has_terms_of_use
@@ -102,6 +101,8 @@ class EnvironmentTest &lt; Test::Unit::TestCase
     assert !v.has_terms_of_enterprise_use?
     v.terms_of_enterprise_use = 'some terms of enterprise use'
     assert v.has_terms_of_enterprise_use?
+    v.terms_of_enterprise_use = ''
+    assert !v.has_terms_of_enterprise_use?
   end
  
   def test_should_list_top_level_categories
...	...	@@ -161,15 +161,47 @@ class Environment < ActiveRecord::Base
161	161	# #################################################
162	162
163	163	# store the Environment settings as YAML-serialized Hash.
164		- serialize :settings
	164	+ acts_as_having_settings :field => :settings
165	165
166		- def homepage
167		- settings[:homepage]
168		- end
	166	+ # the environment's terms of use: every user must accept them before registering.
	167	+ settings_items :terms_of_use, :type => String
	168	+
	169	+ # the environment's terms of enterprise use: every enterprise member must accept them before
	170	+ # registering or activating enterprises.
	171	+ settings_items :terms_of_enterprise_use, :type => String
169	172
170		- # returns a Hash containing the Environment configuration
171		- def settings
172		- self[:settings] \|\|= {}
	173	+ # returns the approval method used for this environment. Possible values are:
	174	+ #
	175	+ # Defaults to <tt>:admim</tt>.
	176	+ settings_items :organization_approval_method, :type => Symbol, :default => :admin
	177	+
	178	+ # Whether this environment should force having 'www.' in its domain name or
	179	+ # not. Defauls to false.
	180	+ #
	181	+ # Sets the value of #force_www. <tt>value</tt> must be a boolean.
	182	+ #
	183	+ # See also #default_hostname
	184	+ settings_items :force_www, :default => false
	185	+
	186	+ settings_items :message_for_friend_invitation, :type => String, :default => InviteFriend.mail_template
	187	+ settings_items :message_for_member_invitation, :type => String, :default => InviteMember.mail_template
	188	+ settings_items :activation_blocked_text, :type => String
	189	+ settings_items :message_for_disabled_enterprise, :type => String
	190	+ settings_items :location, :type => String
	191	+ settings_items :layout_template, :type => String, :default => 'default'
	192	+ settings_items :homepage, :type => String
	193	+ settings_items :description, :type => String
	194	+ settings_items :category_types, :type => Array, :default => ['Category']
	195	+ settings_items :enable_ssl
	196	+ settings_items :theme, :type => String, :default => 'default'
	197	+ settings_items :icon_theme, :type => String, :default => 'default'
	198	+ settings_items :local_docs, :type => Array, :default => []
	199	+ settings_items :news_amount_by_folder, :type => Integer, :default => 4
	200	+ settings_items :help_message_to_add_enterprise, :type => String, :default => ''
	201	+ settings_items :tip_message_enterprise_activation_question, :type => String, :default => ''
	202	+
	203	+ def news_amount_by_folder=(amount)
	204	+ settings[:news_amount_by_folder] = amount.to_i
173	205	end
174	206
175	207	# Enables a feature identified by its name
...	...	@@ -201,71 +233,16 @@ class Environment < ActiveRecord::Base
201	233	end
202	234	end
203	235
204		- # the environment's terms of use: every user must accept them before
205		- # registering.
206		- def terms_of_use
207		- self.settings['terms_of_use']
208		- end
209		-
210		- # sets the environment's terms of use.
211		- def terms_of_use=(value)
212		- self.settings['terms_of_use'] = value.blank? ? nil : value
213		- end
214		-
215	236	# returns <tt>true</tt> if this Environment has terms of use to be
216	237	# accepted by users before registration.
217	238	def has_terms_of_use?
218		- ! self.settings['terms_of_use'].nil?
219		- end
220		-
221		- # the environment's terms of enterprise use: every enterprise member must accept them before
222		- # registering or activating enterprises.
223		- def terms_of_enterprise_use
224		- self.settings['terms_of_enterprise_use']
225		- end
226		-
227		- # sets the environment's terms of enterprise use.
228		- def terms_of_enterprise_use=(value)
229		- self.settings['terms_of_enterprise_use'] = value
	239	+ ! self.terms_of_use.blank?
230	240	end
231	241
232	242	# returns <tt>true</tt> if this Environment has terms of enterprise use to be
233	243	# accepted by users before registration or activation of enterprises.
234	244	def has_terms_of_enterprise_use?
235		- ! self.settings['terms_of_enterprise_use'].blank?
236		- end
237		-
238		- def activation_blocked_text
239		- self.settings['activation_blocked_text']
240		- end
241		-
242		- def activation_blocked_text= value
243		- self.settings['activation_blocked_text'] = value
244		- end
245		-
246		- def message_for_disabled_enterprise
247		- self.settings['message_for_disabled_enterprise']
248		- end
249		-
250		- def message_for_disabled_enterprise=(value)
251		- self.settings['message_for_disabled_enterprise'] = value
252		- end
253		-
254		- # the environment's default location
255		- def location
256		- self.settings['location']
257		- end
258		-
259		- # sets the environment's location.
260		- def location=(value)
261		- self.settings['location'] = value
262		- end
263		-
264		- # returns the approval method used for this environment. Possible values are:
265		- #
266		- # Defaults to <tt>:admim</tt>.
267		- def organization_approval_method
268		- self.settings['organization_approval_method'] \|\| :admin
	245	+ ! self.terms_of_enterprise_use.blank?
269	246	end
270	247
271	248	# Sets the organization_approval_method. Only accepts the following values:
...	...	@@ -292,17 +269,7 @@ class Environment < ActiveRecord::Base
292	269	].map(&:to_sym)
293	270	raise ArgumentError unless accepted_values.include?(actual_value)
294	271
295		- self.settings['organization_approval_method'] = actual_value
296		- end
297		-
298		- # the description of the environment. Normally used in the homepage.
299		- def description
300		- self.settings[:description]
301		- end
302		-
303		- # sets the #description of the environment
304		- def description=(value)
305		- self.settings[:description] = value
	272	+ self.settings[:organization_approval_method] = actual_value
306	273	end
307	274
308	275	def terminology
...	...	@@ -370,22 +337,6 @@ class Environment < ActiveRecord::Base
370	337	end
371	338	end
372	339
373		- def message_for_friend_invitation
374		- self.settings['message_for_friend_invitation'] \|\| InviteFriend.mail_template
375		- end
376		-
377		- def message_for_friend_invitation=(value)
378		- self.settings['message_for_friend_invitation'] = value
379		- end
380		-
381		- def message_for_member_invitation
382		- self.settings['message_for_member_invitation'] \|\| InviteMember.mail_template
383		- end
384		-
385		- def message_for_member_invitation=(value)
386		- self.settings['message_for_member_invitation'] = value
387		- end
388		-
389	340	def custom_enterprise_fields
390	341	self.settings[:custom_enterprise_fields].nil? ? {} : self.settings[:custom_enterprise_fields]
391	342	end
...	...	@@ -440,27 +391,6 @@ class Environment < ActiveRecord::Base
440	391	required_fields
441	392	end
442	393
443		- def category_types
444		- self.settings[:category_types].nil? ? ['Category'] : self.settings[:category_types]
445		- end
446		-
447		- def category_types=(values)
448		- self.settings[:category_types] = values
449		- end
450		-
451		- # Whether this environment should force having 'www.' in its domain name or
452		- # not. Defauls to false.
453		- #
454		- # See also #default_hostname
455		- def force_www
456		- settings[:force_www] \|\| false
457		- end
458		-
459		- # Sets the value of #force_www. <tt>value</tt> must be a boolean.
460		- def force_www=(value)
461		- settings[:force_www] = value
462		- end
463		-
464	394	# #################################################
465	395	# Validations
466	396	# #################################################
...	...	@@ -512,14 +442,6 @@ class Environment < ActiveRecord::Base
512	442	result
513	443	end
514	444
515		- def enable_ssl
516		- settings[:enable_ssl]
517		- end
518		-
519		- def enable_ssl=(value)
520		- settings[:enable_ssl] = value
521		- end
522		-
523	445	def to_s
524	446	self.name \|\| '?'
525	447	end
...	...	@@ -542,10 +464,6 @@ class Environment < ActiveRecord::Base
542	464	end
543	465	end
544	466
545		- def theme
546		- self[:theme] \|\| 'default'
547		- end
548		-
549	467	def themes
550	468	if settings[:themes]
551	469	Theme.system_themes.select { \|theme\| settings[:themes].include?(theme.id) }
...	...	@@ -558,21 +476,6 @@ class Environment < ActiveRecord::Base
558	476	settings[:themes] = values.map(&:id)
559	477	end
560	478
561		- def icon_theme
562		- settings[:icon_theme] \|\| 'default'
563		- end
564		- def icon_theme=(theme)
565		- settings[:icon_theme] = theme
566		- end
567		-
568		- def layout_template
569		- settings[:layout_template] \|\| 'default'
570		- end
571		-
572		- def layout_template=(value)
573		- settings[:layout_template] = value
574		- end
575		-
576	479	def community_template
577	480	Community.find_by_id settings[:community_template_id]
578	481	end
...	...	@@ -641,30 +544,6 @@ class Environment < ActiveRecord::Base
641	544	settings[:portal_folders] = folders ? folders.map(&:id) : nil
642	545	end
643	546
644		- def news_amount_by_folder
645		- (settings[:news_amount_by_folder] \|\| 4)
646		- end
647		-
648		- def news_amount_by_folder=(amount)
649		- settings[:news_amount_by_folder] = amount.to_i
650		- end
651		-
652		- def help_message_to_add_enterprise
653		- self.settings['help_message_to_add_enterprise'] \|\| ''
654		- end
655		-
656		- def help_message_to_add_enterprise=(value)
657		- self.settings['help_message_to_add_enterprise'] = value
658		- end
659		-
660		- def tip_message_enterprise_activation_question
661		- self.settings['tip_message_enterprise_activation_question'] \|\| ''
662		- end
663		-
664		- def tip_message_enterprise_activation_question=(value)
665		- self.settings['tip_message_enterprise_activation_question'] = value
666		- end
667		-
668	547	def portal_news_cache_key
669	548	"home-page-news/#{cache_key}"
670	549	end
...	...	@@ -697,12 +576,4 @@ class Environment < ActiveRecord::Base
697	576	end
698	577	end
699	578
700		- def local_docs
701		- settings[:local_docs] \|\| []
702		- end
703		-
704		- def local_docs=(value)
705		- settings[:local_docs] = value
706		- end
707		-
708	579	end
...	...
...	...	@@ -605,10 +605,6 @@ private :generate_url, :url_options
605	605
606	606	settings_items :layout_template, :type => String, :default => 'default'
607	607
608		- def boxes_limit
609		- LayoutTemplate.find(layout_template).number_of_boxes
610		- end
611		-
612	608	has_many :blogs, :source => 'articles', :class_name => 'Blog'
613	609
614	610	def blog
...	...
...	...	@@ -41,7 +41,7 @@
41	41	<%= render :partial => 'profile_editor/person_form', :locals => {:f => f} %>
42	42	<% end %>
43	43
44		-<% if @terms_of_use %>
	44	+<% unless @terms_of_use.blank? %>
45	45	<div id='terms-of-use-box' class='formfieldline'>
46	46	<%= _("By clicking on 'I accept the terms of use' below you are agreeing to the %s") %
47	47	link_to_function(_('Terms of use'), nil) do \|page\|
...	...
...	...	@@ -9,7 +9,7 @@
9	9	<% end %>
10	10	</p>
11	11
12		-<% if @environment.activation_blocked_text.nil? %>
	12	+<% if @environment.activation_blocked_text.blank? %>
13	13	<%= _('Your enterprise has been blocked') %>
14	14	<% else %>
15	15	<%= @environment.activation_blocked_text %>
...	...
...	...	@@ -29,8 +29,9 @@ module ActsAsHavingBoxes
29	29	# returns 3 unless the class table has a boxes_limit column. In that case
30	30	# return the value of the column.
31	31	def boxes_limit
32		- self[:boxes_limit] \|\| 3
	32	+ LayoutTemplate.find(layout_template).number_of_boxes \|\| 3
33	33	end
	34	+
34	35	end
35	36
36	37	ActiveRecord::Base.extend(ActsAsHavingBoxes::ClassMethods)
...	...
...	...	@@ -76,9 +76,8 @@ class EnvironmentTest < Test::Unit::TestCase
76	76	assert_nil v.terms_of_use
77	77	v.terms_of_use = ""
78	78	assert v.save
	79	+ v.reload
79	80	assert !v.has_terms_of_use?
80		- id = v.id
81		- assert_nil Environment.find(v.id).terms_of_use
82	81	end
83	82
84	83	def test_has_terms_of_use
...	...	@@ -102,6 +101,8 @@ class EnvironmentTest < Test::Unit::TestCase
102	101	assert !v.has_terms_of_enterprise_use?
103	102	v.terms_of_enterprise_use = 'some terms of enterprise use'
104	103	assert v.has_terms_of_enterprise_use?
	104	+ v.terms_of_enterprise_use = ''
	105	+ assert !v.has_terms_of_enterprise_use?
105	106	end
106	107
107	108	def test_should_list_top_level_categories
...	...