fluent-format 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 495a2bd0d34f9a30ff0ac8be3700d5e361cf6150
-  data.tar.gz: 01554a964c734cedf4f7c2cfb0e915e3c608a158
+  metadata.gz: 3c146d76922041322724ecc30226d50f82a10233
+  data.tar.gz: b9f8974f98d0c56705ae57a0d936d6f470a49f28
 SHA512:
-  metadata.gz: 2e5e950a92c5fb60dd20e86cebe99946c0b6410f1e7c20a55100a54fa0ac6923237b67bccd155d6859e48e59d0a5f9e5f2ef350da16325f2fa28bb3d467e27e1
-  data.tar.gz: 36673c63cfd92f6e12c3aebc294b64132e37bed1c59780266066ea529ff29f827e75e7c2e122a7e5be3e828c997a9f8a6fef16cc6119d51ad1e7e58d1f35488a
+  metadata.gz: b969c2059241258ce3c03a5c043805d3696726c0c1a2ff2b0cfa6409dda770649f65760bc07ae468943831609060c57f97fed9cae2d25c10550832df5b0c6fba
+  data.tar.gz: 1f09c86414d97aac4186616cf677c4d05b68652eca921ea2da12ea99e735040ea02b51c5459fd3d568ddfc150a543de134d5f3fe2f42d0c9cab13da21903bf96

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.2.3 (2014/04/10)
+
+Enhancement:
+
+* Add `require` option to fluent-format check
+
 ## 0.2.2 (2014/02/08)
 
 Enhancement:

data/README.md

@@ -1,6 +1,6 @@
-# fluent-format  [![Build Status](https://secure.travis-ci.org/sonots/fluent-format.png?branch=master)](http://travis-ci.org/sonots/fluent-format)
+# fluent-format  [![Build Status](https://travis-ci.org/sonots/fluent-format.png?branch=master)](https://travis-ci.org/sonots/fluent-format)
 
-A command line utility to format fluentd configuration beautifully
+An utility to format or check fluentd configuration
 
 ## Installation
 
@@ -18,26 +18,87 @@ Or install it yourself as:
 
 ## Command Line Interface
 
-Format fluent.conf
+### Format
 
+    $ fluent-format format -c fluent.conf
+    or
     $ fluent-format -c fluent.conf
 
-Check fluent.conf
+Input Example:
+
+```
+<source>
+     type forward
+</source>
+
+   <match test>
+    type stdout
+</match>
+```
+
+Output Example:
+
+```
+<source>
+  type forward
+</source>
+<match test>
+  type stdout
+</match>
+```
+
+### Check
 
     $ fluent-format check -c fluent.conf -p plugin_dir
-    $ echo $? # 0: success 1: failure
+    $ echo $? # 0 or 1
+
+This returns the status code 0 if check passed,
+and status code 1 with error messages if check failed. 
 
 ## As a library
 
+### Format
+
+```ruby
+require 'fluent-format'
+
+File.open(path) {|config|
+  puts Fluent::Format.format(config)
+}
+```
+
+or
+
+```ruby
+require 'fluent-format'
+
+puts Fluent::Format.format(path)
+```
+
+Use the 2nd way when you want to exapnd `include` directive.
+
+### Check
+
 ```ruby
 require 'fluent-format'
 
 File.open(path) {|config|
-  puts Fluent::Format.format(config) # formatted string
-  Fluent::Format.check(config, plugin_dir) #=> Fluent::ConfigParseError or Fluent::ConfigError if failed
+  Fluent::Format.check(config, plugin_dir)
+  #=> Fluent::ConfigParseError or Fluent::ConfigError if failed
 }
 ```
 
+or
+
+```ruby
+require 'fluent-format'
+
+Fluent::Format.check(path, plugin_dir)
+#=> Fluent::ConfigParseError or Fluent::ConfigError if failed
+```
+
+Use the 2nd way when you want to exapnd `include` directive.
+
 ## Contributing
 
 1. Fork it
@@ -49,4 +110,3 @@ File.open(path) {|config|
 ## Licenses
 
 See [LICENSE](LICENSE)
-

data/example/include.conf

@@ -0,0 +1,5 @@
+include included.conf
+
+<source>
+  type forward
+</source>

data/example/include_error.conf

@@ -0,0 +1 @@
+include included_error.conf

data/example/included.conf

@@ -0,0 +1,3 @@
+<match include>
+  type stdout
+</match>

data/example/included_error.conf

@@ -0,0 +1,3 @@
+<match included>
+  type unknown
+</match>

data/fluent-format.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Naotoshi Seo"]
   s.email       = ["sonots@gmail.com"]
   s.homepage    = "https://github.com/sonots/fluent-format"
-  s.summary     = "A command line utility to format fluentd configuration beautifully"
+  s.summary     = "A utility to format or check fluentd configuration"
   s.description = s.summary
   s.licenses    = ["MIT"]
 

data/lib/fluent/format/check.rb

@@ -7,7 +7,8 @@ module Fluent
       #
       # @param [IO|String] config_dev
       # @param [String] plugin_dir the plugin directory
-      def initialize(config_dev, plugin_dir = nil)
+      # @param [Array] libs load libraries (to require)
+      def initialize(config_dev, plugin_dir = nil, libs = nil)
         @opts = {
           :config_path => config_dev, # Fluent::DEFAULT_CONFIG_PATH,
           :plugin_dirs => [Fluent::DEFAULT_PLUGIN_DIR],
@@ -22,6 +23,7 @@ module Fluent
           :suppress_repeated_stacktrace => false,
         }
         @opts[:plugin_dirs] << plugin_dir if plugin_dir
+        @opts[:libs] += libs if libs and !libs.empty?
       end
 
       # Check config file

data/lib/fluent/format/cli.rb

@@ -17,11 +17,15 @@ module Fluent
 
       desc "check", "Check fluent.conf"
       option :config, :aliases => ["-c"], :type => :string, :default => 'fluent.conf', :desc => 'Fluentd configuration file'
-      option :plugin, :aliases => ["-p"], :type => :string, :desc => 'Fluentd plugin directory'
+      option :plugin, :aliases => ["-p"], :type => :string, :desc => 'Additional Fluentd plugin directory'
+      option :require, :aliases => ["-r"], :type => :array, :desc => 'Additional Fluentd lib path'
       def check
         config = @options[:config]
         plugin = @options[:plugin]
-        Fluent::Format.check(config, plugin)
+        require 'pry'
+        binding.pry
+        libs   = @options[:require]
+        Fluent::Format.check(config, plugin, libs)
       rescue => e
         $stderr.puts "#{e.class} #{e.message} #{e.backtrace.first}"
         exit 1

data/lib/fluent/format/version.rb

@@ -1,5 +1,5 @@
 module Fluent
   class Format
-    VERSION = "0.2.2"
+    VERSION = "0.2.3"
   end
 end

data/lib/fluent/format.rb

@@ -14,9 +14,10 @@ module Fluent
     #
     # @param [IO|String] config_dev
     # @param [String] plugin_dir the plugin directory
+    # @param [Array] libs load libraries (to require)
     # @return [Boolean]
-    def self.check(config_dev, plugin_dir = nil)
-      Fluent::Format::Check.new(config_dev, plugin_dir).run
+    def self.check(config_dev, plugin_dir = nil, libs = nil)
+      Fluent::Format::Check.new(config_dev, plugin_dir, libs).run
     end
   end
 end

data/spec/fluent/format/check_spec.rb

@@ -2,13 +2,19 @@ require 'spec_helper'
 
 describe Fluent::Format::Check do
   let(:plugin_dir) { File.expand_path('../../../example', File.dirname(__FILE__)) }
-  let(:subject) { Fluent::Format.check(config, plugin_dir) }
+  let(:libs) { [File.expand_path('../../../example/out_example', File.dirname(__FILE__))] }
+  let(:subject) { Fluent::Format.check(config, plugin_dir, libs) }
 
   context "valid" do
     let(:config) { StringIO.new(%[<match>\ntype stdout\n</match>]) }
     it { should be_true }
   end
 
+  context "plugin option" do
+    let(:config) { StringIO.new(%[<match>\ntype example\n</match>]) }
+    it { should be_true }
+  end
+
   context "syntax error" do
     let(:config) { StringIO.new(%[<source>\ntype stdout\n</match>]) }
     it { expect { subject }.to raise_error(Fluent::ConfigParseError) }
@@ -23,5 +29,10 @@ describe Fluent::Format::Check do
     let(:config) { StringIO.new(%[<match>\ntype example\nparam bad\n</match>]) }
     it { expect { subject }.to raise_error(Fluent::ConfigError) }
   end
+
+  context "file_path should `include`" do
+    let(:config) { File.expand_path('../../../example/include_error.conf', File.dirname(__FILE__)) }
+    it { expect { subject }.to raise_error(Fluent::ConfigError) }
+  end
 end
 

data/spec/fluent/format/cli_spec.rb

@@ -40,6 +40,18 @@ describe Fluent::Format::CLI do
       it { expect { subject }.not_to raise_error }
     end
 
+    context "plugin option" do
+      let(:opts) { {config: "fluent.conf", plugin: "example"} }
+      it { capture_stderr { subject }.should == "" }
+      it { expect { subject }.not_to raise_error }
+    end
+
+    context "require option" do
+      let(:opts) { {config: "fluent.conf", require: ["example/out_example"]} }
+      it { capture_stderr { subject }.should == "" }
+      it { expect { subject }.not_to raise_error }
+    end
+
     context "syntax error" do
       let(:opts) { {config: "example/syntax_error.conf"} }
       it { capture_stderr { subject }.should include("parse error") }

data/spec/fluent/format/format_spec.rb

@@ -17,6 +17,12 @@ describe Fluent::Format::Format do
     let(:config) { StringIO.new(%[<match>\ntype foobar\n</match>]) }
     it { should == %[<match>\n  type foobar\n</match>] }
   end
+
+  context "file_path should `include`" do
+    let(:config)   { File.expand_path('../../../example/include.conf', File.dirname(__FILE__)) }
+    let(:included) { File.expand_path('../../../example/included.conf', File.dirname(__FILE__)) }
+    it { should include(File.read(included)) }
+  end
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-format
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -94,7 +94,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: A command line utility to format fluentd configuration beautifully
+description: A utility to format or check fluentd configuration
 email:
 - sonots@gmail.com
 executables:
@@ -111,6 +111,10 @@ files:
 - README.md
 - Rakefile
 - bin/fluent-format
+- example/include.conf
+- example/include_error.conf
+- example/included.conf
+- example/included_error.conf
 - example/out_example.rb
 - example/param_error.conf
 - example/plugin_error.conf
@@ -150,7 +154,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: A command line utility to format fluentd configuration beautifully
+summary: A utility to format or check fluentd configuration
 test_files:
 - spec/fluent/format/check_spec.rb
 - spec/fluent/format/cli_spec.rb