vhost_generator 0.1.0 → 0.2.0

data/README.md

@@ -8,10 +8,8 @@ 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`.
+* reading configuration parameters from `ENV` (or from the `.env` file if invoked via `foreman run`)
+
 
 ## Installation
 
@@ -37,27 +35,23 @@ Advanced usage: all command-line switches have their equivalent environment vari
 
     $ 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.
+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)
+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
 
+Check the comment at top of each virtualhost configuration file for a command-line that can regenerate the file.
+
 ## Contributing
 
 1. Fork it

data/features/output-nginx.feature

@@ -53,67 +53,6 @@ Feature: Output nginx configuration file
       }
       """
 
-  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"

data/features/version.feature

@@ -8,5 +8,5 @@ Feature: Output program version
     When I run `bundle exec vhost-generator --version`
     Then it should pass with:
       """
-      vhost-generator, version 0.1.0
+      vhost-generator, version 0.2.0
       """

data/lib/vhost_generator/application.rb

@@ -1,8 +1,7 @@
 require 'vhost_generator/version'
+require 'vhost_generator/cmdline_builder'
 require 'vhost_generator/vhost_configuration'
 require 'optparse'
-require 'ostruct'
-require 'dotenv'
 
 module VhostGenerator
 
@@ -22,13 +21,9 @@ module VhostGenerator
     # 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
+        config.cmdline = CmdlineBuilder.new(config, Dir.pwd, $0, ENV)
         @output_stream.puts config.output
       end
     end

data/lib/vhost_generator/cmdline_builder.rb

@@ -0,0 +1,60 @@
+require 'shellwords'
+
+module VhostGenerator
+
+  # Represents a Shell command line (to display in vhost comments)
+  class CmdlineBuilder
+    attr_writer :config, :cwd, :progname, :env
+
+    def initialize(config, cwd, progname, env)
+      self.config = config
+      self.cwd = cwd
+      self.progname = progname
+      self.env = env
+    end
+
+    def cwd
+      @cwd ? ['cd', @cwd] : nil
+    end
+
+    def progname
+      if @progname
+        if @env.keys.grep(/^BUNDLE_/).empty?
+          [@progname]
+        else
+          ['bundle', 'exec', File.basename(@progname)]
+        end
+      end
+    end
+
+    def progargs
+      args = []
+      args << '-f' << @config.static_folder
+      args << '-l' << @config.server_ports.join(',')
+      args << '-s' << @config.server_names.join(',')
+      args << '-p' << @config.instance_ports.join(',')
+      args << '-r' << @config.relative_root
+      args << '-g' << 'nginx' # FIXME use @config.generator when real registry
+      options = @config.generator_options.collect {|k,v| "#{k}=#{v}" }
+      args << '-o' << options.join(',')
+      args
+    end
+
+    def commands
+      if prog_name = progname
+        [cwd, prog_name + progargs].compact
+      else
+        []
+      end
+    end
+
+    def to_str
+      parts = commands.collect { |cmd| Shellwords.shelljoin(cmd) }
+      if parts.length > 1
+        "(#{ parts.join(' && ') })"
+      else
+        parts.first
+      end
+    end
+  end
+end

data/lib/vhost_generator/version.rb

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

data/lib/vhost_generator/vhost_configuration.rb

@@ -3,37 +3,25 @@ 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,
+                :instance_ports, :relative_root,
                 :generator, :generator_options
+    attr_accessor :cmdline
 
     def initialize(static_folder='public', server_ports='80',
         server_names='localhost', instance_ports='', relative_root='/',
-        cmdlinebuilder=ShellCmdLine, generator='nginx', generator_options='')
+        generator='nginx', generator_options='', cmdline=nil)
       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.cmdline = cmdline # usually set later using attr_writer
       self.generator = generator
       self.generator_options = generator_options
     end
@@ -76,8 +64,6 @@ module VhostGenerator
 
     protected
 
-    attr_writer :cmdline
-
     def generator_for(name)
       raise ArgumentError, "unsupported generator: %s, try any of %s." % [
           name.inspect, registry.keys.inspect

data/script/cibuild

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+set -e
+
+bundle install --path .bundle
+
+bundle exec rake features
+
+bundle exec rake spec

data/spec/cmdline_builder_spec.rb

@@ -0,0 +1,106 @@
+require 'vhost_generator/cmdline_builder'
+
+describe VhostGenerator::CmdlineBuilder do
+  let(:config) { double('vhost config').as_null_object }
+  subject do
+    described_class.new(config, nil, nil, [])
+  end
+
+  describe "#cwd" do
+    context "when a current directory is provided" do
+      it "returns 'cd' followed by the current directory" do
+        subject.cwd = 'CWD'
+        expect(subject.cwd).to eql(['cd', 'CWD'])
+      end
+    end
+
+    context "when no current directory is provided" do
+      it "is nil" do
+        subject.cwd = nil
+        expect(subject.cwd).to be_nil
+      end
+    end
+  end
+
+  describe "#progname" do
+    before { subject.progname = '/path/to/progname' }
+
+    context "when no progname is provided" do
+      it "is nil" do
+        subject.progname = nil
+        expect(subject.progname).to be_nil
+      end
+    end
+
+    context "when bundler is in environment" do
+      it "returns 'bundle exec' followed by the basename" do
+        subject.env = Hash['BUNDLE_GEMFILE' => true, 'BUNDLE_BIN' => 'true']
+        expect(subject.progname).to eql(['bundle', 'exec', 'progname'])
+      end
+    end
+
+    context "when bundler is not in environment" do
+      it "returns the full program name" do
+        subject.env = Hash[]
+        expect(subject.progname).to eql(['/path/to/progname'])
+      end
+    end
+  end
+
+  describe "#progargs" do
+    it "describes config as commandline switches" do
+      subject.config = mock(:static_folder => 'SF', :server_ports => [80,81],
+                            :server_names => %w(A B),
+                            :instance_ports => [5000,5001],
+                            :relative_root => 'RR', :generator => 'nginx',
+                            :generator_options => {'k' => 'a=b', 'l' => 'c'})
+      expect(subject.progargs).to eql(['-f', 'SF', '-l', '80,81', '-s', 'A,B',
+                                       '-p', '5000,5001', '-r', 'RR',
+                                       '-g', 'nginx', '-o', 'k=a=b,l=c'])
+    end
+  end
+
+  describe "#commands" do
+    context "when a pwd is present" do
+      it "is same as [#pwd, #progname + #progargs]" do
+        subject.should_receive(:cwd).and_return('CWD')
+        subject.should_receive(:progname).and_return('PROGNAME')
+        subject.should_receive(:progargs).and_return('ARGS')
+        expect(subject.commands).to eql(['CWD', 'PROGNAMEARGS'])
+      end
+    end
+
+    context "when no pwd is present" do
+      it "is same as [#progname + #progargs]" do
+        subject.should_receive(:cwd).and_return(nil)
+        subject.should_receive(:progname).and_return('PROGNAME')
+        subject.should_receive(:progargs).and_return('ARGS')
+        expect(subject.commands).to eql(['PROGNAMEARGS'])
+      end
+    end
+
+    context "when no progname is present" do
+      it "is empty" do
+        subject.should_receive(:progname).and_return(nil)
+        expect(subject.commands).to be_empty
+      end
+    end
+  end
+
+  describe "#to_str" do
+    let(:cmd1) { %w(cd /path/to/directory) }
+    let(:cmd2) { %w(bundle exec progname -x arg -y arg2) }
+
+    it "is escaped #commands" do
+      subject.should_receive(:commands).and_return([cmd2])
+      cmdline = "bundle exec progname -x arg -y arg2"
+      expect(subject.to_str).to eql(cmdline)
+    end
+
+    it "is escaped #commands joined by && & parenthesis" do
+      subject.should_receive(:commands).and_return([cmd1, cmd2])
+      cmdline = "(cd /path/to/directory && bundle exec progname -x arg -y arg2)"
+      expect(subject.to_str).to eql(cmdline)
+    end
+  end
+end

data/spec/vhost_configuration_spec.rb

@@ -79,20 +79,6 @@ describe VhostGenerator::VhostConfiguration do
     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

data/vhost_generator.gemspec

@@ -17,10 +17,9 @@ Gem::Specification.new do |gem|
 
   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.test_files    = gem.files.grep(%r{^(test|spec|features|script)/})
   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')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vhost_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-30 00:00:00.000000000 Z
+date: 2012-10-01 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
@@ -113,12 +97,15 @@ files:
 - features/version.feature
 - lib/vhost_generator.rb
 - lib/vhost_generator/application.rb
+- lib/vhost_generator/cmdline_builder.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
+- script/cibuild
 - spec/application_env_spec.rb
 - spec/application_options_spec.rb
+- spec/cmdline_builder_spec.rb
 - spec/nginx_generator_spec.rb
 - spec/vhost_configuration_spec.rb
 - vhost_generator.gemspec
@@ -136,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -198369393
+      hash: -418120369
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -145,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -198369393
+      hash: -418120369
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -159,7 +146,9 @@ test_files:
 - features/step_definitions/dev_steps.rb
 - features/support/env.rb
 - features/version.feature
+- script/cibuild
 - spec/application_env_spec.rb
 - spec/application_options_spec.rb
+- spec/cmdline_builder_spec.rb
 - spec/nginx_generator_spec.rb
 - spec/vhost_configuration_spec.rb