nginxtra 1.2.6.7 → 1.2.6.8

data/bin/nginxtra

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 require "rubygems"
-gem "nginxtra", "= 1.2.6.7"
+gem "nginxtra", "= 1.2.6.8"
 gem "thor", "~> 0.16.0"
 require "nginxtra"
 Nginxtra::CLI.start

data/bin/nginxtra_rails

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 require "rubygems"
-gem "nginxtra", "= 1.2.6.7"
+gem "nginxtra", "= 1.2.6.8"
 gem "thor", "~> 0.16.0"
 require "nginxtra"
 Nginxtra::Rails::CLI.start

data/lib/nginxtra.rb

@@ -2,6 +2,7 @@ require "nginxtra/action"
 require "nginxtra/actions/compile"
 require "nginxtra/actions/convert"
 require "nginxtra/actions/install"
+require "nginxtra/actions/print"
 require "nginxtra/actions/reload"
 require "nginxtra/actions/restart"
 require "nginxtra/actions/start"

data/lib/nginxtra/actions/install.rb

@@ -6,23 +6,11 @@ module Nginxtra
     class Install
       include Nginxtra::Action
 
-      # Run the installation of nginxtra, but only after first
-      # prompting if the user wants the install.  This will do nothing
-      # if run with --non-interactive mode.
-      def optional_install
-        return installation_skipped if non_interactive?
-        return up_to_date unless should_install?
-        return unless requesting_install?
-        install
-      end
-
       # 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
-        remember_working_directory
         update_last_install
       end
 
@@ -76,26 +64,6 @@ export GEM_PATH="#{ENV["GEM_PATH"]}"
         @thor.say "nginxtra installation is up to date"
       end
 
-      # Notify to the user that installation is being skipped.
-      def installation_skipped
-        @thor.say "skipping nginxtra installation"
-      end
-
-      # Remember the last config location, and use it unless the
-      # config is explicitly passed in.
-      def remember_config_location
-        # Absolute path somehow turns the path to a binary string when
-        # output to Yaml... so make it a string so it stays ascii
-        # readable.
-        Nginxtra::Status[:remembered_config] = Nginxtra::Config.loaded_config_path.to_s
-      end
-
-      # Remember the last working directory, and use it unless the
-      # working direcotry is explicitly passed in.
-      def remember_working_directory
-        Nginxtra::Status[:remembered_workingdir] = File.expand_path "."
-      end
-
       # Mark the last installed version and last installed time (the
       # former being used to determine if nginxtra has been installed
       # yet).
@@ -104,12 +72,6 @@ export GEM_PATH="#{ENV["GEM_PATH"]}"
         Nginxtra::Status[:last_install_time] = Time.now
       end
 
-      # Ask the user if they wish to install.  Return whether the user
-      # requests the install.
-      def requesting_install?
-        @thor.yes? "Would you like to install nginxtra?"
-      end
-
       # Determine if the install should proceed.  This will be true if
       # the force option was used, or if this version of nginxtra
       # differs from the last version installed.

data/lib/nginxtra/actions/print.rb

@@ -0,0 +1,23 @@
+module Nginxtra
+  module Actions
+    class Print
+      include Nginxtra::Action
+
+      def print
+        if @thor.options["list"]
+          @thor.say "Known config files:\n  #{@config.files.sort.join "\n  "}"
+        elsif @thor.options["compile-options"]
+          @thor.say "Compilation options:\n  #{@config.compile_options}"
+        elsif @config.files.include?(file)
+          @thor.say @config.file_contents(file)
+        else
+          @thor.say "No config file by the name '#{file}' exists!"
+        end
+      end
+
+      def file
+        @thor.options["file"]
+      end
+    end
+  end
+end

data/lib/nginxtra/actions/start.rb

@@ -12,7 +12,6 @@ module Nginxtra
       def start
         without_force do
           compile
-          install
         end
 
         return no_need_to_start unless should_start?
@@ -26,11 +25,6 @@ module Nginxtra
         Nginxtra::Actions::Compile.new(@thor, @config).compile
       end
 
-      # Invoke nginxtra installation, but only if the user allows it.
-      def install
-        Nginxtra::Actions::Install.new(@thor, @config).optional_install
-      end
-
       # Save nginx config files to the proper config file path.
       def save_config_files
         files = @config.files

data/lib/nginxtra/cli.rb

@@ -26,7 +26,7 @@ module Nginxtra
       nginxtra.conf.rb).  The result will be output to nginxtra.conf.rb in the current
       directory, unless an override value is specified with the --config option."
     method_option "nginx-bin", :type => :string, :banner => "Point to the compiled nginx to retrieve compile options", :aliases => "-n"
-    method_option "nginx-conf", :type => :string, :banner => "Point to the nginx.conf file to retrieve the existing configuration", :aliases => "-", :default => "nginx.conf"
+    method_option "nginx-conf", :type => :string, :banner => "Point to the nginx.conf file to retrieve the existing configuration", :aliases => "-F", :default => "nginx.conf"
     method_option "ignore-nginx-bin", :type => :boolean, :banner => "Ignore the nginx binary, and assume default compile time options", :aliases => "-N"
     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"
@@ -36,6 +36,22 @@ module Nginxtra
       end
     end
 
+    desc "print", "Output nginxtra.conf.rb as it is processed as nginx.conf"
+    long_desc "
+      Output the contents of nginx.conf, as it is defined in nginxtra.conf.rb.  If the
+      --file is provided, something other than nginx.conf can be output.  The --list
+      option can be provided to list known config files.  The --compile-options option
+      can be provided to list compile time options being passed to nginx."
+    method_option "compile-options", :type => :boolean, :banner => "Show compile options being used", :aliases => "-C"
+    method_option "file", :type => :string, :banner => "The config file that is printed", :aliases => "-F", :default => "nginx.conf"
+    method_option "list", :type => :boolean, :banner => "List known files", :aliases => "-l"
+    def print
+      Nginxtra::Error.protect self do
+        set_working_dir!
+        Nginxtra::Actions::Print.new(self, prepare_config!).print
+      end
+    end
+
     desc "compile", "Compiles nginx based on nginxtra.conf.rb"
     long_desc "
       Compile nginx with the compilation options specified in nginxtra.conf.rb.  If it
@@ -66,12 +82,11 @@ module Nginxtra
     long_desc "
       Start nginx based on nginxtra.conf.rb.  If nginx has not yet been compiled for
       the given compilation options or the current nginx version, it will be compiled.
-      If nginxtra has not been installed for the current version, the user will be
-      asked if it is ok to install. The configuration for nginx will automatically be
-      handled by nginxtra so it matches what is defined in nginxtra.conf.rb.  If it is
-      already running, this will do nothing, unless --force is passed.  Note that
-      compilation and installation will NOT be forced with --force option.  The
-      compile or install task should be invoked if those need to be forced."
+      The configuration for nginx will automatically be handled by nginxtra so it
+      matches what is defined in nginxtra.conf.rb.  If it is already running, this
+      will do nothing, unless --force is passed.  Note that compilation will NOT be
+      forced with the --force option and should be invoked separately if it needs to
+      be forced."
     def start
       Nginxtra::Error.protect self do
         set_working_dir!
@@ -136,8 +151,6 @@ module Nginxtra
     def set_working_dir!
       if options["workingdir"]
         Dir.chdir options["workingdir"]
-      elsif Nginxtra::Status[:remembered_workingdir]
-        Dir.chdir Nginxtra::Status[:remembered_workingdir]
       end
     end
 

data/lib/nginxtra/config.rb

@@ -168,6 +168,11 @@ module Nginxtra
       # returned.
       def path
         path = File.absolute_path "."
+        config = File.join path, FILENAME
+        return config if File.exists? config
+        config = File.join path, "config", FILENAME
+        return config if File.exists? config
+        path = File.dirname path
 
         begin
           config = File.join path, FILENAME
@@ -191,8 +196,6 @@ module Nginxtra
       def require!(config_path = nil)
         if config_path
           config_path = File.absolute_path config_path
-        elsif Nginxtra::Status[:remembered_config]
-          config_path = File.absolute_path Nginxtra::Status[:remembered_config]
         else
           config_path = path
         end
@@ -310,6 +313,56 @@ module Nginxtra
       end
     end
 
+    # Extension point for other gems or libraries that want to define
+    # inline partials.  Please see the partial method for usage.
+    class Extension
+      class << self
+        # Determine if there has been a partial defined for the given
+        # nginx config file, with the given partial name.
+        def partial?(file, name)
+          file = file.to_sym
+          name = name.to_sym
+          @extensions && @extensions[file] && @extensions[file][name]
+        end
+
+        # Define or retrieve the partial for the given nginx config
+        # file and partial name.  If a block is provided, it is set as
+        # the partial, otherwise the partial currently defined for it
+        # will be retrieved.  The block is expected to take 2
+        # arguments... the arguments hash, and then the block passed
+        # in to this definition.  Either may be ignored if so desired.
+        #
+        # Example usage:
+        #   Nginxtra::Config::Extension.partial "nginx.conf", "my_app" do |args, block|
+        #     my_app(args[:port] || 80)
+        #     some_other_setting "on"
+        #     block.call
+        #   end
+        #
+        # The partial will only be valid for the given config file.
+        # It is completely nestable, and other partials may be invoked
+        # as well.
+        def partial(file, name, &block)
+          file = file.to_sym
+          name = name.to_sym
+          @extensions ||= {}
+          @extensions[file] ||= {}
+
+          if block
+            @extensions[file][name] = block
+          else
+            @extensions[file][name]
+          end
+        end
+
+        # Clear all partials so far defined.  This is mainly for test,
+        # but could be called if resetting is so desired.
+        def clear_partials!
+          @extensions = {}
+        end
+      end
+    end
+
     # Represents a config file being defined by nginxtra.conf.rb.
     class ConfigFile
       def initialize(filename, config, &block)
@@ -385,15 +438,51 @@ module Nginxtra
         @end_of_block = true
       end
 
+      # Convenience method to use the "break" keyword, as seen in if
+      # blocks of nginx configurations.
+      def _break(*args, &block)
+        process_config_block_or_line "break", args, block
+      end
+
+      # Convenience method to invoke an if block in the nginx
+      # configuration.  Parenthesis are added around the arguments of
+      # this method.
+      #
+      # Example usage:
+      #   nginxtra.config do
+      #     _if "some", "~", "thing" do
+      #       _return 404
+      #     end
+      #   end
+      #
+      # Which will produce the following config:
+      #   if (some ~ thing) {
+      #     return 404;
+      #   }
+      def _if(*args, &block)
+        config_block "if (#{args.join " "})", &block
+      end
+
+      # Convenience method to use the "return" keyword, as seen in if
+      # blocks of nginx configurations.
+      def _return(*args, &block)
+        process_config_block_or_line "return", args, block
+      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
+        if template.respond_to? :call
+          block = Proc.new { instance_eval &yielder if yielder }
+          instance_exec options, block, &template
+        else
+          process_template_with_yields! template do |x|
+            if x
+              options[x.to_sym]
+            else
+              instance_eval &yielder if yielder
+            end
           end
         end
       end
@@ -444,16 +533,22 @@ module Nginxtra
 
       private
       def partial?(partial_name)
+        return true if Nginxtra::Config::Extension.partial? @filename, partial_name
+
         @config.partial_paths.any? do |path|
           File.exists? File.join(path, "#{@filename}/#{partial_name}.rb")
         end
       end
 
       def invoke_partial(partial_name, args, block)
-        partial_path = @config.partial_paths.map do |path|
-          File.join path, "#{@filename}/#{partial_name}.rb"
-        end.find do |path|
-          File.exists? path
+        if Nginxtra::Config::Extension.partial? @filename, partial_name
+          partial_path = Nginxtra::Config::Extension.partial @filename, partial_name
+        else
+          partial_path = @config.partial_paths.map do |path|
+            File.join path, "#{@filename}/#{partial_name}.rb"
+          end.find do |path|
+            File.exists? path
+          end
         end
 
         if args.empty?

data/lib/nginxtra/config_converter.rb

@@ -114,6 +114,7 @@ module Nginxtra
     end
 
     class Token
+      KEYWORDS = ["break", "if", "return"].freeze
       TERMINAL_CHARACTERS = ["{", "}", ";"].freeze
       attr_reader :value
 
@@ -123,6 +124,18 @@ module Nginxtra
         @ready = false
       end
 
+      def is_if?
+        @value == "if"
+      end
+
+      def if_start!
+        @value.gsub! /^\(/, ""
+      end
+
+      def if_end!
+        @value.gsub! /\)$/, ""
+      end
+
       def terminal_character?
         TERMINAL_CHARACTERS.include? @value
       end
@@ -156,11 +169,19 @@ module Nginxtra
         @instance || @ready || terminal_character?
       end
 
+      def to_line_start
+        if KEYWORDS.include? @value
+          "_#{@value}"
+        else
+          @value
+        end
+      end
+
       def to_s
         if @value =~ /^\d+$/
           @value
         else
-          %{"#{@value}"}
+          %{"#{@value.gsub("\\") { "\\\\" }}"}
         end
       end
 
@@ -224,6 +245,10 @@ module Nginxtra
       end
 
       private
+      def is_if?
+        @tokens.first.is_if?
+      end
+
       def passenger?
         ["passenger_root", "passenger_ruby", "passenger_enabled"].include? @tokens.first.value
       end
@@ -272,13 +297,19 @@ module Nginxtra
       end
 
       def print_first
-        @output.print @tokens.first.value
+        @output.print @tokens.first.to_line_start
       end
 
       def print_args
         args = @tokens[1..-2]
         return if args.empty?
         @output.print " "
+
+        if is_if?
+          args.first.if_start!
+          args.last.if_end!
+        end
+
         @output.print args.map(&:to_s).join(", ")
       end
 

data/lib/nginxtra/version.rb

@@ -6,7 +6,7 @@ module Nginxtra
       end
 
       def to_s
-        "1.2.6.7"
+        "1.2.6.8"
       end
     end
   end

metadata

@@ -1,38 +1,41 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: nginxtra
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.2.6.8
   prerelease: 
-  version: 1.2.6.7
 platform: ruby
-authors: 
+authors:
 - Mike Virata-Stone
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-12-11 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: thor
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 0.16.0
   type: :runtime
-  version_requirements: *id001
-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.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+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
-executables: 
+executables:
 - nginxtra
 - nginxtra_rails
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - bin/nginxtra
 - bin/nginxtra_rails
 - lib/nginxtra.rb
@@ -40,6 +43,7 @@ files:
 - lib/nginxtra/actions/compile.rb
 - lib/nginxtra/actions/convert.rb
 - lib/nginxtra/actions/install.rb
+- lib/nginxtra/actions/print.rb
 - lib/nginxtra/actions/rails/server.rb
 - lib/nginxtra/actions/reload.rb
 - lib/nginxtra/actions/restart.rb
@@ -411,30 +415,26 @@ files:
 - vendor/nginx/src/os/unix/rfork_thread.S
 homepage: http://reasonnumber.com/nginxtra
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Wrapper of nginx for easy install and use.
 test_files: []
-