Reorganize benchmark scripts

Having these in a folder helps because
we can document experiment results in it as well.

And we can edit the require script to raise an error if it takes
longer than a threshold to load faker.

Co-Authored-By: Thiago Araujo <thd.araujo@gmail.com>

Author: stefannibrasil

.github/workflows/bench.yml

@@ -0,0 +1,25 @@
+name: Bench
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Benchmarks
+    steps:
+    - uses: actions/checkout@v6
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.4'
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Generators
+      run: RUBYOPT="-W0" bundle exec ruby benchmark/generators.rb
+    - name: Require
+      run: RUBYOPT="-W0" bundle exec ruby benchmark/require.rb
+

.rubocop.yml

@@ -50,6 +50,12 @@ Naming/VariableNumber:
   Description: Use the configured style when numbering symbols, methods and variables.
   Enabled: false
 
+Security/Eval:
+  Description: The use of eval represents a serious security risk.
+  Exclude:
+    - 'lib/faker/default/json.rb'
+    - 'benchmark/generators.rb'
+
 Style/AsciiComments:
   Description: This cop checks for non-ascii (non-English) characters in comments.
   Exclude:
@@ -71,6 +77,7 @@ Style/EvalWithLocation:
   Description: This cop checks eval method usage. eval can receive source location metadata, that are filename and line number.
   Exclude:
     - 'lib/faker/default/json.rb'
+    - 'benchmark/generators.rb'
 
 Style/FormatStringToken:
   Description: This cop checks for a consistent style for named format string tokens.
@@ -102,11 +109,6 @@ Style/RegexpLiteral:
   - mixed
   AllowInnerSlashes: false
 
-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

benchmark/generators.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'benchmark/ips'
+require 'faker'
+
+def all_generators
+  generators.map do |klass|
+    subclass_methods(klass).flatten
+  end.flatten.sort
+end
+
+def generators
+  Faker.constants.delete_if do |subclass|
+    %i[
+      Base
+      Cat
+      Char
+      Base58
+      Config
+      Date
+      Deprecator
+      Dog
+      Religion
+      Time
+      VERSION
+    ].include?(subclass)
+  end.sort
+end
+
+def subclass_methods(subclass)
+  eval("Faker::#{subclass}.public_methods(false) - Faker::Base.public_methods(false)").sort.map do |method|
+    "Faker::#{subclass}.#{method}"
+  end.sort
+end
+
+Benchmark.ips do |x|
+  x.report("Number of generators: #{all_generators.count}") do
+    all_generators.each { |generator| eval(generator) }
+  end
+end

benchmark/load_yml_vs_json.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'benchmark/ips'
+require 'json'
+require 'yaml'
+
+Benchmark.ips do |x|
+  x.report('YML') { YAML.load_file(File.expand_path("#{File.dirname(__FILE__)}/../lib/locales/es-MX.yml")) }
+  x.report('JSON') { JSON.load_file("#{File.dirname(__FILE__)}/../test/fixtures/locales/es-MX.json") }
+
+  x.compare!(order: :baseline)
+end

benchmark/require.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'benchmark'
+
+ms = Benchmark.realtime do
+  require 'faker'
+end * 1000
+
+puts "took #{ms}ms to load"