nginx_config_parser
by Bruce Williams
== DESCRIPTION:
A simple Nginx Configuration parser that generates an object graph for
traversal and can emit tidied [simple] configurations.
== FEATURES/PROBLEMS:
* Currently ignores `if' statements (focused on only parsing static config)
== SYNOPSIS:
With a file like:
user nobody www; # this is a 'setting' with key 'user'
workers 1;
http { # this is a 'section' with name 'http'
server {
location / { # this is a section with value = ['/']
}
}
}
Parse
config = NginxConfigParser.parse(File.read('/path/to/nginx.conf'))
p config.settings
# => => ['nobody', 'www'], 'workers' => 1
config.each do |section|
p section.name # eg: 'http'
section.each do |subsection|
p section.name # eg: server
# Emit config (`if's and comments are stripped)
puts config
== REQUIREMENTS:
* Pure Ruby parser, no compiler needed
* No dependencies outside Ruby's standard library
* Should work with Ruby 1.8 and 1.9
== INSTALL:
* sudo gem install nginx_config_parser
== LICENSE:
(The MIT License)
Copyright (c) 2008 Bruce Williams
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
by Bruce Williams
== DESCRIPTION:
A simple Nginx Configuration parser that generates an object graph for
traversal and can emit tidied [simple] configurations.
== FEATURES/PROBLEMS:
* Currently ignores `if' statements (focused on only parsing static config)
== SYNOPSIS:
With a file like:
user nobody www; # this is a 'setting' with key 'user'
workers 1;
http { # this is a 'section' with name 'http'
server {
location / { # this is a section with value = ['/']
}
}
}
Parse
config = NginxConfigParser.parse(File.read('/path/to/nginx.conf'))
p config.settings
# => => ['nobody', 'www'], 'workers' => 1
config.each do |section|
p section.name # eg: 'http'
section.each do |subsection|
p section.name # eg: server
# Emit config (`if's and comments are stripped)
puts config
== REQUIREMENTS:
* Pure Ruby parser, no compiler needed
* No dependencies outside Ruby's standard library
* Should work with Ruby 1.8 and 1.9
== INSTALL:
* sudo gem install nginx_config_parser
== LICENSE:
(The MIT License)
Copyright (c) 2008 Bruce Williams
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.