nginx_config_parser 1.0.0

data/tasks/spec.rake

@@ -0,0 +1,40 @@
+# $Id$
+
+if HAVE_SPEC_RAKE_SPECTASK
+
+namespace :spec do
+
+  desc 'Run all specs with basic output'
+  Spec::Rake::SpecTask.new(:run) do |t|
+    t.spec_opts = PROJ.spec_opts
+    t.spec_files = PROJ.specs
+  end
+
+  desc 'Run all specs with text output'
+  Spec::Rake::SpecTask.new(:specdoc) do |t|
+    t.spec_opts = PROJ.spec_opts + ['--format', 'specdoc']
+    t.spec_files = PROJ.specs
+  end
+
+  if HAVE_RCOV
+    desc 'Run all specs with RCov'
+    Spec::Rake::SpecTask.new(:rcov) do |t|
+      t.spec_opts = PROJ.spec_opts
+      t.spec_files = PROJ.specs
+      t.rcov = true
+      t.rcov_opts = PROJ.rcov_opts + ['--exclude', 'spec']
+    end
+  end
+
+end  # namespace :spec
+
+desc 'Alias to spec:run'
+task :spec => 'spec:run'
+
+task :clobber => 'spec:clobber_rcov' if HAVE_RCOV
+
+remove_desc_for_task %w(spec:clobber_rcov)
+
+end  # if HAVE_SPEC_RAKE_SPECTASK
+
+# EOF

data/tasks/test.rake

@@ -0,0 +1,40 @@
+# $Id$
+
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:run) do |t|
+    t.libs = PROJ.libs
+    t.test_files = if test ?f, PROJ.test_file then [PROJ.test_file]
+                   else PROJ.tests end
+    t.ruby_opts += PROJ.ruby_opts
+    t.ruby_opts += PROJ.test_opts
+  end
+
+  if HAVE_RCOV
+    desc 'Run rcov on the unit tests'
+    task :rcov => :clobber_rcov do
+      opts = PROJ.rcov_opts.join(' ')
+      files = if test ?f, PROJ.test_file then [PROJ.test_file]
+              else PROJ.tests end
+      files = files.join(' ')
+      sh "#{RCOV} #{files} #{opts}"
+    end
+
+    desc 'Remove rcov products'
+    task :clobber_rcov do
+      rm_r 'coverage' rescue nil
+    end
+  end
+
+end  # namespace :test
+
+desc 'Alias to test:run'
+task :test => 'test:run'
+
+task :clobber => 'test:clobber_rcov' if HAVE_RCOV
+
+remove_desc_for_task %w(test:clobber_rcov)
+
+# EOF

data/test/fixtures/ezra/conf/nginx.conf

@@ -0,0 +1,209 @@
+# user and group to run as
+user  ez ez;
+
+# number of nginx workers
+worker_processes  6;
+
+# pid of nginx master process
+pid /var/run/nginx.pid;
+
+# Number of worker connections. 1024 is a good default
+events {
+  worker_connections 1024;
+}
+
+# start the http module where we config http access.
+http {
+  # pull in mime-types. You can break out your config 
+  # into as many include's as you want to make it cleaner
+  include /etc/nginx/mime.types;
+
+  # set a default type for the rare situation that
+  # nothing matches from the mimie-type include
+  default_type  application/octet-stream;
+
+  # configure log format
+  log_format main '$remote_addr - $remote_user [$time_local] '
+                  '"$request" $status  $body_bytes_sent "$http_referer" '
+                  '"$http_user_agent" "$http_x_forwarded_for"';
+
+  # main access log
+  access_log  /var/log/nginx_access.log  main;
+
+  # main error log
+  error_log  /var/log/nginx_error.log debug;
+
+  # no sendfile on OSX
+  sendfile on;
+
+  # These are good default values.
+  tcp_nopush        on;
+  tcp_nodelay       off;
+  # output compression saves bandwidth 
+  gzip            on;
+  gzip_http_version 1.0;
+  gzip_comp_level 2;
+  gzip_proxied any;
+  gzip_types      text/plain text/html text/css application/x-javascript text/xml application/xml 
+application/xml+rss text/javascript;
+
+
+  # this is where you define your mongrel clusters. 
+  # you need one of these blocks for each cluster
+  # and each one needs its own name to refer to it later.
+  upstream mongrel {
+    server 127.0.0.1:5000;
+    server 127.0.0.1:5001;
+    server 127.0.0.1:5002;
+  }
+
+
+  # the server directive is nginx's virtual host directive.
+  server {
+    # port to listen on. Can also be set to an IP:PORT
+    listen 80;
+    
+    # Set the max size for file uploads to 50Mb
+    client_max_body_size 50M;
+
+    # sets the domain[s] that this vhost server requests for
+    # server_name www.[engineyard].com [engineyard].com;
+
+    # doc root
+    root /data/ez/current/public;
+
+    # vhost specific access log
+    access_log  /var/log/nginx.vhost.access.log  main;
+
+    # this rewrites all the requests to the maintenance.html
+    # page if it exists in the doc root. This is for capistrano's
+    # disable web task
+    if (-f $document_root/system/maintenance.html) {
+      rewrite  ^(.*)$  /system/maintenance.html last;
+      break;
+    }
+
+    location / {
+      # needed to forward user's IP address to rails
+      proxy_set_header  X-Real-IP  $remote_addr;
+
+      # needed for HTTPS
+      proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header Host $http_host;
+      proxy_redirect false;
+      proxy_max_temp_file_size 0;
+      
+      # If the file exists as a static file serve it directly without
+      # running all the other rewite tests on it
+      if (-f $request_filename) { 
+        break; 
+      }
+
+      # check for index.html for directory index
+      # if its there on the filesystem then rewite 
+      # the url to add /index.html to the end of it
+      # and then break to send it to the next config rules.
+      if (-f $request_filename/index.html) {
+        rewrite (.*) $1/index.html break;
+      }
+
+      # this is the meat of the rails page caching config
+      # it adds .html to the end of the url and then checks
+      # the filesystem for that file. If it exists, then we
+      # rewite the url to have explicit .html on the end 
+      # and then send it on its way to the next config rule.
+      # if there is no file on the fs then it sets all the 
+      # necessary headers and proxies to our upstream mongrels
+      if (-f $request_filename.html) {
+        rewrite (.*) $1.html break;
+      }
+
+      if (!-f $request_filename) {
+        proxy_pass http://mongrel;
+        break;
+      }
+    }
+
+    error_page   500 502 503 504  /500.html;
+    location = /500.html {
+      root   /data/ez/current/public;
+    }
+  }
+
+  # This server is setup for ssl. Uncomment if 
+  # you are using ssl as well as port 80.
+  server {
+    # port to listen on. Can also be set to an IP:PORT
+    listen 443;
+    
+    # Set the max size for file uploads to 50Mb
+    client_max_body_size 50M;
+
+    # sets the domain[s] that this vhost server requests for
+    # server_name www.[engineyard].com [engineyard].com;
+
+    # doc root
+    root /data/ez/current/public;
+
+    # vhost specific access log
+    access_log  /var/log/nginx.vhost.access.log  main;
+
+    # this rewrites all the requests to the maintenance.html
+    # page if it exists in the doc root. This is for capistrano's
+    # disable web task
+    if (-f $document_root/system/maintenance.html) {
+      rewrite  ^(.*)$  /system/maintenance.html last;
+      break;
+    }
+
+    location / {
+      # needed to forward user's IP address to rails
+      proxy_set_header  X-Real-IP  $remote_addr;
+
+      # needed for HTTPS
+      proxy_set_header X_FORWARDED_PROTO https;
+
+      proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header Host $http_host;
+      proxy_redirect false;
+      proxy_max_temp_file_size 0;
+      
+      # If the file exists as a static file serve it directly without
+      # running all the other rewite tests on it
+      if (-f $request_filename) { 
+        break; 
+      }
+
+      # check for index.html for directory index
+      # if its there on the filesystem then rewite 
+      # the url to add /index.html to the end of it
+      # and then break to send it to the next config rules.
+      if (-f $request_filename/index.html) {
+        rewrite (.*) $1/index.html break;
+      }
+
+      # this is the meat of the rails page caching config
+      # it adds .html to the end of the url and then checks
+      # the filesystem for that file. If it exists, then we
+      # rewite the url to have explicit .html on the end 
+      # and then send it on its way to the next config rule.
+      # if there is no file on the fs then it sets all the 
+      # necessary headers and proxies to our upstream mongrels
+      if (-f $request_filename.html) {
+        rewrite (.*) $1.html break;
+      }
+
+      if (!-f $request_filename) {
+        proxy_pass http://mongrel;
+        break;
+      }
+    }
+
+    error_page   500 502 503 504  /500.html;
+    location = /500.html {
+      root   /data/ez/current/public;
+    }
+  }
+
+
+}

data/test/fixtures/simple/conf/nginx.conf

@@ -0,0 +1,21 @@
+user  nobody www;
+worker_processes  1;
+
+events {
+ worker_connections  1024;
+}
+
+http {
+  default_type application/octet-stream;
+  sendfile on;
+  keepalive_timeout 65;
+  server {
+    listen       80;
+    server_name  simple.com *.simple.com;
+    access_log  logs/simple.access.log;
+    location / {
+        root   html;
+        index  index.html index.htm;
+    }
+  }
+}

data/test/parser_test.rb

@@ -0,0 +1,69 @@
+$: << File.dirname(__FILE__) + "/../lib"
+
+require 'nginx_config_parser'
+
+require 'rubygems'
+begin
+  require 'test/spec'
+rescue LoadError
+  STDERR.puts "Testing requires test-spec; gem install test-spec"
+  exit 1
+end
+
+context "Nginx Configuration Parser" do
+    
+  specify "can parse simple configuration" do
+    parsing :simple do |config|
+      assert_equal 2, config.sections.size
+      assert_equal %w(events http), config.sections.map { |s| s.name }
+    end
+  end
+  
+  specify "can parser more complex configuration" do
+    assert_nothing_raised do
+      parsing :ezra do |config|
+        # TODO: More tests
+      end
+    end
+  end
+  
+  specify "skips if statements" do
+    result = parse(<<-EOCONFIG)
+    start 1;
+    if ( an if statement here ) {
+      this should all be ignored
+    }
+    if( this has ( some parenths ) ) {
+      but_is_still_ignored ok;
+    }
+    should_reach_here 1;
+    and_this = / {
+      should_exist 1;
+    }
+    EOCONFIG
+    assert_equal 2, result.settings.size
+    assert_equal 1, result.sections.size
+    assert_equal({'should_exist' => 1}, result.sections.first.settings)
+    assert_equal(%w(= /), result.sections.first.value)
+    assert_nothing_raised do
+      result.each do |section|
+        assert section.is_a?(NginxConfigParser::Section)
+      end
+    end
+    
+  end
+  
+  #######
+  private
+  #######
+  
+  def parse(text)
+    NginxConfigParser.parse(text)
+  end
+
+  def parsing(scenario)
+    fixture = File.dirname(__FILE__) << "/fixtures/#{scenario}/conf/nginx.conf"
+    yield parse(File.read(fixture))
+  end
+  
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: nginx_config_parser
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Bruce Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-01-21 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: "== FEATURES/PROBLEMS:  * Currently ignores `if' statements (focused on only parsing static config)"
+email: bruce@codefluency.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/nginx_config_parser.rb
+- lib/nginx_config_parser/configuration.rb
+- lib/nginx_config_parser/scanner.rb
+- src/scanner.rl
+- tasks/annotations.rake
+- tasks/doc.rake
+- tasks/gem.rake
+- tasks/manifest.rake
+- tasks/ragel.rake
+- tasks/rubyforge.rake
+- tasks/setup.rb
+- tasks/spec.rake
+- tasks/test.rake
+- test/fixtures/ezra/conf/nginx.conf
+- test/fixtures/simple/conf/nginx.conf
+- test/parser_test.rb
+has_rdoc: true
+homepage: http://codefluency.rubyforge.org/nginx_config_parser
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: codefluency
+rubygems_version: 1.0.0
+signing_key: 
+specification_version: 2
+summary: A simple nginx.conf parser and emitter
+test_files: 
+- test/parser_test.rb