singed 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5276eb42b69baf43de15c7ad5a3549f048d00865f225998eb4479b6e7723f2b8
-  data.tar.gz: 0f46bfb076f12a4766e060a017f2cb0e9ad6af98a96b8f96ebf05b58205aac21
+  metadata.gz: 6cc0d66eb51327ad33ea4c7ebb3a912dfed9d0dcf3c136c50b88352df68231bd
+  data.tar.gz: b02a7c770155ace82da51f37024d89a25836f7f4fffbc77983a067789f172aad
 SHA512:
-  metadata.gz: 81b34cf130fbe187680d65ba593ee68ce606e72cbb5db99284aba82beb6bf9ac17cef5104850a49ebba7bce87cc8a11b39f4b0897accb9bc6e0cb268ee35168e
-  data.tar.gz: 23e265212f1f70ebe105c218dde2025728782ae1574ef2abcf4705b04e13eeab7bd9b6197442b950517492c5a540a2ebaa99478d7841b4170a8611ff668094a9
+  metadata.gz: 95b737124852e8d1863658b10b8ab589753f8f5b4d636269c4c3c403df130189fc4b65f7fb3409c70ca11845fbe8bdbd338330476a3f561bf7da9176613a055f
+  data.tar.gz: 966891d7739c6f1bbd63674d345f7a52e678a9791c56075c677fbb3013f575839fa1e399ca13bf08f1a2fe284abf431c2dd29d1a057c1e423356aac0e01a95de

data/README.md

@@ -1,10 +1,20 @@
 # Singed
 
-Singed makes it easy to get a flamegraph anywhere in your code base:
+Singed makes it easy to get a flamegraph anywhere in your code base. It wraps profiling your code with [stackprof](https://github.com/tmm1/stackprof) or [rbspy](https://github.com/rbspy/rbspy), and then launching [speedscope](https://github.com/jlfwong/speedscope) to view it.
+
+## Installation
+
+Add to `Gemfile`:
+
+```ruby
+gem "singed"
+```
+
+Then run `bundle install`
 
 ## Usage
 
-To profile your code, and launch [speedscope](https://github.com/jlfwong/speedscope) for viewing it:
+Simplest is calling with a block:
 
 ```ruby
 flamegraph {
@@ -64,7 +74,7 @@ class EmployeesController < ApplicationController
 end
 ```
 
-This won't catch the entire request though, just once it's been routed to controller and a response has been served.
+This won't catch the entire request though, just once it's been routed to controller and a response has been served (ie no middleware).
 
 ### Rack/Rails requests
 
@@ -84,7 +94,7 @@ There is a `singed` command line you can use that will record a flamegraph from
 
 ```shell
 $ bundle binstub singed # if you want to be able to call it like bin/singed
-$ bundle exec singed -- bin/rails 
+$ bundle exec singed -- bin/rails runner 'Model.all.to_a'
 ```
 
 The flamegraph is opened afterwards.
@@ -98,5 +108,5 @@ The `open` is expected to be available.
 
 ## Alternatives
 
-- using [rbspy](https://rbspy.github.io/) directory
+- using [rbspy](https://rbspy.github.io/) directly
 - using [stackprof](https://github.com/tmm1/stackprof) (a dependency of singed) directly

data/lib/singed/flamegraph.rb

@@ -53,7 +53,7 @@ module Singed
     end
 
     def self.generate_filename(label: nil, time: Time.now) # rubocop:disable Rails/TimeZone
-      formatted_time = time.to_formatted_s(:number)
+      formatted_time = time.strftime('%Y%m%d%H%M%S')
       basename_parts = ['speedscope', label, formatted_time].compact
 
       file = Singed.output_directory.join("#{basename_parts.join('-')}.json")

data/singed.gemspec

@@ -3,7 +3,7 @@
 Gem::Specification.new do |spec|
   spec.name          = 'singed'
 
-  spec.version       = '0.1.0'
+  spec.version       = '0.1.1'
   spec.authors       = ['Josh Nichols']
   spec.email         = ['josh.nichols@gusto.com']
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: singed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Josh Nichols
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize