geminstaller 0.2.4 → 0.2.5

data/History.txt

@@ -1,5 +1,9 @@
 == 0.x.y / yyyy-mm-dd
 
+== 0.2.5 / 2007-10-24
+* Add 'include_config' directive to yaml config file, allowing other files to be included via ERB.
+* Fix broken links in docs - patch from  Maciej Kozak (macio)
+
 == 0.2.4 / 2007-10-21
 * Look for config file at config/geminstaller.yml as well as geminstaller.yml
 * Make startup message ('Installing Gems...') debug level instead of info

data/TODO.txt

@@ -3,6 +3,8 @@
 * Figure out how to suppress webrick messages from embedded gem server
 * Allow array or eval'able string of gems to be passed as --gems arg or instead of args
 * Add @options[:gems], should be parsed from command line
+* Add warning that environment is not passed via sudo
+* document include_config in yaml
 =============== 0.2.6
 * Understand environment.rb vs boot.rb (bottom line: env is not processed before Initializer, so can't be used to load rails gems).  Add doc references.
 * docs - clean up sudo section.  Should be clearer about sudoers entry, and make sure that NOPASSWD is the last entry.

data/lib/geminstaller/config_builder.rb

@@ -24,9 +24,14 @@ module GemInstaller
         file_contents = @file_reader.read(path)
         next unless file_contents
         next if file_contents.empty?
-        @output_filter.geminstaller_output(:debug,"Found GemInstaller config file at: #{File.expand_path(path)}\n")        
-        file_contents_erb = ERB.new(%{#{file_contents}})
-        yaml = @yaml_loader.load(file_contents_erb.result)
+        expanded_path = File.expand_path(path)
+        @output_filter.geminstaller_output(:debug,"Found GemInstaller config file at: #{expanded_path}\n")
+        erb = ERB.new(%{#{file_contents}})
+        erb_result = nil
+        Dir.chdir(File.dirname(expanded_path)) do |yaml_file_dir|
+          erb_result = erb.result(include_config_binding)
+        end
+        yaml = @yaml_loader.load(erb_result)
         merged_defaults.merge!(yaml['defaults']) unless yaml['defaults'].nil?
         next unless yaml['gems']
         yaml['gems'].each do |gem|
@@ -41,5 +46,15 @@ module GemInstaller
       config = GemInstaller::Config.new(merged_yaml)
       config
     end
+  
+    def include_config_binding
+      def include_config(config_file)
+        Dir.chdir(File.dirname(config_file)) do |yaml_file_dir|
+          erb = File.open(config_file) { |io| ERB.new(io.read) }
+          erb.result(include_config_binding)
+        end
+      end
+      binding
+    end
   end
 end

data/lib/geminstaller.rb

@@ -29,7 +29,7 @@ module GemInstaller
   end
 
   def self.version
-    "0.2.4"
+    "0.2.5"
   end
 
   def self.create_application(args = [], registry = nil)

data/website/src/documentation/documentation.page

@@ -26,6 +26,7 @@ h2. Table of Contents
 ** "<code>fix_dependencies</code> config property":#fix_dependencies_config_property
 ** "<code>no_autogem</code> config property":#no_autogem_config_property
 ** "<code>prefer_binary_platform</code> config property":#prefer_binary_platform_config_property
+** "<code>include_config</code> directive":#include_config
 * "Using GemInstaller with Ruby on Rails or Other Ruby Apps":#using_geminstaller_with_ruby_on_rails_or_other_ruby_apps
 ** "Invoking <code>GemInstaller</code> from Rails":#invoking_geminstaller_from_rails
 ** "Bootstrapping Rails with GemInstaller":#bootstrapping_rails_with_geminstaller
@@ -153,6 +154,8 @@ h3(#sudo_option). <code>--sudo</code> option
 
 The <code>--sudo</code> option runs GemInstaller as root by using the <code>sudo</code> command.  This command is neither valid nor necessary on Windows platforms.  See the "Dealing with sudo and root-owned RubyGem installations":#dealing_with_sudo section for more details.
 
+NOTE: As a security feature, the sudo command does NOT pass along the current environment.  That means that if you use the <code>--sudo</code> option, environment variables that are currently set will NOT be available to GemInstaller config files.  There are options to get around this - read the docs on sudoers for your unix distro.
+
 h3(#silent_option). <code>--silent</code> option
 
 The <code>--silent</code> option suppresses all RubyGems output except fatal errors/exceptions.  It overrides the <code>--geminstaller-output</code> and <code>--rubygems-output</code> options.
@@ -237,6 +240,35 @@ Defaults to true.  GemInstaller automatically guesses at the correct platform fo
 
 This option determines whether the 'ruby' platform, or a 'binary' platform will be chosen first.  By default, binary platforms will be chosen if there is one available which seems to match the platform of the current machine.  In practice, this usually only applies to windows, since (hopefully) most gems which need to be compiled distribute a windows-specific precompiled gem version.  See "Automatic Platform Detection":#automatic_platform_detection for more info.
 
+h3(#include_config). <code>include_config</code> directive
+
+Inside a GemInstaller yaml config file, you can use the <code>include_config</code> directive to include another config file via ERB.  This also works recursively - included files can include other files.
+
+This is an alternative to specifying multiple files in the <code>--config</code> command line option - it allows you to abstract out common portions of config files across multiple files, while still only having to specify a single top-level config file.  
+
+GemInstaller also ensures that the working directory is set to the directory containing the current yaml file - NOT the directory that <code>geminstaller</code> was invoked from.  This allows you to use <code>include_config</code> to reference yaml files relative to each other.  Here's an example:
+
+<pre>
+\---
+# .../geminstaller.yml
+gems:
+<%= include_config("#{File.expand_path(File.dirname(__FILE__))}/subdir1/included_gem_config1.yml") %>
+</pre>
+
+<pre>
+\---
+# .../subdir1/included_gem_config1.yml
+  - name: testgem1
+<%= include_config("#{File.expand_path(File.dirname(__FILE__))}/../subdir2/included_gem_config2.yml") %>
+</pre>
+
+<pre>
+\---
+# .../subdir2/included_gem_config2.yml
+  - name: testgem2
+</pre>
+
+
 h2(#using_geminstaller_with_ruby_on_rails_or_other_ruby_apps). Using GemInstaller with Ruby on Rails or Other Ruby Apps
 
 GemInstaller can also be embedded in another application, such as a Rails app.  This is done by invoking the GemInstaller class or the geminstaller executable directly from Ruby.  This section only contains a brief explanation, see the tutorial on "Integrating GemInstaller into Ruby on Rails":#integrating_geminstaller_into_ruby_on_rails for detailed explanation.

data/website/src/documentation/index.page

@@ -52,7 +52,7 @@ require "rubygems"
 require "geminstaller"
 
 # Path(s) to your GemInstaller config file(s)
-config_paths = "#{File.expand_path(RAILS_ROOT)}/config/geminstaller.yml" 
+config_paths = "#{File.expand_path(RAILS_ROOT)}/config/geminstaller.yml"
 
 # Arguments which will be passed to GemInstaller
 args = "--config #{config_paths}"
@@ -64,7 +64,7 @@ args += " --exceptions"
 # This will use sudo by default on all non-windows platforms, but requires an entry in your
 # sudoers file to avoid having to type a password.  It can be omitted if you don't want to use sudo.
 # See http://geminstaller.rubyforge.org/documentation/documentation.html#dealing_with_sudo
-args += " --sudo" unless RUBY_PLATFORM =~ /mswin/ 
+args += " --sudo" unless RUBY_PLATFORM =~ /mswin/
 
 # The 'install' method will auto-install gems as specified by the args and config
 GemInstaller.run(args)
@@ -83,4 +83,4 @@ unless defined?(Rails::Initializer)
 
 h2. Where to go next
 
-See the "Tutorials":documentation/tutorials.html or the "Detailed Documentation":documentation/documentation.html for examples of more GemInstaller features.
+See the "Tutorials":tutorials.html or the "Detailed Documentation":documentation.html for examples of more GemInstaller features.

data/website/src/index.page

@@ -34,12 +34,15 @@ GemInstaller was created by "Chad Woolley":http://www.thewoolleyweb.com.
 
 h2(#known_bugs). Known Bugs
 
-Currently (as of version 0.2.4), the only _major_ known bug is related to auto-installing the Rails or Mongrel gems via boot.rb during startup of Mongrel or Webrick.  The simple workaround is to run GemInstaller manually or just restart Rails anytime GemInstaller auto-installs a Rails/Mongrel gem upgrade during app startup.  For Rails and other deployable apps, you can also "run GemInstaller from Capistrano":documentation/tutorials.html#running_geminstaller_from_capistrano to avoid this problem in demo/production environments.  Researching and fixing this problem is a top priority.  I bet there's another bug or twoo, so please "report them if you find them":http://rubyforge.org/tracker/?group_id=1902!
+Currently, the only _major_ known bug is related to auto-installing the Rails or Mongrel gems via boot.rb during startup of Mongrel or Webrick.  The simple workaround is to run GemInstaller manually or just restart Rails anytime GemInstaller auto-installs a Rails/Mongrel gem upgrade during app startup.  For Rails and other deployable apps, you can also "run GemInstaller from Capistrano":documentation/tutorials.html#running_geminstaller_from_capistrano to avoid this problem in demo/production environments.  I bet there's another bug or twoo, so please "report them if you find them":http://rubyforge.org/tracker/?group_id=1902!
 
 There's also some leakage of gem doc warning messages even if you turn down --rubygems-output, but these can be ignored (these same messages show up when installing gems manually).  This should be fixed soon.
 
 h2(#history). History
 
+* 0.2.5
+** Add 'include_config' directive to yaml config file, allowing other files to be included via ERB.
+** Fix broken links in docs - patch from  Maciej Kozak (macio)
 * 0.2.4
 ** Look for config file at config/geminstaller.yml as well as geminstaller.yml
 ** make startup message ('Installing Gems...') debug level instead of info

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: geminstaller
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
-date: 2007-10-21 00:00:00 -07:00
+  version: 0.2.5
+date: 2007-10-24 00:00:00 -07:00
 summary: GemInstaller provides automated management of RubyGems.
 require_paths: 
 - lib