Merge branch 'faker-ruby:main' into master

Author: tim-heighes-fishbrain

.github/ISSUE_TEMPLATE/bug-report.md

@@ -2,7 +2,7 @@
 name: Bug Report
 about: Create a bug report
 title: "Issue title goes here"
-labels: needs-triage
+labels: "🐞 Issue: Bug"
 assignees: ''
 
 ---
@@ -11,10 +11,39 @@ assignees: ''
 A clear and concise description of what the bug is.
 
 ## To Reproduce
-Describe the steps to reproduce the behavior.
+Describe a way to reproduce your bug. To get the Faker version, run `Faker::VERSION`.
+
+Use the reproduction script below to reproduce the issue:
+
+```
+# frozen_string_literal: true
+
+require "bundler/inline"
+
+gemfile(true) do
+  source "https://rubygems.org"
+
+  git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+  gem 'faker', :git => 'https://github.com/faker-ruby/faker.git', :branch => 'main'
+  gem "minitest"
+end
+
+require "minitest/autorun"
+
+class BugTest < Minitest::Test
+  def test_faker
+    # CHANGEME - Reproduce the issue here. Here's an example:
+    @tester = Faker::TvShows::SiliconValley
+    refute_empty @tester.company
+    assert @tester.company == "Intersite"
+  end
+end
+
+```
 
 ## Expected behavior
 A clear and concise description of what you expected to happen.
 
 ## Additional context
-Add any other context about the problem here.
+Add any other additional information about the problem here.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -1,14 +1,48 @@
-Issue# 
-------
+<!--
+Thanks for contributing to faker-ruby!
 
-Example:
+Please do not make *Draft* pull requests, as they still send
+notifications to everyone watching the faker-ruby repo.
 
-https://github.com/faker-ruby/faker/issues/XXX
+Create a pull request when it is ready for review and feedback
+from the faker-ruby team :).
 
-OR
+If your pull request affects documentation or any non-code
+changes, guidelines for those changes are [available
+here](https://github.com/faker-ruby/faker/blob/main/CONTRIBUTING.md#documentation).
 
-`No-Story`
+About this template
 
-Description:
-------
-*Describe what this PR does in a few lines. If you are adding a new faker generator, please tell us how you're going to use this object. Use cases are important because we need to make sure that our faker generators are useful. After adding the description, please delete this line.*
+The following template aims to help contributors write a good description for their pull requests.
+We'd like you to provide a description of the changes in your pull request (i.e. bugs fixed or features added), motivation behind the changes, and complete the checklist below before opening a pull request.
+
+Feel free to discard it if you need to (e.g. when you just fix a typo). -->
+
+### Motivation / Background
+
+<!--
+Describe why this Pull Request needs to be merged. What bug have you fixed? Why is it important?
+If you are fixing a specific issue, include "Fixes #ISSUE" (replace with the issue number, remove the quotes) and the issue will be linked to this PR.
+
+If you're proposing a new generator or locale, please review and follow the [Contributing guidelines](https://github.com/faker-ruby/faker/blob/main/CONTRIBUTING.md) first.
+-->
+
+This Pull Request has been created because [REPLACE ME].
+
+### Additional information
+
+<!-- Provide additional information such as benchmarks, reference to other repositories or alternative solutions. -->
+
+### Checklist
+
+Before submitting the PR make sure the following are checked:
+
+* [ ] This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
+* [ ] Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: `[Fix #issue-number]`
+* [ ] Tests are added or updated if you fix a bug, refactor something, or add a feature.
+* [ ] Tests and Rubocop are passing before submitting your proposed changes.
+
+If you're proposing a new generator or locale:
+
+* [ ] Double-check the existing generators documentation to make sure the new generator you want to add doesn't already exist.
+* [ ] You've reviewed and followed the [Contributing guidelines](https://github.com/faker-ruby/faker/blob/main/CONTRIBUTING.md).

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  

.github/dependabot.yml

@@ -0,0 +1,55 @@
+name: "CodeQL"
+
+on:
+  schedule:
+    - cron: '56 11 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: [ubuntu-latest]
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/codeql.yml

@@ -0,0 +1,33 @@
+name: Push Gem
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  push:
+    if: github.repository == 'faker-ruby/faker'
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      # Set up
+      - name: Harden Runner
+        uses: step-security/harden-runner@a4aa98b93cab29d9b1101a6143fb8bce00e2eac4 # v2.7.1
+        with:
+          egress-policy: audit
+
+      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@cacc9f1c0b3f4eb8a16a6bb0ed10897b43b9de49 # v1.176.0
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      # Release
+      - uses: rubygems/release-gem@612653d273a73bdae1df8453e090060bb4db5f31 # v1

.github/workflows/push_gem.yml

@@ -9,60 +9,64 @@ name: Tests
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
+
+permissions:
+  contents: read
 
 jobs:
   lint:
-    name: Rubocop
+    name: RuboCop
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.7'
 
       - name: Install dependencies
         run: bundle install
 
-      - name: Run Rubocop
+      - name: Run RuboCop
         run: bundle exec rake rubocop
-  test: 
+  test:
     name: Ruby ${{ matrix.ruby }}
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false # don't fail all matrix builds if one fails
       matrix:
         ruby:
-          - '2.5' 
-          - '2.6' 
           - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
           - 'head'
           - truffleruby-head
     continue-on-error: ${{ endsWith(matrix.ruby, 'head') }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
 
     - name: Install dependencies
       run: bundle install
-    
+
     - name: Setup Code Climate test-reporter
       run: |
         curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
         chmod +x ./cc-test-reporter
         ./cc-test-reporter before-build
-    
+
     - name: Run tests
       run: bundle exec rake test
 
     - name: Publish code coverage
       env:
         CC_TEST_REPORTER_ID: c9b8356df2031a5a72462555fe898245cf24d83c7bb82c40ddb5c6c6976c4319
-        # CC_TEST_REPORTER_ID:  ${{ secrets.CodeClimateReporterId }}
       run: |
         export GIT_BRANCH="${GITHUB_REF/refs\/heads\//}"
         ./cc-test-reporter after-build -r $CC_TEST_REPORTER_ID

.github/workflows/ruby.yml

@@ -1,5 +1,15 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+# Suppress noise for obvious operator precedence.
+Lint/AmbiguousOperatorPrecedence:
+  Description: Checks for expressions containing multiple binary operations with ambiguous precedence.
+  Enabled: false
 
 Layout/LineLength:
   Description: This cop checks the length of lines in the source code. The maximum length is configurable.
@@ -36,6 +46,10 @@ Metrics/PerceivedComplexity:
   Enabled: false
   Max: 7
 
+Naming/VariableNumber:
+  Description: Use the configured style when numbering symbols, methods and variables.
+  Enabled: false
+
 Style/AsciiComments:
   Description: This cop checks for non-ascii (non-English) characters in comments.
   Exclude:
@@ -49,6 +63,10 @@ Style/Documentation:
   Description: This cop checks for missing top-level documentation of classes and modules.
   Enabled: false
 
+Style/DocumentDynamicEvalDefinition:
+  Description: When using `class_eval` (or other `eval`) with string interpolation, add a comment block showing its appearance if interpolated.
+  Enabled: false
+
 Style/EvalWithLocation:
   Description: This cop checks eval method usage. eval can receive source location metadata, that are filename and line number.
   Exclude:
@@ -91,3 +109,7 @@ Security/Eval:
   Description: The use of eval represents a serious security risk.
   Exclude:
     - 'lib/faker/default/json.rb'
+
+Style/IfUnlessModifier:
+  Description: Checks for `if` and `unless` statements that would fit on one line if written as modifier `if`/`unless`. The cop also checks for modifier `if`/`unless` lines that exceed the maximum line length.
+  Enabled: false