Refactoring

- More robust loop, better error handling
- Move from app/ to lib/
- Add Loggers
- Migrate from Minitest to RSpec

Author: ledermann

.dockerignore

@@ -8,3 +8,4 @@ test
 Rakefile
 Dockerfile
 coverage
+Guardfile

.github/workflows/push.yml

@@ -35,7 +35,7 @@ jobs:
         run: bundle exec rubocop
 
       - name: Run tests
-        run: bundle exec rake test
+        run: bundle exec rake spec
 
       - name: Send test coverage to CodeClimate
         uses: paambaati/[email protected]

.rspec

@@ -0,0 +1 @@
+--require spec_helper

.rubocop.yml

@@ -1,5 +1,5 @@
 require:
-  - rubocop-minitest
+  - rubocop-rspec
   - rubocop-rake
   - rubocop-performance
 
@@ -10,26 +10,52 @@ AllCops:
     - 'vendor/**/*'
   NewCops: enable
 
-Style/Documentation:
+# Layout
+
+Layout/LineLength:
+  Max: 130
+
+Layout/LineEndStringConcatenationIndentation:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
+# Metrics
+
+Metrics/AbcSize:
+  Max: 18
+
+Metrics/ClassLength:
   Enabled: false
 
 Metrics/MethodLength:
   Max: 20
 
-Metrics/ClassLength:
-  Max: 200
+# Style
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
 
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: consistent_comma
 
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
-Layout/LineEndStringConcatenationIndentation:
+# RSpec
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/NoExpectationExample:
   Enabled: false
 
-Layout/FirstArrayElementIndentation:
+RSpec/MultipleExpectations:
   Enabled: false

.vscode/tasks.json

@@ -0,0 +1,45 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "guard-rspec",
+      "command": "rbenv",
+      "args": ["exec", "bundle", "exec", "guard"],
+      "isBackground": true,
+      "problemMatcher": {
+        "applyTo": "allDocuments",
+        "owner": "Ruby",
+        "fileLocation": ["relative", "${workspaceRoot}"],
+        "pattern": [
+          {
+            "regexp": "^(Error|Warning|Info):.*$",
+            "severity": 1
+          },
+          {
+            "regexp": "^\\s*[^#]+#[^:]+:$",
+            "message": 0
+          },
+          {
+            "regexp": "^\\s*([^:]+):(.*)$",
+            "message": 5
+          },
+          {
+            "regexp": "^    ([^:]+):(\\d+):in (.+)$",
+            "file": 1,
+            "location": 2,
+            "code": 3
+          }
+        ],
+        "background": {
+          "activeOnStart": true,
+          "beginsPattern": "^# Running:$",
+          "endsPattern": "^\\d+ runs.*$"
+        }
+      },
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      }
+    }
+  ]
+}

Dockerfile

@@ -32,4 +32,4 @@ WORKDIR /mqtt-collector
 COPY --from=Builder /usr/local/bundle/ /usr/local/bundle/
 COPY . /mqtt-collector/
 
-ENTRYPOINT bundle exec app/main.rb
+ENTRYPOINT bundle exec app.rb

Gemfile

@@ -15,25 +15,33 @@ gem 'csv'
 # Support for encoding and decoding binary data using a Base64 representation. (https://github.com/ruby/base64)
 gem 'base64'
 
+group :development do
+  # Guard gem for RSpec (https://github.com/guard/guard-rspec)
+  gem 'guard-rspec', require: false
+
+  # Pretty print Ruby objects with proper indentation and colors (https://github.com/amazing-print/amazing_print)
+  gem 'amazing_print'
+end
+
 group :development, :test do
-  # minitest provides a complete suite of testing facilities supporting TDD, BDD, mocking, and benchmarking (https://github.com/minitest/minitest)
-  gem 'minitest'
+  # rspec-3.13.0 (http://github.com/rspec)
+  gem 'rspec'
 
   # Rake is a Make-like program implemented in Ruby (https://github.com/ruby/rake)
   gem 'rake'
 
   # Automatic Ruby code style checking tool. (https://github.com/rubocop/rubocop)
   gem 'rubocop'
 
-  # Automatic Minitest code style checking tool.
-  gem 'rubocop-minitest'
-
   # A RuboCop plugin for Rake (https://github.com/rubocop/rubocop-rake)
   gem 'rubocop-rake'
 
   # Automatic performance checking tool for Ruby code. (https://github.com/rubocop/rubocop-performance)
   gem 'rubocop-performance'
 
+  # Code style checking for RSpec files (https://github.com/rubocop/rubocop-rspec)
+  gem 'rubocop-rspec'
+
   # Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests. (https://benoittgt.github.io/vcr)
   gem 'vcr'
 

Gemfile.lock

@@ -3,32 +3,78 @@ GEM
   specs:
     addressable (2.8.6)
       public_suffix (>= 2.0.2, < 6.0)
+    amazing_print (1.6.0)
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.7)
     climate_control (1.2.0)
+    coderay (1.1.3)
     crack (1.0.0)
       bigdecimal
       rexml
     csv (3.2.8)
+    diff-lcs (1.5.1)
     docile (1.4.0)
     dotenv (3.1.0)
+    ffi (1.16.3)
+    formatador (1.1.0)
+    guard (2.18.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.13.0)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
     hashdiff (1.1.0)
     influxdb-client (3.1.0)
     json (2.7.1)
     language_server-protocol (3.17.0.3)
-    minitest (5.22.3)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.10)
+    method_source (1.0.0)
     mqtt (0.6.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
     parallel (1.24.0)
     parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     public_suffix (5.0.4)
     racc (1.7.3)
     rainbow (3.1.1)
     rake (13.1.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.9.0)
     rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
     rubocop (1.62.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -42,21 +88,28 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
-    rubocop-minitest (0.35.0)
-      rubocop (>= 1.61, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
     rubocop-performance (1.20.2)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.30.0, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
+    rubocop-rspec (2.27.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
+    shellany (0.0.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    thor (1.3.1)
     unicode-display_width (2.5.0)
     vcr (6.2.0)
     webmock (3.23.0)
@@ -68,18 +121,20 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  amazing_print
   base64
   climate_control
   csv
   dotenv
+  guard-rspec
   influxdb-client
-  minitest
   mqtt
   rake
+  rspec
   rubocop
-  rubocop-minitest
   rubocop-performance
   rubocop-rake
+  rubocop-rspec
   simplecov
   vcr
   webmock

Guardfile

@@ -0,0 +1,49 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Ignore unneeded folders to prevent high CPU load
+# https://stackoverflow.com/a/20543493/57950
+ignore(
+  [
+    %r{^coverage/*},
+    %r{^.vscode/*},
+    %r{^.github/*},
+  ],
+)
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'rspec --colour --format documentation --fail-fast' do
+  directories(%w[lib spec])
+
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_files)
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+end

README.md

@@ -41,7 +41,7 @@ For development you need a recent Ruby setup. On a Mac, I recommend [rbenv](http
 ### Run the app
 
 ```bash
-bundle exec app/main.rb
+bundle exec app.rb
 ```
 
 ### Run tests

Rakefile

@@ -1,13 +1,6 @@
-require 'rubygems'
-require 'bundler'
-require 'rake/testtask'
-require 'dotenv'
-Dotenv.load('.env.test')
+require 'rake'
+require 'rspec/core/rake_task'
 
-Rake::TestTask.new :test do |t|
-  t.libs << 'test' << 'app'
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task default: :test
+task default: :spec