technomancy-harker 0.0.3

data/History.txt

@@ -0,0 +1,12 @@
+=== 0.0.3 / 2009-03-26
+
+* A release!
+* First pass at automating gemification of Rails apps with bin/harker.
+* Swapped order of Harker.launch args; now action then instance dir.
+* Apps don't need config/environment.rb tweaks to use harker.
+* Got some docs; yay.
+
+=== 0.0.1 / 2009-03-25
+
+ * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,64 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+bin/harker
+lib/harker.rb
+lib/harker/gemify.rb
+lib/harker/rails_configuration.rb
+lib/harker/server.rb
+test/sample/Manifest.txt
+test/sample/README.rdoc
+test/sample/Rakefile
+test/sample/app/controllers/application_controller.rb
+test/sample/app/controllers/harks_controller.rb
+test/sample/app/helpers/application_helper.rb
+test/sample/app/helpers/harks_helper.rb
+test/sample/app/models/hark.rb
+test/sample/bin/sample_rails
+test/sample/config/boot.rb
+test/sample/config/database.yml
+test/sample/config/environment.rb
+test/sample/config/environments/development.rb
+test/sample/config/environments/production.rb
+test/sample/config/environments/test.rb
+test/sample/config/initializers/backtrace_silencers.rb
+test/sample/config/initializers/inflections.rb
+test/sample/config/initializers/mime_types.rb
+test/sample/config/initializers/new_rails_defaults.rb
+test/sample/config/initializers/session_store.rb
+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
+test/sample/public/favicon.ico
+test/sample/public/images/rails.png
+test/sample/public/index.html
+test/sample/public/javascripts/application.js
+test/sample/public/javascripts/controls.js
+test/sample/public/javascripts/dragdrop.js
+test/sample/public/javascripts/effects.js
+test/sample/public/javascripts/prototype.js
+test/sample/public/robots.txt
+test/sample/script/about
+test/sample/script/console
+test/sample/script/dbconsole
+test/sample/script/destroy
+test/sample/script/generate
+test/sample/script/performance/benchmarker
+test/sample/script/performance/profiler
+test/sample/script/plugin
+test/sample/script/runner
+test/sample/script/server
+test/sample/test/fixtures/harks.yml
+test/sample/test/functional/harks_controller_test.rb
+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_harker.rb

data/README.rdoc

@@ -0,0 +1,65 @@
+= Harker
+
+http://github.com/technomancy/harker
+
+== Description
+
+Harker means Rails deployments via RubyGems--because a package manager
+is a terrible thing to waste.
+
+== 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.
+
+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.
+
+== Usage
+
+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
+
+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
+
+Test it out by dropping into the console:
+
+  $ RAILS_ENV=production your_app console /var/myapp
+
+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
+
+If you omit the second argument, it defaults to the current directory.
+
+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)
+* a Rails app to use it with
+* rubygems
+* hoe (technically optional)
+
+== Install
+
+* sudo gem install technomancy-harker --source=http://gems.github.com --source=http://gems.rubyforge.org
+
+== License
+
+Copyright (c) 2009 Phil Hagelberg.
+
+Licensed under the same terms as Ruby.

data/Rakefile

@@ -0,0 +1,16 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/harker.rb'
+
+Hoe.new('harker', Harker::VERSION) do |p|
+  p.readme_file = 'README.rdoc'
+  p.summary = "Concourse is a tool to make planning gatherings easy."
+  p.extra_deps << ["rails", "~> 2.3.2"]
+  p.extra_dev_deps << ["minitest", "~> 1.3.1"]
+  p.extra_dev_deps << ["sqlite3-ruby", "~> 1.2.4"]
+  p.developer('Phil Hagelberg', 'technomancy@gmail.com')
+end
+
+# vim: syntax=Ruby

data/bin/harker

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'harker/gemify'
+
+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!
+end
+
+if ARGV.include?('-h') or ARGV.include?('--help') or ARGV.size > 1
+  puts "Usage: #{File.dirname($0)} [RAILS_ROOT]"
+  puts
+  puts "Attempts to turn your Rails app into a gem for deployment with harker."
+  exit
+end
+
+Harker.gemify(ARGV.shift || Dir.pwd)

data/lib/harker/gemify.rb

@@ -0,0 +1,40 @@
+require 'harker'
+
+module Harker
+  def self.gemify(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')
+      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'
+
+Harker.launch(File.basename($0), ARGV)"
+
+    lib = "# Allow rubygems to load this app
+require File.dirname(__FILE__) + '/../config/environment'"
+
+    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."
+
+    puts "Done! Try running rake install_gem."
+  end
+end

data/lib/harker/rails_configuration.rb

@@ -0,0 +1,27 @@
+# TODO: not sure if my Rails patches cover tmp/sessions or tmp/sockets
+
+class Rails::Configuration
+  attr_accessor :tmp_dir
+
+  def default_tmp_dir
+    File.join(root_path, 'tmp')
+  end
+
+  def default_cache_store
+    if File.exist? File.join(default_tmp_dir, 'cache')
+      [ :file_store, File.join(default_tmp_dir, 'cache') ]
+    else
+      :memory_store
+    end
+  end
+end
+
+class Rails::Initializer
+  def self.run(command = :process, configuration = Configuration.new)
+    yield configuration if block_given?
+    Harker.configure(configuration)
+    initializer = new configuration
+    initializer.send(command)
+    initializer
+  end
+end

data/lib/harker/server.rb

@@ -0,0 +1,119 @@
+# A patched copy of what Rails' script/server runs.
+# Only two changes were made, noted below by comments beginning with "Harker"
+
+require 'active_support'
+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
+  # Thin not available
+end
+
+options = {
+  :Port        => 3000,
+  :Host        => "0.0.0.0",
+  :environment => (ENV['RAILS_ENV'] || "development").dup,
+  :config      => RAILS_ROOT + "/config.ru",
+  :detach      => false,
+  :debugger    => false,
+  :path        => nil
+}
+
+ARGV.clone.options do |opts|
+  opts.on("-p", "--port=port", Integer,
+          "Runs Rails on the specified port.", "Default: 3000") { |v| options[:Port] = v }
+  opts.on("-b", "--binding=ip", String,
+          "Binds Rails to the specified ip.", "Default: 0.0.0.0") { |v| options[:Host] = v }
+  opts.on("-c", "--config=file", String,
+          "Use custom rackup configuration file") { |v| options[:config] = v }
+  opts.on("-d", "--daemon", "Make server run as a Daemon.") { options[:detach] = true }
+  opts.on("-u", "--debugger", "Enable ruby-debugging for the server.") { options[:debugger] = true }
+  opts.on("-e", "--environment=name", String,
+          "Specifies the environment to run this server under (test/development/production).",
+          "Default: development") { |v| options[:environment] = v }
+  opts.on("-P", "--path=/path", String, "Runs Rails app mounted at a specific path.", "Default: /") { |v| options[:path] = v }
+
+  opts.separator ""
+
+  opts.on("-h", "--help", "Show this help message.") { puts opts; exit }
+
+  opts.parse!
+end
+
+server = Rack::Handler.get(ARGV.first) rescue nil
+unless server
+  begin
+    server = Rack::Handler::Mongrel
+  rescue LoadError => e
+    server = Rack::Handler::WEBrick
+  end
+end
+
+puts "=> Booting #{ActiveSupport::Inflector.demodulize(server)}"
+puts "=> Rails #{Rails.version} application starting on http://#{options[:Host]}:#{options[:Port]}#{options[:path]}"
+
+%w(cache pids sessions sockets).each do |dir_to_make|
+  # Harker: patched to use Rails.configuration.tmp_dir
+  FileUtils.mkdir_p(File.join(Rails.configuration.tmp_dir, dir_to_make))
+end
+
+if options[:detach]
+  Process.daemon
+  # Harker: patched to use Rails.configuration.tmp_dir
+  pid = File.join(Rails.configuration.tmp_dir, 'pids', 'server.pid')
+  File.open(pid, 'w'){ |f| f.write(Process.pid) }
+  at_exit { File.delete(pid) if File.exist?(pid) }
+end
+
+ENV["RAILS_ENV"] = options[:environment]
+RAILS_ENV.replace(options[:environment]) if defined?(RAILS_ENV)
+
+if File.exist?(options[:config])
+  config = options[:config]
+  if config =~ /\.ru$/
+    cfgfile = File.read(config)
+    if cfgfile[/^#\\(.*)/]
+      opts.parse!($1.split(/\s+/))
+    end
+    inner_app = eval("Rack::Builder.new {( " + cfgfile + "\n )}.to_app", nil, config)
+  else
+    require config
+    inner_app = Object.const_get(File.basename(config, '.rb').capitalize)
+  end
+else
+  require RAILS_ROOT + "/config/environment"
+  inner_app = ActionController::Dispatcher.new
+end
+
+if options[:path].nil?
+  map_path = "/"
+else
+  ActionController::Base.relative_url_root = options[:path]
+  map_path = options[:path]
+end
+
+app = Rack::Builder.new {
+  use Rails::Rack::LogTailer unless options[:detach]
+  use Rails::Rack::Debugger if options[:debugger]
+  map map_path do
+    use Rails::Rack::Static 
+    run inner_app
+  end
+}.to_app
+
+puts "=> Call with -d to detach"
+
+trap(:INT) { exit }
+
+puts "=> Ctrl-C to shutdown server"
+
+begin
+  server.run(app, options.merge(:AccessLog => []))
+ensure
+  puts 'Exiting'
+end

data/lib/harker.rb

@@ -0,0 +1,105 @@
+require 'fileutils'
+
+# Harker lets you deploy Rails apps via RubyGems.
+module Harker
+  VERSION = '0.0.3'
+  ACTIONS = %w(start stop restart init migrate console foreground)
+
+  module_function
+
+  # Dispatch based on user's command
+  def launch(name, args)
+    action = args.shift
+
+    unless ACTIONS.include?(action)
+      abort "Usage: #{@name} INSTANCE_DIR (#{ACTIONS.join('|')})"
+    end
+
+    @root = File.expand_path(args.shift || Dir.pwd)
+    @name = name
+
+    load_app unless action == 'init'
+    self.send(action)
+  end
+
+  # Start the application server in the foreground.
+  def foreground
+    start(false)
+  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)
+    # 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
+
+    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
+
+  def stop
+    abort "No pid at #{pidfile}." unless File.exist?(pidfile)
+    Process.kill('TERM', File.read(pidfile).to_i)
+  end
+
+  def restart
+    stop
+    start
+  end
+
+  # Initialize a new instance of your application
+  def init
+    FileUtils.mkdir_p(@root)
+    FileUtils.mkdir_p(@root + '/log')
+    FileUtils.mkdir_p(@root + '/tmp')
+
+    # 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)
+    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"
+  end
+
+  def migrate
+    ActiveRecord::Migrator.migrate(RAILS_ROOT + '/db/migrate',
+                                   ENV["VERSION"] && ENV["VERSION"].to_i)
+  end
+
+  def console
+    require 'irb'
+    IRB.start
+  end
+
+  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
+end

data/test/sample/Manifest.txt

@@ -0,0 +1,53 @@
+Manifest.txt
+README.rdoc
+Rakefile
+app/controllers/application_controller.rb
+app/controllers/harks_controller.rb
+app/helpers/application_helper.rb
+app/helpers/harks_helper.rb
+app/models/hark.rb
+bin/sample_rails
+config/boot.rb
+config/database.yml
+config/environment.rb
+config/environments/development.rb
+config/environments/production.rb
+config/environments/test.rb
+config/initializers/backtrace_silencers.rb
+config/initializers/inflections.rb
+config/initializers/mime_types.rb
+config/initializers/new_rails_defaults.rb
+config/initializers/session_store.rb
+config/locales/en.yml
+config/routes.rb
+db/migrate/20090326050232_create_harks.rb
+lib/sample_rails.rb
+public/404.html
+public/422.html
+public/500.html
+public/favicon.ico
+public/images/rails.png
+public/index.html
+public/javascripts/application.js
+public/javascripts/controls.js
+public/javascripts/dragdrop.js
+public/javascripts/effects.js
+public/javascripts/prototype.js
+public/robots.txt
+script/about
+script/console
+script/dbconsole
+script/destroy
+script/generate
+script/performance/benchmarker
+script/performance/profiler
+script/plugin
+script/runner
+script/server
+test/fixtures/harks.yml
+test/functional/harks_controller_test.rb
+test/performance/browsing_test.rb
+test/test_helper.rb
+test/unit/hark_test.rb
+test/unit/helpers/harks_helper_test.rb
+tmp

data/test/sample/README.rdoc

@@ -0,0 +1,46 @@
+= Harker Sample
+
+http://github.com/technomancy/harker
+
+== Description
+
+A sample application.
+
+== Usage
+
+Just for tests.
+
+== Requirements
+
+* rails (at least 2.3.2)
+* rubygems
+* hoe
+
+== Install
+
+* sudo gem install harker
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 Phil Hagelberg
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/test/sample/Rakefile

@@ -0,0 +1,16 @@
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rubygems'
+require 'hoe'
+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"]
+  p.extra_deps << ["harker", "~> 0.0.1"]
+  p.developer('Phil Hagelberg', 'technomancy@gmail.com')
+end

data/test/sample/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/test/sample/app/controllers/harks_controller.rb

@@ -0,0 +1,6 @@
+class HarksController < ApplicationController
+  def index
+    Hark.create(:tidings => "Joy!") if Hark.count == 0
+    render :text => Hark.find(:all).map{ |h| h.attributes }.to_yaml
+  end
+end

data/test/sample/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/test/sample/app/helpers/harks_helper.rb

@@ -0,0 +1,2 @@
+module HarksHelper
+end

data/test/sample/app/models/hark.rb

@@ -0,0 +1,2 @@
+class Hark < ActiveRecord::Base
+end

data/test/sample/bin/sample_rails

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