rails-app-installer 0.1.5 → 0.2.0

data/README

@@ -5,21 +5,20 @@ This installer was originally part of Typo (http://typosphere.org).
 
 = Adding the installer to your Rails app
 
-To add the installer to your application, copy the `installer` file from the
-examples directory into your project's `bin` directory, and rename it to match
-your application name. For example, Typo's installer lives in `bin/typo`. Then
-modify your installer as needed, customizing the application name, support
-address, and required Rails version. Once this is complete, create an
-`installer` directory for your app and copy
-`examples/rails_installer_defaults.yml` into it. You can probably use it
-unchanged.
+To add the installer to your application, cd to your application's directory
+and run 'rails-app-installer-setup APPNAME'. This will create several files,
+including 'bin/APPNAME' and 'lib/tasks/release.rake'. Edit these files to make
+sure that they're appropriate for your application and then add them to your
+revision control system.
 
 You should now be able to test the installer like this:
 
     $ ruby ./bin/my_installer install /tmp/foo cwd
 
 This will try to install your app in `/tmp/foo` using the current directory as
-a template.  If you leave off the `cwd` option at the end, then the installer will look for the most recent Ruby GEM for your app, using the `application_name` line from the installer as the gem name.
+a template. If you leave off the `cwd` option at the end, then the installer
+will look for the most recent Ruby GEM for your app, using the
+`application_name` line from the installer as the gem name.
 
 = Creating a Gem
 

data/bin/rails-app-installer-setup

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rails-installer'
+
+def usage
+  STDERR.puts "Usage:"
+  STDERR.puts "  rails-app-installer-setup APPNAME"
+  STDERR.puts ""
+  STDERR.puts "  APPNAME is the name of your application; it should be"
+  STDERR.puts "  both the .gem name and the name of your installer."
+  STDERR.puts ""
+  STDERR.puts "  Please run this command form the root of your Rails project."
+end
+
+
+# $ rails-app-installer-setup APPNAME
+
+appname = ARGV[0]
+
+unless appname and appname =~ /^[a-z][-_a-z0-9]+$/
+  usage
+  exit(1)
+end
+
+installer = RailsInstaller.new('.')
+
+# Check for Rails in cwd
+unless installer.is_valid_rails_directory?
+  STDERR.puts "Please run this command from the root of a valid Rails project"
+  exit(1)
+end
+
+# Find GEM
+
+gem_directory = installer.find_source_directory 'rails-app-installer'
+
+# Copy files from GEM IFF they don't already exist.
+
+files_to_copy = {
+  'examples/installer' => "bin/#{appname}",
+  'examples/rails_installer_defaults.yml' => 'installer/rails_installer_defaults.yml',
+  'examples/apache13.conf.example.template' => 'installer/apache13.conf.example.template',
+  'examples/apache20.conf.example.template' => 'installer/apache20.conf.example.template',
+  'examples/lighttpd.conf.example.template' => 'installer/lighttpd.conf.example.template',
+  'examples/release.rake' => 'lib/tasks/release.rake'
+}
+
+files_to_copy.each do |from, to|
+  next if File.exists? to
+  puts "  creating #{to}"
+  FileUtils.mkdir_p File.dirname(to) rescue nil
+  contents = File.read File.join(gem_directory,from)
+
+  File.open(to,'w') do |out|
+    out.write contents.gsub(/\$APPNAME/,appname)
+  end
+  
+  if to=~/^bin/
+    File.chmod(0755,to)
+  end
+end
+
+puts "Successfully created an installer for your application."
+puts
+puts "Your next steps:"
+puts " 1.  Verify bin/#{appname} and lib/tasks/release.rake to make sure that they're"
+puts "     correct.  Remove all 'FIXME's."
+puts " 2.  Create db/schema.*.sql files by installing the schema_generator gem and"
+puts "     running './script/generate schema'"
+puts " 3.  Run 'rake repackage' and verify that the generated .gem is correct."

data/bin/rails-backup

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rails-installer'
+
+installer = RailsInstaller.new('.')
+
+unless installer.is_valid_rails_directory?
+  STDERR.puts "Please run this command from the root of a valid Rails project"
+  exit(1)
+end
+
+installer.backup_database

data/bin/rails-restore

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'rails-installer'
+
+installer = RailsInstaller.new('.')
+
+unless installer.is_valid_rails_directory?
+  STDERR.puts "Please run this command from the root of a valid Rails project"
+  exit(1)
+end
+
+restore_file = ARGV[0]
+
+unless restore_file and File.exists?(restore_file) and restore_file =~ /\.yml$/
+  puts "Usage:"
+  puts "  rails-restore FILENAME"
+  puts ""
+  puts "  Restores the database contents from FILENAME into the database defined"
+  puts "  in 'config/database.yml'.  FILENAME should be generated by the "
+  puts "  'rails-backup' command."
+end
+
+installer.restore_database restore_file

data/examples/installer

@@ -4,9 +4,8 @@ require 'rubygems'
 require 'rails-installer'
 
 class AppInstaller < RailsInstaller
-  application_name 'my_shiny_metal_app'
-  support_location 'our shiny website'
-  rails_version '1.1.6'
+  application_name '$APPNAME'
+  support_location 'the $APPNAME website'
 end
 
 directory = ARGV[1]

data/examples/release.rake

@@ -0,0 +1,39 @@
+require 'rake/gempackagetask'
+
+PKG_VERSION = "1.0.0"
+PKG_NAME = "$APPNAME"
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+spec = Gem::Specification.new do |s|
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "FIXME"
+  s.description = "FIXME"
+  s.has_rdoc = false
+  
+  s.files = Dir.glob('**/*', File::FNM_DOTMATCH).reject do |f| 
+     [ /\.$/, /config\/database.yml$/, /config\/database.yml-/, 
+     /database\.sqlite/,
+     /\.log$/, /^pkg/, /\.svn/, /^vendor\/rails/, /\~$/, 
+     /\/\._/, /\/#/ ].any? {|regex| f =~ regex }
+  end
+  s.require_path = '.'
+  s.author = "FIXME"
+  s.email = "FIXME@example.com"
+  s.homepage = "http://www.FIXME.com"  
+  s.rubyforge_project = "FIXME"
+  s.platform = Gem::Platform::RUBY 
+  s.executables = ['$APPNAME']
+  
+  s.add_dependency("rails", "= 1.1.6")
+  s.add_dependency("mongrel", ">= 0.3.13.3")
+  s.add_dependency("mongrel_cluster", ">= 0.2.0")
+  s.add_dependency("sqlite3-ruby", ">= 1.1.0")
+  s.add_dependency("rails-app-installer", ">= 0.1.0")
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = false
+  p.need_zip = false
+end

data/lib/rails-installer.rb

@@ -367,15 +367,32 @@ class RailsInstaller
     [added, changed, deleted, same]
   end
   
+  # Decide which Rails version to freeze
+  def rails_version_to_freeze
+    if @@rails_version
+      return "= #{@@rails_version}"
+    else
+      specs = Gem.source_index.find_name(app_name,["= #{@install_version}"])
+      unless specs.to_a.size > 0
+        raise InstallFailed, "Can't locate version #{@install_version.first}!"
+      end
+          
+      rails_dep = specs.first.dependencies.detect {|a| a.name=='rails'}
+      version = rails_dep.version_requirements.to_s
+      return version
+    end
+  end
+  
   # Freeze to a specific version of Rails gems.
   def freeze_rails
-    return unless @@rails_version
+    new_version = rails_version_to_freeze
+
     version_file = File.join(install_directory,'vendor','rails-version')
     vendor_rails = File.join(install_directory,'vendor','rails')
     
     old_version = File.read(version_file).chomp rescue nil
     
-    if @@rails_version == old_version
+    if new_version == old_version
       return
     elsif old_version != nil
       rm_rf(vendor_rails)
@@ -392,10 +409,10 @@ class RailsInstaller
       'activesupport' => File.join(vendor_rails,'activesupport'),
     }
     
-    specs = Gem.source_index.find_name('rails',["= #{@@rails_version}"])
+    specs = Gem.source_index.find_name('rails',[new_version])
     
     unless specs.to_a.size > 0
-      raise InstallFailed, "Can't locate Rails #{@@rails_version}!"
+      raise InstallFailed, "Can't locate Rails #{new_version}!"
     end
     
     copy_gem(specs.first, package_map[specs.first.name])
@@ -566,7 +583,7 @@ class RailsInstaller
   end
   
   # Locate the source directory for a specific Version
-  def find_source_directory(gem_name, version)
+  def find_source_directory(gem_name, version=nil)
     if version == 'cwd'
       return Dir.pwd
     elsif version
@@ -580,6 +597,9 @@ class RailsInstaller
       raise InstallFailed, "Can't locate version #{version}!"
     end
     
+    @install_version = specs.last.version
+    message "Installing #{app_name} #{@install_version}"
+    
     specs.last.full_gem_path
   end
   
@@ -644,6 +664,19 @@ class RailsInstaller
       STDERR.puts "    #{help}"
     end
   end
+  
+  def is_valid_rails_directory?
+    valid = false
+    in_directory install_directory do
+      valid = File.exists?('config/database.yml') and
+        File.directory?('app') and
+        File.directory?('app/models') and
+        File.directory?('vendor')
+    end
+
+    valid
+  end
+  
 end
 
 # Run a block inside of a specific directory.  Chdir into the directory

data/lib/rails-installer/databases.rb

@@ -15,8 +15,10 @@ class RailsInstaller
       database_yml = File.read File.join(installer.install_directory, 'config', 'database.yml') rescue nil
       database_yml ||= yml(installer)
       
+      environment = ENV['RAILS_ENV'] || 'development' # Mirror Rails' default.
+      
       ActiveRecord::Base.establish_connection( 
-        YAML.load(database_yml)['production'])
+        YAML.load(database_yml)[environment])
       begin
         tables = ActiveRecord::Base.connection.tables
         if tables.size > 0

metadata

@@ -1,84 +1,93 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.10
+rubygems_version: 0.9.0
 specification_version: 1
 name: rails-app-installer
 version: !ruby/object:Gem::Version 
-  version: 0.1.5
-date: 2006-08-12
+  version: 0.2.0
+date: 2006-08-15 00:00:00 -07:00
 summary: An installer for Rails apps
 require_paths: 
-  - lib
+- lib
 email: scott@sigkill.org
 homepage: http://scottstuff.net
 rubyforge_project: 
-description: ''
+description: ""
 autorequire: rails-installer
 default_executable: 
 bindir: bin
 has_rdoc: true
 required_ruby_version: !ruby/object:Gem::Version::Requirement 
   requirements: 
-    - 
-      - ">"
-      - !ruby/object:Gem::Version 
-        version: 0.0.0
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
   version: 
 platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
 authors: 
-  - Scott Laird
+- Scott Laird
 files: 
-  - lib/apache13.conf.example.template
-  - lib/apache20.conf.example.template
-  - lib/lighttpd.conf.example.template
-  - lib/rails-installer
-  - lib/rails-installer.rb
-  - examples/installer
-  - examples/rails_installer_defaults.yml
-  - examples/typo
-  - README
-  - lib/rails-installer/commands.rb
-  - lib/rails-installer/databases.rb
-  - lib/rails-installer/web-servers.rb
+- bin/rails-app-installer-setup
+- bin/rails-backup
+- bin/rails-restore
+- lib/rails-installer
+- lib/rails-installer.rb
+- examples/apache13.conf.example.template
+- examples/apache20.conf.example.template
+- examples/installer
+- examples/lighttpd.conf.example.template
+- examples/rails_installer_defaults.yml
+- examples/release.rake
+- examples/typo
+- README
+- lib/rails-installer/commands.rb
+- lib/rails-installer/databases.rb
+- lib/rails-installer/web-servers.rb
 test_files: []
+
 rdoc_options: 
-  - "--main"
-  - RailsInstaller
+- --main
+- RailsInstaller
 extra_rdoc_files: 
-  - README
-  - lib/rails-installer/commands.rb
-  - lib/rails-installer/databases.rb
-  - lib/rails-installer/web-servers.rb
-executables: []
+- README
+- lib/rails-installer/commands.rb
+- lib/rails-installer/databases.rb
+- lib/rails-installer/web-servers.rb
+executables: 
+- rails-app-installer-setup
+- rails-backup
+- rails-restore
 extensions: []
+
 requirements: []
+
 dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: mongrel
-    version_requirement: 
-    version_requirements: !ruby/object:Gem::Version::Requirement 
-      requirements: 
-        - 
-          - ">="
-          - !ruby/object:Gem::Version 
-            version: 0.3.13.3
-      version: 
-  - !ruby/object:Gem::Dependency 
-    name: mongrel_cluster
-    version_requirement: 
-    version_requirements: !ruby/object:Gem::Version::Requirement 
-      requirements: 
-        - 
-          - ">="
-          - !ruby/object:Gem::Version 
-            version: 0.2.0
-      version: 
-  - !ruby/object:Gem::Dependency 
-    name: sqlite3-ruby
-    version_requirement: 
-    version_requirements: !ruby/object:Gem::Version::Requirement 
-      requirements: 
-        - 
-          - ">="
-          - !ruby/object:Gem::Version 
-            version: 1.1.0
-      version: 
+- !ruby/object:Gem::Dependency 
+  name: mongrel
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.13.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mongrel_cluster
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: