factory_bot_instrumentation 0.5.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98a7a69daca8d49bb11b7145e050b3625c5f5638cc961fc3e91377300890c1db
-  data.tar.gz: ed9d4f5a254eb60cb0241fffbc32a43cfcd6ff2a44ddd476fc299286a37b488b
+  metadata.gz: 591ceeab89063ef4a72423185561164932e60b2e7412a4bfa0faa6049988d616
+  data.tar.gz: bdabce3cd1a9b292cae4a3d163511debe37379a3909daee6165e6ceba8a7c555
 SHA512:
-  metadata.gz: 6df53693fc478ac1ef3895d086efb6b86c7654b16a392fc6c7daa828e36918e1a67706bbc7c00a2f219394b092d9fa8f99bd608c57894e16d81274bb5e5e8bbc
-  data.tar.gz: d12ec3b074a2b0c1f7a33ea9725d13d28a4095d01e36d68727b057869d9904a3ea9052ad7247221197f2c1d5087e27be29509a71443b34d7edd8da0c7d254267
+  metadata.gz: 1ca3413bc194f5fd0036a93041e92b5f0e46aebf2f13cd4e6a938faa866b08d06d8cc20d62c8a6d5154035bd0233f654d9d96769bdda257c193b5a55caacb919
+  data.tar.gz: 19eeee8a75a6b7b189ffc650f9e7b604f444eaeb91695122371bbc0995d5cbec5ac7641f845ff98d6b393ed48e0f76eb6e22cbcc76bc0e8939a247139b3c03c9

data/.github/workflows/documentation.yml

@@ -0,0 +1,38 @@
+name: Build Documentation
+on:
+  repository_dispatch:
+    types: [documentation]
+
+concurrency:
+  group: 'docs'
+
+jobs:
+  docs:
+    name: Build gem documentation
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Build gem documentation
+        run: make docs
+
+      - name: Upload the code coverage report
+        run: coverage
+
+      - name: Add this job to the commit status
+        run: commit-status '${{ job.status }}'
+        if: always()

data/.github/workflows/test.yml

@@ -0,0 +1,62 @@
+name: Test
+on:
+  push:
+    branches:
+      - '**'
+  schedule:
+    - cron: '0 0 * * MON'
+
+concurrency:
+  group: '${{ github.ref }}'
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: 'Test the gem (Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }})'
+    runs-on: ubuntu-20.04
+    timeout-minutes: 5
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.4, 2.5, 2.6]
+        rails: ['5.0', 5.1, 5.2]
+    env:
+      BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install the correct Ruby version
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Run the gem tests
+        run: make test
+
+      - name: Upload the code coverage report
+        run: coverage
+
+  trigger-docs:
+    name: Trigger the documentation upload
+    runs-on: ubuntu-20.04
+    timeout-minutes: 2
+    needs: test
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/noop
+
+      - name: Trigger the documentation upload
+        run: workflow documentation

data/.rubocop.yml

@@ -8,23 +8,21 @@ Documentation:
 
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   Exclude:
-    - db/schema.rb
     - bin/**/*
-    - db/migrate/**/*
-    - vendor/cache/**/*
-    - vendor/bundle/**/*
+    - vendor/**/*
     - build/**/*
+    - gemfiles/**/*
+    - spec/dummy/**/*
 
 Metrics/BlockLength:
   Exclude:
-    # Because of the Grape DSL
-    - lib/**/*.rb
     - Rakefile
-    - hausgold-sdk.gemspec
+    - '*.gemspec'
     - spec/**/*.rb
     - '**/*.rake'
+    - doc/**/*.rb
 
 # Document all the things.
 Style/DocumentationMethod:
@@ -41,3 +39,16 @@ Lint/AmbiguousBlockAssociation:
 # supported with the +with(hash_including)+ matchers
 RSpec/MessageSpies:
   EnforcedStyle: receive
+
+# Because nesting makes sense here to group the feature tests
+# more effective. This increases maintainability.
+RSpec/NestedGroups:
+  Max: 4
+
+# Disable regular Rails spec paths.
+RSpec/FilePath:
+  Enabled: false
+
+# Because we just implemented the ActiveRecord API.
+Rails/SkipsModelValidations:
+  Enabled: false

data/.yardopts

@@ -0,0 +1,6 @@
+--output-dir=doc/api
+--plugin activesupport-concern
+--markup=rdoc
+-
+README.md
+lib/**/*.rb

data/Appraisals

@@ -1,7 +1,4 @@
-appraise 'rails-4' do
-  gem 'rails', '~> 4.2.11'
-  gem 'rails-api', '~> 0.4.1'
-end
+# frozen_string_literal: true
 
 appraise 'rails-5.0' do
   gem 'rails', '~> 5.0.7'

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 0.7.1
+
+* Migrated to Github Actions
+* Migrated to our own coverage reporting
+
+### 0.7.0
+
+* Dropped Rails 4 support
+
+### 0.6.0
+
+* Added support for custom error handling and improved the default error
+  handling on FactoryBot usage (#9)
+
+### 0.5.1
+
+* Corrected a bug on the scenario description update (#8)
+
 ### 0.5.0
 
 * Added support for custom before action logics (#7)

data/Makefile

@@ -25,6 +25,8 @@ RM ?= rm
 BUNDLE ?= bundle
 APPRAISAL ?= appraisal
 RAKE ?= rake
+RUBOCOP ?= rubocop
+YARD ?= yard
 
 # Files
 GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
@@ -53,6 +55,11 @@ all:
 	# test               Run the whole test suite
 	# clean              Clean the dependencies
 	#
+	# docs               Generate the Ruby documentation of the library
+	# stats              Print the code statistics (library and test suite)
+	# notes              Print all the notes from the code
+	# release            Release a new Gem version (maintainers only)
+	#
 	# shell              Run an interactive shell on the container
 	# shell-irb          Run an interactive IRB shell on the container
 
@@ -62,15 +69,26 @@ install:
 	@$(call run-shell,$(BUNDLE) check || $(BUNDLE) install --path $(VENDOR_DIR))
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) install)
 
-test: install
+test: \
+	test-specs \
+	test-style
+
+test-specs:
 	# Run the whole test suite
-	@$(call run-shell,$(BUNDLE) exec $(RAKE))
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats spec)
 
 $(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
 $(TEST_GEMFILES):
 	# Run the whole test suite ($(GEMFILE))
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RAKE))
 
+test-style: \
+	test-style-ruby
+
+test-style-ruby:
+	# Run the static code analyzer (rubocop)
+	@$(call run-shell,$(BUNDLE) exec $(RUBOCOP) -a)
+
 clean:
 	# Clean the dependencies
 	@$(RM) -rf $(VENDOR_DIR)
@@ -83,14 +101,27 @@ endif
 
 distclean: clean clean-containers
 
-shell: install
+shell:
 	# Run an interactive shell on the container
 	@$(call run-shell,$(BASH) -i)
 
-shell-irb: install
+shell-irb:
 	# Run an interactive IRB shell on the container
 	@$(call run-shell,bin/console)
 
+docs:
+	# Build the API documentation
+	@$(call run-shell,$(BUNDLE) exec $(YARD) -q && \
+		$(BUNDLE) exec $(YARD) stats --list-undoc --compact)
+
+notes:
+	# Print the code statistics (library and test suite)
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) notes)
+
+stats:
+	# Print all the notes from the code
+	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats)
+
 release:
 	# Release a new gem version
 	@$(BUNDLE) exec $(RAKE) release

data/README.md

@@ -1,10 +1,10 @@
 ![factory_bot_instrumentation](doc/assets/project.svg)
 
-[![Build Status](https://travis-ci.com/hausgold/factory_bot_instrumentation.svg?token=4XcyqxxmkyBSSV3wWRt7&branch=master)](https://travis-ci.com/hausgold/factory_bot_instrumentation)
+[![Continuous Integration](https://github.com/hausgold/factory_bot_instrumentation/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/hausgold/factory_bot_instrumentation/actions/workflows/test.yml)
 [![Gem Version](https://badge.fury.io/rb/factory_bot_instrumentation.svg)](https://badge.fury.io/rb/factory_bot_instrumentation)
-[![Maintainability](https://api.codeclimate.com/v1/badges/bcf9d9c56e55f4d79747/maintainability)](https://codeclimate.com/repos/5c35e98c8e9b03333000021e/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/bcf9d9c56e55f4d79747/test_coverage)](https://codeclimate.com/repos/5c35e98c8e9b03333000021e/test_coverage)
-[![API docs](https://img.shields.io/badge/docs-API-blue.svg)](https://www.rubydoc.info/gems/factory_bot_instrumentation)
+[![Test Coverage](https://automate-api.hausgold.de/v1/coverage_reports/factory_bot_instrumentation/coverage.svg)](https://knowledge.hausgold.de/coverage)
+[![Test Ratio](https://automate-api.hausgold.de/v1/coverage_reports/factory_bot_instrumentation/ratio.svg)](https://knowledge.hausgold.de/coverage)
+[![API docs](https://automate-api.hausgold.de/v1/coverage_reports/factory_bot_instrumentation/documentation.svg)](https://www.rubydoc.info/gems/factory_bot_instrumentation)
 
 This project is dedicated to provide an API and frontend to
 [factory_bot](https://github.com/thoughtbot/factory_bot) factories to generate
@@ -48,14 +48,6 @@ Add this line to your application's Gemfile:
 gem 'factory_bot_instrumentation'
 ```
 
-**Heads up!** In case you use Rails 4.2, you need to add the
-[rails-api](https://github.com/rails-api/rails-api) gem as well, because this
-feature was first introduced with Rails 5.0.
-
-```ruby
-gem 'rails-api'
-```
-
 And then execute:
 
 ```bash
@@ -316,6 +308,18 @@ FactoryBot::Instrumentation.configure do |conf|
     controller.render plain: entity.to_json,
                       content_type: 'application/json'
   end
+  # By default we assemble a JSON response on errors which may be
+  # helpful for debugging, but you can configure your own logic here
+  conf.render_error = proc do |controller, error|
+    app_name = FactoryBot::Instrumentation.configuration.application_name
+    controller.render status: :internal_server_error,
+                      content_type: 'application/json',
+                      plain: {
+                        application: app_name,
+                        error: error.message,
+                        backtrace: error.backtrace.join("\n")
+                      }.to_json
+  end
   # By default we do not perform any custom +before_action+ filters on the
   # instrumentation controllers, with this option you can implement your
   # custom logic like authentication

data/Rakefile

@@ -7,20 +7,86 @@ ENV['DISABLE_DATABASE_ENVIRONMENT_CHECK'] = '1'
 require 'bundler/setup'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rails/code_statistics'
+require 'pp'
 
-APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
 
-Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each { |f| load f }
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
 
 desc 'Run all specs in spec directory (excluding plugin specs)'
 RSpec::Core::RakeTask.new(spec: [
-  'db:drop', 'db:create', 'db:migrate', 'db:setup'
-])
+                            'db:drop', 'db:create', 'db:migrate', 'db:setup'
+                          ])
 
 task default: :spec
+
+# Load some railties tasks
+load 'rails/tasks/statistics.rake'
+load 'rails/tasks/annotations.rake'
+
+# Clear the default statistics directory constant
+#
+# rubocop:disable Style/MutableConstant because we define it
+Object.send(:remove_const, :STATS_DIRECTORIES)
+::STATS_DIRECTORIES = []
+# rubocop:enable Style/MutableConstant
+
+# Monkey patch the Rails +CodeStatistics+ class to support configurable
+# patterns per path. This is reuqired to support top-level only file matches.
+class CodeStatistics
+  DEFAULT_PATTERN = /^(?!\.).*?\.(rb|js|coffee|rake)$/.freeze
+
+  # Pass the possible +pattern+ argument down to the
+  # +calculate_directory_statistics+ method call.
+  def calculate_statistics
+    Hash[@pairs.map do |pair|
+      [pair.first, calculate_directory_statistics(*pair[1..-1])]
+    end]
+  end
+
+  # Match the pattern against the individual file name and the relative file
+  # path. This allows top-level only matches.
+  def calculate_directory_statistics(directory, pattern = DEFAULT_PATTERN)
+    stats = CodeStatisticsCalculator.new
+
+    Dir.foreach(directory) do |file_name|
+      path = "#{directory}/#{file_name}"
+
+      if File.directory?(path) && (/^\./ !~ file_name)
+        stats.add(calculate_directory_statistics(path, pattern))
+      elsif file_name =~ pattern || path =~ pattern
+        stats.add_by_file_path(path)
+      end
+    end
+
+    stats
+  end
+end
+
+# Configure all code statistics directories
+vendors = [
+  [:unshift, 'Top-levels', 'lib'],
+  [:unshift, 'Top-levels specs', 'spec', %r{spec/[^/]+_spec\.rb$}],
+  [:unshift, 'Javascript', 'app/assets'],
+  [:unshift, 'Controllers', 'app/controllers'],
+  [:unshift, 'Controllers specs', 'spec/controllers']
+].reverse
+
+vendors.each do |method, type, dir, pattern|
+  ::STATS_DIRECTORIES.send(method, [type, dir, pattern].compact)
+  ::CodeStatistics::TEST_TYPES << type if type.include? 'specs'
+end
+
+# Setup annotations
+ENV['SOURCE_ANNOTATION_DIRECTORIES'] = 'spec,doc'
+desc 'Enumerate all annotations'
+task :notes do
+  SourceAnnotationExtractor.enumerate '@?OPTIMIZE|@?FIXME|@?TODO', tag: true
+end

data/app/assets/javascripts/factory_bot_instrumentation/create.js

@@ -101,7 +101,7 @@ CreateForm.prototype.bind = function()
     this.submit();
   });
 
-  this.select.on('change', this.updateDesc);
+  this.select.on('change', this.updateDesc.bind(this));
   this.updateDesc();
 };
 

data/app/controllers/factory_bot/instrumentation/application_controller.rb

@@ -1,34 +1,40 @@
 # frozen_string_literal: true
 
-module FactoryBot::Instrumentation
-  # A base engine application controller.
-  class ApplicationController < ActionController::API
-    # Extend our core functionality to support easy authentication logics
-    include ActionController::HttpAuthentication::Basic::ControllerMethods
-    include ActionController::HttpAuthentication::Digest::ControllerMethods
-    include ActionController::HttpAuthentication::Token::ControllerMethods
+module FactoryBot
+  module Instrumentation
+    # A base engine application controller.
+    class ApplicationController < ActionController::API
+      # Extend our core functionality to support easy authentication logics
+      include ActionController::HttpAuthentication::Basic::ControllerMethods
+      include ActionController::HttpAuthentication::Digest::ControllerMethods
+      include ActionController::HttpAuthentication::Token::ControllerMethods
 
-    # Allow the users to implement additional instrumentation-wide before
-    # action logic, like authentication
-    before_action do |controller|
-      if FactoryBot::Instrumentation.configuration.before_action
-        instance_eval &FactoryBot::Instrumentation.configuration.before_action
+      # Allow the users to implement additional instrumentation-wide before
+      # action logic, like authentication
+      before_action do |_controller|
+        if FactoryBot::Instrumentation.configuration.before_action
+          instance_eval(
+            &FactoryBot::Instrumentation.configuration.before_action
+          )
+        end
       end
-    end
 
-    protected
+      protected
 
-    # A simple shortcut for Basic Auth on Rails 4.2+. Just configure the
-    # username and password and you're ready to check the current request.
-    #
-    # @param username [String] the required user name
-    # @param password [String] the required password of the user
-    # @param realm [String] the authentication realm
-    def basic_auth(username:, password:, realm: 'Instrumentation')
-      authenticate_or_request_with_http_basic(realm) \
-        do |given_name, given_password|
-        ActiveSupport::SecurityUtils.secure_compare(given_name, username) &
-          ActiveSupport::SecurityUtils.secure_compare(given_password, password)
+      # A simple shortcut for Basic Auth on Rails 4.2+. Just configure the
+      # username and password and you're ready to check the current request.
+      #
+      # @param username [String] the required user name
+      # @param password [String] the required password of the user
+      # @param realm [String] the authentication realm
+      def basic_auth(username:, password:, realm: 'Instrumentation')
+        authenticate_or_request_with_http_basic(realm) \
+          do |given_name, given_password|
+          ActiveSupport::SecurityUtils.secure_compare(given_name, username) &
+            ActiveSupport::SecurityUtils.secure_compare(
+              given_password, password
+            )
+        end
       end
     end
   end

data/app/controllers/factory_bot/instrumentation/root_controller.rb

@@ -1,119 +1,131 @@
 # frozen_string_literal: true
 
-module FactoryBot::Instrumentation
-  # The Instrumentation engine controller with frontend and API actions.
-  class RootController < ApplicationController
-    # This is required to make API controllers template renderable
-    include ActionView::Layouts
+module FactoryBot
+  module Instrumentation
+    # The Instrumentation engine controller with frontend and API actions.
+    class RootController < ApplicationController
+      # This is required to make API controllers template renderable
+      include ActionView::Layouts
 
-    # Configure the default application layout
-    layout 'factory_bot/instrumentation/application'
+      # Configure the default application layout
+      layout 'factory_bot/instrumentation/application'
 
-    # Show the instrumentation frontend which features the output of configured
-    # dynamic seeds scenarios. The frontend allows humans to generate new seed
-    # data on the fly.
-    def index
-      @instrumentation = instrumentation
-      @scenarios = scenarios
-      @config = FactoryBot::Instrumentation.configuration
-      render :index, layout: true
-    end
+      # Show the instrumentation frontend which features the output of
+      # configured dynamic seeds scenarios. The frontend allows humans to
+      # generate new seed data on the fly.
+      def index
+        @instrumentation = instrumentation
+        @scenarios = scenarios
+        @config = FactoryBot::Instrumentation.configuration
+        render :index, layout: true
+      end
 
-    # Create a new entity with the given factory settings to create on demand
-    # dependencies for your testing needs. You can pass in requests without
-    # authentication in the following JSON format:
-    #
-    #   {
-    #     "factory": "user",
-    #     "traits": ["confirmed"],
-    #     "overwrite": {
-    #       "first_name": "Bernd",
-    #       "last_name": "Müller",
-    #       "email": "bernd.mueller@example.com",
-    #       "password": "secret"
-    #     }
-    #   }
-    #
-    # The result is the API v1 representation of the created entity.
-    def create
-      # Reload the factories to improve the test development experience
-      FactoryBot.reload
-      # Call the factory construction with the user given parameters
-      entity = FactoryBot.create(*factory_params)
-      # Render the resulting entity with the configured rendering block
-      FactoryBot::Instrumentation.configuration.render_entity.call(self, entity)
-    rescue StandardError => err
-      # Log for local factory debugging and re-raise for canary onwards
-      Rails.logger.error("#{err}\n#{err.backtrace.join("\n")}")
-      raise err
-    end
+      # Create a new entity with the given factory settings to create on demand
+      # dependencies for your testing needs. You can pass in requests without
+      # authentication in the following JSON format:
+      #
+      #   {
+      #     "factory": "user",
+      #     "traits": ["confirmed"],
+      #     "overwrite": {
+      #       "first_name": "Bernd",
+      #       "last_name": "Schulze",
+      #       "email": "bernd.schulze@example.com",
+      #       "password": "secret"
+      #     }
+      #   }
+      #
+      # The result is the API v1 representation of the created entity.
+      def create
+        # Reload the factories to improve the test development experience
+        FactoryBot.reload
+        # Call the factory construction with the user given parameters
+        entity = FactoryBot.create(*factory_params)
+        # Render the resulting entity with the configured rendering block
+        FactoryBot::Instrumentation.configuration.render_entity.call(
+          self, entity
+        )
+      rescue StandardError => err
+        # Handle any error gracefully with the configured error handler
+        FactoryBot::Instrumentation.configuration.render_error.call(self, err)
+      end
 
-    private
+      private
 
-    # Parse the given parameters from the request and build
-    # a valid FactoryBot options set.
-    #
-    # @return [Array<Mixed>] the FactoryBot options
-    def factory_params
-      data = params.permit(:factory, traits: [])
+      # Parse the given parameters from the request and build
+      # a valid FactoryBot options set.
+      #
+      # @return [Array<Mixed>] the FactoryBot options
+      #
+      # rubocop:disable Metrics/MethodLength because of the Rails
+      #   version handling
+      def factory_params
+        data = params.permit(:factory, traits: [])
 
-      if Rails::VERSION::MAJOR >= 5
-        overwrite = params.to_unsafe_h.fetch(:overwrite, {})
-                          .deep_symbolize_keys
-      else
-        overwrite = params.fetch('overwrite', {}).deep_symbolize_keys
-      end
+        overwrite = if Rails::VERSION::MAJOR >= 5
+                      params.to_unsafe_h.fetch(:overwrite, {})
+                            .deep_symbolize_keys
+                    else
+                      params.fetch('overwrite', {}).deep_symbolize_keys
+                    end
 
-      [
-        data.fetch(:factory).to_sym,
-        *data.fetch(:traits, []).map(&:to_sym),
-        **overwrite
-      ]
-    end
+        [
+          data.fetch(:factory).to_sym,
+          *data.fetch(:traits, []).map(&:to_sym),
+          **overwrite
+        ]
+      end
+      # rubocop:enable Metrics/MethodLength
 
-    # Unfortunately +Rails.configuration.instrumentation+ is only read once and
-    # do not hot-reload on changes. Thats why we read this file manually to get
-    # always a fresh state.
-    #
-    # @return [Hash{String => Mixed}] the instrumentation scenarios
-    def instrumentation
-      config_file = FactoryBot::Instrumentation.configuration.config_file.to_s
-      content = Pathname.new(config_file).read
-      template = ERB.new(content)
-      YAML.load(template.result(binding))[Rails.env]
-    end
+      # Unfortunately +Rails.configuration.instrumentation+ is only read once
+      # and do not hot-reload on changes. Thats why we read this file manually
+      # to get always a fresh state.
+      #
+      # @return [Hash{String => Mixed}] the instrumentation scenarios
+      #
+      # rubocop:disable Security/YAMLLoad because we just load
+      #   local configuration files here
+      def instrumentation
+        config_file = FactoryBot::Instrumentation.configuration.config_file.to_s
+        content = Pathname.new(config_file).read
+        template = ERB.new(content)
+        YAML.load(template.result(binding))[Rails.env]
+      end
+      # rubocop:enable Security/YAMLLoad
 
-    # Map all the instrumentation scenarios into groups and pass them back.
-    #
-    # @return [Hash{String => Array}] the grouped scenarios
-    def scenarios
-      instrumentation['scenarios'].each_with_object({}) do |scenario, memo|
-        group = scenario_group(scenario['name'])
-        scenario['group'] = group
-        memo[group] = [] unless memo.key? group
-        memo[group] << scenario
+      # Map all the instrumentation scenarios into groups and pass them back.
+      #
+      # @return [Hash{String => Array}] the grouped scenarios
+      def scenarios
+        instrumentation['scenarios'].each_with_object({}) do |scenario, memo|
+          group = scenario_group(scenario['name'])
+          scenario['group'] = group
+          memo[group] = [] unless memo.key? group
+          memo[group] << scenario
+        end
       end
-    end
 
-    # Map all the configured scenario groups to a useable hash.
-    #
-    # @return [Hash{Regexp => String}] the group mapping
-    def groups
-      instrumentation['groups'].each_with_object({}) do |(key, val), memo|
-        memo[Regexp.new(Regexp.quote(key))] = val
+      # Map all the configured scenario groups to a useable hash.
+      #
+      # @return [Hash{Regexp => String}] the group mapping
+      def groups
+        instrumentation['groups'].each_with_object({}) do |(key, val), memo|
+          memo[Regexp.new(Regexp.quote(key))] = val
+        end
       end
-    end
 
-    # Fetch the group name for a given scenario name. This will utilize the
-    # +SCENARIO_GROUPS+ map.
-    #
-    # @param name [String] the scenario name
-    # @return [String] the group name
-    def scenario_group(name)
-      groups.map do |pattern, group_name|
-        next unless pattern.match? name
-        group_name
-      end.compact.first || 'Various'
+      # Fetch the group name for a given scenario name. This will utilize the
+      # +SCENARIO_GROUPS+ map.
+      #
+      # @param name [String] the scenario name
+      # @return [String] the group name
+      def scenario_group(name)
+        groups.map do |pattern, group_name|
+          next unless pattern.match? name
+
+          group_name
+        end.compact.first || 'Various'
+      end
     end
   end
 end

data/factory_bot_instrumentation.gemspec

@@ -21,13 +21,18 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'rails', '>= 4.0'
   spec.add_runtime_dependency 'factory_bot'
+  spec.add_runtime_dependency 'rails', '>= 5.0'
 
+  spec.add_development_dependency 'appraisal'
   spec.add_development_dependency 'bundler', '>= 1.16', '< 3'
+  spec.add_development_dependency 'railties', '>= 4.2.0', '< 6.1'
   spec.add_development_dependency 'rspec-rails', '~> 3.8'
-  spec.add_development_dependency 'simplecov', '~> 0.15'
-  spec.add_development_dependency 'timecop', '~> 0.9.1'
+  spec.add_development_dependency 'rubocop', '~> 0.63.1'
+  spec.add_development_dependency 'rubocop-rspec', '~> 1.31'
+  spec.add_development_dependency 'simplecov', '< 0.18'
   spec.add_development_dependency 'sqlite3', '~> 1.3.6'
-  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'timecop', '~> 0.9.1'
+  spec.add_development_dependency 'yard', '~> 0.9.18'
+  spec.add_development_dependency 'yard-activesupport-concern', '~> 0.0.1'
 end

data/lib/factory_bot/instrumentation/configuration.rb

@@ -25,6 +25,21 @@ module FactoryBot
         end
       end
 
+      # By default we assemble a JSON response on errors which may be
+      # helpful for debugging, but you can configure your own logic here
+      config_accessor(:render_error) do
+        proc do |controller, error|
+          app_name = FactoryBot::Instrumentation.configuration.application_name
+          controller.render status: :internal_server_error,
+                            content_type: 'application/json',
+                            plain: {
+                              application: app_name,
+                              error: error.message,
+                              backtrace: error.backtrace.join("\n")
+                            }.to_json
+        end
+      end
+
       # By default we do not perform any custom +before_action+ filters on the
       # instrumentation controllers, with this option you can implement your
       # custom logic like authentication

data/lib/factory_bot/instrumentation/version.rb

@@ -2,6 +2,6 @@
 
 module FactoryBot
   module Instrumentation
-    VERSION = '0.5.0'.freeze
+    VERSION = '0.7.1'
   end
 end

data/lib/factory_bot_instrumentation.rb

@@ -13,6 +13,7 @@ require 'factory_bot/instrumentation/configuration'
 require 'factory_bot/instrumentation/engine'
 
 module FactoryBot
+  # The top level namespace for the factory_bot_instrumentation gem.
   module Instrumentation
     class << self
       attr_writer :configuration

metadata

@@ -1,37 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_instrumentation
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Hermann Mayer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2021-10-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -58,6 +72,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +106,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.31'
 - !ruby/object:Gem::Dependency
   name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -101,33 +177,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.1
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 0.9.18
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 0.9.18
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: yard-activesupport-concern
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.1
 description: Allow your testers to generate test data on demand
 email:
 - hermann.mayer92@gmail.com
@@ -136,11 +212,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".editorconfig"
+- ".github/workflows/documentation.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".simplecov"
-- ".travis.yml"
+- ".yardopts"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -177,7 +255,6 @@ files:
 - doc/assets/regular.png
 - docker-compose.yml
 - factory_bot_instrumentation.gemspec
-- gemfiles/rails_4.gemfile
 - gemfiles/rails_5.0.gemfile
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
@@ -188,7 +265,7 @@ files:
 homepage: https://github.com/hausgold/factory_bot_instrumentation
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,8 +280,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.16
+signing_key:
 specification_version: 4
 summary: Allow your testers to generate test data on demand
 test_files: []

data/.travis.yml

@@ -1,31 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=fb31117c43f12bf12f2d5a2b8ab4b3fe1b18aa874490f7f3db5502aa9ddb65fc
-
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6
-  - 2.5
-  - 2.4
-
-gemfile:
-  - gemfiles/rails_4.gemfile
-  - gemfiles/rails_5.0.gemfile
-  - gemfiles/rails_5.1.gemfile
-  - gemfiles/rails_5.2.gemfile
-
-before_install: |
-  [[ ! "${BUNDLE_GEMFILE}" =~ rails_4 ]] \
-    && (gem install bundler) \
-    || (yes n | rvm @global do gem uninstall bundler; \
-      gem install bundler -v '~> 1.0') \
-
-before_script:
-  - 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
-script: bundle exec rake
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/gemfiles/rails_4.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "rails", "~> 4.2.11"
-gem "rails-api", "~> 0.4.1"
-
-gemspec path: "../"