Merge pull request #24 from rubyatscale/standardrb

Use standardrb for linting

Author: technicalpickles

.github/workflows/standardrb.yaml

@@ -0,0 +1,13 @@
+name: StandardRB
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: StandardRB Linter
+      uses: standardrb/[email protected]
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.standard.yml

@@ -0,0 +1,2 @@
+fix: true
+format: progress

Gemfile

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in singed.gemspec
 gemspec
 
-gem 'rake', '~> 13.0'
+gem "rake", "~> 13.0"
+gem "standard"

Gemfile.lock

@@ -1,16 +1,28 @@
 PATH
   remote: .
   specs:
-    singed (0.2.1)
+    singed (0.2.2)
       colorize
       stackprof (>= 0.2.13)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     colorize (0.8.1)
     diff-lcs (1.5.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    parallel (1.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
     rake (13.0.6)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -24,7 +36,37 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
+    rubocop (1.62.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.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
     stackprof (0.2.17)
+    standard (1.35.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.62.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
@@ -33,6 +75,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec
   singed!
+  standard
 
 BUNDLED WITH
    2.4.4

Rakefile

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-task default: %i()
+require "bundler/gem_tasks"
+task default: %i[]

exe/singed

@@ -1,9 +1,8 @@
 #!/usr/bin/env ruby
 
-
-require 'singed/cli'
+require "singed/cli"
 if Singed::CLI.chdir_rails_root
-  require './config/environment'
+  require "./config/environment"
 end
 
 Singed::CLI.new(ARGV).run

lib/singed.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'stackprof'
-require 'colorize'
+require "json"
+require "stackprof"
+require "colorize"
 
 module Singed
   extend self
@@ -46,11 +46,11 @@ def filter_line(line)
     line
   end
 
-  autoload :Flamegraph, 'singed/flamegraph'
-  autoload :Report, 'singed/report'
-  autoload :RackMiddleware, 'singed/rack_middleware'
+  autoload :Flamegraph, "singed/flamegraph"
+  autoload :Report, "singed/report"
+  autoload :RackMiddleware, "singed/rack_middleware"
 end
 
-require 'singed/kernel_ext'
-require 'singed/railtie' if defined?(Rails::Railtie)
-require 'singed/rspec' if defined?(RSpec) && RSpec.respond_to?(:configure)
+require "singed/kernel_ext"
+require "singed/railtie" if defined?(Rails::Railtie)
+require "singed/rspec" if defined?(RSpec) && RSpec.respond_to?(:configure)

lib/singed/cli.rb

@@ -1,7 +1,7 @@
-require 'shellwords'
-require 'tmpdir'
-require 'optionparser'
-require 'pathname'
+require "shellwords"
+require "tmpdir"
+require "optionparser"
+require "pathname"
 
 # NOTE: we defer requiring singed until we run. that lets Rails load it if its in the gemfile, so the railtie has had a chance to run
 
@@ -17,24 +17,24 @@ def initialize(argv)
     end
 
     def parse_argv!
-      opts.banner = 'Usage: singed [options] <command>'
+      opts.banner = "Usage: singed [options] <command>"
 
-      opts.on('-h', '--help', 'Show this message') do
+      opts.on("-h", "--help", "Show this message") do
         @show_help = true
       end
 
-      opts.on('-o', '--output-directory DIRECTORY', 'Directory to write flamegraph to') do |directory|
+      opts.on("-o", "--output-directory DIRECTORY", "Directory to write flamegraph to") do |directory|
         @output_directory = directory
       end
 
       opts.order(@argv) do |arg|
-        opts.terminate if arg == '--'
+        opts.terminate if arg == "--"
         break
       end
 
       if @argv.empty?
         @show_help = true
-        @error_message = 'missing command to profile'
+        @error_message = "missing command to profile"
         return
       end
 
@@ -49,7 +49,7 @@ def parse_argv!
     end
 
     def run
-      require 'singed'
+      require "singed"
 
       if @error_message
         puts @error_message
@@ -66,31 +66,31 @@ def run
       Singed.output_directory = @output_directory if @output_directory
       Singed.output_directory ||= Dir.tmpdir
       FileUtils.mkdir_p Singed.output_directory
-      @filename = Singed::Flamegraph.generate_filename(label: 'cli')
+      @filename = Singed::Flamegraph.generate_filename(label: "cli")
 
       options = {
-        format: 'speedscope',
+        format: "speedscope",
         file: filename.to_s,
-        silent: nil,
+        silent: nil
       }
 
       rbspy_args = [
-        'record',
+        "record",
         *options.map { |k, v| ["--#{k}", v].compact }.flatten,
-        '--',
-        *argv,
+        "--",
+        *argv
       ]
 
       loop do
         break unless password_needed?
 
-        puts '🔥📈 Singed needs to run as root, but will drop permissions back to your user. Prompting with sudo now...'
+        puts "🔥📈 Singed needs to run as root, but will drop permissions back to your user. Prompting with sudo now..."
         prompt_password
       end
 
       rbspy = lambda do
         # don't run things with spring, because it forks and rbspy won't see it
-        sudo ['rbspy', *rbspy_args], reason: 'Singed needs to run as root, but will drop permissions back to your user.', env: { 'DISABLE_SPRING' => '1' }
+        sudo ["rbspy", *rbspy_args], reason: "Singed needs to run as root, but will drop permissions back to your user.", env: {"DISABLE_SPRING" => "1"}
       end
 
       if defined?(Bundler)
@@ -113,8 +113,8 @@ def run
 
       # clean the report, similar to how Singed::Report does
       json = JSON.parse(filename.read)
-      json['shared']['frames'].each do |frame|
-        frame['file'] = Singed.filter_line(frame['file'])
+      json["shared"]["frames"].each do |frame|
+        frame["file"] = Singed.filter_line(frame["file"])
       end
       filename.write(JSON.dump(json))
 
@@ -123,15 +123,15 @@ def run
     end
 
     def password_needed?
-      !system('sudo --non-interactive true >/dev/null 2>&1')
+      !system("sudo --non-interactive true >/dev/null 2>&1")
     end
 
     def prompt_password
-      system('sudo true')
+      system("sudo true")
     end
 
     def adjust_ownership!
-      sudo ['chown', ENV['USER'], filename], reason: "Adjusting ownership of #{filename}, but need root."
+      sudo ["chown", ENV["USER"], filename], reason: "Adjusting ownership of #{filename}, but need root."
     end
 
     def show_help?
@@ -147,9 +147,9 @@ def sudo(system_args, reason:, env: {})
       end
 
       sudo_args = [
-        'sudo',
-        '--preserve-env',
-        *system_args.map(&:to_s),
+        "sudo",
+        "--preserve-env",
+        *system_args.map(&:to_s)
       ]
 
       puts "$ #{Shellwords.join(sudo_args)}"
@@ -161,7 +161,7 @@ def self.chdir_rails_root
       original_cwd = Dir.pwd
 
       loop do
-        if File.file?('config/environment.rb')
+        if File.file?("config/environment.rb")
           return Dir.pwd
         end
 
@@ -171,7 +171,7 @@ def self.chdir_rails_root
         end
 
         # Otherwise keep moving upwards in search of an executable.
-        Dir.chdir('..')
+        Dir.chdir("..")
       end
     end
   end

lib/singed/flamegraph.rb

@@ -6,11 +6,11 @@ def initialize(label: nil, ignore_gc: false, interval: 1000, filename: nil)
       # it's been created elsewhere, ie rbspy
       if filename
         if ignore_gc
-          raise ArgumentError, 'ignore_gc not supported when given an existing file'
+          raise ArgumentError, "ignore_gc not supported when given an existing file"
         end
 
         if label
-          raise ArgumentError, 'label not supported when given an existing file'
+          raise ArgumentError, "label not supported when given an existing file"
         end
 
         @filename = filename
@@ -41,7 +41,7 @@ def save
       report = Singed::Report.new(@profile)
       report.filter!
       filename.dirname.mkpath
-      filename.open('w') { |f| report.print_json(f) }
+      filename.open("w") { |f| report.print_json(f) }
     end
 
     def open
@@ -53,10 +53,10 @@ def open_command
     end
 
     def self.generate_filename(label: nil, time: Time.now) # rubocop:disable Rails/TimeZone
-      formatted_time = time.strftime('%Y%m%d%H%M%S-%6N')
-      basename_parts = ['speedscope', label, formatted_time].compact
+      formatted_time = time.strftime("%Y%m%d%H%M%S-%6N")
+      basename_parts = ["speedscope", label, formatted_time].compact
 
-      file = Singed.output_directory.join("#{basename_parts.join('-')}.json")
+      file = Singed.output_directory.join("#{basename_parts.join("-")}.json")
       # convert to relative directory if it's an absolute path and within the current
       pwd = Pathname.pwd
       file = file.relative_path_from(pwd) if file.absolute? && file.to_s.start_with?(pwd.to_s)

lib/singed/kernel_ext.rb

@@ -1,15 +1,15 @@
 module Kernel
-  def flamegraph(label = nil, open: true, ignore_gc: false, interval: 1000, io: $stdout, &block)
+  def flamegraph(label = nil, open: true, ignore_gc: false, interval: 1000, io: $stdout, &)
     fg = Singed::Flamegraph.new(label: label, ignore_gc: ignore_gc, interval: interval)
-    result = fg.record(&block)
+    result = fg.record(&)
     fg.save
 
     if open
       # use npx, so we don't have to add it as a dependency
-      io.puts "🔥📈 #{'Captured flamegraph, opening with'.colorize(:bold).colorize(:red)}: #{fg.open_command}"
+      io.puts "🔥📈 #{"Captured flamegraph, opening with".colorize(:bold).colorize(:red)}: #{fg.open_command}"
       fg.open
     else
-      io.puts "🔥📈 #{'Captured flamegraph to file'.colorize(:bold).colorize(:red)}: #{fg.filename}"
+      io.puts "🔥📈 #{"Captured flamegraph to file".colorize(:bold).colorize(:red)}: #{fg.filename}"
     end
 
     result