fix #251. Add ruby linter and fix formatting (#278)

.circleci/config.yml

@@ -17,7 +17,7 @@ missingdeps: &missingdeps
 
 test: &test
   name: Test bundle
-  command: bundle exec rake test
+  command: bundle exec rake test --trace
 
 executors:
   ruby-2-5:

.rubocop.yml

@@ -0,0 +1,57 @@
+AllCops:
+  TargetRubyVersion: 2.5 # keep in sync with .circleci/config.yml and gemspec
+  NewCops: enable
+
+Style/EmptyMethod:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+# not safe ... needs require 'English'
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 205 # TODO: lower
+
+Style/Documentation:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Style/IfInsideElse:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Lint/NestedMethodDefinition:
+  Enabled: false
+
+# TODO: fix
+Style/StringConcatenation:
+  Enabled: false
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# TODO: enable ... somehow breaks tests
+Style/HashEachMethods:
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/SymbolArray:
+  EnforcedStyle: brackets

Gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gem 'codeclimate-test-reporter', '<1.0.0', :group => :test, :require => nil
-gem 'rubocop', require: false
+gem 'codeclimate-test-reporter', '<1.0.0', group: :test, require: nil
+gem 'rubocop'
 
 # Specify your gem's dependencies in fluent-plugin-add.gemspec
 gemspec

README.md

@@ -2,6 +2,8 @@
 [![Circle CI](https://circleci.com/gh/fabric8io/fluent-plugin-kubernetes_metadata_filter.svg?style=svg)](https://circleci.com/gh/fabric8io/fluent-plugin-kubernetes_metadata_filter)
 [![Code Climate](https://codeclimate.com/github/fabric8io/fluent-plugin-kubernetes_metadata_filter/badges/gpa.svg)](https://codeclimate.com/github/fabric8io/fluent-plugin-kubernetes_metadata_filter)
 [![Test Coverage](https://codeclimate.com/github/fabric8io/fluent-plugin-kubernetes_metadata_filter/badges/coverage.svg)](https://codeclimate.com/github/fabric8io/fluent-plugin-kubernetes_metadata_filter)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop-hq/rubocop)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-community-brightgreen.svg)](https://rubystyle.guide)
 
 The Kubernetes metadata plugin filter enriches container log records with pod and namespace metadata.
 

Rakefile

@@ -1,10 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'bump/tasks'
+require 'rubocop/rake_task'
 
-task :test => [:base_test]
+task test: [:base_test]
+task default: [:test, :build, :rubocop]
 
-task :default => [:test, :build]
+RuboCop::RakeTask.new
 
 desc 'Run test_unit based test'
 Rake::TestTask.new(:base_test) do |t|
@@ -13,7 +18,6 @@ Rake::TestTask.new(:base_test) do |t|
   #  $ bundle exec rake base_test TEST=test/test_*.rb
   t.libs << 'test'
   t.test_files = Dir['test/**/test_*.rb'].sort
-  #t.verbose = true
   t.warning = false
 end
 
@@ -23,15 +27,15 @@ task :headers do
   require 'copyright_header'
 
   args = {
-    :license => 'Apache-2.0',
-    :copyright_software => 'Fluentd Kubernetes Metadata Filter Plugin',
-    :copyright_software_description => 'Enrich Fluentd events with Kubernetes metadata',
-    :copyright_holders => ['Red Hat, Inc.'],
-    :copyright_years => ['2015-2017'],
-    :add_path => 'lib:test',
-    :output_dir => '.'
+    license: 'Apache-2.0',
+    copyright_software: 'Fluentd Kubernetes Metadata Filter Plugin',
+    copyright_software_description: 'Enrich Fluentd events with Kubernetes metadata',
+    copyright_holders: ['Red Hat, Inc.'],
+    copyright_years: ['2015-2021'],
+    add_path: 'lib:test',
+    output_dir: '.'
   }
 
-  command_line = CopyrightHeader::CommandLine.new( args )
+  command_line = CopyrightHeader::CommandLine.new(args)
   command_line.execute
 end

fluent-plugin-kubernetes_metadata_filter.gemspec

@@ -1,33 +1,34 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
-  gem.name          = "fluent-plugin-kubernetes_metadata_filter"
-  gem.version       = "2.6.0"
-  gem.authors       = ["Jimmi Dyson"]
-  gem.email         = ["jimmidyson@gmail.com"]
-  gem.description   = %q{Filter plugin to add Kubernetes metadata}
-  gem.summary       = %q{Fluentd filter plugin to add Kubernetes metadata}
-  gem.homepage      = "https://github.com/fabric8io/fluent-plugin-kubernetes_metadata_filter"
-  gem.license       = "Apache-2.0"
+  gem.name          = 'fluent-plugin-kubernetes_metadata_filter'
+  gem.version       = '2.6.0'
+  gem.authors       = ['Jimmi Dyson']
+  gem.email         = ['jimmidyson@gmail.com']
+  gem.description   = 'Filter plugin to add Kubernetes metadata'
+  gem.summary       = 'Fluentd filter plugin to add Kubernetes metadata'
+  gem.homepage      = 'https://github.com/fabric8io/fluent-plugin-kubernetes_metadata_filter'
+  gem.license       = 'Apache-2.0'
 
   gem.files         = `git ls-files`.split($/)
 
   gem.required_ruby_version = '>= 2.5.0'
 
   gem.add_runtime_dependency 'fluentd', ['>= 0.14.0', '< 1.13']
-  gem.add_runtime_dependency "lru_redux"
-  gem.add_runtime_dependency "kubeclient", '< 5'
+  gem.add_runtime_dependency 'kubeclient', '< 5'
+  gem.add_runtime_dependency 'lru_redux'
 
-  gem.add_development_dependency "bundler", "~> 2.0"
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "minitest", "~> 4.0"
-  gem.add_development_dependency "test-unit", "~> 3.0.2"
-  gem.add_development_dependency "test-unit-rr", "~> 1.0.3"
-  gem.add_development_dependency "copyright-header"
-  gem.add_development_dependency "webmock"
-  gem.add_development_dependency "vcr"
-  gem.add_development_dependency "bump"
-  gem.add_development_dependency "yajl-ruby"
+  gem.add_development_dependency 'bump'
+  gem.add_development_dependency 'bundler', '~> 2.0'
+  gem.add_development_dependency 'copyright-header'
+  gem.add_development_dependency 'minitest', '~> 4.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'test-unit', '~> 3.0.2'
+  gem.add_development_dependency 'test-unit-rr', '~> 1.0.3'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'yajl-ruby'
 end