Setup StandardRB for code formatting & linting (#36)

Author: thbar

.github/workflows/ci.yml

@@ -24,6 +24,9 @@ jobs:
         ruby-version: ${{ matrix.ruby }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - run: bundle exec rake
+    # NOTE: calling "bundle install" because the cache apparently did not update due to the gemspec injection
+    - run: bundle install && bundle exec standardrb
+      if: matrix.ruby == '3.0' # not using "head" because rubocop won't work there yet
   # What's below helps having a single "status check" for mergeability, without
   # having to add each new version to the list of expected status checks in GitHub.
   # See https://github.community/t/status-check-for-a-matrix-jobs/127354/7 

Changes.md

@@ -3,6 +3,8 @@ HEAD
 
 - Drop support for Ruby < 2.5
 - Add compatibility for Kiba 4
+- [StandardRB](https://github.com/testdouble/standard) has been added for formatting & linting the codebase.
+
 
 1.1.0
 ----

Gemfile

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec

Rakefile

@@ -1,7 +1,7 @@
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.pattern = 'test/test_*.rb'
+  t.pattern = "test/test_*.rb"
 end
 
 task default: :test

kiba-common.gemspec

@@ -1,25 +1,25 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/kiba-common/version', __FILE__)
+require File.expand_path("../lib/kiba-common/version", __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Thibaut Barrère']
-  gem.email         = ['[email protected]']
-  gem.description   = gem.summary = 'Commonly used helpers for Kiba ETL'
-  gem.homepage      = 'https://github.com/thbar/kiba-common'
-  gem.license       = 'LGPL-3.0'
-  gem.files         = `git ls-files | grep -Ev '^(examples)'`.split("\n")
-  gem.test_files    = `git ls-files -- test/*`.split("\n")
-  gem.name          = 'kiba-common'
-  gem.require_paths = ['lib']
-  gem.version       = Kiba::Common::VERSION
-  gem.metadata      = {
-    'source_code_uri'   => 'https://github.com/thbar/kiba-common',
-    'documentation_uri' => 'https://github.com/thbar/kiba-common/blob/master/README.md',
+  gem.authors = ["Thibaut Barrère"]
+  gem.email = ["[email protected]"]
+  gem.description = gem.summary = "Commonly used helpers for Kiba ETL"
+  gem.homepage = "https://github.com/thbar/kiba-common"
+  gem.license = "LGPL-3.0"
+  gem.files = `git ls-files | grep -Ev '^(examples)'`.split("\n")
+  gem.test_files = `git ls-files -- test/*`.split("\n")
+  gem.name = "kiba-common"
+  gem.require_paths = ["lib"]
+  gem.version = Kiba::Common::VERSION
+  gem.metadata = {
+    "source_code_uri" => "https://github.com/thbar/kiba-common",
+    "documentation_uri" => "https://github.com/thbar/kiba-common/blob/master/README.md"
   }
 
-  gem.add_dependency 'kiba', '>= 3.0.0', '< 5'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'minitest'
-  gem.add_development_dependency 'amazing_print'
-  gem.add_development_dependency 'minitest-focus'
+  gem.add_dependency "kiba", ">= 3.0.0", "< 5"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "amazing_print"
+  gem.add_development_dependency "minitest-focus"
+  gem.add_development_dependency "standard"
 end

lib/kiba-common/destinations/csv.rb

@@ -1,28 +1,31 @@
-require 'csv'
+require "csv"
 
 module Kiba
   module Common
     module Destinations
       class CSV
         attr_reader :filename, :csv_options, :csv, :headers
-        
+
         def initialize(filename:, csv_options: nil, headers: nil)
           @filename = filename
           @csv_options = csv_options || {}
           @headers = headers
         end
-        
+
         def write(row)
-          @csv ||= ::CSV.open(filename, 'wb', **csv_options)
+          @csv ||= ::CSV.open(filename, "wb", **csv_options)
           @headers ||= row.keys
-          @headers_written ||= (csv << headers ; true)
+          @headers_written ||= begin
+            csv << headers
+            true
+          end
           csv << row.fetch_values(*@headers)
         end
-        
+
         def close
           csv&.close
         end
       end
     end
   end
-end
+end

lib/kiba-common/destinations/lambda.rb

@@ -3,7 +3,7 @@ module Common
     module Destinations
       class Lambda
         attr_reader :on_write, :on_close
-        
+
         def initialize(on_init: nil, on_write: nil, on_close: nil)
           @on_write = on_write
           @on_close = on_close

lib/kiba-common/dsl_extensions/logger.rb

@@ -1,4 +1,4 @@
-require 'logger'
+require "logger"
 
 module Kiba
   module Common
@@ -10,7 +10,7 @@ def logger=(logger_instance)
         end
 
         def logger
-          @logger ||= self.logger = ::Logger.new(STDOUT)
+          @logger ||= self.logger = ::Logger.new($stdout)
         end
       end
     end

lib/kiba-common/sources/csv.rb

@@ -1,4 +1,4 @@
-require 'csv'
+require "csv"
 
 module Kiba
   module Common

lib/kiba-common/sources/enumerable.rb

@@ -7,7 +7,7 @@ class Enumerable
         def initialize(enumerable)
           @enumerable = enumerable
         end
-        
+
         def unwrap_enumerable
           enumerable.respond_to?(:call) ? enumerable.call : enumerable
         end

lib/kiba-common/transforms/enumerable_exploder.rb

@@ -9,4 +9,4 @@ def process(row)
       end
     end
   end
-end
+end

lib/kiba-common/version.rb

@@ -1,5 +1,5 @@
 module Kiba
   module Common
-    VERSION = '1.1.0'
+    VERSION = "1.1.0"
   end
 end

test/helper.rb

@@ -1,6 +1,6 @@
-require 'minitest/autorun'
-require 'minitest/pride'
-require 'minitest/focus'
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/focus"
 
-require 'kiba-common/sources/enumerable'
-require_relative 'support/assert_called'
+require "kiba-common/sources/enumerable"
+require_relative "support/assert_called"

test/support/assert_called.rb

@@ -7,4 +7,4 @@ def assert_called(klass, method, args, return_value = nil)
     end
     mock.verify
   end
-end
+end

test/support/test_array_destination.rb

@@ -2,8 +2,8 @@ class TestArrayDestination
   def initialize(array)
     @array = array
   end
-  
+
   def write(row)
     @array << row
   end
-end
+end

test/support/test_hash_configured_object.rb

@@ -2,7 +2,7 @@ class TestHashConfiguredObject
   def initialize(config)
     @config = config
   end
-  
+
   def each
     yield(@config)
   end

test/support/test_keyword_proxy_source.rb

@@ -3,7 +3,7 @@ def initialize(mandatory:, optional: nil)
     @mandatory = mandatory
     @optional = optional
   end
-  
+
   def each
     yield({
       mandatory: @mandatory,

test/test_csv_destination.rb

@@ -1,10 +1,10 @@
-require_relative 'helper'
-require 'kiba'
-require 'kiba-common/destinations/csv'
+require_relative "helper"
+require "kiba"
+require "kiba-common/destinations/csv"
 
 class TestCSVDestination < Minitest::Test
-  TEST_FILENAME = 'output.csv'
-    
+  TEST_FILENAME = "output.csv"
+
   def teardown
     File.delete(TEST_FILENAME) if File.exist?(TEST_FILENAME)
   end
@@ -21,24 +21,24 @@ def run_etl(csv_options: nil, headers: nil)
     end
 
     Kiba.run(job)
-    
+
     IO.read(TEST_FILENAME)
   end
-  
+
   def test_classic
     assert_equal <<~CSV, run_etl
       name,age
       world,999
     CSV
   end
-  
+
   def test_csv_options
-    assert_equal <<~CSV, run_etl(csv_options: {col_sep: ';'})
+    assert_equal <<~CSV, run_etl(csv_options: {col_sep: ";"})
       name;age
       world;999
     CSV
   end
-  
+
   def test_headers_provided
     assert_equal <<~CSV, run_etl(headers: [:age])
       age

test/test_csv_source.rb

@@ -1,16 +1,16 @@
-require_relative 'helper'
-require 'kiba'
-require 'kiba-common/sources/csv'
-require_relative 'support/test_array_destination'
+require_relative "helper"
+require "kiba"
+require "kiba-common/sources/csv"
+require_relative "support/test_array_destination"
 
 class TestCSVSource < MiniTest::Test
-  TEST_FILENAME = 'input.csv'
+  TEST_FILENAME = "input.csv"
 
   def setup
-    CSV.open(TEST_FILENAME, 'wb') do |csv|
-      csv << %w(first_name last_name)
-      csv << %w(John Barry)
-      csv << %w(Kate Bush)
+    CSV.open(TEST_FILENAME, "wb") do |csv|
+      csv << %w[first_name last_name]
+      csv << %w[John Barry]
+      csv << %w[Kate Bush]
     end
   end
 
@@ -30,11 +30,11 @@ def run_job(args)
 
   def test_with_csv_options
     rows = run_job filename: TEST_FILENAME,
-      csv_options: { headers: true, header_converters: :symbol }
+                   csv_options: {headers: true, header_converters: :symbol}
 
     assert_equal [CSV::Row], rows.map(&:class).uniq
     assert_equal([
-      {first_name: "John", last_name: "Barry" },
+      {first_name: "John", last_name: "Barry"},
       {first_name: "Kate", last_name: "Bush"}
     ], rows.map(&:to_h))
   end
@@ -43,9 +43,9 @@ def test_without_csv_options
     rows = run_job(filename: TEST_FILENAME)
 
     assert_equal [
-      %w(first_name last_name),
-      %w(John Barry),
-      %w(Kate Bush)
+      %w[first_name last_name],
+      %w[John Barry],
+      %w[Kate Bush]
     ], rows
   end
 end

test/test_enumerable_exploder_transform.rb

@@ -1,13 +1,13 @@
-require_relative 'helper'
-require 'kiba'
-require_relative 'support/test_array_destination'
-require 'kiba-common/transforms/enumerable_exploder'
-require 'kiba/dsl_extensions/config'
+require_relative "helper"
+require "kiba"
+require_relative "support/test_array_destination"
+require "kiba-common/transforms/enumerable_exploder"
+require "kiba/dsl_extensions/config"
 
 class TestEnumerableExploderTransform < Minitest::Test
   def test_exploder
     output = []
-    input = [[1,2],[3,4,5]]
+    input = [[1, 2], [3, 4, 5]]
 
     job = Kiba.parse do
       extend Kiba::DSLExtensions::Config
@@ -18,7 +18,7 @@ def test_exploder
       destination TestArrayDestination, output
     end
     Kiba.run(job)
-    
+
     assert_equal input.flatten, output
   end
-end
+end

test/test_enumerable_source.rb

@@ -1,6 +1,6 @@
-require_relative 'helper'
-require 'kiba'
-require_relative 'support/test_array_destination'
+require_relative "helper"
+require "kiba"
+require_relative "support/test_array_destination"
 
 class TestEnumerableSource < Minitest::Test
   def assert_enumerable_source(input:, expected_output:)
@@ -16,12 +16,12 @@ def assert_enumerable_source(input:, expected_output:)
     end
     Kiba.run(job)
   end
-    
+
   def test_source_as_enumerable
     assert_enumerable_source(input: (1..10), expected_output: (2..20).step(2).to_a)
   end
-  
+
   def test_source_as_callable
     assert_enumerable_source(input: -> { (1..10) }, expected_output: (2..20).step(2).to_a)
   end
-end
+end