ref: refs/heads/master
commit c854f9ef73fa6351ceaf6ca8c447181613e97fea
Author: Josef Reidinger
Date: Fri Aug 14 15:11:39 2009 +0200
provide more documentation
---
.../app/controllers/basesystem_controller.rb | 4 ++--
plugins/basesystem/app/models/basesystem.rb | 10 ++++++++++
2 files changed, 12 insertions(+), 2 deletions(-)
diff --git a/plugins/basesystem/app/controllers/basesystem_controller.rb b/plugins/basesystem/app/controllers/basesystem_controller.rb
index 7e81f88..4f49eb9 100644
--- a/plugins/basesystem/app/controllers/basesystem_controller.rb
+++ b/plugins/basesystem/app/controllers/basesystem_controller.rb
@@ -1,6 +1,6 @@
# = Base system controller
-# Provides access to language settings for authentificated users.
-# Main goal is checking permissions.
+# Provides access to queue for basic system setup.
+# It is really quite thin layer.
class LanguageController < ApplicationController
before_filter :login_required
diff --git a/plugins/basesystem/app/models/basesystem.rb b/plugins/basesystem/app/models/basesystem.rb
index ddcf9fc..8eb27f5 100644
--- a/plugins/basesystem/app/models/basesystem.rb
+++ b/plugins/basesystem/app/models/basesystem.rb
@@ -1,4 +1,6 @@
# = Base system model
+# Provides access to basic system settings module queue. Provides and updates
+# currently reached state in queue.
class Basesystem
# steps needed by base system
@@ -6,10 +8,14 @@ class Basesystem
# current step to finish
attr_accessor :current
+ # path to file which defines module queue
STEPS_FILE = File.join(File.dirname(__FILE__),"..","..","config","basesystemsteps.conf")
+ # path to file which store module then is next in queue or END_STRING if all steps is done
CURRENT_STEP_FILE = File.join(File.dirname(__FILE__),"..","..","var","currentstep")
+ # keyword that signalize finish of all steps
END_STRING = "FINISH"
+ #Gets instance of Basesystem with initialized steps queue.
def initialize
@steps = Array.new
#load steps configuration
@@ -20,6 +26,7 @@ class Basesystem
fh.close
end
+ #Gets instance of Basesystem with initialized steps queue and current step
def Basesystem.find
ret = Basesystem.new
unless File.exist?(CURRENT_STEP_FILE)
@@ -37,6 +44,7 @@ class Basesystem
return ret
end
+ #stores to system Basesystem settings
def save
#check if current is valid
unless @steps.include?(@current) or @current == END_STRING
@@ -48,6 +56,7 @@ class Basesystem
cur.close
end
+ #serialize part of Basesystem to xml
def to_xml( options = {} )
xml = options[:builder] ||= Builder::XmlMarkup.new(options)
xml.instruct! unless options[:skip_instruct]
@@ -57,6 +66,7 @@ class Basesystem
end
end
+ #serialize part of Basesystem to json
def to_json( options = {} )
hash = Hash.from_xml(to_xml())
return hash.to_json
--
To unsubscribe, e-mail: yast-commit+unsubscribe@opensuse.org
For additional commands, e-mail: yast-commit+help@opensuse.org