environmentalist 0.1.0 → 0.2.1

data/History.txt

@@ -1,3 +1,14 @@
+=== v0.2.1
+2009-03-06
+
+* Add automatic gem install + activation (bug fix for GemInstaller pending) added to preinitializer.rb
+
+=== v0.2.0
+2009-03-02
+
+* Added preinitializer.rb to the set of the generated files for you.  It auto-loads gem dependencies as specified in geminstaller.yml files that can be distributed across your environment directories.
+* Moved gem onto jeweler (with the temporary loss of rubyforge support --- rubyforge integration has been achieved in a fork of the jeweler repo, so we should have it back once it's merged back into the main line.)
+
 === v0.1.0
 2008-08-04
 

data/{README.txt → LICENSE}

@@ -1,24 +1,3 @@
-= environmentalist
-
-* http://github.com/jtrupiano/environmentalist/tree/master
-
-== DESCRIPTION:
-Provides an executable that converts a rails app's config structure.  The basic idea is that environments themselves are now first-class citizens, allowing you to create several environments (e.g. staging, prodtest, demo, etc.) in a clean, organized fashion.  Each environment is given its own folder where it can store its own set of configuration files (think mongrel configs, apache configs, etc.) without polluting the top-leve config/ directory.
-
-== SYNOPSIS:
-
-  FIX (code sample of usage)
-
-== REQUIREMENTS:
-
-* none, but it's really only useful with a rails app
-
-== INSTALL:
-
-* sudo gem install environmentalist
-
-== LICENSE:
-
 (The MIT License)
 
 Copyright (c) 2008 FIX

data/README.textile

@@ -0,0 +1,22 @@
+h1. environmentalist
+
+* http://github.com/jtrupiano/environmentalist/tree/master
+
+h2. DESCRIPTION
+
+Provides an executable that converts a rails app's config structure.  The basic idea is that environments themselves are now first-class citizens, allowing you to create several environments (e.g. staging, prodtest, demo, etc.) in a clean, organized fashion.  Each environment is given its own folder where it can store its own set of configuration files (think mongrel configs, apache configs, etc.) without polluting the top-leve config/ directory.
+
+h2. REQUIREMENTS
+
+* none, but it's really only useful with a rails app
+
+h2. INSTALL
+
+  sudo gem install environmentalist
+
+h2. USAGE
+
+This gem is intended to be a "one-time consumption."  You use it once to alter/convert the structure of your rails app (works best with a newly-generated app).  It should <b>not</b> be included as a gem dependency for your project.
+
+  environmentalize /path/to/rails/root
+  

data/Rakefile

@@ -1,32 +1,22 @@
-# -*- ruby -*-
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
 
-require 'rubygems'
-require 'hoe'
-require './lib/environmentalist.rb'
-require "./lib/environmentalist/version"
-
-PKG_NAME      = "environmentalist"
-PKG_BUILD     = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
-version = Environmentalist::Version::STRING.dup
-if ENV['SNAPSHOT'].to_i == 1
-  version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
-end
-PKG_VERSION   = version
-PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
-
-Hoe.new(PKG_NAME, PKG_VERSION) do |p|
-  p.rubyforge_name = 'johntrupiano' # if different than lowercase project name
-  p.developer('John Trupiano', 'jtrupiano@gmail.com')
-  p.name = PKG_NAME
-  p.version = PKG_VERSION
-  p.author = "John Trupiano"
-  p.email = "jtrupiano@gmail.com"
-  p.description = %q(Provides an executable that converts a rails app's config structure.  The basic idea is that environments themselves are now first-class citizens, allowing you to create several environments (e.g. staging, prodtest, demo, etc.) in a clean, organized fashion.  Each environment is given its own folder where it can store its own set of configuration files (think mongrel configs, apache configs, etc.) without polluting the top-leve config/ direcotory.)
-  p.summary = p.description # More details later??
-  p.remote_rdoc_dir = PKG_NAME # Release to /PKG_NAME
-  #  p.changes = p.paragraphs_of('CHANGELOG', 0..1).join("\n\n")
-  p.need_zip = true
-  p.need_tar = false
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "environmentalist"
+    s.rubyforge_project = 'johntrupiano' # if different than lowercase project name
+    s.description = %q(Provides an executable that converts a rails app's config structure.  The basic idea is that environments themselves are now first-class citizens, allowing you to create several environments (e.g. staging, prodtest, demo, etc.) in a clean, organized fashion.  Each environment is given its own folder where it can store its own set of configuration files (think mongrel configs, apache configs, etc.) without polluting the top-leve config/ directory.)
+    s.summary = s.description # More details later??
+    s.email = "jtrupiano@gmail.com"
+    s.homepage = "http://github.com/jtrupiano/environmentalist"
+    s.authors = ["John Trupiano"]
+    s.executables = "environmentalize"
+    s.files =  FileList["[A-Z]*", "{bin,lib,test}/**/*"]
+    #s.add_dependency 'schacon-git'
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
-# vim: syntax=Ruby

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 2

data/bin/environmentalize

@@ -36,7 +36,6 @@ end
   end
 end
 
-#cp $GEM_HOME/environmentalist-0.1.0/conf/postboot.rb config/postboot.rb
 postboot = File.join(config_base, "postboot.rb")
 if !File.exists?(postboot)
   gem_postboot = File.dirname(__FILE__) + '/../lib/conf/postboot.rb'
@@ -44,6 +43,13 @@ if !File.exists?(postboot)
   cp(gem_postboot, postboot)
 end
 
+preinitializer = File.join(config_base, "preinitializer.rb")
+if !File.exists?(preinitializer)
+  gem_preinitializer = File.join(File.dirname(__FILE__), '..', 'lib', 'conf', 'preinitializer.rb')
+  puts "cp #{gem_preinitializer} #{preinitializer}"
+  cp(gem_preinitializer, preinitializer)
+end
+
 main_env_file = File.join(config_base, "environment.rb")
 env_contents = File.open(main_env_file).read
 if !env_contents.include?("require File.join(File.dirname(__FILE__), 'postboot')")

data/lib/conf/postboot.rb

@@ -6,20 +6,9 @@ env_dir  = File.join(RAILS_ROOT, 'config', rails_env)
 db_file  = File.join(env_dir, 'database.yml')
 env_file = File.join(env_dir, 'environment.rb')
 
-unless File.exists?(env_dir)
-  puts "#{env_dir} environment directory cannot be found."
-  exit(1)
-end
-
-unless File.exists?(db_file)
-	puts "#{db_file} is missing.  You cannot continue without this."
-	exit(1) # exit with an error code
-end
-
-unless File.exists?(env_file)
-  puts "#{env_file} environment file is missing." 
-  exit(1)
-end
+raise "#{env_dir} environment directory cannot be found." unless File.exists?(env_dir)
+raise "#{db_file} is missing.  You cannot continue without this." unless File.exists?(db_file)
+raise "#{env_file} environment file is missing." unless File.exists?(env_file)
 
 # Now, let's open up Rails and tell it to find our environment files elsewhere.
 module Rails

data/lib/conf/preinitializer.rb

@@ -0,0 +1,20 @@
+# Ensure that proper versions of gems in config/geminstaller.yml are activated.
+require 'rubygems'
+gem 'rails', '= 2.3.0'
+gem 'geminstaller', '= 0.5.2'
+require 'geminstaller'
+
+rails_env = ENV['RAILS_ENV'] || 'development'
+
+perform_install = %w(development test).include?(rails_env)
+
+# Activate gems
+common_gemfile = File.join(RAILS_ROOT, 'config', 'geminstaller.yml')
+env_gemfile    = File.join(RAILS_ROOT, "config", rails_env, "geminstaller.yml")
+
+[common_gemfile, env_gemfile].each do |file|
+  if File.exists?(file)
+    GemInstaller.install("--exceptions --config=#{common_gemfile}") if perform_install
+    GemInstaller.autogem("--exceptions --config=#{common_gemfile}")
+  end
+end

data/test/rails210test/README

@@ -0,0 +1,256 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel and lighttpd if they are installed, otherwise
+Rails will use WEBrick, the webserver that ships with Ruby. When you run script/server,
+Rails will check if Mongrel exists, then lighttpd and finally fall back to WEBrick. This ensures
+that you can always get up and running quickly.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+If Mongrel is not installed, Rails will look for lighttpd. It's considerably faster than
+Mongrel and WEBrick and also suited for production use, but requires additional
+installation and currently only works well on OS X/Unix (Windows users are encouraged
+to start with Mongrel). We recommend version 1.4.11 and higher. You can download it from
+http://www.lighttpd.net.
+
+And finally, if neither Mongrel or lighttpd are installed, Rails will use the built-in Ruby
+web server, WEBrick. WEBrick is a small Ruby web server suitable for development, but not
+for production.
+
+But of course its also possible to run Rails on any platform that supports FCGI.
+Apache, LiteSpeed, IIS are just a few. For more information on FCGI,
+please visit: http://wiki.rubyonrails.com/rails/pages/FastCGI
+
+
+== Apache .htaccess example
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.