ngxmodgen 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5961c31367d229409f53f3e37fce9422551c7bda
+  data.tar.gz: 37dcd694b286e3024303ea6c6b6e44069722bcf5
+SHA512:
+  metadata.gz: 2b38018c6de37587182b532f8781b2ba1cb701824781e2c6ea64b666f55eedfe6e7a3704b2d8d9c65008c372c1bcda20b1755e94e6f5e4697d0bb275f5d7d438
+  data.tar.gz: ea3c6b57a15b527beb52cf2afb49448e55ca86c791c80f4d8776ca7b42a54653287dd4b573678c591e2c3bc3429fec482449b1ba1f7530d777cfc9d35230271c

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ngxmodgen.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tatsuhiko Kubo <cubicdaiya@gmail.com>
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,32 @@
+# ngxmodgen
+
+ngxmodgen is the code generator for a nginx module
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ngxmodgen'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ngxmodgen
+
+## Usage
+
+    $ NGINX_MODULE_NAME=hoge
+    $ ngxcodegen -n $NGINX_MODULE_NAME                # generate ngx_http_hoge_module.c and config
+    $ ngxcodegen -n $NGINX_MODULE_NAME -t http        # generate ngx_http_hoge_module.c and config
+    $ ngxcodegen -n $NGINX_MODULE_NAME -t http_filter # generate ngx_http_hoge_filter_module.c and config
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+
+desc 'test'
+task :test do
+  exec 'ruby test/test.rb'
+end

data/bin/ngxmodgen

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+require 'rubygems' unless defined?(gem)
+here = File.dirname(__FILE__)
+$LOAD_PATH << File.expand_path(File.join(here, '..', 'lib'))
+require 'ngxmodgen'

data/lib/ngxmodgen/configgen.rb

@@ -0,0 +1,23 @@
+class NginxModuleConfigGenerator
+
+  def initialize(module_name)
+    @module_name = module_name
+  end
+
+  def generate
+    <<"EOS"
+ngx_addon_name=ngx_http_#{@module_name}_module
+HTTP_MODULES="$HTTP_MODULES ngx_http_#{@module_name}_module"
+NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_#{@module_name}_module.c"
+EOS
+  end
+
+  def filter_generate
+    <<"EOS"
+ngx_addon_name=ngx_http_#{@module_name}_module
+HTTP_FILTER_MODULES="$HTTP_FILTER_MODULES ngx_http_#{@module_name}_filter_module"
+NGX_ADDON_SRCS="$NGX_ADDON_SRCS $ngx_addon_dir/ngx_http_#{@module_name}_filter_module.c"
+EOS
+  end
+
+end

data/lib/ngxmodgen/srcgen.rb

@@ -0,0 +1,134 @@
+class NginxModuleSourceGenerator
+
+  def initialize(module_name)
+    @module_name = module_name
+  end
+
+  def generate
+    <<"EOS"
+
+#include <ngx_config.h>
+#include <ngx_core.h>
+#include <ngx_http.h>
+
+static ngx_command_t ngx_http_#{@module_name}_commands[] = {
+    /*
+    {
+        ngx_string("command_name"),
+        NGX_HTTP_LOC_CONF|NGX_CONF_NOARGS,
+        NULL,
+        0,
+        0,
+        NULL
+    },
+    */
+    ngx_null_command
+};
+
+static ngx_http_module_t ngx_http_#{@module_name}_module_ctx = {
+    NULL,                              /* preconfiguration */
+    NULL,                              /* postconfiguration */
+
+    NULL,                              /* create main configuration */
+    NULL,                              /* init main configuration */
+
+    NULL,                              /* create server configuration */
+    NULL,                              /* merge server configuration */
+
+    NULL,                              /* create location configuration */
+    NULL                               /* merge location configuration */
+};
+
+ngx_module_t ngx_http_#{@module_name}_module = {
+    NGX_MODULE_V1,
+    &ngx_http_#{@module_name}_module_ctx, /* module context */
+    ngx_http_#{@module_name}_commands,    /* module directives */
+    NGX_HTTP_MODULE,                      /* module type */
+    NULL,                                 /* init master */
+    NULL,                                 /* init module */
+    NULL,                                 /* init process */
+    NULL,                                 /* init thread */
+    NULL,                                 /* exit thread */
+    NULL,                                 /* exit process */
+    NULL,                                 /* exit master */
+    NGX_MODULE_V1_PADDING
+};
+
+EOS
+  end
+
+  def filter_generate
+    <<"EOS"
+
+#include <ngx_config.h>
+#include <ngx_core.h>
+#include <ngx_http.h>
+
+static ngx_int_t ngx_http_#{@module_name}_filter_init(ngx_conf_t *cf);
+
+static ngx_http_module_t  ngx_http_#{@module_name}_filter_module_ctx = {
+    NULL,                                  /* preconfiguration */
+    ngx_http_#{@module_name}_filter_init,  /* postconfiguration */
+
+    NULL,                                  /* create main configuration */
+    NULL,                                  /* init main configuration */
+
+    NULL,                                  /* create server configuration */
+    NULL,                                  /* merge server configuration */
+
+    NULL,                                  /* create location configuration */
+    NULL                                   /* merge location configuration */
+};
+
+ngx_module_t  ngx_http_#{@module_name}_filter_module = {
+    NGX_MODULE_V1,
+    &ngx_http_#{@module_name}_filter_module_ctx, /* module context */
+    NULL,                                        /* module directives */
+    NGX_HTTP_MODULE,                             /* module type */
+    NULL,                                        /* init master */
+    NULL,                                        /* init module */
+    NULL,                                        /* init process */
+    NULL,                                        /* init thread */
+    NULL,                                        /* exit thread */
+    NULL,                                        /* exit process */
+    NULL,                                        /* exit master */
+    NGX_MODULE_V1_PADDING
+};
+
+static ngx_http_output_header_filter_pt  ngx_http_next_header_filter;
+static ngx_http_output_body_filter_pt    ngx_http_next_body_filter;
+
+static ngx_int_t ngx_http_#{@module_name}_header_filter(ngx_http_request_t *r)
+{
+    return ngx_http_next_header_filter(r);
+}
+
+
+static ngx_int_t ngx_http_#{@module_name}_body_filter(ngx_http_request_t *r, ngx_chain_t *in)
+{
+    return ngx_http_next_body_filter(r, in);
+}
+
+static ngx_int_t ngx_http_#{@module_name}_filter_init(ngx_conf_t *cf)
+{
+    ngx_http_next_header_filter = ngx_http_top_header_filter;
+    ngx_http_top_header_filter = ngx_http_#{@module_name}_header_filter;
+
+    ngx_http_next_body_filter = ngx_http_top_body_filter;
+    ngx_http_top_body_filter = ngx_http_#{@module_name}_body_filter;
+
+    return NGX_OK;
+}
+
+EOS
+  end
+
+  def module_name
+    "ngx_http_#{@module_name}_module"
+  end
+
+  def filter_module_name
+    "ngx_http_#{@module_name}_filter_module"
+  end
+
+end

data/lib/ngxmodgen/version.rb

@@ -0,0 +1,3 @@
+module Ngxmodgen
+  VERSION = "0.0.1"
+end

data/lib/ngxmodgen.rb

@@ -0,0 +1,42 @@
+require "ngxmodgen/version"
+require "ngxmodgen/configgen"
+require "ngxmodgen/srcgen"
+
+require 'optparse'
+
+op = OptionParser.new
+
+module_name = ""
+module_type = "http"
+
+op.on('-n', '--name NAME', "nginx module name") {|s|
+  module_name = s
+}
+
+op.on('-t', '--type [TYPE]', "module type(default: #{module_type})") {|s|
+  module_type = s
+}
+
+op.parse!(ARGV)
+
+if module_name == ""
+  e = OptionParser::ParseError.new;
+  raise e, "module name was not specified"
+end
+
+config_gen = NginxModuleConfigGenerator.new(module_name)
+src_gen    = NginxModuleSourceGenerator.new(module_name)
+
+if module_type == "http"
+  File.open('config', 'w') {|f| f.write(config_gen.generate()) }
+  File.open("#{src_gen.module_name}.c", 'w') {|f| f.write(src_gen.generate()) }
+  puts "#{src_gen.module_name}.c and config is generated"
+elsif module_type == "http_filter"
+  File.open('config', 'w') {|f| f.write(config_gen.filter_generate()) }
+  File.open("#{src_gen.filter_module_name}.c", 'w') {|f| f.write(src_gen.filter_generate()) }
+  puts "#{src_gen.filter_module_name}.c and config is generated"
+else
+  puts "module type is invalid. Input 'http' or 'http_filter'"
+  exit(1)
+end
+

data/ngxmodgen.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ngxmodgen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ngxmodgen"
+  spec.version       = Ngxmodgen::VERSION
+  spec.authors       = ["Tatsuhiko Kubo"]
+  spec.email         = ["cubicdaiya@gmail.com"]
+  spec.description   = %q{Nginx Module Generator}
+  spec.summary       = %q{Nginx Module Generator}
+  spec.homepage      = "https://github.com/cubicdaiya/ngxmodgen"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/test/test.rb

@@ -0,0 +1,35 @@
+require "minitest/unit"
+require "minitest/autorun"
+require "ngxmodgen/configgen"
+require "ngxmodgen/srcgen"
+
+class TestNgxmodgen < MiniTest::Unit::TestCase
+  def setup
+    @module_name = "hoge"
+    @config_gen  = NginxModuleConfigGenerator.new(@module_name)
+    @src_gen     = NginxModuleSourceGenerator.new(@module_name)
+  end
+
+  def teardown
+
+  end
+
+  def test_module_name
+    assert_equal "ngx_http_hoge_module", @src_gen.module_name
+  end
+
+  def test_filter_module_name
+    assert_equal "ngx_http_hoge_filter_module", @src_gen.filter_module_name
+  end
+
+  def test_http_module_config
+    r = /^HTTP_MODULES/
+    assert r.match(@config_gen.generate), "HTTP_MODULE is not included"
+  end
+
+  def test_http_filter_module_config
+    r = /^HTTP_FILTER_MODULES/
+    assert r.match(@config_gen.filter_generate), "HTTP_FILTER_MODULE is not included"
+  end
+
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ngxmodgen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tatsuhiko Kubo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Nginx Module Generator
+email:
+- cubicdaiya@gmail.com
+executables:
+- ngxmodgen
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ngxmodgen
+- lib/ngxmodgen.rb
+- lib/ngxmodgen/configgen.rb
+- lib/ngxmodgen/srcgen.rb
+- lib/ngxmodgen/version.rb
+- ngxmodgen.gemspec
+- test/test.rb
+homepage: https://github.com/cubicdaiya/ngxmodgen
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Nginx Module Generator
+test_files:
+- test/test.rb