Codestin Search App

aniketkaushik · 2022-06-11T19:16:36Z

Notion card

https://www.notion.so/saeloun/Add-Book-keeper-role-2202d380771845bfbf23fb781afc29ae

Checklist:

I have manually tested all workflows
I have performed a self-review of my own code
I have added automated tests for my code

github-actions · 2022-06-11T19:21:20Z

Current Code Coverage Percent of this PR:

89.18 %

Files having coverage below 100%

Impacted Files	Coverage
/lib/custom_failure.rb	80.0 %
/app/controllers/users/invitations_controller.rb	86.36 %
/app/controllers/users/sessions_controller.rb	85.71 %
/app/services/invoice_payment/checkout.rb	44.0 %
/app/services/invoice_payment/pdf_generation.rb	70.97 %
/app/controllers/internal_api/v1/companies_controller.rb	95.45 %
/app/controllers/internal_api/v1/profile_controller.rb	96.88 %
/app/controllers/internal_api/v1/payment_settings_controller.rb	93.33 %
/app/controllers/internal_api/v1/wise/recipients_controller.rb	90.0 %
/app/controllers/internal_api/v1/payments/providers_controller.rb	94.74 %
/lib/benchmarking/benchmarker.rb	0.0 %

rohitjoshixyz

Nice work @aniket-k-kaushik with the spec coverage. Added few comments

rohitjoshixyz · 2022-06-14T07:09:42Z

app/controllers/users/sessions_controller.rb

    return new_company_path if resource.companies.empty? && resource.has_role?(:owner)

-    time_tracking_index_path
-
-    # As per discussion we want to redirect all the users to time-tracking page as dashboard is blank.
+    if resource.has_book_keeper_role?(current_company)
+      payments_path
+    else
+      time_tracking_index_path
+    end


Convert to switch case

Also we can DRY this bit of code out.

rohitjoshixyz · 2022-06-14T07:10:12Z

app/controllers/users/sessions_controller.rb

    # if resource.has_owner_or_admin_role?(current_company)
    #   dashboard_index_path
+    # elsif resource.has_book_keeper_role?(current_company)
+    #   payments_path
    # else
    #   time_tracking_index_path
    # end


Remove this

@supriya3105 Suggested to redirect all users to time-sheet page temporally as we don't have dashboard yet so, once the dashboard is done, we can uncomment these lines and remove the current conditions.

if resource.has_book_keeper_role?(current_company) payments_path else time_tracking_index_path end

We can add the commented code later if needed, it's simple enough but having unused commented code is bad practice

ok, I will remove it

rohitjoshixyz · 2022-06-14T07:13:55Z

app/models/user.rb

+  def has_owner_or_admin_or_employee_role?(company)
+    return false if company.nil?
+
+    self.has_cached_role?(
+      :owner,
+      company) || self.has_cached_role?(:admin, company) || self.has_cached_role?(:employee, company)
+  end
+
+  def has_owner_or_admin_or_book_keeper_role?(company)
+    return false if company.nil?
+
+    self.has_cached_role?(
+      :owner,
+      company) || self.has_cached_role?(:admin, company) || self.has_cached_role?(:book_keeper, company)
+  end


We have created separate methods to check role, I don't think creating new methods for all combinations is a good idea.
Add one method for employee role and we can then use
has_owner_or_admin_role? || has_employee_role? in the policy which is equivalent to the above method

Ruby's metaprogramming features (define_method) comes quite handy when we need to create_methods like these.

Agree. This creates confusion. KISS please! is_owner_or_admin?, is_employee? & is_bookkeeper? is fine.

OK, will look into it.

rohitjoshixyz · 2022-06-14T07:15:40Z

app/policies/application_policy.rb

+  def user_owner_or_admin_or_book_keeper_role?(resource = user.current_workspace)
+    user.has_owner_or_admin_or_book_keeper_role?(resource)
+  end
+
+  def user_owner_or_admin_or_employee?(resource = user.current_workspace)
+    user.has_owner_or_admin_or_employee_role?(resource)
+  end


Adding so many methods for combinations is confusing, reuse individual methods as mentioned in above comment

rohitjoshixyz · 2022-06-14T07:22:17Z

app/views/partial/_navbar.html.erb

        <%# if policy(:dashboard).index? %>
 <!--          <a href="/dashboard" class="<%#= request.path == "/dashboard" ? "navbar__smaller-screen_selected" : "navbar__smaller-screen_unselected" %> navbar__smaller-screen_titles"><%#= t('navbar.dashboard') %></a>-->
        <%# end %>
+        <% if policy(:timesheet_entry).index? %>


This is too much repetition. Let's use a helper method to render the navbar. It will return a hash with the title and path of the authorized nav links and then we can iterate it here cc @apoorv-mishra @akhilgkrishnan @keshavbiswa

Makes sense, but in a separate PR IMO.

rohitjoshixyz · 2022-06-14T07:45:43Z

spec/requests/internal_api/v1/clients_controller_spec.rb

      end
    end

+    context "when user is an book keeper" do


Suggested change

context "when user is an book keeper" do

context "when user is a book keeper" do

Check for grammar in all spec descriptions. I see the B of book keeper is unnecessarily capitalized at some places

akhilgkrishnan · 2022-06-14T07:43:19Z

app/controllers/users/sessions_controller.rb

    # if resource.has_owner_or_admin_role?(current_company)
    #   dashboard_index_path
+    # elsif resource.has_book_keeper_role?(current_company)
+    #   payments_path
    # else
    #   time_tracking_index_path
    # end


why these all are commented?

Supriya Suggested to redirect all users to time-sheet page temporally as we don't have dashboard yet so, once the dashboard is done, we can uncomment these lines and remove the current conditions.

app/models/user.rb

app/policies/timesheet_entry_policy.rb

keshavbiswa

Reviewed most of the codes except the tests and added few comments

app/controllers/root_controller.rb

keshavbiswa · 2022-06-14T08:00:24Z

app/controllers/users/sessions_controller.rb

    return new_company_path if resource.companies.empty? && resource.has_role?(:owner)

-    time_tracking_index_path
-
-    # As per discussion we want to redirect all the users to time-tracking page as dashboard is blank.
+    if resource.has_book_keeper_role?(current_company)
+      payments_path
+    else
+      time_tracking_index_path
+    end


Also we can DRY this bit of code out.

keshavbiswa · 2022-06-14T08:02:59Z

app/models/user.rb

+  def has_owner_or_admin_or_employee_role?(company)
+    return false if company.nil?
+
+    self.has_cached_role?(
+      :owner,
+      company) || self.has_cached_role?(:admin, company) || self.has_cached_role?(:employee, company)
+  end
+
+  def has_owner_or_admin_or_book_keeper_role?(company)
+    return false if company.nil?
+
+    self.has_cached_role?(
+      :owner,
+      company) || self.has_cached_role?(:admin, company) || self.has_cached_role?(:book_keeper, company)
+  end


Ruby's metaprogramming features (define_method) comes quite handy when we need to create_methods like these.

apoorv-mishra · 2022-06-14T08:03:30Z

app/models/user.rb

+  def has_owner_or_admin_or_employee_role?(company)
+    return false if company.nil?
+
+    self.has_cached_role?(
+      :owner,
+      company) || self.has_cached_role?(:admin, company) || self.has_cached_role?(:employee, company)
+  end
+
+  def has_owner_or_admin_or_book_keeper_role?(company)
+    return false if company.nil?
+
+    self.has_cached_role?(
+      :owner,
+      company) || self.has_cached_role?(:admin, company) || self.has_cached_role?(:book_keeper, company)
+  end


Agree. This creates confusion. KISS please! is_owner_or_admin?, is_employee? & is_bookkeeper? is fine.

app/controllers/root_controller.rb

aniketkaushik · 2022-06-14T19:50:13Z

Nice work @aniket-k-kaushik with the spec coverage. Added few comments

thanks

rohitjoshixyz

LGTM 🎉 perform a self-review of the code before merging. There are many minor changes in the specs similar to the ones I have commented.

spec/policies/invoice_policy_spec.rb

spec/policies/payments/provider_policy_spec.rb

spec/policies/project_policy_spec.rb

spec/requests/clients/destroy_spec.rb

spec/requests/internal_api/v1/timesheet_entries/update_spec.rb

spec/requests/payment_settings/refresh_stripe_connect_spec.rb

keshavbiswa · 2022-06-15T06:49:07Z

app/models/concerns/user_roles.rb

+    define_method "has_#{role}_role?" do |company|
+      return false if company.nil?
+
+      self.has_cached_role?("#{role}".to_sym, company)


Suggested change

self.has_cached_role?("#{role}".to_sym, company)

self.has_cached_role?(role.to_sym, company)

I tried by, removing the concerns but it didn't worked, so keeping it for now

What exactly didn't work?

has_book_keeper_role? in the session_controller.rb gave an error, when I removed the user_roles.rb concern

undefined method `has_book_keeper_role?

Yes obviously, you will need to use the function rolify provides.

done with the changes suggested

app/policies/application_policy.rb

app/controllers/users/sessions_controller.rb

keshavbiswa

LGTM!

* added book keeper role * removed comment from client controller * review comments resolved * provider policy * review comments * test fix * session controller more readable * test fix * removed user_roles.rb concerns

pr-triage bot added the PR: unreviewed label Jun 11, 2022

supriya3105 requested review from akhilgkrishnan and rohitjoshixyz June 14, 2022 06:53

rohitjoshixyz suggested changes Jun 14, 2022

View reviewed changes

pr-triage bot added PR: reviewed-changes-requested and removed PR: unreviewed labels Jun 14, 2022

akhilgkrishnan reviewed Jun 14, 2022

View reviewed changes

app/policies/timesheet_entry_policy.rb Outdated Show resolved Hide resolved

keshavbiswa reviewed Jun 14, 2022

View reviewed changes

apoorv-mishra reviewed Jun 14, 2022

View reviewed changes

aniketkaushik force-pushed the Add-bookkeeper-role-for-invoice-and-payment branch from f1d45be to 836ecde Compare June 14, 2022 12:01

pr-triage bot added PR: unreviewed and removed PR: reviewed-changes-requested labels Jun 14, 2022

aniketkaushik force-pushed the Add-bookkeeper-role-for-invoice-and-payment branch from 7185e7f to 130159b Compare June 14, 2022 18:18

aniketkaushik requested review from akhilgkrishnan, apoorv-mishra, keshavbiswa and rohitjoshixyz June 14, 2022 18:26

rohitjoshixyz approved these changes Jun 15, 2022

View reviewed changes

pr-triage bot added PR: partially-approved and removed PR: unreviewed labels Jun 15, 2022

keshavbiswa reviewed Jun 15, 2022

View reviewed changes

apoorv-mishra reviewed Jun 15, 2022

View reviewed changes

app/policies/application_policy.rb Show resolved Hide resolved

app/controllers/users/sessions_controller.rb Outdated Show resolved Hide resolved

pr-triage bot added PR: unreviewed and removed PR: partially-approved labels Jun 15, 2022

aniketkaushik requested review from apoorv-mishra and keshavbiswa June 15, 2022 10:05

keshavbiswa approved these changes Jun 15, 2022

View reviewed changes

Aniket Kaushik added 9 commits June 15, 2022 16:02

added book keeper role

9bf99b5

removed comment from client controller

64dfffa

review comments resolved

77b1a01

provider policy

64be888

review comments

fb22c8e

test fix

b5d6380

session controller more readable

e25df32

test fix

f262989

removed user_roles.rb concerns

4f6a745

aniketkaushik force-pushed the Add-bookkeeper-role-for-invoice-and-payment branch from 28bc2c5 to 4f6a745 Compare June 15, 2022 10:32

aniketkaushik merged commit 20e1ab1 into develop Jun 15, 2022

aniketkaushik deleted the Add-bookkeeper-role-for-invoice-and-payment branch June 15, 2022 10:40

pr-triage bot added PR: merged and removed PR: unreviewed labels Jun 15, 2022

	context "when user is an book keeper" do
	context "when user is a book keeper" do

	self.has_cached_role?("#{role}".to_sym, company)
	self.has_cached_role?(role.to_sym, company)

Conversation

aniketkaushik commented Jun 11, 2022

Notion card

Checklist:

Uh oh!

github-actions bot commented Jun 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Current Code Coverage Percent of this PR:

89.18 %

Files having coverage below 100%

Uh oh!

rohitjoshixyz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

aniketkaushik Jun 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

keshavbiswa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aniketkaushik commented Jun 14, 2022

Uh oh!

rohitjoshixyz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Jun 11, 2022 •

edited

Loading

aniketkaushik Jun 14, 2022 •

edited

Loading

aniketkaushik Jun 15, 2022 •

edited

Loading

aniketkaushik Jun 15, 2022 •

edited

Loading

aniketkaushik Jun 15, 2022 •

edited

Loading