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

jimmyli97 · 2024-09-24T02:03:16Z

Split off from PR #4585
Various refactors and documentation changes

Description

Rename item.kits scope to item.housing_a_kit
DRYs up kit base_item seeding
Removes duplicated code and rspec from ChildrenReportService
Add rspecs to:
- prevent kit base_item deletion
- test item.is_in_kit?, item.loose, item.housing_a_kit
Add documentation

Type of change

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

How Has This Been Tested?

passes test suite

* 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

* 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)

* Rename to snake case * Add docs noting base items will be changed

…_spec.rb

jimmyli97 · 2024-09-24T02:38:49Z

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
-      organization_id = @organization.id


(continuing conversation from #4585)

these lines were removed because they're unused in this service and duplicated in AcquisitionReportService (probably the author copied AcquisitionReportService as a template when creating this service and forgot to delete them)

cielf · 2024-09-28T17:06:31Z

@jimmyli97 FYI: We had an urgent fix that required all the senior contributors this week , so we didn't get to look at this again. Hopefully this week will go better.

dorner · 2024-09-30T00:53:18Z

app/controllers/admin/base_items_controller.rb

@@ -40,7 +42,9 @@ def show

  def destroy
    @base_item = BaseItem.includes(:items).find(params[:id])
-    if @base_item.items.any? && @base_item.destroy
+    if (@base_item.id = KitCreateService.find_or_create_kit_base_item!.id)


Assignment inside a condition is pretty prone to bugs. Can we separate them out into two lines?

I think this was a typo, fixed to == in commit 94030f7

dorner · 2024-09-30T00:53:40Z

app/controllers/admin/base_items_controller.rb

-    if @base_item.items.any? && @base_item.destroy
+    if (@base_item.id = KitCreateService.find_or_create_kit_base_item!.id)
+      redirect_to admin_base_items_path, alert: "You cannot delete the Kits base item. This is reserved for all Kits."
+    elsif @base_item.items.any? && @base_item.destroy


Shouldn't this be @base_item.items.empty?

yes, fixed in commit 94030f7

dorner · 2024-09-30T00:55:49Z

lib/seed_base_items.rb

@@ -0,0 +1,19 @@
+def seed_base_items


Top-level functions look kind of weird in a Rails app. Can this be wrapped in a module?

It worked in rails_helper because those kind of helper methods are fine if used specifically for test setup.

added to module seeds in commit 94030f7

dorner · 2024-09-30T00:57:56Z

spec/requests/admin/base_items_requests_spec.rb

    end
  end

+  # TODO aren't organization_admins not allowed to view base items?
+  # also, some of these tests are sending organization.id instead of BaseItem.id as args


Pretty sure they can't. @cielf ?

Org admins can't see the base items pages.

They see a list of base items that they pick from when setting up items, and there are places they can filter by base item, but they can't view or edit the base item information.

fixed specs to clarify that org admins can't access or edit base items in commit 44c42be

dorner · 2024-09-30T00:58:05Z

spec/services/reports/children_served_report_service_spec.rb

@@ -42,6 +42,7 @@
        create_list(:line_item, 5, :distribution, quantity: 200, item: disposable_item, itemizable: dist)
        create_list(:line_item, 5, :distribution, quantity: 300, item: non_disposable_item, itemizable: dist)
      end
+      # within_time total distributed i


accidental commit?

fixed in commit 94030f7

dorner

Almost there! One last suggestion.

dorner · 2024-10-22T14:04:17Z

spec/requests/admin/base_items_requests_spec.rb

  context "When logged in as an organization admin" do
    before do
      sign_in(organization_admin)
    end

    describe "GET #new" do
-      it "returns http success" do
+      it "denies access and redirects" do


I don't think you even need these specs - every route under admin is blocked to every user besides admins. We don't need specs for every one of those routes. Maybe pick one representative one (index?) and leave it at that.

addressed in commit a861839

dorner · 2024-11-10T15:33:36Z

@jimmyli97 are you able to finish this off?

cielf · 2024-11-10T15:34:25Z

Hey @jimmyli97 -- Just checking if you are still working on this. If we don't hear from you in a couple weeks, we'll assume not. Thank you for all your work on this in either case!

jimmyli97 · 2024-11-10T17:29:57Z

If someone wants to finish this that's fine, otherwise I can hopefully get to this next week

dorner · 2024-11-27T01:23:52Z

All good on my side. @cielf did you want to kick the tires?

cielf · 2024-11-27T13:49:52Z

Yes. Should be able to fit it in today or tomorrow.

cielf · 2024-11-28T14:44:15Z

Looks good after a light kicking.

github-actions · 2024-12-15T16:06:56Z

@jimmyli97: Your PR Add missing kit rspecs, DRY up kit base items and report service is part of today's Human Essentials production release: 2024.12.15.
Thank you very much for your contribution!

jimmyli97 added 10 commits September 24, 2024 01:55

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

f8b85d3

FIX typo in params in donation and purchase controllers

a4d1164

* Another typo in docs

DOCS add comment clarifying itemizable works with line items

8ee83ee

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

7f776ab

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

Add rspec for item.is_in_kit?

dd4ce7b

Fix lint

dd2b556

rename findorcreatebaseitem to add !

b59975a

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

240a32e

jimmyli97 mentioned this pull request Sep 24, 2024

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

Draft

Base Item linting

a74dcc9

* Rename to snake case * Add docs noting base items will be changed

jimmyli97 mentioned this pull request Sep 24, 2024

#4217 kit factory refactor #4585

Merged

jimmyli97 added 2 commits September 24, 2024 02:29

REFACTOR move seed_base_items into lib util file

8fde086

REFACTOR use specify -> instead of it -> in test descriptions in item…

7d25b3a

…_spec.rb

jimmyli97 commented Sep 24, 2024

View reviewed changes

cielf requested a review from dorner September 24, 2024 12:52

dorner requested changes Sep 30, 2024

View reviewed changes

jimmyli97 added 2 commits October 17, 2024 22:17

Merge branch 'main' into cleanup-typos-kit-rspecs

94c1d91

FIX typos, move to Seeds module

94030f7

jimmyli97 force-pushed the cleanup-typos-kit-rspecs branch from 9472525 to 94030f7 Compare October 17, 2024 22:38

FIX clarify org admins can't view or edit base items in specs

44c42be

jimmyli97 requested a review from dorner October 17, 2024 23:32

dorner requested changes Oct 22, 2024

View reviewed changes

jimmyli97 added 2 commits November 22, 2024 01:01

update bundler version

0415e49

remove extra base item route rspecs

a861839

jimmyli97 added 2 commits November 22, 2024 01:10

Merge branch 'main' into cleanup-typos-kit-rspecs

a66ec9f

Merge branch 'main' into cleanup-typos-kit-rspecs

cf11430

jimmyli97 requested a review from dorner November 22, 2024 01:17

Merge branch 'main' into cleanup-typos-kit-rspecs

3fd9aa7

dorner approved these changes Dec 10, 2024

View reviewed changes

dorner merged commit 32ee2fb into rubyforgood:main Dec 10, 2024
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

jimmyli97 commented Sep 24, 2024 •

edited

Loading

jimmyli97 Sep 24, 2024 •

edited

Loading

cielf commented Sep 28, 2024

dorner Sep 30, 2024

jimmyli97 Oct 17, 2024

dorner Sep 30, 2024

jimmyli97 Oct 17, 2024

dorner Sep 30, 2024

jimmyli97 Oct 17, 2024

dorner Sep 30, 2024

cielf Sep 30, 2024

jimmyli97 Oct 17, 2024

dorner Sep 30, 2024

jimmyli97 Oct 17, 2024

dorner left a comment

dorner Oct 22, 2024

jimmyli97 Nov 22, 2024

dorner commented Nov 10, 2024

cielf commented Nov 10, 2024

jimmyli97 commented Nov 10, 2024

dorner commented Nov 27, 2024

cielf commented Nov 27, 2024

cielf commented Nov 28, 2024

github-actions bot commented Dec 15, 2024

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

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

Conversation

jimmyli97 commented Sep 24, 2024 • edited Loading

Description

Type of change

How Has This Been Tested?

jimmyli97 Sep 24, 2024 • edited Loading

Choose a reason for hiding this comment

cielf commented Sep 28, 2024

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

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

dorner commented Nov 10, 2024

cielf commented Nov 10, 2024

jimmyli97 commented Nov 10, 2024

dorner commented Nov 27, 2024

cielf commented Nov 27, 2024

cielf commented Nov 28, 2024

github-actions bot commented Dec 15, 2024

jimmyli97 commented Sep 24, 2024 •

edited

Loading

jimmyli97 Sep 24, 2024 •

edited

Loading