nginxtra 1.2.1.2 → 1.2.1.3

data/VERSION

@@ -1 +1 @@
-1.2.1.2
+1.2.1.3

data/bin/nginxtra

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 require "rubygems"
-gem "nginxtra", "= 1.2.1.2"
+gem "nginxtra", "= 1.2.1.3"
 require "nginxtra"
 Nginxtra::CLI.start

data/lib/nginxtra/actions/convert.rb

@@ -44,15 +44,23 @@ module Nginxtra
         return if @thor.options["ignore-nginx-bin"]
 
         if @thor.options["nginx-bin"]
-          @thor.run "#{@thor.options["nginx-bin"]} -V 2>&1", :capture => true
+          binary = @thor.options["nginx-bin"]
         else
-          # TODO: Figure out the nginx binary location and call -V
-          raise "The auto detection of nginx binary is not yet implemented.  Please use the --nginx-bin option for now."
+          binary = etc_nginx_binary
         end
+
+        @thor.run "#{binary} -V 2>&1", :capture => true
+      end
+
+      def etc_nginx_binary
+        raise Nginxtra::Error::ConvertFailed.new("Cannot find nginx binary", :header => "Cannot find nginx binary!", :message => "Either point to it via --nginx-bin or ignore the binary with --ignore-nginx-bin") unless File.exists? "/etc/init.d/nginx"
+        binary = File.read("/etc/init.d/nginx")[/\s*DAEMON\s*=\s*(.*?)\s*$/, 1]
+        raise Nginxtra::Error::ConvertFailed.new("Cannot determine nginx binary", :header => "Cannot find nginx binary!", :message => "The binary location of nginx cannot be determined from /etc/init.d/nginx.  Either point to it via --nginx-bin or ignore the binary with --ignore-nginx-bin") unless binary
+        binary
       end
 
       def open_file(path)
-        raise "Missing config file #{path}" unless File.exists? path
+        raise Nginxtra::Error::ConvertFailed.new("Missing config file #{path}") unless File.exists? path
 
         File.open(path, "r").tap do |stream|
           @streams_to_close << stream

data/lib/nginxtra/actions/install.rb

@@ -11,9 +11,6 @@ module Nginxtra
       # if run with --non-interactive mode.
       def optional_install
         return installation_skipped if non_interactive?
-        # TODO: Raise an error if nginx is determined to be installed
-        # (via /etc/init.d/nginx perhaps... but allow ignoring this
-        # check).
         return up_to_date unless should_install?
         return unless requesting_install?
         install
@@ -22,11 +19,25 @@ module Nginxtra
       # Run the installation of nginxtra.
       def install
         return up_to_date unless should_install?
+        check_if_nginx_is_installed
         create_etc_script
         remember_config_location
         update_last_install
       end
 
+      # Look for nginx installation and fail if it exists (unless
+      # --ignore-nginx-check is passed).
+      def check_if_nginx_is_installed
+        return unless File.exists?("/etc/init.d/nginx")
+
+        if @thor.options["ignore-nginx-check"]
+          @thor.say @thor.set_color("Detected nginx install, but ignoring!", :red, true)
+          return
+        end
+
+        raise Nginxtra::Error::NginxDetected.new("Uninstall nginx before installing nginxtra", :header => "It appears nginx is already installed!", :message => "Since /etc/init.d/nginx exists, you might have an existing nginx installation that will conflict with nginxtra.  If you want to install nginxtra alongside nginx (at your own risk), please include the --ignore-nginx-check option to bypass this check.")
+      end
+
       # Create a script in the base directory which be symlinked to
       # /etc/init.d/nginxtra and then used to start and stop nginxtra
       # via update-rc.d.
@@ -53,7 +64,8 @@ export GEM_PATH="#{ENV["GEM_PATH"]}"
           @thor.chmod filename, 0755
         end
 
-        run! %{#{sudo true}rm /etc/init.d/nginxtra && #{sudo true}ln -s "#{File.join Nginxtra::Config.base_dir, filename}" /etc/init.d/nginxtra}
+        run! %{#{sudo true}rm /etc/init.d/nginxtra} if File.exists? "/etc/init.d/nginxtra"
+        run! %{#{sudo true}ln -s "#{File.join Nginxtra::Config.base_dir, filename}" /etc/init.d/nginxtra}
         run! %{#{sudo true}update-rc.d nginxtra defaults}
       end
 

data/lib/nginxtra/actions/start.rb

@@ -34,7 +34,7 @@ module Nginxtra
       # Save nginx config files to the proper config file path.
       def save_config_files
         files = @config.files
-        raise Nginxtra::Error::InvalidConfig.new("Missing definition for nginx.conf") unless files.include? "nginx.conf"
+        raise Nginxtra::Error::InvalidConfig.new("Missing definition for nginx.conf", :header => "Missing definition for nginx.conf!", :message => "You must define your nginx.conf configuration in your nginxtra.conf.rb file.") unless files.include? "nginx.conf"
 
         @thor.inside Nginxtra::Config.config_dir do
           files.each do |filename|

data/lib/nginxtra/cli.rb

@@ -5,7 +5,9 @@ module Nginxtra
     include Thor::Actions
 
     class_option "force", :type => :boolean, :banner => "Force a task to happen, regardless of what nginxtra thinks", :aliases => "-f"
+    class_option "trace", :type => :boolean, :banner => "Output stack traces on error"
     class_option "non-interactive", :type => :boolean, :banner => "If nginxtra would ask a question, it instead proceeds as if 'no' were the answer", :aliases => "-I"
+    class_option "ignore-nginx-check", :type => :boolean, :banner => "Ignore the nginx check if installing"
     class_option "config", :type => :string, :banner => "Specify the configuration file to use", :aliases => "-c"
     class_option "basedir", :type => :string, :banner => "Specify the directory to store nginx files", :aliases => "-b"
 
@@ -26,7 +28,9 @@ module Nginxtra
     method_option "output", :type => :boolean, :banner => "Output to standard out instead of to a file", :aliases => "-o"
     method_option "input", :type => :boolean, :banner => "Read nginx.conf from standard in instead of a file", :aliases => "-i"
     def convert
-      Nginxtra::Actions::Convert.new(self, nil).convert
+      Nginxtra::Error.protect self do
+        Nginxtra::Actions::Convert.new(self, nil).convert
+      end
     end
 
     desc "compile", "Compiles nginx based on nginxtra.conf.rb"
@@ -37,7 +41,9 @@ module Nginxtra
       be executed directly.  However, you can force recompilation by running this task
       with the --force option."
     def compile
-      Nginxtra::Actions::Compile.new(self, prepare_config!).compile
+      Nginxtra::Error.protect self do
+        Nginxtra::Actions::Compile.new(self, prepare_config!).compile
+      end
     end
 
     desc "install", "Installs nginxtra"
@@ -47,7 +53,9 @@ module Nginxtra
       already installed with this version of nginxtra.  If it was already installed,
       installation will be skipped unless the --force option is given."
     def install
-      Nginxtra::Actions::Install.new(self, prepare_config!).install
+      Nginxtra::Error.protect self do
+        Nginxtra::Actions::Install.new(self, prepare_config!).install
+      end
     end
 
     desc "start", "Start nginx with configuration defined in nginxtra.conf.rb"
@@ -61,7 +69,9 @@ module Nginxtra
       compilation and installation will NOT be forced with --force option.  The
       compile or install task should be invoked if those need to be forced."
     def start
-      Nginxtra::Actions::Start.new(self, prepare_config!).start
+      Nginxtra::Error.protect self do
+        Nginxtra::Actions::Start.new(self, prepare_config!).start
+      end
     end
 
     desc "stop", "Stop nginx"
@@ -70,23 +80,31 @@ module Nginxtra
       determined to be running, this command will do nothing, unless --force is passed
       (which will cause it to run the stop command regardless of the pidfile)."
     def stop
-      Nginxtra::Actions::Stop.new(self, prepare_config!).stop
+      Nginxtra::Error.protect self do
+        Nginxtra::Actions::Stop.new(self, prepare_config!).stop
+      end
     end
 
     desc "restart", "Restart nginx"
     def restart
-      Nginxtra::Actions::Restart.new(self, prepare_config!).restart
+      Nginxtra::Error.protect self do
+        Nginxtra::Actions::Restart.new(self, prepare_config!).restart
+      end
     end
     map "force-reload" => "restart"
 
     desc "reload", "Reload nginx"
     def reload
-      Nginxtra::Actions::Reload.new(self, prepare_config!).reload
+      Nginxtra::Error.protect self do
+        Nginxtra::Actions::Reload.new(self, prepare_config!).reload
+      end
     end
 
     desc "status", "Check if nginx is running"
     def status
-      Nginxtra::Actions::Status.new(self, prepare_config!).status
+      Nginxtra::Error.protect self do
+        Nginxtra::Actions::Status.new(self, prepare_config!).status
+      end
     end
 
     private

data/lib/nginxtra/config.rb

@@ -25,6 +25,15 @@ module Nginxtra
       self
     end
 
+    # Support simple configuration in a special block.  This will
+    # allow wholesale configuration like for rails.  It supports the
+    # :worker_processes and :worker_connections options, which will
+    # affect the resulting configuration.
+    def simple_config(options = {}, &block)
+      SimpleConfig.new(self, options, &block).process!
+      self
+    end
+
     # Notify nginxtra that root access is needed to run the daemon
     # commands.  Sudo will automatically be used if the current user
     # isn't root.
@@ -68,10 +77,10 @@ module Nginxtra
     #   end
     def compile_option(opt)
       opt = "--#{opt}" unless opt =~ /^--/
-      raise Nginxtra::Error::InvalidConfig.new("The --prefix compile option is not allowed with nginxtra.  It is reserved so nginxtra can control where nginx is compiled and run from.") if opt =~ /--prefix=/
-      raise Nginxtra::Error::InvalidConfig.new("The --sbin-path compile option is not allowed with nginxtra.  It is reserved so nginxtra can control what binary is used to run nginx.") if opt =~ /--sbin-path=/
-      raise Nginxtra::Error::InvalidConfig.new("The --conf-path compile option is not allowed with nginxtra.  It is reserved so nginxtra can control the configuration entirely via #{Nginxtra::Config::FILENAME}.") if opt =~ /--conf-path=/
-      raise Nginxtra::Error::InvalidConfig.new("The --pid-path compile option is not allowed with nginxtra.  It is reserved so nginxtra can control where the pid file is created.") if opt =~ /--pid-path=/
+      raise Nginxtra::Error::InvalidConfig.new("Invalid compilation option --prefix", :header => "Invalid compilation option --prefix", :message => "The --prefix compile option is not allowed with nginxtra.  It is reserved so nginxtra can control where nginx is compiled and run from.") if opt =~ /--prefix=/
+      raise Nginxtra::Error::InvalidConfig.new("Invalid compilation option --sbin-path", :header => "Invalid compilation option --sbin-path", :message => "The --sbin-path compile option is not allowed with nginxtra.  It is reserved so nginxtra can control what binary is used to run nginx.") if opt =~ /--sbin-path=/
+      raise Nginxtra::Error::InvalidConfig.new("Invalid compilation option --conf-path", :header => "Invalid compilation option --conf-path", :message => "The --conf-path compile option is not allowed with nginxtra.  It is reserved so nginxtra can control the configuration entirely via #{Nginxtra::Config::FILENAME}.") if opt =~ /--conf-path=/
+      raise Nginxtra::Error::InvalidConfig.new("Invalid compilation option --pid-path", :header => "Invalid compilation option --pid-path", :message => "The --pid-path compile option is not allowed with nginxtra.  It is reserved so nginxtra can control where the pid file is created.") if opt =~ /--pid-path=/
       @compile_options << opt
     end
 
@@ -84,7 +93,7 @@ module Nginxtra
     # Define a new config file with the given filename and the block
     # to define it with.
     def file(filename, &block)
-      @files[filename] = Nginxtra::Config::ConfigFile.new(&block)
+      @files[filename] = Nginxtra::Config::ConfigFile.new(self, &block)
     end
 
     # Retrieve the files that have been defined.
@@ -194,6 +203,17 @@ module Nginxtra
         File.join base_nginx_dir, "build"
       end
 
+      # Retrieve the directory where templates are loaded from.
+      def template_dir
+        File.join base_dir, "templates"
+      end
+
+      # Retrieve the directory within the gem where templates are
+      # loaded from.
+      def gem_template_dir
+        File.join gem_dir, "templates"
+      end
+
       # The path to the config directory where nginx config files are
       # stored (including nginx.conf).
       def config_dir
@@ -227,7 +247,7 @@ module Nginxtra
       # be found.
       def passenger_spec
         @passenger_spec ||= Gem::Specification.find_by_name("passenger").tap do |spec|
-          raise InvalidConfig.new("You cannot reference passenger unless the passenger gem is installed!") if spec.nil?
+          raise InvalidConfig.new("Missing passenger gem", :header => "Missing passenger gem!", :message => "You cannot reference passenger unless the passenger gem is installed!") if spec.nil?
         end
       end
 
@@ -244,14 +264,18 @@ module Nginxtra
 
     # Represents a config file being defined by nginxtra.conf.rb.
     class ConfigFile
-      def initialize(&block)
+      def initialize(config, &block)
+        @config = config
+        @indentation = Nginxtra::Config::Indentation.new :indent_size => 4
         @file_contents = []
         instance_eval &block
       end
 
       # The file contents that were defined for this config file.
       def config_file_contents
-        @file_contents.join "\n"
+        result = @file_contents.join "\n"
+        result += "\n" unless result.empty?
+        result
       end
 
       # Add a new line to the config.  A semicolon is added
@@ -263,7 +287,8 @@ module Nginxtra
       #     config_line "worker_processes 42"
       #   end
       def config_line(contents)
-        @file_contents << "#{contents};"
+        @begin_of_block = false
+        bare_config_line "#{contents};"
       end
 
       # Add a new line to the config, but without a semicolon at the
@@ -274,7 +299,14 @@ module Nginxtra
       #     bare_config_line "a line with no semicolon"
       #   end
       def bare_config_line(contents)
-        @file_contents << contents
+        @begin_of_block = false
+        @file_contents << "#{@indentation}#{contents}"
+      end
+
+      # Add an empty config line to the resulting config file.
+      def empty_config_line
+        @begin_of_block = false
+        @file_contents << ""
       end
 
       # Add a new block to the config.  This will result in outputting
@@ -290,9 +322,32 @@ module Nginxtra
       #     end
       #   end
       def config_block(name)
-        @file_contents << "#{name} {"
+        empty_config_line unless @file_contents.empty? || @begin_of_block
+        bare_config_line "#{name} {"
+        @begin_of_block = true
+        @indentation + 1
         yield if block_given?
-        @file_contents << "}"
+        @indentation - 1
+        bare_config_line "}"
+      end
+
+      # Process the given template.  Optionally, include options (as
+      # yielded values) available to the template.  The yielder passed
+      # in will be invoked (if given) if the template invokes yield.
+      def process_template!(template, options = {}, yielder = nil)
+        process_template_with_yields! template do |x|
+          if x
+            options[x.to_sym]
+          else
+            instance_eval &yielder if yielder
+          end
+        end
+      end
+
+      # Helper method for process_template! Which is expected to have
+      # a block passed in to handle yields from within the template.
+      def process_template_with_yields!(template)
+        instance_eval File.read(template)
       end
 
       # Arbitrary config can be specified as long as the name doesn't
@@ -335,6 +390,116 @@ module Nginxtra
         config_line %{passenger_enabled on}
       end
     end
+
+    # A class for encapsulating simple configuration.
+    class SimpleConfig
+      def initialize(config, options = {}, &block)
+        @config = config
+        @options = options
+        @invoked_partials = []
+        instance_eval &block
+      end
+
+      # Process the simple config.
+      def process!
+        gem_files = find_config_files! File.join(Nginxtra::Config.gem_template_dir, "files")
+        override_files = find_config_files! File.join(Nginxtra::Config.template_dir, "files")
+
+        config_files = (gem_files.keys + override_files.keys).uniq.map do |x|
+          override_files[x] || gem_files[x]
+        end
+
+        process_files! config_files
+      end
+
+      # Find all the config files at the given path directory.  The
+      # result will be a hash of hashes.  The key on the outer hash is
+      # the output config file name, while the value is a hash of
+      # :path to the original file path, and :config_file to the
+      # output config file name.
+      def find_config_files!(path)
+        files_hash = {}
+
+        Dir["#{path}/**/*.rb"].select do |x|
+          File.file? x
+        end.map do |x|
+          file_name = x.sub /^#{Regexp.quote "#{path}"}\/(.*)\.rb$/, "\\1"
+          { :path => x, :config_file => file_name }
+        end.each do |x|
+          files_hash[x[:config_file]] = x
+        end
+
+        files_hash
+      end
+
+      # Process all config files passed in, where each is a hash with
+      # :path to the original path of the file, and :config_file to
+      # the output config file name.
+      def process_files!(files)
+        files.each do |x|
+          path = x[:path]
+          file_name = x[:config_file]
+          options = @options
+          invoked_partials = @invoked_partials
+
+          yielder = proc do
+            invoked_partials.each do |partial|
+              method, args, block = partial
+              partial_end_path = "partials/#{file_name}/#{method}.rb"
+              partial_path = File.join Nginxtra::Config.gem_template_dir, partial_end_path
+              override_partial_path = File.join Nginxtra::Config.template_dir, partial_end_path
+              partial_options = {}
+              partial_options = args.first if args.length > 0 && args.first.kind_of?(Hash)
+
+              if File.exists? override_partial_path
+                process_template! override_partial_path, partial_options
+              elsif File.exists? partial_path
+                process_template! partial_path, partial_options
+              end
+            end
+          end
+
+          @config.file file_name do
+            process_template! path, options, yielder
+          end
+        end
+      end
+
+      def method_missing(method, *args, &block)
+        @invoked_partials << [method, args, block]
+      end
+    end
+
+    class Indentation
+      attr_reader :value
+
+      def initialize(options = {})
+        @value = 0
+        @options = options
+      end
+
+      def indent_size
+        @options[:indent_size] || 2
+      end
+
+      def done?
+        @value == 0
+      end
+
+      def -(amount)
+        self + (-amount)
+      end
+
+      def +(amount)
+        @value += amount
+        raise Nginxtra::Error::ConvertFailed.new("Missing block end!") if @value < 0
+        @value
+      end
+
+      def to_s
+        " " * indent_size * @value
+      end
+    end
   end
 end
 

data/lib/nginxtra/config_converter.rb

@@ -3,7 +3,7 @@ module Nginxtra
     def initialize(output)
       @converted = false
       @output = output
-      @indentation = Nginxtra::ConfigConverter::Indentation.new
+      @indentation = Nginxtra::Config::Indentation.new
     end
 
     def convert(options)
@@ -229,7 +229,7 @@ module Nginxtra
       end
 
       def puts_line
-        raise Nginxtra::Error::ConvertFailed.new("line must have a first label!") unless @tokens.length > 1
+        raise Nginxtra::Error::ConvertFailed.new("Line must have a first label!") unless @tokens.length > 1
         return puts_passenger if passenger?
         print_indentation
         print_first
@@ -294,31 +294,5 @@ module Nginxtra
         @indentation - 1
       end
     end
-
-    class Indentation
-      attr_reader :value
-
-      def initialize
-        @value = 0
-      end
-
-      def done?
-        @value == 0
-      end
-
-      def -(amount)
-        self + (-amount)
-      end
-
-      def +(amount)
-        @value += amount
-        raise Nginxtra::Error::ConvertFailed.new("Missing block end!") if @value < 0
-        @value
-      end
-
-      def to_s
-        "  " * @value
-      end
-    end
   end
 end

data/lib/nginxtra/error.rb

@@ -1,16 +1,52 @@
 module Nginxtra
   module Error
+    # Base error with all the base functionality.
+    class Base < StandardError
+      def initialize(message, options = nil)
+        @options = options
+        super(message)
+      end
+
+      def output(thor)
+        options = @options || { :header => message }
+        Nginxtra::Error.print_error thor, options
+      end
+    end
+
+    # Raised if config conversion fails
+    class ConvertFailed < Nginxtra::Error::Base; end
+
     # Raised when an invalid configuration is specified, such as the
     # --prefix compile option.
-    class InvalidConfig < StandardError; end
+    class InvalidConfig < Nginxtra::Error::Base; end
 
     # Raised when the config file cannot be found.
-    class MissingConfig < StandardError; end
+    class MissingConfig < Nginxtra::Error::Base; end
+
+    # Raised when installing and nginx is detected to be installed.
+    class NginxDetected < Nginxtra::Error::Base; end
 
     # Raised when a run command fails
-    class RunFailed < StandardError; end
+    class RunFailed < Nginxtra::Error::Base; end
 
-    # Raised if config conversion fails
-    class ConvertFailed < StandardError; end
+    class << self
+      def print_error(thor, options)
+        text = "" << thor.set_color(options[:header], :red, true)
+        text << "\n\n" << thor.set_color(options[:message], :red, false) if options[:message]
+        thor.print_wrapped text
+      end
+
+      def protect(thor)
+        begin
+          yield
+        rescue Nginxtra::Error::Base => e
+          e.output thor
+          raise if thor.options["trace"]
+        rescue => e
+          print_error thor, :header => "An unexpected error occurred!"
+          raise if thor.options["trace"]
+        end
+      end
+    end
   end
 end

data/lib/nginxtra/status.rb

@@ -37,7 +37,7 @@ module Nginxtra
         return if @@status
 
         if File.exists? path
-          @@status = YAML.load File.read path
+          @@status = YAML.load File.read(path)
         else
           @@status = {}
         end
@@ -50,7 +50,9 @@ module Nginxtra
 
       # Save the current state to disk.
       def save!
-        File.write path, YAML.dump(@@status)
+        File.open path, "w" do |file|
+          file << YAML.dump(@@status)
+        end
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nginxtra
 version: !ruby/object:Gem::Version
-  version: 1.2.1.2
+  version: 1.2.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-06 00:00:00.000000000 Z
+date: 2012-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &10550480 !ruby/object:Gem::Requirement
+  requirement: &10532080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 0.15.0
   type: :runtime
   prerelease: false
-  version_requirements: *10550480
+  version_requirements: *10532080
 description: This gem is intended to provide an easy to use configuration file that
   will automatically be used to compile nginx and configure the configuration.
 email: reasonnumber@gmail.com