rspec_profiling 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1395be18ece44c2dcfededac3437d6dc6513a5d66cd08eed8d2cfaaff03aad0e
-  data.tar.gz: 01a97ea2671d1154469a611142528cdd4778d70561f4c403382b89f332a107e8
+  metadata.gz: d9b5f4ed5db1ef327545a3609ecaa955c0e9c438842c36c2efd1f0c5fdcf6753
+  data.tar.gz: 4012c683e52eb5ae99766d904b9b89fea1c5163c88aaf353f70ed8faa2c3e592
 SHA512:
-  metadata.gz: f2aa36663dd1bbb6e121ee3282fa4595aea9775e266c6cf8e3926c9e9338a9ff94891a0792d64aae9c6222673cd003414d1d35bf38e59ae2c79086f76977ee5a
-  data.tar.gz: 9d06c7160f4b0fb634c2c2719ef63fe428fc5a71171d42885c2bd5598fa7c8a33f37ea9cb92165f84b7d8637d4bec8f64b2025224116270dbbff8bfa4662698e
+  metadata.gz: 428016ee95be0dd84792839f468d1da94dba1e17dd02197c3b077b7fc486457d9c67a763bba11b8a25802e834f34d9a7fef9713b04e4ec6099ceb944062f3989
+  data.tar.gz: 3b6f6731030a443fe2bc3860f4ac1c8a9a9d91818b147a1867ed898e39004fc434e04b1eab0e3f353493ef76b1bdd7c1dc8f8512777a3bf31c8b2f3c2e8de35b

data/.github/workflows/release.yaml

@@ -6,35 +6,38 @@ on:
     branches: [main]
   workflow_dispatch: # allow manual deployment through GitHub Action UI
 jobs:
-  release:
+  version-check:
     runs-on: ubuntu-latest
     if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
+    outputs:
+      changed: ${{ steps.check.outputs.any_changed }}
     steps:
       - uses: actions/checkout@v4
-      - name: Version file changed
-        id: version-file-changed
+      - name: Check if version has been updated
+        id: check
         uses: tj-actions/changed-files@v42
         with:
           files: lib/rspec_profiling/version.rb
+  release:
+    runs-on: ubuntu-latest
+    needs: version-check
+    if: ${{ github.event_name == 'workflow_dispatch' || needs.version-check.outputs.changed == 'true' }}
+    steps:
+      - uses: actions/checkout@v4
       - name: Set up Ruby
-        if: ${{ github.event_name == 'workflow_dispatch' || steps.version-file-changed.outputs.any_changed == 'true' }}
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: 3.2
           bundler-cache: true
       - name: Installing dependencies
-        if: ${{ github.event_name == 'workflow_dispatch' || steps.version-file-changed.outputs.any_changed == 'true' }}
-        run: bundle check --path=vendor/bundle || bundle install --path=vendor/bundle
+        run: bundle install
       - name: Build gem file
-        if: ${{ github.event_name == 'workflow_dispatch' || steps.version-file-changed.outputs.any_changed == 'true' }}
         run: bundle exec rake build
       - uses: fac/ruby-gem-setup-credentials-action@v2
-        if: ${{ github.event_name == 'workflow_dispatch' || steps.version-file-changed.outputs.any_changed == 'true' }}
         with:
           user: ""
           key: rubygems
           token: ${{secrets.RUBY_GEMS_API_KEY}}
       - uses: fac/ruby-gem-push-action@v2
-        if: ${{ github.event_name == 'workflow_dispatch' || steps.version-file-changed.outputs.any_changed == 'true' }}
         with:
           key: rubygems

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 0.0.9
+
+* feat: Add support for ownership tagging via magic comment [#10]
+* chore: simplify release Github Action [#9]
+
+## 0.0.8
+
+* chore: add badges to README and add gemspec metadata [#6]
+* chore: setup local development [#3]
+* chore: upgrade ruby [#4]
+* chore: standardize repository for procore open-source[#2]
+
+## 0.0.7
+
+* Migrate to procore-oss/rspec_profiling repo [#1]
+
 ## 0.0.6
 
 * Create indexes for DB collectors [#26]

data/README.md

@@ -87,6 +87,18 @@ RspecProfiling.configure do |config|
 end
 ```
 
+#### Custom Ownership Tracking
+
+If the repo you are running the profiler on has many teams working on it, you can use the `magic_comment` option to specify a comment at the top of files to scan for ownership tracking.  In the example below,
+the profiler will look for `#team: <owner>` comments at the top of each file and add <owner> to the results.
+The default is `team` but can be configured to any comment you want.
+
+```Ruby
+RspecProfiling.configure do |config|
+  config.magic_comment = 'team'
+end
+```
+
 #### Custom Event Subscriptions
 
 ```Ruby
@@ -204,6 +216,7 @@ end
 - `table_name` - the database table name in which results are stored
 - `csv_path` - the directory in which CSV files are dumped
 - `collector` - collector to use
+- `magic_comment` - comment to scan top of files to enable ownership tracking (EX: `#team: tooling`)
 
 ### Usage in a script
 

data/lib/rspec_profiling/collectors/csv.rb

@@ -10,6 +10,7 @@ module RspecProfiling
         date
         file
         line_number
+        owner_tag
         description
         status
         exception

data/lib/rspec_profiling/collectors/json.rb

@@ -8,6 +8,7 @@ module RspecProfiling
         date
         file
         line_number
+        owner_tag
         description
         status
         exception

data/lib/rspec_profiling/config.rb

@@ -9,6 +9,7 @@ module RspecProfiling
       vcs:        RspecProfiling::VCS::Git,
       table_name: 'spec_profiling_results',
       events:     [],
+      magic_comment: 'team',
       additional_data: {}
     })
   end

data/lib/rspec_profiling/example.rb

@@ -1,4 +1,9 @@
 require "benchmark"
+require "rspec_profiling/vcs/git"
+require "rspec_profiling/vcs/svn"
+require "rspec_profiling/vcs/git_svn"
+require "rspec_profiling/collectors/csv"
+require "rspec_profiling/collectors/json"
 
 module RspecProfiling
   class Example
@@ -50,6 +55,10 @@ module RspecProfiling
       execution_result.run_time
     end
 
+    def owner_tag
+      ownership_for_file(metadata[:file_path])
+    end
+
     def query_count
       counts[:query_count]
     end
@@ -112,5 +121,32 @@ module RspecProfiling
     def verbose_record_event?(event_name)
       metadata[:record_events].to_a.include?(event_name)
     end
+
+    def ownership_for_file(file_path)
+      return nil if RspecProfiling.config.magic_comment.empty?
+      ownership_regex = /(^#\s*#{RspecProfiling.config.magic_comment}:\s*)\K(?<#{RspecProfiling.config.magic_comment}>.*$)/.freeze
+      comments = top_comments_from_file(file_path)
+      matching_line = comments.detect { |line| line.match?(ownership_regex) }
+      extract_ownership(matching_line, ownership_regex) if matching_line
+    end
+
+    def top_comments_from_file(file_path)
+      with_file(file_path) do |f|
+        f.take_while { |line| line.start_with?('#', "\n") }
+      end
+    end
+
+    def with_file(file_path)
+      if File.exist?(file_path)
+        File.open(file_path)
+      else
+        puts "File not found: #{file_path}"
+        []
+      end
+    end
+
+    def extract_ownership(matching_line, regex)
+      matching_line.match(regex)[RspecProfiling.config.magic_comment.to_sym]
+    end
   end
 end

data/lib/rspec_profiling/run.rb

@@ -42,6 +42,7 @@ module RspecProfiling
         status:        @current_example.status,
         exception:     @current_example.exception,
         time:          @current_example.time,
+        owner_tag:     @current_example.owner_tag,
         query_count:   @current_example.query_count,
         query_time:    @current_example.query_time,
         request_count: @current_example.request_count,

data/lib/rspec_profiling/version.rb

@@ -1,3 +1,3 @@
 module RspecProfiling
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_profiling
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Procore Technologies, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-23 00:00:00.000000000 Z
+date: 2024-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord