lib/scide/project.rb in scide-0.0.5 vs lib/scide/project.rb in scide-0.0.6

@@ -1,30 +1,65 @@
 module Scide
 
+  # Scide configuration for one project.
   class Project
-    attr_accessor :properties, :options, :path
 
-    def initialize contents, key, global
-      @global = global
+    # The project key in the projects configuration hash.
+    attr_reader :key
 
+    # The path where the project is located. See #initialize.
+    attr_reader :path
+
+    # Project-specific options. Can be used by commands. See #initialize.
+    attr_reader :options
+
+    # Returns a project configuration.
+    #
+    # If not given in the project hash, #path is built by joining
+    # the global path and <tt>key</tt>.
+    #
+    # ==== Arguments
+    # * <tt>global</tt> - The global configuration.
+    # * <tt>key</tt> - The key identifying the project. This is the
+    #   key in the projects hash.
+    # * <tt>contents</tt> - The project hash.
+    #
+    # ==== Project Options
+    #
+    # #options is built by merging the options given in the project
+    # hash with the global options.
+    #
+    # The following default options are added if not given:
+    # * <tt>name</tt> - Defaults to the project key.
+    # * <tt>path</tt> - The path where the project is located.
+    def initialize global, key, contents
+      raise ArgumentError, "project '#{key}' must be a hash" unless contents.kind_of? Hash
+      raise ArgumentError, "windows of project '#{key}' must be an array" unless contents[:windows].nil? or contents[:windows].kind_of?(Array)
+      raise ArgumentError, "options of project '#{key}' must be a hash" unless contents[:options].nil? or contents[:options].kind_of?(Hash)
+
+      @global, @key = global, key
+
+      # path defaults to project key
       @path = contents[:path].try(:to_s) || key.to_s
+      # expand from home directory if not absolute
       @path = File.join global.path, @path unless @path.match /^\//
 
-      @properties = global.properties.merge(contents[:properties] || {})
-      @properties['name'] ||= key
+      @options = global.options.dup.merge(contents[:options] || {})
+      @options[:name] ||= key
+      @options[:path] ||= @path
 
-      @options = global.options.merge(contents[:options] || {})
-
-      @windows = []
-      contents[:windows].each do |w|
-        @windows << Scide::Window.new(w, self)
-      end
+      @windows = contents[:windows].collect{ |w| Scide::Window.new self, w }
     end
 
+    # Returns a representation of this project as a GNU Screen
+    # configuration fragment. Returns nil if this project has
+    # no configured windows.
     def to_screen
+      return nil if @windows.blank?
       String.new.tap do |s|
         @windows.each_with_index do |w,i|
           s << w.to_screen(i)
+          s << "\n" if i != @windows.length - 1
         end
       end
     end
   end
 end