#4217 kit factory refactor #4585

jimmyli97 · 2024-08-08T23:37:17Z

Addresses #4217 for kits

Description

Eliminate checking factory items in our tests #4217 Hard codes all uses of kit factory
Remove kit :with_item trait and replace with KitCreateService - this is to make it easier for me to rewrite kit creation later when working on [Kit Redesign] Phase 1 - Change itemizable source #3707

Kit :with_item trait removal conflicts with #4582, recommend merging that one first then I can merge and change their rspecs in this PR

Type of change

Bug fix (non-breaking change which fixes an issue)
Documentation update

How Has This Been Tested?

passes all rspecs

* Replace :with_item trait with calls to KitCreateService to make it easy to change line_item itemizable behavior later * Remove unnecessary :with_item traits * Hard code all rspecs matching against kit values, finishes rubyforgood#4217 for kits

* Another typo in docs

* Clearer name * Add rspecs to test :housing_a_kit and :loose scopes

… deletion * Move seed_base_items code into one static function * Move kit base item creation code into one static function * Add code to prevent calling destroy on kit base item and corresponding rspec * Added comments - not sure about whether other base item request specs are useful or what the purpose of destroy is in the controller if it can't be called

jimmyli97 · 2024-08-09T02:02:11Z

the failing tests are flaky ones, added them to the list

* All SQL code is duplicated in AcquisitionReportService * RSpec is close enough to what is in AcquisitionReportService Spec that it can be removed without merging in (only difference is Diapers - Adult Briefs category is not created, but that shouldn't matter because the SQL looks for %diaper% so this category isn't testing anything different)

dorner

In general I think this PR is trying to do a bit too many things at once - it might be easier to focus on things that (for example) aren't blocked by the PR you mention. Maybe the cleanup pieces could be on their own and the factory pieces could be separate.

dorner · 2024-09-02T18:12:21Z

app/controllers/admin/base_items_controller.rb

@@ -38,9 +38,12 @@ def show
    @items = @base_item.items
  end

+  # TODO there are no buttons on the view to call this method, consider removing?


We're going to be removing the current approach to base items at some point in the future. I think for now it's safe to just leave this method alone if nothing calls it.

added a note for this in PR #4665 a74dcc9

dorner · 2024-09-02T18:13:35Z

app/services/kit_create_service.rb

  attr_reader :kit

+  def self.FindOrCreateKitBaseItem!


Idiomatic Ruby uses snake_case: find_or_create_kit_base_item!.

changed this in PR #4665 a74dcc9

dorner · 2024-09-02T18:14:56Z

app/services/reports/children_served_report_service.rb

@@ -31,47 +31,8 @@ def average_children_monthly
      total_children_served / 12.0
    end

-    def disposable_diapers_from_kits_total


Why were these lines removed?

continued conversation in #4665

dorner · 2024-09-02T18:16:23Z

app/models/base_item.rb


+  def self.seed_base_items


This is only used in specs and seeds. Not sure this belongs on the main BaseItem class. I'd probably create a module call Seeds or something like that that can be referenced from those two contexts.

moved into lib/seed_base_items.rb in PR #4665 8fde086

dorner · 2024-09-02T18:17:42Z

spec/events/inventory_aggregate_spec.rb

+        {item_id: item2.id, quantity: 3}
+      ]
+
+      kit = KitCreateService.new(organization_id: organization.id, kit_params: params).call.kit


Is there a way for us to just update the factory itself to call KitCreateService? E.g. by overriding to_create? https://github.com/thoughtbot/factory_bot/blob/main/GETTING_STARTED.md#custom-methods-to-persist-objects

If not, can we create a reusable method to do this work, allowing you just to pass in the LineItems you want to create, and provide a sane default if we don't care what they are?

I considered overriding to_create but I don't think it'll work because the way it works right now KitCreateService creates its own instance of kit and I don't think it's worth the time to rejig it so that it can accept FactoryBot's instance, since it will be changed in the kit refactoring.

I created a helper method under spec/support/kit_helper.rb in 730371a

dorner · 2024-09-02T18:18:37Z

spec/models/item_spec.rb

@@ -57,6 +57,29 @@
      expect(Item.by_size("4").length).to eq(2)
    end

+    it "->housing_a_kit returns all items which belongs_to (house) a kit" do


In general, if the first word of the test description isn't "should", you should use the specify keyword instead of it. They are aliases of each other - it's just a readability thing.

changed in #4665 7d25b3a

…rgood#4163" This reverts commit ceec002.

This reverts commit 7cabfa6.

This reverts commit 1109170.

This reverts commit b9b8755.

…ase_item deletion" This reverts commit 8c18e42.

This reverts commit e1e2c31.

This reverts commit 141d959.

This reverts commit 080721e.

jimmyli97 · 2024-09-24T02:13:33Z

I split off the cleanup pieces into PR #4665

jimmyli97 added 9 commits August 8, 2024 22:40

Update bundler version

7a351cd

REFACTOR clean up unused line item trait introduced in rubyforgood#4163

ceec002

FIX typo in params in donation and purchase controllers

7cabfa6

* Another typo in docs

DOCS add comment clarifying itemizable works with line items

1109170

REFACTOR rename Item:kits scope to :housing_a_kit, add rspecs

b9b8755

* Clearer name * Add rspecs to test :housing_a_kit and :loose scopes

Add rspec for item.is_in_kit?

e1e2c31

Fix lint

7f166cc

jimmyli97 changed the title ~~#4217 kit factory and rspec various refactors~~ #4217 kit factory, base item, and rspec various refactors Aug 8, 2024

jimmyli97 mentioned this pull request Aug 8, 2024

WIP [Phase 1 Kit Refactor] Fix #3707 add itemizable item, migrate kit line items (backup db before merge) #4560

Draft

cielf requested a review from dorner August 9, 2024 01:34

rename findorcreatebaseitem to add !

2c5ed05

jimmyli97 force-pushed the 4217-kit-various-refactors branch from 59374ad to 2c5ed05 Compare August 9, 2024 01:52

jimmyli97 force-pushed the 4217-kit-various-refactors branch from 1969e05 to 141d959 Compare August 15, 2024 00:51

jimmyli97 added 2 commits August 15, 2024 03:45

Fix bin/setup so it's working with seed_base_item move

080721e

Merge branch 'main' into 4217-kit-various-refactors

e26f441

dorner requested changes Sep 2, 2024

View reviewed changes

jimmyli97 added 8 commits September 24, 2024 01:33

Revert "REFACTOR clean up unused line item trait introduced in rubyfo…

a111f74

…rgood#4163" This reverts commit ceec002.

Revert "FIX typo in params in donation and purchase controllers"

81c99af

This reverts commit 7cabfa6.

Revert "DOCS add comment clarifying itemizable works with line items"

7b4da7d

This reverts commit 1109170.

Revert "REFACTOR rename Item:kits scope to :housing_a_kit, add rspecs"

04917ba

This reverts commit b9b8755.

Revert "REFACTOR DRY up kit base_item, seed_base_items, prevent kit b…

e4de92c

…ase_item deletion" This reverts commit 8c18e42.

Revert "Add rspec for item.is_in_kit?"

96b3ceb

This reverts commit e1e2c31.

Revert "REFACTOR remove unused code childrenservedreportservice"

af1dfd5

This reverts commit 141d959.

Revert "Fix bin/setup so it's working with seed_base_item move"

6b50518

This reverts commit 080721e.

jimmyli97 changed the title ~~#4217 kit factory, base item, and rspec various refactors~~ #4217 kit factory refactor Sep 24, 2024

jimmyli97 mentioned this pull request Sep 24, 2024

Add missing kit rspecs, DRY up kit base items and report service #4665

Open

jimmyli97 added 2 commits September 25, 2024 23:49

REFACTOR move kit creation in specs into helper method

730371a

Merge branch 'main' into 4217-kit-various-refactors

51f0585

jimmyli97 requested a review from dorner September 25, 2024 23:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#4217 kit factory refactor #4585

#4217 kit factory refactor #4585

jimmyli97 commented Aug 8, 2024 •

edited

Loading

jimmyli97 commented Aug 9, 2024

dorner left a comment

dorner Sep 2, 2024

jimmyli97 Sep 24, 2024

dorner Sep 2, 2024

jimmyli97 Sep 24, 2024

dorner Sep 2, 2024

jimmyli97 Sep 24, 2024

dorner Sep 2, 2024

jimmyli97 Sep 24, 2024

dorner Sep 2, 2024

jimmyli97 Sep 25, 2024

dorner Sep 2, 2024

jimmyli97 Sep 24, 2024

jimmyli97 commented Sep 24, 2024

#4217 kit factory refactor #4585

Are you sure you want to change the base?

#4217 kit factory refactor #4585

Conversation

jimmyli97 commented Aug 8, 2024 • edited Loading

Description

Type of change

How Has This Been Tested?

jimmyli97 commented Aug 9, 2024

dorner left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jimmyli97 commented Sep 24, 2024

jimmyli97 commented Aug 8, 2024 •

edited

Loading