technomancy-harker 0.0.3 → 0.5.0

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.5.0 / 2009-03-30
+
+* Use gem's config/database.yml for a base.
+* Gemifying existing apps works now.
+* Accept arguments for script/server when starting app.
+
 === 0.0.3 / 2009-03-26
 
 * A release!

data/Manifest.txt

@@ -7,6 +7,9 @@ lib/harker.rb
 lib/harker/gemify.rb
 lib/harker/rails_configuration.rb
 lib/harker/server.rb
+lib/harker/templates/bin.erb
+lib/harker/templates/hoe.erb
+lib/harker/templates/lib.erb
 test/sample/Manifest.txt
 test/sample/README.rdoc
 test/sample/Rakefile
@@ -31,8 +34,6 @@ test/sample/config/locales/en.yml
 test/sample/config/routes.rb
 test/sample/db/migrate/20090326050232_create_harks.rb
 test/sample/lib/sample_rails.rb
-test/sample/log/development.log
-test/sample/log/test.log
 test/sample/public/404.html
 test/sample/public/422.html
 test/sample/public/500.html
@@ -61,4 +62,5 @@ test/sample/test/performance/browsing_test.rb
 test/sample/test/test_helper.rb
 test/sample/test/unit/hark_test.rb
 test/sample/test/unit/helpers/harks_helper_test.rb
+test/test_gemify.sh
 test/test_harker.rb

data/README.rdoc

@@ -7,12 +7,31 @@ http://github.com/technomancy/harker
 Harker means Rails deployments via RubyGems--because a package manager
 is a terrible thing to waste.
 
+== Motivation
+
+This will mean you can use the same infrastructure you already rely on
+for your dependencies to manage your application itself. It means
+never having to keep a checkout of your app just for deployment. It
+also becomes very easy to see what versions are installed on a given
+box and run multiple instances (of the same or different versions) at
+the same time on different ports.
+
+Your app code will live in your gem home, but all the files specific
+to a given instance will live in an instance directory.
+
+In short: you've already got a package manager. Why are you handling
+installation of your deployed apps with a one-off tool?
+
 == Setup
 
 Your Rails app will need to be modified a bit to become a gem and work
-with Harker. Running "harker /path/to/rails/app" will attempt to turn
-it into a gem that uses Hoe. It probably won't be perfect, but it's a
-start. See the app in test/sample/ for an example of how this works.
+with Harker. But don't worry, these modifications will improve your
+app and make it more awesome. Running "harker /path/to/rails/app" will
+attempt to turn it into a gem that uses Hoe. You may need to perform a
+bit of tweaking in order to get it to build cleanly since every app is
+different--see the one in test/sample/ for an example of how this
+works. In particular, be sure Manifest.txt does not include any files
+that shouldn't go in the gem, such as pid or log files.
 
 You don't have to use Hoe if you want to turn your app into a gem
 manually or using another library, but it helps.
@@ -23,21 +42,24 @@ Once your app is a gem, install it locally with "rake install_gem",
 and you should be able to use the bin wrapper to generate a new
 instance:
 
-  $ your_app init /var/myapp
+  $ your_app init ~/apps/your_app_3000
 
 Then edit /var/myapp/database.yml with your database settings. At that
 point you should be able to bring up your database:
 
-  $ RAILS_ENV=production your_app migrate /var/myapp
+  $ your_app migrate ~/apps/your_app_3000
 
 Test it out by dropping into the console:
 
-  $ RAILS_ENV=production your_app console /var/myapp
+  $ your_app console ~/apps/your_app_3000
 
 Then you can start and stop your application server via Rack:
 
-  $ RAILS_ENV=production your_app start /var/myapp
-  $ RAILS_ENV=production your_app stop /var/myapp
+  $ your_app start ~/apps/your_app_3000 --daemon
+  $ your_app stop ~/apps/your_app_3000
+
+To configure the web server, create a config.ru file in your instance
+directory, and Rails will pick that up with Rack.
 
 If you omit the second argument, it defaults to the current directory.
 
@@ -45,8 +67,6 @@ For deployment, simply publish your gem to a gem server (public or
 private), install it on the target server, and launch it via the bin
 wrappers.
 
-TODO: automate /etc/init.d scripts?
-
 == Requirements
 
 * rails (at least 2.3.2)
@@ -58,6 +78,12 @@ TODO: automate /etc/init.d scripts?
 
 * sudo gem install technomancy-harker --source=http://gems.github.com --source=http://gems.rubyforge.org
 
+== Todo
+
+* rake tasks for remotely installing gem
+* make it easy to "rake release" to a private gem repo
+* test, test, test. try it out with more rails apps!
+
 == License
 
 Copyright (c) 2009 Phil Hagelberg.

data/bin/harker

@@ -6,11 +6,11 @@ begin
   gem 'hoe'
 rescue LoadError
   abort 'Hoe not found. You can continue without hoe if you gemify
-your app yourself; see Harker documentation for details.' # TODO: document!
+your app yourself; see Harker documentation for details.'
 end
 
 if ARGV.include?('-h') or ARGV.include?('--help') or ARGV.size > 1
-  puts "Usage: #{File.dirname($0)} [RAILS_ROOT]"
+  puts "Usage: #{File.basename($0)} [RAILS_ROOT]"
   puts
   puts "Attempts to turn your Rails app into a gem for deployment with harker."
   exit

data/lib/harker.rb

@@ -1,9 +1,14 @@
 require 'fileutils'
 
 # Harker lets you deploy Rails apps via RubyGems.
+#
+# These commands get invoked by the bin wrapper of the rails app gem
+# rather than by Harker itself.
+#
 module Harker
-  VERSION = '0.0.3'
-  ACTIONS = %w(start stop restart init migrate console foreground)
+  VERSION = '0.5.0'
+  ACTIONS = %w(start stop restart init migrate console)
+  GEM_ROOT = Gem.loaded_specs[File.basename($0)].full_gem_path rescue '.'
 
   module_function
 
@@ -12,31 +17,35 @@ module Harker
     action = args.shift
 
     unless ACTIONS.include?(action)
-      abort "Usage: #{@name} INSTANCE_DIR (#{ACTIONS.join('|')})"
+      abort "Usage: #{name} INSTANCE_DIR (#{ACTIONS.join('|')}).
+The start command takes the same arguments as script/server."
     end
 
-    @root = File.expand_path(args.shift || Dir.pwd)
+    # We need to get rid of the first arg if it's the optional
+    # instance directory so script/server doesn't get confused.
+    @root = if File.directory? args.first.to_s or action == 'init'
+              File.expand_path args.shift
+            else
+              Dir.pwd
+            end
+
     @name = name
 
-    load_app unless action == 'init'
-    self.send(action)
-  end
+    unless action == 'init'
+      # 2.3.2 doesn't support tmp_dir config option; needs a monkeypatch.
+      require 'harker/rails_configuration'
+      require @name
+    end
 
-  # Start the application server in the foreground.
-  def foreground
-    start(false)
+    self.send(action)
   end
 
-  # Start and daemonize the application server
-  def start(daemonize = true)
-    # can has internal consistency plz, Rails?
-    Rails::Rack::LogTailer::EnvironmentLog.replace(Rails.configuration.log_path)
+  # Start and optionally daemonize the application server
+  def start
     # http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/2350
     # Submitted a patch to Rails, but this lets it work with 2.3.2
+    Rails::Rack::LogTailer::EnvironmentLog.replace(Rails.configuration.log_path)
 
-    ARGV.replace ["--config=#{@root}/config.ru"]
-    ARGV.push('--daemon') if daemonize
-    
     abort "Can't start; pidfile exists at #{pidfile}." if File.exist? pidfile
     require 'harker/server'
   end
@@ -48,6 +57,7 @@ module Harker
 
   def restart
     stop
+  rescue SystemExit
     start
   end
 
@@ -56,28 +66,34 @@ module Harker
     FileUtils.mkdir_p(@root)
     FileUtils.mkdir_p(@root + '/log')
     FileUtils.mkdir_p(@root + '/tmp')
+    FileUtils.mkdir_p(@root + '/db') # In case we use sqlite.
+
+    base_db_file = File.join(GEM_ROOT, 'config', 'database.yml')
 
-    # TODO: use the in-gem copy of database.yml as a base for this
     File.open("#{@root}/database.yml", 'w') do |fp|
-      # TODO: be smart about environments; bleh
-      fp.puts({ 'production' => { 'adapter' => 'sqlite3',
-                  'database' => @root + '/db.sqlite3',
-                  'pool' => 5, 'timeout' => 5000 }}.to_yaml)
+      # Need to make sure any sqlite3 DB paths are absolute.
+      db_config = YAML.load_file(base_db_file)
+      db_config.each do |env, hash|
+        if hash['adapter'] =~ /sqlite3?/
+          hash['database'] = File.join(@root, hash['database'])
+        end
+      end
+
+      fp.puts(db_config.to_yaml)
     end
 
-    # TODO: write a default config.ru?
-
     puts "Initialized #{@name} instance in #{@root}..."
     puts
     puts "Configure your database by editing #{@root}/database.yml."
     puts "Optionally configure your web server via rack in #{@root}/config.ru."
     puts
     puts "Migrate your DB with: #{@name} migrate"
-    puts "Then launch with: #{@name} start"
+    puts "Then launch with: #{@name} start --daemon"
   end
 
   def migrate
-    ActiveRecord::Migrator.migrate(RAILS_ROOT + '/db/migrate',
+    puts "Migrating the #{RAILS_ENV} environment of #{@name}..."
+    ActiveRecord::Migrator.migrate(File.join(Rails.root, 'db', 'migrate'),
                                    ENV["VERSION"] && ENV["VERSION"].to_i)
   end
 
@@ -89,16 +105,9 @@ module Harker
   def configure(config)
     config.database_configuration_file = File.join(@root, 'database.yml')
     config.log_path = File.join(@root, 'log', "#{RAILS_ENV}.log")
-
-    # 2.3.2 doesn't support tmp_dir config option.
-    require 'harker/rails_configuration' unless config.respond_to?(:tmp_dir=)
     config.tmp_dir = File.join(@root, '/tmp')
   end
 
-  def load_app
-    require @name
-  end
-
   def pidfile
     File.join(@root, 'tmp', 'pids', 'server.pid')
   end

data/lib/harker/gemify.rb

@@ -1,40 +1,44 @@
 require 'harker'
+require 'fileutils'
+require 'erb'
 
 module Harker
+  # Turn an existing Rails app into a gem.
   def self.gemify(rails_root)
-    project_name = File.basename(rails_root)
+    @project_name = File.basename(rails_root)
 
-    if File.exist?(rails_root + "/bin/#{project_name}", 'w') or
-        File.exist?(rails_root + "/lib/#{project_name}.rb", 'w')
+    if File.exist?(rails_root + "/bin/#{@project_name}") or
+        File.exist?(rails_root + "/lib/#{@project_name}.rb")
       abort "Can't write gem files without overwriting existing ones.
 Try manually gemifying."
     end
 
-    # TODO: can we specify the version better?
-    hoe = "Hoe.new('#{project_name}', '1.0.0') do |p|
-  p.extra_deps << ['rails', '~> 2.3.2']
-  p.extra_deps << ['harker', '~> #{Harker::VERSION}']
-  p.developer('Your Name', 'you@example.com') # FIXME!
-end"
-
-    bin = "#!/usr/bin/env ruby
-require 'rubygems'
-require 'harker'
+    File.open(File.join(rails_root, '/Rakefile'), 'a') do |fp|
+      fp.puts template('hoe')
+      puts "Added hoe block to Rakefile."
+    end
 
-Harker.launch(File.basename($0), ARGV)"
+    FileUtils.mkdir_p(File.join(rails_root, '/bin'))
+    File.open(File.join(rails_root, "/bin/#{@project_name}"), 'w') do |fp|
+      fp.puts template('bin')
+      puts "Wrote bin launcher."
+    end
 
-    lib = "# Allow rubygems to load this app
-require File.dirname(__FILE__) + '/../config/environment'"
+    File.open(File.join(rails_root, "/lib/#{@project_name}.rb"), 'w') do |fp|
+      fp.puts template('lib')
+      puts "Wrote lib file."
+    end
 
-    File.open(rails_root + '/Rakefile', 'a') { |fp| fp.puts hoe }
-    puts "Added hoe block to Rakefile."
-    File.open(rails_root + "/bin/#{project_name}", 'w') { fp.puts bin }
-    puts "Wrote bin launcher."
-    File.open(rails_root + "/lib/#{project_name}.rb", 'w') { fp.puts lib }
-    puts "Wrote lib file."
-    system "cd #{rails_root}; rake check_manifest | patch"
-    puts "Wrote manifest."
+    # Submitted a patch to hoe to make it ignore log files by default,
+    # but folks should still give it a once-over manually anyway.
+    system "cd #{rails_root}; touch Manifest.txt; rake check_manifest | patch"
+    puts "Wrote Manifest.txt."
+    puts "Ensure the manifest doesn't contain files you don't want in the gem."
+    puts "Then try running rake install_gem."
+  end
 
-    puts "Done! Try running rake install_gem."
+  def self.template(name)
+    template_path = File.join File.dirname(__FILE__), 'templates', "#{name}.erb"
+    ERB.new(File.read(template_path)).result(binding)
   end
 end

data/lib/harker/rails_configuration.rb

@@ -1,4 +1,13 @@
-# TODO: not sure if my Rails patches cover tmp/sessions or tmp/sockets
+# This monkeypatches Rails to allow tmp_dir to be configured.
+
+# It's been submitted upstream:
+# http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/2379
+
+# We can remove the Configuration monkeypatch once the above patch is
+# accepted if we don't care about supporting older versions.
+
+gem 'rails'
+require 'initializer'
 
 class Rails::Configuration
   attr_accessor :tmp_dir
@@ -17,7 +26,7 @@ class Rails::Configuration
 end
 
 class Rails::Initializer
-  def self.run(command = :process, configuration = Configuration.new)
+  def self.run(command = :process, configuration = Rails::Configuration.new)
     yield configuration if block_given?
     Harker.configure(configuration)
     initializer = new configuration

data/lib/harker/server.rb

@@ -1,4 +1,11 @@
 # A patched copy of what Rails' script/server runs.
+
+# These changes were submitted upstream to Rails:
+# http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/2379
+
+# We can remove this file once that patch is accepted if we don't care
+# about supporting older versions.
+
 # Only two changes were made, noted below by comments beginning with "Harker"
 
 require 'active_support'
@@ -7,7 +14,6 @@ require 'action_controller'
 require 'fileutils'
 require 'optparse'
 
-# TODO: Push Thin adapter upstream so we don't need worry about requiring it
 begin
   require_library_or_gem 'thin'
 rescue Exception

data/lib/harker/templates/bin.erb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'harker'
+
+Harker.launch(File.basename($0), ARGV)

data/lib/harker/templates/hoe.erb

@@ -0,0 +1,9 @@
+require 'hoe'
+Hoe.new('<%= @project_name %>', '1.0.0') do |p|
+  p.summary = 'A Rails application.' # FIXME!
+  p.developer('Your Name', 'you@example.com') # FIXME!
+  p.extra_deps << ['rails', '~> 2.3.2']
+  p.extra_deps << ['harker', '~> <%= Harker::VERSION %>']
+end
+
+# TODO: remove hoe's test tasks once new hoe is released.

data/lib/harker/templates/lib.erb

@@ -0,0 +1,2 @@
+# Allow rubygems to load this app
+require File.dirname(__FILE__) + '/../config/environment'

data/test/sample/Rakefile

@@ -6,8 +6,6 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'tasks/rails'
 
-# TODO: Hoe and Rails' test tasks stomp on each other
-# TODO: specify version sanely
 Hoe.new('sample_rails', '1.0.0') do |p|
   p.readme_file = 'README.rdoc'
   p.extra_deps << ["rails", "~> 2.3.2"]

data/test/sample/public/javascripts/controls.js

@@ -779,7 +779,7 @@ Ajax.InPlaceCollectionEditor = Class.create(Ajax.InPlaceEditor, {
       onComplete: Prototype.emptyFunction,
       onSuccess: function(transport) {
         var js = transport.responseText.strip();
-        if (!/^\[.*\]$/.test(js)) // TODO: improve sanity check
+        if (!/^\[.*\]$/.test(js))
           throw('Server returned an invalid collection representation.');
         this._collection = eval(js);
         this.checkForExternalText();

data/test/test_gemify.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+# The gemification step is tricky to test. =\
+
+sudo gem uninstall -x dummy
+rm -rf /tmp/dummy-instance
+rm -rf /tmp/dummy
+
+cd /tmp
+rails dummy
+cd /tmp/dummy
+script/generate scaffold Dummy name:string favourite_dumb_thing:string
+harker
+rake install_gem
+dummy init /tmp/dummy-instance
+cd /tmp/dummy-instance
+dummy migrate
+dummy start

data/test/test_harker.rb

@@ -1,19 +1,13 @@
 require "rubygems"
 require "minitest/unit"
 require 'fileutils'
+require 'timeout'
 require 'open-uri'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__) + "/../lib/")
+$LOAD_PATH.unshift(File.dirname(__FILE__) + "/sample/lib/")
 require 'harker'
 
-begin
-  ENV['RAILS_ENV'] = 'production'
-  gem 'sample_rails'
-rescue LoadError
-  abort "You need the sample_rails gem installed:
-  $ cd #{File.dirname(__FILE__) + '/sample'} && rake install_gem"
-end
-
 class TestHarker < MiniTest::Unit::TestCase
   ROOT = "/tmp/harker-test-#{Process.pid}"
   URL = 'http://localhost:3000/harks'
@@ -26,6 +20,7 @@ class TestHarker < MiniTest::Unit::TestCase
 
   def setup
     unless File.exist?(ROOT)
+      Harker::GEM_ROOT.replace(File.dirname(__FILE__) + '/sample/')
       harker_action('init')
       harker_action('migrate')
     end
@@ -54,7 +49,7 @@ class TestHarker < MiniTest::Unit::TestCase
   def test_stop
     start_server_process
     assert File.exists?(ROOT + '/tmp/pids/server.pid'), "No pid found."
-    Harker.launch('sample_rails', ['stop', ROOT])
+    Harker.launch('sample_rails', ['stop', ROOT]); sleep 0.1
     assert_raises(Errno::ECONNREFUSED) { open(URL).read }
   end
 
@@ -75,8 +70,11 @@ class TestHarker < MiniTest::Unit::TestCase
   end
 
   def start_server_process
-    `cd #{File.dirname(__FILE__)}/.. ; ruby -I:lib test/sample/bin/sample_rails #{ROOT} start`
-    loop { break if File.exist?(ROOT + '/tmp/pids/server.pid'); sleep 0.1 }
+    `cd #{File.dirname(__FILE__)}/.. ; ruby -I:lib:test/sample/lib test/sample/bin/sample_rails start #{ROOT}`
+    Timeout.timeout(5) do
+      loop { break if File.exist?(ROOT + '/tmp/pids/server.pid'); sleep 0.1 }
+    end
+    sleep 0.1 # Waiting for pid to exist isn't enough; it looks like.
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: technomancy-harker
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.5.0
 platform: ruby
 authors: 
 - Phil Hagelberg
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-26 00:00:00 -07:00
+date: 2009-03-30 00:00:00 -07:00
 default_executable: harker
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -72,6 +72,9 @@ files:
 - lib/harker/gemify.rb
 - lib/harker/rails_configuration.rb
 - lib/harker/server.rb
+- lib/harker/templates/bin.erb
+- lib/harker/templates/hoe.erb
+- lib/harker/templates/lib.erb
 - test/sample/Manifest.txt
 - test/sample/README.rdoc
 - test/sample/Rakefile
@@ -96,8 +99,6 @@ files:
 - test/sample/config/routes.rb
 - test/sample/db/migrate/20090326050232_create_harks.rb
 - test/sample/lib/sample_rails.rb
-- test/sample/log/development.log
-- test/sample/log/test.log
 - test/sample/public/404.html
 - test/sample/public/422.html
 - test/sample/public/500.html
@@ -126,6 +127,7 @@ files:
 - test/sample/test/test_helper.rb
 - test/sample/test/unit/hark_test.rb
 - test/sample/test/unit/helpers/harks_helper_test.rb
+- test/test_gemify.sh
 - test/test_harker.rb
 has_rdoc: true
 homepage: http://github.com/technomancy/harker