factory_bot_instrumentation 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 106c1aa5ca524b01dbff80a366493e8e921d2b65aba880d156da6481f6798d74
-  data.tar.gz: 538be239cc2016d21996c85d96730c8501dfca703f5d7a1d259dc198aa0da880
+  metadata.gz: 4893e1b40e7d03da45c7be90714efdae1c41c10fdf03152c20725100a19ed717
+  data.tar.gz: cb2481504a13586d664a02f0314684074938c0eb28ad910cf358482f51277301
 SHA512:
-  metadata.gz: 423b35d7c9c7e590a1b312206f5f05a93407fa1fe3f5dff3790ae0ba9d263f782e7a3e8cbd24ae48307e422dd4806e15284b378b71f35792384d0fbf1739e449
-  data.tar.gz: 6f2211b069039602f7e74bfa6a5d737acf2a651953ce81e6c758fed27625719f4128abb419dd5a66accfa5614c89e7663e65e9944bca09674e58f05244158b28
+  metadata.gz: 3ba69df7c7cc56fbe23d9758b69324938d8ef5db9080c0e6f3aa949e87e8f30f301c1382a8a56d423f8fd88c9d4741db6027f7ab95cb0c0a601919df6e417b0c
+  data.tar.gz: d95ae1e9a2ba594536c30ead21c161ff088f33b552b16085c1cf821645dbec61f1f14841e69f7af837ebbae5674b8850a5bcab143986068759dbb200d4d47f98

data/.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Release
+run-name: Release ${{ github.event.inputs.VERSION }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      VERSION:
+        description: The new version to release. (eg. `1.0.0`) Check the
+          changelog for the latest version.
+
+concurrency:
+  group: '${{ github.event.inputs.VERSION }}'
+  cancel-in-progress: true
+
+jobs:
+  docs:
+    name: Release the gem
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Ruby 2.5
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+          rubygems: '3.3.26'
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Switch to SSH remotes for the Git repository
+        run: git-ssh-remotes
+
+      - name: Enforce version '${{ github.event.inputs.VERSION }}'
+        run: set-gem-version '${{ github.event.inputs.VERSION }}'
+
+      - name: Prepare the Git release commit
+        run: git-release-commit '${{ github.event.inputs.VERSION }}'
+
+      - name: Push the release Git commit/tag and package to the registry
+        run: make release

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### next
+
+* TODO: Replace this bullet point with an actual description of a change.
+
+### 1.1.0
+
+* Added support for Gem release automation
+
+### 1.0.2
+
+* When used in combination with the `factory_bot_rails` gem (>= 6.0) we do not
+  force a `FactoryBot.reload` at Rails engine initialization as it breaks with
+  an `FactoryBot::DuplicateDefinitionError` (#14)
+
 ### 1.0.1
 
 * Added a retry logic to the FactoryBot reloading on the POST/create endpoint

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at development@hausgold.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/README.md

@@ -38,7 +38,9 @@ cases.
     - [Custom scripts](#custom-scripts)
     - [Custom styles](#custom-styles)
 - [Development](#development)
+- [Code of Conduct](#code-of-conduct)
 - [Contributing](#contributing)
+- [Releasing](#releasing)
 
 ## Installation
 
@@ -730,17 +732,28 @@ application. The file could look like this:
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`bundle exec rake spec` to run the tests. You can also run `bin/console` for an
+After checking out the repo, run `make install` to install dependencies. Then,
+run `make test` to run the tests. You can also run `make shell-irb` for an
 interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+## Code of Conduct
+
+Everyone interacting in the project codebase, issue tracker, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](./CODE_OF_CONDUCT.md).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/hausgold/factory_bot_instrumentation.
+https://github.com/hausgold/factory_bot_instrumentation. Make sure that every pull request adds
+a bullet point to the [changelog](./CHANGELOG.md) file with a reference to the
+actual pull request.
+
+## Releasing
+
+The release process of this Gem is fully automated. You just need to open the
+Github Actions [Release
+Workflow](https://github.com/hausgold/factory_bot_instrumentation/actions/workflows/release.yml)
+and trigger a new run via the **Run workflow** button. Insert the new version
+number (check the [changelog](./CHANGELOG.md) first for the latest release) and
+you're done.

data/factory_bot_instrumentation.gemspec

@@ -40,6 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'appraisal', '~> 2.4'
   spec.add_development_dependency 'bundler', '~> 2.3'
   spec.add_development_dependency 'countless', '~> 1.1'
+  spec.add_development_dependency 'factory_bot_rails', '~> 6.2'
   spec.add_development_dependency 'guard-rspec', '~> 4.7'
   spec.add_development_dependency 'railties', '>= 5.2'
   spec.add_development_dependency 'rspec-rails', '~> 5.1'

data/lib/factory_bot/instrumentation/engine.rb

@@ -7,11 +7,16 @@ module FactoryBot
       isolate_namespace FactoryBot::Instrumentation
 
       # Fill in some dynamic settings (application related)
-      initializer 'factory_bot_instrumentation.config' do
-        # Ensure the FactoryBot gem loads its factories to ensure they are
-        # also available in the rails console and other places in the app
-        # and not only via instrumentation frontend.
-        FactoryBot.reload
+      initializer 'factory_bot_instrumentation.config' do |app|
+        # Ensure the FactoryBot gem loads its factories to ensure they are also
+        # available in the rails console and other places in the app and not
+        # only via instrumentation frontend. We skip this step as in
+        # combination with the +factory_bot_rails+ gem (>=6.0) the FactoryBot
+        # initializing occurs after the Rails application initializing, which
+        # leads to +FactoryBot::DuplicateDefinitionError+s.
+        initializer_names = app.initializers.map(&:name).map(&:to_s)
+        FactoryBot.reload \
+          if initializer_names.grep(/^factory_bot\./).count.zero?
 
         FactoryBot::Instrumentation.configure do |conf|
           # Set the application name dynamically

data/lib/factory_bot/instrumentation/version.rb

@@ -4,7 +4,7 @@ module FactoryBot
   # The gem version details.
   module Instrumentation
     # The version of the +factory_bot_instrumentation+ gem
-    VERSION = '1.0.1'
+    VERSION = '1.1.0'
 
     class << self
       # Returns the version of gem as a string.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot_instrumentation
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Hermann Mayer
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: factory_bot
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -257,6 +271,7 @@ extra_rdoc_files: []
 files:
 - ".editorconfig"
 - ".github/workflows/documentation.yml"
+- ".github/workflows/release.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -265,6 +280,7 @@ files:
 - ".yardopts"
 - Appraisals
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Dockerfile
 - Envfile
 - Gemfile
@@ -310,7 +326,7 @@ files:
 - lib/factory_bot/instrumentation/engine.rb
 - lib/factory_bot/instrumentation/version.rb
 - lib/factory_bot_instrumentation.rb
-homepage:
+homepage: 
 licenses:
 - MIT
 metadata:
@@ -319,7 +335,7 @@ metadata:
   changelog_uri: https://github.com/hausgold/factory_bot_instrumentation/blob/master/CHANGELOG.md
   bug_tracker_uri: https://github.com/hausgold/factory_bot_instrumentation/issues
   documentation_uri: https://www.rubydoc.info/gems/factory_bot_instrumentation
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -334,8 +350,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.8
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: Allow your testers to generate test data on demand
 test_files: []