nginxtra 1.8.0.11 → 1.8.1.12

data/lib/nginxtra/config_converter.rb

@@ -7,7 +7,7 @@ module Nginxtra
     end
 
     def convert(options)
-      raise Nginxtra::Error::ConvertFailed.new("The convert method can only be called once!") if converted?
+      raise Nginxtra::Error::ConvertFailed, "The convert method can only be called once!" if converted?
       header
       compile_options options[:binary_status]
       config_file options[:config]
@@ -16,32 +16,33 @@ module Nginxtra
     end
 
     private
+
     def header
       @output.puts "nginxtra.config do"
-      @indentation + 1
+      @indentation.increment
     end
 
     def compile_options(status)
       return unless status
       options = (status[/^configure arguments:\s*(.*)$/, 1] || "").strip
       return if options.empty?
-      options = options.split /\s+/
+      options = options.split(/\s+/)
       process_passenger_compile_options! options
 
       options.each do |option|
         next if invalid_compile_option? option
         @output.print @indentation
-        @output.puts %{compile_option "#{option}"}
+        @output.puts %(compile_option "#{option}")
       end
     end
 
     def process_passenger_compile_options!(options)
-      return if options.select { |x| x =~ /^--add-module.*\/passenger.*/ }.empty?
+      return if options.select { |x| x =~ %r{^--add-module.*/passenger.*} }.empty?
       @output.print @indentation
       @output.puts "require_passenger!"
 
       options.delete_if do |x|
-        next true if x =~ /^--add-module.*\/passenger.*/
+        next true if x =~ %r{^--add-module.*/passenger.*}
         ["--with-http_ssl_module", "--with-http_gzip_static_module", "--with-cc-opt=-Wno-error"].include? x
       end
     end
@@ -57,8 +58,8 @@ module Nginxtra
     def config_file(input)
       return unless input
       @output.print @indentation
-      @output.puts %{file "nginx.conf" do}
-      @indentation + 1
+      @output.puts %(file "nginx.conf" do)
+      @indentation.increment
       line = Nginxtra::ConfigConverter::Line.new @indentation, @output
 
       each_token(input) do |token|
@@ -70,8 +71,8 @@ module Nginxtra
         end
       end
 
-      raise Nginxtra::Error::ConvertFailed.new("Unexpected end of file!") unless line.empty?
-      @indentation - 1
+      raise Nginxtra::Error::ConvertFailed, "Unexpected end of file!" unless line.empty?
+      @indentation.decrement
       @output.print @indentation
       @output.puts "end"
     end
@@ -79,7 +80,10 @@ module Nginxtra
     def each_token(input)
       token = Nginxtra::ConfigConverter::Token.new
 
-      while c = input.read(1)
+      loop do
+        c = input.read(1)
+        break unless c
+
         if c == "#"
           chomp_comment input
         else
@@ -90,19 +94,21 @@ module Nginxtra
       end
 
       yield token.instance while token.ready?
-      raise Nginxtra::Error::ConvertFailed.new("Unexpected end of file in mid token!") unless token.value.empty?
+      raise Nginxtra::Error::ConvertFailed, "Unexpected end of file in mid token!" unless token.value.empty?
     end
 
     def chomp_comment(input)
-      while c = input.read(1)
+      loop do
+        c = input.read(1)
+        break unless c
         break if c == "\n"
       end
     end
 
     def footer
-      @indentation - 1
+      @indentation.decrement
       @output.puts "end"
-      raise Nginxtra::Error::ConvertFailed.new("Missing end blocks!") unless @indentation.done?
+      raise Nginxtra::Error::ConvertFailed, "Missing end blocks!" unless @indentation.done?
     end
 
     def converted!
@@ -114,7 +120,7 @@ module Nginxtra
     end
 
     class Token
-      KEYWORDS = ["break", "if", "return"].freeze
+      KEYWORDS = %w(break if return).freeze
       TERMINAL_CHARACTERS = ["{", "}", ";"].freeze
       attr_reader :value
 
@@ -124,16 +130,16 @@ module Nginxtra
         @ready = false
       end
 
-      def is_if?
+      def if?
         @value == "if"
       end
 
       def if_start!
-        @value.gsub! /^\(/, ""
+        @value.gsub!(/^\(/, "")
       end
 
       def if_end!
-        @value.gsub! /\)$/, ""
+        @value.gsub!(/\)$/, "")
       end
 
       def terminal_character?
@@ -153,7 +159,7 @@ module Nginxtra
       end
 
       def instance
-        raise Nginxtra::Error::ConvertFailed.new("Whoops!") unless ready?
+        raise Nginxtra::Error::ConvertFailed, "Whoops!" unless ready?
         token = Nginxtra::ConfigConverter::Token.new @value
         reset!
         token
@@ -181,11 +187,12 @@ module Nginxtra
         if @value =~ /^\d+$/
           @value
         else
-          %{"#{@value.gsub("\\") { "\\\\" }}"}
+          %("#{@value.gsub("\\") { "\\\\" }}")
         end
       end
 
       private
+
       def space!
         return if @value.empty?
         @ready = true
@@ -202,11 +209,11 @@ module Nginxtra
       end
 
       def reset!
-        if @next
-          @value = @next
-        else
-          @value = ""
-        end
+        @value = if @next
+                   @next
+                 else
+                   ""
+                 end
 
         @next = nil
         @ready = false
@@ -240,21 +247,22 @@ module Nginxtra
         elsif @tokens.last.block_end?
           puts_block_end
         else
-          raise Nginxtra::Error::ConvertFailed.new "Can't puts invalid line!"
+          raise Nginxtra::Error::ConvertFailed, "Can't puts invalid line!"
         end
       end
 
       private
-      def is_if?
-        @tokens.first.is_if?
+
+      def if?
+        @tokens.first.if?
       end
 
       def passenger?
-        ["passenger_root", "passenger_ruby", "passenger_enabled"].include? @tokens.first.value
+        %w(passenger_root passenger_ruby passenger_enabled).include? @tokens.first.value
       end
 
       def puts_line
-        raise Nginxtra::Error::ConvertFailed.new("Line must have a first label!") unless @tokens.length > 1
+        raise Nginxtra::Error::ConvertFailed, "Line must have a first label!" unless @tokens.length > 1
         return puts_passenger if passenger?
         print_indentation
         print_first
@@ -272,12 +280,12 @@ module Nginxtra
         elsif @tokens.first.value == "passenger_enabled"
           print_newline "passenger_on!"
         else
-          raise Nginxtra::Error::ConvertFailed.new("Whoops!")
+          raise Nginxtra::Error::ConvertFailed, "Whoops!"
         end
       end
 
       def puts_block_start
-        raise Nginxtra::Error::ConvertFailed.new("Block start must have a first label!") unless @tokens.length > 1
+        raise Nginxtra::Error::ConvertFailed, "Block start must have a first label!" unless @tokens.length > 1
         print_indentation
         print_first
         print_args
@@ -286,7 +294,7 @@ module Nginxtra
       end
 
       def puts_block_end
-        raise Nginxtra::Error::ConvertFailed.new("Block end can't have labels!") unless @tokens.length == 1
+        raise Nginxtra::Error::ConvertFailed, "Block end can't have labels!" unless @tokens.length == 1
         unindent
         print_indentation
         print_newline("end")
@@ -305,7 +313,7 @@ module Nginxtra
         return if args.empty?
         @output.print " "
 
-        if is_if?
+        if if?
           args.first.if_start!
           args.last.if_end!
         end
@@ -318,11 +326,11 @@ module Nginxtra
       end
 
       def indent
-        @indentation + 1
+        @indentation.increment
       end
 
       def unindent
-        @indentation - 1
+        @indentation.decrement
       end
     end
   end

data/lib/nginxtra/error.rb

@@ -8,7 +8,7 @@ module Nginxtra
       end
 
       def output(thor)
-        options = @options || { :header => message }
+        options = @options || { header: message }
         Nginxtra::Error.print_error thor, options
       end
     end
@@ -16,6 +16,27 @@ module Nginxtra
     # Raised if config conversion fails.
     class ConvertFailed < Nginxtra::Error::Base; end
 
+    # Raised if /etc/init.d/nginx is missing.
+    class NginxInitScriptMissing < Nginxtra::Error::ConvertFailed
+      HEADER = "Cannot find nginx binary!".freeze
+      MESSAGE = "Either point to it via --nginx-bin or ignore the binary with --ignore-nginx-bin".freeze
+
+      def initialize
+        super("Cannot find nginx binary", header: HEADER, message: MESSAGE)
+      end
+    end
+
+    # Raised if the nginx binary cannot be determined from the
+    # /etc/init.d/nginx init script.
+    class UndeterminedNginxBinary < Nginxtra::Error::ConvertFailed
+      HEADER = "Cannot find nginx binary!".freeze
+      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".freeze
+
+      def initialize
+        super("Cannot determine nginx binary", header: HEADER, message: MESSAGE)
+      end
+    end
+
     # Raised when something is in an illegal state, such as when
     # running nginxtra_rails from a directory other than a rails root
     # directory.
@@ -25,11 +46,72 @@ module Nginxtra
     # --prefix compile option.
     class InvalidConfig < Nginxtra::Error::Base; end
 
+    # Subclass of InvalidConfig that indicates an option was provided
+    # that is not allowed.
+    class InvalidCompilationOption < Nginxtra::Error::InvalidConfig
+      MESSAGES = {
+        "prefix" => "The --prefix compile option is not allowed with nginxtra.  It is reserved so nginxtra can control where nginx is compiled and run from.",
+        "sbin-path" => "The --sbin-path compile option is not allowed with nginxtra.  It is reserved so nginxtra can control what binary is used to run nginx.",
+        "conf-path" => "The --conf-path compile option is not allowed with nginxtra.  It is reserved so nginxtra can control the configuration entirely via #{Nginxtra::Config::FILENAME}.",
+        "pid-path" => "The --pid-path compile option is not allowed with nginxtra.  It is reserved so nginxtra can control where the pid file is created."
+      }.freeze
+
+      def initialize(parameter)
+        super("Invalid compilation option --#{parameter}", header: "Invalid compilation option --#{parameter}", message: MESSAGES[parameter])
+      end
+    end
+
+    # Raised when the nginxtra config is missing
+    class MissingNginxConfig < Nginxtra::Error::InvalidConfig
+      HEADER = "Missing definition for nginx.conf!".freeze
+      MESSAGE = "You must define your nginx.conf configuration in your nginxtra.conf.rb file.".freeze
+
+      def initialize
+        super("Missing definition for nginx.conf", header: HEADER, message: MESSAGE)
+      end
+    end
+
+    # Raised if a partial is called with anything but no arguments or
+    # a single Hash.
+    class InvalidPartialArguments < Nginxtra::Error::InvalidConfig
+      HEADER = "Invalid partial arguments!".freeze
+      MESSAGE = "You can only pass 0 arguments or 1 hash to a partial!".freeze
+
+      def initialize
+        super("Invalid partial arguments", header: HEADER, message: MESSAGE)
+      end
+    end
+
+    # Raised if you reference passenger without the passenger gem.
+    class MissingPassengerGem < Nginxtra::Error::InvalidConfig
+      HEADER = "Missing passenger gem!".freeze
+      MESSAGE = "You cannot reference passenger unless the passenger gem is installed!".freeze
+
+      def initialize
+        super("Missing passenger gem", header: HEADER, message: MESSAGE)
+      end
+    end
+
+    # Raise when a config file doesn't actually specify the config
+    class NoConfigSpecified < Nginxtra::Error::InvalidConfig
+      def initialize(config_path)
+        super("No configuration is specified in #{config_path}!")
+      end
+    end
+
     # Raised when the config file cannot be found.
     class MissingConfig < Nginxtra::Error::Base; end
 
     # Raised when installing and nginx is detected to be installed.
-    class NginxDetected < Nginxtra::Error::Base; end
+    class NginxDetected < Nginxtra::Error::Base
+      HEADER = "It appears nginx is already installed!".freeze
+      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.".freeze
+
+      def initialize
+        super("Uninstall nginx before installing nginxtra", header: HEADER, message: MESSAGE)
+      end
+    end
 
     # Raised when a run command fails.
     class RunFailed < Nginxtra::Error::Base; end
@@ -42,15 +124,13 @@ module Nginxtra
       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
+        yield
+      rescue Nginxtra::Error::Base => e
+        e.output thor
+        raise if thor.options["trace"]
+      rescue
+        print_error thor, header: "An unexpected error occurred!"
+        raise if thor.options["trace"]
       end
     end
   end

data/lib/nginxtra/rails/cli.rb

@@ -5,14 +5,14 @@ module Nginxtra
     class CLI < Thor
       include Thor::Actions
 
-      class_option "trace", :type => :boolean, :banner => "Output stack traces on error"
+      class_option "trace", type: :boolean, banner: "Output stack traces on error"
 
       map "-v" => "version"
 
       desc "server", "Start rails using nginxtra"
-      method_option "port", :type => :numeric, :banner => "Specify the port to use to run the server on", :aliases => "-p", :default => 3000
-      method_option "environment", :banner => "Specify the rails environment to run the server with", :aliases => "-e", :default => "development"
-      method_option "verbose", :type => :boolean, :banner => "Attempts to output the log while the server is running", :aliases => "-V"
+      method_option "port", type: :numeric, banner: "Specify the port to use to run the server on", aliases: "-p", default: 3000
+      method_option "environment", banner: "Specify the rails environment to run the server with", aliases: "-e", default: "development"
+      method_option "verbose", type: :boolean, banner: "Attempts to output the log while the server is running", aliases: "-V"
       def server
         Nginxtra::Error.protect self do
           Nginxtra::Actions::Rails::Server.new(self, nil).server

data/lib/nginxtra/status.rb

@@ -4,18 +4,20 @@ module Nginxtra
   # The status class encapsulates current state of nginxtra, such as
   # when the last time nginx was compiled and with what options.
   class Status
-    @@status = nil
     # The name of the file that stores the state.
     FILENAME = ".nginxtra_status".freeze
 
     class << self
+      attr_accessor :status
+      private :status, :status=
+
       # Retrieve an option from the state stored in the filesystem.
       # This will first load the state from the .nginxtra_status file
       # in the root of the nginxtra gem directory, if it has not yet
       # been loaded.
       def[](option)
         load!
-        @@status[option]
+        status[option]
       end
 
       # Store an option to the status state.  This will save out to
@@ -23,24 +25,25 @@ module Nginxtra
       # return value will be the value stored to the given option key.
       def[]=(option, value)
         load!
-        @@status[option] = value
+        status[option] = value
         save!
         value
       end
 
       private
+
       # Load the status state, if it hasn't yet been loaded.  If there
       # is no file yet existing, then the state is simply initialized
       # to an empty hash (and it is NOT stored to the filesystem til
       # the first write).
       def load!
-        return if @@status
+        return if status
 
-        if File.exists? path
-          @@status = YAML.load File.read(path)
-        else
-          @@status = {}
-        end
+        self.status = if File.exist? path
+                        YAML.load File.read(path)
+                      else
+                        {}
+                      end
       end
 
       # The full path to the file with the state.
@@ -51,7 +54,7 @@ module Nginxtra
       # Save the current state to disk.
       def save!
         File.open path, "w" do |file|
-          file << YAML.dump(@@status)
+          file << YAML.dump(status)
         end
       end
     end