Merge pull request #22 from joaoGabriel55/build/add-standard-linter

carlosdanielpohlod · web-flow · commit 50bb916d81bf · 2024-09-06T10:18:29.000-03:00
Build: Add Standard: The Standard Linter/Formatter Gem
diff --git a/Gemfile b/Gemfile
@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -6,8 +6,21 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     diff-lcs (1.5.1)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    parallel (1.25.1)
+    parser (3.3.4.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.0)
+    rainbow (3.1.1)
     rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.2)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -21,14 +34,47 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.39.2)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.64.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    strscan (3.1.0)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
   rails_tracepoint_stack!
   rake (~> 13.0, >= 13.0.0)
   rspec (~> 3.0, >= 3.0.0)
+  standard (~> 1.39, >= 1.39.1)
 
 BUNDLED WITH
-   2.4.17
+   2.5.16
diff --git a/Rakefile b/Rakefile
@@ -1,6 +1,5 @@
-
-require 'rake'
-require 'rspec/core/rake_task'
+require "rake"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
diff --git a/lib/rails_tracepoint_stack.rb b/lib/rails_tracepoint_stack.rb
@@ -28,7 +28,7 @@ def self.enable_trace
   end
 end
 
-if ENV.fetch('RAILS_TRACEPOINT_STACK_ENABLED', 'false') == 'true'
+if ENV.fetch("RAILS_TRACEPOINT_STACK_ENABLED", "false") == "true"
   $rails_tracer_rtps = RailsTracepointStack::Tracer.new.tracer
   $rails_tracer_rtps.enable
 
diff --git a/lib/rails_tracepoint_stack/filter/rb_config.rb b/lib/rails_tracepoint_stack/filter/rb_config.rb
@@ -2,7 +2,7 @@ module RailsTracepointStack
   module Filter
     class RbConfig
       def self.ruby_lib_path
-        @ruby_lib_path ||= ::RbConfig::CONFIG['rubylibdir']
+        @ruby_lib_path ||= ::RbConfig::CONFIG["rubylibdir"]
       end
     end
   end
diff --git a/lib/rails_tracepoint_stack/logger.rb b/lib/rails_tracepoint_stack/logger.rb
@@ -5,7 +5,7 @@ def self.log(msg)
         RailsTracepointStack.configuration.logger.info(msg)
       else
         # TODO: Add the support to Rails.env for the default filename
-        File.open("log/rails_tracepoint_stack.log", 'a') do |f|
+        File.open("log/rails_tracepoint_stack.log", "a") do |f|
           f.puts msg
         end
       end
diff --git a/lib/rails_tracepoint_stack/trace.rb b/lib/rails_tracepoint_stack/trace.rb
@@ -1,4 +1,4 @@
-require 'forwardable'
+require "forwardable"
 
 module RailsTracepointStack
   class Trace
diff --git a/lib/rails_tracepoint_stack/trace_filter.rb b/lib/rails_tracepoint_stack/trace_filter.rb
@@ -22,7 +22,7 @@ def ignore_trace?(trace:)
       end
       if should_ignore_because_is_ruby_trace?(trace: trace)
         return true
-      end 
+      end
 
       return false
     end
diff --git a/lib/rails_tracepoint_stack/tracer.rb b/lib/rails_tracepoint_stack/tracer.rb
@@ -1,8 +1,8 @@
-#TODO: Move to a loader file
-require 'rails_tracepoint_stack/logger'
-require 'rails_tracepoint_stack/trace_filter'
-require 'rails_tracepoint_stack/trace'
-require 'rails_tracepoint_stack/log_formatter'
+# TODO: Move to a loader file
+require "rails_tracepoint_stack/logger"
+require "rails_tracepoint_stack/trace_filter"
+require "rails_tracepoint_stack/trace"
+require "rails_tracepoint_stack/log_formatter"
 
 module RailsTracepointStack
   class Tracer
@@ -16,7 +16,7 @@ def tracer
 
         # TODO: Use proper OO
         message = RailsTracepointStack::LogFormatter.message trace
-        RailsTracepointStack::Logger.log message 
+        RailsTracepointStack::Logger.log message
       end
     end
   end
diff --git a/rails_tracepoint_stack.gemspec b/rails_tracepoint_stack.gemspec
@@ -1,13 +1,13 @@
 require_relative "lib/rails_tracepoint_stack/version"
 
 Gem::Specification.new do |s|
-  s.name        = "rails_tracepoint_stack"
-  s.version     = RailsTracepointStack::VERSION
-  s.summary     = "Get a complete stack trace for your code on a Rails application."
+  s.name = "rails_tracepoint_stack"
+  s.version = RailsTracepointStack::VERSION
+  s.summary = "Get a complete stack trace for your code on a Rails application."
   s.description = "A formatted output of all methods called in your rails application of code created by the developer, with the complete path to the class/module, including passed params."
-  s.authors     = ["Carlos Daniel Pohlod"]
-  s.email       = "carlospohlod@gmail.com"
-  s.files       = [
+  s.authors = ["Carlos Daniel Pohlod"]
+  s.email = "carlospohlod@gmail.com"
+  s.files = [
     "lib/rails_tracepoint_stack.rb",
     "lib/rails_tracepoint_stack/configuration.rb",
     "lib/rails_tracepoint_stack/log_formatter.rb",
@@ -23,12 +23,13 @@ Gem::Specification.new do |s|
     "lib/rails_tracepoint_stack/filter/trace_from_ruby_code_filter.rb",
     "lib/rails_tracepoint_stack/filter/trace_to_ignore_filter.rb",
   ]
-  s.homepage    = "https://github.com/carlosdanielpohlod/rails_tracepoint_stack/"
-  s.license     = "MIT"
+  s.homepage = "https://github.com/carlosdanielpohlod/rails_tracepoint_stack/"
+  s.license = "MIT"
   s.metadata["documentation_uri"] = "https://github.com/carlosdanielpohlod/rails_tracepoint_stack/"
   s.metadata["changelog_uri"] = "https://github.com/carlosdanielpohlod/rails_tracepoint_stack/blob/main/changelog.md"
 
-  s.required_ruby_version = '>= 3.0'
-  s.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
-  s.add_development_dependency 'rake', '~> 13.0', '>= 13.0.0'
+  s.required_ruby_version = ">= 3.0"
+  s.add_development_dependency "rspec", "~> 3.0", ">= 3.0.0"
+  s.add_development_dependency "rake", "~> 13.0", ">= 13.0.0"
+  s.add_development_dependency "standard", "~> 1.39", ">= 1.39.1"
 end
diff --git a/spec/rails_tracepoint_stack/log_formatter_spec.rb b/spec/rails_tracepoint_stack/log_formatter_spec.rb
@@ -1,66 +1,66 @@
-require 'spec_helper'
-require 'json'
+require "spec_helper"
+require "json"
 
 RSpec.describe RailsTracepointStack::LogFormatter do
   let(:trace_double) do
-    instance_double(RailsTracepointStack::Trace, 
-                    class_name: "MyClass", 
-                    method_name: :my_method, 
-                    file_path: "/path/to/file.rb", 
-                    line_number: 42, 
-                    params: { key: 'value' })
+    instance_double(RailsTracepointStack::Trace,
+      class_name: "MyClass",
+      method_name: :my_method,
+      file_path: "/path/to/file.rb",
+      line_number: 42,
+      params: {key: "value"})
   end
 
-  describe '.message' do
-    context 'when format is :json' do
+  describe ".message" do
+    context "when format is :json" do
       before do
         allow(RailsTracepointStack)
           .to receive_message_chain(:configuration, :log_format)
           .and_return(:json)
       end
 
-      it 'returns a JSON formatted string' do
+      it "returns a JSON formatted string" do
         expected_json = {
           class: "MyClass",
           method_name: :my_method,
           path: "/path/to/file.rb",
           line: 42,
-          params: { key: 'value' }
+          params: {key: "value"}
         }.to_json
 
         expect(described_class.message(trace_double)).to eq(expected_json)
       end
     end
 
-    context 'when format is not :json' do
+    context "when format is not :json" do
       before do
         allow(RailsTracepointStack)
-        .to receive_message_chain(:configuration, :log_format)
-        .and_return(nil)
+          .to receive_message_chain(:configuration, :log_format)
+          .and_return(nil)
       end
 
-      it 'returns a text formatted string' do
+      it "returns a text formatted string" do
         expected_text = "called: MyClass#my_method in /path/to/file.rb:42 with params: {:key=>\"value\"}"
         expect(described_class.message(trace_double)).to eq(expected_text)
       end
     end
   end
 
-  describe '.text' do
-    it 'returns a text formatted string' do
+  describe ".text" do
+    it "returns a text formatted string" do
       expected_text = "called: MyClass#my_method in /path/to/file.rb:42 with params: {:key=>\"value\"}"
       expect(described_class.text(trace_double)).to eq(expected_text)
     end
   end
 
-  describe '.json' do
-    it 'returns a JSON formatted string' do
+  describe ".json" do
+    it "returns a JSON formatted string" do
       expected_json = {
         class: "MyClass",
         method_name: :my_method,
         path: "/path/to/file.rb",
         line: 42,
-        params: { key: 'value' }
+        params: {key: "value"}
       }.to_json
 
       expect(described_class.json(trace_double)).to eq(expected_json)
diff --git a/spec/rails_tracepoint_stack/logger_spec.rb b/spec/rails_tracepoint_stack/logger_spec.rb
@@ -1,18 +1,18 @@
-require 'spec_helper'
-require 'fileutils'
+require "spec_helper"
+require "fileutils"
 
 RSpec.describe RailsTracepointStack::Logger do
   let(:log_message) { "This is a test log message." }
-  let(:log_file_path) { 'log/rails_tracepoint_stack.log' }
+  let(:log_file_path) { "log/rails_tracepoint_stack.log" }
   context "when provide a custom logger" do
-    let(:custom_logger) { double('Logger', info: true) }
+    let(:custom_logger) { double("Logger", info: true) }
     before do
       RailsTracepointStack.configure do |config|
         config.logger = custom_logger
       end
     end
-    
-    it 'uses the custom logger to log the message' do
+
+    it "uses the custom logger to log the message" do
       described_class.log(log_message)
 
       expect(custom_logger)
@@ -29,10 +29,10 @@
 
       allow(File)
         .to receive(:open)
-        .with('log/rails_tracepoint_stack.log', 'a')
+        .with("log/rails_tracepoint_stack.log", "a")
     end
 
-    it 'logs the message to the default log file' do
+    it "logs the message to the default log file" do
       described_class.log(log_message)
 
       expect(File).to have_received(:open)
diff --git a/spec/rails_tracepoint_stack/trace_filter_spec.rb b/spec/rails_tracepoint_stack/trace_filter_spec.rb
diff --git a/spec/rails_tracepoint_stack/trace_spec.rb b/spec/rails_tracepoint_stack/trace_spec.rb
diff --git a/spec/rails_tracepoint_stack/tracer_spec.rb b/spec/rails_tracepoint_stack/tracer_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-source 'https://rubygems.org'`
	`1`	`+source "https://rubygems.org"`
`2`	`2`
`3`	`3`	`gemspec`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-require 'forwardable'`
	`1`	`+require "forwardable"`
`2`	`2`
`3`	`3`	`module RailsTracepointStack`
`4`	`4`	`class Trace`