rspec_test_data 1.0.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a910ceb350cd1c0038d9ed55855a3cf61518eff07edff511b97d82c8a7b41df3
+  data.tar.gz: 852ac12267d03e947fa86a1672814b9e7da9b00897344cf00973d800281b8932
+SHA512:
+  metadata.gz: 7ffcbf8472b3b97f5adbfc59af4364f3160c9a5ce65f3b9283e84c5a2bd8bfa58606b5e25e03077b2072d464374bda176ed6602427fa4b7f002df55d3671d0df
+  data.tar.gz: 6bed65c1cb5b4e22afc3730bfb1837031eb5f90dcc58477edb90f892db43f8791215d225eca94ff1bb71a69e0d6175858f9851719db40aee2483ab8ff509818c

data/.circleci/config.yml

@@ -0,0 +1,35 @@
+version: 2.1
+orbs:
+  # See https://circleci.com/developer/orbs/orb/circleci/ruby
+  ruby: circleci/ruby@1.2.0
+jobs:                # keyword
+  test:              # my name for the job
+    parameters:      # keyword
+      ruby-version:  # my parameter name
+        type: string # type is a keyword
+    docker:          # keyword
+      - image: cimg/base:stable
+    steps:                                       # keyword
+      - checkout                                 # magic name
+      - ruby/install:                            # ruby/ is from the orb name, install is a command in that orb
+          version: << parameters.ruby-version >> # magic nonsense for param subst
+      - run:
+          command: "bin/setup"
+      - run:
+          name: "Create the test results directory because you can't just store_test_results with a file and if you do you do not get any sort of error because wtf is with this platform?"
+          command: mkdir -p /tmp/test-results
+      - run:
+          command: bin/ci /tmp/test-results/rspec_results.xml
+      - store_test_results:                      # store_test_results is magic from circle
+          path: /tmp/test-results                # path is a param to store_test_results and it must be a directory not a file
+      - store_artifacts:                         # store_artifacts is magic from circle
+          path: /tmp/test-results                # path is the param to store_artifacts
+workflows:              # keyword
+  all-rubies:           # my name for the workflow
+    jobs:               # keyword
+      - test:           # my name for the job
+          matrix:       # keyword
+            parameters: # keyword
+              # All rubies being maintained per this page:
+              # https://www.ruby-lang.org/en/downloads/branches/
+              ruby-version: [ "2.5", "2.6", "2.7", "3.0" ]

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

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, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, 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 davetron5000 (at) gmail.com. 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+

data/CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# Contributing
+
+* Code changes for style, cleanliness, eleganance, or other aesthetic stuff will not be accepted.
+* All proposed changes must have a clear problem statement and be based on a real-world scenario. Imagined problems will not be solved.
+* Tests are appreciated with all pull requests, but I realize there aren't any in here so help with how this might be tested would be very much appreciated.

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in with_clues.gemspec
+gemspec
+
+gem "rake", "~> 12.0"

data/LICENSE.md

@@ -0,0 +1,33 @@
+[rspec_test_data] Copyright (2021) (David Copeland)(“Licensor”)
+
+Hippocratic License Version Number: 2.1.
+
+Purpose. The purpose of this License is for the Licensor named above to permit the Licensee (as defined below) broad permission, if consistent with Human Rights Laws and Human Rights Principles (as each is defined below), to use and work with the Software (as defined below) within the full scope of Licensor’s copyright and patent rights, if any, in the Software, while ensuring attribution and protecting the Licensor from liability.
+
+Permission and Conditions. The Licensor grants permission by this license (“License”), free of charge, to the extent of Licensor’s rights under applicable copyright and patent law, to any person or entity (the “Licensee”) obtaining a copy of this software and associated documentation files (the “Software”), to do everything with the Software that would otherwise infringe (i) the Licensor’s copyright in the Software or (ii) any patent claims to the Software that the Licensor can license or becomes able to license, subject to all of the following terms and conditions:
+
+* Acceptance. This License is automatically offered to every person and entity subject to its terms and conditions. Licensee accepts this License and agrees to its terms and conditions by taking any action with the Software that, absent this License, would infringe any intellectual property right held by Licensor.
+
+* Notice. Licensee must ensure that everyone who gets a copy of any part of this Software from Licensee, with or without changes, also receives the License and the above copyright notice (and if included by the Licensor, patent, trademark and attribution notice). Licensee must cause any modified versions of the Software to carry prominent notices stating that Licensee changed the Software. For clarity, although Licensee is free to create modifications of the Software and distribute only the modified portion created by Licensee with additional or different terms, the portion of the Software not modified must be distributed pursuant to this License. If anyone notifies Licensee in writing that Licensee has not complied with this Notice section, Licensee can keep this License by taking all practical steps to comply within 30 days after the notice. If Licensee does not do so, Licensee’s License (and all rights licensed hereunder) shall end immediately.
+
+* Compliance with Human Rights Principles and Human Rights Laws.
+
+    1. Human Rights Principles.
+
+        (a) Licensee is advised to consult the articles of the United Nations Universal Declaration of Human Rights and the United Nations Global Compact that define recognized principles of international human rights (the “Human Rights Principles”). Licensee shall use the Software in a manner consistent with Human Rights Principles.
+
+        (b) Unless the Licensor and Licensee agree otherwise, any dispute, controversy, or claim arising out of or relating to (i) Section 1(a) regarding Human Rights Principles, including the breach of Section 1(a), termination of this License for breach of the Human Rights Principles, or invalidity of Section 1(a) or (ii) a determination of whether any Law is consistent or in conflict with Human Rights Principles pursuant to Section 2, below, shall be settled by arbitration in accordance with the Hague Rules on Business and Human Rights Arbitration (the “Rules”); provided, however, that Licensee may elect not to participate in such arbitration, in which event this License (and all rights licensed hereunder) shall end immediately. The number of arbitrators shall be one unless the Rules require otherwise.
+
+        Unless both the Licensor and Licensee agree to the contrary: (1) All documents and information concerning the arbitration shall be public and may be disclosed by any party; (2) The repository referred to under Article 43 of the Rules shall make available to the public in a timely manner all documents concerning the arbitration which are communicated to it, including all submissions of the parties, all evidence admitted into the record of the proceedings, all transcripts or other recordings of hearings and all orders, decisions and awards of the arbitral tribunal, subject only to the arbitral tribunal's powers to take such measures as may be necessary to safeguard the integrity of the arbitral process pursuant to Articles 18, 33, 41 and 42 of the Rules; and (3) Article 26(6) of the Rules shall not apply.
+
+    2. Human Rights Laws. The Software shall not be used by any person or entity for any systems, activities, or other uses that violate any Human Rights Laws.  “Human Rights Laws” means any applicable laws, regulations, or rules (collectively, “Laws”) that protect human, civil, labor, privacy, political, environmental, security, economic, due process, or similar rights; provided, however, that such Laws are consistent and not in conflict with Human Rights Principles (a dispute over the consistency or a conflict between Laws and Human Rights Principles shall be determined by arbitration as stated above).  Where the Human Rights Laws of more than one jurisdiction are applicable or in conflict with respect to the use of the Software, the Human Rights Laws that are most protective of the individuals or groups harmed shall apply.
+
+    3. Indemnity. Licensee shall hold harmless and indemnify Licensor (and any other contributor) against all losses, damages, liabilities, deficiencies, claims, actions, judgments, settlements, interest, awards, penalties, fines, costs, or expenses of whatever kind, including Licensor’s reasonable attorneys’ fees, arising out of or relating to Licensee’s use of the Software in violation of Human Rights Laws or Human Rights Principles.
+
+* Failure to Comply. Any failure of Licensee to act according to the terms and conditions of this License is both a breach of the License and an infringement of the intellectual property rights of the Licensor (subject to exceptions under Laws, e.g., fair use). In the event of a breach or infringement, the terms and conditions of this License may be enforced by Licensor under the Laws of any jurisdiction to which Licensee is subject. Licensee also agrees that the Licensor may enforce the terms and conditions of this License against Licensee through specific performance (or similar remedy under Laws) to the extent permitted by Laws. For clarity, except in the event of a breach of this License, infringement, or as otherwise stated in this License, Licensor may not terminate this License with Licensee.
+
+* Enforceability and Interpretation. If any term or provision of this License is determined to be invalid, illegal, or unenforceable by a court of competent jurisdiction, then such invalidity, illegality, or unenforceability shall not affect any other term or provision of this License or invalidate or render unenforceable such term or provision in any other jurisdiction; provided, however, subject to a court modification pursuant to the immediately following sentence, if any term or provision of this License pertaining to Human Rights Laws or Human Rights Principles is deemed invalid, illegal, or unenforceable against Licensee by a court of competent jurisdiction, all rights in the Software granted to Licensee shall be deemed null and void as between Licensor and Licensee. Upon a determination that any term or provision is invalid, illegal, or unenforceable, to the extent permitted by Laws, the court may modify this License to affect the original purpose that the Software be used in compliance with Human Rights Principles and Human Rights Laws as closely as possible. The language in this License shall be interpreted as to its fair meaning and not strictly for or against any party.
+
+* Disclaimer. TO THE FULL EXTENT ALLOWED BY LAW, THIS SOFTWARE COMES “AS IS,” WITHOUT ANY WARRANTY, EXPRESS OR IMPLIED, AND LICENSOR AND ANY OTHER CONTRIBUTOR SHALL NOT BE LIABLE TO ANYONE FOR ANY DAMAGES OR OTHER LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THIS LICENSE, UNDER ANY KIND OF LEGAL CLAIM.
+
+This Hippocratic License is an Ethical Source license (https://ethicalsource.dev) and is offered for use by licensors and licensees at their own risk, on an “AS IS” basis, and with no warranties express or implied, to the maximum extent permitted by Laws.

data/README.md

@@ -0,0 +1,387 @@
+# rspec\_test\_data - Create Complex test data with the ability to share with other tests or seed data
+
+[![<sustainable-rails>](https://circleci.com/gh/sustainable-rails/rubygem.svg?style=shield)](https://app.circleci.com/pipelines/github/sustainable-rails/rubygem)
+
+## Install
+
+```ruby
+# In your Gemfile
+gem "rspec_test_data"
+```
+
+*Note*: Nothing is required when you do this. You *must* configure things. See below.
+
+## What Problem Does This Solve?
+
+This allows the creation of test data that is more than one factory, but scoped to a test file.
+
+Rails comes with the concept of *fixtures* which is a global set of data that is available to all of your tests.  Many developers, myself
+included, find this is hard to manage when an app becomes non-trivial, and can get extremely complicated when you use and validate
+foreign key constraints.
+
+[FactoryBot](https://github.com/thoughtbot/factory_bot) provides an alternative, which are *factories* to create instances of objects you
+would use as input to a test.  These work great for creating single objects.  They do not work as great when you need to create a lot of
+objects.
+
+*Why would you need to create a lot of objects?*  Glad you asked.  A very common reason in my experience is if you are writing some code
+that needs to perform a query that is complex.  For example, show me all the customers who have said they have insurance, but who have
+not provided the details of their insurance, but filter out everyone that has not scheduled an appointment.
+
+Testing this requires creating several records in all the various states to check your query logic, then running the query and figuring
+out what came back.
+
+*OK, so use factories* - for a single test, it *is* better to just use factories to create a bunch of stuff.  But, when you start needing
+to create them in more than one test, or want to have that data in your seed data for local development, RSpec provides very rudimentary
+tools for this.  Since RSpec uses an internal DSL via `let` and `shared_context` and friends, it is hard to manage, compose, and re-use
+this stuff.
+
+But! We have *Object-Oriented Programming*! If we could put this stuff in a class, we can use that class, make that class configurable
+(or not), extend that class, etc. We can use the tools we use every day to manage our complex test data.
+
+*OK, so why do I need a gem?*  This gem facilitates that by providing an implicit `test_data` object that allows access to a test data
+class you define.
+
+## Using This Gem
+
+Suppose you have `spec/services/appointments_spec.rb`:
+
+```ruby
+RSpec.describe Appointments do
+  describe "#upcoming" do
+    context "no restriction by service" do
+      it "returns all in the future" do
+        a1       = create(:appointment,            date: 4.days.from_now)
+        a2       = create(:appointment,            date: 14.days.from_now)
+        canceled = create(:appointment, :canceled, date: 3.days.from_now)
+        past     = create(:appointment,            date: 3.days.ago)
+
+        upcoming = appointments.upcoming
+
+        expect(upcoming.size).to eq(2)
+        aggregate_failures do
+          expect(upcoming).to include(a1)
+          expect(upcoming).to include(a2)
+        end
+      end
+    end
+    context "restrict by service" do
+      it "returns those in the future for the given service" do
+        s1 = create(:service)
+        s2 = create(:service)
+
+        a1       = create(:appointment,            service: s1, date: 4.days.from_now)
+        a2       = create(:appointment,            service: s2, date: 14.days.from_now)
+        canceled = create(:appointment, :canceled, service: s1, date: 3.days.from_now)
+        past     = create(:appointment,            service: s1, date: 3.days.ago)
+
+        upcoming = appointments.upcoming(service: s1)
+
+        expect(upcoming.size).to eq(1)
+        expect(upcoming).to      include(a1)
+      end
+    end
+  end
+end
+```
+
+The test set up for both tests is pretty similar.  The first test does not specify the service, but the service doesn't matter to that test, so it could absolutely use the exact same set of services and appointments that the second test uses.
+
+It also might be nice to use this setup when you are working on the front-end to have some realistic data or as part of a larger set of
+test data for a system test that involves this code.
+
+We could put that in a `before` block or a series of `let` calls, but this doesn't make it easy to use outside this test.  Enter
+`rspec_test_data`.
+
+Assuming you have configured this gem, you would create the class `RspecTestData::Services::Appointments` in the file
+`spec/services/appointments.test_data.rb` like so:
+
+```ruby
+module RspecTestData::Services
+  class Appointments < RspecTestData::BaseTestData
+
+    attr_reader :service, :upcoming_appointment_service, :upcoming_appointment_other_service
+
+    def initialize
+      @service      = create(:service)
+      other_service = create(:service)
+
+      @upcoming_appointment_service       = create(:appointment,
+                                                   service: s1,
+                                                   date: 4.days.from_now)
+      @upcoming_appointment_other_service = create(:appointment,
+                                                   service: s2,
+                                                   date: 14.days.from_now)
+      canceled                            = create(:appointment, :canceled,
+                                                   service: s1,
+                                                   date: 3.days.from_now)
+      past                                = create(:appointment,
+                                                    service: s1,
+                                                    date: 3.days.ago)
+    end
+  end
+end
+```
+
+This class creates the test data and exposes only the data the test is going to need.  Now, the test looks like so:
+
+```ruby
+RSpec.describe Appointments do
+  describe "#upcoming" do
+    context "no restriction by service" do
+      it "returns all in the future" do
+        upcoming = appointments.upcoming
+
+        expect(upcoming.size).to eq(2)
+
+        aggregate_failures do
+          expect(upcoming).to include(test_data.upcoming_appointment_service)
+          expect(upcoming).to include(test_data.upcoming_appointment_other_service)
+        end
+      end
+    end
+    context "restrict by service" do
+      it "returns those in the future for the given service" do
+        upcoming = appointments.upcoming(service: test_data.service)
+
+        expect(upcoming.size).to eq(1)
+        expect(upcoming).to      include(test_data.upcoming_appointment_service)
+      end
+    end
+  end
+end
+```
+
+Whoa.  Yes, the setup is gone and subsumed into the test data class.  This is a trade-off.  You make this trade-off in this case because
+you want access to the test data outside this class.  You can achieve this like so, in your `db/seeds.rb`:
+
+```ruby
+require "rspec_test_data/seeds_helper"
+
+test_data_seeds_helper = RspecTestData::SeedsHelper.for_rails
+test_data = test_data_seeds_helper.load("RspecTestData::Services::Appointments")
+
+puts test_data.upcoming_appointment_service.customer.name +
+     " has an upcoming appointment with the service"
+```
+
+This can be extremely helpful for aligning your dev environment, where you may want realistic data to work on the UI, with your tests.
+
+Note that since the test data class is just a class, it can accept arguments to the constructor that affect the behavior.  Perhaps you
+want your seed data to be a bit more realistic:
+
+```ruby
+require "rspec_test_data/seeds_helper"
+
+test_data_seeds_helper = RspecTestData::SeedsHelper.for_rails
+test_data = test_data_seeds_helper.load("RspecTestData::Services::Appointments",
+                                        service_name: "Physical Therapy")
+
+puts test_data.upcoming_appointment_service.customer.name +
+     " has an upcoming appointment for Physical Therapy"
+```
+
+The test data class accommodates this using plain ole Ruby:
+
+```ruby
+module RspecTestData::Services
+  class Appointments < RspecTestData::BaseTestData
+
+    attr_reader :service, :upcoming_appointment_service, :upcoming_appointment_other_service
+
+    def initialize(service_name: :use_factory)
+      @service      = if service_name == :use_factory
+                        create(:service)
+                      else
+                        create(:service, name: service_name)
+                      end
+      other_service = create(:service)
+
+      # ... as before
+
+    end
+  end
+end
+```
+
+This class then becomes a sort of "super factory" you can use to create complex test data.  Suppose you want to search for upcoming
+appointments by service name?  You'll need to make sure both services are created with distinct names so  you can reliably search by name
+
+```ruby
+module RspecTestData::Services
+  class Appointments < RspecTestData::BaseTestData
+
+    attr_reader :service, :upcoming_appointment_service, :upcoming_appointment_other_service
+
+    def initialize(service_name:       :use_factory,
+                   other_service_name: :use_factory)
+
+      @service      = if service_name == :use_factory
+                        create(:service)
+                      else
+                        create(:service, name: service_name)
+                      end
+      other_service = if other_service_name == :use_factory
+                        create(:service)
+                      else
+                        create(:service, name: other_service_name)
+                      end
+
+      # ... as before
+
+    end
+  end
+end
+```
+
+Now, in your test you can override the default creation of the test data per test.  If you declare a `let` variable named
+`test_data_override`, *that* will be set to `test_data`.  To create this, you have access to the class via the implicitly defined
+variable `test_data_class`.
+
+```ruby
+RSpec.describe Appointments do
+  describe "#upcoming" do
+    context "no restriction by service" do
+      it "returns all in the future" # as before
+    end
+    context "restrict by service" do
+      it "returns those in the future for the given service" # as before
+    end
+    context "restrict by service name partial match" do
+      let(:test_data_override) {
+        test_data_class.new(service_name:       "Physical Therapy",
+                            other_service_name: "Ortho Exam")
+      }
+      it "returns those in the future for the given service" do
+        upcoming = appointments.upcoming(service_name: "phys")
+
+        expect(upcoming.size).to eq(1)
+        expect(upcoming).to      include(test_data.upcoming_appointment_service)
+      end
+    end
+  end
+end
+```
+
+Notice how the *only* magic happening is the definition of `test_data` and `test_data_class` based on a convention of a class defined
+in a file with a specific name.  The test data class is just a normal Ruby class.  Your test that overrides it just uses
+Ruby.
+
+You can opt out using RSpec metadata:
+
+```ruby
+RSpec.describe Appointments do
+  describe "#upcoming" do
+    context "no restriction by service" do
+      it "returns all in the future" # as before
+    end
+    context "restrict by service" do
+      it "returns those in the future for the given service" # as before
+    end
+    context "restrict by service name partial match", test_data: false do
+      it "returns those in the future for the given service" do
+        # test_data is not defined here - do whatever you want
+      end
+    end
+  end
+end
+```
+
+Test Data can also be useful for system tests.  Perhaps you want a system test of the appointment search feature.
+
+```ruby
+# spec/system/appointments/search_spec.rb
+RSpec.describe "searching for appointments" do
+  scenario "show all appointments" do
+    login_as test_data.therapist
+
+    click_on "Search Appointments"
+    click_on "View All"
+
+    expect(page).to     have_content(test_data.upcoming_appointment_service.description)
+    expect(page).to     have_content(test_data.upcoming_appointment_other_service.description)
+    expect(page).not_to have_content(test_data.canceled_appointment.description)
+  end
+end
+```
+
+To make this work, you'll need to define `RspecTestData::System::Appointments::Search` in the file
+`spec/system/appointments/search.test_data.rb`.
+
+To re-use the test data for the `Appointments` class, all you have to do is use a plain old Ruby concept: inheritance:
+
+```ruby
+require_relative "../services/appointments.test_data.rb"
+class RspecTestData::System::Appointments::Search < RspecTestData::Services::Appointments
+  attr_reader :therapist, :canceled_appointment
+  def initialize(...)
+    super(...)
+
+    @therapist = create(:user, type: :therapist)
+
+    @canceled_appointment = create(:appointment, :canceled,
+                                   service: @service,
+                                   date: 10.days.from_now)
+  end
+end
+```
+
+This gem isn't really facilitating this re-use - we can do it because this is just a class and Ruby allows it.  No new skills or DSL is
+needed here. You can do whatever makes sense.
+
+## Configuration & Setup
+
+In your `spec/spec_helper.rb`:
+
+```ruby
+require "rspec_test_data/rspec_setup"    # brings in the setup below
+require "rspec_test_data/base_test_data" # Avoid having to require this in all test data class files
+
+RSpec.configure do |config|
+
+  # whatever set up you have already
+
+  config.before(:example) do |example|
+    RspecTestData::Setup.new(example)
+  end
+end
+```
+
+Even here, the setup is explicit so you know it's happening. Nothing is done to you automatically.
+
+If you don't create an analogous `.test_data.rb` file, nothing happens, your test works like normal.
+
+## Debugging
+
+Often, libraries with implicit behavior are hard to debug when nothing happens.  The library can't tell that you meant to do something
+but failed - it just thinks you didn't try to do something.  To help debug those situations:
+
+```
+DEBUG_TEST_DATA=true bin/rspec spec/services/appointments_spec.rb
+```
+
+This will cause rspec\_test\_data to output verbose information about what it's doing, what it tried, what worked, what didn't.  You can also add the `debug_test_data: true`
+metadata to any test or spec to trigger the same behavior.
+
+## A Note on Implementation
+
+I have been using this for several months in two Rails apps that I would say are "medium-small".  It is working great for me, but if you
+look at the code for `RspecTestData::Setup`, there is a bit of wizardry in there.  Be careful with how you use this.
+
+## Ejecting from the Magic
+
+Since your test data class is just a class, you can eject from all of this like so:
+
+1. Remove this Gem
+2. Keep a copy of `RspecTestData::BaseTestData` in your app, e.g. in `lib/rspec_test_data/base_test_data.rb`
+3. In your RSpec tests, add this:
+
+   ```ruby
+   require_relative "./appointments.test_data.rb"
+
+   # Then, in a test...
+   let(:test_data) { RspecTestData::Services::Appointments.new }
+   ```
+
+## Contributing
+
+Would love feedback on the implementation and how it might be unit tested.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/ci

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+set -e
+echo "[bin/ci] Running tests"
+if [ -z $1 ]; then
+  bin/rspec --format=doc
+else
+  echo "[bin/ci] Generating JUnit XML output to $1"
+  bin/rspec --format RspecJunitFormatter --out $1 --format=doc
+fi

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "with_clues"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle check || bundle install

data/lib/rspec_test_data/base_test_data.rb

@@ -0,0 +1,6 @@
+require "factory_bot"
+module RspecTestData
+  class BaseTestData
+    include FactoryBot::Syntax::Methods
+  end
+end

data/lib/rspec_test_data/rspec_setup.rb

@@ -0,0 +1,52 @@
+module RspecTestData
+  class Setup
+    def initialize(example)
+      debug = ->(*) {}
+
+      if example.metadata[:debug_test_data] || ENV["DEBUG_TEST_DATA"] == "true"
+        debug = ->(*args) {
+          first_message,rest = args[0], args[1..-1]
+          puts *([ "[ debug_test_data ] #{args[0]}" ] + args[1..-1])
+        }
+      end
+
+      use_test_data = example.metadata[:test_data].nil? || example.metadata[:test_data] == true
+      if !use_test_data
+        debug.("Spec opted out of test_data (#{example.description})")
+        return
+      end
+
+      test_data_file = example.file_path.gsub(/_spec\.rb$/,".test_data.rb")
+
+      if !File.exists?(test_data_file)
+        debug.("Can't find #{test_data_file}, so assuming none to load")
+        return
+      end
+
+      require test_data_file
+
+      test_data_class_name = "RspecTestData::" + example.file_path.gsub(/^.\/spec\//,"").gsub(/_spec\.rb$/,"").classify
+      test_data_class = begin
+                          debug.("Loading '#{test_data_class_name}' as the test data class name")
+                          test_data_class_name.constantize
+                        rescue NameError => ex
+                          raise "Expected '#{test_data_file}' to define '#{test_data_class_name}', but it does not: #{ex.message}"
+                        end
+
+      example.example_group.let(:test_data_class) { test_data_class }
+
+      if example.example_group.method_defined?(:test_data_override)
+        debug.("test_data_override for '#{example.description}'")
+        example.example_group.let(:test_data) { test_data_override }
+      else
+        if example.metadata[:test_data_eager] == true
+          test_data = test_data_class.new
+          example.example_group.let(:test_data) { test_data }
+        else
+          example.example_group.let(:test_data) { test_data_class.new }
+        end
+      end
+
+    end
+  end
+end

data/lib/rspec_test_data/seeds_helper.rb

@@ -0,0 +1,31 @@
+require "pathname"
+require_relative "./base_test_data"
+
+module RspecTestData
+  class SeedsHelper
+
+    def self.for_rails
+      self.new(Rails.root / "spec")
+    end
+
+    def initialize(spec_path)
+      @spec_path = spec_path
+    end
+
+    def load(test_data_class_name,**args)
+      if test_data_class_name !~ /^RspecTestData::/
+        test_data_class_name = "RspecTestData::#{test_data_class_name}"
+      end
+      parts = test_data_class_name.split(/::/).map(&:underscore)
+
+      path = (@spec_path / parts[1..-1].join("/")).to_s + ".test_data.rb"
+
+      if !File.exist?(path)
+        raise "Expected to find test data for #{test_data_class_name} in '#{path}', but that file doesn't exist."
+      end
+
+      require_relative path
+      test_data_class_name.constantize.new(**args)
+    end
+  end
+end

data/lib/rspec_test_data/version.rb

@@ -0,0 +1,3 @@
+module RspecTestData
+  VERSION="1.0.0.pre1"
+end

data/lib/rspec_test_data.rb

@@ -0,0 +1,2 @@
+module RspecTestData
+end

data/rspec_test_data.gemspec

@@ -0,0 +1,27 @@
+require_relative "lib/rspec_test_data/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rspec_test_data"
+  spec.version = RspecTestData::VERSION
+  spec.authors       = ["Dave Copeland"]
+  spec.email         = ["davec@naildrivin5.com"]
+  spec.summary       = %q{Create complex sets of test data using factories to allow re-use across tests or in seed data}
+  spec.homepage      = "https://sustainable-rails.com"
+  spec.license       = "Hippocratic"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/sustainable-rails/rspec_test_data"
+  spec.metadata["changelog_uri"] = "https://github.com/sustainable-rails/rspec_test_data/releases"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("rspec")
+  spec.add_development_dependency("rspec_junit_formatter")
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: rspec_test_data
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre1
+platform: ruby
+authors:
+- Dave Copeland
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- davec@naildrivin5.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/ci
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/rspec_test_data.rb
+- lib/rspec_test_data/base_test_data.rb
+- lib/rspec_test_data/rspec_setup.rb
+- lib/rspec_test_data/seeds_helper.rb
+- lib/rspec_test_data/version.rb
+- rspec_test_data.gemspec
+homepage: https://sustainable-rails.com
+licenses:
+- Hippocratic
+metadata:
+  homepage_uri: https://sustainable-rails.com
+  source_code_uri: https://github.com/sustainable-rails/rspec_test_data
+  changelog_uri: https://github.com/sustainable-rails/rspec_test_data/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Create complex sets of test data using factories to allow re-use across tests
+  or in seed data
+test_files: []