singed 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cc0d66eb51327ad33ea4c7ebb3a912dfed9d0dcf3c136c50b88352df68231bd
-  data.tar.gz: b02a7c770155ace82da51f37024d89a25836f7f4fffbc77983a067789f172aad
+  metadata.gz: ccc937a4dae7308cce56944f95e632c8e1001d7e2d51e148c7c24bab8ebb7e0a
+  data.tar.gz: 3bc4cbfad22a829baf1f973b23188442a9525c000554f6485b314641ce459988
 SHA512:
-  metadata.gz: 95b737124852e8d1863658b10b8ab589753f8f5b4d636269c4c3c403df130189fc4b65f7fb3409c70ca11845fbe8bdbd338330476a3f561bf7da9176613a055f
-  data.tar.gz: 966891d7739c6f1bbd63674d345f7a52e678a9791c56075c677fbb3013f575839fa1e399ca13bf08f1a2fe284abf431c2dd29d1a057c1e423356aac0e01a95de
+  metadata.gz: 8838d8a8b85fec579494d7a364a6f82d0a5a12245d076206a68d80264eacb01d43f1c6eb05c3258cf68c2d98f94caa160670f23d49e997b7c3ebd182028d8f99
+  data.tar.gz: c6effbd5a23d9df99c6d19516638c730bbdfc9be400f8d0e673b2d3a06c1144dc33470a18f3ff68d67bdce8242791792fdf6ee3dee78dcbf60292fed29970f28

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:
@@ -32,7 +34,7 @@ Singed.output_directory = "tmp/slowness-exploration"
 If you are calling it in a loop, or with different variations, you can include a label on the filename:
 
 ```ruby
-flamegraph(label: "rspec") {
+flamegraph("rspec") {
   # your code here
 }
 ```

data/lib/singed/cli.rb

@@ -1,6 +1,7 @@
 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
 
@@ -64,6 +65,7 @@ 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')
 
       options = {
@@ -86,11 +88,19 @@ module Singed
         prompt_password
       end
 
-      Bundler.with_unbundled_env do
+      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' }
       end
 
+      if defined?(Bundler)
+        Bundler.with_unbundled_env do
+          rbspy.call
+        end
+      else
+        rbspy.call
+      end
+
       unless filename.exist?
         puts "#{filename} doesn't exist. Maybe rbspy had a failure capturing it? Check the scrollback."
         exit 1
@@ -102,9 +112,9 @@ module Singed
       end
 
       # clean the report, similar to how Singed::Report does
-      json = JSON.parse(filename.read).with_indifferent_access
+      json = JSON.parse(filename.read)
       json['shared']['frames'].each do |frame|
-        frame[:file] = Singed.filter_line(frame[:file])
+        frame['file'] = Singed.filter_line(frame['file'])
       end
       filename.write(JSON.dump(json))
 

data/lib/singed/kernel_ext.rb

@@ -1,15 +1,15 @@
 module Kernel
-  def flamegraph(label = nil, open: true, ignore_gc: false, interval: 1000, &block)
+  def flamegraph(label = nil, open: true, ignore_gc: false, interval: 1000, io: $stdout, &block)
     fg = Singed::Flamegraph.new(label: label, ignore_gc: ignore_gc, interval: interval)
     result = fg.record(&block)
     fg.save
 
     if open
       # use npx, so we don't have to add it as a dependency
-      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
-      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.rb

@@ -13,7 +13,7 @@ module Singed
   end
 
   def self.output_directory
-    @output_directory || raise("output directory hasn't been set!")
+    @output_directory
   end
 
   def enabled=(enabled)
@@ -53,4 +53,4 @@ end
 
 require 'singed/kernel_ext'
 require 'singed/railtie' if defined?(Rails::Railtie)
-require 'singed/rspec' if defined?(RSpec)
+require 'singed/rspec' if defined?(RSpec) && RSpec.respond_to?(:configure)

data/singed.gemspec

@@ -3,25 +3,24 @@
 Gem::Specification.new do |spec|
   spec.name          = 'singed'
 
-  spec.version       = '0.1.1'
+  spec.version       = '0.2.1'
+  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.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_dependency 'stackprof', '>= 0.2.13'
 
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singed
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Josh Nichols
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-04-10 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
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - josh.nichols@gusto.com
@@ -74,7 +88,8 @@ files:
 - lib/singed/rspec.rb
 - singed.gemspec
 homepage: 
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []