singed 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b94bd39d1904f3d339e34974c5ad88bec590c2373ffedc6ffba15a4bce0fbb06
-  data.tar.gz: dcf1af83d2b05c7cc2d20566045a99781385408c6316ef183fa3cba77ec8538f
+  metadata.gz: 130f5fb69096f1a09875822dca8c86ca3a05876ca2b742cab274fb863ed7c253
+  data.tar.gz: 342357ad154850a5e5be841820cefe69609825650c8f0401c58a182f1ffd992c
 SHA512:
-  metadata.gz: c3155afc39b9bc923718a488ebc170f3c0b03ecdf8eb945af93a85ad489a3825dd464a10dc8289795b30b91e6ff0ce43a488f348a5e2cacd1308417626228edd
-  data.tar.gz: f0f054893e83aceb2f3342317f30e732e75c79af1fa61164e7b637fea5ae18b03b8aee5eac68b4d05facc4a37e62a5e1ef833d1aa86df55046de7e8686fc2aac
+  metadata.gz: 673f34810201f6050862488b728272ff769e5072b6a5fba90a4669b811efdbaa6fc9a8fd56c4f2cccebca7445c00bdc28700ec22881076dfcaef7bdf4bd5be2a
+  data.tar.gz: a839d09f7b78c96c4b1e38aa101fb755fef1c72ac3cee5068c0aef1df9d199ce3a73cfee3c40f6a2f934b6c14abb90765b3475e2a9ffc1d23e5a29f8eba01aab

data/README.md

@@ -12,6 +12,8 @@ gem "singed"
 
 Then run `bundle install`
 
+Then run `npm install -g speedscope`
+
 ## Usage
 
 Simplest is calling with a block:

data/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

data/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 @@ module Singed
     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 @@ module Singed
     end
 
     def run
-      require 'singed'
+      require "singed"
 
       if @error_message
         puts @error_message
@@ -66,31 +66,31 @@ module Singed
       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 @@ module Singed
 
       # 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 @@ module Singed
     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 @@ module Singed
       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 @@ module Singed
       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 @@ module Singed
         end
 
         # Otherwise keep moving upwards in search of an executable.
-        Dir.chdir('..')
+        Dir.chdir("..")
       end
     end
   end

data/lib/singed/flamegraph.rb

@@ -6,11 +6,11 @@ module Singed
       # 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 @@ module Singed
       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 @@ module Singed
     end
 
     def self.generate_filename(label: nil, time: Time.now) # rubocop:disable Rails/TimeZone
-      formatted_time = time.strftime('%Y%m%d%H%M%S')
-      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)

data/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

data/lib/singed/rack_middleware.rb

@@ -1,6 +1,6 @@
 # Rack Middleware
 
-require 'rack'
+require "rack"
 
 module Singed
   class RackMiddleware
@@ -21,15 +21,15 @@ module Singed
     end
 
     def capture_flamegraph?(env)
-      self.class.always_capture? || env['HTTP_X_SINGED'] == 'true'
+      self.class.always_capture? || env["HTTP_X_SINGED"] == "true"
     end
 
-    TRUTHY_STRINGS = ['true', '1', 'yes'].freeze
+    TRUTHY_STRINGS = ["true", "1", "yes"].freeze
 
     def self.always_capture?
       return @always_capture if defined?(@always_capture)
 
-      @always_capture = TRUTHY_STRINGS.include?(ENV.fetch('SINGED_MIDDLEWARE_ALWAYS_CAPTURE', 'false'))
+      @always_capture = TRUTHY_STRINGS.include?(ENV.fetch("SINGED_MIDDLEWARE_ALWAYS_CAPTURE", "false"))
     end
   end
 end

data/lib/singed/railtie.rb

@@ -1,9 +1,9 @@
-require 'singed/backtrace_cleaner_ext'
-require 'singed/controller_ext'
+require "singed/backtrace_cleaner_ext"
+require "singed/controller_ext"
 
 module Singed
   class Railtie < Rails::Railtie
-    initializer 'singed.configure_rails_initialization' do |app|
+    initializer "singed.configure_rails_initialization" do |app|
       self.class.init!
 
       app.middleware.use Singed::RackMiddleware
@@ -14,7 +14,7 @@ module Singed
     end
 
     def self.init!
-      Singed.output_directory = Rails.root.join('tmp/speedscope')
+      Singed.output_directory = Rails.root.join("tmp/speedscope")
       Singed.backtrace_cleaner = Rails.backtrace_cleaner
     end
   end

data/lib/singed/rspec.rb

@@ -1,11 +1,7 @@
-require 'singed'
+require "singed"
 
 RSpec.configure do |config|
-  config.around do |example|
-    if example.metadata[:flamegraph]
-      flamegraph { example.run }
-    else
-      example.run
-    end
+  config.around(flamegraph: true) do |example|
+    flamegraph { example.run }
   end
 end

data/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 @@ module Singed
     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)
+require "singed/kernel_ext"
+require "singed/railtie" if defined?(Rails::Railtie)
+require "singed/rspec" if defined?(RSpec) && RSpec.respond_to?(:configure)

data/singed.gemspec

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
 Gem::Specification.new do |spec|
-  spec.name          = 'singed'
-
-  spec.version       = '0.2.0'
-  spec.authors       = ['Josh Nichols']
-  spec.email         = ['josh.nichols@gusto.com']
-
-  spec.summary       = 'Quick and easy way to get flamegraphs from a specific part of your code base'
-  spec.required_ruby_version = '>= 2.7.0'
-
-  # spec.metadata['allowed_push_host'] = "TODO: Set to your gem server 'https://example.com'"
-
-  spec.files         = Dir['README.md', '*.gemspec', 'lib/**/*', 'exe/**/*']
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r(\Aexe/)) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Uncomment to register a new dependency of your gem
-  spec.add_dependency 'colorize'
-  spec.add_dependency 'stackprof'
-
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec'
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.name = "singed"
+
+  spec.version = "0.2.2"
+  spec.license = "MIT"
+  spec.authors = ["Josh Nichols"]
+  spec.email = ["josh.nichols@gusto.com"]
+  spec.summary = "Quick and easy way to get flamegraphs from a specific part of your code base"
+  spec.required_ruby_version = ">= 2.7.0"
+  spec.homepage = "https://github.com/rubyatscale/singed"
+  spec.metadata = {
+    "source_code_uri" => "https://github.com/rubyatscale/singed.git",
+    "bug_tracker_uri" => "https://github.com/rubyatscale/singed/issues",
+    "homepage_uri" => "https://github.com/rubyatscale/singed"
+  }
+
+  spec.files = Dir["README.md", "*.gemspec", "lib/**/*", "exe/**/*"]
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "colorize"
+  spec.add_dependency "stackprof", ">= 0.2.13"
+
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singed
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Josh Nichols
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-21 00:00:00.000000000 Z
+date: 2024-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.13
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - josh.nichols@gusto.com
 executables:
@@ -87,10 +87,14 @@ files:
 - lib/singed/report.rb
 - lib/singed/rspec.rb
 - singed.gemspec
-homepage: 
-licenses: []
-metadata: {}
-post_install_message: 
+homepage: https://github.com/rubyatscale/singed
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/rubyatscale/singed.git
+  bug_tracker_uri: https://github.com/rubyatscale/singed/issues
+  homepage_uri: https://github.com/rubyatscale/singed
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +109,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.4
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: Quick and easy way to get flamegraphs from a specific part of your code base
 test_files: []