vhost_generator 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vhost_generator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Julien Pervillé
+
+MIT License
+
+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/README.md

@@ -0,0 +1,69 @@
+# VhostGenerator
+
+This gem outputs a general-purpose VirtualHost configuration file
+to run your web application behind an nginx or apache frontend.
+
+The motivation of this gem is to automate that tedious task the first time, but
+also every time the virtualhost parameters (such as the number of instances to
+run and the ports where the instances are listening).
+
+The gem features tries to integrate with the [foreman][1] gem by:
+* reading configuration parameters from `ENV` (or from the `.env` file if present)
+* detecting whether to proxy to tcp or unix socket from `Procfile` if present
+* reading configuration from foreman's standard environment variables to allow
+for generating a virtualhost that matches the last `foreman export`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vhost_generator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vhost_generator
+
+## Usage
+
+Basic usage:
+
+    $ bundle exec vhost-generator -l 80 -s myapp.com -p 5000,5001,5002
+
+Advanced usage: all command-line switches have their equivalent environment variables. See note in `bundle exec vhost-generator --help`.
+
+    $ SERVER_PORTS=80 SERVER_NAMES=myapp.com INSTANCE_PORTS=5000,5001,5002 bundle exec vhost-generator
+
+Advanced usage for lazy people: environment variables may be saved into the `.env` file or into another file whose name is given in `ENV['DOTENV']`.
+This last option is nice, as it allows to store the environment in a file and reuse it later to generate the same virtualhost configurations.
+
+    $ echo "SERVER_PORTS=80\nSERVER_NAMES=myapp.com\nINSTANCE_PORTS=5000,5001,5002" >> my.env
+    $ DOTENV=my.env bundle exec vhost-generator
+
+More advanced usages: see `features/` directory or run:
+
+    $ bundle exec vhost-generator --help
+
+## Tips
+
+Protip: pipe with `sudo tee` to save the configuration in your nginx sites-enabled directory.
+
+    $ bundle exec vhost-generator -l 80 -s myapp.com -p 5000,5001,5002 | sudo tee /etc/nginx/sites-enabled/myapp
+
+Protip: run through `foreman run` to leverage your application's `.env` (DRY and handy when having a configured `RAILS_RELATIVE_URL_ROOT` for example)
+
+    $ echo RAILS_RELATIVE_URL_ROOT='/myapp' >> .env
+    $ bundle exec foreman run vhost-generator -l 80 -s myapp.com -p 5000,5001,5002
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[1]: https://github.com/ddollar/foreman "Foreman"

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "cucumber/rake/task"
+require 'rspec/core/rake_task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/vhost-generator

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'vhost_generator'
+
+VhostGenerator.application.run

data/features/help.feature

@@ -0,0 +1,12 @@
+Feature: Output help summary
+
+  In order to know how to invoke the program
+  As a user of the library
+  I want to display the program's help summary.
+
+  Scenario: output program help summary
+    When I run `bundle exec vhost-generator --help`
+    Then it should pass with:
+      """
+      Display this help message.
+      """

data/features/output-nginx.feature

@@ -0,0 +1,171 @@
+Feature: Output nginx configuration file
+
+  In order to run my application as an nginx virtualhost
+  As a user of the library
+  I want to output a nginx virtualhost configuration.
+
+  Scenario: using command-line options
+    When I run `bundle exec vhost-generator -g nginx -o upstream=myupstream -f html -l 80,81 -s localhost,my.server -p 5000,5001,5002 -r /myapp`
+    Then the output should match /FILE GENERATED BY.*EDIT AT YOUR OWN RISK/
+    And the output should contain:
+      """
+      upstream myupstream {
+        server localhost:5000 fail_timeout=0;
+        server localhost:5001 fail_timeout=0;
+        server localhost:5002 fail_timeout=0;
+      }
+      """
+    And the output should contain:
+      """
+      server {
+        listen 80;
+        listen 81;
+      """
+    And the output should contain:
+      """
+        server_name localhost, my.server;
+      """
+    And the output should match /root.*html;/
+    And the output should contain:
+      """
+        try_files $uri/index.html $uri @upstream;
+        location @upstream {
+          proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+          proxy_set_header X-Forwarded-Proto $scheme;
+          proxy_set_header Host $http_host;
+          proxy_redirect off;
+          proxy_pass http://myupstream;
+        }
+      """
+      And the output should contain:
+      """
+        location /myapp/assets {
+          gzip_static on; # to serve pre-gzipped version
+          expires 60d;
+          add_header  Cache-Control public;
+        }
+      """
+      And the output should contain:
+      """
+        error_page 500 502 503 504 /500.html;
+        client_max_body_size 4G;
+        keepalive_timeout 10;
+      }
+      """
+
+  Scenario: using dotenv
+    Given a file named "tmpdir/my.env" with:
+      """
+      GENERATOR=nginx
+      GENERATOR_OPTIONS=upstream=myupstream
+      STATIC_FOLDER=html
+      SERVER_PORTS=80,81
+      SERVER_NAMES=localhost,my.server
+      INSTANCE_PORTS=5000,5001,5002
+      RAILS_RELATIVE_URL_ROOT=/myapp
+      """
+    When I cd to "tmpdir"
+    And I set env variable "DOTENV" to "my.env"
+    And I run `bundle exec vhost-generator`
+    Then the output should match /FILE GENERATED BY.*EDIT AT YOUR OWN RISK/
+    And the output should contain:
+      """
+      upstream myupstream {
+        server localhost:5000 fail_timeout=0;
+        server localhost:5001 fail_timeout=0;
+        server localhost:5002 fail_timeout=0;
+      }
+      """
+    And the output should contain:
+      """
+      server {
+        listen 80;
+        listen 81;
+      """
+    And the output should contain:
+      """
+        server_name localhost, my.server;
+      """
+    And the output should match /root.*html;/
+    And the output should contain:
+      """
+        try_files $uri/index.html $uri @upstream;
+        location @upstream {
+          proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+          proxy_set_header X-Forwarded-Proto $scheme;
+          proxy_set_header Host $http_host;
+          proxy_redirect off;
+          proxy_pass http://myupstream;
+        }
+      """
+    And the output should contain:
+      """
+        location /myapp/assets {
+          gzip_static on; # to serve pre-gzipped version
+          expires 60d;
+          add_header  Cache-Control public;
+        }
+      """
+    And the output should contain:
+      """
+        error_page 500 502 503 504 /500.html;
+        client_max_body_size 4G;
+        keepalive_timeout 10;
+      }
+      """
+
+  Scenario: using environment variables
+    When I set env variable "GENERATOR" to "nginx"
+    And I set env variable "GENERATOR_OPTIONS" to "upstream=myupstream"
+    And I set env variable "STATIC_FOLDER" to "html"
+    And I set env variable "SERVER_PORTS" to "80,81"
+    And I set env variable "SERVER_NAMES" to "localhost,my.server"
+    And I set env variable "INSTANCE_PORTS" to "5000,5001,5002"
+    And I set env variable "RAILS_RELATIVE_URL_ROOT" to "/myapp"
+    And I run `bundle exec vhost-generator`
+    Then the output should match /FILE GENERATED BY.*EDIT AT YOUR OWN RISK/
+    And the output should contain:
+      """
+      upstream myupstream {
+        server localhost:5000 fail_timeout=0;
+        server localhost:5001 fail_timeout=0;
+        server localhost:5002 fail_timeout=0;
+      }
+      """
+    And the output should contain:
+      """
+      server {
+        listen 80;
+        listen 81;
+      """
+    And the output should contain:
+      """
+        server_name localhost, my.server;
+      """
+    And the output should match /root.*html;/
+    And the output should contain:
+      """
+        try_files $uri/index.html $uri @upstream;
+        location @upstream {
+          proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+          proxy_set_header X-Forwarded-Proto $scheme;
+          proxy_set_header Host $http_host;
+          proxy_redirect off;
+          proxy_pass http://myupstream;
+        }
+      """
+    And the output should contain:
+      """
+        location /myapp/assets {
+          gzip_static on; # to serve pre-gzipped version
+          expires 60d;
+          add_header  Cache-Control public;
+        }
+      """
+    And the output should contain:
+      """
+        error_page 500 502 503 504 /500.html;
+        client_max_body_size 4G;
+        keepalive_timeout 10;
+      }
+      """

data/features/step_definitions/dev_steps.rb

@@ -0,0 +1,3 @@
+When /^I set env variable "(\w+)" to "([^"]*)"$/ do |var, value|
+  ENV[var] = value
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/features/version.feature

@@ -0,0 +1,12 @@
+Feature: Output program version
+
+  In order to know if I am up to date
+  As a user of the library
+  I want to know the current version of vhost-generator.
+
+  Scenario: output program version
+    When I run `bundle exec vhost-generator --version`
+    Then it should pass with:
+      """
+      vhost-generator, version 0.1.0
+      """

data/lib/vhost_generator/application.rb

@@ -0,0 +1,150 @@
+require 'vhost_generator/version'
+require 'vhost_generator/vhost_configuration'
+require 'optparse'
+require 'ostruct'
+require 'dotenv'
+
+module VhostGenerator
+
+  ###########################################################################
+  # VhostGenerator main application object.  When invoking +vhost-generator+
+  # from the command line, a VhostGenerator::Application object is created
+  # and run.
+  #
+  class Application
+    attr_writer :config
+
+    def initialize(output_stream=$stdout)
+      @name = File.basename($0 || 'vhost-generator')
+      @output_stream = output_stream
+    end
+
+    # Run the VhostGenerator application.
+    def run
+      standard_exception_handling do
+        # load serialized environment variables from DOTENV files if present.
+        dotenvs = ['.env', ENV['DOTENV']]
+        dotenvs.compact.each { |f| Dotenv.load(f) }
+        handle_env(ENV)
+        handle_options(ARGV)
+        config.cmdline << ['cd', Dir.pwd]
+        config.cmdline << [$0] + ARGV
+        @output_stream.puts config.output
+      end
+    end
+
+    def config(configurator=VhostGenerator::VhostConfiguration)
+      @config ||= configurator.new # XXX
+    end
+
+    def handle_env(env)
+      if path = env['STATIC_FOLDER']
+        config.static_folder = path
+      end
+      if ports = env['SERVER_PORTS']
+        config.server_ports = ports
+      end
+      if names = env['SERVER_NAMES']
+        config.server_names = names
+      end
+      if ports = env['INSTANCE_PORTS']
+        config.instance_ports = ports
+      end
+      if root = env['RAILS_RELATIVE_URL_ROOT']
+        config.relative_root = root
+      end
+      if generator = env['GENERATOR']
+        config.generator = generator
+      end
+      if options = env['GENERATOR_OPTIONS']
+        config.generator_options = options
+      end
+    end
+
+    def handle_options(argv)
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{@name} [options]"
+
+        opts.separator ""
+        opts.separator ['Note: all command-line options below also exist as ' \
+                        'environment variables.', 'You may try to setenv all ' \
+                        'uppercase names in the rest of this summary, eg.',
+                        '`export RAILS_RELATIVE_URL_ROOT=/myapp`.'].join($/)
+
+        opts.separator ""
+        opts.separator "Application options:"
+        application_options.each { |args| opts.on(*args) }
+
+        opts.separator ""
+        opts.separator "Generator options:"
+        generator_options.each { |args| opts.on(*args) }
+
+        opts.separator ""
+
+        opts.on_tail("-v", "--version", "Display the program version.") do
+          @output_stream.puts "#{@name}, version #{VhostGenerator::VERSION}"
+          exit(true)
+        end
+
+        opts.on_tail("-h", "--help", "-H", "Display this help message.") do
+          @output_stream.puts opts
+          exit(true)
+        end
+      end.parse(argv)
+    end
+
+    def application_options
+      [
+        ['-f', '--static-folder STATIC_FOLDER',
+                %q{Path of your application's static folder (e.g. public/)},
+                lambda { |value| config.static_folder = value }],
+        ['-l', '--listen SERVER_PORTS',
+                %q{Public ports to listen on (e.g. 80,81)},
+                lambda { |value| config.server_ports = value }],
+        ['-s', '--server-name SERVER_NAMES',
+                %q{Server names to listen on (e.g. localhost,example.com)},
+                lambda { |value| config.server_names = value }],
+        ['-p', '--instance-port INSTANCE_PORTS',
+                %q{Internal ports where instances listen on (e.g. 5000,5001)},
+                lambda { |value| config.instance_ports = value }],
+        ['-r', '--relative-root RAILS_RELATIVE_URL_ROOT',
+               lambda { |value| config.relative_root = value }],
+      ]
+    end
+
+    def generator_options
+      [
+        ['-g', '--generator GENERATOR',
+               %q{Generator to use to output virtualhost configuration file},
+               lambda { |value| config.generator = value }],
+        ['-o', '--generator-options GENERATOR_OPTIONS',
+                %q{Generator options as comma-separated list of key=value},
+                lambda { |value| config.generator_options = value }],
+      ].freeze
+    end
+
+    # Provide standard exception handling for the given block.
+    def standard_exception_handling
+      begin
+        yield
+      rescue SystemExit => ex
+        # Exit silently with current status
+        raise
+      rescue OptionParser::InvalidOption => ex
+        $stderr.puts ex.message
+        exit(false)
+      rescue Exception => ex
+        # Exit with error message
+        display_error_message(ex)
+        exit(false)
+      end
+    end
+
+    # Display the error message that caused the exception.
+    def display_error_message(ex)
+      $stderr.puts "#{@name} aborted!"
+      $stderr.puts ex.message
+      $stderr.puts ex.backtrace.join("\n")
+    end
+  end
+end

data/lib/vhost_generator/nginx_generator.rb

@@ -0,0 +1,66 @@
+require 'ostruct'
+require 'erb'
+
+module VhostGenerator
+
+  # Nginx VhostGenerator
+  #
+  class NginxGenerator
+    attr_reader :cfg, :options
+    def initialize(cfg, options={})
+      @cfg = cfg
+      @options = OpenStruct.new(default_options.merge(options)).freeze
+    end
+
+    def render
+      template.result(binding)
+    end
+
+    protected
+
+    def default_options
+      Hash[ 'client_max_body_size' => '4G', 'keepalive_timeout' => '10',
+            'assets_expire_in' => '60d', 'upstream' => 'appservers' ].freeze
+    end
+
+    private
+
+    def template
+      @template ||= ERB.new <<EOF
+#### FILE GENERATED BY `<%= String(cfg.cmdline) %>`, EDIT AT YOUR OWN RISK ####
+
+upstream <%= options.upstream %> {
+<% cfg.instance_ports.each do |p| %>  server localhost:<%= p %> fail_timeout=0;
+<% end %>}
+
+server {
+  <% cfg.server_ports.each do |p| %>listen <%= p %>;
+  <% end %>
+  <% unless cfg.server_names.empty? %>server_name <%=
+       cfg.server_names.join(', ') %>;<% end %>
+
+  root <%= cfg.static_folder %>;
+
+  try_files $uri/index.html $uri @upstream;
+  location @upstream {
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+    proxy_set_header Host $http_host;
+    proxy_redirect off;
+    proxy_pass http://<%= options.upstream %>;
+  }
+
+  location <%= cfg.relative_root %>assets {
+    gzip_static on; # to serve pre-gzipped version
+    expires <%= options.assets_expire_in %>;
+    add_header  Cache-Control public;
+  }
+
+  error_page 500 502 503 504 /500.html;
+  client_max_body_size <%= options.client_max_body_size %>;
+  keepalive_timeout <%= options.keepalive_timeout %>;
+}
+EOF
+    end
+  end
+end

data/lib/vhost_generator/version.rb

@@ -0,0 +1,3 @@
+module VhostGenerator
+  VERSION = "0.1.0"
+end

data/lib/vhost_generator/vhost_configuration.rb

@@ -0,0 +1,108 @@
+require 'vhost_generator/nginx_generator'
+require 'shellwords'
+
+module VhostGenerator
+
+  # Represents a Shell command line (to display in vhost comments)
+  # TODO: make it a real class with a more narrow interface than Array
+  class ShellCmdLine < Array
+    def to_str
+      parts = self.collect { |cmd| Shellwords.join(cmd) }
+      if parts.length > 1
+        "(" + parts.join(' && ') + ")"
+      else
+        parts.join
+      end
+    end
+  end
+
+  ###########################################################################
+  # VhostConfiguration stores all the configuration values (to read from)
+  # +env+ or +cmdline+ needed to render the configuration template.
+  #
+  class VhostConfiguration
+    attr_reader :static_folder, :server_ports, :server_names,
+                :instance_ports, :relative_root, :cmdline,
+                :generator, :generator_options
+
+    def initialize(static_folder='public', server_ports='80',
+        server_names='localhost', instance_ports='', relative_root='/',
+        cmdlinebuilder=ShellCmdLine, generator='nginx', generator_options='')
+      self.static_folder = static_folder
+      self.server_ports = server_ports
+      self.server_names = server_names
+      self.instance_ports = instance_ports
+      self.relative_root = relative_root
+      self.cmdline = cmdlinebuilder.new
+      self.generator = generator
+      self.generator_options = generator_options
+    end
+
+    def static_folder=(folder)
+      @static_folder = File.expand_path(folder)
+    end
+
+    def server_ports=(ports)
+      @server_ports = parse_integer_list(ports)
+    end
+
+    def server_names=(names)
+      @server_names = parse_word_list(names)
+    end
+
+    def instance_ports=(ports)
+      @instance_ports = parse_integer_list(ports)
+    end
+
+    def relative_root=(root)
+      @relative_root = (String(root) + '/').gsub(%r{/+}, '/')
+    end
+
+    def generator=(name)
+      @generator = generator_for(name)
+    end
+
+    def generator_options=(options)
+      @generator_options = parse_option_list(options)
+    end
+
+    def configure!(parser)
+      parser.parse(self)
+    end
+
+    def output
+      self.generator.new(self, self.generator_options).render
+    end
+
+    protected
+
+    attr_writer :cmdline
+
+    def generator_for(name)
+      raise ArgumentError, "unsupported generator: %s, try any of %s." % [
+          name.inspect, registry.keys.inspect
+      ] unless registry.has_key?(name)
+      registry[name]
+    end
+
+    private
+
+    attr_writer :registry
+    def registry
+      # XXX use a real registry to reduce coupling
+      @registry ||= {'nginx' => VhostGenerator::NginxGenerator}
+    end
+
+    def parse_word_list(s)
+      String(s).split(/[,\s]+/)
+    end
+
+    def parse_option_list(s)
+      Hash[ parse_word_list(s).map { |i| i.split('=', 2) } ]
+    end
+
+    def parse_integer_list(s)
+      parse_word_list(s).map { |i| Integer(i) }
+    end
+  end
+end

data/lib/vhost_generator/vhost_generator_module.rb

@@ -0,0 +1,18 @@
+require 'vhost_generator/application'
+
+module VhostGenerator
+
+  # VhostGenerator module singleton methods.
+  #
+  class << self
+    # Current VhostGenerator Application
+    def application
+      @application ||= VhostGenerator::Application.new
+    end
+
+    # Set the current VhostGenerator application object.
+    def application=(app)
+      @application = app
+    end
+  end
+end

data/lib/vhost_generator.rb

@@ -0,0 +1,6 @@
+require "vhost_generator/version"
+require "vhost_generator/vhost_generator_module"
+
+module VhostGenerator
+  # Your code goes here...
+end

data/spec/application_env_spec.rb

@@ -0,0 +1,29 @@
+require 'vhost_generator/application'
+require 'ostruct'
+
+describe VhostGenerator::Application do
+  describe "Env" do
+    let(:config) { OpenStruct.new }
+    before { subject.config = config }
+
+    options = Hash[
+      'static_folder'     => 'STATIC_FOLDER',
+      'server_ports'      => 'SERVER_PORTS',
+      'server_names'      => 'SERVER_NAMES',
+      'instance_ports'    => 'INSTANCE_PORTS',
+      'relative_root'     => 'RAILS_RELATIVE_URL_ROOT',
+      'generator'         => 'GENERATOR',
+      'generator_options' => 'GENERATOR_OPTIONS',
+    ]
+
+    options.each_pair do |name, var|
+      describe "#{name} option" do
+        it "is set by the #{var} variable" do
+          expect {
+            subject.handle_env(var => 'value')
+          }.to change(config, name).to('value')
+        end
+      end
+    end
+  end
+end

data/spec/application_options_spec.rb

@@ -0,0 +1,31 @@
+require 'vhost_generator/application'
+require 'ostruct'
+
+describe VhostGenerator::Application do
+  describe "Options" do
+    let(:config) { OpenStruct.new }
+    before { subject.config = config }
+
+    options = Hash[
+      'static_folder'     => %w(-f --static-folder),
+      'server_ports'      => %w(-l --listen),
+      'server_names'      => %w(-s --server-name),
+      'instance_ports'    => %w(-p --instance-port),
+      'relative_root'     => %w(-r --relative-root),
+      'generator'         => %w(-g --generator),
+      'generator_options' => %w(-o --generator-options)
+    ]
+
+    options.each_pair do |name, flags|
+      describe "#{name} option" do
+        flags.each do |flag|
+          it "is set by the #{flag} flag" do
+            expect {
+              subject.handle_options([flag, 'value'])
+            }.to change(config, name).to('value')
+          end
+        end
+      end
+    end
+  end
+end

data/spec/nginx_generator_spec.rb

@@ -0,0 +1,61 @@
+require 'vhost_generator/nginx_generator'
+
+describe VhostGenerator::NginxGenerator do
+  let(:config) { double('vhost config').as_null_object }
+  subject do
+    described_class.new(config, 'upstream' => 'myupstream')
+  end
+
+  describe "#render" do
+    let(:output) { subject.render }
+
+    it "includes the cmdline in a comment" do
+      config.stub(:cmdline).and_return('CMDLINE')
+      expect(output).to match(/^#### FILE GENERATED BY .*CMDLINE/)
+    end
+
+    it "declares the named upstream" do
+      expect(output).to include('upstream myupstream {')
+    end
+
+    it "references the named upstream" do
+      expect(output).to include('http://myupstream;')
+    end
+
+    it "declares all the requested upstream servers" do
+      config.stub(:instance_ports).and_return([1337, 1338])
+      expect(output).to include('server localhost:1337 fail_timeout=0;')
+      expect(output).to include('server localhost:1338 fail_timeout=0;')
+    end
+
+    it "listens to the requested server ports" do
+      config.stub(:server_ports).and_return([12345, 12346])
+      expect(output).to include('listen 12345;')
+      expect(output).to include('listen 12346;')
+    end
+
+    it "declares the server names it responds to" do
+      config.stub(:server_names).and_return(%w(host1 host2))
+      expect(output).to include('server_name host1, host2;')
+    end
+
+    it "declares the requested document root" do
+      config.stub(:static_folder).and_return('STATIC-FOLDER')
+      expect(output).to include('root STATIC-FOLDER;')
+    end
+
+    it "forwards X-Forwarded-For header" do
+      expect(output).to \
+        include('proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;')
+    end
+
+    it "forwards X-Forwarded-Proto header" do
+      expect(output).to include('proxy_set_header X-Forwarded-Proto $scheme;')
+    end
+
+    it "respects custom relative_roots" do
+      config.stub(:relative_root).and_return('RELATIVE_ROOT')
+      expect(output).to include('location RELATIVE_ROOTassets {')
+    end
+  end
+end

data/spec/vhost_configuration_spec.rb

@@ -0,0 +1,127 @@
+require 'vhost_generator/vhost_configuration'
+
+describe VhostGenerator::VhostConfiguration do
+  describe "#static_folder" do
+    it "is 'public/' by default" do
+      expect(subject.static_folder).to eql(File.expand_path('public'))
+    end
+
+    it "expanded" do
+      expect {
+        subject.static_folder = 'html'
+      }.to change(subject, :static_folder).to File.expand_path('html')
+    end
+  end
+
+  describe "#server_ports" do
+    it "is 80 by default" do
+      expect(subject.server_ports).to eql([80])
+    end
+
+    it "parses to Array of Integer" do
+      expect {
+        subject.server_ports = '80,81'
+      }.to change(subject, :server_ports).to [80, 81]
+    end
+
+    it "complains when trying to set invalid values" do
+      expect {
+        subject.server_ports = '80a'
+      }.to raise_error(ArgumentError, /invalid value for Integer/)
+    end
+  end
+
+  describe "#server_names" do
+    it "is 'localhost' by default" do
+      expect(subject.server_names).to eql(%w(localhost))
+    end
+
+    it "parses to Array of String" do
+      expect {
+        subject.server_names = 'localhost , test.host'
+      }.to change(subject, :server_names).to %w(localhost test.host)
+    end
+  end
+
+  describe "#instance_ports" do
+    it "is empty by default" do
+      expect(subject.instance_ports).to be_empty
+    end
+
+    it "parses to Array of Integer" do
+      expect {
+        subject.instance_ports = '5000,5001'
+      }.to change(subject, :instance_ports).to [5000, 5001]
+    end
+
+    it "complains when trying to set invalid values" do
+      expect {
+        subject.instance_ports = '5000a'
+      }.to raise_error(ArgumentError, /invalid value for Integer/)
+    end
+  end
+
+  describe "#relative_root" do
+    it "is '/' by default" do
+      expect(subject.relative_root).to eql('/')
+    end
+
+    it "appends '/' at end" do
+      expect {
+        subject.relative_root = '/myapp'
+      }.to change(subject, :relative_root).to '/myapp/'
+    end
+
+    it "strips redundant slashes" do
+      expect {
+        subject.relative_root = '/path//to///myapp////'
+      }.to change(subject, :relative_root).to '/path/to/myapp/'
+    end
+  end
+
+  describe "#cmdline" do
+    it "is empty by default" do
+      subject.cmdline.should be_empty
+    end
+
+    it "can be append to using the shovel operator" do
+      subject.cmdline.should respond_to(:<<)
+    end
+
+    it "can be coerced into string" do
+      subject.cmdline.should respond_to(:to_str)
+    end
+  end
+
+  describe "#generator" do
+    it "is present by default" do
+      expect(subject.generator).to be
+    end
+
+    it "is resolved into a generator plugin" do
+      generator = double('generator')
+      subject.send(:registry).merge!('test' => generator)
+      expect {
+        subject.generator = 'test'
+      }.to change(subject, :generator).to generator
+    end
+
+    it "complains when trying to set invalid values" do
+      expect {
+        subject.generator = 'xyzzy'
+      }.to raise_error(ArgumentError, /unsupported generator/)
+    end
+  end
+
+  describe "#generator_options" do
+    it "is empty by default" do
+      expect(subject.generator_options).to be_empty
+    end
+
+    it "parses to Hash[key=value]" do
+      expect {
+        subject.generator_options = 'k=a=b , l=j'
+      }.to change(subject, :generator_options).to Hash['k' => 'a=b', 'l' => 'j']
+    end
+  end
+end

data/vhost_generator.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vhost_generator/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vhost_generator"
+  gem.version       = VhostGenerator::VERSION
+  gem.authors       = ["Julien Pervillé"]
+  gem.email         = ["julien.perville@mingalar.fr"]
+  gem.description   = ['vhost_generator outputs a general-purpose VirtualHost',
+                       'configuration file to run your web application behind',
+                       'an nginx or apache frontend'].join(' ')
+  gem.summary       = ['vhost_generator outputs nginx or apache VirtualHost',
+                       'configurations to run your web application'].join(' ')
+  gem.homepage      = "https://github.com/mingalar/vhost_generator"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency('dotenv', '~> 0.2.0')
+  gem.add_development_dependency('rake', '~> 0.9.2.2')
+  gem.add_development_dependency('cucumber', '~> 1.2.1')
+  gem.add_development_dependency('aruba', '~> 0.4.11')
+  gem.add_development_dependency('rspec', '~> 2.11.0')
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: vhost_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Julien Pervillé
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.11
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: vhost_generator outputs a general-purpose VirtualHost configuration file
+  to run your web application behind an nginx or apache frontend
+email:
+- julien.perville@mingalar.fr
+executables:
+- vhost-generator
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/vhost-generator
+- features/help.feature
+- features/output-nginx.feature
+- features/step_definitions/dev_steps.rb
+- features/support/env.rb
+- features/version.feature
+- lib/vhost_generator.rb
+- lib/vhost_generator/application.rb
+- lib/vhost_generator/nginx_generator.rb
+- lib/vhost_generator/version.rb
+- lib/vhost_generator/vhost_configuration.rb
+- lib/vhost_generator/vhost_generator_module.rb
+- spec/application_env_spec.rb
+- spec/application_options_spec.rb
+- spec/nginx_generator_spec.rb
+- spec/vhost_configuration_spec.rb
+- vhost_generator.gemspec
+homepage: https://github.com/mingalar/vhost_generator
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -198369393
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -198369393
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: vhost_generator outputs nginx or apache VirtualHost configurations to run
+  your web application
+test_files:
+- features/help.feature
+- features/output-nginx.feature
+- features/step_definitions/dev_steps.rb
+- features/support/env.rb
+- features/version.feature
+- spec/application_env_spec.rb
+- spec/application_options_spec.rb
+- spec/nginx_generator_spec.rb
+- spec/vhost_configuration_spec.rb