ActionItem6: documented the enterprise controller and the related models

git-svn-id: https://svn.colivre.coop.br/svn/noosfero/trunk@355 3f533792-8f58-4932-b0fe-aaf55b0a4547

ActionItem6: documented the enterprise controller and the related models
git-svn-id: https://svn.colivre.coop.br/svn/noosfero/trunk@355 3f533792-8f58-4932-b0fe-aaf55b0a4547
MoisesMachado
1 parent 71b98ac5
Showing 5 changed files with 17 additions and 0 deletions Show diff stats
app/controllers/enterprise_controller.rb
app/models/affiliation.rb
app/models/organization.rb
app/models/person.rb
app/models/profile.rb
@@ -3,6 +3,7 @@ class EnterpriseController &lt; ApplicationController
   before_filter :logon, :my_enterprises
+  # Redirects to show if there is only one action and to list otherwise
   def index
     if @my_enterprises.size == 1
       redirect_to :action => 'show', :id => @my_enterprises[0]
@@ -11,20 +12,24 @@ class EnterpriseController &lt; ApplicationController
     end
   end
+  # Lists all enterprises
   def list
     @enterprises = Enterprise.find(:all) - @my_enterprises
   end
+  # Show details about an enterprise
   def show
     @enterprise = @my_enterprises.find(params[:id])
   end
+  # Make a form to the creation of an eterprise
   def register_form
     @enterprise = Enterprise.new()
     @vitual_communities = VirtualCommunity.find(:all)
     @validation_entities = Organization.find(:all)
   end
+  # Saves the new created enterprise
   def register
     @enterprise = Enterprise.new(params[:enterprise])
     @enterprise.organization_info = OrganizationInfo.new(params[:organization])
@@ -40,11 +45,13 @@ class EnterpriseController &lt; ApplicationController
     end
   end
+  # Provides an interface to editing the enterprise details
   def edit
     @enterprise = @my_enterprises.find(params[:id])
     @validation_entities = Organization.find(:all) - [@enterprise]
   end
+  # Saves the changes made in an enterprise
   def update
     @enterprise = @my_enterprises.find(params[:id])
     if @enterprise.update_attributes(params[:enterprise]) && @enterprise.organization_info.update_attributes(params[:organization_info])
@@ -56,22 +63,26 @@ class EnterpriseController &lt; ApplicationController
     end
   end
+  # Make the current user a new member of the enterprise
   def affiliate
     @enterprise = Enterprise.find(params[:id])
     @enterprise.people << @person
     redirect_to :action => 'index'
   end
+  # Elimitates the enterprise of the system
   def destroy 
     @enterprise = @my_enterprises.find(params[:id])
     @enterprise.destroy
     redirect_to :action => 'index'
   end
+  # Search enterprises by name or tags
   def search
     @tagged_enterprises = Enterprise.search(params[:query])
   end
+  # Activate a validated enterprise
   def activate
     @enterprise = Enterprise.find(params[:id])
     if @enterprise.update_attribute('active', true)
@@ -84,6 +95,7 @@ class EnterpriseController &lt; ApplicationController
   protected
+  # Make sure that the user is logged before access this controller
   def logon
     if logged_in?
       @user = current_user
@@ -93,6 +105,7 @@ class EnterpriseController &lt; ApplicationController
     end
   end
+  # Initializes some variables to contain the enterprises of the current user
   def my_enterprises
     if logged_in?
       @my_active_enterprises = @person.active_enterprises
+# Affiliation it is a join model to hold affiliations of people to others profiles
 class Affiliation < ActiveRecord::Base
   belongs_to :person
   belongs_to :profile
+# Represents any organization of the system and has an organization_info object to hold its info
 class Organization < Profile
   has_one :organization_info
   has_many :validated_enterprises, :class_name => 'enterprise'
+# A person is the profile of an user holding all relationships with the rest of the system
 class Person < Profile
   ENTERPRISE = {:class_name => 'Enterprise', :through => :affiliations, :foreign_key => 'person_id', :source => 'profile'}
@@ -56,6 +56,7 @@ class Profile &lt; ActiveRecord::Base
     self.virtual_community ||= VirtualCommunity.default
   end
+  # Searches tags by tag or name
   def self.search(term)
     find_tagged_with(term) + find_all_by_name(term)
   end
		1	+# Affiliation it is a join model to hold affiliations of people to others profiles
1	class Affiliation < ActiveRecord::Base	2	class Affiliation < ActiveRecord::Base
2	belongs_to :person	3	belongs_to :person
3	belongs_to :profile	4	belongs_to :profile
		1	+# Represents any organization of the system and has an organization_info object to hold its info
1	class Organization < Profile	2	class Organization < Profile
2	has_one :organization_info	3	has_one :organization_info
3	has_many :validated_enterprises, :class_name => 'enterprise'	4	has_many :validated_enterprises, :class_name => 'enterprise'
		1	+# A person is the profile of an user holding all relationships with the rest of the system
1	class Person < Profile	2	class Person < Profile
2	ENTERPRISE = {:class_name => 'Enterprise', :through => :affiliations, :foreign_key => 'person_id', :source => 'profile'}	3	ENTERPRISE = {:class_name => 'Enterprise', :through => :affiliations, :foreign_key => 'person_id', :source => 'profile'}
3		4
	@@ -56,6 +56,7 @@ class Profile < ActiveRecord::Base		@@ -56,6 +56,7 @@ class Profile < ActiveRecord::Base
56	self.virtual_community \|\|= VirtualCommunity.default	56	self.virtual_community \|\|= VirtualCommunity.default
57	end	57	end
58		58
		59	+ # Searches tags by tag or name
59	def self.search(term)	60	def self.search(term)
60	find_tagged_with(term) + find_all_by_name(term)	61	find_tagged_with(term) + find_all_by_name(term)
61	end	62	end