lib/imw/boot.rb in imw-0.1.1 vs lib/imw/boot.rb in imw-0.2.0

@@ -1,38 +1,84 @@
+require 'imw/utils/extensions/hash'
+
 module IMW
+
+  # IMW looks for configuration settings in the following places, in
+  # order of increasing precedence:
+  #
+  #   1. Settings defined directly in this file.
+  #
+  #   2. From the <tt>etc/imwrc</tt> file in the IMW root directory.
+  #
+  #   3. From the <tt>.imwrc</tt> file in the user's home directory (the
+  #      filename can be changed; see
+  #      <tt>IMW::Config::USER_CONFIG_FILE_BASENAME</tt>).
+  #
+  #   4. From the file defined by the environment variable +IMWRC+ (the
+  #      value can be changed; see
+  #      <tt>IMW::Config::USER_CONFIG_FILE_ENV_VARIABLE</tt>
+  #
+  # Settings not found in one configuration location will be searched
+  # for in locations of lesser precedence.
+  #
+  # *Note:* configuration files are plain Ruby code that will be directly
+  # evaluated.
+  #
+  # Relevant settings include
+  #
+  # * interfaces with external programs (+tar+, +wget+, &c.)
+  # * paths to directories where IMW reads/writes files
+  # * correspondences between file extensions and IMW file classes
+  #
+  # For more detailed information, see the default configuration file,
+  # <tt>etc/imwrc</tt>.
   module Config
 
     # Root of the IMW source base.
     def self.imw_root
       File.expand_path File.join(File.dirname(__FILE__), '../..')
     end
 
     #
     # User configuration file
     #
-    # By default, the file ~/.imwrc (.imwrc, in your home directory -- note no .rb extension)
-    # is sourced at top level.  If the $IMWRC environment variable is set,
-    # that file will be sourced instead.
+    # By default, the file ~/.imwrc (.imwrc, in your home directory --
+    # note no .rb extension) is sourced at top level.  If the $IMWRC
+    # environment variable is set, that file will be sourced instead.
     #
-    # Any code within this file will override settings in IMW_ROOT/etc/imwrc.rb
+    # Any code within this file will override settings in
+    # /etc/imwrc.rb which itself overrides IMW_ROOT/etc/imwrc.rb
     #
     USER_CONFIG_FILE = File.join(ENV['HOME'] || '', '.imwrc')
     # Environment variable to override user configuration file location.
     ENV_CONFIG_FILE = "IMWRC"
     def self.user_config_file # :nodoc:
       File.expand_path(ENV[ENV_CONFIG_FILE] || USER_CONFIG_FILE)
     end
 
-    # System-level config file
-    SITE_CONFIG_FILE = "etc/imwrc.rb"
+    # Path to site-wide config file (overwrites IMW defaults but
+    # overridden by user defaults).
+    SITE_CONFIG_FILE = "/etc/imwrc.rb"
     def self.site_config_file # :nodoc:
-      File.join(imw_root, SITE_CONFIG_FILE)
+      SITE_CONFIG_FILE
     end
 
+    def self.default_config_file # :nodoc:
+      File.join(imw_root, "etc/imwrc.rb")
+    end
+    
     # Source the config files
     def self.load_config
-      require site_config_file
-      load    user_config_file   if File.exist? user_config_file
+      if File.exist?(user_config_file)
+        load user_config_file
+      end
+
+      if File.exist?(site_config_file)
+        load site_config_file
+      end
+
+      load default_config_file
+      
     end
   end
 end
 
 #