rspec_profiling 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24110d7ae61d04956ff76ff9e13c088c238a5fe66218d9e1aa4ef8a62bdbd9c6
-  data.tar.gz: 44d1a03208cba2c4249cbc81b27657dc535157d8fbe7ae302e618645732aebb5
+  metadata.gz: 26ca0174bdfbc6586d2c6f570089eb5e54593111d879cb93fd97a0575233e3d5
+  data.tar.gz: 1c53782f71972337e7f6d4158cbfe261aa9a37a104b56e558dc950b3828cc3f4
 SHA512:
-  metadata.gz: 3ad4f846af0ec602a4f8211f7f53f4358764e8aeed1e558dd46a3e8b8f70db66e02d53aa1242fb0715eb596c08c302d0d9cf23c499cf45246ae55f9f37e38c63
-  data.tar.gz: f9b030d41c7a68b511254bcdeb153a0b2dfd047928e9b38f1ffba123423dbd908d10badf0d461934c5f8e5bfc9944f0260e80558fbd8b57f51d800ef9e986506
+  metadata.gz: 9a00ddc9c3750e5be40a987ea8ee988d8352cdafa08a8f5381b1792c72632a7683e3d003a691341672d5f8ef7cd75b0f830eba8c2e5806fdf83f6d47e7d19f9e
+  data.tar.gz: 240b4aea885e635c0c493237e2d7a67a1e3c22653b79217d598527641a1bb8586cfdf618c82d39874a98a76b41e2ea777ca1de5911510b782a5dc6129174b76c

data/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @procore-oss/procore-ospo @procore-oss/procore-rspec-profiling

data/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,66 @@
+name: 🐞 Bug
+description: File a bug/issue
+title: "[bug] <title>"
+labels: [bug, needs-triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: checkboxes
+  attributes:
+    label: Is this a regression?
+    description: Did this behavior work before?
+    options:
+    - label: Yes, this used to work before
+      required: false
+- type: textarea
+  attributes:
+    label: Current Behavior
+    description: A concise description of what you're experiencing.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Expected Behavior
+    description: A concise description of what you expected to happen.
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Steps To Reproduce
+    description: Steps to reproduce the behavior.
+    placeholder: |
+      1.
+      2.
+      3.
+      4.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Environment
+    description: |
+      examples:
+        - **OS**: OSX 13.3.1
+        - **Browser Name and Version**: Chrome Version 112.0.5615.49 (Official Build) (arm64)
+        - **Ruby Version**: 3.0.0
+    value: |
+        - OS:
+        - Browser Name and version:
+        - Ruby Version:
+    render: markdown
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Anything else?
+    description: |
+      Links? References? Anything that will give us more context about the issue you are encountering!
+
+      Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+  validations:
+    required: false

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

data/.github/ISSUE_TEMPLATE/docs.yml

@@ -0,0 +1,18 @@
+name: 📚 Documentation or README.md issue report
+description: File a bug/issue for docs or README.md
+title: "[bug] <title>"
+labels: [docs, needs-triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Docs/README.md Part to update
+    description: A concise description of what you thing should be updated
+  validations:
+    required: true

data/.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,36 @@
+name: 🚀🆕 Feature Request
+description: Suggest an idea or possible new feature for this project
+title: "[Feature Request] <title>"
+labels: [feature, needs-triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Is your feature request related to a problem? Please describe
+    description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe the feature you'd like to see implemented
+    description: A clear and concise description of what you want to happen
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Describe alternatives you've considered
+    description: A clear and concise description of any alternative solutions or features you've considered
+  validations:
+    required: false
+- type: textarea
+  attributes:
+    label: Additional context
+    description: Add any other context or additional information about the problem here
+  validations:
+    required: false

data/.github/ISSUE_TEMPLATE/question-support.yml

@@ -0,0 +1,18 @@
+name: ❓ Question or Support Request
+description: Questions and requests for support
+title: "[Question/Support] <title>"
+labels: [question, support, needs-triage]
+body:
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this?
+    description: Please search to see if an issue already exists for the bug you encountered.
+    options:
+    - label: I have searched the existing issues
+      required: true
+- type: textarea
+  attributes:
+    label: Describe your question or ask for support
+    description: A concise description of what you would like support with
+  validations:
+    required: true

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,17 @@
+Checklist:
+
+* [ ] I have updated the necessary documentation
+* [ ] I have signed off all my commits as required by [DCO](https://github.com/procore-oss/rspec_profiling/blob/main/CONTRIBUTING.md)
+* [ ] My build is green
+
+<!--
+Note on DCO:
+
+If the DCO check fails, one or more of your commits are not signed off. Please click on the *Details* link next to the DCO action for instructions on how to resolve this.
+
+TL;DR - You need to sign off your commits with `git commit -s` or `git commit --signoff` to indicate that you agree to the terms of the DCO.
+
+Note on Versioning:
+
+Maintainers will bump the version and do a release when they are ready to release (possibly multiple merged PRs). Please do not bump the version in your PRs.
+-->

data/.github/dependabot.yaml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: /
+    schedule:
+      interval: "weekly"
+      timezone: "America/Los_Angeles"
+    labels:
+      - "dependabot"
+      - "dependencies"
+      - "github-actions"
+  - package-ecosystem: "bundler"
+    directory: /
+    schedule:
+      interval: "weekly"
+      timezone: "America/Los_Angeles"
+    labels:
+      - "dependabot"
+      - "dependencies"
+      - "bundler"

data/.github/workflows/auto-assign-author.yaml

@@ -0,0 +1,13 @@
+name: 'Auto Author Assign'
+
+on:
+  pull_request_target:
+    types: [opened, reopened]
+
+jobs:
+  assign-author:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: toshimaru/auto-author-assign@v2.1.0
+        with:
+          repo-token: "${{ secrets.GITHUB_TOKEN }}"

data/.github/workflows/codeql.yaml

@@ -0,0 +1,43 @@
+name: "Custom CodeQL"
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: Ubuntu-latest
+    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v3
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

data/.github/workflows/release.yaml

@@ -0,0 +1,40 @@
+name: Release
+on:
+  workflow_run:
+    workflows: [Test]
+    types: [completed]
+    branches: [main]
+  workflow_dispatch: # allow manual deployment through GitHub Action UI
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Version file changed
+        id: version-file-changed
+        uses: tj-actions/changed-files@v42
+        with:
+          files: lib/rspec_profiling/version.rb
+      - 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
+      - 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/.github/workflows/stale.yaml

@@ -0,0 +1,38 @@
+## Reference: https://github.com/actions/stale
+name: Mark stale issues and pull requests
+on:
+  schedule:
+  - cron: "30 1 * * *"
+
+permissions:
+  contents: read
+
+jobs:
+  stale:
+    permissions:
+      issues: write  # for actions/stale to close stale issues
+      pull-requests: write  # for actions/stale to close stale PRs
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/stale@v9
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        # Number of days of inactivity before an issue becomes stale
+        days-before-stale: 60
+        # Number of days of inactivity before a stale issue is closed
+        days-before-close: 7
+        # Issues with these labels will never be considered stale
+        exempt-issue-labels: "on-hold,pinned,security"
+        exempt-pr-labels: "on-hold,pinned,security"
+        # Comment to post when marking an issue as stale.
+        stale-issue-message: >
+          This issue has been automatically marked as stale because it has not had
+          recent activity. It will be closed if no further activity occurs. Thank you
+          for your contributions.
+        stale-pr-message: >
+          This pull request has been automatically marked as stale because it has not had
+          recent activity. It will be closed if no further activity occurs. Thank you
+          for your contributions.
+        # Label to use when marking an issue as stale
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'

data/.github/workflows/test.yaml

@@ -0,0 +1,54 @@
+name: Test
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+permissions:
+  contents: read
+jobs:
+  test:
+    env:
+      ENVIRONMENT: test
+      PGDATABASE: rspec_profiling_test
+      PGHOST: localhost
+      PGPASSWORD: mypassword
+      PGUSER: myuser
+      SPEC_GEMFILE: spec/Gemfile
+    strategy:
+      matrix:
+        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3']
+        postgres: ['16-bookworm', '15-bookworm', '14-bookworm', '13-bookworm', '12-bookworm']
+    name: Ruby ${{ matrix.ruby }} - PostgreSQL ${{ matrix.postgres }}
+    # https://docs.github.com/en/actions/learn-github-actions/expressions#example
+    runs-on: ${{ matrix.ruby == '2.7' && 'ubuntu-20.04' || 'ubuntu-latest' }}
+    services:
+      postgres:
+        image: postgres:${{ matrix.postgres }}
+        env:
+          POSTGRES_HOST: ${{ env.PGHOST }}
+          POSTGRES_DB: ${{ env.PGDATABASE}}
+          POSTGRES_HOST_AUTH_METHOD: trust
+          POSTGRES_USER: ${{ env.PGUSER }}
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Installing dependencies
+        run: bundle install --gemfile ${{ env.SPEC_GEMFILE }} && cd spec/dummy && bundle install
+      - name: Setup Database in Dummy Rails App
+        run: cd spec/dummy && bundle exec rake db:create db:migrate --trace RAILS_ENV=${{ env.ENVIRONMENT }}
+      - name: Initialize rspec_profiling in Dummy Rails App
+        run: cd spec/dummy && bundle exec rake rspec_profiling:install RAILS_ENV=${{ env.ENVIRONMENT }}
+      - name: Run specs
+        run: bundle exec --gemfile ${{ env.SPEC_GEMFILE }} rspec

data/.gitignore

@@ -2,6 +2,8 @@
 *.rbc
 .bundle
 .config
+.env
+.ruby-gemset
 .yardoc
 Gemfile.lock
 InstalledFiles
@@ -11,6 +13,7 @@ doc/
 lib/bundler/man
 pkg
 rdoc
+rspec_profiling
 spec/reports
 test/tmp
 test/version_tmp

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.1
+ruby-3.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,130 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Spam or other deceptive practices that take advantage of the community
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<opensource@procore.com>.
+All complaints will be reviewed and investigated promptly and fairly by
+the Procore Open Source Program Office (OSPO)
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

data/CONTRIBUTING.md

@@ -0,0 +1,37 @@
+# Contributing to Procore Projects
+
+This document explains the common procedures expected by contributors while submitting code to Procore open source projects.
+
+## Code of Conduct
+
+Please read and abide by the [Code of Conduct](CODE_OF_CONDUCT.md)
+
+## General workflow
+
+Once a GitHub issue is accepted and assigned to you, please follow general workflow in order to submit your contribution:
+
+1. Fork the target repository under your GitHub username.
+2. Create a branch in your forked repository for the changes you are about to make.
+3. Commit your changes in the branch you created in step 2. All commits need to be signed-off. Check the [legal](#legal) section bellow for more details.
+4. Push your commits to your remote fork.
+5. Create a Pull Request from your remote fork pointing to the HEAD branch (usually `main` branch) of the target repository.
+6. Check the GitHub build and ensure that all checks are green.
+
+## Legal
+
+Procore projects use Developer Certificate of Origin ([DCO](https://GitHub.com/apps/dco/)).
+
+Please sign-off your contributions by doing ONE of the following:
+
+* Use `git commit -s ...` with each commit to add the sign-off or
+* Manually add a `Signed-off-by: Your Name <your.email@example.com>` to each commit message.
+
+The email address must match your primary GitHub email. You do NOT need cryptographic (e.g. gpg) signing.
+
+* Use `git commit -s --amend ...` to add a sign-off to the latest commit, if you forgot.
+
+*Note*: Some projects will provide specific configuration to ensure all commits are signed-off. Please check the project's documentation for more details.
+
+## Tests
+
+Make sure your changes are properly covered by automated tests. We aim to build an efficient test suite that is low cost to maintain and bring value to project. Prefer writing unit-tests over heavy end-to-end (e2e) tests. However, sometimes e2e tests are necessary. If you aren't sure, ask one of the maintainers about the requirements for your pull-request.

data/EMERITUS.md

@@ -0,0 +1,3 @@
+This repo is a fork of <https://github.com/foraker/rspec_profiling>.
+
+[Former contributors](https://github.com/foraker/rspec_profiling/graphs/contributors)

data/{LICENSE.txt → LICENSE.md}

@@ -1,4 +1,5 @@
-Copyright (c) 2014 Ben Eddy
+Copyright (c) 2014-2024 Ben Eddy
+Copyright (c) 2024 Procore Technologies, Inc.
 
 MIT License
 

data/Makefile

@@ -0,0 +1,60 @@
+# -e says exit immediately when a command fails
+# -o sets pipefail, meaning if it exits with a failing command, the exit code should be of the failing command
+# -u fails a bash script immediately if a variable is unset
+ENVIRONMENT := test
+PGHOST := localhost
+PGPORT := 5432
+PGUSER := myuser
+PGPASSWORD := mypassword
+SHELL = /bin/bash -eu -o pipefail
+
+define is_installed
+if ! command -v $(1) &> /dev/null; \
+then \
+	echo "$(1) not installed, please install it. 'brew install $(1)'"; \
+	exit; \
+fi;
+endef
+
+.PHONY : help
+help : # Display help
+	@awk -F ':|##' \
+		'/^[^\t].+?:.*?##/ {\
+			printf "\033[36m%-30s\033[0m %s\n", $$1, $$NF \
+		}' $(MAKEFILE_LIST)
+
+.PHONY : ruby_installed
+ruby_installed: ## check if ruby is installed
+	@$(call is_installed,ruby)
+
+.PHONY : bundle
+bundle: ruby_installed ## install gems
+	@bundle install --gemfile spec/Gemfile && cd spec/dummy && bundle install
+
+.PHONY : setup_db
+setup_db: ruby_installed postgres ## setup database
+	@echo "setting up database"
+	@cd spec/dummy && bundle exec rake db:create db:migrate --trace RAILS_ENV=${ENVIRONMENT}
+
+.PHONY : initialize_profiling
+initialize_profiling: ruby_installed ## initialize rspec_profiling
+	@echo "initializing rspec_profiling"
+	@cd spec/dummy && bundle exec rake rspec_profiling:install RAILS_ENV=${ENVIRONMENT}
+
+.PHONY : spec
+spec : bundle setup_db initialize_profiling ## run specs
+	@echo "running specs"
+	@bundle exec --gemfile=spec/dummy/Gemfile rspec
+
+.PHONY : test
+test: spec ## run specs
+	@echo "running specs"
+
+.PHONY : docker_installed
+docker_installed: ## check if docker and docker-compose are installed
+	@$(call is_installed,docker)
+	@$(call is_installed,docker-compose)
+
+.PHONY : postgres
+postgres: docker_installed ## start postgres in docker container
+	@docker-compose up -d || true